24ec5f4c78137d63a81307be4036d2a06d0a1e30
Marco Ricci Import initial project files

Marco Ricci authored 7 months ago

1) # derivepassphrase
2) 
3) [![PyPI - Version](https://img.shields.io/pypi/v/derivepassphrase.svg)](https://pypi.org/project/derivepassphrase)
4) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/derivepassphrase.svg)](https://pypi.org/project/derivepassphrase)
5) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

6) An almost faithful Python reimplementation of [James Coglan's `vault`][VAULT], a deterministic password manager/generator.
7) 
8) Using a master passphrase or a master SSH key, derive a passphrase for a given named service, subject to length, character and character repetition constraints.
9) The derivation is cryptographically strong, meaning that even if a single passphrase is compromised, guessing the master passphrase or a different service's passphrase is computationally infeasible.
10) The derivation is also deterministic, given the same inputs, thus the resulting passphrase need not be stored explicitly.
11) The service name and constraints themselves also need not be kept secret; the latter are usually stored in a world-readable file.
Marco Ricci Import initial project files

Marco Ricci authored 7 months ago

12) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

13) [VAULT]: https://getvau.lt
Marco Ricci Import initial project files

Marco Ricci authored 7 months ago

14) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

15) -----
Marco Ricci Import initial project files

Marco Ricci authored 7 months ago

16) 
17) ## Installation
18) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

19) ### With `pip`
20) 
Marco Ricci Include explanation for vir...

Marco Ricci authored 3 months ago

21) (If not inside a [virtual environment][VENV], use `pip install --user` instead of plain `pip install`.)
22) 
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

23) ```` shell-session
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

24) $ pip install derivepassphrase
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

25) ````
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

26) 
Marco Ricci Include explanation for vir...

Marco Ricci authored 3 months ago

27) To use the `export` subcommand, install the `export` extra:
28) 
29) ```` shell-session
30) $ pip install "derivepassphrase[export]"
31) ````
32) 
33) [VENV]: https://docs.python.org/3/library/venv.html
34) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

35) ### Manually
36) 
Marco Ricci Update package dependencies...

Marco Ricci authored 5 months ago

37) `derivepassphrase` is a pure Python package, and may be easily installed manually by placing the respective files and the package's dependencies into Python's import path.
38) `derivepassphrase` requires Python 3.10 or higher as well as the [typing-extensions package][TYPING_EXTENSIONS] for its core functionality and programmatic interface, and [`click`][CLICK] 8.1 or higher for its command-line interface.
Marco Ricci Fix version typo in README

Marco Ricci authored 3 months ago

39) Using the `export vault` subcommand additionally requires the [cryptography package][CRYPTOGRAPHY], version 38.0 or newer.
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

40) 
Marco Ricci Update package dependencies...

Marco Ricci authored 5 months ago

41) [TYPING_EXTENSIONS]: https://pypi.org/project/typing-extensions/
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

42) [CLICK]: https://click.palletsprojects.com/
Marco Ricci Reintegrate all functionali...

Marco Ricci authored 3 months ago

43) [CRYPTOGRAPHY]: https://github.com/pyca/cryptography
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

44) 
45) ## Quick Usage
46) 
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

47) ```` shell-session
Marco Ricci Reintegrate all functionali...

Marco Ricci authored 3 months ago

48) $ derivepassphrase vault -p --length 30 --upper 3 --lower 1 --number 2 --space 0 --symbol 0 my-email-account
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

49) Passphrase: This passphrase is for demonstration purposes only.
50) JKeet7GeBpxysOgdCEJo6UzmP8A0Ih
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

51) ````
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

52) 
53) Some time later…
54) 
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

55) ```` shell-session
Marco Ricci Reintegrate all functionali...

Marco Ricci authored 3 months ago

56) $ derivepassphrase vault -p --length 30 --upper 3 --lower 1 --number 2 --space 0 --symbol 0 my-email-account
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

57) Passphrase: This passphrase is for demonstration purposes only.
58) JKeet7GeBpxysOgdCEJo6UzmP8A0Ih
Marco Ricci Fix minor formatting detail...

Marco Ricci authored 5 months ago

59) ````
Marco Ricci Import initial project files

Marco Ricci authored 7 months ago

60) 
Marco Ricci Fill out README and documen...

Marco Ricci authored 5 months ago

61) (The user input `This passphrase is for demonstration purposes only.` for the passphrase prompt is not actually displayed on-screen.)
62)