{"id":34838961,"url":"https://github.com/sumeshi/ntfsdump","last_synced_at":"2026-02-21T21:13:09.139Z","repository":{"id":57447137,"uuid":"278140044","full_name":"sumeshi/ntfsdump","owner":"sumeshi","description":"An efficient tool for extracting files, directories, and alternate data streams directly from NTFS image files.","archived":false,"fork":false,"pushed_at":"2024-02-21T20:08:46.000Z","size":237,"stargazers_count":22,"open_issues_count":4,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-01-25T16:20:50.352Z","etag":null,"topics":["dfir","e01","forensics","ntfs","python","raw","sleuthkit","vhd","vhdx","vmdk"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/ntfsdump/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sumeshi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-07-08T16:27:00.000Z","updated_at":"2025-10-16T01:53:30.000Z","dependencies_parsed_at":"2023-11-12T16:30:09.928Z","dependency_job_id":null,"html_url":"https://github.com/sumeshi/ntfsdump","commit_stats":{"total_commits":135,"total_committers":4,"mean_commits":33.75,"dds":"0.23703703703703705","last_synced_commit":"fc1c94e810b763eb03fde37c635fc437570db744"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/sumeshi/ntfsdump","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Fntfsdump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Fntfsdump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Fntfsdump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Fntfsdump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sumeshi","download_url":"https://codeload.github.com/sumeshi/ntfsdump/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Fntfsdump/sbom","scorecard":{"id":858236,"data":{"date":"2025-08-11","repo":{"name":"github.com/sumeshi/ntfsdump","commit":"89042557e65207cd4fdce1dac0be2417bc3807b3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-binary-pypi.yaml:1","Warn: no topLevel permission defined: .github/workflows/publish-release.yaml:1","Warn: no topLevel permission defined: .github/workflows/test.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v2.5.3 not signed: https://api.github.com/repos/sumeshi/ntfsdump/releases/131274051","Warn: release artifact v2.4.0 not signed: https://api.github.com/repos/sumeshi/ntfsdump/releases/63528595","Warn: release artifact v2.3.5 not signed: https://api.github.com/repos/sumeshi/ntfsdump/releases/63450920","Warn: release artifact v2.5.3 does not have provenance: https://api.github.com/repos/sumeshi/ntfsdump/releases/131274051","Warn: release artifact v2.4.0 does not have provenance: https://api.github.com/repos/sumeshi/ntfsdump/releases/63528595","Warn: release artifact v2.3.5 does not have provenance: https://api.github.com/repos/sumeshi/ntfsdump/releases/63450920"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-binary-pypi.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-binary-pypi.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-binary-pypi.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-binary-pypi.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-release.yaml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/publish-release.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/test.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/sumeshi/ntfsdump/test.yaml/master?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:1: pin your Docker image by updating python:3.11.0-bullseye to python:3.11.0-bullseye@sha256:d7d20249ea6c872f67a760fd05ba0f06c5c4ae3debfb48dcc5582bad570cb44c","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.11-bullseye to python:3.11-bullseye@sha256:df0bd610af061603b29d63eb82027b64d5a3f15506e39270422b10b2a55079fc","Warn: pipCommand not pinned by hash: .devcontainer/Dockerfile:11","Warn: pipCommand not pinned by hash: .devcontainer/Dockerfile:11","Warn: pipCommand not pinned by hash: Dockerfile:5","Warn: pipCommand not pinned by hash: Dockerfile:5","Warn: pipCommand not pinned by hash: .github/workflows/publish-binary-pypi.yaml:19","Warn: pipCommand not pinned by hash: .github/workflows/publish-binary-pypi.yaml:20","Warn: pipCommand not pinned by hash: .github/workflows/publish-release.yaml:103","Warn: pipCommand not pinned by hash: .github/workflows/publish-release.yaml:112","Warn: pipCommand not pinned by hash: .github/workflows/test.yaml:27","Info:   0 out of   8 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   0 out of   2 containerImage dependencies pinned","Info:   0 out of   9 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"14 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6","Warn: Project is vulnerable to: PYSEC-2024-230 / GHSA-248v-346w-9cwc","Warn: Project is vulnerable to: GHSA-3ww4-gg4f-jr7f","Warn: Project is vulnerable to: PYSEC-2024-225 / GHSA-6vqw-3v5j-54x4","Warn: Project is vulnerable to: GHSA-9v9h-cgj8-h64p","Warn: Project is vulnerable to: GHSA-h4gh-qq45-vh27","Warn: Project is vulnerable to: PYSEC-2023-254 / GHSA-jfhm-5ghh-2f97","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2024-187 / GHSA-rqc4-2hc7-8c8v","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T00:29:39.754Z","repository_id":57447137,"created_at":"2025-08-24T00:29:39.754Z","updated_at":"2025-08-24T00:29:39.754Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29694200,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T18:18:25.093Z","status":"ssl_error","status_checked_at":"2026-02-21T18:18:22.435Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dfir","e01","forensics","ntfs","python","raw","sleuthkit","vhd","vhdx","vmdk"],"created_at":"2025-12-25T16:58:07.484Z","updated_at":"2026-02-21T21:13:09.132Z","avatar_url":"https://github.com/sumeshi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ntfsdump\n\n[![LGPLv3+ License](http://img.shields.io/badge/license-LGPLv3+-blue.svg?style=flat)](LICENSE)\n[![PyPI version](https://badge.fury.io/py/ntfsdump.svg)](https://badge.fury.io/py/ntfsdump)\n[![Python Versions](https://img.shields.io/pypi/pyversions/ntfsdump.svg)](https://pypi.org/project/ntfsdump/)\n[![pytest](https://github.com/sumeshi/ntfsdump/actions/workflows/test.yaml/badge.svg)](https://github.com/sumeshi/ntfsdump/actions/workflows/test.yaml)\n\n![ntfsdump logo](https://gist.githubusercontent.com/sumeshi/c2f430d352ae763273faadf9616a29e5/raw/baa85b045e0043914218cf9c0e1d1722e1e7524b/ntfsdump.svg)\n\nAn efficient tool for extracting files, directories, and alternate data streams directly from NTFS image files.\n\n## 🚀 Overview\n\n`ntfsdump` allows digital forensic investigators and incident responders to seamlessly extract records from disk images without needing to mount them. By leveraging powerful backend libraries like `pytsk3` and `libyal`, it supports reading from standard disk image formats (RAW, E01, VHD(x), VMDK) and reliably dumps NTFS structures.\n\n## 📦 Features\n\n- **Direct Extraction**: Avoid mounting overhead by extracting files directly from NTFS partitions.\n- **Support Multiple Formats**: Read from `.raw`, `.e01`, `.vhd`, `.vhdx`, and `.vmdk`.\n- **Recursive Directory Dumping**: Extract entire folders seamlessly.\n- **Alternate Data Stream (ADS)**: Supports extracting hidden alternate data streams.\n- **Intelligent Path Reconstruction**: When outputting single files embedded deep in directories with an absolute path (e.g. `\\Windows\\System32...`), `ntfsdump` reconstructs the directory structure in the output destination folder to keep artifacts perfectly organized.\n- **Glob \u0026 Wildcard Queries**: Basic support for extracting matched artifacts (e.g. `.*`).\n- **Use as a CLI or Python Module**: Highly flexible to integrate into other automated tools.\n\n## ⚙️ Execution Environment\n\n- **Python**: Compatible with Python 3.13+.\n- **Precompiled Binaries**: Available for both Windows and Linux in the [GitHub releases](https://github.com/sumeshi/ntfsdump/releases) section.\n\n\n## 📂 Installation\n\n```bash\n# From PyPI\npip install ntfsdump\n\n# Form GitHub Releases (Precompiled Binaries)\nchmod +x ./ntfsdump\n./ntfsdump --help\n```\n\n## 🛠️ Requirements \u0026 File Prerequisites\n\nThe image file must meet the following conditions:\n- **Formats**: `raw`, `e01`, `vhd`, `vhdx`, `vmdk`.\n- **File System**: `NTFS`.\n- **Partition Table**: `GPT` (MBR will usually be auto-detected, but GPT is officially supported).\n\n\n## 💻 Usage\n\n### Command Line Interface\n\nYou can pass arguments directly into the CLI. Output paths can be either file paths or directory paths.\n\n```bash\nntfsdump [OPTIONS] \u003cIMAGE\u003e [PATHS...]\n```\n\n**Options**:\n- `--help`, `-h`: Show help message.\n- `--version`, `-V`: Display program version.\n- `--quiet`, `-q`: Suppress stdout output.\n- `--no-log`: Prevent log file creation.\n- `--flat`: Extract all artifacts purely into a single folder without reconstructing directories.\n- `--volume`, `-n`: Target specific NTFS volume number (default: auto-detects main OS volume).\n- `--format`, `-f`: Image file format (default: `raw`). Options: `raw`, `e01`, `vhd`, `vhdx`, `vmdk`.\n- `--output`, `-o`: Directory or file to save exported outputs.\n\n#### Examples\n\nDump a single file:\n```bash\nntfsdump -o ./dump ./path/to/your/image.raw /$MFT\n```\n\nDump an entire directory recursively:\n```bash\nntfsdump -o ./dump ./path/to/your/image.raw /Windows/System32/winevt/Logs\n```\n\nExtracting from split E01 images (Provide the starting segment `.E01`):\n```bash\nntfsdump --format=e01 -o ./dump ./path/to/your/image.E01 /Windows/System32/winevt/Logs\n```\n\nUsing with [ntfsfind](https://github.com/sumeshi/ntfsfind) over standard input (pipe):\n```bash\nntfsfind '.*\\.evtx' ./image.raw | ntfsdump -o ./dump ./image.raw\n```\n*Note: Any absolute path (starting with `/` or `\\`) passed over stdin via tools like `ntfsfind` will automatically be cleaned, and the folder hierarchy will be rebuilt faithfully inside your local output directory (`./dump/Windows/System32/winevt/Logs/System.evtx`).*\n\n### Python Module\n\nYou can incorporate `ntfsdump` logic into your own scripts.\n\n```python\nfrom ntfsdump import ntfsdump\n\nntfsdump(\n    image='./path/to/your/image.raw',\n    paths=['/Windows/System32/winevt/Logs'],\n    output='./dump',\n    volume=2,\n    format='raw'\n)\n```\n\n## 🔍 Query Syntax\n\n**`ntfsdump` utilizes UNIX-like path separators (`/`) for queries.** Paths are case-sensitive relative to the target volume structure.\n- **File**: `/$MFT` -\u003e extracts `$MFT`\n- **ADS**: `/$Extend/$UsnJrnl:$J` -\u003e extracts the `$J` ADS file from `$UsnJrnl`.\n- **Directory**: `/Windows/System32/winevt/Logs` -\u003e extracts all event logs recursively.\n- **Prefix Expansion**: `/Windows/Prefetch/.*` -\u003e extracts all files located in the `Prefetch` dir.\n\n## 📝 Logs\n\nBy default, an execution log (e.g. `ntfsdump_20240101_153205_1234.log`) is generated in the current directory to safely record which files were successfully dumped or failed.\n*To disable logging entirely, append the `--no-log` flag.*\n\n## 🤝 Contributing\n\nWe welcome reports, issues, and feature requests. Please do so on the [GitHub repository](https://github.com/sumeshi/ntfsdump). :sushi: :sushi: :sushi:\n\n## 📜 License\n\nReleased under the [LGPLv3+](LICENSE) License.\n\nPowered by:\n- [pytsk](https://github.com/py4n6/pytsk)\n- [libewf](https://github.com/libyal/libewf)\n- [libvhdi](https://github.com/libyal/libvhdi)\n- [libvmdk](https://github.com/libyal/libvmdk)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumeshi%2Fntfsdump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsumeshi%2Fntfsdump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumeshi%2Fntfsdump/lists"}