raspberryaether / dwpwg Goto Github PK

dwpwg currently offers a middle ground between security and convenience. However, we should add the ability to simply generate a new printable code book; that way passwords could be generated offline.

Acceptance criteria:

• A command line option is present which outputs a printable PDF file (or, optionally, a raw text file) of the generated codebook
• README is updated with new method

The "classic" Diceware algorithm calls for 7776 unique words in a list, indexed by all possible permutations of 5 six-sided dice. Using 20-sided dice, @ospalh was able to reduce the number of dice needed to index these words to three.

Unfortunately, not everyone has multiple d20s lying around. More unfortunately yet, not everyone has a d20 at all. And still more unfortunate than that is the fact that probably a great number of humans do not know what a d20 is.

Six-sided dice, however, are everywhere. Therefore, dwpwg should be extended to support dice with 6 faces.

Acceptance criteria:

• Generation of wordlists and passphrases using dice with 6 faces is supported.
• The readme is updated to mention 6-sided dice.

Implement an "audit" mode to provide the ability to swap out undesirable (vulgar and/or hard to remember or spell) words.

A suggested mode of implementation:

1. The word is printed, upon which the user is prompted "(K)eep? (D)iscard? (B)ack? ".
   a. Keep will result in the current word being added to the revised wordlist and the next word being shown.
   b. Discard will show the next word. The current word will not be added.
   c. Back will remove the previous word added to the revised wordlist and present it again for decision.
2. The user is prompted for a filename in which to save the revised wordlist.

Acceptance Criteria:

• A wordlist audit mode such as the one described above is implemented.
• A mechanism is present to use the customized wordlists.
• The readme is updated with an explanation of the new mode.

Currently input is somewhat inconvenient as input is rather unconstrained and may cause undefined behavior. Output is also unnecessarily verbose and cryptic.

We should change this. Currently after a newline is used to lock in a roll, a new prompt shows the number of rolls remaining. There is no way to revise prior rolls. We should instead use the following state-based model:

• Rearrange output to a grid structure, with N columns where N is the number of rolls per word.
• When N cells are confirmed, the corresponding word is printed at the end of the line and the cursor moves to the first cell on the next line.
• In any cell:
  • Numeric input is only accepted if it would result in a valid roll. Otherwise, an alert bell is emitted.
• In an empty cell:
  • [Backspace] or [-] moves the cursor to the end of the previous cell or emits an alarm bell if this is not possible.
  • [Enter] or [.] emits an alarm bell.
• In a non-empty cell:
  • [Backspace] or [-] removes the most recently entered digit and puts the cursor in its place.
  • [Enter] or [.] locks in the roll and moves the cursor to the next cell.

Acceptance criteria:

• Input and output follows the new scheme detailed above.
• Behavior is tested both with a terminal emulator and a Windows command prompt.

The wordlist is currently not shuffled before being indexed by the dice throws.

Reproduction instructions:

1. Run python -m dwpwg 1
2. Input 1 three times.
3. Generated word will be aachen, every time.

Package should be submitted to PyPI to simplify the install process.

Acceptance criteria:

• Nice installable package using setuptools
• A proper entry point is registered such that installation results in a "dwpwg" command in path
• README reflects new installation method
• Submitted to PyPI

In addition to a number of words, we should also accept a format string which allows a password to be generated entirely programmatically if a user wishes to insert other characters between/after the words.

For example, the command: $ python -m dwpwg {@}-{+}-{.}-{.}-{#100}
Might output the password: CORRECT-Horse-battery-staple-42

Acceptance criteria:

• a format string scheme is implemented as described above
• README documents new scheme