Commit Graph
86 Commits
Author SHA1 Message Date
NK 35fc30e0a3 Add GitHub issue templates for bug reports and feature requests
Bug template requires: vmkatz version, input format, guest OS/arch,
host platform, filesystem, full command output, and file details.
Blank issues disabled to enforce structured reports.
2026-03-18 23:26:06 +01:00
NK 3706710552 Add x86 EPROCESS offsets for Vista/Win7/Win8/8.1 and fix Vista x86 classification
- Add EPROCESS offset tables for Vista SP2 x86, Win7 SP1 x86, Win8/8.1 x86
- Fix is_prevista_x86 threshold: Vista x86 (PID=0x9C) uses AES/3DES like
  Win7+, not DES-X/RC4. Tighten cutoff from 0xA0 to 0x98.
- Update README: 18 offset tables, correct x86 support status
2026-03-18 00:03:20 +01:00
NK e2c078d4f7 Bump version to 1.2.2 v1.2.2 2026-03-17 23:27:00 +01:00
NK 06397923d2 Flip EPT scanning to opt-in and remove dev examples from repo
EPT scanning (for VBS/Credential Guard VMs) is now disabled by default
and enabled with --ept, since the vast majority of VMs don't use VBS.
Previously it was enabled by default and disabled with --no-ept.

Also remove examples/ (dev-only test utilities) from tracking.
2026-03-17 23:24:03 +01:00
NK 97d1d18c6f Support VBox 5.x-7.x PGM saved state versions in .sav parser
The PGM struct fields size varies by VirtualBox version:
- v14 (VBox 7.x): 78 bytes — existing behavior
- v12-13 (VBox 5.x-6.x): 74 bytes — no cBalloonedPages field
- v11 (VBox 4.1+): 70 bytes — pre-balloon support

Previously hardcoded to skip(78), which corrupted RAM extraction
for any .sav file not from VBox 7.x. Now reads the PGM unit
version from the unit header and adapts accordingly.
2026-03-17 23:16:40 +01:00
NK 6a52381e46 Update README.md
- Split Quick Start into basic and advanced sections
- Fix binary size: ~5 MB → ~3 MB in ESXi deploy section
- Update module architecture tree with all source files:
  disk/ (vmdk, vdi, qcow2, vhd, vhdx, raw), sam/ (hive, bootkey,
  hashes, lsa, cache, dpapi_masterkey, ntfs_fallback), paging/
  (translate, entry, filebacked), pe/, utils
2026-03-17 14:42:46 +01:00
NK 4afa6eec69 Update README.md
- Add DPAPI master key hashes (hashcat 15300/15900) to disk extraction list
- Document missing CLI options: -r/--recurse, --scan, --provider, --no-ept,
  -v/--verbose, --build, --format brief
- Add brief format to output formats table
- Add dissect.vmfs (Fox-IT) and vmfs-tools to acknowledgements
2026-03-17 14:18:13 +01:00
NK 90074c601a Update README.md 2026-03-17 12:23:09 +01:00
NK 2f01b48258 Validate GPT entry size before allocation and slice access
Reject entry_size outside 128-4096 range to prevent:
- panic on slice &entry[0..16] when entry_size < 16
- OOM allocation from forged u32 entry_size
GPT spec mandates minimum 128 bytes per partition entry.
2026-03-17 02:16:51 +01:00
NK a1e0a65e7f Fix VDI parent resolution and coalesce_pages overflow
- VDI: search for location= attribute AFTER the UUID match, not in a
  window that extends 200 bytes before it. Prevents picking a location
  from a different HardDisk entry in multi-disk .vbox files.
- dump: use saturating_add/sub in coalesce_pages to prevent u64
  overflow on kernel addresses near 0xFFFFFFFFFFFFF000.
2026-03-17 01:52:05 +01:00
NK 75b2351363 Fix cfg gate on fmt_lm_pwdump: sam feature, not ntds.dit
The function is used by both SAM and NTDS output paths. Gating it on
ntds.dit broke compilation when sam was enabled without ntds.dit
(e.g. --features sam or --features vmfs).
2026-03-17 01:48:26 +01:00
NK 09dae5b16c Cap QCOW2 L1 table allocation and fix VMware tag parsing
- QCOW2: cap l1_table pre-allocation to 1M entries to prevent OOM
  from forged l1_size in header (actual entries read from file)
