Changelog

Copy Markdown View Source

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.8.7 - 2026-09-05

Changed

  • Every association rejection now ends the process with a shutdown reason instead of a crash reason: {:shutdown, :no_accepted_contexts}, {:shutdown, :authentication_failed} and {:shutdown, :association_rejected} on the SCP side, {:shutdown, {:rejected, result, source, reason}} on the SCU side. Refusing an association is the decision the SCP was asked to make, so an SCP with an AE allowlist or an association policy no longer logs two error reports with a full state dump for every unauthorized attempt. Dimse.connect/3 still returns {:error, {:rejected, result, source, reason}} and the other public results are unchanged.
  • Implementation version bumped to DIMSE_0.8.7.

0.8.6 - 2026-09-05

Changed

  • An association whose peer closes the TCP connection now exits with {:shutdown, :tcp_closed} instead of :tcp_closed. Callers blocked on the association still receive {:error, :tcp_closed} and Dimse.connect/3 still returns {:error, :tcp_closed}, but GenServer and Ranch no longer log a crash for every TCP health probe that connects and closes without an A-ASSOCIATE-RQ (one error report per probe, every few seconds, on a monitored SCP).
  • Implementation version bumped to DIMSE_0.8.6.

0.8.5 - 2026-09-05

Added

  • Lazy C-MOVE and C-GET sub-operations. handle_move/3 and handle_get/3 may return {sop_class_uid, sop_instance_uid, fetcher} where fetcher is a zero-arity function returning {:ok, data_set} or {:error, reason}; the association calls it right before that object's C-STORE and keeps no reference to the bytes afterwards, so a retrieve of thousands of objects holds one data set at a time. A fetcher that returns an error, raises, throws, exits or returns an unexpected term counts as one failed sub-operation (the last four also emit [:dimse, :handler, :exception] with callback: :fetcher) and the retrieve continues.
  • The final C-MOVE-RSP / C-GET-RSP carries the Failed SOP Instance UID List (0008,0058) in sub-operation order when any sub-operation failed (PS3.4 C.4.2.1.4.2 and C.4.3.1.3.2), encoded in the negotiated transfer syntax; under Explicit VR Little Endian the list is cut to the UIDs that fit the 16-bit length while the counts stay exact.
  • Implementation version bumped to DIMSE_0.8.5.

Fixed

  • Optional handler callbacks (validate_association/2, handle_authenticate/2, supported_abstract_syntaxes/0, resolve_ae/1 and the DIMSE-N SCP callbacks) were checked with function_exported?/3 without loading the handler module first. In interactive mode (dev/test) a handler that had not been loaded yet silently lost those callbacks, so the first association could skip validation or authentication and be rejected with :no_accepted_contexts. The module is now loaded before the check.

0.8.4 - 2026-03-20

Changed

  • Coverage increased to 98.16% overall, with Dimse.Scu driven to 100% and Dimse.Association lifted to 95.64%
  • Added deterministic regression tests for SCU connect-exit normalization, DOWN-preferred error mapping, and internal association-helper edge cases
  • Exposed a tiny set of @doc false SCU/association helpers to make shutdown and timeout branches testable without protocol flakiness
  • Implementation version bumped to DIMSE_0.8.4

0.8.3 - 2026-03-20

Changed

  • Coverage increased to 96.99% overall, with Dimse.Scu raised through deterministic helper-path tests instead of race-dependent assertions
  • Extracted Dimse.Scu connection-finalization and exit-normalization helpers as documented internal APIs (@doc false) to keep timeout and shutdown semantics directly testable
  • Added regression tests for immediate-open timeout handling, connect-exit normalization, and DOWN-vs-fallback error mapping
  • Implementation version bumped to DIMSE_0.8.3

0.8.2 - 2026-03-19

Changed

  • Coverage: 95.90% → 96.36% with targeted protocol edge-case tests
  • Tests: 438 (10 properties + 428 tests)
  • Added tests for unexpected PDU handling, A-ABORT during pending request, C-GET sub-op failure, raw TCP protocol edge cases

