dicomlock 0.7.0__tar.gz
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.
- dicomlock-0.7.0/LICENSE +201 -0
- dicomlock-0.7.0/PKG-INFO +136 -0
- dicomlock-0.7.0/README.md +96 -0
- dicomlock-0.7.0/dicomlock.egg-info/PKG-INFO +136 -0
- dicomlock-0.7.0/dicomlock.egg-info/SOURCES.txt +27 -0
- dicomlock-0.7.0/dicomlock.egg-info/dependency_links.txt +1 -0
- dicomlock-0.7.0/dicomlock.egg-info/entry_points.txt +2 -0
- dicomlock-0.7.0/dicomlock.egg-info/requires.txt +17 -0
- dicomlock-0.7.0/dicomlock.egg-info/top_level.txt +1 -0
- dicomlock-0.7.0/pyproject.toml +57 -0
- dicomlock-0.7.0/scanner/__init__.py +0 -0
- dicomlock-0.7.0/scanner/_resources.py +20 -0
- dicomlock-0.7.0/scanner/_sandbox.py +107 -0
- dicomlock-0.7.0/scanner/calibration.py +157 -0
- dicomlock-0.7.0/scanner/classify.py +139 -0
- dicomlock-0.7.0/scanner/cli.py +240 -0
- dicomlock-0.7.0/scanner/codec_cve.py +134 -0
- dicomlock-0.7.0/scanner/data/dicom_codec_cve.json +57 -0
- dicomlock-0.7.0/scanner/data/vendor_private_tags.json +19 -0
- dicomlock-0.7.0/scanner/deid_auditor.py +715 -0
- dicomlock-0.7.0/scanner/disarm.py +245 -0
- dicomlock-0.7.0/scanner/file_security.py +334 -0
- dicomlock-0.7.0/scanner/findings.py +68 -0
- dicomlock-0.7.0/scanner/ingest.py +66 -0
- dicomlock-0.7.0/scanner/metadata.py +502 -0
- dicomlock-0.7.0/scanner/pipeline.py +105 -0
- dicomlock-0.7.0/scanner/pixel_advanced.py +633 -0
- dicomlock-0.7.0/scanner/pixel_analysis.py +300 -0
- dicomlock-0.7.0/setup.cfg +4 -0
dicomlock-0.7.0/LICENSE
ADDED
|
@@ -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.
|
dicomlock-0.7.0/PKG-INFO
ADDED
|
@@ -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
|
+
[](https://pypi.org/project/dicomlock/)
|
|
46
|
+
[](LICENSE)
|
|
47
|
+
[](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,96 @@
|
|
|
1
|
+
# DicomLock
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
[](https://pypi.org/project/dicomlock/)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
[](https://www.python.org/downloads/)
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
This is Content Disarm and Reconstruction (CDR) for DICOM, built to be open and auditable.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install dicomlock
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The core install pulls in the decoder backends (gdcm and pylibjpeg) so disarm works out of the box. Two optional extras:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
pip install "dicomlock[server]" # web UI and REST API
|
|
23
|
+
pip install "dicomlock[full]" # PHI / de-identification audit and legacy forensics
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Python 3.10 or newer.
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
dicomlock file.dcm # scan one file
|
|
32
|
+
dicomlock folder/ # scan every .dcm in a folder
|
|
33
|
+
dicomlock folder/ --disarm # scan, then disarm or quarantine each file
|
|
34
|
+
dicomlock file.dcm --deid # add the PHI / de-identification audit
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
As a library:
|
|
38
|
+
|
|
39
|
+
```python
|
|
40
|
+
from scanner.pipeline import run_security_scan, disarm_or_quarantine, is_dangerous
|
|
41
|
+
|
|
42
|
+
report = run_security_scan("file.dcm")
|
|
43
|
+
if is_dangerous(report):
|
|
44
|
+
result = disarm_or_quarantine("file.dcm") # {"action": "disarmed" | "quarantined", ...}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Web UI and API:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
python server.py # http://localhost:8899
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Uploads are scanned in a temp directory and deleted right after, so PHI is never persisted.
|
|
54
|
+
|
|
55
|
+
## How it works
|
|
56
|
+
|
|
57
|
+
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.
|
|
58
|
+
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.
|
|
59
|
+
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.
|
|
60
|
+
|
|
61
|
+
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.
|
|
62
|
+
|
|
63
|
+
## Why this is a real problem
|
|
64
|
+
|
|
65
|
+
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).
|
|
66
|
+
|
|
67
|
+
DicomLock works on the file. It does not break or weaken encryption and makes no claim to.
|
|
68
|
+
|
|
69
|
+
## Results
|
|
70
|
+
|
|
71
|
+
All reproducible from the scripts in [`_attack_test/`](_attack_test/):
|
|
72
|
+
|
|
73
|
+
- Zero false positives across 575 real clinical CT files, and zero on a separate mixed-compression corpus spanning 12 transfer syntaxes.
|
|
74
|
+
- 20 of 20 crafted attack fixtures flagged by the expected check.
|
|
75
|
+
- pydicom, GDCM, and dcmtk accept the weaponized files without complaint; DicomLock flags every one.
|
|
76
|
+
- Disarmed pixels are bit-exact against two independent decoders (GDCM and pylibjpeg) on every lossless sample.
|
|
77
|
+
- The codec decode is sandboxed, so a crashing or hanging decoder is contained and the file is quarantined, not the tool.
|
|
78
|
+
|
|
79
|
+
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.
|
|
80
|
+
|
|
81
|
+
## Where it fits
|
|
82
|
+
|
|
83
|
+
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.
|
|
84
|
+
|
|
85
|
+
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.
|
|
86
|
+
|
|
87
|
+
## Documentation
|
|
88
|
+
|
|
89
|
+
- [THREAT_MODEL.md](THREAT_MODEL.md), attacks defended and explicit non-claims
|
|
90
|
+
- [ARCHITECTURE.md](ARCHITECTURE.md), module specs
|
|
91
|
+
- [CONTRIBUTING.md](CONTRIBUTING.md), how to help with the CVE map, vendor allowlist, and codecs
|
|
92
|
+
- [SECURITY.md](SECURITY.md), vulnerability disclosure
|
|
93
|
+
|
|
94
|
+
## License
|
|
95
|
+
|
|
96
|
+
[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,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
|
+
[](https://pypi.org/project/dicomlock/)
|
|
46
|
+
[](LICENSE)
|
|
47
|
+
[](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,27 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
dicomlock.egg-info/PKG-INFO
|
|
5
|
+
dicomlock.egg-info/SOURCES.txt
|
|
6
|
+
dicomlock.egg-info/dependency_links.txt
|
|
7
|
+
dicomlock.egg-info/entry_points.txt
|
|
8
|
+
dicomlock.egg-info/requires.txt
|
|
9
|
+
dicomlock.egg-info/top_level.txt
|
|
10
|
+
scanner/__init__.py
|
|
11
|
+
scanner/_resources.py
|
|
12
|
+
scanner/_sandbox.py
|
|
13
|
+
scanner/calibration.py
|
|
14
|
+
scanner/classify.py
|
|
15
|
+
scanner/cli.py
|
|
16
|
+
scanner/codec_cve.py
|
|
17
|
+
scanner/deid_auditor.py
|
|
18
|
+
scanner/disarm.py
|
|
19
|
+
scanner/file_security.py
|
|
20
|
+
scanner/findings.py
|
|
21
|
+
scanner/ingest.py
|
|
22
|
+
scanner/metadata.py
|
|
23
|
+
scanner/pipeline.py
|
|
24
|
+
scanner/pixel_advanced.py
|
|
25
|
+
scanner/pixel_analysis.py
|
|
26
|
+
scanner/data/dicom_codec_cve.json
|
|
27
|
+
scanner/data/vendor_private_tags.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
pydicom>=2.4.0
|
|
2
|
+
numpy>=1.24.0
|
|
3
|
+
python-gdcm>=3.0.0
|
|
4
|
+
pylibjpeg>=2.0.0
|
|
5
|
+
pylibjpeg-libjpeg>=2.0.0
|
|
6
|
+
pylibjpeg-openjpeg>=2.0.0
|
|
7
|
+
|
|
8
|
+
[full]
|
|
9
|
+
scipy>=1.11.0
|
|
10
|
+
scikit-image>=0.21.0
|
|
11
|
+
Pillow>=10.0.0
|
|
12
|
+
PyWavelets>=1.4.0
|
|
13
|
+
|
|
14
|
+
[server]
|
|
15
|
+
fastapi>=0.110.0
|
|
16
|
+
uvicorn>=0.29.0
|
|
17
|
+
python-multipart>=0.0.9
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
scanner
|