Commit 5f9cb1f
committed
Adds the getting-started guide and runbook
Two guides, both required before a first release, written after the
envelope because a getting-started guide for an unimplemented package
is a promise rather than a document.
The getting-started guide stands up a single-key vault and then a
per-tenant one. It states where key material may come from - the
init/1 callback, never use options and never a config file - when to
configure 0x0478 and when to keep the signing default, and why
:max_age is required with no default: it is the answer to how long a
crypto-shred takes to take effect on a running node.
It requires two root secrets from day one, holding the same bytes. A
deployment that provisions both at install never performs P1 step 0,
which is the most destructive-looking no-op in the design: generating
a fresh reference root rather than copying moves every tenant
reference in the deployment.
The rotation runbook is the four procedures with their preconditions,
steps, independent verification and rollback, both blast radius
tables, and the two-vocabulary mapping across the packages. Every step
says whether it is a function this package ships or an action on a
store it does not own, and cache drainage is a step inside each
destructive procedure rather than a follow-up. It carries the honest
wording on shredding: a shred destroys plaintext, not attribution.
Every code block in both guides is executed by Encryptor.GuidesTest
against modules transcribed from the printed text, so a guide that
drifts from the landed surface fails the gate.
README reports the package as built rather than as a scaffold and
gives the installation form as a SHA-pinned git dependency; the
reserved 0.1.0 on Hex holds no implementation.
Refs: enc-nsi1 parent 1b42c26 commit 5f9cb1f
8 files changed
Lines changed: 2010 additions & 11 deletions
File tree
- changelog.d
- guides
- lib
- test
- support
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
19 | 30 | | |
20 | 31 | | |
21 | 32 | | |
| |||
100 | 111 | | |
101 | 112 | | |
102 | 113 | | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
103 | 118 | | |
104 | 119 | | |
105 | 120 | | |
106 | | - | |
| 121 | + | |
107 | 122 | | |
108 | 123 | | |
109 | 124 | | |
110 | 125 | | |
111 | | - | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
112 | 140 | | |
113 | 141 | | |
114 | 142 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
0 commit comments