0.8.1 - 2026-03-19

Added

  • validate_association/2 optional handler callback for pre-auth association admission control
  • Current presentation-context details in handler state via current_context_id, current_abstract_syntax_uid, and current_transfer_syntax_uid
  • Integration coverage for association rejection and callback context propagation

Changed

  • SCP handler callbacks now receive association state enriched with the negotiated presentation context for the current message
  • Association rejection can now happen before user-identity authentication, enabling AE-title and policy checks at admission time

0.8.0 - 2026-03-18

Added

  • Dimse.with_connection/4 — automatic connect/execute/release lifecycle
  • Dimse.Error module — error taxonomy with types for all 4 error categories
  • Dimse.Tls module — shared TLS option normalization
  • Expanded telemetry: 17 events across 6 categories (negotiation, TLS handshake, handler callbacks, sub-operations)
  • TLS hardening tests: hostname verification (SNI), handshake timeout, error surfacing, wrong-protocol detection
  • Interop test infrastructure with Docker harness (dcmtk, Orthanc, pynetdicom)
  • Protocol edge-case tests: 128 contexts, fragmentation boundaries, concurrent associations, ARTIM timer
  • artim_timeout option for start_listener/1

Changed

  • DRY: extracted put_if/3 in Dimse.Scu (was maybe_put/3 duplicated in store, n_get, n_create)
  • DRY: extracted Dimse.Tls.normalize_opts/1 (was normalize_tls_opt/1 duplicated in association, listener)
  • Implementation version bumped to DIMSE_0.8.0
  • Test count: 340 → 429 (10 properties + 419 tests), coverage 95.79% → 96%+

Removed

  • docs/roadmap.md

0.7.1 - 2026-03-18

Added

  • 17 additional tests for default-argument stubs, abort paths, and tcp_closed scenarios; total 340 tests, 95.79% coverage

Fixed

  • reverse_ui_list_fields/1 fast path: skips struct rebuild for plain associations without Extended Negotiation sub-items (common case)

Changed

  • README trimmed and updated with block-letter logo
  • Removed stale docs/PRD.md

0.7.0 - 2026-03-18

Added

  • Extended Negotiation sub-items in A-ASSOCIATE-RQ/AC UserInformation block (PS3.7 Annex D)
  • Role Selection (0x54) — SCU/SCP role negotiation per SOP class (Dimse.Pdu.RoleSelection)
  • SOP Class Extended Negotiation (0x56) — service-class-specific application info (Dimse.Pdu.SopClassExtendedNegotiation)
  • SOP Class Common Extended Negotiation (0x57) — service class UID + related SOP class UIDs (Dimse.Pdu.SopClassCommonExtendedNegotiation)
  • User Identity Negotiation (0x58/0x59) — username/password/Kerberos/SAML/JWT authentication (Dimse.Pdu.UserIdentity, Dimse.Pdu.UserIdentityAc)

  • handle_authenticate/2 optional SCP callback — returns {:ok, nil | binary()} to accept or {:error, reason} to reject; A-ASSOCIATE-RJ sent automatically on rejection

  • Dimse.Association.negotiated_roles/1 — retrieve negotiated SCU/SCP roles for the association as %{sop_class_uid => {scu, scp}}
  • :role_selections and :user_identity opts for Dimse.connect/3 and Dimse.Scu.open/3
  • SCP echoes back role selections filtered to accepted SOP classes in A-ASSOCIATE-AC
  • Server response from handle_authenticate/2 included in A-ASSOCIATE-AC when SCU requested positive response
  • 45 new tests: 23 PDU unit tests + 5 Extended Negotiation integration tests + 17 coverage tests for default-arg stubs, abort paths, and tcp_closed scenarios

Changed

  • UserInformation struct replaces extended_negotiation: term() placeholder with 5 typed fields: role_selections, sop_class_extended, sop_class_common_extended, user_identity, user_identity_ac
  • handle_authenticate/2 added to @optional_callbacks — associations without the callback default to accepting all SCUs
  • Implementation version bumped to DIMSE_0.7.0

0.6.1 - 2026-03-18

