regipy

# regipy

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/mkorman90/regipy/badge)](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 加速后端（alpha）

核心 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

#### 在配置单元上运行相关插件

```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)

所有新插件都应有一个或多个基本验证用例（将来可以扩展），例如：

```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