- VMware tags: validate all index bytes are available before parsing,
  break out of tag loop instead of producing truncated indices
2026-03-17 01:41:56 +01:00
NK 873c93357d Validate NTFS boot sector cluster_size and record_size
Reject zero values parsed from untrusted NTFS metadata to prevent
division-by-zero panics in cluster offset and MFT record calculations.
2026-03-17 01:40:05 +01:00
NK f99b1a4c74 Guard VMware parser against malformed .vmsn files
- Bounds-check tag_start before slicing vmsn_data (prevents panic on
  forged memory_group.offset beyond file size)
- Cap Vec::with_capacity for group_count based on actual data size
  (prevents OOM from forged u32 in header)
- Cap regions Vec::with_capacity to 4096 (prevents OOM from forged
  regionsCount tag value)
2026-03-17 01:33:35 +01:00
NK e538e27209 Harden SAM/ESE/VMFS parsers against malformed inputs
- SAM hashes: use saturating_add + checked_add for V-value offset
  calculations to prevent overflow on crafted hive data
- ESE: check tag_idx overflow in read_tag before subtraction from
  page_size (prevents wrap-around on large tag indices)
- ESE: explicit guard last_var_id < 128 in variable column parsing
  to prevent underflow in offset table size calculation
- VMFS flat VMDK: guard block_size == 0 in resolve_position and Read
  impl to prevent division by zero on corrupt superblock
2026-03-17 01:29:33 +01:00
NK f798f59224 Harden parsers against malformed inputs
- MSV: propagate arch parameter instead of hardcoding Arch::X64,
  fixes credential extraction on x86/WoW64 processes
- VMDK: validate grain_size != 0 and numGTEsPerGT != 0 (div-by-zero)
- VMDK: reject extent number 0 in parse_extent_number (underflow)
- VHDX: validate block_size and logical_sector_size != 0
- VHD: validate block_size != 0 in dynamic header
- VMFS: guard file_block_size, clusters_per_group, and
  parent_resources_per_group against zero (div-by-zero)
- QEMU ELF: use checked arithmetic for program header offsets
- VMware tags: bounds-check data_size before advancing parse position
- Process walk: guard flink_phys underflow in enumerate_processes
2026-03-17 01:22:11 +01:00
NK 1658606d1a Bump version to v1.2.1
- Fix SSP decryption: use AES-CFB-8 instead of CFB-128 (matches mimikatz)
- Fix machine account password display: raw hex instead of lossy UTF-16
- Truncate decrypted passwords to UNICODE_STRING.Length (drop padding)
v1.2.1
2026-03-16 23:34:33 +01:00
NK 5115e632ef Fix lossy password decoding for machine accounts
- Truncate decrypted password to UNICODE_STRING.Length bytes (was using
  MaximumLength, including garbage padding after the actual data)
- Add decode_password_bytes: hex-encode raw bytes directly for binary
  passwords instead of round-tripping through lossy UTF-16LE decode
  (char::REPLACEMENT_CHARACTER destroyed original bytes)
- Apply to all providers via decrypt_unicode_string_password_arch and
  the SSP-specific CFB-8 variant
- Update CSV/text output to use raw hex for binary passwords
2026-03-16 23:28:18 +01:00
NK 5f24e8f528 Add missing vmrs.rs module 2026-03-16 23:02:10 +01:00
NK dab403c139 Bump version to v1.2.0
- Fix SSP decryption: use AES-CFB-8 (8-bit segments) instead of CFB-128.
  SSP is the only LSASS provider using CFB-8 (mimikatz: KP_MODE_BITS=8).
  Previously produced garbage output for SSP passwords.
