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

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

Si vous avez cloné sans les sous-modules, initialisez-les :```bash
git submodule update --init --recursive

`.env.example` est commité et fourni avec chaque clé d’identifiants vide. `.env` lui-même ne doit **jamais** être commité — il est gitignoré, ainsi que ses variantes de sauvegarde habituelles, et hate_crack le crée toujours avec le mode `0600` (lecture/écriture pour le propriétaire uniquement). `.env.example` est généré à partir du schéma ; régénérez-le après avoir modifié `hate_crack/config_schema.py` avec `uv run python -m hate_crack.config_writer`.

### 3. Installer les dépendances et hate_crack

La façon la plus simple est d’exécuter `make` (ou `make install`), qui détecte automatiquement votre OS et installe :
- Dépendances externes (p7zip, transmission-daemon / transmission-remote)
- Construit les sous-modules (hashcat-utils, princeprocessor, pcfg_cracker, et optionnellement omen)
- Dépendances Python via uv et un shim CLI dans `~/.local/bin/hate_crack````bash
make

**Ou installez les dépendances manuellement :**

### Dépendances externes
Celles-ci sont requises pour certains flux de téléchargement/extraction :

- `7z`/`7za` (p7zip) — utilisé pour extraire les archives `.7z`.
- `transmission-daemon` / `transmission-remote` — utilisé pour télécharger les torrents Weakpass.

Commandes d'installation manuelle :

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

Ensuite, installez les dépendances Python et le shim 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

Vous pouvez également exécuter via `uv` :```bash
uv run hate_crack.py <hash_file> <hash_type>

La commande `make install` crée un shim bash dans `~/.local/bin/hate_crack` qui s'exécute depuis le répertoire du dépôt, afin que la configuration et les ressources soient toujours trouvées quel que soit votre répertoire de travail courant.

La configuration est également recherchée dans :
- La racine du dépôt et le répertoire du paquet
- `~/.hate_crack`

**Remarque :** Le `hcatPath` dans `config.json` sert uniquement à l'emplacement du binaire hashcat (facultatif si hashcat est dans le PATH). Les ressources Hate_crack (hashcat-utils, princeprocessor, pcfg_cracker, omen) sont chargées depuis le répertoire du dépôt et embarquées automatiquement par `make install`.

### Exécuter en tant que script

Le script utilise un shebang `uv`. Rendez-le exécutable et lancez-le :```bash
chmod +x hate_crack.py
./hate_crack.py

### Utilisation non interactive / scriptée

