A tool for search paths from an NTFS volume on an image file.
Project description
ntfsfind
A tool for search file paths from an NTFS volume on an Image file.
Usage
$ ntfsfind {{query_regex}} /path/to/imagefile.raw
from ntfsfind import ntfsfind
# imagefile_path: str
# search_query: str
# volume_num: Optional[int] = None
# file_type: Literal['raw', 'e01'] = 'raw'
# multiprocess: bool = False
#
# -> List[str]
records = ntfsfind(
imagefile_path='./path/to/your/imagefile.raw',
search_query='.*\.evtx',
volume_num=2,
file_type='raw',
multiprocess=False
)
for record in records:
print(record)
Query
The query for ntfsfind is a regular expression of the file path to be extracted. The paths are separated by slashes.
e.g.
Original Path: C:\$MFT
Query: '/\$MFT'
# find Eventlogs
Query: '.*\.evtx'
# find Alternate Data Streams
Query: '.*:.*'
Example
Extracts $MFT information directly from image files in raw device mapping format.
ntfsfind can use regular expressions to search for files.
$ ntfsfind '.*\.evtx' /path/to//imagefile.raw
Windows/System32/winevt/Logs/Setup.evtx
Windows/System32/winevt/Logs/Microsoft-Windows-All-User-Install-Agent%4Admin.evtx
Logs/Windows PowerShell.evtx
Logs/Microsoft-Windows-Winlogon%4Operational.evtx
Logs/Microsoft-Windows-WinINet-Config%4ProxyConfigChanged.evtx
Logs/Microsoft-Windows-Windows Firewall With Advanced Security%4ConnectionSecurity.evtx
Logs/Microsoft-Windows-UserPnp%4ActionCenter.evtx
Logs/Microsoft-Windows-TerminalServices-RemoteConnectionManager%4Admin.evtx
Logs/Microsoft-Windows-TerminalServices-LocalSessionManager%4Admin.evtx
Logs/Microsoft-Windows-SMBServer%4Security.evtx
Logs/Microsoft-Windows-SMBServer%4Connectivity.evtx
Logs/Microsoft-Windows-SMBServer%4Audit.evtx
Logs/Microsoft-Windows-SmbClient%4Security.evtx
Logs/Microsoft-Windows-SMBClient%4Operational.evtx
Logs/Microsoft-Windows-Shell-Core%4ActionCenter.evtx
Logs/Microsoft-Windows-SettingSync%4Operational.evtx
...
When use with ntfsdump
Combined with ntfsdump, the retrieved files can be dumped directly from the image file.
$ ntfsfind '.*\.evtx' /path/to/imagefile.raw | ntfsdump /path/to/your/imagefile
https://github.com/sumeshi/ntfsdump
Options
--help, -h:
show help message and exit.
--version, -v:
show program's version number and exit.
--volume-num, -n:
NTFS volume number (default: autodetect).
--type, -t:
image file format (default: raw(dd-format)).
(raw|e01|vhd|vhdx|vmdk) are supported.
--multiprocess, -m:
flag to run multiprocessing.
Prerequisites
The image file to be processed must meet the following conditions.
- raw or e01 file format
- NT file system(NTFS)
- GUID partition table(GPT)
Additional file formats will be added in the future.
If you have any questions, please submit an issue.
Installation
via PyPI
$ pip install ntfsfind
Run with Docker
https://hub.docker.com/r/sumeshi/ntfsfind
$ docker run --rm -v $(pwd):/app -t sumeshi/ntfsfind:latest '/\$MFT' /app/sample.raw
Contributing
The source code for ntfsfind is hosted at GitHub, and you may download, fork, and review it from this repository(https://github.com/sumeshi/ntfsfind).
Please report issues and feature requests. :sushi: :sushi: :sushi:
License
ntfsfind is released under the LGPLv3+ License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ntfsfind-2.4.0.tar.gz.
File metadata
- Download URL: ntfsfind-2.4.0.tar.gz
- Upload date:
- Size: 18.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.9.10 Darwin/21.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5627f2133e1245395dec7a44db0aee7b766c74b61c662bf43298b24fe00f653
|
|
| MD5 |
028382b858056cb47d7e9400ff8fe1de
|
|
| BLAKE2b-256 |
342b04fd7fc3b89b428aec034b971189508d8cfd4a7ffb371c34373b41b15069
|
File details
Details for the file ntfsfind-2.4.0-py3-none-any.whl.
File metadata
- Download URL: ntfsfind-2.4.0-py3-none-any.whl
- Upload date:
- Size: 19.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.9.10 Darwin/21.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d41c2597c14bfcc48a9ef6c2d3d60d75e60da21b65ab1e72c7a7ff4a83862d3b
|
|
| MD5 |
645151cd960655383e6855109b5e6c19
|
|
| BLAKE2b-256 |
eba28a0c1f258ade5e9a2e7d0343eab833d47f78d650418631ba8380a7ef36c4
|