- Fix .vmsn hang: mmap metadata instead of loading entire multi-GB file
- Reduce EPT scan budget (4GB cap, 1GB gap) for faster non-VBS bail-out
- Fix crash on ESXi: spawn 8MB stack thread (ESXi default is 512KB)
- Add credential deduplication: merge duplicate sessions by default (-a for all)
- Add version banner at startup
- Fix snapshot labels: recognize .vmss and .vmrs extensions
- Add Hyper-V VMRS saved state support
- Add Clone derives on credential types
v1.2.0
2026-03-16 22:57:08 +01:00
NK 55aa12199c Update README.md 2026-03-16 18:08:30 +01:00
NK 9014a3f2ef Bump version to v1.1.1
- Fix .vmsn hang: use mmap instead of fs::read for metadata parsing,
  avoiding multi-GB allocation on embedded memory snapshots
- Reduce EPT scan budget (4GB cap, 1GB gap limit) for faster bail-out
  on non-VBS VMs (70s → 10s on 16GB snapshot)
v1.1.1
2026-03-16 18:05:57 +01:00
NK f6001f8a0b Bump version to v1.1.0
New features: VMFS-6 raw SCSI parser, native Hyper-V VMRS parser.
v1.1.0
2026-03-10 11:01:47 +01:00
NK 9c74207520 Expand VMFS-6 section with discovery, auto-scan, and internals
Detail the --vmfs-list device discovery with example output, single-VM
vs auto-scan extraction modes, NTFS partition filtering for batch mode,
and the on-disk resolution chain diagram.
2026-03-10 10:55:32 +01:00
NK 8ddbcd28c4 Update README with VMFS-6 raw parser and Hyper-V VMRS support
Add documentation for two major new features:
- VMFS-6 raw SCSI device parser that bypasses ESXi file locks on running VMs
- Native Hyper-V .vmrs saved state parser (reverse-engineered, no Microsoft DLL)
2026-03-10 10:53:45 +01:00
NK 6c35d9f242 Add VMFS feature flag, device enumeration, and fix all clippy warnings
VMFS module:
- Gate behind `vmfs` Cargo feature (included in defaults, depends on sam)
- Add --vmfs-list to discover VMFS-6 devices and flat VMDKs on ESXi
- Add --vmfs-device/--vmdk auto-scan with NTFS partition pre-check
- Fix label reading: use data_offset at LVM header 0x7A (not 0xC8)
- Filter out duplicate vml. symlink devices

Clippy fixes across all feature combinations:
- Remove unused fields, methods, constants in vmfs.rs
- Remove redundant `as u64` casts, use div_ceil()
- Gate MSSK_TAG and fmt_lm_pwdump behind their feature flags
- Simplify boolean expressions in ntfs_fallback.rs
- Suppress unit-type warnings for PagefileRef/DiskPathRef cfg stubs

Zero warnings on: --features vmware, all-except-vmfs, --all-features.
2026-03-10 03:01:13 +01:00
NK 2beb89a745 Add resilient I/O for reading live/in-use block devices
On Proxmox (and ESXi with VMFS), reading disk images of running VMs
can hit transient I/O errors on individual sectors/clusters that are
temporarily locked by the hypervisor.

Instead of aborting on the first read error, all NTFS and registry
hive reading paths now use block-level resilient I/O:
- read_from_data_runs: reads 4KB blocks individually, zero-fills
  blocks that fail, and continues to the next block
- resilient_read_blocks: MFT batch reads zero-fill failing records
  instead of skipping entire batches
- read_file_data (ntfs_reader): falls back to chunked 4KB reads
  when exact read fails
- Partition table parsing: skips unreadable GPT entries gracefully
- Hive scanning: skips unreadable chunks instead of aborting scan
- MFTMirr: accepts records without FILE signature check on first
  extent (live VMs may have transient I/O on header sectors)
- $ATTRIBUTE_LIST parsing for extension MFT records (large hives)

Tested on Proxmox with running Win11 and DC VMs — extracts SAM/SYSTEM
hives and NTDS.dit successfully despite scattered I/O errors.
2026-03-10 03:00:59 +01:00
NK 0a1febd8f0 Add VMFS-6 raw parser for direct ESXi SCSI device access
Self-contained VMFS-6 parser that reads flat VMDKs directly from raw
SCSI partition devices, bypassing VMFS file locks on running VMs.