Pour l'automatisation, vous pouvez lancer une seule attaque directement, en contournant le menu. Le nom de l'attaque est le premier argument, suivi du fichier de hash et du type de hash hashcat. Les invites de prétraitement (filtrage des comptes d'ordinateur, force brute LM-first, déduplication des comptes en double) acceptent automatiquement leurs valeurs par défaut dans ce mode. Le processus se termine avec `0` en cas de succès et une valeur non nulle en cas d'erreur (fichier de hash manquant, type de hash non numérique, fichier de liste de mots manquant ou nom de fichier de règles inconnu).```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

Cela affecte les clones créés avant juillet 2026. L'historique publié a été réécrit
ensuite pour supprimer certains fichiers qui n'auraient jamais dû être commités, ce qui a donné
à chaque commit un nouvel ID ; les tags d'un ancien clone pointent donc vers des objets que ce
dépôt ne contient plus, et git refuse de déplacer un tag qu'il possède déjà.
Rien ne cloche dans votre checkout et aucune donnée de cracking n'est en danger.

Récupérez avec une réinitialisation unique. Cela supprime les commits et modifications locaux dans le
checkout ; donc si vous avez personnalisé quelque chose suivi par git (contrairement à
`config.json`, qui n'est pas suivi), commitez-le d'abord sur une branche :```bash
cd /path/to/hate_crack
git fetch --tags --force origin
git checkout -B main origin/main
make install

Cela signifie que les ressources hate_crack n'ont pas été incluses dans le paquet installé.

**Comprendre les chemins :**
- `hcatPath` dans config.json → pointe vers **l'emplacement du binaire hashcat** (optionnel, peut être dans le PATH)
- `hashcat-utils/` et `princeprocessor/` → inclus dans le paquet par `make install`

**Solution :**
Réinstallez en utilisant le Makefile, qui compile les sous-modules et installe l'outil :```bash
cd /path/to/hate_crack  # the repository checkout
make install

**Chargement de la configuration :**
- Précédence pour chaque clé : `os.environ` > le fichier d'accueil de la clé (`.env` ou `config.json`) > valeur par défaut intégrée
- Les clés manquantes retombent sur les valeurs par défaut intégrées ; `config.json.example` documente chaque clé de `config.json`
- Les deux fichiers sont recherchés, indépendamment l'un de l'autre, dans cet ordre : **racine du dépôt**, puis **répertoire du paquet installé**, puis **`~/.hate_crack`**. Le premier trouvé est utilisé ; il est normal que les deux fichiers proviennent de répertoires différents.
- Au premier lancement, les deux sont créés — `config.json` à partir de `config.json.example`, `.env` à partir des valeurs par défaut intégrées. Si un ancien `config.json` contient encore des clés d'intégration, elles sont copiées dans le nouveau `.env` et hate_crack vous indique lesquelles supprimer de `config.json` ; il ne modifie jamais ce fichier lui-même.
- À chaque exécution, hate_crack affiche les deux fichiers qu'il a réellement chargés :  ```
  [*] config.json: /home/you/.hate_crack/config.json
  [*] .env:        /home/you/.hate_crack/.env

La branche par défaut a été renommée de `master` à `main`. Corrigez avec :```bash
git remote set-head origin -a
git branch -m master main
git branch --set-upstream-to=origin/main main
git pull

Ceci est idempotent - il ignore les outils déjà installés.

**Réinstallation propre forcée :**```bash
make reinstall

**Désinstallation** - supprime les dépendances OS et l'outil:```bash
make uninstall

**Exécuter les tests** - gère automatiquement HATE_CRACK_SKIP_INIT lorsque nécessaire :```bash
make test

**Nettoyer les artefacts de build/test:**```bash
make clean

### Exécution des linters et des vérifications de types

Avant de pousser des modifications, exécutez ces vérifications localement. Utilisez `make lint` pour tout, ou exécutez des vérifications individuelles :

**Ruff (lint et formatage) :**```bash
make ruff
# or manually:
uv run ruff check hate_crack tests tools packaging hate_crack.py

**ty (vérification de type):**```bash
make ty
# or manually:
uv run ty check hate_crack

### Exécution des tests

Les tests détectent automatiquement lorsque les sous-modules ne sont pas construits et définissent `HATE_CRACK_SKIP_INIT=1` automatiquement.```bash
make test

Avec couverture :```bash
make coverage

### Hooks Git (prek)

Les hooks Git sont gérés par [prek](https://github.com/j178/prek) (v0.3.3+). Installez les hooks avec :```bash
prek install --hook-type pre-push --hook-type pre-commit

Options du menu :
- **(1) Upload Cracked Hashes** - Envoyer les résultats crackés de la session courante vers Hashview
- **(2) Upload Wordlist** - Envoyer un fichier wordlist vers Hashview
- **(3) Download Wordlist** - Télécharger une wordlist depuis Hashview
- **Download Rule** - Télécharger un fichier de règles depuis Hashview (décompressé en texte brut, prêt pour `hashcat -r`)
- **(4) Download Left Hashes** - Télécharger les hashes non crackés restants (invite à basculer pour le cracking)
- **(5) Download Found Hashes** - Télécharger les hashes déjà crackés avec les mots de passe en clair (pour référence/analyse)
- **(6) Upload Hashfile and Create Job** - Envoyer un nouveau fichier de hashes et créer une tâche de cracking
- **(99) Back to Main Menu** - Revenir au menu principal

**Important : Download Found vs Download Left**
- **Download Left Hashes (4)** : Télécharge les hashes non crackés qui doivent être crackés. Fusionne automatiquement avec les hashes trouvés si disponibles, et invite à basculer vers ce fichier de hashes pour le cracking.
- **Download Found Hashes (5)** : Télécharge les hashes déjà crackés au format hash:cleartext. Ceux-ci servent de référence et ne peuvent pas être crackés davantage. Aucune invite de basculement n'est affichée.

#### Interface en ligne de commande

Les opérations Hashview peuvent également être effectuées via la ligne de commande :

Envoyer les hashes crackés :```bash
hate_crack.py --hashview upload-cracked --file <output_file>.out --hash-type 1000

Téléchargez un fichier de règles (enregistré décompressé, prêt pour `hashcat -r`):```bash
hate_crack.py --hashview download-rules --rules-id 4 --output best64.rule

Télécharger les hashes trouvés (hashes déjà craqués avec texte en clair):```bash
hate_crack.py --hashview download-found --customer-id 1 --hashfile-id 123

#### Configuration

Définissez les identifiants Hashview dans `.env` (ce sont des paramètres d'intégration, donc ils ne se trouvent pas dans `config.json`) :```
HASHVIEW_URL=https://hashview.example.com
HASHVIEW_API_KEY=your-api-key-here

- **`OLLAMA_MODEL`** — Le modèle Ollama utilisé pour la génération de candidats (par défaut : `qwen2.5:32b`). L'attaque LLM utilise une sortie structurée (JSON), choisissez donc un modèle avec un bon support des outils/JSON.
- **`OLLAMA_NUM_CTX`** — Taille de la fenêtre de contexte pour le modèle (par défaut : `8192`). Elle était de `2048` avant l'introduction des statistiques de corpus, ce qui était trop petit pour contenir le prompt qui lui était fourni : 500 textes clairs échantillonnés représentent environ 2,000–3,500 tokens avant le prompt système et la réponse, donc Ollama tronquait silencieusement une partie de l'échantillon que l'échantillonneur avait soigneusement répartie dans le fichier.
- **`OLLAMA_TIMEOUT`** — Secondes à attendre une réponse de génération avant d'abandonner (par défaut : `300`). Augmentez cette valeur si un grand modèle est encore en cours de chargement en VRAM lors de la première requête, ce qui peut sinon dépasser le délai d'attente ; hate_crack affiche le délai écoulé et le nom de ce paramètre lorsque cela se produit.
- **`OLLAMA_MAX_SAMPLE_LINES`** — Le seuil en dessous duquel les modes LLM collent également les textes clairs littéraux dans le prompt (par défaut : `500`). Les valeurs ≤ 0 sont traitées comme 500.

  Les modes dérivés du corpus (**Wordlist**, **Cracked passwords**, **Pattern rules**) décrivent toujours le *corpus entier* de manière statistique — proportions de mots de base, masques, casses, longueurs, chiffres et symboles finaux, années — plutôt que d'en coller un extrait. L'agrégation est bornée, donc un dump de 120,000 mots de passe coûte à peu près le même espace de prompt qu'un dump de 500 lignes. Lorsque le corpus entier tient sous ce seuil, les textes clairs bruts sont également inclus, car il n'y a rien à gagner à cacher un petit corpus au modèle.

  Cela remplace le comportement précédent consistant à coller un échantillon régulièrement espacé d'au plus `ollamaMaxSampleLines` mots de passe. Un échantillon d'un gros dump ne transmettait aucune information de fréquence : le modèle ne pouvait pas distinguer un mot de base utilisé par 8 % de l'organisation d'un mot de base utilisé par une seule personne, ce qui est précisément le signal qui rend une tentative intéressante.
- **`OLLAMA_NO_CLOUD`** — Quand `true`, refuse d'envoyer quoi que ce soit à un modèle *cloud* Ollama. Ollama transmet un modèle marqué `-cloud` (`gpt-oss:120b-cloud`, `deepseek-v3.1:671b-cloud`) vers ollama.com via le même point de terminaison local qu'un modèle local, donc rien dans la requête ne semble différent — mais les prompts de hate_crack contiennent les textes clairs récupérés, les statistiques du corpus, ainsi que le nom, le secteur et la localisation du client. Avec cette option activée, un nom de modèle cloud est refusé avant même la construction de toute requête. La valeur par défaut est `false`, donc un modèle cloud configuré délibérément continue de fonctionner ; activez-la pour les missions où les données client ne doivent pas quitter l'hôte.
- **`OLLAMA_AUTO_RESEARCH`** — Quand `true` (par défaut), le mode **Target info** demande au modèle local de suggérer le secteur et la localisation dès que vous avez tapé le nom de l'entreprise, et les propose comme valeurs par défaut modifiables du prompt. Mettez `false` pour toujours obtenir des prompts vides (utile avec un modèle lent, car la recherche coûte un aller-retour supplémentaire avant le début de l'attaque).
- **`OLLAMA_HOST`** — Où Ollama écoute. Accepte un `host:port` nu (`theplague.lan:11434`) ou une URL complète avec un schéma (`https://ollama.example.com`) ; dans les deux cas, l'URL de base est normalisée avant utilisation. Par défaut `localhost:11434`. Définissez-le dans `.env`, ou exportez-le comme une véritable variable d'environnement pour le remplacer pour une seule exécution — c'est le même nom de variable que lit le propre CLI d'Ollama.
- Assurez-vous qu'Ollama est en cours d'exécution et que le modèle est téléchargé (`ollama pull qwen2.5:32b`) avant d'utiliser l'attaque LLM — hate_crack ne télécharge plus automatiquement les modèles manquants.

L'attaque propose trois modes de génération :

1. **Target info** — entreprise / secteur / localisation ; le modèle déduit les candidats de ces détails.

   Après avoir tapé le nom de l'entreprise, hate_crack demande au même modèle local ce qu'il sait déjà de cette organisation et pré-remplit les prompts **Industry** et **Location** avec les réponses, affichées entre parenthèses :   ```
   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):

Un échec de recherche — délai d'attente, Ollama non lancé, réponse vide — ne bloque jamais l'attaque ; il retombe simplement sur des invites vides. Définissez `ollamaAutoResearch` sur `false` pour ignorer complètement la recherche.
2. **Wordlist** — dériver les mots de base à partir d'un échantillon de liste de mots.
3. **Mots de passe craqués** — renvoyer au modèle les textes en clair déjà récupérés lors de cette session (`<hashfile>.out`) afin qu'il puisse déduire les conventions de mots de passe propres à l'organisation cible (mots de base, saisons, années, suffixes, leetspeak) et générer de *nouveaux* candidats dans le même style. Cette option n'est proposée qu'à partir du moment où au moins un hash a été craqué ; le fichier entier est analysé statistiquement exactement comme le mode Wordlist (voir `ollamaMaxSampleLines` ci-dessus).

#### Configuration PCFG

L'attaque PCFG (option 20) et l'attaque PRINCE-LING (option 21) utilisent le sous-module `pcfg_cracker`. Configurez-les dans `config.json` :```json
{
"pcfgRuleset": "DEFAULT",
"pcfgMaxCandidates": 50000000,
"pcfgPrinceLingMaxCandidates": 10000000
}

- **`check_for_updates`** — Active la vérification automatique des versions au démarrage (par défaut : `true`).
- Lorsque cette option est activée, hate_crack récupère les dernières informations de version depuis GitHub et affiche une notification si une mise à jour est disponible.
- La vérification s'exécute de manière asynchrone et ne bloque pas le démarrage. Les erreurs réseau sont ignorées silencieusement.

##### Canaux de mise à jour

| Canal | Option | Source | Ce que vous obtenez |
|---------|------|--------|--------------|
| Release | `--update` | `main` | La dernière version publiée. C'est le choix par défaut et ce que propose la vérification au démarrage. |
| Nightly | `--nightly` | `nightly-dev` | Le travail qui a passé la CI mais qui n'a pas encore été publié. |

Les versions suivent le semver classique, l'incrément étant dérivé de ce qui se trouve réellement dans le lot. Le deuxième composant n'évolue **que pour les fonctionnalités** : un cycle contenant un commit `feat` aboutit à `X.(Y+1).0`, et un cycle composé uniquement de correctifs, de documentation et de maintenance aboutit à `X.Y.(Z+1)`.

`nightly-dev` tague des release candidates pour la version vers laquelle le lot se dirige — `v2.20.1rc1`, `v2.20.1rc2`, … — et la fusion vers `main` promeut cette même cible en version finale. Les candidates sont de véritables préversions PEP 440, elles se classent donc correctement aux deux extrémités :

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

La cible peut changer en cours de cycle : le premier `feat` qui arrive la fait passer de `X.Y.(Z+1)` à `X.(Y+1).0`, et la numérotation des candidates redémarre pour la nouvelle cible. Le numéro indique toujours ce que le lot publierait aujourd'hui.

Le composant majeur n'est jamais incrémenté automatiquement — un sujet avec `!` ou un pied de page `BREAKING CHANGE:` compte comme une fonctionnalité, car une version majeure automatique n'est qu'à une ligne de sujet mal saisie d'une publication définitive irréversible. Une version majeure est un acte humain explicite : il faut créer le tag et le pousser à la main.

La politique se trouve dans `tools/next_version.py`, partagée par les deux workflows de tagging et testée unitairement dans `tests/test_next_version.py`.

La vérification au démarrage ne propose jamais que des releases, car les nightly ne publient aucune release GitHub et la vérification lit le point d'extrémité « latest release » de GitHub — donc activer `check_for_updates` ne vous fera jamais passer sur une nightly. Deux éléments distinguent désormais les canaux : ce fait, et le fait qu'une candidate est une véritable préversion PEP 440, de sorte qu'un outil qui classe les numéros de version bruts la considère également comme plus ancienne que la release qu'elle devient.

Chacune des deux options bascule d'abord votre checkout vers la branche correspondante (et refuse de le faire si vous avez des modifications non validées). Si vous utilisez une nightly et souhaitez revenir au code publié, `--update` vous ramène sur `main`.

#### Fusion automatique des hashs trouvés (téléchargement des restants uniquement)

Lors du téléchargement des hashs restants (hashs non craqués), hate_crack automatiquement :
1. Tente de télécharger les éventuels hashs trouvés (craqués) depuis Hashview en tant qu'opération auxiliaire
2. Fusionne les hashs trouvés avec les fichiers `.out` locaux (par exemple, `left_1_123.txt.out` ou `left_1_123.nt.txt.out` pour le format pwdump)
3. Supprime les entrées en double
4. Nettoie les fichiers temporaires fractionnés après la fusion

Cela garantit que vos résultats de craquage locaux restent synchronisés avec la base de données centralisée de Hashview lorsque vous travaillez avec des hashs non craqués.

**Remarque :** L'option download-found télécharge séparément les hashs déjà craqués à des fins de référence et n'effectue aucune fusion ni invite à lancer le craquage.

Le <hash_type> est obtenu en exécutant `hashcat --help`

Exemples de hashs : 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

## Testing

La suite de tests est principalement hors ligne et utilise des mocks/fixtures. Les vérifications réseau en direct et les contrôles de dépendances système sont optionnels via des variables d'environnement.

### Exécution des tests localement```bash
# Run all tests
uv run pytest -v

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

### Tests Hashview en direct contre une pile Docker locale

Au lieu de pointer les tests en direct vers un serveur Hashview distant, vous pouvez faire en sorte que la suite démarre une pile Docker [Hashview](https://github.com/hashview/hashview) locale, la peuple, exécute les tests en direct contre elle, puis la démonte. Définissez `HASHVIEW_TEST_LOCAL=1` et pointez `HASHVIEW_REPO` vers un checkout de 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

Installation/exécution de bout en bout basée sur Docker (mise en cache via `Dockerfile.test`) :```bash
HATE_CRACK_RUN_DOCKER_TESTS=1 uv run pytest tests/test_docker_script_install.py -v

La VM de test est provisionnée automatiquement avec toutes les dépendances 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

Quelle(s) règle(s) souhaitez-vous exécuter ?
(1) best64.rule
(2) d3ad0ne.rule
(3) T0XlC.rule
(4) dive.rule
(99) YOLO...exécuter toutes les règles
Saisissez la liste des règles que vous souhaitez exécuter, séparées par des virgules. Pour exécuter des règles enchaînées, utilisez le symbole +.
Par exemple, 1+1 exécutera best64.rule enchaînée deux fois et 1,2 exécutera best64.rule puis d3ad0ne.rule séquentiellement.
Choisissez judicieusement :```




#### 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).