Added

  • bench/ directory with five Benchee suites: PDU encode/decode, command encode/decode, message fragmentation/assembly, persistent-connection throughput, and end-to-end round-trip benchmarks
  • benchee dev dependency for the benchmark suites

Changed

  • Dimse.connect/3 and Dimse.Scu.open/3 now enforce a single timeout budget across socket connect plus association negotiation
  • PDU encoder keeps iodata throughout — no intermediate IO.iodata_to_binary flatten; sizes computed via :erlang.iolist_size/1
  • PDU encoder fast-path for single-PDV P-DATA-TF (the common case) avoids Enum.map list allocation

  • PDU decoder accumulates presentation contexts with [h | t] + Enum.reverse/1 instead of ++ [item] (O(n) vs O(n²))

  • Command encoder uses compile-time pattern-match dispatch for VR lookup instead of Map.get/3 at runtime
  • Message fragmentation rewritten as a tail-recursive accumulator — no intermediate chunk lists, direct struct construction
  • Association TCP receive handler skips binary concatenation when the buffer is already empty (common case: one PDU per segment)

Fixed

  • SCP examples now declare supported_abstract_syntaxes/0 for the non-Verification services they advertise
  • TLS failure-path tests now require synchronous connect/3 failure instead of tolerating the old async-connect behavior

0.6.0 - 2026-03-18

Added

  • TLS / DICOM Secure Transport (PS3.15 Annex B) support for both SCP and SCU
  • start_listener/1 accepts :tls option to use ranch_ssl transport
  • connect/3 accepts :tls option to connect via :ssl instead of :gen_tcp
  • Full mutual TLS (mTLS) support: SCP can require client certificates
  • All standard :ssl options (:certfile, :keyfile, :cacertfile, :verify, :fail_if_no_peer_cert) passed through to OTP
  • :ssl and :public_key added to extra_applications (OTP stdlib, zero new deps)
  • 7 TLS integration tests: C-ECHO over TLS, C-STORE over TLS, mutual TLS, DIMSE-N over TLS, mixed TCP+TLS listeners, untrusted CA rejection, missing client cert rejection
  • Dynamic test certificate generation using OTP :public_key (no cert files in repo)

Changed

  • handle_info/2 now uses guards (when proto in [:tcp, :ssl]) instead of atom-specific clauses for socket messages
  • send_pdu/2, reactivate_socket/1, and close_socket/1 handle :ssl transport alongside :gen_tcp and Ranch transports
  • Implementation version bumped to DIMSE_0.6.0

Fixed

  • Dimse.connect/3 and Dimse.Scu.open/3 now wait for association negotiation to succeed or fail before returning
  • Dimse.n_create/4 now returns the created SOP Instance UID alongside status and response data
  • N-CREATE requests without an Attribute List now set CommandDataSetType correctly

0.5.1 - 2026-03-18

Fixed

  • N-GET now correctly encodes and decodes multi-valued Attribute Identifier Lists instead of crashing on a documented list input
  • N-CREATE SCP handlers can now return the created SOP Instance UID for inclusion in the response command
  • DIMSE-N SCU helpers now return explicit error tuples for DIMSE failure statuses instead of reporting them as {:ok, status, data}

0.5.0 - 2026-03-18

Added

Changed

  • send_dimse_request/4 now checks both AffectedSOPClassUID (0000,0002) and RequestedSOPClassUID (0000,0003) for context lookup
  • request_on_negotiated_context?/2 validates both Affected and Requested SOP Class UIDs
  • Response builder dynamically sets CommandDataSetType based on response data presence (was hardcoded 0x0101)

0.4.1 - 2026-03-18

