___ ___         __             _________                       __
 /   |   \_____ _/  |_  ____     \_   ___ \____________    ____ |  | __
/    ~    \__  \\   __\/ __ \    /    \  \/\_  __ \__  \ _/ ___\|  |/ /
\    Y    // __ \|  | \  ___/    \     \____|  | \// __ \\  \___|    <
 \___|_  /(____  /__|  \___  >____\______  /|__|  (____  /\___  >__|_ \
       \/      \/          \/_____/      \/            \/     \/     \/

macOS (Homebrew):```bash
brew install hashcat

Se você clonou sem submódulos, inicialize-os:```bash
git submodule update --init --recursive

`.env.example` é commitado e incluído com todas as chaves de credenciais vazias. O `.env` em si **nunca** deve ser commitado — ele está no gitignore, juntamente com suas variações de backup habituais, e o hate_crack sempre o cria no modo `0600` (somente leitura/gravação do proprietário). O `.env.example` é gerado a partir do esquema; regenere-o após alterar `hate_crack/config_schema.py` com `uv run python -m hate_crack.config_writer`.

### 3. Instalar dependências e o hate_crack

A maneira mais fácil é executar `make` (ou `make install`), que detecta automaticamente seu sistema operacional e instala:
- Dependências externas (p7zip, transmission-daemon / transmission-remote)
- Compila submódulos (hashcat-utils, princeprocessor, pcfg_cracker e, opcionalmente, omen)
- Dependências Python via uv e um shim de CLI em `~/.local/bin/hate_crack````bash
make

**Ou instale as dependências manualmente:**

### Dependências Externas
Elas são necessárias para determinados fluxos de download/extração:

- `7z`/`7za` (p7zip) — usado para extrair arquivos `.7z`.
- `transmission-daemon` / `transmission-remote` — usado para baixar torrents do Weakpass.

Comandos de instalação manual:

Ubuntu/Kali:```bash
sudo apt-get update
sudo apt-get install -y p7zip-full transmission-daemon

Em seguida, instale as dependências Python e o shim da CLI:```bash
uv sync
mkdir -p ~/.local/bin
printf '#!/usr/bin/env bash\nset -euo pipefail\nexec uv run --directory %s python -m hate_crack "$@"\n' "$(pwd)" > ~/.local/bin/hate_crack
chmod +x ~/.local/bin/hate_crack

Alternativamente, execute via `uv`:```bash
uv run hate_crack.py <hash_file> <hash_type>

O comando `make install` cria um shim bash em `~/.local/bin/hate_crack` que executa a partir do diretório do repositório, para que a configuração e os assets sejam sempre encontrados independentemente do seu diretório de trabalho atual.

A configuração também é procurada em:
- A raiz do repositório e o diretório do pacote
- `~/.hate_crack`

**Nota:** O `hcatPath` em `config.json` é apenas para a localização do binário do hashcat (opcional se o hashcat estiver no PATH). Os assets do Hate_crack (hashcat-utils, princeprocessor, pcfg_cracker, omen) são carregados do diretório do repositório e empacotados automaticamente pelo `make install`.

### Executar como script
O script usa um shebang `uv`. Torne-o executável e execute:```bash
chmod +x hate_crack.py
./hate_crack.py

### Uso não interativo / via script

Para automação, você pode lançar um único ataque diretamente, contornando o menu. O nome do ataque é o primeiro argumento, seguido pelo arquivo de hash e pelo tipo de hash do hashcat. Os prompts de pré-processamento (filtragem de contas de computador, força bruta LM-first, deduplicação de contas duplicadas) aceitam automaticamente seus padrões neste modo. O processo termina com `0` em caso de sucesso e com código diferente de zero em caso de erro (arquivo de hash ausente, tipo de hash não numérico, wordlist ausente ou nome de arquivo de regra desconhecido).```bash
# Quick crack: one wordlist + optional rule(s) from the rules directory
hate_crack quick hashes.txt 1000 --wordlist rockyou.txt --rules best64.rule

# Chain two rules in a single run
hate_crack quick hashes.txt 1000 --wordlist rockyou.txt --rules best64.rule+d3ad0ne.rule

# Run two rules as two separate passes
hate_crack quick hashes.txt 1000 --wordlist rockyou.txt --rules best64.rule d3ad0ne.rule

# Canned dictionary methodology (uses your configured wordlists)
hate_crack dict hashes.txt 1000

# Brute force lengths 1-8
hate_crack brute hashes.txt 1000 --min 1 --max 8

# Top-mask attack targeting ~4 hours
hate_crack topmask hashes.txt 1000 --target-time 4

Isto afeta clones criados antes de julho de 2026. O histórico publicado foi reescrito
então para remover alguns arquivos que nunca deveriam ter sido commitados, o que deu
a cada commit um novo ID; portanto, as tags de um clone mais antigo apontam para objetos que este
repositório não contém mais, e o git se recusa a mover uma tag que já possui.
Nada está errado com o seu checkout e nenhum dado de cracking está em risco.

Recupere com um reset único. Isso descarta commits locais e edições no
checkout; portanto, se você personalizou algo rastreado pelo git (ao contrário de
`config.json`, que não é rastreado), faça commit disso em um branch primeiro:```bash
cd /path/to/hate_crack
git fetch --tags --force origin
git checkout -B main origin/main
make install

Isso significa que os assets do hate_crack não foram incluídos no pacote instalado.

**Entendendo os caminhos:**
- `hcatPath` em config.json → aponta para a **localização do binário do hashcat** (opcional, pode estar no PATH)
- `hashcat-utils/` e `princeprocessor/` → incluídos no pacote pelo `make install`

**Solução:**
Reinstale usando o Makefile, que compila os submódulos e instala a ferramenta:```bash
cd /path/to/hate_crack  # the repository checkout
make install

**Carregamento de configuração:**
- Precedência para cada chave: `os.environ` > o arquivo home da própria chave (`.env` ou `config.json`) > padrão integrado
- Chaves ausentes recorrem aos padrões integrados; `config.json.example` documenta todas as chaves de `config.json`
- Ambos os arquivos são procurados, independentemente um do outro, nesta ordem: **raiz do repositório**, depois o **diretório do pacote instalado**, depois **`~/.hate_crack`**. A primeira correspondência vence; é normal que os dois arquivos venham de diretórios diferentes.
- Na primeira execução, ambos são criados — `config.json` a partir de `config.json.example`, `.env` a partir dos padrões integrados. Se um `config.json` mais antigo ainda contiver chaves de integração, elas são copiadas para o novo `.env` e o hate_crack informa quais você deve excluir de `config.json`; ele nunca edita esse arquivo por conta própria.
- Em todas as execuções, o hate_crack exibe os dois arquivos que realmente carregou:  ```
  [*] config.json: /home/you/.hate_crack/config.json
  [*] .env:        /home/you/.hate_crack/.env

O branch padrão foi renomeado de `master` para `main`. Corrija com:```bash
git remote set-head origin -a
git branch -m master main
git branch --set-upstream-to=origin/main main
git pull

Isto é idempotente - ignora ferramentas já instaladas.

**Forçar reinstalação limpa:**```bash
make reinstall

**Desinstalar** - remove dependências do SO e a ferramenta:```bash
make uninstall

**Executar testes** - lida automaticamente com HATE_CRACK_SKIP_INIT quando necessário:```bash
make test

**Limpar artefatos de build/teste:**```bash
make clean

### Executando Linters e Verificações de Tipo

Antes de enviar alterações, execute estas verificações localmente. Use `make lint` para tudo, ou execute verificações individuais:

**Ruff (linting e formatação):**```bash
make ruff
# or manually:
uv run ruff check hate_crack tests tools packaging hate_crack.py

**ty (verificação de tipos):**```bash
make ty
# or manually:
uv run ty check hate_crack

### Executando Testes

Os testes detectam automaticamente quando os submódulos não estão compilados e definem `HATE_CRACK_SKIP_INIT=1` automaticamente.```bash
make test

Com cobertura:```bash
make coverage

### Git Hooks (prek)

Os hooks do Git são gerenciados pelo [prek](https://github.com/j178/prek) (v0.3.3+). Instale os hooks com:```bash
prek install --hook-type pre-push --hook-type pre-commit

Menu options:
- **(1) Carregar Hashes Quebrados** - Enviar os hashes quebrados da sessão atual para o Hashview
- **(2) Carregar Wordlist** - Enviar um arquivo de wordlist para o Hashview
- **(3) Baixar Wordlist** - Baixar uma wordlist do Hashview
- **Baixar Regra** - Baixar um arquivo de regras do Hashview (descomprimido para texto simples, pronto para `hashcat -r`)
- **(4) Baixar Hashes Restantes** - Baixar os hashes restantes não quebrados (solicita a troca para quebra)
- **(5) Baixar Hashes Encontrados** - Baixar hashes já quebrados com senhas em texto claro (para referência/análise)
- **(6) Carregar Hashfile e Criar Job** - Enviar novo hashfile e criar um job de quebra
- **(99) Voltar ao Menu Principal** - Retornar ao menu principal

**Importante: Baixar Encontrados vs Baixar Restantes**
- **Baixar Hashes Restantes (4)**: Baixa hashes não quebrados que precisam de quebra. Mescla automaticamente com quaisquer hashes encontrados, se disponíveis, e solicita a troca para este hashfile para quebra.
- **Baixar Hashes Encontrados (5)**: Baixa hashes já quebrados no formato hash:texto claro. Eles servem para referência e não podem ser quebrados novamente. Nenhum prompt de troca é exibido.

#### Interface de Linha de Comando

As operações do Hashview também podem ser realizadas via linha de comando:

Carregar hashes quebrados:```bash
hate_crack.py --hashview upload-cracked --file <output_file>.out --hash-type 1000

Baixe um arquivo de regras (salvo descompactado, pronto para `hashcat -r`):```bash
hate_crack.py --hashview download-rules --rules-id 4 --output best64.rule

Baixar hashes encontrados (hashes já quebrados com texto claro):```bash
hate_crack.py --hashview download-found --customer-id 1 --hashfile-id 123

#### Configuração

Defina as credenciais do Hashview em `.env` (são configurações de integração, portanto não ficam em `config.json`):```
HASHVIEW_URL=https://hashview.example.com
HASHVIEW_API_KEY=your-api-key-here

- **`OLLAMA_MODEL`** — O modelo Ollama usado para geração de candidatos (padrão: `qwen2.5:32b`). O ataque LLM usa saída estruturada (JSON), então escolha um modelo com bom suporte a ferramentas/JSON.
- **`OLLAMA_NUM_CTX`** — Tamanho da janela de contexto para o modelo (padrão: `8192`). Era `2048` antes da introdução das estatísticas de corpus, o que era pequeno demais para conter o prompt que estava sendo fornecido: 500 textos simples amostrados consomem aproximadamente 2.000–3.500 tokens antes do prompt do sistema e da resposta, então o Ollama truncava silenciosamente parte da amostra que o amostrador havia distribuído cuidadosamente pelo arquivo.
- **`OLLAMA_TIMEOUT`** — Segundos de espera por uma resposta de geração antes de desistir (padrão: `300`). Aumente esse valor se um modelo grande ainda estiver carregando na VRAM na primeira requisição, caso contrário isso pode exceder o tempo limite; o hate_crack imprime o tempo limite decorrido e o nome dessa configuração quando isso ocorre.
- **`OLLAMA_MAX_SAMPLE_LINES`** — O limite abaixo do qual os modos LLM também colam os textos simples literais no prompt (padrão: `500`). Valores ≤ 0 são tratados como 500.

  Os modos derivados de corpus (**Wordlist**, **Cracked passwords**, **Pattern rules**) sempre descrevem o *corpus* inteiro estatisticamente — proporções de palavras-base, máscaras, capitalização, comprimentos, dígitos e símbolos finais, anos — em vez de colar uma fatia dele. A agregação é limitada, então um dump de 120.000 senhas custa aproximadamente o mesmo espaço de prompt que um de 500 linhas. Quando todo o corpus cabe nesse limite, os textos simples brutos também são incluídos, já que não há nada a ganhar ocultando um corpus pequeno do modelo.

  Isso substitui o comportamento anterior de colar uma amostra uniformemente espaçada de até `ollamaMaxSampleLines` senhas. Uma amostra de um dump grande não transmitia nenhuma informação de frequência: o modelo não conseguia distinguir uma palavra-base usada por 8% da organização de uma usada por uma única pessoa, que é precisamente o sinal que faz uma tentativa valer a pena.
- **`OLLAMA_NO_CLOUD`** — Quando `true`, recusa-se a enviar qualquer coisa para um modelo *cloud* do Ollama. O Ollama encaminha um modelo com tag `-cloud` (`gpt-oss:120b-cloud`, `deepseek-v3.1:671b-cloud`) para ollama.com através do mesmo endpoint local usado por um modelo local, então nada na requisição parece diferente — mas os prompts do hate_crack carregam textos simples recuperados, estatísticas de corpus e o nome, setor e localização do cliente. Com isso definido, um nome de modelo cloud é recusado antes que qualquer requisição seja construída. O padrão é `false`, então um modelo cloud configurado deliberadamente continua funcionando; ative essa opção para engajamentos em que os dados do cliente não podem sair do host.
- **`OLLAMA_AUTO_RESEARCH`** — Quando `true` (padrão), o modo **Target info** pede ao modelo local para sugerir o setor e a localização assim que você digitar o nome da empresa, e os oferece como padrões editáveis de prompt. Defina como `false` para sempre obter prompts em branco (útil com um modelo lento, pois a pesquisa custa uma ida e volta extra antes do ataque começar).
- **`OLLAMA_HOST`** — Onde o Ollama está escutando. Aceita um `host:port` sem esquema (`theplague.lan:11434`) ou uma URL completa com esquema (`https://ollama.example.com`); de qualquer forma, a URL base é normalizada antes do uso. O padrão é `localhost:11434`. Defina-o no `.env`, ou exporte-o como uma variável de ambiente real para sobrescrever isso em uma única execução — é o mesmo nome de variável que o CLI do próprio Ollama lê.
- Garanta que o Ollama esteja em execução e que o modelo tenha sido baixado (`ollama pull qwen2.5:32b`) antes de usar o LLM Attack — o hate_crack não baixa mais automaticamente modelos ausentes.

O ataque oferece três modos de geração:

1. **Target info** — empresa / setor / localização; o modelo deriva candidatos a partir desses detalhes.

   Depois que você digita o nome da empresa, o hate_crack pergunta ao mesmo modelo local o que ele já sabe sobre essa organização e pré-preenche os prompts **Industry** e **Location** com as respostas, mostradas entre parênteses:   ```
   Company name: Acme Rail Services

   [!] The values in parentheses below are the local model's GUESSES, not verified OSINT.
       Press Enter to accept, or type your own value to override.
   Industry (freight rail maintenance):
   Location (Omaha, Nebraska):

Uma falha de pesquisa — timeout, Ollama não executando, resposta vazia — nunca bloqueia o ataque; ela apenas retrocede para prompts em branco. Defina `ollamaAutoResearch` como `false` para pular a pesquisa por completo.
2. **Wordlist** — derivar palavras-base de uma wordlist de amostra.
3. **Senhas quebradas** — alimentar o modelo com os textos simples já recuperados nesta sessão (`<hashfile>.out`) para que ele possa inferir as próprias convenções de senha da organização alvo (palavras-base, estações do ano, anos, sufixos, leetspeak) e gerar *novos* candidatos no mesmo estilo. Esta opção só é listada depois que pelo menos um hash foi quebrado; o arquivo inteiro é analisado estatisticamente exatamente como no modo Wordlist (veja `ollamaMaxSampleLines` acima).

#### Configuração do PCFG

O Ataque PCFG (opção 20) e o Ataque PRINCE-LING (opção 21) usam o submódulo `pcfg_cracker`. Configure-os no `config.json`:```json
{
"pcfgRuleset": "DEFAULT",
"pcfgMaxCandidates": 50000000,
"pcfgPrinceLingMaxCandidates": 10000000
}

- **`check_for_updates`** — Ativa verificações automáticas de versão na inicialização (padrão: `true`).
- Quando ativado, o hate_crack busca as informações da versão mais recente no GitHub e exibe um aviso se houver uma atualização disponível.
- A verificação é executada de forma assíncrona e não bloqueia a inicialização. Erros de rede são ignorados silenciosamente.

##### Canais de Atualização

| Canal | Bandeira | Origem | O que você obtém |
|---------|------|--------|--------------|
| Release | `--update` | `main` | A versão estável mais recente. Este é o padrão e o que a verificação de inicialização oferece. |
| Nightly | `--nightly` | `nightly-dev` | Trabalho que passou pela CI, mas ainda não foi lançado. |

As versões seguem o semver comum, com o incremento derivado do que está de fato no
lote. O segundo componente muda **apenas para funcionalidades (features)**: um ciclo que contenha
qualquer commit `feat` está caminhando para `X.(Y+1).0`, e um ciclo apenas com correções,
documentação e tarefas de manutenção está caminhando para `X.Y.(Z+1)`.

`nightly-dev` cria tags de candidatos a lançamento para a versão para a qual o lote está caminhando — `v2.20.1rc1`, `v2.20.1rc2`, … — e o merge para `main` promove esse mesmo alvo ao seu lançamento final. Os candidatos são pré-lançamentos reais do PEP 440, então eles são ordenados corretamente em ambas as extremidades:

    2.20.0  <  2.20.1rc1  <  2.20.1rc2  <  2.20.1  <  2.21.0rc1  <  2.21.0

O alvo pode mudar no meio do ciclo: o primeiro `feat` a ser incorporado o move de
`X.Y.(Z+1)` para `X.(Y+1).0`, e a numeração dos candidatos recomeça para o novo alvo.
O número sempre indica o que o lote publicaria hoje.

O componente principal nunca é incrementado automaticamente — um assunto com `!` ou um rodapé `BREAKING CHANGE:` é contado como uma funcionalidade, porque um incremento automático de versão principal está a apenas uma linha de assunto mal digitada de um lançamento publicado irreversível. Um incremento de versão principal é um ato humano explícito: crie a tag e envie (push) manualmente.

A política está em `tools/next_version.py`, compartilhada pelos dois fluxos de trabalho de criação de tags e
com testes unitários em `tests/test_next_version.py`.

A verificação de inicialização oferece apenas lançamentos, porque as builds noturnas não publicam nenhum
lançamento do GitHub e a verificação lê o endpoint "latest release" do GitHub — portanto,
ativar `check_for_updates` nunca fará você cair em uma versão noturna. Duas coisas mantêm
os canais separados: isso e o fato de que um candidato é um pré-lançamento real do PEP 440,
de modo que uma ferramenta que classifica números de versão crus também o trata como mais antigo do que
o lançamento em que ele se torna.

Qualquer uma das bandeiras muda seu checkout para o branch correspondente primeiro (e
se recusa a fazer isso se houver alterações não confirmadas). Se você estiver executando uma versão noturna
e quiser voltar ao código lançado, `--update` o move de volta para `main`.

#### Mesclagem Automática de Hashes Encontrados (Somente Download de Left)

Ao baixar hashes left (hashes não quebrados), o hate_crack automaticamente:
1. Tenta baixar quaisquer hashes encontrados (quebrados) do Hashview como uma operação auxiliar
2. Mescla os hashes encontrados com arquivos `.out` locais (ex.: `left_1_123.txt.out` ou `left_1_123.nt.txt.out` para o formato pwdump)
3. Remove entradas duplicadas
4. Limpa arquivos divididos temporários após a mesclagem

Isso garante que seus resultados locais de quebra permaneçam sincronizados com o banco de dados centralizado do Hashview ao trabalhar com hashes não quebrados.

**Nota:** A opção download-found baixa hashes já quebrados separadamente para fins de referência e não realiza nenhuma mesclagem nem solicita a quebra.

O <hash_type> é obtido executando `hashcat --help`

Hashes de Exemplo: http://hashcat.net/wiki/doku.php?id=example_hashes```
$ hashcat --help |grep -i ntlm
   5500 | NetNTLMv1                                        | Network protocols
   5500 | NetNTLMv1 + ESS                                  | Network protocols
   5600 | NetNTLMv2                                        | Network protocols
   1000 | NTLM                                             | Operating-Systems

docker run -t owasp/zap2docker-weekly zap-api-scan.py \
    -t https://www.example.com/openapi.json \
    -f openapi -r zap_report.html

## Testes

A suíte de testes é majoritariamente offline e usa mocks/fixtures. Verificações de rede ao vivo e
verificações de dependências do sistema são opcionais, ativadas por variáveis de ambiente.

### Executando Testes Localmente```bash
# Run all tests
uv run pytest -v

# Run specific test
uv run pytest tests/test_hashview.py -v

### Testes ao Vivo do Hashview Contra uma Stack Docker Local

Em vez de apontar os testes ao vivo para um servidor Hashview remoto, você pode fazer
a suíte subir uma stack Docker local do [Hashview](https://github.com/hashview/hashview),
alimentá-la, executar os testes ao vivo contra ela e derrubá-la. Defina
`HASHVIEW_TEST_LOCAL=1` e aponte `HASHVIEW_REPO` para um checkout do Hashview:```bash
HASHVIEW_TEST_LOCAL=1 HASHVIEW_REPO=~/projects/hashview \
  HATE_CRACK_SKIP_INIT=1 uv run pytest tests/test_hashview_cli_subcommands_subprocess.py -v

Instalação/execução de ponta a ponta baseada em Docker (com cache via `Dockerfile.test`):```bash
HATE_CRACK_RUN_DOCKER_TESTS=1 uv run pytest tests/test_docker_script_install.py -v

A VM de teste é provisionada automaticamente com todas as dependências Linux (hashcat, build-essential, curl, git, gzip, p7zip-full, transmission-daemon, ocl-icd-libopencl1, pocl-opencl-icd, uv).```bash
HATE_CRACK_RUN_LIMA_TESTS=1 uv run pytest tests/test_lima_vm_install.py -v

Quais regras você gostaria de executar?
(1) best64.rule
(2) d3ad0ne.rule
(3) T0XlC.rule
(4) dive.rule
(99) YOLO...executar todas as regras
Insira uma lista separada por vírgulas das regras que você deseja executar. Para executar regras encadeadas, use o símbolo +.
Por exemplo, 1+1 executará best64.rule encadeada duas vezes e 1,2 executará best64.rule e depois d3ad0ne.rule sequencialmente.
Escolha com sabedoria:```




#### Extensive Pure_Hate Methodology Crack
Runs several attack methods provided by Martin Bos (formerly known as pure_hate):
  * Brute Force Attack (7 characters)
  * Dictionary Attack
    * All wordlists in `hcatWordlists` with `best64.rule`
    * `rockyou.txt` with `d3ad0ne.rule`
    * `rockyou.txt` with `T0XlC.rule`
  * Top Mask Attack (Target Time = 4 Hours)
  * Fingerprint Attack
  * Combinator Attack
  * Hybrid Attack
  * Extra - Just For Good Measure
    - Runs a dictionary attack using `rockyou.txt` with chained `combinator.rule` and `InsidePro-PasswordsPro.rule` rules

#### Brute Force Attack
Brute forces all characters with the choice of a minimum and maximum password length.

#### Top Mask Attack
Uses StatsGen and MaskGen from PACK (https://thesprawl.org/projects/pack/) to perform a top mask attack using passwords already cracked for the current session.
Presents the user a choice of target cracking time to spend (default 4 hours).

#### Fingerprint Attack
https://hashcat.net/wiki/doku.php?id=fingerprint_attack

Runs a fingerprint attack using passwords already cracked for the current session.

#### Combinator Attack
https://hashcat.net/wiki/doku.php?id=combinator_attack

Runs a combinator attack using the "rockyou.txt" wordlist.

#### Hybrid Attack
https://hashcat.net/wiki/doku.php?id=hybrid_attack

* Runs several hybrid attacks using the "rockyou.txt" wordlists.
  - Hybrid Wordlist + Mask - ?s?d wordlists/rockyou.txt ?1?1
  - Hybrid Wordlist + Mask - ?s?d wordlists/rockyou.txt ?1?1?1
  - Hybrid Wordlist + Mask - ?s?d wordlists/rockyou.txt ?1?1?1?1
  - Hybrid Mask + Wordlist - ?s?d ?1?1 wordlists/rockyou.txt
  - Hybrid Mask + Wordlist - ?s?d ?1?1?1 wordlists/rockyou.txt
  - Hybrid Mask + Wordlist - ?s?d ?1?1?1?1 wordlists/rockyou.txt

#### Pathwell Top 100 Mask Brute Force Crack
Runs a brute force attack using the top 100 masks from KoreLogic:
https://blog.korelogic.com/blog/2014/04/04/pathwell_topologies

#### PRINCE Attack
https://hashcat.net/events/p14-trondheim/prince-attack.pdf

Runs a PRINCE attack using wordlists/rockyou.txt

#### YOLO Combinator Attack
Runs a continuous combinator attack using random wordlists from the configured wordlists directory for the left and right sides.

#### Middle Combinator Attack
https://jeffh.net/2018/04/26/combinator_methods/

Runs a modified combinator attack adding a middle character mask:
wordlists/rockyou.txt + masks + worklists/rockyou.txt

Where the masks are some of the most commonly used separator characters:
2 4 <space> - _ , + . &

#### Thorough Combinator Attack
https://jeffh.net/2018/04/26/combinator_methods/

* Runs many rounds of different combinator attacks with the rockyou list.
  - Standard Combinator attack: rockyou.txt + rockyou.txt
  - Middle Combinator attack: rockyou.txt + ?n + rockyou.txt
  - Middle Combinator attack: rockyou.txt + ?s + rockyou.txt
  - End Combinator attack: rockyou.txt + rockyou.txt + ?n
  - End Combinator attack: rockyou.txt + rockyou.txt + ?s
  - Hybrid middle/end attack: rockyou.txt + ?n + rockyou.txt + ?n
  - Hybrid middle/end attack: rockyou.txt + ?s + rockyou.txt + ?s


#### Bandrel Methodology

Prompts for comma-separated names and creates a pseudo hybrid attack by capitalizing the first letter and adding up to six additional characters at the end. Each word is limited to a total of five minutes.

  - Built-in common words (seasons, months) included as a customizable `config.json` entry (`bandrel_common_basedwords`)
  - The default five-minute time limit is customizable via `bandrelmaxruntime` in `config.json`

#### Loopback Attack
https://hashcat.net/wiki/doku.php?id=loopback_attack

Uses hashcat's loopback mode to feed cracked passwords from the current session back into the attack pipeline with rules applied. This generates new password candidates based on variations of already-cracked passwords, which is particularly effective for finding related passwords that follow similar patterns.

* Prompts for rule selection to apply to the loopback candidates
* Uses an empty wordlist with the --loopback flag to process previously cracked passwords
* Automatically downloads Hashmob rules if no rules are available locally

#### LLM Attack
Uses a local Ollama instance to generate password candidates for a capture-the-flag scenario. Prompts for the fake company name, industry, and location, then sends these details to the configured LLM model to produce likely password candidates using industry terms and company name permutations. The generated candidates are fed into a hashcat wordlist+rules attack.

* Requires a running Ollama instance (default: `http://localhost:11434`, override with `OLLAMA_HOST` in `.env` or the environment) with the model already pulled — hate_crack does not auto-pull
* Candidate generation uses structured (JSON) output via Atomic Agents, so pick a model with good schema adherence (default: `qwen2.5:32b`)
* Configurable model, context window, request timeout, and sample size via `.env` (see Ollama Configuration below)
* Prompts for target company name, industry, and location. The industry and location prompts are pre-filled with the local model's guesses about the named organization (editable, and clearly labelled as guesses rather than verified OSINT); disable with `ollamaAutoResearch: false`
* Alternatively derives basewords from a sample **wordlist**, or from the **cracked passwords** of the current session (`<hashfile>.out`) so the model mirrors the target organization's own password conventions and produces new candidates in that style (only offered once something has been cracked)
* A live spinner with an elapsed-seconds counter runs during generation, and requests are bounded by `ollamaTimeout` so a model stuck loading into VRAM reports a timeout instead of hanging

**Pattern rules mode** (option 4 in the LLM submenu) takes the same shape as the [Spoonman Attack](#spoonman-attack) — a baseword list run through a rule file, both derived from one corpus — but infers each side with the model instead of extracting it. Spoonman is exact and therefore bounded: its basewords all appear in the corpus and its rules only reproduce transformations the corpus already shows. This asks the model to generalize on both axes, so it can name the *word families* behind a sample (the company and its products, site names, local sports teams, seasons, mascots) and write decorations the corpus does not contain.

* Pattern source is either the current session's cracked passwords (offered first, and only once something has been cracked, since those reveal the target's real conventions) or a sample wordlist
* **You are not asked to pick a rule file.** The model writes one, from the same corpus statistics — a stock rule file encodes the internet's habits, and the point of spending a model round trip is to encode *this* organization's
* Basewords are normalized to lowercase letters only, discarding anything under 3 characters, so the generated rules supply case, digits, and punctuation exactly once
* Generated rules are validated before hashcat sees them, and anything using an op hashcat does not have, a position argument outside `0-9A-Z`, more than 31 functions, or a stray comment or non-ASCII character is discarded. hashcat drops an invalid rule *silently* when valid rules share the file, so an unscreened line would become missing coverage rather than an error. The op table was established by testing hashcat itself, not from its rule documentation, which lists ops hashcat will not actually run
* Local-model yield varies a lot run to run, so a thin answer is asked again once and the two rounds are merged — a handful of rules would waste the pass they are spent on
* If no rule survives validation the basewords still run, unmutated, rather than throwing away the expensive half of the run
* Output lands in `<hashfile>.llm_patterns/` as `basewords.txt` and `rules.rule` — per-run scratch, laid out like `.spoonman/` and removed on exit

#### OMEN Attack
Uses the Ordered Markov ENumerator (OMEN) to train a statistical password model from a wordlist and generate password candidates. This attack learns patterns from known passwords and generates new candidates based on those patterns.

* Requires OMEN binaries (createNG and enumNG) to be built from the omen submodule
* Interactive menu: use existing model, train new model, or cancel
* Training wordlist picker shows available wordlists from configured directory or accepts a custom path
* Validates all 5 required model files (createConfig, CP/IP/EP/LN.level) before running
* Captures and reports enumNG errors instead of failing silently
* Generates up to a specified number of password candidates (configurable via `omenMaxCandidates`)
* Pipes generated candidates directly into hashcat for cracking
* Model files and metadata are stored in `~/.hate_crack/omen/` for persistence across sessions

#### Combinator Attacks Submenu
Opens an interactive submenu with six combinator attack variants (formerly at menu keys 10-12). Consolidates related attacks for cleaner menu organization:
- Combinator Attack - combines two wordlists
- YOLO Combinator Attack - combines all permutations of multiple wordlists
- Middle Combinator Attack - combines wordlists with an extra word in the middle
- Thorough Combinator Attack - comprehensive combination of wordlists with rules
- Combinator3 Attack - combines exactly 3 wordlists using `combinator3.bin`, generating all `word1+word2+word3` combinations piped to hashcat
- CombinatorX Attack - combines 2-8 wordlists using `combinatorX.bin` with optional `--sepFill` separator character between word segments

#### Ad-hoc Mask Attack
Runs hashcat mask attack (mode 3) with a user-specified custom mask string. Allows fine-grained control over character-set brute forcing.

* Opens with a choice between typing a mask and selecting a mask file
* Prompts for a hashcat mask (e.g., `?u?l?l?l?d?d` for uppercase + lowercase + lowercase + lowercase + digit + digit)
* Supports custom character sets (`-1`, `-2`, `-3`, `-4`) for specialized character combinations
* Interactive charset entry with early exit on blank input
* Mask files (`.hcmask`) can be selected with tab completion, defaulting to the bundled `masks/` directory; hashcat runs every mask in the file in order. Because a mask file defines its own charsets inline, the `-1` through `-4` prompts are skipped when one is chosen
* Useful for targeted brute forcing when you know password structure patterns

#### Markov Brute Force Attack
Generates password candidates using Markov chain statistical models. Similar to OMEN but simpler and faster.

* Checks for existing `.hcstat2` Markov table from previous sessions (with option to reuse, regenerate, or cancel)
* Generates table from training source if needed:
  - Can use cracked passwords from current session (`.out` file) as training data
  - Or select any wordlist from configured directory or custom path
* Interactive menu: choose minimum and maximum password length
* Uses `--increment` flag to test lengths in sequence
* Markov table persists with hash file (filename.out.hcstat2) for fast subsequent runs
* Faster than OMEN for general-purpose brute forcing

#### N-gram Attack
Generates n-gram candidates from a corpus file using `ngramX.bin` from hashcat-utils and pipes them into hashcat.

* Prompts for a corpus file with tab completion, defaulting to the configured wordlist directory
* Prompts for an n-gram group size (default 3)
* Gzip-compressed corpus files are auto-detected and decompressed on the fly
* Useful when you have target-relevant prose (scraped site copy, leaked documents, internal wiki exports) rather than a password list

#### Permutation Attack
Generates all character permutations of each word in a targeted wordlist and pipes them to hashcat via `permute.bin` from hashcat-utils.

* Prompts for a single wordlist file (not a directory)
* Effective against short targeted wordlists where the character set is known but the order is not (company abbreviations, name fragments, known tokens)
* WARNING: Scales as N! per word - an 8-character word produces 40,320 permutations. Only practical for words up to ~8 characters.
* Uses `permute.bin < wordlist | hashcat` pipeline pattern

#### Random Rules Attack
Generates a set of random hashcat mutation rules using `generate-rules.bin`, writes them to a temporary file, then runs hashcat against a chosen wordlist with those rules.

* Prompts for rule count (default 65536)
* Prompts for wordlist path with tab-completion and numbered selection
* Temporary rules file is cleaned up after the run regardless of outcome
* Useful when known rule sets are exhausted - explores random rule-space for additional cracks

#### Combipow Passphrase Attack
Generates all unique non-empty subset combinations from a short wordlist using `combipow.bin` and pipes them into hashcat. Designed for passphrase cracking when you know the pool of words a password was built from.

* Prompts for a wordlist file (max 63 lines - combipow generates up to 2^n-1 combinations)
* Optional space separator (`-s` flag) to insert spaces between words in each combination
* Warns if the wordlist exceeds 20 lines (output volume may be large)
* Aborts with a clear message if the wordlist exceeds 63 lines (hard limit)
* Candidates are piped directly to hashcat stdin

#### PCFG Attack
Uses [pcfg_cracker](https://github.com/lakiw/pcfg_cracker) to generate candidates from a Probabilistic Context-Free Grammar, piping `pcfg_guesser.py` output directly into hashcat's stdin mode. A PCFG models password *structure* (baseword + digits + symbol, capitalization habits, keyboard walks) with learned probabilities, so candidates come out roughly in descending likelihood order.

* Requires the `pcfg_cracker` submodule. Presence is checked at startup and reported non-fatally: if it is missing, the PCFG attacks are simply unavailable. Run `make` to fetch it.
* Uses the trained grammar named by `pcfgRuleset` in `config.json` (default `DEFAULT`), read from `pcfg_cracker/Rules/<name>/`
* Candidate count is capped by `pcfgMaxCandidates` (default 50,000,000)
* hate_crack does not wrap grammar training. To build a grammar from a target-specific password set, run pcfg_cracker's own `trainer.py` and point `pcfgRuleset` at the resulting ruleset name

#### PRINCE-LING Attack
Uses pcfg_cracker's `prince_ling.py` to derive an optimized PRINCE base wordlist from a trained grammar, then hands it to the existing PRINCE attack. PRINCE-LING picks base words the grammar says are actually productive, so the PRINCE combination space is far less wasteful than pointing PRINCE at a generic wordlist.

* Requires the `pcfg_cracker` submodule and a trained ruleset directory, same as the PCFG attack
* The generated wordlist is cached at `<hcatOptimizedWordlists>/pcfg_prince_ling_<ruleset>.txt` and reused across sessions
* Regenerates only when the ruleset directory is newer than the cached wordlist, so retraining a grammar invalidates the cache automatically
* Generation is written to a temporary file and atomically moved into place; a failed or interrupted run cleans up its partial file and leaves any existing cache intact
* Base wordlist size is capped by `pcfgPrinceLingMaxCandidates` (default 10,000,000)

#### Spoonman Attack
Derives a baseword list and a hashcat rule file from a corpus of known plaintext passwords — a previous engagement's cracked output, a leak dump, or any password list — such that the baseword x rule cross product reconstructs the corpus exactly (see the memory bound below for the one case where it does not). Contributed as issue #169 by @Spoonman1091.

Each password is split into its letters-only lowercased core (the baseword) plus a rule that rebuilds the original from it, using `l`/`u`/`c` for casing, `T{p}` toggles, `${x}`/`^{x}` for trailing and leading characters, and `i{p}{x}` for interior ones.

* When the current session already has cracked plaintexts (`<hash file>.out` exists and is non-empty), a picker offers those as the corpus ahead of a free-form path — the target's own recovered passwords derive rules describing that target's actual conventions, which is exactly what you want to fire back at the remaining uncracked hashes. Deriving from `.out` and then cracking the same hash file appends new plaintexts to that same file, growing the corpus for the next run; that is the intended feedback loop, not corruption. Sessions with no cracked output yet see no picker at all — just today's path prompt
* Prompts for the corpus, then for how much of the rule file to run: top 50% coverage (listed first and recommended), top 75%, top 95%, top 99%, or the full set
* Rules are sorted by how many passwords each one rebuilds, so a truncated file keeps the most productive rules. Coverage is extremely long-tailed: on a 98.2M-password sample, 50% coverage needed 4,120 rules while 95% needed 16,119,661 and 100% needed 21,029,696 — the last few percent typically costs orders of magnitude more rules than the first half, which is why the smallest tier is listed first and is usually the right choice
* Output is written beside the hash file in `<hash file>.spoonman/`, alongside the other ephemeral wordlists: `basewords.txt`, `rules.full.rule`, the capped rule files, and `coverage.txt` with per-milestone rule counts. Derivation is skipped on later runs of the same hash file unless the corpus has been modified since, and the directory is removed on exit by the temp-file cleanup
* Derivation is bounded in memory. Both counters would otherwise grow for the whole read with nothing written until the end, so a corpus large enough to exhaust RAM lost the entire pass to an OOM kill and produced no output; a measured run against a 31 GB corpus reached 14.1 GB resident at 11% of the file and was still accelerating. Each counter is now capped at 20 million distinct keys (about 1.6 GB apiece), and the lowest-frequency keys are discarded once it is exceeded. If that happens, the run says so on the console and in `coverage.txt`, the output reconstructs the retained keys rather than 100% of the corpus, and the coverage percentages are relative to those. Corpora below the cap are unaffected
* Passwords that cannot be expressed as a rule are written verbatim as their own baseword with a `:` no-op, so coverage stays complete. This covers two hashcat limits: rule positions cannot address past index 35, and hashcat rejects any rule with more than 31 functions — silently, when valid rules share the file
* The derivation self-checks every password by reconstructing it in-process, and reports any failures rather than reporting success
* Corpus lines may carry a hash in front of the password, as cracked output does. A leading field is dropped only when it has the shape of a hash (a hex digest at a known length, or a crypt-style `$id$` string), so `hash:salt:plain` is handled while a plaintext or wordlist entry containing a colon survives intact. `$HEX[...]` plaintexts are decoded. If most lines look like an uncracked dump rather than cracked output, `coverage.txt` records the count and the attack warns — the derived basewords and rules would otherwise be meaningless without any error being raised

#### Rosetta Attack
Mines hashcat `--debug-mode 5` logs for the basewords and rules that already cracked something, then runs their full cross product. Powered by [HashcatRosetta](https://github.com/bandrel/HashcatRosetta), the same library behind [Analyze Hashcat Rules](#analyze-hashcat-rules-rule-file-tools-option-5).

No setup is needed to feed it: `_add_debug_mode_for_rules` appends `--debug-mode 5 --debug-file` to every rule-based hashcat invocation hate_crack makes, so the logs accumulate in `hcatDebugLogPath` (`~/.hate_crack/hashcat_debug` by default, one file per session) as a side effect of normal use. A mode 5 log records only candidates that cracked a hash, in the form `baseword:rule:candidate:wordlist`, which is what makes both halves known-productive against this target population; the trailing wordlist field also shows which list is earning its keep on a multi-wordlist run. HashcatRosetta parses mode 4 and mode 5 alike, so logs written before the switch are still read.

The value is in the cross product rather than the recorded pairs. A pair present in a log has already cracked its hash and will not crack another, but a rule that worked on one baseword has usually never been tried against the others — so N basewords and M rules yield close to N x M untried candidates.

The menu first asks how to rank rules — choices 1-3 below, plus a fourth, unrelated mode:

* Rules can be ranked by application frequency, by how many distinct basewords each one worked on, or by how many unique candidates each one generated. Frequency is the default; baseword spread is the better choice when the goal is a rule set that generalizes past the specific words it was learned from
* Only after one of those three is picked does hate_crack list the logs found in `hcatDebugLogPath` newest-first with their sizes; pick one, pick all of them (up to 20), or type a path to a log from elsewhere
* Prompts for how many top rules to keep (default 100) and how many top basewords (default all). Zero means unlimited for either. The keyspace is the product of the two and is printed before hashcat starts
* Output is written beside the hash file in `<hash file>.rosetta/` as `basewords.txt` and `rules.rule`, alongside the other ephemeral wordlists, and the directory is removed on exit by the temp-file cleanup
* Reading stops at 1,000,000 debug lines, since the analyzer needs the whole batch in memory at once. Truncation is reported on the console rather than assumed harmless — logs from a long run routinely exceed this, in which case the newest log is the one worth selecting
* **LLM Mask Attack** (4) - a different mode entirely, and the only one that needs no debug logs. Prompts for a natural-language description of the passwords you expect (length, character patterns, symbols, etc.), sends it to the locally configured Ollama model, writes the returned masks to `<hash file>.hcmask`, and runs a `-a 3` hashcat mask attack against them

#### Wordlist Tools (option 80)
A submenu of wordlist preprocessing utilities using hashcat-utils binaries. All tools read from and write to files on disk. All file and directory path prompts support tab completion.

| Key | Tool | Description |
|-----|------|-------------|
| 1 | Filter by Length | Keep only words between a min and max length (`len.bin`) |
| 2 | Require Char Classes | Keep words that include all char classes in mask (`req-include.bin`). Mask: 1=lower, 2=upper, 4=digit, 8=symbol (additive) |
| 3 | Exclude Char Classes | Remove words containing any char class in mask (`req-exclude.bin`). Same mask encoding |
| 4 | Extract Substring | Cut bytes from each word at a given offset and optional length (`cutb.bin`) |
| 5 | Split by Length | Create per-length files in an output directory (`splitlen.bin`) |
| 6 | Subtract Wordlist | Remove lines from a wordlist that appear in one or more remove files. Mode 1 uses `rli2.bin` (single file); mode 2 uses `rli.bin` (multiple files) |
| 7 | Shard Wordlist | Split a wordlist into N equal, interleaved parts in one run, written as `base.001`…`base.00N` for distributed cracking (`gate.bin`) |
| 8 | Optimize Wordlists | Dedupe and split the selected wordlists into per-length files under an output directory |
| 9 | Download from Hashmob.net | Browse and download wordlists from Hashmob.net into the configured wordlist directory |
| 10 | Download from Weakpass | Browse and download Weakpass wordlist torrents, with automatic extraction |

All binaries are in `hate_crack/hashcat-utils/bin/`.

#### Rule File Tools (option 81)
Preprocesses hashcat rule files using `cleanup-rules.bin` and `rules_optimize.bin` from hashcat-utils, and downloads rule files from Hashmob.net.

* **Clean** (1) - removes invalid syntax and duplicate rules using `cleanup-rules.bin`. Useful after combining rule files or downloading rules from external sources.
* **Optimize** (2) - consolidates redundant operations using `rules_optimize.bin`. Reduces rule file size and improves cracking speed.
* **Clean and optimize** (3) - runs both operations in sequence via a temporary file, then writes the final result.
* **Download rules from Hashmob.net** (4) - fetches rule files into the configured `rulesDirectory`.
* **Analyze Hashcat rules** (5) - opcode frequency analysis of a rule file, powered by HashcatRosetta.

The three preprocessing operations read from an input file and write to a separate output file (original is never modified).

#### Download Rules from Hashmob.net (Rule File Tools option 4)
Downloads the latest rule files from Hashmob.net's rule repository. These rules are curated and optimized for password cracking and can be used with the Quick Crack and Loopback Attack modes.

* Downloads rule sets in parallel using a thread pool (up to 4 concurrent downloads)
* Skips rules already downloaded locally
* Reports download summary with success/failure counts
* Stores rules in the configured rules directory

#### Analyze Hashcat Rules (Rule File Tools option 5)
Powered by HashcatRosetta (https://github.com/bandrel/HashcatRosetta), this feature analyzes hashcat rule files to provide detailed insights into rule composition and complexity.

* Prompts for a rule file path
* Displays frequency analysis of rule opcodes (operations)
* Helps understand what transformations a rule set performs
* Useful for rule debugging and optimization

#### Download Wordlists from Hashmob.net (Wordlist Tools option 9)
Downloads wordlists from Hashmob.net's collection of cracked passwords and commonly used wordlists.

* Interactive menu for browsing available wordlists
* Progress tracking for large downloads
* Stores wordlists in configured wordlist directory

#### Weakpass Wordlist Menu (Wordlist Tools option 10)
Interactive menu for downloading and managing wordlists from Weakpass.com via BitTorrent.

* Browse available Weakpass wordlist torrents
* Download specific wordlists or entire collections
* Automatic extraction of compressed archives
* Progress tracking for torrent downloads

-------------------------------------------------------------------
### Version History

The full, per-release changelog now lives in [CHANGELOG.md](https://github.com/trustedsec/hate_crack/blob/HEAD/CHANGELOG.md).