Key features:
- Full VMFS-6 on-disk format parsing: LVM, superblock, FDC, SBC, PB/PB2
- Directory traversal with allocation map and entry bitmap support
- Block map building with batched PB reads (320 reads vs 262K individual)
- Sub-block resolution for small files via SBC resource metadata
- Auto-scan mode: enumerates all VMs, skips non-Windows VMDKs
- NTFS-only extraction for fast batch scanning

Verified on ESXi 8.0 datastore: 73 VMDKs scanned in <2min, 4 Windows
VMs with SAM hashes + LSA secrets + DCC2 cached credentials extracted.
2026-03-10 02:31:40 +01:00
NK a386bc19d5 build: replace env_logger with inline logger (3.0M → 2.3M)
env_logger pulled in regex + jiff (~700KB). Replace with a 10-line
SimpleLogger that writes to stderr. Same behavior, zero dependencies.
v1.0.0
2026-03-09 16:53:27 +01:00
NK 85348ed84f build: optimize binary size (4.0M → 3.0M)
- Add opt-level = "z" to release profile (size-optimized codegen)
- Remove redundant strip/editbin steps from CI (strip = true in Cargo.toml
  already handles all targets)
- Remove redundant --features "ntds.dit" (already in default features)
2026-03-09 16:39:30 +01:00
NK d616a62775 v1.0.0: major rewrite — minidump support, pre-Vista, verified offsets, carve mode
LSASS credential extraction:
- Minidump (.dmp) support: full MSV/Kerberos/DPAPI/WDigest/TsPkg/SSP/
  LiveSSP/CredMan/CloudAP extraction from LSASS minidumps
- Pre-Vista (WinXP/Win2003): 32-bit EPROCESS, PAE paging, DES-X-CBC/RC4
- Win11 24H2 (26100+): correct EPROCESS offsets, MSV LIST_64/LIST_65,
  Kerberos variant with shifted offsets
- All MSV/SSP/LiveSSP/CloudAP/CredMan/WDigest offsets verified against
  mimikatz C structs and pypykatz templates
- EPROCESS offsets verified against Vergilius Project (13 variants)
- AES-CFB-128 cipher for non-8-aligned LSASS blobs
- DPAPI extraction from dpapisrv.dll (Win10 19041+ moved g_MasterKeyCacheList)
- Adaptive MSV offset discovery with build-number-aware variant ordering
- MSV NT hash fix: validated variant tracking + DPAPI cross-check for
  human accounts (SHA1 validation only works for machine accounts)
- Kerberos: AES/DES/RC4 key extraction, kirbi/ccache export, ticket
  quality validation, false positive filtering
- CloudAP: PRT blob extraction, 7 patterns covering Win10 1507–Win11 24H2
- CredMan: correct 2-level navigation (SET_LIST→STARTER→entry)
- Garbage filtering: repeating pattern detection, structural score
  validation, unknown etype rejection

Architecture:
- Carve mode: two-level degraded extraction for truncated memory files
- sam/mod.rs split into 4 submodules (partition, ntfs_reader,
  disk_fallbacks, vmdk_scan)
- ProviderStatus enum replacing string-based status tracking
- Safe read helpers (utils.rs) replacing 86 try_into().unwrap() calls
- GovmemError renamed to VmkatzError across all 35 source files
- Named paging constants (PAGE_PHYS_MASK, LARGE_*_MASK)

Performance:
- TLB cache for page table translation (256-entry direct-mapped)
- QCOW2 L2 table caching (64 tables, amortized I/O)
- VMware region binary search (partition_point)
- Stack-allocated ASN.1 length encoding, IV entropy histogram
- Single-pass System process + EPT scanning
- memchr::memmem for pattern matching

Robustness:
- Minidump parser hardening (bounds checks, overflow protection)
- PE32 validation (machine type, section count, optional header size)
- Multiple pagefile support (PTE pagefile_number routing)
- VMware embedded memory support (.vmss/.vmsn without .vmem)
- EPT false positive prevention (reserved bits, PDPT validation)
- VMEM truncation detection with user warning