Added

  • C-MOVE SCU (Dimse.Scu.Move) — retrieve instances to a destination AE via C-STORE sub-operations
  • C-GET SCU (Dimse.Scu.Get) — retrieve instances on the same association via interleaved C-STORE sub-ops
  • Dimse.move/4 public API with query level convenience atoms (:patient, :study) and dest_ae option
  • Dimse.get/4 public API with query level convenience atoms (:patient, :study)
  • Association.get_request/4 for C-GET multi-response with interleaved C-STORE handling
  • resolve_ae/1 optional handler callback for C-MOVE destination AE resolution
  • Sub-operation state machine in Association.State for tracking C-GET/C-MOVE progress
  • SCP dispatch for C-GET-RQ (0x0010) and C-MOVE-RQ (0x0021) with asynchronous sub-operation processing
  • SCU get_mode for auto-accepting C-STORE sub-operations during C-GET retrieval
  • Sub-operation count tracking (remaining/completed/failed/warning) in C-GET/C-MOVE responses
  • C-GET integration tests (basic retrieval, empty, error, mixed echo+get)
  • C-MOVE integration tests (basic retrieval, empty, error, resolve_ae failure, mixed echo+move)
  • Unit tests for Dimse.Scu.Move and Dimse.Scu.Get (SOP class mapping, command set building)

Changed

  • Breaking: handle_move/3 now returns {:ok, [{sop_class_uid, sop_instance_uid, data}]} (was {:ok, [String.t()]})
  • Breaking: handle_get/3 now returns {:ok, [{sop_class_uid, sop_instance_uid, data}]} (was {:ok, [binary()]})
  • MoveOriginatorMessageID tag (0000,1031) added to command VR map for correct US encoding

Fixed

  • SCU requests now fail closed when no negotiated presentation context matches the requested SOP Class
  • Dimse.find/4 now returns an explicit cancellation error when a peer ends the operation with status 0xFE00

0.3.0 - 2026-03-18

Added

  • C-FIND SCU (Dimse.Scu.Find) — query DICOM data sets from remote SCPs
  • Dimse.find/4 public API with query level convenience atoms (:patient, :study, :worklist)
  • Dimse.cancel/2 for C-CANCEL-RQ (PS3.7 §9.3.2.3)
  • Multi-response handling in Association for Pending + Success response sequences
  • Association.find_request/4 for multi-response DIMSE commands
  • Query SOP Class UID mapping (Dimse.Scu.Find.sop_class_uid/1)
  • C-FIND integration tests (basic, empty, many results, error, mixed operations, cancel)
  • Late response tolerance — SCU ignores responses after operation completes

Changed

  • SCP C-CANCEL-RQ handling — no longer sends erroneous response to C-CANCEL

0.2.0 - 2026-03-18

Added

  • C-STORE SCU (Dimse.Scu.Store) — send DICOM instances to remote SCPs
  • Dimse.store/5 public API with priority and move originator support
  • Command-level telemetry events ([:dimse, :command_start], [:dimse, :command_stop])
  • AffectedSOPInstanceUID echo-back in C-STORE-RSP (PS3.7 Table 9.1-1)
  • Property-based tests using StreamData for PDU encode/decode roundtrips
  • @type t() specs on all PDU structs (fixes mix docs warnings)
  • StreamData generators in test helpers for all PDU types
  • C-STORE integration tests (basic, multiple, large data set fragmentation, mixed echo+store)

0.1.0 - 2025-12-15

Added

  • PDU type structs for all 7 DICOM Upper Layer PDU types (PS3.8 Section 9.3)
  • PDU encoder (struct → iodata) and decoder (binary → struct)
  • DIMSE command set encode/decode (Implicit VR Little Endian, group 0000)
  • DIMSE command field constants (PS3.7 Annex E)
  • DIMSE status code constants and classification (PS3.7 Annex C)
  • Association GenServer with 5-phase state machine (PS3.8 Section 9.2)
  • ARTIM timer for connection timeout compliance
  • Presentation context negotiation (abstract syntax + transfer syntax matching)
  • Max PDU length negotiation with automatic message fragmentation
  • Handler behaviour (Dimse.Handler) for SCP service class implementations
  • Built-in C-ECHO SCP and SCU
  • SCU client API (Dimse.Scu.open/3, release, abort)
  • Ranch TCP acceptor integration
  • Telemetry event definitions for association lifecycle and PDU I/O
  • CI workflow with Elixir 1.16/1.17/1.18 matrix