wneessen/apg-go
1
1
Fork 0
mirror of https://github.com/wneessen/apg-go.git synced 2024-11-22 13:50:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

More README.md updates

Browse source
This commit is contained in:
Winni Neessen 2021-09-23 16:32:03 +02:00
parent cdf0237034
commit 1b393d8692
2 changed files with 24 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.idea/workspace.xml
View file

@ -4,8 +4,7 @@
<option name="autoReloadType" value="ALL" /> <option name="autoReloadType" value="ALL" />
</component> </component>
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="e32960c0-29e5-4669-9fc2-ef12314486ce" name="Changes" comment="Minor code cleanups and updated README to reflect #27"> <list default="true" id="e32960c0-29e5-4669-9fc2-ef12314486ce" name="Changes" comment="README.md updated">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" /> <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
</list> </list>
<option name="SHOW_DIALOG" value="false" /> <option name="SHOW_DIALOG" value="false" />
@ -84,7 +83,8 @@
<MESSAGE value="IDE settings..." /> <MESSAGE value="IDE settings..." />
<MESSAGE value="Added pronounceable passwords #27" /> <MESSAGE value="Added pronounceable passwords #27" />
<MESSAGE value="Minor code cleanups and updated README to reflect #27" /> <MESSAGE value="Minor code cleanups and updated README to reflect #27" />
<option name="LAST_COMMIT_MESSAGE" value="Minor code cleanups and updated README to reflect #27" /> <MESSAGE value="README.md updated" />
<option name="LAST_COMMIT_MESSAGE" value="README.md updated" />
</component> </component>
<component name="VgoProject"> <component name="VgoProject">
<integration-enabled>true</integration-enabled> <integration-enabled>true</integration-enabled>

38
README.md
View file

@ -197,7 +197,7 @@ the desired length by one complete syllable (which can be up to 3 characters lon
randomly created passwords, due to the nature how syllables work. As a rule of thumb, it is recommended randomly created passwords, due to the nature how syllables work. As a rule of thumb, it is recommended
to multiply the length of your generated pronouncable passwords by at least 1.5 times, compared to truly to multiply the length of your generated pronouncable passwords by at least 1.5 times, compared to truly
randomly generated passwords. It might also be helpful to run the pronoucable password mode with enabled randomly generated passwords. It might also be helpful to run the pronoucable password mode with enabled
"HIBP" flag, so that each generated password is automatically checked against "Have I Been Pwned" "[HIBP](#have-i-been-pwned)" flag, so that each generated password is automatically checked against "Have I Been Pwned"
database. database.
```shell ```shell
$ ./apg-go -a 0 -n 1 $ ./apg-go -a 0 -n 1
@ -222,23 +222,27 @@ connectivity, but also might take between 500ms to 1s to complete. When you gene
of password `-n 100`, the process could take much longer than without the `-p` feature enabled. of password `-n 100`, the process could take much longer than without the `-p` feature enabled.
## CLI parameters ## CLI parameters
_apg-go_ replicates some of the parameters of the original APG. Some parameters are different though: _apg-go_ replicates most of the parameters of the original c-apg. Some parameters are different though:
- ```-m <length>```: The minimum length of the password to be generated (Default: 12) - `-a <algorithm>`: Choose password generation algorithm (Default: 1)
- ```-x <length>```: The maximum length of the password to be generated (Default: 20) - `0`: Pronouncable password generation (Koremutake syllables)
- ```-n <number of passwords>```: The amount of passwords to be generated (Default: 6) - `1`: Random password generation according to password modes/flags
- ```-E <list of characters>```: Do not use the specified characters in generated passwords - `-m <length>`: The minimum length of the password to be generated (Default: 12)
- ```-M <[LUNSHClunshc]>```: New style password parameters (upper-case enables, lower-case disables) - `-x <length>`: The maximum length of the password to be generated (Default: 20)
- ```-L```: Use lower-case characters in passwords (Default: on) - `-n <number of passwords>`: The amount of passwords to be generated (Default: 6)
- ```-U```: Use upper-case characters in passwords (Default: on) - `-E <list of characters>`: Do not use the specified characters in generated passwords
- ```-N```: Use numeric characters in passwords (Default: on) - `-M <[LUNSHClunshc]>`: New style password parameters (upper-case enables, lower-case disables)
- ```-S```: Use special characters in passwords (Default: off) - `-L`: Use lower-case characters in passwords (Default: on)
- ```-H```: Avoid ambiguous characters in passwords (i. e.: 1, l, I, o, O, 0) (Default: off) - `-U`: Use upper-case characters in passwords (Default: on)
- ```-C```: Generate complex passwords (implies -L -U -N -S and disables -H) (Default: off) - `-N`: Use numeric characters in passwords (Default: on)
- ```-l```: Spell generated passwords (Default: off) - `-S`: Use special characters in passwords (Default: off)
- ```-p```: Check the HIBP database if the generated passwords was found in a leak before (Default: off) // *this feature requires internet connectivity* - `-H`: Avoid ambiguous characters in passwords (i. e.: 1, l, I, o, O, 0) (Default: off)
- ```-h```: Show a CLI help text - `-C`: Generate complex passwords (implies -L -U -N -S and disables -H) (Default: off)
- ```-v```: Show the version number - `-l`: Spell generated passwords in random password mode (Default: off)
- `-t`: Spell generated passwords in pronouncable password mode (Default: off)
- `-p`: Check the HIBP database if the generated passwords was found in a leak before (Default: off) // *this feature requires internet connectivity*
- `-h`: Show a CLI help text
- `-v`: Show the version number
## Contributors ## Contributors
Thanks to the following people for contributing to the apg-go codebase: Thanks to the following people for contributing to the apg-go codebase: