mkorman90/regipyRegipy é uma biblioteca python independente de sistema operacional para análise de hives de registro offline.
# regipy
[](https://securityscorecards.dev/viewer/?uri=github.com/mkorman90/regipy)
> **⚠️ Alterações significativas na v6.0.0**
>
> A versão 6.0.0 inclui alterações significativas de modernização:
>
> - **Requer Python 3.9+** - Suporte removido para Python 3.6, 3.7 e 3.8
> - **Biblioteca `attrs` removida** - As classes de dados agora usam o módulo `dataclasses` nativo do Python
> - Se o seu código importa classes internas (`Cell`, `VKRecord`, `Value`, `Subkey`) e usa funções `attrs` como `attr.asdict()`, mude para `dataclasses.asdict()`
>
> Consulte o [CHANGELOG](https://github.com/mkorman90/regipy/blob/master/CHANGELOG.md) para todos os detalhes.
Regipy é uma biblioteca Python para analisar hives de registro offline (arquivos Hive com cabeçalho REGF). O regipy tem muitas capacidades:
- Usar como biblioteca:
- Percorrer recursivamente o hive de registro, a partir da raiz ou de um caminho fornecido, e obter todas as subchaves e valores
- Ler subchaves e valores específicos
- Aplicar logs de transação num hive de registro
- Ferramentas de Linha de Comandos
- Exportar um hive de registro completo para json
- Aplicar logs de transação num hive de registro
- Comparar hives de registro
- Executar plugins de um sistema de plugins robusto (ex.: amcache, shimcache, extrair nome do computador...)
**Requer Python 3.9 ou superior.**
## Instalação
A versão mais recente do Regipy pode ser instalada a partir do pypi:
```bash
pip install regipy[full]
```
NOTA: ``regipy[full]`` instala dependências que requerem ferramentas de compilação e podem demorar algum tempo.
É possível instalar uma versão com dependências relaxadas, omitindo o ``[full]``.
Além disso, é possível instalar a partir do código-fonte clonando o repositório e executando:
```bash
pip install --editable .[full]
```
### Backend acelerado em Rust (alpha)
Uma implementação opcional em Rust do parser REGF principal está disponível como
backend opcional, publicada separadamente no PyPI como
[`regipy-rs`](https://pypi.org/project/regipy-rs/):
```bash
pip install regipy[rust]
```
```python
from regipy.registry_rs import RegistryHive # em vez de regipy.registry
reg = RegistryHive("/tmp/NTUSER.dat")
# Mesma API: get_key, iter_values, recurse_subkeys, plugins — tudo
# funciona sem alterações, incluindo todos os plugins do regipy.
```
É um substituto direto validado 1:1 contra o parser puro em Python sobre
todo o corpus de hives de teste — cada caminho de chave, timestamp, valor e saída
de plugin, notarizado por digests de travessia SHA-256 correspondentes (ver
`regipy_tests/comparison_test.py` e a secção *Forensic parity evidence*
de [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md)).
Travessia completa com valores (`recurse_subkeys`), melhor de 3 execuções:
| Hive | Chaves | Python | Rust | Aceleração |
| ------ | -----: | -------: | -----: | --------: |
| 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** |
O `cProfile` mostra porquê: no backend Python, o tempo de travessia é dominado
pela análise de estruturas `construct` por registo e pela descodificação de valores; com o backend
Rust, o parser desaparece completamente do perfil e o único
custo Python restante é a construção das dataclasses `Subkey` retornadas.
Os perfis completos, digests por hive e um aviso documentando as poucas
divergências intencionais (tipos de exceção em hives corrompidos, comportamento de proteção contra ciclos)
estão em [regipy-rs/BENCHMARKS.md](https://github.com/mkorman90/regipy/blob/master/regipy-rs/BENCHMARKS.md);
`python regipy-rs/benchmark.py` regenera o relatório completo.
O parser puro em Python continua a ser o padrão e não é afetado quando o backend
Rust não está instalado.
## CLI
#### Analisar o cabeçalho
```bash
regipy-parse-header ~/Documents/TestEvidence/Registry/SYSTEM
```
Exemplo de saída:
```
╒════════════════════════╤══════════╕
│ 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
```
- Ao analisar o cabeçalho de um hive, também são feitas a validação de checksum e as validações de transação
#### Exportar o hive completo para disco (isto pode demorar algum tempo)
```bash
regipy-dump ~/Documents/TestEvidence/Registry/NTUSER-CCLEANER.DAT -o /tmp/output.json
```
O utilitário regipy-dump também pode gerar uma linha temporal em vez de um JSON, adicionando a flag `-t`
#### Executar plugins relevantes no Hive
```bash
regipy-plugins-run ~/Documents/TestEvidence/Registry/SYSTEM -o /tmp/plugins_output.json
```
O tipo de hive será detetado automaticamente e os plugins relevantes serão executados.
[**Consulte a secção de plugins para mais informações**](https://github.com/mkorman90/regipy/blob/master/docs/PLUGINS.md)
#### Comparar hives de registro
Comparar hives de registro do mesmo tipo e exportar para CSV (se `-o` não for especificado, a saída será impressa no ecrã)
```bash
regipy-diff NTUSER.dat NTUSER_modified.dat -o /tmp/diff.csv
```
Exemplo de saída:
```
[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
```
## Recuperar um hive de registro, usando logs de transação
```bash
regipy-process-transaction-logs NTUSER.DAT -p ntuser.dat.log1 -s ntuser.dat.log2 -o recovered_NTUSER.dat
```
Após a recuperação, compare os hives com registry-diff para ver o que mudou
## Usar como biblioteca
#### Iniciar o objeto do hive de registro
```python
from regipy.registry import RegistryHive
reg = RegistryHive("/Users/martinkorman/Documents/TestEvidence/Registry/Vibranium-NTUSER.DAT")
```
#### Iterar recursivamente sobre todo o hive, a partir da chave raiz
```python
for entry in reg.recurse_subkeys(as_json=True):
print(entry)
```
#### Iterar sobre uma chave e obter todas as subchaves e o seu tempo de modificação
```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
```
#### Obter os valores de uma chave
```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},
]
```
#### Usar como plugin
```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,
}
],
}
}
```
#### Executar todos os plugins relevantes para um hive específico
```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",
}
],
}
```
## Casos de validação
[Relatório de casos de validação](https://github.com/mkorman90/regipy/blob/master/regipy_tests/validation/plugin_validation.md)
Todos os novos plugins devem ter um ou mais casos de validação básicos (que podem ser expandidos no futuro), por exemplo:
```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
```
## Desenvolvimento
### Configurar para desenvolvimento
```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
```
### Executar testes
```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
```
### Qualidade de código
```bash
# Run linter
ruff check .
# Run formatter
ruff format .
# Run type checker
mypy regipy/
```
### Testar GitHub Actions Localmente
Para testar alterações ao fluxo de trabalho de CI localmente antes de fazer push, use [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
```
Certifique-se de que o Docker está em execução, depois:
```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"}'
```
Nota: Alguns jobs podem requerer secrets. Pode fornecê-los com:
```bash
act -j publish --secret PYPI_API_TOKEN=your_token
```
## Licença
MIT