fiddlesticks 0.6.0__tar.gz → 0.7.0__tar.gz

fiddlesticks-0.7.0/.github/workflows/benchmarks.yml

@@ -0,0 +1,35 @@
+name: Benchmarks
+
+on:
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-26.04
+    container:
+      image: ghcr.io/hazardous-area/fiddlesticks/test_env:sha-f1100e7
+      # Extra options needed for Veracrypt to 
+      # mount volumes inside a Docker container
+      options: >-
+        --device /dev/fuse
+        --cap-add SYS_ADMIN
+        --security-opt apparmor:unconfined
+        --privileged
+        -v /dev:/dev
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v7
+
+    - name: Install code under test
+      run: |
+        . /fiddlesticks/.venv/bin/activate
+        pip install -e .[all]   
+
+    - name: Run Benchmarks
+      run: |
+        . /fiddlesticks/.venv/bin/activate
+        python benchmarks.py --output-file benchmarks.txt --max-time-s=3540 --min-num-subs=0 --max-num-subs=6 --num-cores=4
+
+    - name: Print Benchmark results file
+      run: |
+        cat benchmarks.txt

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/.github/workflows/dev_tests.yml

@@ -2,8 +2,6 @@ name: Dev tests
 
 on:
   workflow_dispatch:
-  push:
-
 
 jobs:
   test:
@@ -61,16 +59,12 @@ jobs:
         . ./.venv/bin/activate
         pip install -e .[all]
 
-    - name: Run Multicore smoke test
-      run: |
-        . ./.venv/bin/activate
-        python dev/sketch_multicore.py
 
     
 
-    # - name: Run PW candidate Generator regression tests (to check refactor)
-    #   run: |
-    #     . ./.venv/bin/activate
-    #     pytest dev/pw_generator_regression_tests.py
+    - name: Run PW candidate Generator regression tests (to check refactor)
+      run: |
+        . ./.venv/bin/activate
+        pytest dev/pw_generator_regression_tests.py
 
 

fiddlesticks-0.7.0/.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: Run pre-commit hooks
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-26.04
+    container:
+      image: ghcr.io/hazardous-area/fiddlesticks/test_env:sha-f1100e7
+      # Extra options needed for Veracrypt to 
+      # mount volumes inside a Docker container
+      options: >-
+        --device /dev/fuse
+        --cap-add SYS_ADMIN
+        --security-opt apparmor:unconfined
+        --privileged
+        -v /dev:/dev
+    steps:
+    - name: Check out repo
+      uses: actions/checkout@v7
+
+    - name: Install project deps and lint group
+      run: |
+        . /fiddlesticks/.venv/bin/activate
+        pip install --group=lint --group=test
+        pip install -e .[all] --only-deps
+
+    - name: Run Ruff
+      run: /fiddlesticks/.venv/bin/ruff check
+
+    - name: Run Ty
+      env:
+        VIRTUAL_ENV: /fiddlesticks/.venv
+      run: /fiddlesticks/.venv/bin/ty check

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fiddlesticks
-Version: 0.6.0
+Version: 0.7.0
 Summary: Password recovery tool for encrypted files (.7z archives .kdbx files, and Aegis archives).
 Project-URL: GitHub, https://github.com/Hazardous-Area/fiddlesticks
 Author-email: James Parrott <james@jamesparrott.dev>
@@ -12,10 +12,13 @@ Requires-Dist: py-avdu; extra == 'aegis'
 Provides-Extra: all
 Requires-Dist: bcrypt; extra == 'all'
 Requires-Dist: cryptography>=47; extra == 'all'
+Requires-Dist: legacycrypt; extra == 'all'
 Requires-Dist: msoffcrypto-tool; extra == 'all'
 Requires-Dist: py-avdu; extra == 'all'
 Requires-Dist: py7zr; extra == 'all'
 Requires-Dist: pykeepass; extra == 'all'
+Provides-Extra: etc-shadow
+Requires-Dist: legacycrypt; extra == 'etc-shadow'
 Provides-Extra: keepassxc
 Requires-Dist: pykeepass; extra == 'keepassxc'
 Provides-Extra: msoffice
