Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elforastero/gpgqr
🔑 A tool to backup and restore secret GPG keys using printable QR codes
https://github.com/elforastero/gpgqr
backup gpg openpgp paperkey pgp qrcode
Last synced: 14 days ago
JSON representation
🔑 A tool to backup and restore secret GPG keys using printable QR codes
- Host: GitHub
- URL: https://github.com/elforastero/gpgqr
- Owner: ElForastero
- Created: 2022-04-12T20:03:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-13T19:50:11.000Z (almost 3 years ago)
- Last Synced: 2024-11-12T00:37:39.933Z (2 months ago)
- Topics: backup, gpg, openpgp, paperkey, pgp, qrcode
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔑 → GPGQR → 🏞 → 🖨
> **gpgqr** helps to back up secret GPG keys as QR codes that may be printed
### Requirements
- https://github.com/google/zx
- `split` or `gsplit` for MacOS
- `paperkey`
- `qrencode`
- `zbarimg`
## Creating backup
1. ☝️ Install all the dependencies above.
2. 🔑 Check if you have your secret keys on your machine:
```bash
$ gpg -K
/var/folders/jx/5ll9xg7166945zr_jrzh423m0000gn/T/gnupg_202204132230_XXX.6TZDeVqr/pubring.kbx
--------------------------------------------------------------------------------------------
sec rsa4096 2022-04-13 [SC]
5E4A60CDCE1374ADE9D4B42E311366FBF780DB86
uid [ultimate] Eugene Dzhumak
ssb rsa4096 2022-04-13 [E]
```
If you see a hash symbol near the key type (`sec#`), it means your key is not on your machine. Did you store it offline
on a USB drive?
3. 🏞 Run backup script providing your key identifier:
```bash
$ ./backup.mjs 5E4A60CDCE1374ADE9D4B42E311366FBF780DB86
rm -f generated/*
cp index.html generated/
gpg --export-secret-key 5E4A60CDCE1374ADE9D4B42E311366FBF780DB86 | paperkey --output-type raw | base64 | gsplit -C 1500 -d -a 2 - generated/temp-chunk-
cat generated/temp-chunk-00
qrencode -l L -o generated/qr-1.png
cat generated/temp-chunk-01
qrencode -l L -o generated/qr-2.png
cat generated/temp-chunk-02
qrencode -l L -o generated/qr-3.png
```
4. 🖨 Open `./generated/index.html` in your browser and print the page or save it as PDF (
see [example](example/example.pdf))
5. ✨ You are awesome ✨
## Restoring
To restore secret keys you need to have your public key, what usually is not a problem.
1. 🏞 Place QR images inside `/generated` folder naming them with number suffix for proper sorting (like `qr-1.png`)
2. 🔐 Run the script providing a path to your public key file (binary, not armored)
```bash
$ ./restore.mjs ~/pubkey.gpg
zbarimg -q --raw ./generated/*.png | base64 -d | paperkey --pubring /Users/eugenedzhumak/pubkey.gpg | gpg --import
gpg: key 311366FBF780DB86: public key "Eugene Dzhumak " imported
gpg: key 311366FBF780DB86: secret key imported
gpg: Total number processed: 1
gpg: imported: 1
gpg: secret keys read: 1
gpg: secret keys imported: 1
```
3. ✅ Done. Check your GPG keys, they were restored:
```bash
$ gpg --list-secret-keys
/var/folders/jx/5ll9xg7166945zr_jrzh423m0000gn/T/gnupg_202204132230_XXX.6TZDeVqr/pubring.kbx
--------------------------------------------------------------------------------------------
sec rsa4096 2022-04-13 [SC]
5E4A60CDCE1374ADE9D4B42E311366FBF780DB86
uid [ unknown] Eugene Dzhumak
ssb rsa4096 2022-04-13 [E]
$ gpg --list-public-keys
/var/folders/jx/5ll9xg7166945zr_jrzh423m0000gn/T/gnupg_202204132230_XXX.6TZDeVqr/pubring.kbx
--------------------------------------------------------------------------------------------
pub rsa4096 2022-04-13 [SC]
5E4A60CDCE1374ADE9D4B42E311366FBF780DB86
uid [ unknown] Eugene Dzhumak
sub rsa4096 2022-04-13 [E]
```
### Links and credits
- [Paperkey - an OpenPGP key archiver](https://www.jabberwocky.com/software/paperkey/)
- [Paperkey ArchWiki](https://wiki.archlinux.org/title/Paperkey)
- [Create a paper backup of your GPG key](https://medium.com/@johnnymatthews/create-a-paper-backup-of-your-gpg-key-5e43894c59a)
- [Producing printable QR codes for persistent storage of GPG private keys](https://gist.github.com/joostrijneveld/59ab61faa21910c8434c)
- https://github.com/balos1/easy-gpg-to-paper