xkcd936

README

Xkcd936

xkcd936 style passphrase generator with BIP32 word list.

Installation

To compile from the source, you need to have golang installed on the system.

git clone https://github.com/weakish/xkcd936
cd xkcd936
make install

To change installation path (default to /usr/local/bin), edit config.mk before running make.

To uninstall, run make uninstall.

The Makefile is compatible with both GNU make and BSD make.

Usage

As a Commandline Utility

Example output:

; xkcd936
subway modify spoil basic

To fulfill password requirements from some websites (white space is not allowed and/or mix case is required), xkcd936 can also output titlized words:

; xkcd936 -t
AdvanceJealousDevelopSenior

By default, xkcd936 will generate four words, consistent with the [xkcd936] comic. But xkcd936 can generate up to 12 words with the number specified in -n.

By default, the BIP32 English word list is used. To use a BIP32 word list in another language, specify it in -l.

Some diceware-derived lists can also be used:

- `diceware{1,2,3,4}`: four lists split from [diceware8k], containing 2048 words each.
- `diceware2k`: [a wordlist derived from diceware8k][diceware2k], containing 2048 short words.

As a Library

import (
	"github.com/weakish/xkcd936/xkcd936"
)

var words []string = xkcd936.Words(4) // e.g. []string{"cannon", "isolate", "soccer", "word"}
var phrase string = xkcd936.Phrase(words, true) // e.g. "CannonIsolateSoccerWord"

License

0BSD