Project

paperback

0.0
Low commit activity in last 3 years
No release in over a year
Paperback is a library for creating printable paper backups of small amounts of sensitive data like cryptographic keys.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
~> 3.0
~> 0.50
>= 0
~> 2.0
~> 0.5
~> 0.10

Runtime

~> 1.3
~> 0.10
~> 0.3
 Project Readme

Paperback

Gem Version Inline Docs Test status

Paperback is a library that facilitates the creation of paper offline backups of small amounts of important data, such as encryption keys.

It is designed to be used for long-term paper storage. Arbitrary data to be backed up is encoded using QR codes, sixword English text, and Base64.

Nothing else approaches the durability and inexpensiveness of paper. This library is designed to facilitate the restoration process, which would be tedious and error-prone when using human typists or even OCR.

The QR code is easily machine readible, the sixword text is easiest to transcribe for humans, and the Base64 serves as a fallback for broadest compatibility.

By default, the backup data is GPG-encrypted with a symmetric passphrase to avoid exposing data to the printer (or scanner, assuming you cover the passphrase when scanning).

The printed document does contain the SHA256 digest of the original content for error correction, which is not a problem for random data like keys. But if you are backing up low-entropy secrets and want to preserve the printer-blindness property, pad the content with a random salt or encrypt it before using paperback.

Usage

Typical usage will be through the paperback executable. Use the --help option for a usage menu.

# Back up the content in data.key
paperback data.key out.pdf

Sample output

See sample directory

sample page one sample page two

More complex patterns

See the YARD documentation.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request