mkorman90/regipyRegipy は、オフラインレジストリハイブを解析するためのOS非依存のPythonライブラリです。
# regipy
[](https://securityscorecards.dev/viewer/?uri=github.com/mkorman90/regipy)
> **⚠️ v6.0.0 における破壊的変更**
>
> バージョン 6.0.0 には大幅なモダナイゼーションの変更が含まれています:
>
> - **Python 3.9 以上が必要** - Python 3.6、3.7、3.8 のサポートを終了
> - **`attrs` ライブラリを削除** - データクラスは Python 組み込みの `dataclasses` モジュールを使用するようになりました
> - 内部クラス (`Cell`、`VKRecord`、`Value`、`Subkey`) をインポートし、`attr.asdict()` のような `attrs` 関数を使用している場合は、`dataclasses.asdict()` に切り替えてください
>
> 詳細については [CHANGELOG](https://github.com/mkorman90/regipy/blob/master/CHANGELOG.md) を参照してください。
Regipy は、オフラインのレジストリハイブ (REGF ヘッダーを持つ Hive ファイル) を解析するための Python ライブラリです。regipy には多くの機能があります:
- ライブラリとして使用:
- ルートまたは指定されたパスからレジストリハイブを再帰的に探索し、すべてのサブキーと値を取得
- 特定のサブキーと値を読み取る
- レジストリハイブにトランザクションログを適用する
- コマンドラインツール
- レジストリハイブ全体を json にダンプする
- レジストリハイブにトランザクションログを適用する
- レジストリハイブを比較する
- 堅牢なプラグインシステムからプラグインを実行する (例: amcache、shimcache、コンピューター名の抽出...)
**Python 3.9 以上が必要です。**
## インストール
Regipy の最新バージョンは pypi からインストールできます:
```bash
pip install regipy[full]
```
注: ``regipy[full]`` はコンパイルツールを必要とする依存関係をインストールするため、時間がかかる場合があります。
``[full]`` を省略することで、依存関係を緩和したバージョンをインストールすることも可能です。
また、リポジトリをクローンして以下を実行することで、ソースからインストールすることも可能です:
```bash
pip install --editable .[full]
```
### Rust アクセラレーテッドバックエンド (アルファ)
コア REGF パーサーのオプションの Rust 実装が、オプトイン
バックエンドとして利用可能で、PyPI に
[`regipy-rs`](https://pypi.org/project/regipy-rs/) として別途公開されています:
```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.
```
これはドロップイン置換であり、テストハイブコーパス全体にわたって純粋な Python パーサーと 1:1 で検証されています — すべてのキーパス、タイムスタンプ、値、プラグイン出力が、一致する SHA-256 トラバーサルダイジェストによって公証されています (`regipy_tests/comparison_test.py` および [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md) の *Forensic parity evidence* セクションを参照)。
値付きの完全なトラバーサル (`recurse_subkeys`)、3 回実行のベスト:
| 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` はその理由を示しています: Python バックエンドでは、トラバーサル時間はレコードごとの `construct` 構造体解析と値のデコードによって支配されていますが、Rust バックエンドではパーサーがプロファイルから完全に消え、残る Python のコストは返される `Subkey` データクラスの構築のみです。
完全なプロファイル、ハイブごとのダイジェスト、および少数の意図的な相違点 (破損したハイブでの例外タイプ、サイクルガードの動作) を文書化した免責事項は [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md) にあります;
`python regipy-rs/benchmark.py` でレポート全体を再生成できます。
純粋な Python パーサーはデフォルトのままであり、Rust バックエンドがインストールされていない場合は影響を受けません。
## CLI
#### ヘッダーを解析する
```bash
regipy-parse-header ~/Documents/TestEvidence/Registry/SYSTEM
```
出力例:
```
╒════════════════════════╤══════════╕
│ 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
```
- ハイブのヘッダーを解析する際、チェックサム検証とトランザクション検証も行われます
#### ハイブ全体をディスクにダンプする (時間がかかる場合があります)
```bash
regipy-dump ~/Documents/TestEvidence/Registry/NTUSER-CCLEANER.DAT -o /tmp/output.json
```
regipy-dump ユーティリティは、`-t` フラグを追加することで、JSON の代わりにタイムラインを出力することもできます
#### Hive 上で関連するプラグインを実行する
```bash
regipy-plugins-run ~/Documents/TestEvidence/Registry/SYSTEM -o /tmp/plugins_output.json
```
ハイブタイプは自動的に検出され、関連するプラグインが実行されます。
[**詳細についてはプラグインセクションを参照してください**](https://github.com/mkorman90/regipy/blob/master/docs/PLUGINS.md)
#### レジストリハイブを比較する
同じタイプのレジストリハイブを比較し、CSV に出力します (`-o` が指定されていない場合、出力は画面に表示されます)
```bash
regipy-diff NTUSER.dat NTUSER_modified.dat -o /tmp/diff.csv
```
出力例:
```
[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
```
## トランザクションログを使用してレジストリハイブを復元する
```bash
regipy-process-transaction-logs NTUSER.DAT -p ntuser.dat.log1 -s ntuser.dat.log2 -o recovered_NTUSER.dat
```
復元後、registry-diff でハイブを比較し、何が変更されたかを確認します
## ライブラリとして使用する
#### レジストリハイブオブジェクトを初期化する
```python
from regipy.registry import RegistryHive
reg = RegistryHive("/Users/martinkorman/Documents/TestEvidence/Registry/Vibranium-NTUSER.DAT")
```
#### ルートキーからハイブ全体を再帰的に反復する
```python
for entry in reg.recurse_subkeys(as_json=True):
print(entry)
```
#### キーを反復し、すべてのサブキーとその変更時刻を取得する
```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
```
#### キーの値を取得する
```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},
]
```
#### プラグインとして使用する
```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,
}
],
}
}
```
#### 特定のハイブに関連するすべてのプラグインを実行する
```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",
}
],
}
```
## 検証ケース
[検証ケースレポート](https://github.com/mkorman90/regipy/blob/master/regipy_tests/validation/plugin_validation.md)
すべての新しいプラグインには、1 つ以上の基本的な検証ケース (将来的に拡張可能) が必要です。例えば:
```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
```
## 開発
### 開発環境のセットアップ
```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
```
### テストの実行
```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
```
### コード品質
```bash
# Run linter
ruff check .
# Run formatter
ruff format .
# Run type checker
mypy regipy/
```
### GitHub Actions をローカルでテストする
プッシュする前に CI ワークフローの変更をローカルでテストするには、[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
```
Docker が実行中であることを確認してから:
```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"}'
```
注: 一部のジョブはシークレットを必要とする場合があります。次のように指定できます:
```bash
act -j publish --secret PYPI_API_TOKEN=your_token
```
## ライセンス
MIT