diff --git a/.github/workflows/version-bump.yml b/.github/workflows/version-bump.yml new file mode 100644 index 0000000..c19ba22 --- /dev/null +++ b/.github/workflows/version-bump.yml @@ -0,0 +1,41 @@ +name: version-bump + +on: + pull_request: + types: [closed] + branches: [main] + +permissions: + contents: write + +jobs: + bump: + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Bump patch version + run: | + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + + latest=$(git tag --sort=-v:refname | grep -E '^v[0-9]+\.[0-9]+' | head -1) + if [ -z "$latest" ]; then + echo "No version tag found, starting at v0.0.1" + next="v0.0.1" + else + # Strip leading v + version="${latest#v}" + major=$(echo "$version" | cut -d. -f1) + minor=$(echo "$version" | cut -d. -f2) + patch=$(echo "$version" | cut -d. -f3) + patch=${patch:-0} + next="v${major}.${minor}.$((patch + 1))" + fi + + echo "Tagging $next (previous: ${latest:-none})" + git tag -a "$next" -m "Release $next" + git push origin "$next" diff --git a/Makefile b/Makefile index c1e2bf1..d848ced 100644 --- a/Makefile +++ b/Makefile @@ -60,15 +60,12 @@ install: submodules vendor-assets sudo apt-get install -y p7zip-full transmission-cli; \ else \ echo "Unsupported OS. Please install dependencies manually."; \ - $(MAKE) clean-vendor; \ exit 1; \ fi - @uv tool install . --force --reinstall - @$(MAKE) clean-vendor + @uv tool install -e . --force --reinstall update: submodules vendor-assets - @uv tool install . --force --reinstall - @$(MAKE) clean-vendor + @uv tool install -e . --force --reinstall reinstall: uninstall install diff --git a/README.md b/README.md index 45319f8..a939beb 100644 --- a/README.md +++ b/README.md @@ -323,6 +323,21 @@ Make it executable: chmod +x .git/hooks/pre-push ``` +### Optional Dependencies + +The optional `[ml]` group includes ML/AI features required for the PassGPT attack: +- **torch** - PyTorch deep learning framework (for PassGPT attack and training) +- **transformers** - HuggingFace transformers library (for GPT-2 models) +- **datasets** - HuggingFace datasets library (for fine-tuning support) +- **accelerate** - HuggingFace training acceleration library + +Install with: +```bash +uv pip install -e ".[ml]" +``` + +PassGPT (option 17) will be hidden from the menu if ML dependencies are not installed. + ### Dev Dependencies The optional `[dev]` group includes: @@ -428,6 +443,20 @@ The LLM Attack (option 15) uses Ollama to generate password candidates. Configur - **`ollamaNumCtx`** — Context window size for the model (default: `2048`). - The Ollama URL defaults to `http://localhost:11434`. Ensure Ollama is running before using the LLM Attack. +#### Automatic Update Checks + +hate_crack can automatically check GitHub for newer releases on startup. This feature is controlled by the `check_for_updates` config option: + +```json +{ + "check_for_updates": true +} +``` + +- **`check_for_updates`** — Enable automatic version checks on startup (default: `true`). +- When enabled, hate_crack fetches the latest release info from GitHub and displays a notice if an update is available. +- The check runs asynchronously and does not block startup. Network errors are silently ignored. + #### Automatic Found Hash Merging (Download Left Only) When downloading left hashes (uncracked hashes), hate_crack automatically: @@ -550,6 +579,7 @@ Tests automatically run on GitHub Actions for every push and pull request (Ubunt (14) Loopback Attack (15) LLM Attack (16) OMEN Attack + (17) PassGPT Attack (90) Download rules from Hashmob.net (91) Analyze Hashcat Rules @@ -694,6 +724,76 @@ Uses the Ordered Markov ENumerator (OMEN) to train a statistical password model * Pipes generated candidates directly into hashcat for cracking * Model files are stored in `~/.hate_crack/omen/` for persistence across sessions +#### PassGPT Attack +Uses PassGPT, a GPT-2 based password generator trained on leaked password datasets, to generate candidate passwords. PassGPT produces higher-quality candidates than traditional Markov models by leveraging transformer-based language modeling. You can use the default HuggingFace model or fine-tune a custom model on your own password wordlist. + +**Note:** This menu item is hidden unless ML dependencies are installed. + +**Requirements:** ML dependencies must be installed separately: +```bash +uv pip install -e ".[ml]" +``` + +This installs PyTorch and HuggingFace Transformers. GPU acceleration (CUDA/MPS) is auto-detected but not required. + +**Configuration keys:** +- `passgptModel` - HuggingFace model name (default: `javirandor/passgpt-10characters`) +- `passgptMaxCandidates` - Maximum candidates to generate (default: 1000000) +- `passgptBatchSize` - Generation batch size (default: 1024) +- `passgptTrainingList` - Default wordlist for fine-tuning (default: `rockyou.txt`) + +**Supported models:** +- `javirandor/passgpt-10characters` - Trained on passwords up to 10 characters (default) +- `javirandor/passgpt-16characters` - Trained on passwords up to 16 characters +- Any compatible GPT-2 model on HuggingFace +- Locally fine-tuned models (stored in `~/.hate_crack/passgpt/`) + +**Training a Custom Model:** +When you select the PassGPT Attack (option 17), the menu presents: +- List of available models (default HF model + any locally fine-tuned models) +- Option (T) to train a new model on a custom wordlist +- Fine-tuned models are automatically saved to `~/.hate_crack/passgpt//` for reuse + +To train a new model: +1. Select option (T) from the model selection menu +2. Choose a training wordlist (supports tab-complete file selection) +3. Optionally specify a base model (defaults to configured `passgptModel`) +4. Training will fine-tune the model on your wordlist and save it locally + +Fine-tuned models can be reused in future cracking sessions and appear in the model selection menu alongside the default models. + +**Apple Silicon (MPS) Performance Notes:** +- Batch size is automatically capped at 64 to prevent memory errors on MPS devices +- GPU memory watermark ratios are configured for stability (50% high, 30% low) +- Specify `--device cpu` to force CPU generation if MPS has issues + +**Standalone usage:** + +Generate candidates: +```bash +python -m hate_crack.passgpt_generate --num 1000 --model javirandor/passgpt-10characters +``` + +Fine-tune a custom model: +```bash +python -m hate_crack.passgpt_train --training-file wordlist.txt --output-dir ~/.hate_crack/passgpt/my_model +``` + +**Generator command-line options:** +- `--num` - Number of candidates to generate (default: 1000000) +- `--model` - HuggingFace model name or local path (default: javirandor/passgpt-10characters) +- `--batch-size` - Generation batch size (default: 1024) +- `--max-length` - Max token length including special tokens (default: 12) +- `--device` - Device: cuda, mps, or cpu (default: auto-detect) + +**Training command-line options:** +- `--training-file` - Path to password wordlist for fine-tuning (required) +- `--output-dir` - Directory to save the fine-tuned model (required) +- `--base-model` - Base HuggingFace model to fine-tune (default: javirandor/passgpt-10characters) +- `--epochs` - Number of training epochs (default: 3) +- `--batch-size` - Training batch size (default: 8) +- `--device` - Device: cuda, mps, or cpu (default: auto-detect) + #### Download Rules from Hashmob.net 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. @@ -726,13 +826,21 @@ Interactive menu for downloading and managing wordlists from Weakpass.com via Bi ------------------------------------------------------------------- ### Version History + Version 2.0+ - Added OMEN Attack (option 16) using statistical model-based password generation - Added OMEN configuration keys (omenTrainingList, omenMaxCandidates) - Added LLM Attack (option 15) using Ollama for AI-generated password candidates - Added Ollama configuration keys (ollamaModel, ollamaNumCtx) - Auto-versioning via setuptools-scm from git tags - CI test fixes across Python 3.9–3.14 + - Added automatic update checks on startup (check_for_updates config option) + - Added `packaging` dependency for version comparison + - Added PassGPT Attack (option 17) using GPT-2 based ML password generation + - Added PassGPT fine-tuning capability for custom password models + - Added PassGPT configuration keys (passgptModel, passgptMaxCandidates, passgptBatchSize, passgptTrainingList) + - Added `[ml]` optional dependency group for PyTorch, Transformers, and Datasets + - Added OMEN Attack (option 16) using statistical model-based password generation + - Added OMEN configuration keys (omenTrainingList, omenMaxCandidates) + - Added LLM Attack (option 15) using Ollama for AI-generated password candidates + - Added Ollama configuration keys (ollamaModel, ollamaNumCtx) + - Auto-versioning via setuptools-scm from git tags + - Automatic patch version bump (v2.0.1, v2.0.2, ...) on PR merge to main + - CI test fixes across Python 3.9-3.14 Version 2.0 Modularized codebase into CLI/API/attacks modules diff --git a/config.json.example b/config.json.example index 424e762..7c5e1f8 100644 --- a/config.json.example +++ b/config.json.example @@ -26,5 +26,10 @@ "ollamaModel": "mistral", "ollamaNumCtx": 2048, "omenTrainingList": "rockyou.txt", - "omenMaxCandidates": 1000000 + "omenMaxCandidates": 1000000, + "passgptModel": "javirandor/passgpt-10characters", + "passgptMaxCandidates": 1000000, + "passgptBatchSize": 1024, + "passgptTrainingList": "rockyou.txt", + "check_for_updates": true } diff --git a/hate_crack.py b/hate_crack.py index a73b440..d9fb181 100755 --- a/hate_crack.py +++ b/hate_crack.py @@ -95,6 +95,8 @@ def get_main_menu_options(): "98": show_readme, "99": quit_hc, } + if globals().get("HAS_ML_DEPS"): + options["17"] = _attacks.passgpt_attack # Only show Hashview API when configured. if globals().get("hashview_api_key"): options["94"] = hashview_api diff --git a/hate_crack/attacks.py b/hate_crack/attacks.py index b0c5c62..4acb2dd 100644 --- a/hate_crack/attacks.py +++ b/hate_crack/attacks.py @@ -510,7 +510,8 @@ def omen_attack(ctx: Any) -> None: print("\n\tOMEN binaries not found. Build them with:") print(f"\t cd {omen_dir} && make") return - model_exists = os.path.isfile(os.path.join(omen_dir, "IP.level")) + model_dir = os.path.join(os.path.expanduser("~"), ".hate_crack", "omen") + model_exists = os.path.isfile(os.path.join(model_dir, "createConfig")) if not model_exists: print("\n\tNo OMEN model found. Training is required before generation.") training_source = input( @@ -525,3 +526,88 @@ def omen_attack(ctx: Any) -> None: if not max_candidates: max_candidates = str(ctx.omenMaxCandidates) ctx.hcatOmen(ctx.hcatHashType, ctx.hcatHashFile, int(max_candidates)) + + +def passgpt_attack(ctx: Any) -> None: + print("\n\tPassGPT Attack (ML Password Generator)") + if not ctx.HAS_ML_DEPS: + print("\n\tPassGPT requires ML dependencies. Install them with:") + print('\t uv pip install -e ".[ml]"') + return + + # Build model choices: default HF model + any local fine-tuned models + default_model = ctx.passgptModel + models = [(default_model, f"{default_model} (default)")] + + model_dir = ctx._passgpt_model_dir() + if os.path.isdir(model_dir): + for entry in sorted(os.listdir(model_dir)): + entry_path = os.path.join(model_dir, entry) + if os.path.isdir(entry_path) and os.path.isfile( + os.path.join(entry_path, "config.json") + ): + models.append((entry_path, f"{entry} (local)")) + + print("\n\tSelect a model:") + for i, (_, label) in enumerate(models, 1): + print(f"\t ({i}) {label}") + print("\t (T) Train a new model") + + choice = input("\n\tChoice: ").strip() + + if choice.upper() == "T": + print("\n\tTrain a new PassGPT model") + print("\n\t--- Estimated Training Times (14M passwords, 3 epochs) ---") + print("\t CUDA (RTX 3090/4090): 1-3 hours") + print("\t MPS (Apple Silicon): 6-12 hours") + print("\t CPU: Very slow (not recommended)") + print("\t Use --max-lines to reduce training data for faster runs.") + training_file = ctx.select_file_with_autocomplete( + "Select training wordlist", base_dir=ctx.hcatWordlists + ) + if not training_file: + print("\n\tNo training file selected. Aborting.") + return + if isinstance(training_file, list): + training_file = training_file[0] + base = input(f"\n\tBase model ({default_model}): ").strip() + if not base: + base = default_model + + print("\n\tSelect training device:") + print("\t (1) cuda (Recommended)") + print("\t (2) mps (Apple Silicon)") + print("\t (3) cpu") + device_choice = input("\n\tDevice [1]: ").strip() + device_map = {"1": "cuda", "2": "mps", "3": "cpu", "": "cuda"} + device = device_map.get(device_choice, "cuda") + + result = ctx.hcatPassGPTTrain(training_file, base, device=device) + if result is None: + print("\n\tTraining failed. Returning to menu.") + return + model_name = result + else: + try: + idx = int(choice) - 1 + if 0 <= idx < len(models): + model_name = models[idx][0] + else: + print("\n\tInvalid selection.") + return + except ValueError: + print("\n\tInvalid selection.") + return + + max_candidates = input( + f"\n\tMax candidates to generate ({ctx.passgptMaxCandidates}): " + ).strip() + if not max_candidates: + max_candidates = str(ctx.passgptMaxCandidates) + ctx.hcatPassGPT( + ctx.hcatHashType, + ctx.hcatHashFile, + int(max_candidates), + model_name=model_name, + batch_size=ctx.passgptBatchSize, + ) diff --git a/hate_crack/config.json.example b/hate_crack/config.json.example index 48df46a..f3f03d7 100644 --- a/hate_crack/config.json.example +++ b/hate_crack/config.json.example @@ -22,5 +22,9 @@ "bandrel_common_basedwords": "welcome,password,p@ssword,p@$$word,changeme,letmein,summer,winter,spring,springtime,fall,autumn,monday,tuesday,wednesday,thursday,friday,saturday,sunday,january,february,march,april,may,june,july,august,september,october,november,december,christmas,easter,covid19", "hashview_url": "http://localhost:8443", "hashview_api_key": "", - "hashmob_api_key": "" + "hashmob_api_key": "", + "passgptModel": "javirandor/passgpt-10characters", + "passgptMaxCandidates": 1000000, + "passgptBatchSize": 1024, + "passgptTrainingList": "" } diff --git a/hate_crack/main.py b/hate_crack/main.py index cf23d04..cd61fa3 100755 --- a/hate_crack/main.py +++ b/hate_crack/main.py @@ -37,6 +37,15 @@ try: except Exception: pass +HAS_ML_DEPS = False +try: + import torch # noqa: F401 + import transformers # noqa: F401 + + HAS_ML_DEPS = True +except Exception: + pass + # Ensure project root is on sys.path so package imports work when loaded via spec. _root_dir = os.path.dirname(os.path.realpath(__file__)) if _root_dir not in sys.path: @@ -486,6 +495,51 @@ except KeyError as e: ) ) omenMaxCandidates = int(default_config.get("omenMaxCandidates", 1000000)) +try: + passgptModel = config_parser["passgptModel"] +except KeyError as e: + print( + "{0} is not defined in config.json using defaults from config.json.example".format( + e + ) + ) + passgptModel = default_config.get("passgptModel", "javirandor/passgpt-10characters") +try: + passgptMaxCandidates = int(config_parser["passgptMaxCandidates"]) +except KeyError as e: + print( + "{0} is not defined in config.json using defaults from config.json.example".format( + e + ) + ) + passgptMaxCandidates = int(default_config.get("passgptMaxCandidates", 1000000)) +try: + passgptBatchSize = int(config_parser["passgptBatchSize"]) +except KeyError as e: + print( + "{0} is not defined in config.json using defaults from config.json.example".format( + e + ) + ) + passgptBatchSize = int(default_config.get("passgptBatchSize", 1024)) +try: + passgptTrainingList = config_parser["passgptTrainingList"] +except KeyError as e: + print( + "{0} is not defined in config.json using defaults from config.json.example".format( + e + ) + ) + passgptTrainingList = default_config.get("passgptTrainingList", "rockyou.txt") +try: + check_for_updates_enabled = config_parser["check_for_updates"] +except KeyError as e: + print( + "{0} is not defined in config.json using defaults from config.json.example".format( + e + ) + ) + check_for_updates_enabled = default_config.get("check_for_updates", True) hcatExpanderBin = "expander.bin" hcatCombinatorBin = "combinator.bin" @@ -628,6 +682,7 @@ hcatGoodMeasureBaseList = _normalize_wordlist_setting( ) hcatPrinceBaseList = _normalize_wordlist_setting(hcatPrinceBaseList, wordlists_dir) omenTrainingList = _normalize_wordlist_setting(omenTrainingList, wordlists_dir) +passgptTrainingList = _normalize_wordlist_setting(passgptTrainingList, wordlists_dir) if not SKIP_INIT: # Verify hashcat binary is available # hcatBin should be in PATH or be an absolute path (resolved from hcatPath + hcatBin if configured) @@ -823,6 +878,35 @@ def ascii_art(): ) +def check_for_updates(): + """Check GitHub for a newer release and print a notice if one exists.""" + try: + from hate_crack import __version__ + + if not REQUESTS_AVAILABLE: + return + resp = requests.get( + "https://api.github.com/repos/trustedsec/hate_crack/releases/latest", + timeout=5, + ) + resp.raise_for_status() + tag = resp.json().get("tag_name", "") + latest = tag.lstrip("v") + # Compare base version (before any +g... suffix) against remote tag + local_base = __version__.split("+")[0] + if not latest or not local_base: + return + from packaging.version import parse + + if parse(latest) > parse(local_base): + print( + f"\n Update available: {latest} (current: {local_base})." + f"\n See https://github.com/trustedsec/hate_crack/releases\n" + ) + except Exception: + pass + + # File selector with tab autocomplete def select_file_with_autocomplete( prompt, default=None, allow_multiple=False, base_dir=None @@ -2111,6 +2195,15 @@ def hcatPrince(hcatHashType, hcatHashFile): prince_proc.kill() +# OMEN model directory - writable location for trained model files. +# The binaries live in {hate_path}/omen/ (possibly read-only after install), +# but model output (createConfig, *.level) goes to ~/.hate_crack/omen/. +def _omen_model_dir(): + model_dir = os.path.join(os.path.expanduser("~"), ".hate_crack", "omen") + os.makedirs(model_dir, exist_ok=True) + return model_dir + + # OMEN Attack - Train model def hcatOmenTrain(training_file): omen_dir = os.path.join(hate_path, "omen") @@ -2118,13 +2211,30 @@ def hcatOmenTrain(training_file): if not os.path.isfile(create_bin): print(f"Error: OMEN createNG binary not found: {create_bin}") return + training_file = os.path.abspath(training_file) if not os.path.isfile(training_file): print(f"Error: Training file not found: {training_file}") return + model_dir = _omen_model_dir() print(f"Training OMEN model with: {training_file}") - cmd = [create_bin, "--iPwdList", training_file] + print(f"Model output directory: {model_dir}") + cmd = [ + create_bin, + "--iPwdList", + training_file, + "-C", + os.path.join(model_dir, "createConfig"), + "-c", + os.path.join(model_dir, "CP"), + "-i", + os.path.join(model_dir, "IP"), + "-e", + os.path.join(model_dir, "EP"), + "-l", + os.path.join(model_dir, "LN"), + ] print(f"[*] Running: {_format_cmd(cmd)}") - proc = subprocess.Popen(cmd, cwd=omen_dir) + proc = subprocess.Popen(cmd) try: proc.wait() except KeyboardInterrupt: @@ -2145,7 +2255,13 @@ def hcatOmen(hcatHashType, hcatHashFile, max_candidates): if not os.path.isfile(enum_bin): print(f"Error: OMEN enumNG binary not found: {enum_bin}") return - enum_cmd = [enum_bin, "-p", "-m", str(max_candidates)] + model_dir = _omen_model_dir() + config_path = os.path.join(model_dir, "createConfig") + if not os.path.isfile(config_path): + print(f"Error: OMEN model not found at {config_path}") + print("Run training first (option 16).") + return + enum_cmd = [enum_bin, "-p", "-m", str(max_candidates), "-C", config_path] hashcat_cmd = [ hcatBin, "-m", @@ -2160,7 +2276,7 @@ def hcatOmen(hcatHashType, hcatHashFile, max_candidates): _append_potfile_arg(hashcat_cmd) print(f"[*] Running: {_format_cmd(enum_cmd)} | {_format_cmd(hashcat_cmd)}") _debug_cmd(hashcat_cmd) - enum_proc = subprocess.Popen(enum_cmd, cwd=omen_dir, stdout=subprocess.PIPE) + enum_proc = subprocess.Popen(enum_cmd, cwd=model_dir, stdout=subprocess.PIPE) hcatProcess = subprocess.Popen(hashcat_cmd, stdin=enum_proc.stdout) enum_proc.stdout.close() try: @@ -2172,6 +2288,107 @@ def hcatOmen(hcatHashType, hcatHashFile, max_candidates): enum_proc.kill() +# PassGPT model directory - writable location for fine-tuned models. +# Models are saved to ~/.hate_crack/passgpt//. +def _passgpt_model_dir(): + model_dir = os.path.join(os.path.expanduser("~"), ".hate_crack", "passgpt") + os.makedirs(model_dir, exist_ok=True) + return model_dir + + +# PassGPT Attack - Fine-tune a model on a custom wordlist +def hcatPassGPTTrain(training_file, base_model=None, device=None): + training_file = os.path.abspath(training_file) + if not os.path.isfile(training_file): + print(f"Error: Training file not found: {training_file}") + return None + if base_model is None: + base_model = passgptModel + # Derive output dir name from training file + basename = os.path.splitext(os.path.basename(training_file))[0] + # Sanitize: replace non-alphanumeric chars with underscores + sanitized = "".join(c if c.isalnum() or c in "-_" else "_" for c in basename) + output_dir = os.path.join(_passgpt_model_dir(), sanitized) + os.makedirs(output_dir, exist_ok=True) + cmd = [ + sys.executable, + "-m", + "hate_crack.passgpt_train", + "--training-file", + training_file, + "--base-model", + base_model, + "--output-dir", + output_dir, + ] + if device: + cmd.extend(["--device", device]) + print(f"[*] Running: {_format_cmd(cmd)}") + proc = subprocess.Popen(cmd) + try: + proc.wait() + except KeyboardInterrupt: + print("Killing PID {0}...".format(str(proc.pid))) + proc.kill() + return None + if proc.returncode == 0: + print(f"PassGPT model training complete. Model saved to: {output_dir}") + return output_dir + else: + print(f"PassGPT training failed with exit code {proc.returncode}") + return None + + +# PassGPT Attack - Generate candidates with ML model and pipe to hashcat +def hcatPassGPT( + hcatHashType, + hcatHashFile, + max_candidates, + model_name=None, + batch_size=None, +): + global hcatProcess + if model_name is None: + model_name = passgptModel + if batch_size is None: + batch_size = passgptBatchSize + gen_cmd = [ + sys.executable, + "-m", + "hate_crack.passgpt_generate", + "--num", + str(max_candidates), + "--model", + model_name, + "--batch-size", + str(batch_size), + ] + hashcat_cmd = [ + hcatBin, + "-m", + hcatHashType, + hcatHashFile, + "--session", + generate_session_id(), + "-o", + f"{hcatHashFile}.out", + ] + hashcat_cmd.extend(shlex.split(hcatTuning)) + _append_potfile_arg(hashcat_cmd) + print(f"[*] Running: {_format_cmd(gen_cmd)} | {_format_cmd(hashcat_cmd)}") + _debug_cmd(hashcat_cmd) + gen_proc = subprocess.Popen(gen_cmd, stdout=subprocess.PIPE) + hcatProcess = subprocess.Popen(hashcat_cmd, stdin=gen_proc.stdout) + gen_proc.stdout.close() + try: + hcatProcess.wait() + gen_proc.wait() + except KeyboardInterrupt: + print("Killing PID {0}...".format(str(hcatProcess.pid))) + hcatProcess.kill() + gen_proc.kill() + + # Extra - Good Measure def hcatGoodMeasure(hcatHashType, hcatHashFile): global hcatExtraCount @@ -3091,6 +3308,10 @@ def omen_attack(): return _attacks.omen_attack(_attack_ctx()) +def passgpt_attack(): + return _attacks.passgpt_attack(_attack_ctx()) + + # convert hex words for recycling def convert_hex(working_file): processed_words = [] @@ -3330,6 +3551,8 @@ def get_main_menu_options(): "98": show_readme, "99": quit_hc, } + if HAS_ML_DEPS: + options["17"] = passgpt_attack # Only show this when Hashview API is configured (requested behavior). if hashview_api_key: options["94"] = hashview_api @@ -3730,6 +3953,8 @@ def main(): sys.exit(1) else: ascii_art() + if not SKIP_INIT and check_for_updates_enabled: + check_for_updates() menu_loop = True while menu_loop: print("\n" + "=" * 60) @@ -3786,6 +4011,8 @@ def main(): if not hcatHashFileOrig: hcatHashFileOrig = hcatHashFile ascii_art() + if not SKIP_INIT and check_for_updates_enabled: + check_for_updates() # Get Initial Input Hash Count # If LM or NT Mode Selected and pwdump Format Detected, Prompt For LM to NT Attack @@ -3973,6 +4200,8 @@ def main(): print("\t(14) Loopback Attack") print("\t(15) LLM Attack") print("\t(16) OMEN Attack") + if HAS_ML_DEPS: + print("\t(17) PassGPT Attack") print("\n\t(90) Download rules from Hashmob.net") print("\n\t(91) Analyze Hashcat Rules") print("\t(92) Download wordlists from Hashmob.net") diff --git a/hate_crack/passgpt_generate.py b/hate_crack/passgpt_generate.py new file mode 100644 index 0000000..d23f519 --- /dev/null +++ b/hate_crack/passgpt_generate.py @@ -0,0 +1,156 @@ +"""Standalone PassGPT password candidate generator. + +Invokable as ``python -m hate_crack.passgpt_generate``. Outputs one +candidate password per line to stdout so it can be piped directly into +hashcat. Progress and diagnostic messages go to stderr. +""" + +from __future__ import annotations + +import argparse +import os +import sys + +# Disable HuggingFace telemetry before any HF imports +os.environ["HF_HUB_DISABLE_TELEMETRY"] = "1" + + +_MPS_BATCH_SIZE_CAP = 64 + + +def _detect_device() -> str: + import torch + + if torch.cuda.is_available(): + return "cuda" + if hasattr(torch.backends, "mps") and torch.backends.mps.is_available(): + return "mps" + return "cpu" + + +def _configure_mps() -> None: + """Set MPS memory limits before torch is imported.""" + import os + + os.environ.setdefault("PYTORCH_MPS_HIGH_WATERMARK_RATIO", "0.5") + os.environ.setdefault("PYTORCH_MPS_LOW_WATERMARK_RATIO", "0.3") + + +def generate( + num: int, + model_name: str, + batch_size: int, + max_length: int, + device: str | None, +) -> None: + # If MPS is requested (or will be auto-detected), set memory limit before importing torch + if device == "mps" or device is None: + _configure_mps() + + import torch + from transformers import GPT2LMHeadModel # type: ignore[attr-defined] + from transformers import RobertaTokenizerFast # type: ignore[attr-defined] + + if device is None: + device = _detect_device() + + if device == "mps" and batch_size > _MPS_BATCH_SIZE_CAP: + print( + f"[*] Capping batch size from {batch_size} to {_MPS_BATCH_SIZE_CAP} for MPS", + file=sys.stderr, + ) + batch_size = _MPS_BATCH_SIZE_CAP + + print(f"[*] Loading model {model_name} on {device}", file=sys.stderr) + tokenizer = RobertaTokenizerFast.from_pretrained(model_name) + model = GPT2LMHeadModel.from_pretrained(model_name).to(device) # type: ignore[arg-type] + model.eval() + + generated = 0 + seen: set[str] = set() + + print(f"[*] Generating {num} candidates (batch_size={batch_size})", file=sys.stderr) + with torch.no_grad(): + while generated < num: + current_batch = min(batch_size, num - generated) + input_ids = torch.full( + (current_batch, 1), + tokenizer.bos_token_id, + dtype=torch.long, + device=device, + ) + output = model.generate( + input_ids, + max_length=max_length, + do_sample=True, + top_k=0, + top_p=1.0, + num_return_sequences=current_batch, + pad_token_id=tokenizer.eos_token_id, + ) + # Strip BOS token + output = output[:, 1:] + for seq in output: + token_strs = [tokenizer.decode([t]) for t in seq] + password = "" + for t in token_strs: + if t in (tokenizer.eos_token, tokenizer.pad_token): + break + password += t.replace(" ", "") + if password and password not in seen: + seen.add(password) + sys.stdout.write(password + "\n") + generated += 1 + if generated >= num: + break + + sys.stdout.flush() + print(f"[*] Done. Generated {generated} unique candidates.", file=sys.stderr) + + +def main() -> None: + parser = argparse.ArgumentParser( + description="Generate password candidates using PassGPT" + ) + parser.add_argument( + "--num", + type=int, + default=1000000, + help="Number of candidates to generate (default: 1000000)", + ) + parser.add_argument( + "--model", + type=str, + default="javirandor/passgpt-10characters", + help="HuggingFace model name (default: javirandor/passgpt-10characters)", + ) + parser.add_argument( + "--batch-size", + type=int, + default=1024, + help="Generation batch size (default: 1024)", + ) + parser.add_argument( + "--max-length", + type=int, + default=12, + help="Max token length including special tokens (default: 12)", + ) + parser.add_argument( + "--device", + type=str, + default=None, + help="Device: cuda, mps, or cpu (default: auto-detect)", + ) + args = parser.parse_args() + generate( + num=args.num, + model_name=args.model, + batch_size=args.batch_size, + max_length=args.max_length, + device=args.device, + ) + + +if __name__ == "__main__": + main() diff --git a/hate_crack/passgpt_train.py b/hate_crack/passgpt_train.py new file mode 100644 index 0000000..8892484 --- /dev/null +++ b/hate_crack/passgpt_train.py @@ -0,0 +1,329 @@ +"""Fine-tune a PassGPT model on a custom password wordlist. + +Invokable as ``python -m hate_crack.passgpt_train``. Progress and +diagnostic messages go to stderr. +""" + +from __future__ import annotations + +import argparse +import os +import subprocess +import sys + + +# Disable HuggingFace telemetry before any HF imports +os.environ["HF_HUB_DISABLE_TELEMETRY"] = "1" + + +def _detect_device() -> str: + import torch + + if torch.cuda.is_available(): + return "cuda" + if hasattr(torch.backends, "mps") and torch.backends.mps.is_available(): + return "mps" + return "cpu" + + +def _configure_mps() -> None: + """Set MPS memory limits before torch is imported.""" + os.environ.setdefault("PYTORCH_MPS_HIGH_WATERMARK_RATIO", "0.5") + os.environ.setdefault("PYTORCH_MPS_LOW_WATERMARK_RATIO", "0.3") + + +def _get_available_memory_mb() -> int | None: + """Return available system RAM in MB, or None if detection fails.""" + try: + if sys.platform == "linux": + with open("/proc/meminfo") as f: + for line in f: + if line.startswith("MemAvailable:"): + return int(line.split()[1]) // 1024 + return None + elif sys.platform == "darwin": + # macOS: try os.sysconf first, fall back to sysctl + try: + page_size = os.sysconf("SC_PAGE_SIZE") + avail_pages = os.sysconf("SC_AVPHYS_PAGES") + if page_size > 0 and avail_pages > 0: + return (page_size * avail_pages) // (1024 * 1024) + except (ValueError, OSError): + pass + # Fallback: use sysctl for total memory (not available, but better than nothing) + try: + result = subprocess.run( + ["sysctl", "-n", "hw.memsize"], + capture_output=True, + text=True, + timeout=5, + ) + if result.returncode == 0: + return int(result.stdout.strip()) // (1024 * 1024) + except (subprocess.TimeoutExpired, FileNotFoundError, ValueError): + pass + return None + else: + return None + except Exception: + return None + + +def _count_lines(filepath: str) -> int: + """Count non-empty lines in a file without loading it into memory.""" + count = 0 + with open(filepath, encoding="utf-8", errors="replace") as f: + for line in f: + if line.strip(): + count += 1 + return count + + +def _estimate_training_memory_mb( + training_file: str, max_length: int = 16, max_lines: int = 0 +) -> int: + """Estimate peak memory usage in MB for training on the given file. + + Components: + - Model: ~500MB (GPT-2 small) + - Optimizer states: ~1000MB (2x model for AdamW momentum/variance) + - Dataset offset index: ~8 bytes per line + - Per-batch activations and tokenization buffer: ~200MB + """ + num_lines = _count_lines(training_file) + if max_lines > 0: + num_lines = min(num_lines, max_lines) + + model_mb = 500 + optimizer_mb = 1000 + # Offset index: 8 bytes per line (Python int in list) + index_mb = (num_lines * 8) // (1024 * 1024) + # Activation/buffer overhead + buffer_mb = 200 + + return model_mb + optimizer_mb + index_mb + buffer_mb + + +def train( + training_file: str, + output_dir: str, + base_model: str, + epochs: int, + batch_size: int, + device: str | None, + max_lines: int = 0, + memory_limit: int = 0, +) -> None: + # --- Memory pre-check --- + if memory_limit > 0: + # Auto-tune max_lines to fit within memory_limit + estimated_base = _estimate_training_memory_mb(training_file, max_lines=1) + per_line_bytes = 8 # offset index cost per line + available_for_data = (memory_limit - estimated_base) * 1024 * 1024 + if available_for_data > 0: + auto_max_lines = available_for_data // per_line_bytes + if max_lines == 0 or auto_max_lines < max_lines: + max_lines = max(1, int(auto_max_lines)) + print( + f"[*] --memory-limit {memory_limit}MB: auto-set --max-lines to {max_lines}", + file=sys.stderr, + ) + else: + print( + f"[!] --memory-limit {memory_limit}MB is too low for model overhead alone.", + file=sys.stderr, + ) + sys.exit(1) + + estimated = _estimate_training_memory_mb(training_file, max_lines=max_lines) + available = _get_available_memory_mb() + if available is not None and estimated > available: + print( + f"[!] Estimated memory usage ({estimated}MB) exceeds available RAM ({available}MB).", + file=sys.stderr, + ) + print( + "[!] Use --max-lines to limit wordlist size or --memory-limit to auto-tune.", + file=sys.stderr, + ) + sys.exit(1) + + if device == "mps" or device is None: + _configure_mps() + + import torch + from transformers import ( # type: ignore[attr-defined] + GPT2LMHeadModel, + RobertaTokenizerFast, + Trainer, + TrainingArguments, + ) + + if device is None: + device = _detect_device() + + print(f"[*] Loading base model {base_model} on {device}", file=sys.stderr) + tokenizer = RobertaTokenizerFast.from_pretrained(base_model) + model = GPT2LMHeadModel.from_pretrained(base_model).to(device) # type: ignore[arg-type] + + max_length = ( + model.config.n_positions if hasattr(model.config, "n_positions") else 16 + ) + + # Enable gradient checkpointing to reduce activation memory + model.gradient_checkpointing_enable() + + print(f"[*] Indexing training file: {training_file}", file=sys.stderr) + + class LazyPasswordDataset(torch.utils.data.Dataset): # type: ignore[type-arg] + """Dataset that indexes file byte offsets and tokenizes on-the-fly.""" + + def __init__( + self, + filepath: str, + tokenizer: object, + max_length: int, + max_lines: int = 0, + ): + self.filepath = filepath + self.tokenizer = tokenizer + self.max_length = max_length + self.offsets: list[int] = [] + with open(filepath, "rb") as f: + while True: + offset = f.tell() + line = f.readline() + if not line: + break + if line.strip(): + self.offsets.append(offset) + if max_lines > 0 and len(self.offsets) >= max_lines: + break + + def __len__(self) -> int: + return len(self.offsets) + + def __getitem__(self, idx: int) -> dict[str, object]: + with open(self.filepath, "rb") as f: + f.seek(self.offsets[idx]) + line = f.readline().decode("utf-8", errors="replace").strip() + enc = self.tokenizer( # type: ignore[operator] + line, + truncation=True, + padding="max_length", + max_length=self.max_length, + return_tensors="pt", + ) + input_ids = enc["input_ids"].squeeze(0) + attention_mask = enc["attention_mask"].squeeze(0) + return { + "input_ids": input_ids, + "attention_mask": attention_mask, + "labels": input_ids, + } + + dataset = LazyPasswordDataset(training_file, tokenizer, max_length, max_lines) + print(f"[*] Indexed {len(dataset)} passwords", file=sys.stderr) + + # Use CPU for training args if device is MPS (Trainer handles device placement) + use_cpu = device not in ("cuda",) + use_fp16 = device == "cuda" + training_args = TrainingArguments( + output_dir=output_dir, + num_train_epochs=epochs, + per_device_train_batch_size=batch_size, + save_strategy="epoch", + logging_steps=100, + use_cpu=use_cpu, + report_to="none", + push_to_hub=False, + gradient_accumulation_steps=4, + fp16=use_fp16, + gradient_checkpointing=True, + ) + + trainer = Trainer( + model=model, + args=training_args, + train_dataset=dataset, + ) + + print( + f"[*] Starting training: {epochs} epochs, batch_size={batch_size}, device={device}", + file=sys.stderr, + ) + trainer.train() + + print(f"[*] Saving model to {output_dir}", file=sys.stderr) + model.save_pretrained(output_dir) + tokenizer.save_pretrained(output_dir) + print("[*] Training complete.", file=sys.stderr) + + +def main() -> None: + parser = argparse.ArgumentParser( + description="Fine-tune a PassGPT model on a password wordlist" + ) + parser.add_argument( + "--training-file", + type=str, + required=True, + help="Path to the password wordlist for training", + ) + parser.add_argument( + "--base-model", + type=str, + default="javirandor/passgpt-10characters", + help="Base HuggingFace model to fine-tune (default: javirandor/passgpt-10characters)", + ) + parser.add_argument( + "--output-dir", + type=str, + required=True, + help="Directory to save the fine-tuned model", + ) + parser.add_argument( + "--epochs", + type=int, + default=3, + help="Number of training epochs (default: 3)", + ) + parser.add_argument( + "--batch-size", + type=int, + default=8, + help="Training batch size (default: 8)", + ) + parser.add_argument( + "--device", + type=str, + default=None, + help="Device: cuda, mps, or cpu (default: auto-detect)", + ) + parser.add_argument( + "--max-lines", + type=int, + default=0, + help="Limit training to the first N lines of the wordlist (default: 0, no limit)", + ) + parser.add_argument( + "--memory-limit", + type=int, + default=0, + help="Memory cap in MB; auto-tunes --max-lines to fit (default: 0, no limit)", + ) + args = parser.parse_args() + train( + training_file=args.training_file, + output_dir=args.output_dir, + base_model=args.base_model, + epochs=args.epochs, + batch_size=args.batch_size, + device=args.device, + max_lines=args.max_lines, + memory_limit=args.memory_limit, + ) + + +if __name__ == "__main__": + main() diff --git a/pyproject.toml b/pyproject.toml index d6530ee..63185be 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,12 +12,19 @@ dependencies = [ "requests>=2.31.0", "beautifulsoup4>=4.12.0", "openpyxl>=3.0.0", + "packaging>=21.0", ] [project.scripts] hate_crack = "hate_crack.__main__:main" [project.optional-dependencies] +ml = [ + "torch>=2.0.0", + "transformers>=4.30.0", + "datasets>=2.14.0", + "accelerate>=1.1.0", +] dev = [ "mypy>=1.8.0", "ruff>=0.3.0", diff --git a/tests/test_omen_attack.py b/tests/test_omen_attack.py index cd8ae12..84bc412 100644 --- a/tests/test_omen_attack.py +++ b/tests/test_omen_attack.py @@ -19,10 +19,16 @@ class TestHcatOmenTrain: create_bin = omen_dir / "createNG" create_bin.touch() create_bin.chmod(0o755) + model_dir = tmp_path / "model" + model_dir.mkdir() with patch.object(main_module, "hate_path", str(tmp_path)), patch.object( main_module, "hcatOmenCreateBin", "createNG" - ), patch("hate_crack.main.subprocess.Popen") as mock_popen: + ), patch( + "hate_crack.main._omen_model_dir", return_value=str(model_dir) + ), patch( + "hate_crack.main.subprocess.Popen" + ) as mock_popen: mock_proc = MagicMock() mock_proc.wait.return_value = None mock_proc.returncode = 0 @@ -35,6 +41,17 @@ class TestHcatOmenTrain: assert cmd[0] == str(create_bin) assert "--iPwdList" in cmd assert str(training_file) in cmd + # Verify explicit output paths are passed + assert "-C" in cmd + assert str(model_dir / "createConfig") in cmd + assert "-c" in cmd + assert str(model_dir / "CP") in cmd + assert "-i" in cmd + assert str(model_dir / "IP") in cmd + assert "-e" in cmd + assert str(model_dir / "EP") in cmd + assert "-l" in cmd + assert str(model_dir / "LN") in cmd def test_missing_binary(self, main_module, tmp_path, capsys): training_file = tmp_path / "passwords.txt" @@ -52,10 +69,12 @@ class TestHcatOmenTrain: omen_dir.mkdir() create_bin = omen_dir / "createNG" create_bin.touch() + model_dir = tmp_path / "model" + model_dir.mkdir() with patch.object(main_module, "hate_path", str(tmp_path)), patch.object( main_module, "hcatOmenCreateBin", "createNG" - ): + ), patch("hate_crack.main._omen_model_dir", return_value=str(model_dir)): main_module.hcatOmenTrain("/nonexistent/file.txt") captured = capsys.readouterr() assert "Training file not found" in captured.out @@ -68,6 +87,9 @@ class TestHcatOmen: enum_bin = omen_dir / "enumNG" enum_bin.touch() enum_bin.chmod(0o755) + model_dir = tmp_path / "model" + model_dir.mkdir() + (model_dir / "createConfig").write_text("# test config\n") with patch.object(main_module, "hate_path", str(tmp_path)), patch.object( main_module, "hcatOmenEnumBin", "enumNG" @@ -77,6 +99,8 @@ class TestHcatOmen: main_module, "hcatPotfilePath", "" ), patch.object( main_module, "hcatHashFile", "/tmp/hashes.txt", create=True + ), patch( + "hate_crack.main._omen_model_dir", return_value=str(model_dir) ), patch( "hate_crack.main.subprocess.Popen" ) as mock_popen: @@ -96,6 +120,10 @@ class TestHcatOmen: assert "-p" in enum_cmd assert "-m" in enum_cmd assert "500000" in enum_cmd + assert "-C" in enum_cmd + assert str(model_dir / "createConfig") in enum_cmd + # cwd should be model_dir + assert mock_popen.call_args_list[0][1]["cwd"] == str(model_dir) # Second call: hashcat hashcat_cmd = mock_popen.call_args_list[1][0][0] assert hashcat_cmd[0] == "hashcat" @@ -110,6 +138,23 @@ class TestHcatOmen: captured = capsys.readouterr() assert "enumNG binary not found" in captured.out + def test_missing_model(self, main_module, tmp_path, capsys): + omen_dir = tmp_path / "omen" + omen_dir.mkdir() + enum_bin = omen_dir / "enumNG" + enum_bin.touch() + enum_bin.chmod(0o755) + model_dir = tmp_path / "model" + model_dir.mkdir() + # No createConfig in model_dir + + with patch.object(main_module, "hate_path", str(tmp_path)), patch.object( + main_module, "hcatOmenEnumBin", "enumNG" + ), patch("hate_crack.main._omen_model_dir", return_value=str(model_dir)): + main_module.hcatOmen("1000", "/tmp/hashes.txt", 500000) + captured = capsys.readouterr() + assert "OMEN model not found" in captured.out + class TestOmenAttackHandler: def test_prompts_and_calls_hcatOmen(self): @@ -120,9 +165,13 @@ class TestOmenAttackHandler: ctx.hcatHashType = "1000" ctx.hcatHashFile = "/tmp/hashes.txt" - with patch("os.path.isfile", return_value=True), patch( - "builtins.input", return_value="" - ): + def fake_isfile(path): + # Binaries exist, model exists + return True + + with patch("os.path.isfile", side_effect=fake_isfile), patch( + "os.path.expanduser", return_value="/fake/home" + ), patch("builtins.input", return_value=""): from hate_crack.attacks import omen_attack omen_attack(ctx) @@ -138,11 +187,12 @@ class TestOmenAttackHandler: ctx.hcatHashFile = "/tmp/hashes.txt" def fake_isfile(path): - return "IP.level" not in path + # Binaries exist, but createConfig does not + return "createConfig" not in path with patch("os.path.isfile", side_effect=fake_isfile), patch( - "builtins.input", return_value="" - ): + "os.path.expanduser", return_value="/fake/home" + ), patch("builtins.input", return_value=""): from hate_crack.attacks import omen_attack omen_attack(ctx) diff --git a/tests/test_passgpt_attack.py b/tests/test_passgpt_attack.py new file mode 100644 index 0000000..58d532d --- /dev/null +++ b/tests/test_passgpt_attack.py @@ -0,0 +1,519 @@ +import importlib.util +import os +import sys +from unittest.mock import MagicMock, patch + +import pytest + +_has_transformers = importlib.util.find_spec("transformers") is not None + +from hate_crack.passgpt_train import ( + _count_lines, + _estimate_training_memory_mb, + _get_available_memory_mb, +) + + +@pytest.fixture +def main_module(hc_module): + """Return the underlying hate_crack.main module for direct patching.""" + return hc_module._main + + +class TestHcatPassGPT: + def test_builds_correct_pipe_commands(self, main_module): + with ( + patch.object(main_module, "hcatBin", "hashcat"), + patch.object(main_module, "hcatTuning", "--force"), + patch.object(main_module, "hcatPotfilePath", ""), + patch.object(main_module, "hcatHashFile", "/tmp/hashes.txt", create=True), + patch.object( + main_module, "passgptModel", "javirandor/passgpt-10characters" + ), + patch.object(main_module, "passgptBatchSize", 1024), + patch("hate_crack.main.subprocess.Popen") as mock_popen, + ): + mock_gen_proc = MagicMock() + mock_gen_proc.stdout = MagicMock() + mock_hashcat_proc = MagicMock() + mock_hashcat_proc.wait.return_value = None + mock_gen_proc.wait.return_value = None + mock_popen.side_effect = [mock_gen_proc, mock_hashcat_proc] + + main_module.hcatPassGPT("1000", "/tmp/hashes.txt", 500000) + + assert mock_popen.call_count == 2 + # First call: passgpt generator + gen_cmd = mock_popen.call_args_list[0][0][0] + assert gen_cmd[0] == sys.executable + assert "-m" in gen_cmd + assert "hate_crack.passgpt_generate" in gen_cmd + assert "--num" in gen_cmd + assert "500000" in gen_cmd + assert "--model" in gen_cmd + assert "javirandor/passgpt-10characters" in gen_cmd + assert "--batch-size" in gen_cmd + assert "1024" in gen_cmd + # Second call: hashcat + hashcat_cmd = mock_popen.call_args_list[1][0][0] + assert hashcat_cmd[0] == "hashcat" + assert "1000" in hashcat_cmd + assert "/tmp/hashes.txt" in hashcat_cmd + + def test_custom_model_and_batch_size(self, main_module): + with ( + patch.object(main_module, "hcatBin", "hashcat"), + patch.object(main_module, "hcatTuning", "--force"), + patch.object(main_module, "hcatPotfilePath", ""), + patch.object(main_module, "hcatHashFile", "/tmp/hashes.txt", create=True), + patch.object( + main_module, "passgptModel", "javirandor/passgpt-10characters" + ), + patch.object(main_module, "passgptBatchSize", 1024), + patch("hate_crack.main.subprocess.Popen") as mock_popen, + ): + mock_gen_proc = MagicMock() + mock_gen_proc.stdout = MagicMock() + mock_hashcat_proc = MagicMock() + mock_hashcat_proc.wait.return_value = None + mock_gen_proc.wait.return_value = None + mock_popen.side_effect = [mock_gen_proc, mock_hashcat_proc] + + main_module.hcatPassGPT( + "1000", + "/tmp/hashes.txt", + 100000, + model_name="custom/model", + batch_size=512, + ) + + gen_cmd = mock_popen.call_args_list[0][0][0] + assert "custom/model" in gen_cmd + assert "512" in gen_cmd + + +class TestHcatPassGPTTrain: + def test_builds_correct_subprocess_command(self, main_module, tmp_path): + training_file = tmp_path / "wordlist.txt" + training_file.write_text("password123\nabc456\n") + + with ( + patch.object( + main_module, "passgptModel", "javirandor/passgpt-10characters" + ), + patch("hate_crack.main.subprocess.Popen") as mock_popen, + ): + mock_proc = MagicMock() + mock_proc.returncode = 0 + mock_proc.wait.return_value = None + mock_popen.return_value = mock_proc + + with patch.object( + main_module, + "_passgpt_model_dir", + return_value=str(tmp_path / "models"), + ): + result = main_module.hcatPassGPTTrain(str(training_file)) + + assert result is not None + assert mock_popen.call_count == 1 + cmd = mock_popen.call_args[0][0] + assert cmd[0] == sys.executable + assert "-m" in cmd + assert "hate_crack.passgpt_train" in cmd + assert "--training-file" in cmd + assert str(training_file) in cmd + assert "--base-model" in cmd + assert "javirandor/passgpt-10characters" in cmd + assert "--output-dir" in cmd + + def test_missing_training_file(self, main_module, capsys): + result = main_module.hcatPassGPTTrain("/nonexistent/wordlist.txt") + assert result is None + captured = capsys.readouterr() + assert "Training file not found" in captured.out + + def test_custom_base_model(self, main_module, tmp_path): + training_file = tmp_path / "wordlist.txt" + training_file.write_text("test\n") + + with patch("hate_crack.main.subprocess.Popen") as mock_popen: + mock_proc = MagicMock() + mock_proc.returncode = 0 + mock_proc.wait.return_value = None + mock_popen.return_value = mock_proc + + with patch.object( + main_module, + "_passgpt_model_dir", + return_value=str(tmp_path / "models"), + ): + main_module.hcatPassGPTTrain( + str(training_file), base_model="custom/base-model" + ) + + cmd = mock_popen.call_args[0][0] + assert "custom/base-model" in cmd + + def test_training_failure_returns_none(self, main_module, tmp_path): + training_file = tmp_path / "wordlist.txt" + training_file.write_text("test\n") + + with ( + patch.object( + main_module, "passgptModel", "javirandor/passgpt-10characters" + ), + patch("hate_crack.main.subprocess.Popen") as mock_popen, + ): + mock_proc = MagicMock() + mock_proc.returncode = 1 + mock_proc.wait.return_value = None + mock_popen.return_value = mock_proc + + with patch.object( + main_module, + "_passgpt_model_dir", + return_value=str(tmp_path / "models"), + ): + result = main_module.hcatPassGPTTrain(str(training_file)) + + assert result is None + + +class TestPassGPTModelDir: + def test_creates_directory(self, main_module, tmp_path): + target = str(tmp_path / "passgpt_models") + with patch("hate_crack.main.os.path.expanduser", return_value=str(tmp_path)): + result = main_module._passgpt_model_dir() + assert os.path.isdir(result) + assert result.endswith("passgpt") + + +class TestPassGPTAttackHandler: + def _make_ctx(self, model_dir=None): + ctx = MagicMock() + ctx.HAS_ML_DEPS = True + ctx.passgptMaxCandidates = 1000000 + ctx.passgptModel = "javirandor/passgpt-10characters" + ctx.passgptBatchSize = 1024 + ctx.hcatHashType = "1000" + ctx.hcatHashFile = "/tmp/hashes.txt" + ctx.hcatWordlists = "/tmp/wordlists" + if model_dir is None: + ctx._passgpt_model_dir.return_value = "/nonexistent/empty" + else: + ctx._passgpt_model_dir.return_value = model_dir + return ctx + + def test_select_default_model_and_generate(self): + ctx = self._make_ctx() + + # "1" selects default model, "" accepts default max candidates + inputs = iter(["1", ""]) + with ( + patch("builtins.input", side_effect=inputs), + patch("hate_crack.attacks.os.path.isdir", return_value=False), + ): + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + ctx.hcatPassGPT.assert_called_once_with( + "1000", + "/tmp/hashes.txt", + 1000000, + model_name="javirandor/passgpt-10characters", + batch_size=1024, + ) + + def test_select_local_model(self, tmp_path): + # Create a fake local model directory + model_dir = tmp_path / "passgpt" + local_model = model_dir / "my_model" + local_model.mkdir(parents=True) + (local_model / "config.json").write_text("{}") + + ctx = self._make_ctx(model_dir=str(model_dir)) + + # "2" selects the local model, "" accepts default max candidates + inputs = iter(["2", ""]) + with ( + patch("builtins.input", side_effect=inputs), + patch("hate_crack.attacks.os.path.isdir", return_value=True), + patch("hate_crack.attacks.os.listdir", return_value=["my_model"]), + patch("hate_crack.attacks.os.path.isfile", return_value=True), + patch( + "hate_crack.attacks.os.path.isdir", + side_effect=lambda p: True, + ), + ): + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + ctx.hcatPassGPT.assert_called_once() + call_kwargs = ctx.hcatPassGPT.call_args + # The model_name should be the local path + assert call_kwargs[1]["model_name"] == str(local_model) + + def test_train_new_model(self): + ctx = self._make_ctx() + ctx.select_file_with_autocomplete.return_value = "/tmp/wordlist.txt" + ctx.hcatPassGPTTrain.return_value = "/home/user/.hate_crack/passgpt/wordlist" + + # "T" for train, "" for default base model, "" for default device (cuda), "" for default max candidates + inputs = iter(["T", "", "", ""]) + with ( + patch("builtins.input", side_effect=inputs), + patch("hate_crack.attacks.os.path.isdir", return_value=False), + ): + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + ctx.hcatPassGPTTrain.assert_called_once_with( + "/tmp/wordlist.txt", "javirandor/passgpt-10characters", device="cuda" + ) + ctx.hcatPassGPT.assert_called_once() + call_kwargs = ctx.hcatPassGPT.call_args + assert call_kwargs[1]["model_name"] == "/home/user/.hate_crack/passgpt/wordlist" + + def test_train_failure_aborts(self): + ctx = self._make_ctx() + ctx.select_file_with_autocomplete.return_value = "/tmp/wordlist.txt" + ctx.hcatPassGPTTrain.return_value = None + + # "T" for train, "" for default base model, "" for default device (cuda) + inputs = iter(["T", "", ""]) + with ( + patch("builtins.input", side_effect=inputs), + patch("hate_crack.attacks.os.path.isdir", return_value=False), + ): + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + ctx.hcatPassGPTTrain.assert_called_once() + ctx.hcatPassGPT.assert_not_called() + + def test_ml_deps_missing(self, capsys): + ctx = MagicMock() + ctx.HAS_ML_DEPS = False + + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + captured = capsys.readouterr() + assert "ML dependencies" in captured.out + assert "uv pip install" in captured.out + ctx.hcatPassGPT.assert_not_called() + + def test_custom_max_candidates(self): + ctx = self._make_ctx() + + # "1" selects default model, "500000" for custom max candidates + inputs = iter(["1", "500000"]) + with ( + patch("builtins.input", side_effect=inputs), + patch("hate_crack.attacks.os.path.isdir", return_value=False), + ): + from hate_crack.attacks import passgpt_attack + + passgpt_attack(ctx) + + ctx.hcatPassGPT.assert_called_once_with( + "1000", + "/tmp/hashes.txt", + 500000, + model_name="javirandor/passgpt-10characters", + batch_size=1024, + ) + + +class TestGetAvailableMemoryMb: + def test_returns_int_or_none(self): + result = _get_available_memory_mb() + assert result is None or isinstance(result, int) + + def test_never_crashes_on_any_platform(self): + # Should not raise regardless of platform + _get_available_memory_mb() + + def test_returns_positive_when_detected(self): + result = _get_available_memory_mb() + if result is not None: + assert result > 0 + + +class TestCountLines: + def test_counts_non_empty_lines(self, tmp_path): + f = tmp_path / "test.txt" + f.write_text("line1\nline2\n\nline3\n") + assert _count_lines(str(f)) == 3 + + def test_empty_file(self, tmp_path): + f = tmp_path / "empty.txt" + f.write_text("") + assert _count_lines(str(f)) == 0 + + +class TestEstimateTrainingMemoryMb: + def test_returns_reasonable_estimate(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 1000) + estimate = _estimate_training_memory_mb(str(f)) + # Should include at least model + optimizer overhead (~1700MB) + assert estimate >= 1700 + + def test_max_lines_reduces_estimate(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 100000) + full = _estimate_training_memory_mb(str(f)) + limited = _estimate_training_memory_mb(str(f), max_lines=100) + assert limited <= full + + +class TestMemoryPrecheck: + def test_aborts_when_insufficient(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 10) + + with ( + patch("hate_crack.passgpt_train._get_available_memory_mb", return_value=1), + patch( + "hate_crack.passgpt_train._estimate_training_memory_mb", + return_value=5000, + ), + pytest.raises(SystemExit), + ): + from hate_crack.passgpt_train import train + + train( + training_file=str(f), + output_dir=str(tmp_path / "out"), + base_model="test", + epochs=1, + batch_size=1, + device="cpu", + ) + + @pytest.mark.skipif(not _has_transformers, reason="transformers not installed") + def test_skips_when_detection_fails(self, tmp_path): + """When memory detection returns None, training proceeds past the pre-check.""" + f = tmp_path / "words.txt" + f.write_text("password\n" * 10) + + mock_tokenizer = MagicMock() + mock_model = MagicMock() + mock_model.config.n_positions = 16 + mock_trainer = MagicMock() + + with ( + patch( + "hate_crack.passgpt_train._get_available_memory_mb", return_value=None + ), + patch( + "hate_crack.passgpt_train._estimate_training_memory_mb", + return_value=5000, + ), + patch("hate_crack.passgpt_train._configure_mps"), + patch( + "transformers.RobertaTokenizerFast.from_pretrained", + return_value=mock_tokenizer, + ), + patch( + "transformers.GPT2LMHeadModel.from_pretrained", + return_value=mock_model, + ), + patch("transformers.Trainer", return_value=mock_trainer), + patch("transformers.TrainingArguments"), + ): + from hate_crack.passgpt_train import train + + train( + training_file=str(f), + output_dir=str(tmp_path / "out"), + base_model="test", + epochs=1, + batch_size=1, + device="cpu", + ) + + mock_trainer.train.assert_called_once() + + +class TestMaxLines: + def test_count_lines_respects_limit(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 1000) + # _count_lines doesn't have a limit, but _estimate uses max_lines + total = _count_lines(str(f)) + assert total == 1000 + + def test_estimate_uses_max_lines(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 10000) + est_full = _estimate_training_memory_mb(str(f)) + est_limited = _estimate_training_memory_mb(str(f), max_lines=10) + assert est_limited <= est_full + + +class TestMemoryLimitAutoTune: + @pytest.mark.skipif(not _has_transformers, reason="transformers not installed") + def test_auto_tunes_max_lines(self, tmp_path, capsys): + f = tmp_path / "words.txt" + f.write_text("password\n" * 100) + + mock_tokenizer = MagicMock() + mock_model = MagicMock() + mock_model.config.n_positions = 16 + mock_trainer = MagicMock() + + with ( + patch( + "hate_crack.passgpt_train._get_available_memory_mb", return_value=None + ), + patch("hate_crack.passgpt_train._configure_mps"), + patch( + "transformers.RobertaTokenizerFast.from_pretrained", + return_value=mock_tokenizer, + ), + patch( + "transformers.GPT2LMHeadModel.from_pretrained", + return_value=mock_model, + ), + patch("transformers.Trainer", return_value=mock_trainer), + patch("transformers.TrainingArguments"), + ): + from hate_crack.passgpt_train import train + + train( + training_file=str(f), + output_dir=str(tmp_path / "out"), + base_model="test", + epochs=1, + batch_size=1, + device="cpu", + memory_limit=2000, + ) + + captured = capsys.readouterr() + assert "--memory-limit 2000MB: auto-set --max-lines" in captured.err + + def test_memory_limit_too_low_exits(self, tmp_path): + f = tmp_path / "words.txt" + f.write_text("password\n" * 10) + + with pytest.raises(SystemExit): + from hate_crack.passgpt_train import train + + train( + training_file=str(f), + output_dir=str(tmp_path / "out"), + base_model="test", + epochs=1, + batch_size=1, + device="cpu", + memory_limit=1, # 1MB - way too low + ) diff --git a/tests/test_ui_menu_options.py b/tests/test_ui_menu_options.py index 2df6ebd..db237b9 100644 --- a/tests/test_ui_menu_options.py +++ b/tests/test_ui_menu_options.py @@ -27,6 +27,16 @@ MENU_OPTION_TEST_CASES = [ ("14", CLI_MODULE._attacks, "loopback_attack", "loopback"), ("15", CLI_MODULE._attacks, "ollama_attack", "ollama"), ("16", CLI_MODULE._attacks, "omen_attack", "omen"), + pytest.param( + "17", + CLI_MODULE._attacks, + "passgpt_attack", + "passgpt", + marks=pytest.mark.skipif( + not getattr(CLI_MODULE, "HAS_ML_DEPS", False), + reason="ML dependencies not installed", + ), + ), ("90", CLI_MODULE, "download_hashmob_rules", "hashmob-rules"), ("91", CLI_MODULE, "weakpass_wordlist_menu", "weakpass-menu"), ("92", CLI_MODULE, "download_hashmob_wordlists", "hashmob-wordlists"), diff --git a/tests/test_version_check.py b/tests/test_version_check.py new file mode 100644 index 0000000..68b22fb --- /dev/null +++ b/tests/test_version_check.py @@ -0,0 +1,121 @@ +"""Tests for the startup version check feature.""" + +import json +from unittest.mock import MagicMock, patch + +import pytest + + +@pytest.fixture +def hc_module(): + """Load hate_crack.main with SKIP_INIT enabled.""" + import os + import importlib + + os.environ["HATE_CRACK_SKIP_INIT"] = "1" + mod = importlib.import_module("hate_crack.main") + return mod + + +class TestCheckForUpdates: + """Tests for check_for_updates().""" + + def test_newer_version_prints_update_notice(self, hc_module, capsys): + mock_resp = MagicMock() + mock_resp.json.return_value = {"tag_name": "v99.0.0"} + mock_resp.raise_for_status = MagicMock() + + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", True + ): + mock_requests.get.return_value = mock_resp + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available: 99.0.0" in output + assert "github.com/trustedsec/hate_crack/releases" in output + + def test_same_version_prints_nothing(self, hc_module, capsys): + from hate_crack import __version__ + + local_base = __version__.split("+")[0] + mock_resp = MagicMock() + mock_resp.json.return_value = {"tag_name": f"v{local_base}"} + mock_resp.raise_for_status = MagicMock() + + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", True + ): + mock_requests.get.return_value = mock_resp + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available" not in output + + def test_older_version_prints_nothing(self, hc_module, capsys): + mock_resp = MagicMock() + mock_resp.json.return_value = {"tag_name": "v0.0.1"} + mock_resp.raise_for_status = MagicMock() + + with ( + patch.object(hc_module, "requests") as mock_requests, + patch.object(hc_module, "REQUESTS_AVAILABLE", True), + patch("hate_crack.__version__", "2.0"), + ): + mock_requests.get.return_value = mock_resp + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available" not in output + + def test_network_error_silently_handled(self, hc_module, capsys): + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", True + ): + mock_requests.get.side_effect = ConnectionError("no network") + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available" not in output + assert "Error" not in output + + def test_requests_unavailable_skips_check(self, hc_module, capsys): + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", False + ): + hc_module.check_for_updates() + mock_requests.get.assert_not_called() + + def test_config_disabled_skips_check(self, hc_module): + """Verify that check_for_updates_enabled=False prevents the call in main().""" + # The config flag is checked in main() before calling check_for_updates(). + # We verify the flag loads correctly from config. + assert hasattr(hc_module, "check_for_updates_enabled") + + def test_tag_without_v_prefix(self, hc_module, capsys): + mock_resp = MagicMock() + mock_resp.json.return_value = {"tag_name": "99.0.0"} + mock_resp.raise_for_status = MagicMock() + + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", True + ): + mock_requests.get.return_value = mock_resp + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available: 99.0.0" in output + + def test_empty_tag_name_handled(self, hc_module, capsys): + mock_resp = MagicMock() + mock_resp.json.return_value = {"tag_name": ""} + mock_resp.raise_for_status = MagicMock() + + with patch.object(hc_module, "requests") as mock_requests, patch.object( + hc_module, "REQUESTS_AVAILABLE", True + ): + mock_requests.get.return_value = mock_resp + hc_module.check_for_updates() + + output = capsys.readouterr().out + assert "Update available" not in output