Skip to content

docs: Size recovery cards to the backup length #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BenWestgate wants to merge 1 commit into
base: reviewability-v1
Choose a base branch
from
+93 −19
Open

docs: Size recovery cards to the backup length #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ codex32 strings.
Printable forms:

- [codex32 recovery card](docs/user/recovery-card.html)
- [codex32 recovery card, 256-bit](docs/user/recovery-card-256.html)
- [wallet-verification record](docs/user/wallet-verification-record.html)

## For developers and reviewers
Expand Down
4 changes: 3 additions & 1 deletion docs/user/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ You will need:
- Bitcoin Core 32 or newer, with its local RPC server enabled and
`bitcoin-cli` available on `PATH`;
- codex32 installed using the [README instructions](../../README.md#install);
- one blank [codex32 recovery card](recovery-card.html) per secret or share; and
- one blank codex32 recovery card per secret or share: the
[standard card](recovery-card.html) for 48-character backups (128-bit), or
the [256-bit card](recovery-card-256.html) for 74 characters; and
- a separately stored [wallet-verification record](wallet-verification-record.html).

Before running `create` for a real wallet, have your blank cards, a pen, and
Expand Down
72 changes: 72 additions & 0 deletions docs/user/recovery-card-256.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>codex32 recovery card: 74 characters</title>
<style>
@page { size: letter landscape; margin: 0.35in; }
* { box-sizing: border-box; }
body { color: #111; font: 11pt/1.25 sans-serif; margin: 0 auto; max-width: 10.3in; }
h1 { font-size: 19pt; margin: 0 0 0.08in; }
h2 { font-size: 12pt; margin: 0.13in 0 0.05in; }
p, ol { margin: 0.05in 0; }
.warning { border: 2px solid #111; font-weight: bold; padding: 0.08in; }
.fields { display: grid; gap: 0.08in 0.18in; grid-template-columns: 1fr 1fr; }
.field { border-bottom: 1px solid #111; min-height: 0.28in; }
.groups { counter-reset: box; display: flex; flex-wrap: wrap; gap: 0.1in 0.3in; }
.block { display: flex; gap: 0.08in; }
.group { border: 1px solid #555; height: 0.4in; position: relative; width: 0.72in; }
.group::before { color: #999; content: counter(box); counter-increment: box; font-size: 6pt;
left: 0.03in; position: absolute; top: 0.01in; }
.half { width: 0.36in; }
.small { font-size: 8.5pt; }
.footer { border-top: 1px solid #777; margin-top: 0.12in; padding-top: 0.05in; }
@media print { body { max-width: none; } }
</style>
</head>
<body>
<h1>codex32 recovery card: 74 characters (256-bit)</h1>
<p class="warning">
PROTECTED RECOVERY MATERIAL — keep offline. Do not photograph, upload, or enter this
text into a website, chat, or network-connected device.
</p>

<h2>Backup details</h2>
<div class="fields">
<div class="field">Threshold (shares needed):</div>
<div class="field">Four-character identifier:</div>
<div class="field">This share index:</div>
<div class="field">Wallet policy: single-key / multisig / other:</div>
<div class="field">Separate wallet record location(s):</div>
</div>

<h2>Protected codex32 text — copy exactly, four characters per box</h2>
<div class="groups" aria-label="19 blank groups: 18 of four characters, then one of two">
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group half"></span></span>
</div>
<p class="small">The last box holds two characters. For 128-bit seeds and shares (48 characters),
use the <a href="recovery-card.html">standard card</a>.</p>

<h2>Offline recovery</h2>
<ol>
<li>Collect the stated threshold of cards with the same identifier and text length.</li>
<li>On a reviewed offline computer, install the owner’s archived codex32 release.</li>
<li>Run <code>codex32 check</code>. It validates but does not suggest corrections.</li>
<li>Restore the wallet using its documented Bitcoin Core recovery workflow.</li>
<li>Use the separate wallet record to verify the restored wallet before signing.</li>
</ol>

<h2>Manual fallback</h2>
<p class="small">
Keep a versioned offline copy of the <em>Codex32 Book Recovery Wheel and Translation
Worksheet</em>, file <code>2023-03-07--bw.pdf</code>, with the owner’s recovery kit.
Expected SHA-256: <code>0370ea863d2eae692408aeefa9b13c14283e520f45a00f7373ad933ccf418f2e</code>.
Follow that archived document if compatible software is unavailable.
</p>
<p class="footer small">Card revision 2 — BIP93/codex32 — one card per share or secret.</p>
</body>
</html>
35 changes: 17 additions & 18 deletions docs/user/recovery-card.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,29 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>codex32 recovery card</title>
<title>codex32 recovery card: 48 characters</title>
<style>
@page { size: letter; margin: 0.35in; }
@page { size: letter landscape; margin: 0.35in; }
* { box-sizing: border-box; }
body { color: #111; font: 11pt/1.25 sans-serif; margin: 0 auto; max-width: 7.8in; }
body { color: #111; font: 11pt/1.25 sans-serif; margin: 0 auto; max-width: 10.3in; }
h1 { font-size: 19pt; margin: 0 0 0.08in; }
h2 { font-size: 12pt; margin: 0.13in 0 0.05in; }
p, ol { margin: 0.05in 0; }
.warning { border: 2px solid #111; font-weight: bold; padding: 0.08in; }
.fields { display: grid; gap: 0.08in 0.18in; grid-template-columns: 1fr 1fr; }
.field { border-bottom: 1px solid #111; min-height: 0.28in; }
.groups { display: grid; gap: 0.08in 0.12in; grid-template-columns: repeat(4, 1fr); }
.group { border: 1px solid #555; font: 15pt monospace; height: 0.32in; text-align: center; }
.groups { counter-reset: box; display: flex; flex-wrap: wrap; gap: 0.1in 0.3in; }
.block { display: flex; gap: 0.08in; }
.group { border: 1px solid #555; height: 0.4in; position: relative; width: 0.72in; }
.group::before { color: #999; content: counter(box); counter-increment: box; font-size: 6pt;
left: 0.03in; position: absolute; top: 0.01in; }
.small { font-size: 8.5pt; }
.footer { border-top: 1px solid #777; margin-top: 0.12in; padding-top: 0.05in; }
@media print { body { max-width: none; } }
</style>
</head>
<body>
<h1>codex32 recovery card</h1>
<h1>codex32 recovery card: 48 characters (128-bit)</h1>
<p class="warning">
PROTECTED RECOVERY MATERIAL — keep offline. Do not photograph, upload, or enter this
text into a website, chat, or network-connected device.
Expand All @@ -36,18 +39,14 @@ <h2>Backup details</h2>
<div class="field">Separate wallet record location(s):</div>
</div>

<h2>Protected codex32 text — copy exactly in four-character groups</h2>
<div class="groups" aria-label="32 blank four-character groups">
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span>
<h2>Protected codex32 text — copy exactly, four characters per box</h2>
<div class="groups" aria-label="12 blank four-character groups">
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
<span class="block"><span class="group"></span><span class="group"></span><span class="group"></span><span class="group"></span></span>
</div>
<p class="small">Leave unused boxes blank.</p>
<p class="small">For 256-bit seeds and shares (74 characters), use the
<a href="recovery-card-256.html">256-bit card</a>.</p>

<h2>Offline recovery</h2>
<ol>
Expand All @@ -65,6 +64,6 @@ <h2>Manual fallback</h2>
Expected SHA-256: <code>0370ea863d2eae692408aeefa9b13c14283e520f45a00f7373ad933ccf418f2e</code>.
Follow that archived document if compatible software is unavailable.
</p>
<p class="footer small">Card revision 1 — BIP93/codex32 — one card per share or secret.</p>
<p class="footer small">Card revision 2 — BIP93/codex32 — one card per share or secret.</p>
</body>
</html>
Loading