@@ -33,18 +36,19 @@ Description-Content-Type: text/markdown
 ![Tests passing](https://github.com/Hazardous-Area/fiddlesticks/actions/workflows/tests.yml/badge.svg)
 ![Code qual](https://github.com/Hazardous-Area/fiddlesticks/actions/workflows/lint.yml/badge.svg)
 
-Version 0.5.0.dev
+Version 0.6.1
 
 ## Description
 Password recovery tool, for password-encrypted files, using simple off-line brute 
 force attacks.  Password candidates are generated, using common variations 
-of a guessed password (e.g. typos and substitutions). SSH keys and Aegis archives, 
-plus .7z, .kdbx, .xlsx, and .docx files, 
-are directly supported as optional dependencies (Veracrypt volumes too, but they're 
-so secure, they require 45 CPU-core-seconds per guess).  But 
+of a guessed password (e.g. typos and substitutions). SSH keys, Veracrypt volumes, /etc/shadow lines(\*), and Aegis archives, plus .7z, .kdbx, .xlsx and .docx files and 
+are directly supported as optional dependencies.  But 
 Fiddlesticks can also call any shell command, that accepts a candidate password, 
 e.g. for Veracrypt volumes (and can pipe candidates to stdout).
 
+(\*) If root or sudo is available to read /etc/shadow in the first place, note:
+if the goal is only to access another user's account, their password can simply be changed, also with sudo.
+
 ### Raison d'etre
  - Password-protected file owners recovering their own password themselves, as long as 
 they can still recall a rough guess for their password, might only need to test 
@@ -196,26 +200,19 @@ At the very least, real world adversaries (posessing a stolen file or password h
 
 ## Benchmarks
  - Github Actions Ubuntu runner (4 core)
- 
-| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
-|----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
-|        0 |       1 |        0|         1.0|        0|         0.0|        0|         1.0|        0|         0.0|        0|       164.0|        0|         1.0|
-|        1 |      42 |        0|        11.0|        0|         5.0|        0|         6.0|        0|         0.0|        0|         6.0|        0|         8.0|
-|        2 |     842 |        3|         3.0|        1|         2.0|        2|         2.0|        2|         2.0|        2|         3.0|        1|         2.0|
-|        3 |   10724 |       38|         3.0|       22|         2.0|       28|         2.0|       29|         2.0|       27|         2.0|       28|         2.0|
-|        4 |   97431 |      281|         2.0|      254|         2.0|      233|         2.0|      212|         2.0|      254|         2.0|      240|         2.0|
-|        5 |  672118 |     1883|         2.0|     1967|         2.0|     1636|         2.0|     1701|         2.0|     1382|         2.0|     1497|         2.0|
-
-
-
- - Hetzner CX23 x86 4GB
- - fiddlesticks v0.5.0.dev
+ - fiddlesticks v0.6.1
  - guess=[`correcthorsebatterystaple`](https://xkcd.com/936/)
+ 
 
-| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
+| Num subs |Num pwds | .docx/s | per pwd/cpu ms | .kdbx/s | per pwd/cpu ms | .json/s | per pwd/cpu ms | .7z  /s | per pwd/cpu ms | .key /s | per pwd/cpu ms | .hc  /s | per pwd/cpu ms |
 |----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
-|        0 |       1 |        0|        71.0|        0|       110.0|        0|       148.0|        0|       221.0|        0|       261.0|       45|     45610.0|
-|        1 |      42 |        2|        59.0|        3|        90.0|        6|       147.0|        9|       230.0|       10|       257.0|         |            |
-|        2 |     842 |       46|        55.0|       76|        90.0|      121|       144.0|      186|       221.0|      216|       257.0|         |            |
-|        3 |   10724 |      573|        53.0|      991|        92.0|         |            |         |            |         |            |         |            |
+|        0 |       1 |       10|40339.412689208984|       20|80084.81884002686|       10|40073.225021362305|       20|80056.3097000122|       20|80056.48422241211|       10|40072.23320007324|
+|        1 |      42 |       20|1908.452306474958|       20|1908.4490140279133|       20|1908.4565525963194|       20|1908.7251481555757|       20|1907.8663417271205|       20|1908.5558709644135|
+|        2 |     842 |       20|96.46233583572642|       10|48.93052153236226|       20|96.45510852478462|       20|96.49051226799392|       20|96.44632951097647|       20|96.43983048101502|
+|        3 |   10724 |       23|8.813216943253513|       23|8.81822400020157|       23|8.808564268266563|       13|5.058712231850544|       13|5.071774742043939|       23|8.794312955549696|
+|        4 |   97431 |       52|2.1614515430617898|       52|2.1749609552847717|       43|1.7742308170991132|       53|2.1980988163370605|       53|2.21338118517836|       53|2.2093424457554316|
+|        5 |  672118 |      242|1.4430960060459646|      257|1.5301919328892881|      263|1.567255141390218|      244|1.4564930530505062|      269|1.6068344686839404|      256|1.5272892323243892|
+|        6 | 3658692 |     1361|1.4885278247339404|      931|1.0179169681424118|     1342|1.468057746344242|      930|1.0174063220909733|     1359|1.4865520419278282|     1351|1.4778001960510592|
+
 
+more in `./dev/Benchmarks.md`

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/README.md

@@ -4,18 +4,19 @@
 ![Tests passing](https://github.com/Hazardous-Area/fiddlesticks/actions/workflows/tests.yml/badge.svg)
 ![Code qual](https://github.com/Hazardous-Area/fiddlesticks/actions/workflows/lint.yml/badge.svg)
 
-Version 0.5.0.dev
+Version 0.6.1
 
 ## Description
 Password recovery tool, for password-encrypted files, using simple off-line brute 
 force attacks.  Password candidates are generated, using common variations 
-of a guessed password (e.g. typos and substitutions). SSH keys and Aegis archives, 
-plus .7z, .kdbx, .xlsx, and .docx files, 
-are directly supported as optional dependencies (Veracrypt volumes too, but they're 
-so secure, they require 45 CPU-core-seconds per guess).  But 
+of a guessed password (e.g. typos and substitutions). SSH keys, Veracrypt volumes, /etc/shadow lines(\*), and Aegis archives, plus .7z, .kdbx, .xlsx and .docx files and 
+are directly supported as optional dependencies.  But 
 Fiddlesticks can also call any shell command, that accepts a candidate password, 
 e.g. for Veracrypt volumes (and can pipe candidates to stdout).
 
+(\*) If root or sudo is available to read /etc/shadow in the first place, note:
+if the goal is only to access another user's account, their password can simply be changed, also with sudo.
+
 ### Raison d'etre
  - Password-protected file owners recovering their own password themselves, as long as 
 they can still recall a rough guess for their password, might only need to test 
@@ -167,26 +168,19 @@ At the very least, real world adversaries (posessing a stolen file or password h
 
 ## Benchmarks
  - Github Actions Ubuntu runner (4 core)
- 
-| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
-|----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
-|        0 |       1 |        0|         1.0|        0|         0.0|        0|         1.0|        0|         0.0|        0|       164.0|        0|         1.0|
-|        1 |      42 |        0|        11.0|        0|         5.0|        0|         6.0|        0|         0.0|        0|         6.0|        0|         8.0|
-|        2 |     842 |        3|         3.0|        1|         2.0|        2|         2.0|        2|         2.0|        2|         3.0|        1|         2.0|
-|        3 |   10724 |       38|         3.0|       22|         2.0|       28|         2.0|       29|         2.0|       27|         2.0|       28|         2.0|
-|        4 |   97431 |      281|         2.0|      254|         2.0|      233|         2.0|      212|         2.0|      254|         2.0|      240|         2.0|
-|        5 |  672118 |     1883|         2.0|     1967|         2.0|     1636|         2.0|     1701|         2.0|     1382|         2.0|     1497|         2.0|
-
-
-
- - Hetzner CX23 x86 4GB
- - fiddlesticks v0.5.0.dev
+ - fiddlesticks v0.6.1
  - guess=[`correcthorsebatterystaple`](https://xkcd.com/936/)
+ 
 
-| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
+| Num subs |Num pwds | .docx/s | per pwd/cpu ms | .kdbx/s | per pwd/cpu ms | .json/s | per pwd/cpu ms | .7z  /s | per pwd/cpu ms | .key /s | per pwd/cpu ms | .hc  /s | per pwd/cpu ms |
 |----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
-|        0 |       1 |        0|        71.0|        0|       110.0|        0|       148.0|        0|       221.0|        0|       261.0|       45|     45610.0|
-|        1 |      42 |        2|        59.0|        3|        90.0|        6|       147.0|        9|       230.0|       10|       257.0|         |            |
-|        2 |     842 |       46|        55.0|       76|        90.0|      121|       144.0|      186|       221.0|      216|       257.0|         |            |
-|        3 |   10724 |      573|        53.0|      991|        92.0|         |            |         |            |         |            |         |            |
+|        0 |       1 |       10|40339.412689208984|       20|80084.81884002686|       10|40073.225021362305|       20|80056.3097000122|       20|80056.48422241211|       10|40072.23320007324|
+|        1 |      42 |       20|1908.452306474958|       20|1908.4490140279133|       20|1908.4565525963194|       20|1908.7251481555757|       20|1907.8663417271205|       20|1908.5558709644135|
+|        2 |     842 |       20|96.46233583572642|       10|48.93052153236226|       20|96.45510852478462|       20|96.49051226799392|       20|96.44632951097647|       20|96.43983048101502|
+|        3 |   10724 |       23|8.813216943253513|       23|8.81822400020157|       23|8.808564268266563|       13|5.058712231850544|       13|5.071774742043939|       23|8.794312955549696|
+|        4 |   97431 |       52|2.1614515430617898|       52|2.1749609552847717|       43|1.7742308170991132|       53|2.1980988163370605|       53|2.21338118517836|       53|2.2093424457554316|
+|        5 |  672118 |      242|1.4430960060459646|      257|1.5301919328892881|      263|1.567255141390218|      244|1.4564930530505062|      269|1.6068344686839404|      256|1.5272892323243892|
+|        6 | 3658692 |     1361|1.4885278247339404|      931|1.0179169681424118|     1342|1.468057746344242|      930|1.0174063220909733|     1359|1.4865520419278282|     1351|1.4778001960510592|
+
 
+more in `./dev/Benchmarks.md`

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/benchmarks.py

@@ -1,4 +1,5 @@
 import argparse
+import os
 import time
 import tomllib
 from collections import deque
@@ -13,6 +14,7 @@ version = metadata["project"]["version"]
 
 # guess = "abcd"
 guess = "correcthorsebatterystaple"
+num_cpu_cores_available = os.process_cpu_count()
 
 
 def f(x, guess=guess):
@@ -106,7 +108,7 @@ def benchmark_candidate_generation(
 
 
 test_files = [
-    ("test.xlsx", "test.docx"),
+    ("test.docx", "test.xlsx"),
     "Test_vault_Do_Not_Use.kdbx",
     "aegis_encrypted.json",
     "foo.7z",
@@ -116,14 +118,16 @@ test_files = [
 
 
 files = {
-    Path(files[0] if isinstance(files, tuple) else files): 0.0 for files in test_files
+    Path(files[0] if isinstance(files, tuple) else files): 0.1 for files in test_files
 }
 
 
 def benchmark_candidate_testing(
     output_file: Path = Path("fiddlesticks_benchmarks.txt"),
     max_time_s: int = 1000,
+    min_num_subs: int = 0,
     max_num_subs: int = 3,
+    num_cores: int = 1,
 ):
 
     def output(s: str):
@@ -135,7 +139,7 @@ def benchmark_candidate_testing(
     output(f"{msg}\n\n")
 
     # Markdown table format
-    headers = [f" {file.suffix:5}/s | per pwd/ms |" for file in files]
+    headers = [f" {file.suffix:5}/s | per pwd/cpu ms |" for file in files]
     headers.insert(0, "| Num subs |")
     headers.insert(1, "Num pwds |")
     for header in headers:
@@ -147,48 +151,57 @@ def benchmark_candidate_testing(
     output("|".join(f":{'-' * 7}:|:{'-' * 10}:" for header in headers[2:]))
     output("|\n")
 
-    for num_subs in range(min(max_num_subs, len(guess)) + 1):
+    for num_subs in range(min_num_subs, min(max_num_subs, len(guess)) + 1):
         L = len(headers[0])
 
         output(f"|{num_subs:{L - 3}} |")
 
         printed_num_pwds = False
 
-        for header, (file, per_pwd_ms) in zip(headers[2:], files.items()):
+        for header, (file, per_pwd_per_cpu_ms) in zip(headers[2:], files.items()):
             L = len(header)
 
             # For num_subs = 8, caching all candidates requires 8GB,
             # so make a new iterator for each file
-            N, pwds = fiddlesticks.candidate_passwords_from_alt_chars(
+            total, _pwds = fiddlesticks.candidate_passwords_from_alt_chars(
                 [guess],
                 min_subs=num_subs,
                 max_subs=num_subs,
             )
 
             if not printed_num_pwds:
-                output(f" {N:{len(headers[1]) - 3}} |")
+                output(f" {total:{len(headers[1]) - 3}} |")
                 printed_num_pwds = True
 
-            if (per_pwd_ms * N / 1000) >= max_time_s:
+            # Skip this one, if it's estimated to take longer than max_time_s
+            if (per_pwd_per_cpu_ms / 1000) * (total / num_cores) >= max_time_s:
                 output(f"{' ':9}|{' ':{L - 11}}|")
                 continue
 
             file_name = file.as_posix()
-            checker_factory = fiddlesticks._default_Checker_selector(file_name)
-            updater = fiddlesticks.Updater()
+            # checker_factory = fiddlesticks._default_Checker_selector(file_name)
+            # updater = fiddlesticks.Updater()
 
             t0 = time.time()
-            with checker_factory(file_name) as checker:
-                fiddlesticks.check_passwords_sequentially(
-                    pwds, checker, update_every=1000, updater=updater
-                )
+            fiddlesticks.cli(
+                [
+                    "--new-search",
+                    f"--password-guess={guess}",
+                    f"--num-cores={num_cores}",
+                    f"--max-subs={num_subs}",
+                    f"--min-subs={num_subs}",
+                    file_name,
+                ]
+            )
             t1 = time.time()
 
             t_s = t1 - t0
 
-            per_pwd_ms = 1000 * t_s // N
-            files[file] = per_pwd_ms
-            output(f"{int(t_s):9}|{per_pwd_ms:{L - 11}}|")
+            per_pwd_per_cpu_ms = (1000 * t_s * num_cores) / total
+            # Update the current value in the dict, with (hopefully)
+            # this better estimate (initialised to zero above).
+            files[file] = per_pwd_per_cpu_ms
+            output(f"{int(t_s):9}|{per_pwd_per_cpu_ms:{L - 11}}|")
 
         output("\n")
 
@@ -199,10 +212,15 @@ parser.add_argument(
 )
 parser.add_argument("--max-time-s", type=int, default=1000)
 parser.add_argument("--max-num-subs", type=int, default=3)
+parser.add_argument("--min-num-subs", type=int, default=0)
+parser.add_argument("--num-cores", type=int, default=1)
 
 
 if __name__ == "__main__":
     namespace = parser.parse_args()
+    print(
+        f"Testing: {guess=}  (num_cores = {namespace.num_cores}, {num_cpu_cores_available=}). "
+    )
     benchmark_candidate_testing(**vars(namespace))
 
 # E.g.

fiddlesticks-0.7.0/dev/Benchmarks.md

@@ -0,0 +1,39 @@
+
+## Benchmarks
+ - Github Actions Ubuntu runner (4 core)
+ - fiddlesticks v0.6.1
+ - guess=[`correcthorsebatterystaple`](https://xkcd.com/936/)
+ 
+
+| Num subs |Num pwds | .docx/s | per pwd/cpu ms | .kdbx/s | per pwd/cpu ms | .json/s | per pwd/cpu ms | .7z  /s | per pwd/cpu ms | .key /s | per pwd/cpu ms | .hc  /s | per pwd/cpu ms |
+|----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
+|        0 |       1 |       10|40339.412689208984|       20|80084.81884002686|       10|40073.225021362305|       20|80056.3097000122|       20|80056.48422241211|       10|40072.23320007324|
+|        1 |      42 |       20|1908.452306474958|       20|1908.4490140279133|       20|1908.4565525963194|       20|1908.7251481555757|       20|1907.8663417271205|       20|1908.5558709644135|
+|        2 |     842 |       20|96.46233583572642|       10|48.93052153236226|       20|96.45510852478462|       20|96.49051226799392|       20|96.44632951097647|       20|96.43983048101502|
+|        3 |   10724 |       23|8.813216943253513|       23|8.81822400020157|       23|8.808564268266563|       13|5.058712231850544|       13|5.071774742043939|       23|8.794312955549696|
+|        4 |   97431 |       52|2.1614515430617898|       52|2.1749609552847717|       43|1.7742308170991132|       53|2.1980988163370605|       53|2.21338118517836|       53|2.2093424457554316|
+|        5 |  672118 |      242|1.4430960060459646|      257|1.5301919328892881|      263|1.567255141390218|      244|1.4564930530505062|      269|1.6068344686839404|      256|1.5272892323243892|
+|        6 | 3658692 |     1361|1.4885278247339404|      931|1.0179169681424118|     1342|1.468057746344242|      930|1.0174063220909733|     1359|1.4865520419278282|     1351|1.4778001960510592|
+
+
+
+ - Github Actions Ubuntu runner (4 core)
+ - fiddlesticks v0.6.1
+ - guess='correcthorsebatterystaple'
+
+| Num subs |Num pwds | .docx/s | per pwd/cpu ms |
+|----------|:-------:|:-------:|:----------:|
+|        7 | 16123752 |     5199|1.2898232823581652|
+
+
+ - Hetzner CX23 x86 4GB
+ - fiddlesticks v0.5.0.dev
+ - guess=[`correcthorsebatterystaple`](https://xkcd.com/936/)
+
+| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
+|----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
+|        0 |       1 |        0|        71.0|        0|       110.0|        0|       148.0|        0|       221.0|        0|       261.0|       45|     45610.0|
+|        1 |      42 |        2|        59.0|        3|        90.0|        6|       147.0|        9|       230.0|       10|       257.0|         |            |
+|        2 |     842 |       46|        55.0|       76|        90.0|      121|       144.0|      186|       221.0|      216|       257.0|         |            |
+|        3 |   10724 |      573|        53.0|      991|        92.0|         |            |         |            |         |            |         |            |
+

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/pyproject.toml

@@ -12,7 +12,11 @@ authors = [
     { name = "James Parrott", email = "james@jamesparrott.dev" }
 ]
 requires-python = ">=3.13"
-version = "0.6.0"
+
+# Define the version statically here, not with dynamic=["version"], so that
+# the fiddlesticks.py needn't be copied into the the Docker image in order to
+# install the dependencies and test dependency group
+version = "0.7.0" 
 
 dependencies = []
 
@@ -39,8 +43,11 @@ py7zr = [
 msoffice = [
     "msoffcrypto-tool",
 ]
+etc_shadow = [
+    "legacycrypt",
+]
 all = [
-    "fiddlesticks[ssh,keepassxc,aegis,py7zr,msoffice]",
+    "fiddlesticks[ssh,keepassxc,aegis,py7zr,msoffice,etc_shadow]",
 ]
 # Note.  Some features also require optional dependencies 
 # that are not available on PyPi (and must be installed from
@@ -50,14 +57,6 @@ all = [
 
 
 [dependency-groups]
-all_optional_deps = [
-        "fiddlesticks[ssh,keepassxc,aegis,py7zr,msoffice]",
-]
-dev = [
-    {include-group= "all_optional_deps"},
-    {include-group = "lint"},
-    {include-group = "test"},
-]
 test = [
     "pytest",
     "hypothesis",
@@ -67,7 +66,6 @@ test = [
 lint = [
     "ruff",
     "ty",
-    "pre-commit",
 ]
 
 

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/src/fiddlesticks.py

@@ -790,6 +790,54 @@ class VeracryptChecker(SubprocessChecker):
         self.temp_dir.cleanup()
 
 
+class EtcShadowChecker(Checker):
+    @staticmethod
+    def _parse_etc_shadow_line(line: str, name: str) -> tuple[str, str] | None:
+        fields = line.split(":")
+        if len(fields) <= 1:
+            return None
+        account_name, flag_salt_and_digest = fields[:2]
+
+        if name != account_name:
+            return None
+
+        try:
+            __, flag, salt, _digest = flag_salt_and_digest.split("$")
+        except ValueError:
+            return None
+
+        salt_arg = f"${flag}${salt}"
+        return flag_salt_and_digest, salt_arg
+
+    @classmethod
+    def parse_etc_shadow(cls, file: FileT, account_name: str) -> tuple[str, str] | None:
+        file_path = Path(file)
+        for line in file_path.read_text().splitlines():
+            parsed = cls._parse_etc_shadow_line(line, account_name)
+            if parsed is not None:
+                return parsed
+        return None
+
+    def __init__(self, file: FileT, account_name: str, **kwargs):
+        import legacycrypt
+
+        self.crypt = legacycrypt
+        parsed = self.parse_etc_shadow(file, account_name)
+        if parsed is None:
+            raise ValueError(
+                f"Could not parse: {file} as /etc/shadow for account name: {account_name}"
+            )
+        self.shadow_hash_line, self.salt_arg = parsed
+
+    def __call__(self, candidate: str):
+        # Fiddlesticks doesn't care about timing attacks
+        # (its primary purpose is to enable the password owner's own attack!).
+        #
+        # But in general, don't directly compare strings for log-in purposes,
+        # (or any application in which the attacker can gain timing information).
+        return self.crypt.crypt(candidate, salt=self.salt_arg) == self.shadow_hash_line
+
+
 def save_ruled_out_indices_to_progress_file(
     indices: list[int],
     saved_progress_file: Path = DEFAULT_PROGRESS_FILE,
@@ -1055,7 +1103,7 @@ def check_passwords_in_parallel(
         return None
 
 
-default_Checkers = {
+default_file_checkers = {
     ".7z": SevenZipChecker,
     ".json": PyAvduAegisChecker,
     ".kdbx": PyKeepassChecker,
@@ -1076,10 +1124,24 @@ def _default_Checker_selector(*args: str):
             "Default checker requires arg(s) to define how to test the passwords"
         )
 
-    path = Path(args[0])
+    file_path: Path | None
+    for arg in args:
+        file_path = Path(arg)
+        if file_path.is_file():
+            break
+    else:
+        file_path = None
+
+    if len(args) == 1 and file_path is not None:
+        return default_file_checkers[file_path.suffix.lower()]
 
-    if len(args) == 1 and path.is_file():
-        return default_Checkers[path.suffix.lower()]
+    if len(args) == 2 and file_path is not None:
+        account_name = next((arg for arg in args if not Path(arg).is_file()), None)
+        if (
+            account_name is not None
+            and EtcShadowChecker.parse_etc_shadow(file_path, account_name) is not None
+        ):
+            return EtcShadowChecker
 
     return SubprocessChecker
 
@@ -1198,6 +1260,7 @@ parser.add_argument(
     help=(
         "Extra args to create the password checker with. "
         "E.g. file to find password for, "
+        "line from /etc/shadow"
         "or partial shell command, "
         "to which the password guesses will be appended, "
         "such as: 7z x archive.7z -p"
@@ -1264,6 +1327,7 @@ add_command_arg("--aegis", PyAvduAegisChecker)
 add_command_arg("--py7zr", Py7zrChecker)
 add_command_arg("--msoffice", MS_OfficeFilesKeyChecker)
 add_command_arg("--veracrypt", VeracryptChecker)
+add_command_arg("--etc-shadow-line", EtcShadowChecker)
 
 
 alt_char_map_group = add_mutex_group(
@@ -1383,7 +1447,7 @@ def cli(args: list[str] = sys.argv[1:]) -> int:
         and ns.verbosity == 0
     ):
         warnings.warn(
-            "The SSH key, Keepass and the Aegis vault checkers do not decrypt files. "
+            "The SSH key, Keepass, /etc/shadow, and the Aegis vault checkers do not decrypt files. "
             "When running fiddlesticks without print-passwords, without "
             "an output-file, and with verbosity=0, only the candidate index "
             "of any recovered password will be printed. "

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/tests/checker_tests.py

@@ -8,6 +8,7 @@ import pytest
 
 from fiddlesticks import (
     IS_WINDOWS,
+    EtcShadowChecker,
     MS_OfficeFilesKeyChecker,
     PyAvduAegisChecker,
     PyKeepassChecker,
@@ -22,6 +23,7 @@ from fiddlesticks import (
 
 from .helpers import (
     DOCX_FILE,
+    ETC_SHADOW,
     KDBX_TEST_VAULT,
     SEVEN_ZIP_TEST_ARCHIVE,
     XLSX_FILE,
@@ -204,3 +206,53 @@ def test_SSH_base_class_cannot_be_instantiated():
     ):
         with pytest.raises(TypeError):
             Class(file="some_key_file.pem")
+
+
+def test_EtcShadowChecker(tmp_path):
+    with EtcShadowChecker(ETC_SHADOW, "testymctestface") as checker:
+        assert not checker("incorrect_horse")
+        assert checker("correcthorse")
+
+    invalid_shadow_file = tmp_path / "invalid_etc_shadow.txt"
+    invalid_shadow_file.write_text("foo:\nbar:\n")
+    assert EtcShadowChecker.parse_etc_shadow(invalid_shadow_file, "baz") is None
+
+    with pytest.raises(ValueError):
+        EtcShadowChecker(invalid_shadow_file, "baz")
+
+
+def test_parse_etc_shadow_line():
+    valid_line = "foo:$6$salt$hash:0:0:0:0:::"
+    assert EtcShadowChecker._parse_etc_shadow_line(valid_line, "foo") == (
+        valid_line.split(":")[1],
+        "$6$salt",
+    )
+    # Line only contains no colons (":"s)
+    assert (
+        EtcShadowChecker._parse_etc_shadow_line(valid_line.replace(":", ";"), "foo")
+        is None
+    )
+    # Name not found
+    assert EtcShadowChecker._parse_etc_shadow_line(valid_line, "bar") is None
+    # Leading $ missing
+    assert (
+        EtcShadowChecker._parse_etc_shadow_line(
+            valid_line.replace("$", "", count=1), "foo"
+        )
+        is None
+    )
+    # Flag missing
+    assert (
+        EtcShadowChecker._parse_etc_shadow_line(valid_line.replace("$6", ""), "foo")
+        is None
+    )
+    # Salt missing
+    assert (
+        EtcShadowChecker._parse_etc_shadow_line(valid_line.replace("$salt", ""), "foo")
+        is None
+    )
+    # Hash missing
+    assert (
+        EtcShadowChecker._parse_etc_shadow_line(valid_line.replace("$hash", ""), "foo")
+        is None
+    )

fiddlesticks-0.7.0/tests/data_files/etc_shadow.txt

@@ -0,0 +1,2 @@
+username:$flag$salt$hash:last:logged:in:times:etc::
+testymctestface:$6$ToieP6Pt$BMSA.nEPerJ61R7iKPWApFPQ4DI1FYZlAHNOlAcsCoRVaIb1Kc8MN1N1WL5QiQOP2IJ0X5pfDbXU2BdUJtc5U0:20749:0:99999:7:::

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/tests/end_to_end_tests.py

@@ -17,6 +17,7 @@ from fiddlesticks import IS_WINDOWS
 from .helpers import (
     BI_MAP,
     DOCX_FILE,
+    ETC_SHADOW,
     KDBX_TEST_VAULT,
     SEVEN_ZIP_TEST_ARCHIVE,
     XLSX_FILE,
@@ -264,6 +265,21 @@ def test_bad_guess_with_all_cores_with_docx():
     assert result.returncode == 1
 
 
+def test_etc_shadow_checker_from_CLI_via_default():
+    result = subprocess.run(
+        _collate_args(
+            4,
+            ["c0rr3cthorse"],
+            ETC_SHADOW.as_posix(),
+            "testymctestface",
+            "--num-cores=1",
+        ),
+        capture_output=True,
+        check=False,
+    )
+    assert result.returncode == 0
+
+
 @pytest.mark.parametrize(
     "file",
     [DOCX_FILE],

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/tests/helpers.py

@@ -24,6 +24,7 @@ KDBX_TEST_VAULT = DATA_FILES / "Test_vault_Do_Not_Use.kdbx"
 SEVEN_ZIP_TEST_ARCHIVE = DATA_FILES / "foo.7z"
 XLSX_FILE = DATA_FILES / "test.xlsx"
 DOCX_FILE = DATA_FILES / "test.docx"
+ETC_SHADOW = DATA_FILES / "etc_shadow.txt"
 
 file_names = text(
     alphabet=string.ascii_letters + string.digits,

{fiddlesticks-0.6.0 → fiddlesticks-0.7.0}/tests/misc_tests.py

@@ -19,9 +19,11 @@ from hypothesis.strategies import composite, integers, lists
 
 from fiddlesticks import (
     IS_WINDOWS,
+    EtcShadowChecker,
     OpenSSHKeyChecker,
     SSHPEMKeyChecker,
     UnknownCPUCount,
+    _default_Checker_selector,
     _get_hopefully_incorrect_password,
     cli,
     get_cpu_count,
@@ -32,6 +34,7 @@ from fiddlesticks import (
 
 from .helpers import (
     DOCX_FILE,
+    ETC_SHADOW,
     SEVEN_ZIP_TEST_ARCHIVE,
     XLSX_FILE,
     _assert_output_on_found_password,
@@ -183,7 +186,7 @@ def test_msoffice_crypto_tools(path: Path):
     office_file.decrypt(stream)
 
 
-def test_offer_to_skip_indices_ruled_out_by_progress_file(tmp_path, capsys):
+def test_offer_to_skip_indices_ruled_out_by_progress_file_y(tmp_path, capsys):
     progress_file, indices = _create_random_progress_file(
         tmp_path / "test_progress_file.json"
     )
@@ -196,6 +199,19 @@ def test_offer_to_skip_indices_ruled_out_by_progress_file(tmp_path, capsys):
     capsys.readouterr()
 
 
+def test_offer_to_skip_indices_ruled_out_by_progress_file_n(tmp_path, capsys):
+    progress_file, _indices = _create_random_progress_file(
+        tmp_path / "test_progress_file.json"
+    )
+
+    with patch("builtins.input", side_effect=["n"]):
+        assert 0 == offer_to_skip_indices_ruled_out_by_progress_file(
+            force_resume=False,
+            saved_progress_file=progress_file,
+        )
+    capsys.readouterr()
+
+
 def test_bad_progress_file(tmp_path):
     progress_file = tmp_path / "test_progress_file.json"
     progress_file.write_text("{")  # Invalid JSON
@@ -289,3 +305,29 @@ def test_multiple_cores_to_let_coverage_measure_lines_properly(capsys):
     )
     assert 0 == retcode
     capsys.readouterr()
+
+
+def test_default_Checker_selector_two_files_EtcShadowChecker_not_Selected(tmp_path):
+    other_file = tmp_path / "foo.txt"
+    other_file.write_text("bar")
+
+    invalid_shadow_file = tmp_path / "invalid_etc_shadow.txt"
+    invalid_shadow_file.write_text("foo:\nbar:\n")
+
+    assert (
+        _default_Checker_selector(ETC_SHADOW.as_posix(), "testymctestface")
+        is EtcShadowChecker
+    )
+    assert (
+        _default_Checker_selector(ETC_SHADOW.as_posix(), "wrong_user")
+        is not EtcShadowChecker
+    )
+    assert EtcShadowChecker.parse_etc_shadow(ETC_SHADOW, other_file.as_posix()) is None
+    assert (
+        _default_Checker_selector(ETC_SHADOW.as_posix(), other_file.as_posix())
+        is not EtcShadowChecker
+    )
+    assert (
+        _default_Checker_selector(invalid_shadow_file.as_posix(), ETC_SHADOW.as_posix())
+        is not EtcShadowChecker
+    )

fiddlesticks-0.6.0/.github/workflows/benchmarks.yml

@@ -1,72 +0,0 @@
-name: Benchmarks
-
-on:
-  workflow_dispatch:
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    container:
-      image: ubuntu:26.04
-      # These are needed to run libfuse and mount 
-      # drives within the container for Veracrypt
-      options: >-
-        --device /dev/fuse
-        --cap-add SYS_ADMIN
-        --security-opt apparmor:unconfined
-        --privileged
-        -v /dev:/dev
-    steps:
-    - name: Check out repo
-      uses: actions/checkout@v7
-    
-
-    - name: Check Git hasn't corrupted test data files
-      run: |
-        sha256sum tests/data_files/Test_vault_Do_Not_Use.kdbx
-
-    - name: Install deps
-      run: |
-        apt-get update
-        apt-get install -y sudo wget git 7zip python3-venv python3-pip python-is-python3
-
-
-    - name: Direct Install libfuse3-4
-      run: |
-        sudo apt-get update && sudo apt-get install -y wget
-        wget http://archive.ubuntu.com/ubuntu/pool/main/f/fuse3/libfuse3-4_3.18.2-1_amd64.deb
-        sudo dpkg -i libfuse3-4_3.18.2-1_amd64.deb || sudo apt-get install -f -y
-
-    - name: Download Veracrypt .deb
-      run: wget https://github.com/veracrypt/VeraCrypt/releases/download/VeraCrypt_1.26.29/veracrypt-console-1.26.29-Ubuntu-26.04-amd64.deb
- 
-    - name: Install Veracrypt from downloaded .deb
-      run: |
-        sudo apt update
-        sudo apt install -y software-properties-common
-        sudo add-apt-repository universe
-        sudo apt-get update 
-        # Suggests fuse3
-        sudo apt-get install -y fuse3 libfuse3-dev
-        sudo apt-get install -y ./veracrypt-console-1.26.29-Ubuntu-26.04-amd64.deb  
-
-
-
-    - name: Create venv
-      run: |
-        python3 -m venv .venv
-
-    - name: Install dependencies
-      run: |
-        . ./.venv/bin/activate
-        pip install -e . --group=all_optional_deps
-
-
-    - name: Run Benchmarks
-      run: |
-        . ./.venv/bin/activate
-        python benchmarks.py --output-file benchmarks.txt --max-time-s=3540 --max-num-subs=6
-
-    - name: Print Benchmark results file
-      run: |
-        cat benchmarks.txt

fiddlesticks-0.6.0/.github/workflows/lint.yml

@@ -1,25 +0,0 @@
-name: Run pre-commit hooks
-
-on:
-  push:
-  pull_request:
-  workflow_dispatch:
-
-jobs:
-  pre-commit:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v7
-
-    - name: Install uv and set the python version
-      uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
-      with:
-        version: 0.12.7
-        python-version: "3.14"
-
-    - name: uv Sync project with all dependency groups (for type checker)
-      run: uv sync --group dev
-
-    - name: Run pre-commit
-      run: uv run pre-commit run --all-files --show-diff-on-failure --color=always
-      shell: bash

fiddlesticks-0.6.0/.pre-commit-config.yaml

@@ -1,23 +0,0 @@
-repos:
-- repo: local
-  hooks:
-    - id: ruff-check
-      name: ruff check
-      entry: uv run ruff check
-      language: system
-      pass_filenames: false
-    - id: ruff-format
-      name: ruff format
-      entry: uv run ruff format
-      language: system
-      pass_filenames: false
-    - id: ty
-      name: ty
-      entry: uv run ty check .
-      language: system
-      pass_filenames: false
-
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v6.0.0
-  hooks:
-    - id: check-yaml

fiddlesticks-0.6.0/dev/sketch_multicore.py

@@ -1,162 +0,0 @@
-import os
-import queue
-import sys
-from collections.abc import Iterable
-from multiprocessing import Process, Queue
-from pathlib import Path
-
-from fiddlesticks import (
-    Checker,
-    MS_OfficeFilesKeyChecker,
-    candidate_passwords_from_alt_chars,
-    save_ruled_out_indices_to_progress_file,
-)
-
-type IndexedGuessInfo = tuple[int, tuple[str, int]]
-
-
-class UnknownCPUCount(Exception):
-    pass
-
-
-def get_cpu_count() -> int:
-    cpu_count = (
-        os.process_cpu_count() if sys.version_info >= (3, 13) else os.cpu_count()
-    )
-    if cpu_count is None:
-        raise UnknownCPUCount(
-            f"Could not find number of CPU cores to run on, {cpu_count=}"
-        )
-    return cpu_count
-
-
-class Worker:
-    def __init__(
-        self,
-        found_passwords: Queue[IndexedGuessInfo],
-        guesses: Queue[IndexedGuessInfo],
-        incorrect_guess_indices: Queue[int],
-        checker_factory: type[Checker],
-        file: Path,
-    ):
-        self.found_passwords = found_passwords
-        self.guesses = guesses
-        self.incorrect_guess_indices = incorrect_guess_indices
-        self.checker = checker_factory(file=file)
-
-    def __call__(self):
-        with self.checker:
-            while self.get_and_check_next_guess():
-                pass
-
-    def get_and_check_next_guess(self) -> bool:
-
-        if not self.found_passwords.empty():
-            return False
-
-        try:
-            guess_info = self.guesses.get(timeout=10)
-        except queue.Empty:
-            return False
-
-        index, (guess, _num_subs) = guess_info
-
-        if self.checker(guess):
-            self.found_passwords.put(guess_info)
-
-            return False
-
-        self.incorrect_guess_indices.put(index)
-        return True
-
-
-def parent(
-    checker_factory: type[Checker],
-    file: Path,
-    guesses: Iterable[IndexedGuessInfo],
-    num_cores: int | None = None,
-    min_queue_size=1_000,
-    max_queue_size=10_000,
-):
-
-    guesses = iter(guesses)
-    queued_guesses: Queue[IndexedGuessInfo] = Queue(maxsize=max_queue_size)
-    incorrect_guess_indices: Queue[int] = Queue(maxsize=max_queue_size)
-    found_passwords: Queue[IndexedGuessInfo] = Queue(maxsize=1)
-
-    if num_cores is None:
-        num_cores = get_cpu_count()
-    print(f"Using {num_cores=}")
-
-    workers = [
-        Process(
-            target=Worker(
-                found_passwords,
-                queued_guesses,
-                incorrect_guess_indices,
-                checker_factory,
-                file,
-            ),
-            args=(),
-        )
-        for _ in range(num_cores - 1)
-    ]
-    parent_worker = Worker(
-        found_passwords, queued_guesses, incorrect_guess_indices, checker_factory, file
-    )
-
-    unqueued_candidates = True
-
-    for worker in workers:
-        worker.start()
-
-    with parent_worker.checker:
-        while found_passwords.empty():
-            approx_queue_size = queued_guesses.qsize()
-            if unqueued_candidates and approx_queue_size <= min_queue_size:
-                # Or while workers not timed out
-                guess_info = next(guesses, None)
-                if guess_info is None:
-                    unqueued_candidates = False
-                else:
-                    queued_guesses.put(guess_info)
-                    continue
-
-            indices: list[int] = []
-            while True:
-                try:
-                    index = incorrect_guess_indices.get_nowait()
-                except queue.Empty:
-                    break
-                indices.append(index)
-
-            save_ruled_out_indices_to_progress_file(indices)
-
-            more_work = parent_worker.get_and_check_next_guess()
-            if not more_work:
-                break
-
-    try:
-        return found_passwords.get_nowait()
-    except queue.Empty:
-        return None
-
-
-def main():
-    xlsx_file = Path(__file__).parent.parent / "tests" / "data_files" / "test.xlsx"
-    first_index = 0
-    total, guesses = candidate_passwords_from_alt_chars(
-        guesses=["te57"],
-        first_index=first_index,
-    )
-    print(f"{total=}")
-
-    parent(
-        checker_factory=MS_OfficeFilesKeyChecker,
-        file=xlsx_file,
-        guesses=guesses,
-    )
-
-
-if __name__ == "__main__":
-    main()

fiddlesticks-0.6.0/fiddlesticks_benchmarks.txt

@@ -1,7 +0,0 @@
-## Benchmarks
- - fiddlesticks v0.6.0.dev
- - guess='correcthorsebatterystaple'
-
-| Num subs |Num pwds | .xlsx/s | per pwd/ms | .kdbx/s | per pwd/ms | .json/s | per pwd/ms | .7z  /s | per pwd/ms | .key /s | per pwd/ms | .hc  /s | per pwd/ms |
-|----------|:-------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|:-------:|:----------:|
-|        0 |       1 |