fuguseed-qr(1)
NAME
fuguseed-qr — turn
12 seed words into a Standard SeedQR
SYNOPSIS
fuguseed-qr |
DESCRIPTION
fuguseed-qr reads 12 seed words from the
first line of standard input. It prints a Standard SeedQR as text, zone by
zone, so that a person can draw the code on paper. The program takes no
option and no argument.
The words enter on standard input only. No argument, no file name, and no environment variable carries a word. The program opens no file, it starts no other program, and it reads no environment variable. The three standard streams are its one contact with the computer.
fuguseed-qr sees the seed words. Run it on
an air-gapped computer only.
The input
The first line of standard input holds the 12 words, with one space between two words. Each word must be a word of the English word list of BIP39.
The result
fuguseed-qr prints the SeedQR. Standard
output holds the digit string on the first line: the 12 word indexes,
0-based, each as 4 decimal digits. The grid view of the 25 rows follows, and
then the 25 zone views, from “A-1” to “E-5”. A
dark module prints as a number sign, and a light module prints as a period.
A zone view holds the zone name, the 5 rows of the zone, and the count of
the dark modules of the zone.
After each zone view, the program reads one line from standard input. Press the return key to get the next zone. At the end of the input, the remaining zones print without a pause.
The checksum
Word 12 must be the check word of words 1 to 11. fuguseed-last(1) prints that word.
With a wrong checksum, fuguseed-qr prints
one line to standard error, and it prints no SeedQR. A wrong word at any
position can give that failure. Compare the 12 words that you typed with the
paper, word for word. When a typed word is different from the paper, correct
the word. Then start the program again.
When the typed words agree with the paper, a word on the paper is wrong. When the procedure of fuguseed(7) gave the words, word 12 is wrong. That page gives the steps that correct word 12.
The form of the code
The output is a Standard SeedQR of 25 x 25 modules. It is not a
Compact SeedQR: fuguseed-qr prints no Compact
SeedQR. A Standard SeedQR decodes to the digit string, so a person can map
the digits back to the 12 words. A consumer such as FuguPass reads the
SeedQR with a camera, and it reads no typed word.
The check of the file
The release publishes fuguseed-qr as one
file, beside the tarballs. The signed SHA256 manifest of the release names
that file. Compare the digest of the file with the manifest on the
air-gapped computer, before the first run:
$ sha256 fuguseed-qrThe two digests must agree. Do not run a file with a different digest.
The drawing procedure
WARNING: The SeedQR is the 12 words in another form. A person who scans the code gets the seed. Keep the paper as you keep the words. Do not photograph the code, and do not put it on a computer. A loss of the words is irreversible.
The procedure needs an air-gapped computer, a printed 25 x 25 template, and a marker. The template is the printable 25 x 25 template of the SeedQR specification, or a grid with the same zones. The template must hold a quiet zone of 4 light modules around the code. Each module must be 5 mm or more, because the drawing must scan under a camera.
Do these steps:
- Start
fuguseed-qron the air-gapped computer, and type the 12 words. - Find the zone of the template with the name of the zone view.
- Fill one square of that zone for each dark module of the zone view.
- Count the filled squares of the zone. The count must agree with the count of the zone view.
- Press the return key, and do the same for each of the other 24 zones.
- Compare the grid view with the template, row by row.
- Scan the drawing with the camera of the device. The device must show the 12 words, in the same order.
The scan proves the drawing. Do the scan before you keep the paper, and before you erase the words from the air-gapped computer.
EXIT STATUS
- 0
fuguseed-qrprinted the SeedQR.- 1
- The input did not hold 12 words of the list, or the checksum of the 12
words failed.
fuguseed-qrprinted one line to standard error. That line holds no word. - 2
- The command line held an argument.
fuguseed-qrprinted one usage line to standard error.
EXAMPLES
Start the program on the air-gapped computer:
$ fuguseed-qr
The program waits for the 12 words on standard input.
SEE ALSO
STANDARDS
The word list and the checksum come from BIP39, the mnemonic code for the generation of a deterministic key. The form of the code comes from the SeedQR specification of the SeedSigner project. The QR code follows ISO/IEC 18004: version 2, error correction level L, numeric mode, and mask pattern 0.
AUTHORS
Dick Olsson <hi@senzilla.io>
CAVEATS
The program prints no penalty score and it selects no mask. The mask is pattern 0, always. Every reader decodes the code, because the format information names the mask.