scancrypt 1.0.0__tar.gz

scancrypt-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 IronSights Pty Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scancrypt-1.0.0/NOTICE

@@ -0,0 +1,14 @@
+ScanCrypt, ransomware partial-recovery tool
+Copyright 2026 IronSights Pty Ltd
+
+This product includes software developed by IronSights Pty Ltd
+(https://ironsights.com.au).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.
+
+ScanCrypt recovers the portions of ransomware-encrypted files that were never
+actually encrypted. It is NOT a decryptor and does not break, weaken, or bypass
+any cryptography. It reads evidence strictly read-only and never modifies the
+files or devices it scans. It is provided free of charge and AS IS, without
+warranty of any kind and without liability, for lawful use on systems the
+operator is authorized to examine.

scancrypt-1.0.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: scancrypt
+Version: 1.0.0
+Summary: ScanCrypt: finds and extracts the parts of a ransomware-encrypted file that were never actually encrypted.
+Author-email: IronSights <team@scancrypt.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ironsightscyber/scancrypt
+Project-URL: Source, https://github.com/ironsightscyber/scancrypt
+Project-URL: Issues, https://github.com/ironsightscyber/scancrypt/issues
+Keywords: ransomware,incident-response,dfir,data-recovery,forensics,entropy
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: PySide6>=6.6
+Requires-Dist: numpy>=1.26
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: ntfs
+Requires-Dist: dissect.ntfs>=3; extra == "ntfs"
+Requires-Dist: dissect.hypervisor>=3; extra == "ntfs"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pyinstaller>=6.0; extra == "dev"
+Requires-Dist: dissect.ntfs>=3; extra == "dev"
+Requires-Dist: dissect.hypervisor>=3; extra == "dev"
+Requires-Dist: pillow>=10; extra == "dev"
+Dynamic: license-file
+
+# ScanCrypt — get back the data the ransomware never touched
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![CI](https://github.com/ironsightscyber/scancrypt/actions/workflows/ci.yml/badge.svg)](https://github.com/ironsightscyber/scancrypt/actions)
+
+Most ransomware is in a race: encrypting terabytes takes hours, so to finish before
+it's caught it only scrambles **part** of each large file — the first chunk, or stripes
+through it — then renames it so everything *looks* equally dead. It usually isn't.
+
+**ScanCrypt** scans an encrypted file or disk, measures exactly which bytes were never
+actually encrypted, and pulls those bytes back out — **no decryption key, no ransom.**
+It is not a decryptor; it's a ransomware-aware *partial-recovery* tool. Databases, VM
+disks, and backup archives are typically **mostly intact** underneath.
+
+Free and open source (Apache-2.0), **read-only**, by [IronSights](https://ironsights.com.au) ·
+[scancrypt.org](https://scancrypt.org) · [Plain-English guide for victims](docs/recover.html)
+
+> **Honest by design.** Recoverability is always reported as *most, not all*, with the
+> measured percentage. A partial file list is flagged as partial, never passed off as
+> complete. Family IDs are labelled *validated* vs *from public reporting*. Fully-encrypted
+> and small files are out of scope. Provided AS IS, no warranty; use only on systems you
+> are authorised to examine.
+
+---
+
+## Install
+
+**Just want to run it?** Download the app from the
+[releases page](https://github.com/ironsightscyber/scancrypt/releases/latest) —
+`scancrypt-gui.exe` (Windows) is a single portable file, nothing to install, fully offline.
+No terminal needed. New to this? Read the [plain-English guide](docs/recover.html).
+
+**From source (any OS):**
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate            # Windows: .venv\Scripts\activate
+pip install -e ".[ntfs]"             # ".[ntfs]" adds VHDX/VHD/VMDK + NTFS support
+scancrypt --help                     # or:  python -m rprt --help
+```
+
+`dissect.hypervisor` + `dissect.ntfs` (pulled in by `[ntfs]`) are what let ScanCrypt read
+files out of a virtual disk. Everything else works without them.
+
+---
+
+## Quickstart
+
+### 1. How much of a file/disk is recoverable?
+
+```bash
+scancrypt "SQL_DATA_D.vhdx"
+```
+
+```
+size        108.5 GB
+pattern     front-only
+recoverable 100.0%
+encrypted   0.0002%   258 KB at the front
+family      Makop / Phobos  (validated)
+```
+
+Add `--report triage.html` for a shareable HTML report, `--json out.json` for machine output.
+Scans stay fast **even on huge disks** — a 322 GB VM images in seconds, because finding the
+encryption boundary doesn't require reading the whole file.
+
+### 2. Recover files from a virtual disk (the headline workflow)
+
+Ransomware often encrypts a VM disk's header, so it won't mount. ScanCrypt rebuilds the disk
+from the block map that survived and reads the files straight out — names and folders intact.
+
+```bash
+scancrypt "SQL_DATA_D.vhdx" --list-volume            # see what's inside
+scancrypt "SQL_DATA_D.vhdx" --recover-files ./out    # copy the files out
+```
+
+Recover only specific files (near-instant, no full walk):
+
+```bash
+printf '/Program Files/.../DATA/production.mdf\n' > paths.txt
+scancrypt "SQL_DATA_D.vhdx" --recover-files ./out --only-paths paths.txt
+```
+
+If part of the disk didn't survive, the file list says so (`… (partial)`) instead of
+pretending it's complete.
+
+### 3. Check a recovered SQL Server database
+
+```bash
+scancrypt recovered.mdf --validate-sql
+```
+
+```
+253,478 valid SQL Server page(s)  (90.6%)   verdict: sql-data-present
+database name: production_db
+```
+
+A page-level integrity check (a structural analogue to DBCC), so you know what you got back
+before handing it to a DBA.
+
+### 4. Triage a whole share at once
+
+```bash
+scancrypt /mnt/encrypted_share --report incident.html --csv incident.csv
+```
+
+One incident-wide figure — *"across N files totalling X TB, this fraction is recoverable for
+free"* — with a per-file breakdown for a client or insurer.
+
+### 5. Extract the intact bytes of a single large file
+
+```bash
+scancrypt victim.bin --extract recovered.bin
+```
+
+---
+
+## Common options
+
+| Flag | What it does |
+|------|--------------|
+| `--report FILE` | standalone HTML triage report (add `--hash` to embed a SHA-256) |
+| `--json FILE` | full machine-readable report |
+| `--list-volume` | list every file in a virtual disk's NTFS volume |
+| `--recover-files DIR` | recover files from a VHDX/VHD/VMDK (rebuilds an encrypted-header disk) |
+| `--only-paths FILE` | with `--recover-files`, restrict to listed paths |
+| `--validate-sql` | page-level check of a recovered SQL Server MDF/NDF |
+| `--fingerprint` | emit a privacy-safe family signature stub + pre-filled issue link (no file contents) |
+| `--extract FILE` | write the intact byte ranges of a single file |
+| `--carve DIR` | carve loose files from the recoverable region (needs PhotoRec) |
+| `--boundary-only` | accept the fast front-boundary result; never do a full-disk read |
+| `--full` | force a full block-by-block scan (precise map, reads the whole file) |
+| `--audit-log FILE` | hash-chained, tamper-evident audit trail (+ `--case-id`, `--examiner`, `--evidence-id`) |
+
+Scan a raw disk in place (Windows, elevated prompt): `scancrypt \\.\PhysicalDrive1 --json triage.json`
+
+Evidence-grade run and later verification:
+
+```bash
+scancrypt disk.img --extract out.bin --audit-log audit.jsonl \
+    --case-id CASE-0001 --examiner "A. Analyst" --evidence-id DISK-01
+python -c "from rprt import forensics; print(forensics.verify_log('audit.jsonl'))"
+```
+
+---
+
+## How it works (four read-only stages)
+
+1. **Map the encryption.** An entropy scan brackets where the encryption starts and stops,
+   then binary-searches down to the byte. It stays cheap on huge disks and only escalates to
+   a full read when the evidence points to a genuine second encrypted region — not to the
+   scattered high-entropy blocks (databases, compressed content) that are normal on any disk.
+2. **Tell ciphertext from compression.** Encrypted and compressed data both look random; a
+   chi-square test plus archive-header checks separate real ciphertext from an ordinary zip,
+   image, or database blob, so recoverable data isn't written off.
+3. **Report the number.** A recoverable percentage, an entropy map, the strain, and the
+   limits stated plainly — per file, or rolled up across a whole share.
+4. **Recover.** Extract intact byte ranges; pull files out of a virtual disk (even one whose
+   header was destroyed); validate a recovered SQL database; carve loose files. Hashes are
+   recorded throughout.
+
+Recovery is **family-agnostic** — a wrong or unknown family guess never affects what comes
+back; identification only names the strain and sets expectations. Validated families
+(matched against real samples) vs public-reporting-only ones are labelled as such.
+
+---
+
+## Honest limits
+
+- Not decryption — it recovers bytes that were never encrypted; the rest stays locked.
+- Recovery is *most, not all*; the report gives a measured figure, not a promise every file opens.
+- Small files are usually encrypted end-to-end. The value is in big files: databases, VM disks, backups, media.
+- Periodic/intermittent patterns recover less cleanly than front-only.
+- No warranty, no liability. Authorised systems only.
+
+---
+
+## For developers
+
+### Dev setup
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+pytest
+```
+
+Run the GUI locally (works on macOS/Linux for development): `python -m rprt.gui`
+
+### Build the Windows app
+
+Must run on Windows (PyInstaller doesn't cross-compile):
+
+```powershell
+python -m venv .venv; .venv\Scripts\activate
+pip install -e ".[dev]"
+python build_scripts\build_windows.py     # -> dist\rprt-gui.exe (single file, no installer)
+```
+
+CI runs the suite on Ubuntu + Windows on every push and builds `rprt-gui.exe`; pushing a
+`v*` tag attaches it to a GitHub release.
+
+### Module map
+
+| Module | Responsibility |
+|--------|----------------|
+| `engine.py` | core scan / classify / boundary-search / extract |
+| `stats.py` | chi-square randomness test (encrypted vs compressed) |
+| `signatures.py` · `ransomnote.py` | ransomware fingerprinting from extension/footer and from ransom notes |
+| `formats.py` | container/filesystem detection on the recoverable region (VHDX, ZIP/OOXML, NTFS/FAT, …) |
+| `ntfs.py` | read files out of an NTFS volume inside a partially-encrypted / header-encrypted virtual disk |
+| `sqlpages.py` | page-level SQL Server MDF/NDF recovery-quality check |
+| `carve.py` | orchestrates PhotoRec over the recoverable region |
+| `batch.py` | incident-wide directory triage + rollup |
+| `report.py` | standalone HTML triage report (inline CSS + SVG entropy map) |
+| `forensics.py` | before/after integrity proof + hash-chained audit log + case metadata |
+| `source.py` | read-only input abstraction (files, images, raw Windows devices) |
+| `gui.py` · `cli.py` | PySide6 desktop app · command-line entry point |
+
+### Help ScanCrypt recognise a strain it doesn't name yet
+
+Point it at one encrypted file:
+
+```bash
+scancrypt "somefile.newcrypt" --fingerprint
+```
+
+It prints a **privacy-safe** stub — extension, the family's trailing magic-candidate bytes,
+the encryption pattern, and any nearby ransom note — as a ready-to-paste `signatures.yaml`
+block **and** a pre-filled [GitHub issue](https://github.com/ironsightscyber/scancrypt/issues/new?template=ransomware-sample.yml)
+link. It reads **no file contents**, so a victim can submit safely. (In the app: *Help improve
+ScanCrypt…* after a scan.)
+
+Contributions welcome — especially **new verified family signatures** (see
+[CONTRIBUTING.md](CONTRIBUTING.md)).
+
+---
+
+*ScanCrypt does not break, weaken, or bypass cryptography, and it does not recover
+fully-encrypted data. Need an incident handled end to end — full extraction, database
+rebuilds, forensic reporting? [IronSights](https://ironsights.com.au) does that as a paid
+engagement; the tool stays free.*