Metadata-Version: 2.5
Name: fiddlesticks
Version: 0.1.0
Summary: Password recovery tool for encrypted archives (currently only .7z files supported).
Project-URL: GitHub, https://github.com/Hazardous-Area/fiddlesticks
Author-email: James Parrott <james@jamesparrott.dev>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Provides-Extra: aegis
Requires-Dist: py-avdu; extra == 'aegis'
Provides-Extra: py7zr
Requires-Dist: py7zr; extra == 'py7zr'
Provides-Extra: tests
Requires-Dist: hypothesis; extra == 'tests'
Requires-Dist: pytest; extra == 'tests'
Description-Content-Type: text/markdown

# Fiddlesticks!
*"Aaaagh!  I forgot my 7zip password"* - James (more times than he cares to remember).
![Tests passing](https://github.com/Hazardous-Area/fiddlesticks/actions/workflows/tests.yml/badge.svg)

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

### 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 
every candidate password that's similar enough to the guess.  
 - This may be a much faster and cheaper computation
than the one an adversary must do, without such a guess, but in possession 
of a stolen password protected file[^0].

### Warning
Strictly speaking, Fiddlesticks is a password-protected file recovery tool.  Use it to 
get your files back.  But once you've found a password that protected those files via Fiddlesticks
(or any third party tool) it should not be used again.  Anywhere else it is also used, the 
password should be reset (or the files re-encrypted with a different one).  By default,
Fiddlesticks does not print the password it finds (or any candidates) unless `-P` or `-v` is set 
(or if using `--pipe` with no pipe).

### "Back of envelope" sketch 'calculation'
 - Attackers targetting a truly[^0] random password, must try up to `2**N` 
 candidate passwords (for each bit length `N` being considered). 
 - Specifically, password owners may only need to consider every candidate within some 
 maximum [Weighted-Levenshtein distance](https://en.wikipedia.org/wiki/Edit_distance#Types_of_edit_distance) 
 from their best guess of the forgotten password, lets say a total of `M`.  
 - Fiddlesticks is intended to assist recovering passwords from "close enough" guesses, 
 when `M` is much smaller than `2**N`.
 - If Fiddlesticks can crack an archive's password with a starting guess of an empty string, 
(if `2**N` is also small enough to be feasible, with no guess) then anyone with the 
archive can also do so - the password wasn't strong enough.
 - If Fiddlesticks fails to crack an archive's password given some starting guess, a lower
 bound on how similar the actual password is to the starting guess can still be deduced
 (e.g. this could indicate that the starting guess was wrong).

 ### Design and security notes
 *"FAQ: Why the heck should anyone in their right mind trust this with their password?"*
 - Any similar 3rd party password cracking service based on 'best guess' passwords, requires 
 the user to share the guesses for their passwords with the service.  Even if the password
 was not used for anything else, sharing even guesses for secret credentials with 3rd parties, 
 is a critical security issue.
 - Fiddlesticks is designed to minimise the need for this.  It is designed to both i) require as 
 few dependencies as possible, and ii) be as easy to install as possible.  
 The intention is ii) assists users to run Fiddlesticks in their own secure
 environment, locked down as much as they want, without requiring them to take their 
 password guesses outside of that.  Only stock 7zip is required.  Fiddlesticks can even 
 generate a file of candidate passwords, for any possible application.  Secondly
 i) helps users decide for themselves whether or not to trust Fiddlesticks 
 in the first place.  In particular whether or not it will take their password guesses outside
 of its running environment.  When the project was concieved, the intention was also to 
 iii) require as little code as possible.  But the code base has since become somewhat more 
 complex, mainly in order to have a nice CLI.  Simplicity and brevity should both be much 
 more highly prized features of any software, than they are.  But you 
 be the judge of whether or not c) is still the case.  It's only a single ~500 line file.

### Usage
Recommended use is simply to automate attempts to open a 7z archive via the user's own 7zip.
Fiddlesticks can also try to decrypt Aegis vault files (for TOTP authenticators) if [py-avdu](https://pypi.org/project/py-avdu/) is also installed.

There are a couple of alternative modes too, firstly: automating any other external Bash command that a candidate password can be appended to (that obeys the normal return code convention).

Secondly with `--pipe` candidate passwords can be sent to stdout, from where they can be piped to a user's own external program or code (all the normal output from fiddlesticks goes to stderr).

Thirdly, if py7zr is also installed, with `--py7zr` fiddlesticks can use it to test passwords for 7z archives,
 entirely within Python.

### Other Notes
 - Successful attempts to extract a password-protected archive, result in the archive being
 unencrypted (naturally) by some methods.  Currently all such plaintext unencrypted archives 
 are not deleted from the file system afterwards.  If the options `--extract-to` or `-x` 
 are given, archives are extracted there.
 - Fiddlesticks cannot recover passwords for online accounts.  Online password entry attempts 
 should be rate limited.  Cracking is only possible locally if the website owner shares the 
 password hash with the user, in which case they can probably provide the rest of their 
 account data too.
 - If Fiddlesticks fails to 'crack' or find a known password, this should not be taken as 
 proof of the password's strength.  It won't ever be possible to think everything, and
 we certainly don't wish users to draw a false sense of security from Fiddlesticks.

## Alternatives
 - https://github.com/philsmd/7z2hashcat
 - https://en.wikipedia.org/wiki/Dictionary_attack#Dictionary_attack_software

[^0] Truly random passwords are difficult for humans to remember (without writing them down or saving them).
At the very least, real world adversaries (posessing a stolen file or password hash) are likely to first attempt a [dictionary attack](https://en.wikipedia.org/wiki/Dictionary_attack#Dictionary_attack_software)