mkorman90/regipyRegipy ist eine OS-unabhängige Python-Bibliothek zum Parsen von Offline-Registry-Hives.
# regipy
[](https://securityscorecards.dev/viewer/?uri=github.com/mkorman90/regipy)
> **⚠️ Breaking Changes in v6.0.0**
>
> Version 6.0.0 enthält bedeutende Modernisierungsänderungen:
>
> - **Python 3.9+ erforderlich** - Unterstützung für Python 3.6, 3.7 und 3.8 wurde eingestellt
> - **`attrs`-Bibliothek entfernt** - Datenklassen verwenden jetzt das in Python integrierte `dataclasses`-Modul
> - Wenn Ihr Code interne Klassen importiert (`Cell`, `VKRecord`, `Value`, `Subkey`) und `attrs`-Funktionen wie `attr.asdict()` verwendet, wechseln Sie zu `dataclasses.asdict()`
>
> Siehe das [CHANGELOG](https://github.com/mkorman90/regipy/blob/master/CHANGELOG.md) für vollständige Details.
Regipy ist eine Python-Bibliothek zum Parsen von Offline-Registry-Hives (Hive-Dateien mit REGF-Header). regipy bietet viele Funktionen:
- Verwendung als Bibliothek:
- Rekursives Durchlaufen des Registry-Hives, vom Stammverzeichnis oder einem angegebenen Pfad aus, und Abrufen aller Unterschlüssel und Werte
- Lesen bestimmter Unterschlüssel und Werte
- Anwenden von Transaktionsprotokollen auf ein Registry-Hive
- Kommandozeilen-Tools
- Ein gesamtes Registry-Hive als JSON ausgeben
- Transaktionsprotokolle auf ein Registry-Hive anwenden
- Registry-Hives vergleichen
- Plugins aus einem robusten Plugin-System ausführen (z. B.: amcache, shimcache, Computernamen extrahieren...)
**Erfordert Python 3.9 oder höher.**
## Installation
Die neueste Version von Regipy kann von pypi installiert werden:
```bash
pip install regipy[full]
```
HINWEIS: ``regipy[full]`` installiert Abhängigkeiten, die Kompilierungswerkzeuge erfordern und einige Zeit in Anspruch nehmen können.
Es ist möglich, eine Version mit gelockerten Abhängigkeiten zu installieren, indem ``[full]`` weggelassen wird.
Außerdem ist es möglich, aus dem Quellcode zu installieren, indem das Repository geklont und Folgendes ausgeführt wird:
```bash
pip install --editable .[full]
```
### Rust-beschleunigtes Backend (Alpha)
Eine optionale Rust-Implementierung des Kern-REGF-Parsers ist als
Opt-in-Backend verfügbar und wird separat auf PyPI als
[`regipy-rs`](https://pypi.org/project/regipy-rs/) veröffentlicht:
```bash
pip install regipy[rust]
```
```python
from regipy.registry_rs import RegistryHive # instead of regipy.registry
reg = RegistryHive("/tmp/NTUSER.dat")
# Same API: get_key, iter_values, recurse_subkeys, plugins — everything
# works unchanged, including all regipy plugins.
```
Es ist ein Drop-in-Ersatz, der 1:1 gegen den reinen Python-Parser über
den gesamten Test-Hive-Korpus validiert wurde — jeder Schlüsselpfad, Zeitstempel, Wert und Plugin-
Ausgabe, beglaubigt durch übereinstimmende SHA-256-Traversierungs-Digests (siehe
`regipy_tests/comparison_test.py` und den Abschnitt *Forensic parity evidence*
in [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md)).
Vollständige Traversierung mit Werten (`recurse_subkeys`), beste von 3 Durchläufen:
| Hive | Keys | Python | Rust | Speedup |
| ------ | -----: | -------: | -----: | --------: |
| NTUSER.DAT | 1,812 | 173 ms | 5 ms | **38x** |
| UsrClass.dat | 6,205 | 948 ms | 17 ms | **55x** |
| amcache.hve | 2,105 | 837 ms | 12 ms | **67x** |
| SYSTEM | 30,756 | 23.1 s | 91 ms | **253x** |
| SYSTEM (Win10 1709) | 43,211 | 118.7 s | 111 ms | **1,068x** |
| SOFTWARE | 117,488 | 745.6 s | 292 ms | **2,550x** |
`cProfile` zeigt warum: Im Python-Backend wird die Traversierungszeit von
der `construct`-Struct-Analyse pro Datensatz und der Wertdekodierung dominiert; mit dem Rust-
Backend verschwindet der Parser vollständig aus dem Profil und die einzigen
verbleibenden Python-Kosten sind die Konstruktion der zurückgegebenen `Subkey`-Datenklassen.
Die vollständigen Profile, Digests pro Hive und ein Haftungsausschluss, der die wenigen
absichtlichen Abweichungen dokumentiert (Ausnahmetypen bei beschädigten Hives, Cycle-Guard-
Verhalten), befinden sich in [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md);
`python regipy-rs/benchmark.py` regeneriert den gesamten Bericht.
Der reine Python-Parser bleibt der Standard und ist nicht betroffen, wenn das Rust-
Backend nicht installiert ist.
## CLI
#### Den Header parsen
```bash
regipy-parse-header ~/Documents/TestEvidence/Registry/SYSTEM
```
Beispielausgabe:
```
╒════════════════════════╤══════════╕
│ signature │ b'regf' │
├────────────────────────┼──────────┤
│ primary_sequence_num │ 11639 │
├────────────────────────┼──────────┤
│ secondary_sequence_num │ 11638 │
├────────────────────────┼──────────┤
│ last_modification_time │ 0 │
├────────────────────────┼──────────┤
│ major_version │ 1 │
├────────────────────────┼──────────┤
│ minor_version │ 5 │
├────────────────────────┼──────────┤
│ file_type │ 0 │
├────────────────────────┼──────────┤
│ file_format │ 1 │
├────────────────────────┼──────────┤
│ root_key_offset │ 32 │
├────────────────────────┼──────────┤
│ hive_bins_data_size │ 10534912 │
├────────────────────────┼──────────┤
│ clustering_factor │ 1 │
├────────────────────────┼──────────┤
│ file_name │ SYSTEM │
├────────────────────────┼──────────┤
│ checksum │ 0 │
╘════════════════════════╧══════════╛
[2019-02-09 13:46:12.111654] WARNING: regipy.cli: Hive is not clean! You should apply transaction logs
```
- Beim Parsen des Headers eines Hives werden auch Checksummen- und Transaktionsvalidierungen durchgeführt
#### Das gesamte Hive auf die Festplatte ausgeben (dies kann einige Zeit dauern)
```bash
regipy-dump ~/Documents/TestEvidence/Registry/NTUSER-CCLEANER.DAT -o /tmp/output.json
```
Das regipy-dump-Dienstprogramm kann auch eine Timeline anstelle eines JSON ausgeben, indem das `-t`-Flag hinzugefügt wird
#### Relevante Plugins auf dem Hive ausführen
```bash
regipy-plugins-run ~/Documents/TestEvidence/Registry/SYSTEM -o /tmp/plugins_output.json
```
Der Hive-Typ wird automatisch erkannt und die relevanten Plugins werden ausgeführt.
[**Siehe den Plugin-Abschnitt für weitere Informationen**](https://github.com/mkorman90/regipy/blob/master/docs/PLUGINS.md)
#### Registry-Hives vergleichen
Registry-Hives desselben Typs vergleichen und als CSV ausgeben (wenn `-o` nicht angegeben ist, wird die Ausgabe auf dem Bildschirm ausgegeben)
```bash
regipy-diff NTUSER.dat NTUSER_modified.dat -o /tmp/diff.csv
```
Beispielausgabe:
```
[2019-02-11 19:49:18.824245] INFO: regipy.cli: Comparing NTUSER.DAT vs NTUSER_modified.DAT
╒══════════════╤══════════════╤════════════════════════════════════════════════════════════════════════════════╤════════════════════════════════════════════════╕
│ difference │ first_hive │ second_hive │ description │
╞══════════════╪══════════════╪════════════════════════════════════════════════════════════════════════════════╪════════════════════════════════════════════════╡
│ new_subkey │ │ 2019-02-11T19:46:31.832134+00:00 │ \Software\Microsoft\legitimate_subkey │
├──────────────┼──────────────┼────────────────────────────────────────────────────────────────────────────────┼────────────────────────────────────────────────┤
│ new_value │ │ not_a_malware: c:\temp\legitimate_binary.exe @ 2019-02-11 19:45:25.516346+00:00 │ \Software\Microsoft\Windows\CurrentVersion\Run │
╘══════════════╧══════════════╧════════════════════════════════════════════════════════════════════════════════╧════════════════════════════════════════════════╛
[2019-02-11 19:49:18.825328] INFO: regipy.cli: Detected 2 differences
```
## Ein Registry-Hive mithilfe von Transaktionsprotokollen wiederherstellen
```bash
regipy-process-transaction-logs NTUSER.DAT -p ntuser.dat.log1 -s ntuser.dat.log2 -o recovered_NTUSER.dat
```
Nach der Wiederherstellung vergleichen Sie die Hives mit registry-diff, um zu sehen, was sich geändert hat
## Verwendung als Bibliothek
#### Das Registry-Hive-Objekt initialisieren
```python
from regipy.registry import RegistryHive
reg = RegistryHive("/Users/martinkorman/Documents/TestEvidence/Registry/Vibranium-NTUSER.DAT")
```
#### Rekursiv über das gesamte Hive iterieren, vom Stammschlüssel aus
```python
for entry in reg.recurse_subkeys(as_json=True):
print(entry)
```
#### Über einen Schlüssel iterieren und alle Unterschlüssel und deren Änderungszeit abrufen
```python
for sk in reg.get_key('Software').iter_subkeys():
print(sk.name, convert_wintime(sk.header.last_modified).isoformat())
Adobe 2019-02-03T22:05:32.525965
AppDataLow 2019-02-03T22:05:32.526047
McAfee 2019-02-03T22:05:32.526140
Microsoft 2019-02-03T22:05:32.526282
Netscape 2019-02-03T22:05:32.526352
ODBC 2019-02-03T22:05:32.526521
Policies 2019-02-03T22:05:32.526592
```
#### Die Werte eines Schlüssels abrufen
```python
reg.get_key("Software\Microsoft\Internet Explorer\BrowserEmulation").get_values(as_json=True)
[
{"name": "CVListTTL", "value": 0, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "UnattendLoaded", "value": 0, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "TLDUpdates", "value": 0, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "CVListXMLVersionLow", "value": 2097211, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "CVListXMLVersionHigh", "value": None, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "CVListLastUpdateTime", "value": None, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "IECompatVersionHigh", "value": None, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "IECompatVersionLow", "value": 2097211, "value_type": "REG_DWORD", "is_corrupted": False},
{"name": "StaleCompatCache", "value": 0, "value_type": "REG_DWORD", "is_corrupted": False},
]
```
#### Als Plugin verwenden
```python
from regipy.plugins.ntuser.ntuser_persistence import NTUserPersistencePlugin
NTUserPersistencePlugin(reg, as_json=True).run()
{
"Software\\Microsoft\\Windows\\CurrentVersion\\Run": {
"timestamp": "2019-02-03T22:10:52.655462",
"values": [
{
"name": "Sidebar",
"value": "%ProgramFiles%\\Windows Sidebar\\Sidebar.exe /autoRun",
"value_type": "REG_EXPAND_SZ",
"is_corrupted": False,
}
],
}
}
```
#### Alle relevanten Plugins für ein bestimmtes Hive ausführen
```python
from regipy.plugins.utils import run_relevant_plugins
reg = RegistryHive("/Users/martinkorman/Documents/TestEvidence/Registry/SYSTEM")
run_relevant_plugins(reg, as_json=True)
{
"routes": {},
"computer_name": [
{
"control_set": "ControlSet001\\Control\\ComputerName\\ComputerName",
"computer_name": "DESKTOP-5EG84UG",
"timestamp": "2019-02-03T22:19:28.853219",
}
],
}
```
## Validierungsfälle
[Validierungsfälle-Bericht](https://github.com/mkorman90/regipy/blob/master/regipy_tests/validation/plugin_validation.md)
Alle neuen Plugins sollten einen oder mehrere grundlegende Validierungsfälle haben (die in Zukunft erweitert werden können), zum Beispiel:
```python
from regipy.plugins.system.bam import BAMPlugin
from regipy_tests.validation.validation import ValidationCase
class NTUserUserAssistValidationCase(ValidationCase):
# define your plugin class
plugin = BAMPlugin
# define the test file name, which should be present in `regipy_tests/data`
test_hive_file_name = "SYSTEM_WIN_10_1709.xz"
# Use `expected_entries` to test for presence of a few samples from the plugin results
expected_entries = [
{
"sequence_number": 9,
"version": 1,
"sid": "S-1-5-90-0-1",
"executable": "\\Device\\HarddiskVolume2\\Windows\\System32\\dwm.exe",
"timestamp": "2020-04-19T09:09:35.731816+00:00",
"key_path": "\\ControlSet001\\Services\\bam\\state\\UserSettings\\S-1-5-90-0-1",
}
]
# OR use `exact_expected_result` to test for an exact result:
exact_expected_result = [
{
"sequence_number": 9,
"version": 1,
"sid": "S-1-5-90-0-1",
"executable": "\\Device\\HarddiskVolume2\\Windows\\System32\\dwm.exe",
"timestamp": "2020-04-19T09:09:35.731816+00:00",
"key_path": "\\ControlSet001\\Services\\bam\\state\\UserSettings\\S-1-5-90-0-1",
},
{
"sequence_number": 8,
"version": 1,
"sid": "S-1-5-90-0-1",
"executable": "\\Device\\HarddiskVolume2\\Windows\\System32\\cmd.exe",
"timestamp": "2020-04-19T09:09:34.544224+00:00",
"key_path": "\\ControlSet001\\Services\\bam\\state\\UserSettings\\S-1-5-90-0-1",
},
]
expected_entries_count = 2
```
## Entwicklung
### Einrichtung für die Entwicklung
```bash
# Clone the repository
git clone https://github.com/mkorman90/regipy.git
cd regipy
# Install in development mode with all dependencies
pip install -e ".[full,dev]"
# Install pre-commit hooks
pre-commit install
```
### Tests ausführen
```bash
# Run all tests
pytest
# Run specific test files
pytest regipy_tests/tests.py
pytest regipy_tests/cli_tests.py
# Run plugin validation
PYTHONPATH=. python regipy_tests/validation/plugin_validation.py
```
### Codequalität
```bash
# Run linter
ruff check .
# Run formatter
ruff format .
# Run type checker
mypy regipy/
```
### GitHub Actions lokal testen
Um CI-Workflow-Änderungen lokal vor dem Pushen zu testen, verwenden Sie [act](https://github.com/nektos/act):
```bash
# Install act (Fedora)
sudo dnf install act-cli
# Install act (macOS)
brew install act
# Install act (other)
# See https://nektosact.com/installation/index.html
```
Stellen Sie sicher, dass Docker läuft, dann:
```bash
# List available jobs
act -l
# Run the lint job
act -j lint
# Run all jobs for a push event
act push
# Run the test job with a specific Python version
act -j test
# Test the build job from publish workflow (simulates a release)
act release -j build --eventpath /dev/stdin <<< '{"action": "published"}'
```
Hinweis: Einige Jobs erfordern möglicherweise Secrets. Sie können diese bereitstellen mit:
```bash
act -j publish --secret PYPI_API_TOKEN=your_token
```
## Lizenz
MIT