Testing:
- 8 automated tests (4 unit + 4 integration)
- Non-regression framework: compare.py + esxi_test.sh
- All credentials verified against pypykatz on 10+ minidumps

CLI:
- --all/-a: show empty sessions (hidden by default)
- --no-ept: skip EPT scanning
- --kirbi/--ccache: Kerberos ticket export
- Silent output modes: ntlm, hashcat, text summary
- Hex display for non-printable machine account passwords
2026-03-09 16:21:24 +01:00
NK ac15c32d37 Fix MSV NT hash variant selection for human accounts
SHA1 cross-validation only works for machine accounts (where
ShaOwPassword = SHA1(NTHash)). For human accounts, ShaOwPassword =
SHA1(UTF16LE(password)), so the entropy fallback could pick the wrong
offset variant (reading DPAPI Protected field as NT hash).

Two fixes:
- Track SHA1-validated variant across credentials in same LSASS process
  (same Windows build → same offsets). Reuse for subsequent credentials.
- DPAPI cross-check: when isDPAPIProtected=1, reject entropy candidates
  whose NT hash matches the DPAPIProtected field at offset 0x6A.

Verified: Administrator NT hash now correct (09f6ff15...) on both
Citrix DC snapshots, matching pypykatz ground truth.
2026-02-26 12:18:37 +01:00
NK 0dd011dd49 Fix false positive tickets and improve MSV credential matching
- Validate Kerberos tickets: reject paged-out blobs (>75% zeros),
  garbage key_types (>0xFF), and all-zero timestamps
- Improve MSV physical scan LUID matching: match by username only
  when domain is empty or "." (local machine shorthand)
- Eliminates synthetic LUIDs and garbage ticket output
2026-02-26 04:24:55 +01:00
NK f2bd87d305 Add physical scan for Kerberos keys and fix credential matching
- Extract pKeyList keys even when credential substructure is paged out
- Physical scan for KIWI_KERBEROS_KEYS_LIST_6 structures in LSASS pages
- Match key groups to credentials via RC4 key = NT hash correlation
- Merge Kerberos credentials by username/domain when LUID is unknown
- Remove duplicate DPAPI line (was always same as SHA1)
- Hide all-zero LM hashes in output
2026-02-26 03:21:33 +01:00
NK 2700102ae9 Add --kirbi and --ccache flags for Kerberos ticket export
- --kirbi <DIR>: export individual .kirbi files per ticket
- --ccache <FILE>: export all tickets as MIT Kerberos ccache v4 format
- Uses actual Kerberos name types from ticket data for ccache principals
- Sanitizes filenames for cross-platform compatibility
2026-02-25 23:38:02 +01:00
NK 1dcda44efe Add Kerberos AES/DES/RC4 key extraction from pKeyList
Read KIWI_KERBEROS_KEYS_LIST_6 from the session entry's pKeyList
pointer, parse KERB_HASHPASSWORD_6[_1607] entries, decrypt and
extract AES128, AES256, RC4 (NTLM), and DES key material.

Offsets for Win10 1607+, Win10 1507, Win8, and Win7 variants.
Keys are displayed in both text and Display formats.

This closes the gap vs pypykatz which extracts these keys from
minidumps. VMkatz now extracts passwords, keys, and tickets.
2026-02-25 23:28:35 +01:00
NK 28afe24f98 Filter false positive LSASS sessions from garbage memory
Add LUID and username validation to reject phantom sessions caused by
wrong MSV struct offsets being applied to valid memory. Filters:
- LUID must have high 32 bits zero (real Windows LUIDs are 32-bit)
- Username must contain at least one alphanumeric char, no file paths
  or control characters

