emma/Java
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation for passgen

Browse source
This commit is contained in:
Emma Nora Theuer 2024-09-07 14:05:52 +02:00
parent 7e3b23eb88
commit 0730a10628
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.org
View file

@ -20,7 +20,7 @@ This doesn't need much explaining. It's a simple fizzbuzz. I used this to motiva
A short, simple script that asks the user for nationality and displays a lucky number based on that input. It was a quick and dirty script that I did very early, mostly to get me familiar with String comparison and conditionals. I would probably do it a bit differently by now (use a switch statement instead of an if-else chain) and use a random number generator for people who aren't German or Polish. Part of why I did that project also just was a 2137 joke lol A short, simple script that asks the user for nationality and displays a lucky number based on that input. It was a quick and dirty script that I did very early, mostly to get me familiar with String comparison and conditionals. I would probably do it a bit differently by now (use a switch statement instead of an if-else chain) and use a random number generator for people who aren't German or Polish. Part of why I did that project also just was a 2137 joke lol
** Passgen/ ** Passgen/
Passgen (Also known as this took 5 minutes, half the code and no packaging in python) is a very simple project, actually. It generates a cryptographically secure password using a simple cli (Using picocli). This was meant to be a lot less work because I did not expect needing a third party library and maven (and as such a pom.xml file) for this to work correctly. It can generate an xkcd-style password (See [[https://xkcd.com/936][xkcd-936]] for more), a password using letters and numbers and using letters, numbers and special characters. The length is variable. A bit on how it works: Passgen (Also known as this took 5 minutes, half the code and no packaging in python) is a very simple project, actually. It generates a cryptographically secure password using a simple cli (Using picocli). This was meant to be a lot less work because I did not expect needing a third party library and maven (and as such a pom.xml file) for this to work correctly. It can generate an xkcd-style password (See [[https://xkcd.com/936][xkcd-936]] for more), a password using letters and numbers and using letters, numbers and special characters. XKCD-Style passwords as of now only work on linux and require a dictionary file at /usr/share/dict/words. The length is variable. A bit on the usage:
+ -x --xkcd will generate an xkcd style password + -x --xkcd will generate an xkcd style password
+ -s --simple will generate a password only using letters and numbers + -s --simple will generate a password only using letters and numbers
+ -l --length sets the length of the password. For regular passwords and simple passwords, this determines the length, for xkcd passwords the amount of words. + -l --length sets the length of the password. For regular passwords and simple passwords, this determines the length, for xkcd passwords the amount of words.