dicomlock 0.7.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,136 @@
1
+ Metadata-Version: 2.4
2
+ Name: dicomlock
3
+ Version: 0.7.0
4
+ Summary: Open-source, self-hosted DICOM file-security scanner + Content Disarm & Reconstruction (CDR)
5
+ Author: Vijay Thakore
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://dicomlock.com
8
+ Project-URL: Repository, https://github.com/vthakore23/dicomlock
9
+ Project-URL: Issues, https://github.com/vthakore23/dicomlock/issues
10
+ Keywords: dicom,security,cdr,content-disarm,medical-imaging,pacs,polyglot
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Healthcare Industry
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Topic :: Security
15
+ Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Operating System :: OS Independent
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: pydicom>=2.4.0
25
+ Requires-Dist: numpy>=1.24.0
26
+ Requires-Dist: python-gdcm>=3.0.0
27
+ Requires-Dist: pylibjpeg>=2.0.0
28
+ Requires-Dist: pylibjpeg-libjpeg>=2.0.0
29
+ Requires-Dist: pylibjpeg-openjpeg>=2.0.0
30
+ Provides-Extra: server
31
+ Requires-Dist: fastapi>=0.110.0; extra == "server"
32
+ Requires-Dist: uvicorn>=0.29.0; extra == "server"
33
+ Requires-Dist: python-multipart>=0.0.9; extra == "server"
34
+ Provides-Extra: full
35
+ Requires-Dist: scipy>=1.11.0; extra == "full"
36
+ Requires-Dist: scikit-image>=0.21.0; extra == "full"
37
+ Requires-Dist: Pillow>=10.0.0; extra == "full"
38
+ Requires-Dist: PyWavelets>=1.4.0; extra == "full"
39
+ Dynamic: license-file
40
+
41
+ # DicomLock
42
+
43
+ Open-source, self-hosted security for DICOM medical-image files. It scans a file for the ways it can be weaponized, then disarms it by rebuilding a clean, clinically identical copy.
44
+
45
+ [![PyPI](https://img.shields.io/pypi/v/dicomlock.svg)](https://pypi.org/project/dicomlock/)
46
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
47
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
48
+
49
+ A DICOM file is not just a picture. It is input for a parser, and hospital software has to read and decode all of it before anyone sees an image. That step is the attack surface. DicomLock checks the file for polyglot malware, parser-exploit constructions, and pixel data that routes through vulnerable image or video codecs, then rebuilds a clean version before the file reaches a PACS, viewer, or model. It runs inside your network, so no patient data leaves the building.
50
+
51
+ This is Content Disarm and Reconstruction (CDR) for DICOM, built to be open and auditable.
52
+
53
+ ## Install
54
+
55
+ ```bash
56
+ pip install dicomlock
57
+ ```
58
+
59
+ The core install pulls in the decoder backends (gdcm and pylibjpeg) so disarm works out of the box. Two optional extras:
60
+
61
+ ```bash
62
+ pip install "dicomlock[server]" # web UI and REST API
63
+ pip install "dicomlock[full]" # PHI / de-identification audit and legacy forensics
64
+ ```
65
+
66
+ Python 3.10 or newer.
67
+
68
+ ## Usage
69
+
70
+ ```bash
71
+ dicomlock file.dcm # scan one file
72
+ dicomlock folder/ # scan every .dcm in a folder
73
+ dicomlock folder/ --disarm # scan, then disarm or quarantine each file
74
+ dicomlock file.dcm --deid # add the PHI / de-identification audit
75
+ ```
76
+
77
+ As a library:
78
+
79
+ ```python
80
+ from scanner.pipeline import run_security_scan, disarm_or_quarantine, is_dangerous
81
+
82
+ report = run_security_scan("file.dcm")
83
+ if is_dangerous(report):
84
+ result = disarm_or_quarantine("file.dcm") # {"action": "disarmed" | "quarantined", ...}
85
+ ```
86
+
87
+ Web UI and API:
88
+
89
+ ```bash
90
+ python server.py # http://localhost:8899
91
+ ```
92
+
93
+ Uploads are scanned in a temp directory and deleted right after, so PHI is never persisted.
94
+
95
+ ## How it works
96
+
97
+ 1. **Scan.** Deterministic, rule-based checks, no ML: preamble and polyglot signatures, length amplification, sequence-nesting depth, pixel-dimension and decompression bombs, private-tag payloads, codec-CVE exposure, and metadata integrity.
98
+ 2. **Disarm.** For files that are dangerous but recoverable, it zeroes the preamble, transcodes compressed pixels to native off the vulnerable codec (in a sandboxed subprocess), and filters private tags against a vendor allowlist. Lossless sources come out bit-exact. Lossy sources are decoded once with no new compression.
99
+ 3. **Quarantine.** Anything it cannot safely rebuild, such as length bombs and files no backend can decode, is held back. It re-scans its own output, so it never emits a file that still fails a check.
100
+
101
+ The point of CDR is that it rebuilds from a validated canonical form instead of matching a known signature, so it neutralizes attacks it has never seen. That is the defense that holds up when vulnerabilities turn up faster than anyone can patch them, which is the situation for the systems a patch cycle reaches slowly: legacy and embedded medical devices, and software locked behind FDA recertification.
102
+
103
+ ## Why this is a real problem
104
+
105
+ The 128-byte preamble can hold an executable header, so one file can be a valid scan and working malware at the same time (CVE-2019-11687, extended to Linux devices by ELFDICOM). Attacker-controlled length fields turn a 140-byte file into a multi-gigabyte allocation request. Encapsulated pixel and video data decodes through libjpeg, OpenJPEG, CharLS, and FFmpeg-class libraries that carry long CVE histories. Live examples in clinical software include the Orthanc auth bypass (CVE-2025-0896, CVSS 9.8) and MicroDicom remote code execution (CVE-2025-5943).
106
+
107
+ DicomLock works on the file. It does not break or weaken encryption and makes no claim to.
108
+
109
+ ## Results
110
+
111
+ All reproducible from the scripts in [`_attack_test/`](_attack_test/):
112
+
113
+ - Zero false positives across 575 real clinical CT files, and zero on a separate mixed-compression corpus spanning 12 transfer syntaxes.
114
+ - 20 of 20 crafted attack fixtures flagged by the expected check.
115
+ - pydicom, GDCM, and dcmtk accept the weaponized files without complaint; DicomLock flags every one.
116
+ - Disarmed pixels are bit-exact against two independent decoders (GDCM and pylibjpeg) on every lossless sample.
117
+ - The codec decode is sandboxed, so a crashing or hanging decoder is contained and the file is quarantined, not the tool.
118
+
119
+ The attack fixtures in this repo are inert. Polyglots carry only magic bytes, and payload tags carry a header plus zero padding. No working malware ships here.
120
+
121
+ ## Where it fits
122
+
123
+ Commercial DICOM CDR already exists (OPSWAT, Votiro), and there is academic prior art, so "nobody does this" is not the pitch. DicomLock's reason to exist is that it is open, self-hosted, auditable, and PACS-depth. The transcoding, the vendor allowlist, and the parser-bomb rejection are all readable in source and run inside your network. The natural first users are research-imaging and data-engineering teams that already ingest untrusted external DICOM.
124
+
125
+ It is a security and sanitization tool, not a medical device. It carries no diagnostic claim and no FDA clearance. See [THREAT_MODEL.md](THREAT_MODEL.md) for what it does and does not defend.
126
+
127
+ ## Documentation
128
+
129
+ - [THREAT_MODEL.md](THREAT_MODEL.md), attacks defended and explicit non-claims
130
+ - [ARCHITECTURE.md](ARCHITECTURE.md), module specs
131
+ - [CONTRIBUTING.md](CONTRIBUTING.md), how to help with the CVE map, vendor allowlist, and codecs
132
+ - [SECURITY.md](SECURITY.md), vulnerability disclosure
133
+
134
+ ## License
135
+
136
+ [Apache-2.0](LICENSE), © 2026 Vijay Thakore. Provided as is, without warranty. DicomLock is a sanitization tool, not a medical device, and makes no diagnostic claim. Validate disarmed files in your own environment before any clinical use, and run on de-identified data where you can.
@@ -0,0 +1,24 @@
1
+ dicomlock-0.7.0.dist-info/licenses/LICENSE,sha256=3hBgkQIsJvxcNTbr6bEtbmoHBHHcp_3llCHqUsJ9Vj4,11343
2
+ scanner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
+ scanner/_resources.py,sha256=pMmNlja9AtUaDmkNWnV9krKNeASBMptIWLI3F6mJUoY,634
4
+ scanner/_sandbox.py,sha256=ocB5JhwGB-fBfnOLfxbGqK1Q49PXy7Z1VHV1zpn2buI,4594
5
+ scanner/calibration.py,sha256=1OZHCmQbonfe2iQCRLMbPIRsQ3ms9jwD0JDJsZtCWb4,4944
6
+ scanner/classify.py,sha256=31inkIx8_blOECkkrvjRyIwnyY5tPoYlvJ2l0DW8N1U,4620
7
+ scanner/cli.py,sha256=R8AcG4WtcMZPzy_7Um4pR4dd-PGafHk5lav82lDT7ko,7587
8
+ scanner/codec_cve.py,sha256=rozrMQbxZorHfUMkUgKqQzeOR9I_IW766se-TDNx-nM,6810
9
+ scanner/deid_auditor.py,sha256=FD9EwqLyAp8xVGcVF7Go8DTzQu7qk96RZPtXj_uCsoo,28779
10
+ scanner/disarm.py,sha256=tdfB1JZ4FqLjiGqDJiCfBgFfi0vxXMnVIHM0ZQCX3jo,10959
11
+ scanner/file_security.py,sha256=wH8EHwkYG_CKMdS_vVx5NAnB48XJnsK0LiWk2N34Sh8,15193
12
+ scanner/findings.py,sha256=R6by4K_so9040pp8o7NjgwZf06M7h19Vurpzb5nNJBU,1898
13
+ scanner/ingest.py,sha256=6tgAruAQtrpdVPCMcISZBSgODgE_Y17YcDBdabC2n-k,1688
14
+ scanner/metadata.py,sha256=kcy_2fBw1XqB-Ge6VzQcs8eG-V-Q0ziAuffQZmOlXQI,18739
15
+ scanner/pipeline.py,sha256=aCND5y7UukUxD1gMgPZJYp3DWOp5jBuQAkcqvRsUqXI,4176
16
+ scanner/pixel_advanced.py,sha256=pbsB34Nc0YAbeAMxKCpbww1an6OOmpRR_u8hswvGSs4,23472
17
+ scanner/pixel_analysis.py,sha256=ZIpP1jfvzCAhjLyqvlI7ObGcM4axQFmDheIajs2R45M,9847
18
+ scanner/data/dicom_codec_cve.json,sha256=gqkFze8KB9tLyaxvDSJbsN_XR371_f704HMf8WazQu0,2823
19
+ scanner/data/vendor_private_tags.json,sha256=W5WaeIuRD0nJoFG6eVqM918ureM3zE_X82useNyzEaU,1333
20
+ dicomlock-0.7.0.dist-info/METADATA,sha256=tuPAPTy-MMqctkN5fb48SChe-q8--8TAObWGGUw5LRc,7725
21
+ dicomlock-0.7.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
22
+ dicomlock-0.7.0.dist-info/entry_points.txt,sha256=8U_ijIk79dG_mtE6E9YSD8JRQw3svK8G4KBZkFF6XMQ,47
23
+ dicomlock-0.7.0.dist-info/top_level.txt,sha256=uVdh7ZIJC9rjZQex7pba18nBuRRxFhjkFu4vHPiWTcw,8
24
+ dicomlock-0.7.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (82.0.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ dicomlock = scanner.cli:main
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Vijay Thakore
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1 @@
1
+ scanner
scanner/__init__.py ADDED
File without changes
scanner/_resources.py ADDED
@@ -0,0 +1,20 @@
1
+ """Locate packaged config data (codec-CVE map, vendor allowlist).
2
+
3
+ Resolves to scanner/data/<name> whether running from source or pip-installed. Falls back to a
4
+ project-root data/ dir so legacy/custom copies still work.
5
+ """
6
+
7
+ import os
8
+
9
+ _HERE = os.path.dirname(os.path.abspath(__file__))
10
+
11
+
12
+ def data_file(name: str) -> str:
13
+ candidates = [
14
+ os.path.join(_HERE, "data", name), # packaged (canonical)
15
+ os.path.join(os.path.dirname(_HERE), "data", name), # project-root fallback
16
+ ]
17
+ for path in candidates:
18
+ if os.path.exists(path):
19
+ return path
20
+ return candidates[0]
scanner/_sandbox.py ADDED
@@ -0,0 +1,107 @@
1
+ """
2
+ DicomLock — sandboxed pixel decode for CDR.
3
+
4
+ This is the ONE place DicomLock invokes a third-party image codec (libjpeg / OpenJPEG /
5
+ CharLS / OpenJPH / RLE) on untrusted bytes. Decoding compressed pixel data is the deep
6
+ memory-safety attack surface (the codec CVE class). We never run it in the tool's own process:
7
+ the decode happens in a resource-limited child process, so a codec segfault, OOM, or hang kills
8
+ the worker, and the caller quarantines the file instead of crashing the scanner.
9
+
10
+ This makes the "tool must not become the victim" property in THREAT_MODEL.md real rather than
11
+ just a deployment recommendation. Allocation/length/decompression bombs are still rejected by the
12
+ header-level checks BEFORE this worker is ever spawned; the rlimits here are defense in depth and
13
+ the timeout/signal handling is what contains a genuine codec memory fault.
14
+
15
+ The worker is invoked by file path (`python3 scanner/_sandbox.py <in> <out>`), so it has no
16
+ dependency on DicomLock's package imports and stays self-contained.
17
+ """
18
+
19
+ import os
20
+ import subprocess
21
+ import sys
22
+
23
+ # A codec decode on real clinical data is fast (ms). A worker that needs more than this much
24
+ # wall-clock or memory is treating the input as hostile; we kill it and quarantine.
25
+ TIMEOUT_S = 30
26
+ MEM_LIMIT_BYTES = 2 * 1024 ** 3 # 2 GiB address-space cap per worker
27
+
28
+ # The child script the parent spawns. Module-level so a containment self-test can point it at a
29
+ # deliberately crashing/hanging worker without shipping a vulnerable codec (see test_sandbox.py).
30
+ _WORKER = os.path.abspath(__file__)
31
+
32
+
33
+ def _limit_resources():
34
+ """Run in the child between fork and exec: cap address space + CPU time. Best-effort
35
+ (RLIMIT_AS is weakly enforced on some platforms); the subprocess timeout and signal-exit
36
+ detection below are the portable backstops for hang and crash."""
37
+ try:
38
+ import resource
39
+ resource.setrlimit(resource.RLIMIT_AS, (MEM_LIMIT_BYTES, MEM_LIMIT_BYTES))
40
+ resource.setrlimit(resource.RLIMIT_CPU, (TIMEOUT_S, TIMEOUT_S))
41
+ except Exception:
42
+ pass
43
+
44
+
45
+ def safe_transcode_to_native(in_path: str, out_path: str, timeout: int = TIMEOUT_S):
46
+ """Decode `in_path` and rewrite it as native Explicit VR LE at `out_path`, in a sandboxed
47
+ child process. Returns (ok: bool, reason: str).
48
+
49
+ ok=False means the codec crashed, hung, exhausted memory, or otherwise failed — the file is
50
+ NOT disarmable and the caller MUST quarantine it (we never trust a file whose decode
51
+ misbehaved). ok=True means `out_path` is a clean native file the parent can safely re-open
52
+ without ever invoking a codec again.
53
+ """
54
+ argv = [sys.executable, _WORKER, in_path, out_path]
55
+ try:
56
+ proc = subprocess.run(
57
+ argv, capture_output=True, timeout=timeout,
58
+ preexec_fn=_limit_resources if os.name == "posix" else None,
59
+ )
60
+ except subprocess.TimeoutExpired:
61
+ _unlink(out_path)
62
+ return False, f"sandboxed decode hung (> {timeout}s) — denial-of-service codec input"
63
+
64
+ if proc.returncode == 0 and os.path.exists(out_path) and os.path.getsize(out_path) > 0:
65
+ return True, "ok"
66
+
67
+ _unlink(out_path)
68
+ if proc.returncode < 0:
69
+ return False, (f"sandboxed decode crashed (killed by signal {-proc.returncode}) — "
70
+ "codec memory fault; file quarantined")
71
+ last = (proc.stderr.decode("utf-8", "ignore").strip().splitlines() or ["decode failed"])[-1]
72
+ return False, f"sandboxed decode failed: {last[:200]}"
73
+
74
+
75
+ def _unlink(path: str):
76
+ try:
77
+ os.unlink(path)
78
+ except OSError:
79
+ pass
80
+
81
+
82
+ def _worker(in_path: str, out_path: str) -> int:
83
+ """Child entry point: decode pixels (the dangerous codec call) and save native. Any failure
84
+ exits non-zero so the parent quarantines; a memory fault exits via signal, also caught."""
85
+ import pydicom
86
+ from pydicom.uid import ExplicitVRLittleEndian
87
+
88
+ ds = pydicom.dcmread(in_path, force=True)
89
+ try:
90
+ ds.decompress() # primary path: decode + set TransferSyntaxUID = Explicit VR LE
91
+ except Exception:
92
+ # Fallback: decode to an array and store raw uncompressed.
93
+ arr = ds.pixel_array
94
+ ds.PixelData = arr.tobytes()
95
+ ds.file_meta.TransferSyntaxUID = ExplicitVRLittleEndian
96
+ ds["PixelData"].VR = "OW" if int(getattr(ds, "BitsAllocated", 16)) > 8 else "OB"
97
+
98
+ try:
99
+ ds.save_as(out_path)
100
+ except TypeError:
101
+ ds.save_as(out_path, enforce_file_format=False)
102
+ return 0
103
+
104
+
105
+ if __name__ == "__main__":
106
+ _limit_resources()
107
+ sys.exit(_worker(sys.argv[1], sys.argv[2]))
scanner/calibration.py ADDED
@@ -0,0 +1,157 @@
1
+ """
2
+ DicomLock — Calibration Pipeline
3
+
4
+ Runs feature extraction on a corpus of known-real DICOM files to establish
5
+ per-modality baselines. These baselines define "what normal looks like"
6
+ so the scanner can flag statistical outliers.
7
+
8
+ Usage:
9
+ from scanner.calibration import calibrate, load_baselines
10
+
11
+ # Build baselines from a directory of real DICOM files
12
+ calibrate("path/to/real/dicoms", "data/baselines.json")
13
+
14
+ # Load baselines for use in scanning
15
+ baselines = load_baselines("data/baselines.json")
16
+ """
17
+
18
+ import json
19
+ import os
20
+ import sys
21
+ from collections import defaultdict
22
+ from pathlib import Path
23
+
24
+ import numpy as np
25
+ import pydicom
26
+
27
+ from scanner.pixel_advanced import extract_all_features
28
+
29
+
30
+ def calibrate(dicom_dir: str, output_path: str, verbose: bool = True) -> dict:
31
+ """
32
+ Run feature extraction on all DICOM files in a directory
33
+ and compute per-modality baseline statistics.
34
+
35
+ Args:
36
+ dicom_dir: Path to directory containing real DICOM files
37
+ output_path: Where to save the baselines JSON
38
+ verbose: Print progress
39
+
40
+ Returns:
41
+ The baselines dict (also saved to output_path)
42
+ """
43
+ # Collect all DICOM files
44
+ dcm_files = sorted(Path(dicom_dir).rglob("*.dcm"))
45
+ if verbose:
46
+ print(f"Found {len(dcm_files)} DICOM files in {dicom_dir}")
47
+
48
+ # Extract features from every file, grouped by modality
49
+ modality_features = defaultdict(list)
50
+ errors = 0
51
+ skipped = 0
52
+
53
+ for i, filepath in enumerate(dcm_files):
54
+ try:
55
+ ds = pydicom.dcmread(str(filepath), force=True)
56
+ features = extract_all_features(ds)
57
+
58
+ if features is None:
59
+ skipped += 1
60
+ continue
61
+
62
+ modality = features.pop("modality", "UNKNOWN")
63
+ # Remove non-numeric fields
64
+ features.pop("rows", None)
65
+ features.pop("cols", None)
66
+
67
+ modality_features[modality].append(features)
68
+
69
+ if verbose and (i + 1) % 50 == 0:
70
+ print(f" Processed {i + 1}/{len(dcm_files)} files...")
71
+ except Exception as e:
72
+ errors += 1
73
+ if verbose:
74
+ print(f" Error on {filepath.name}: {e}")
75
+
76
+ if verbose:
77
+ print(f"\nExtraction complete:")
78
+ for mod, feats in sorted(modality_features.items()):
79
+ print(f" {mod}: {len(feats)} files")
80
+ if skipped:
81
+ print(f" Skipped (no pixel data): {skipped}")
82
+ if errors:
83
+ print(f" Errors: {errors}")
84
+
85
+ # Compute statistics for each feature within each modality
86
+ baselines = {}
87
+ for modality, feature_list in modality_features.items():
88
+ if len(feature_list) < 3:
89
+ if verbose:
90
+ print(f"\n Skipping {modality} — too few samples ({len(feature_list)})")
91
+ continue
92
+
93
+ baselines[modality] = {
94
+ "_sample_count": len(feature_list),
95
+ }
96
+
97
+ # Get all feature keys
98
+ all_keys = set()
99
+ for f in feature_list:
100
+ all_keys.update(f.keys())
101
+
102
+ for key in sorted(all_keys):
103
+ values = [f[key] for f in feature_list if key in f and np.isfinite(f[key])]
104
+ if len(values) < 3:
105
+ continue
106
+
107
+ arr = np.array(values)
108
+ baselines[modality][key] = {
109
+ "mean": float(np.mean(arr)),
110
+ "std": float(np.std(arr)),
111
+ "median": float(np.median(arr)),
112
+ "min": float(np.min(arr)),
113
+ "max": float(np.max(arr)),
114
+ "p5": float(np.percentile(arr, 5)),
115
+ "p95": float(np.percentile(arr, 95)),
116
+ "n": len(values),
117
+ }
118
+
119
+ # Save
120
+ os.makedirs(os.path.dirname(output_path) or ".", exist_ok=True)
121
+ with open(output_path, "w") as f:
122
+ json.dump(baselines, f, indent=2)
123
+
124
+ if verbose:
125
+ total_features = sum(
126
+ len([k for k in v if not k.startswith("_")])
127
+ for v in baselines.values()
128
+ )
129
+ print(f"\nBaselines saved to {output_path}")
130
+ print(f" {len(baselines)} modalities, {total_features} total feature baselines")
131
+
132
+ return baselines
133
+
134
+
135
+ def load_baselines(path: str) -> dict:
136
+ """Load baselines from a JSON file."""
137
+ if not os.path.exists(path):
138
+ return {}
139
+ with open(path) as f:
140
+ return json.load(f)
141
+
142
+
143
+ # ---------------------------------------------------------------------------
144
+ # CLI entry point
145
+ # ---------------------------------------------------------------------------
146
+
147
+ if __name__ == "__main__":
148
+ if len(sys.argv) < 2:
149
+ print("Usage: python -m scanner.calibration <dicom_dir> [output.json]")
150
+ print(" Scans all .dcm files in <dicom_dir> and computes baselines.")
151
+ print(" Default output: data/baselines.json")
152
+ sys.exit(1)
153
+
154
+ dicom_dir = sys.argv[1]
155
+ output = sys.argv[2] if len(sys.argv) > 2 else "data/baselines.json"
156
+
157
+ calibrate(dicom_dir, output)