Tested on SilverFort-AD (Server 2022 DC, 32GB): eliminates 3 false
sessions while preserving all 10 legitimate ones.
2026-02-25 22:57:09 +01:00
NK 08e95e7a82 Bump version to 0.2.2 2026-02-25 11:31:49 +01:00
NK d262b7fad3 Fix clippy len_zero warning
Use !is_empty() instead of len() >= 1 for clearer intent.
2026-02-25 11:00:52 +01:00
NK e774c481b5 Bump version to 0.2.1 v0.2.1 2026-02-25 10:56:04 +01:00
NK 384fdcf191 Add raw file input: vmkatz ntds.dit SYSTEM, vmkatz SAM SYSTEM [SECURITY]
Accept multiple positional arguments and auto-detect file types by magic
bytes (ESE 0xEFCDAB89, registry "regf", minidump "MDMP").

- Raw NTDS.dit + SYSTEM hive: extracts AD hashes without a disk image
- Raw SAM + SYSTEM [+ SECURITY]: extracts local hashes, LSA secrets,
  and cached domain credentials from exported registry hives
- Auto-detects which hive is SYSTEM (bootkey extraction), SAM, or
  SECURITY — argument order does not matter
- Helpful error messages for incomplete inputs (e.g. NTDS without SYSTEM)
- LSASS minidump detection with guidance to use pypykatz (parser planned)
- Full backward compatibility with existing single-file workflows
2026-02-25 10:54:08 +01:00
NK a794c19388 Bump version to 0.2.0 v0.2.0 2026-02-25 10:42:16 +01:00
NK b988715864 Add colored output, blank hash detection, and fix LM hash display
- Add --color auto|always|never for colored terminal output (TTY auto-detect)
- Highlight usernames (bold), hashes (yellow), section headers (green),
  provider names (cyan), plaintext passwords (red), blank hashes (dim)
- Annotate well-known blank password hashes with (blank) in text mode
- Hide zero LM hashes in text mode (mimikatz convention: LM disabled)
- Output aad3b435b51404eeaad3b435b51404ee for zero LM in ntlm/csv modes
  (impacket pwdump convention for downstream tool compatibility)
- Add acknowledgements section for mimikatz, pypykatz, and impacket
2026-02-25 10:37:15 +01:00
NK def787cfc4 Add native NTDS.dit extraction with ESE large page support
- Fix ESE parser for 32KB large pages (Win Server 2025): use 80-byte
  page header and 12-bit tag count for pages >=16KB
- Move NTDS code from src/sam/ to src/ntds/ module (ese.rs + mod.rs)
- Enable ntds.dit feature by default in Cargo.toml
- Fix conditional compilation warnings across all feature combinations
- Add test examples for ESE parser and end-to-end NTDS extraction
- Update README with NTDS usage, examples, and test results

Verified against 4 domain controllers:
  - 3x Win Server 2019 (8KB pages, GOAD lab): 18/19/15 hashes
  - 1x Win Server 2025 (32KB pages): 8 hashes
All hashes match impacket-secretsdump (which itself fails on 32KB pages).
2026-02-25 10:02:01 +01:00
NK a5d5b9a875 Add Proxmox Win11 test result to README 2026-02-24 23:03:41 +01:00
NK b241b4e805 Fix DCC2 key offset, GMSA display, and add block device support
- Fix DCC2 cached credentials: use NL$KM[0:16] as AES key instead of
  [16:32]. The secret is already stripped of its LSA_SECRET_BLOB header,
  so [16:32] was a double offset producing garbage decryption.
- Fix GMSA secrets: display managed service account passwords as hex
  instead of trying to decode binary data as UTF-16LE.
- Add raw block device support for LVM thin volumes (/dev/pve/...).
  Auto-detect block devices and route to SAM extraction. Use seek-to-end
  for device size since metadata().len() returns 0 for block devices.
- Update README with Proxmox LVM test results and Server 2025 support.
2026-02-24 23:02:12 +01:00
NK 396817c594 Add Clippy CI workflow and badge v0.1.0 2026-02-19 21:40:31 +01:00
NK 9a08d27c2f Replace static Rust badge with CI build status badge 2026-02-19 21:38:16 +01:00
NK 63d1e1404b Add MIT license, multi-platform CI, and README badges 2026-02-19 21:23:50 +01:00
NK 5e941b3ce3 Update gitignore and README 2026-02-19 21:11:30 +01:00