Commit graph

589 commits

Author SHA1 Message Date
Heiko Schaefer
6f609c7f88
ch4: new text about preferences/features 2023-11-22 15:06:35 +01:00
Heiko Schaefer
c6888559f5
ch4: restructure text about metadata
Move "metadata" content into its own section.
This section started out as a remark about key flags, and was part of the "component key" section.
Generalizing it seems better, so it's now after the "linking" section, which introduces binding self-signatures.
2023-11-22 15:06:35 +01:00
Heiko Schaefer
999549dcc3
ch4: elaborate on split User IDs 2023-11-22 15:06:35 +01:00
Heiko Schaefer
fd32381839
ch8: add link anchor 2023-11-22 15:06:35 +01:00
Heiko Schaefer
886e8f5ff2
Add anchor, and clarify intended meaning of section 2023-11-22 15:06:20 +01:00
Heiko Schaefer
1e3672fa26
Add anchor, and clarify intended meaning of section 2023-11-22 15:06:02 +01:00
Heiko Schaefer
bf3c72d855
Adjust color description 2023-11-20 19:41:42 +01:00
David Runge
83a07f0001
Add name and alt attributes for all figures
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-20 19:13:19 +01:00
David Runge
514bb02d3d
Configure sphinx to render numbering for figures in flat hierarchy
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-20 16:24:10 +01:00
Heiko Schaefer
5cb7b94950
moved to #119 2023-11-18 17:14:53 +01:00
Heiko Schaefer
0389d75da0
ch4: drop minor redundancy 2023-11-17 14:50:37 +01:00
Heiko Schaefer
4ddbeb9e5a
use "signature packet" for disambiguation 2023-11-17 14:47:55 +01:00
Heiko Schaefer
d7bcc75249
align link names and ordering with current chapter naming 2023-11-17 14:44:49 +01:00
Heiko Schaefer
8236e97002
typo fix 2023-11-17 14:43:35 +01:00
Heiko Schaefer
36399d330b
ch3 feedback from liw, fixes #112 2023-11-17 14:36:27 +01:00
Heiko Schaefer
3d02f4ae88
Fix swapped description
(From #112)
2023-11-17 14:30:05 +01:00
Heiko Schaefer
c43b444980
RNP is independent of Thunderbird 2023-11-17 13:34:18 +01:00
Heiko Schaefer
9b925ffd9c
fix list dash 2023-11-17 00:14:09 +01:00
Tammi L. Coles
5259fb0606 Merge branch 'draft' into tammi-ch6 2023-11-16 21:09:26 +00:00
Tammi L. Coles
e6c935eec9 remove 'and providing varying levels of security' 2023-11-16 22:08:05 +01:00
Heiko Schaefer
4277942114
ch8: typo fix 2023-11-16 17:31:16 +01:00
heiko
a02c7562f0 Merge branch 'draft' into tammi-heiko-ch7 2023-11-16 16:25:43 +00:00
Tammi L. Coles
1b1e918a01 add detail to ch7 pitfalls section of cleartext signatures 2023-11-16 15:16:05 +01:00
Heiko Schaefer
32b5e0cfe0
Align wording with https://gitlab.com/openpgp-wg/rfc4880bis/-/merge_requests/354/diffs 2023-11-16 13:31:10 +01:00
Tammi L. Coles
58340c97a1 edit ch7 cleartext transformations subsection 2023-11-16 11:57:46 +01:00
Tammi L. Coles
2f44224974 edit ch7 section on use case 2023-11-16 11:14:16 +01:00
Tammi L. Coles
7ed65cc02c make second-pass edits to ch7 2023-11-16 09:48:07 +01:00
Heiko Schaefer
0def7f33ae
add link anchor 2023-11-15 12:31:08 +01:00
Heiko Schaefer
c410108a67
ch8: add link anchor 2023-11-14 22:06:02 +01:00
Heiko Schaefer
d47d9fdd53
clarify 2023-11-14 19:50:30 +01:00
Heiko Schaefer
5a454e85e7
extend todo-note 2023-11-14 19:50:29 +01:00
Heiko Schaefer
77d056702a
clarity, fix typo, normalize capitalization 2023-11-14 19:28:48 +01:00
Heiko Schaefer
1e231b0f45
adjust RFC linking, minor tweaks.
I removed the "type IDs" here, because these are *packet type* IDs. The only IDs we're using in the text are *signature types*. I believe signature type IDs are the only IDs that application developers sometimes think about in numerical terms.
2023-11-14 19:28:47 +01:00
Heiko Schaefer
ad7b58ce71
clarify/tighten: there is just *one* signature packet in this paragraph. 2023-11-14 13:35:11 +01:00
Heiko Schaefer
029e517b84
removed "particularly", because for inline signatures, this issue doesn't exist at all. added the "cleartext" case, which is equivalent here. 2023-11-14 13:20:14 +01:00
Heiko Schaefer
94eb58070b
Attempt at clearer description 2023-11-14 11:33:26 +01:00
Heiko Schaefer
6db0a1f841
Merge branch 'tammi-ch7' into heiko-ch7
# Conflicts:
#	book/source/07-signing_data.md
2023-11-13 23:56:27 +01:00
Tammi L. Coles
78c8327733 edit ch7 cleartext signature 2023-11-13 22:36:05 +01:00
Tammi L. Coles
e6b9c11a3d edit ch7 inline signatures 2023-11-13 22:06:35 +01:00
Tammi L. Coles
17d43e0e91 edit ch7 inline signatures 2023-11-13 21:33:03 +01:00
Tammi L. Coles
62af0cb83b edit ch7 detached signatures 2023-11-13 21:27:37 +01:00
Tammi L. Coles
ee65b80bc7 default to data signatures not signature over data 2023-11-13 21:20:09 +01:00
Tammi L. Coles
7e89a9f11f remove blank line 2023-11-13 21:18:15 +01:00
Tammi L. Coles
a76acf950b edits to data signature forms 2023-11-13 20:57:56 +01:00
Tammi L. Coles
f0052e23c2 edits to data signature forms 2023-11-13 20:57:44 +01:00
Heiko Schaefer
42eb52e95c
ch8: some more text about delegating trust and WoT 2023-11-13 20:52:08 +01:00
Heiko Schaefer
6812b29d23
ch8: third-party signatures 2023-11-13 01:29:44 +01:00
Heiko Schaefer
61d664f0b0
ch8: edit and expand "revocations" section 2023-11-13 01:29:44 +01:00
Heiko Schaefer
2346c346c2
ch8: edits for clarity and flow 2023-11-13 01:29:44 +01:00
Heiko Schaefer
06da358f99
ch8: write missing "signatures for primary key metadata" section 2023-11-13 01:29:44 +01:00
Heiko Schaefer
6bbef95d21
ch4: add todo 2023-11-13 01:29:37 +01:00
Heiko Schaefer
7706df1cc9
ch4: fix typos 2023-11-13 01:28:11 +01:00
Heiko Schaefer
1c3a693442
minor editing fix 2023-11-12 00:44:54 +01:00
Heiko Schaefer
1c8d728612
revert accidental removal of Fingerprint diagram 2023-11-12 00:18:30 +01:00
Heiko Schaefer
6dc243de98
ch7: Write "transformations" section about CSF 2023-11-11 21:05:01 +01:00
Heiko Schaefer
1b5edc1774
ch7: clarify CSF and its use 2023-11-11 21:05:01 +01:00
Tammi L. Coles
4fd97868e8 edit ch7 forms of data signatures 2023-11-10 17:53:52 +01:00
Tammi L. Coles
f7ea1b115e edit ch7 ## Signature types 2023-11-10 17:45:36 +01:00
Tammi L. Coles
51ba919106 edit ch7 signatures over data 2023-11-10 17:28:26 +01:00
Tammi L. Coles
8a82cebd6c edit ch6 notation subpackets with the Keyoxide example 2023-11-10 16:48:25 +01:00
Tammi L. Coles
44a4a00a2e edit ch6 "Criticality of subpackets" 2023-11-10 16:30:07 +01:00
Tammi L. Coles
93d061efc7 remove another random colon :D 2023-11-10 15:57:47 +01:00
Tammi L. Coles
48f39f0ffb remove colon from subheader 2023-11-10 15:57:07 +01:00
Tammi L. Coles
ec61e782df edit ch6 hashed vs unhashed areas 2023-11-10 15:56:22 +01:00
Tammi L. Coles
18a621c827 edit on ch6 verifying packet section and subpackets 2023-11-10 15:41:11 +01:00
Tammi L. Coles
3dcc962c57 edit on ch6 verifying packet section 2023-11-10 15:21:22 +01:00
Tammi L. Coles
3b401a17a7 tighten up ch6 signature packet creation section 2023-11-10 15:07:35 +01:00
Tammi L. Coles
d4a616094e restructure signature packet section of ch6 2023-11-10 14:45:39 +01:00
Heiko Schaefer
2445b2f414
ch7: edits for clarity 2023-11-10 01:59:20 +01:00
Heiko Schaefer
7f9aba28fa
restructure text blocks 2023-11-09 01:43:56 +01:00
Heiko Schaefer
420e15e8c8
remove seemingly stray text 2023-11-08 21:01:29 +01:00
Heiko Schaefer
1335d5568f
edits 2023-11-08 21:01:28 +01:00
Heiko Schaefer
b73789d1c8
adjust structure 2023-11-08 21:00:29 +01:00
Heiko Schaefer
0039afd7fd
edits 2023-11-08 21:00:29 +01:00
Tammi L. Coles
e20a629db7 edit signature types section in Ch6 2023-11-07 21:33:19 +01:00
Tammi L. Coles
2ee0d7263a edits on Ch6 terminology 2023-11-07 21:16:08 +01:00
Tammi L. Coles
e23fd3de9c tighten text of signatures intro section 2023-11-07 20:58:28 +01:00
Heiko Schaefer
bf41637c05
Restructure opening 2023-11-07 14:34:02 +01:00
Heiko Schaefer
390089139e
remove todo text 2023-11-06 23:25:29 +01:00
Heiko Schaefer
169ce620e9
Experiment: Adjust signature type diagram structure 2023-11-06 23:21:18 +01:00
Heiko Schaefer
658b03b1a4
Edits (in part based on feedback from David) 2023-11-06 13:45:50 +01:00
Heiko Schaefer
d1e23fef9e
Add new signature diagrams. Add some more text and structure for them. 2023-11-06 00:55:46 +01:00
Heiko Schaefer
1dc7a7f116
update image 2023-11-05 21:46:36 +01:00
Heiko Schaefer
366bb70b54
import new/updated diagrams from skvis-draft 2023-11-05 21:26:35 +01:00
skvisual
7326a765ad
import new/updated diagrams from skvis-draft 2023-11-05 21:20:52 +01:00
Heiko Schaefer
256c9b14e8
ch19: add link target 2023-11-05 20:56:05 +01:00
Heiko Schaefer
10246eebc1
Drop duplicate diagram files 2023-11-04 19:09:19 +01:00
Heiko Schaefer
c05cd64f7f
Drop many of the legacy diagrams 2023-11-04 19:06:40 +01:00
Heiko Schaefer
e1668dbd09
Add a bit of text about where the "backsig" is actually embedded 2023-11-04 18:39:18 +01:00
Heiko Schaefer
f91b386ea9
Edits based on David's input 2023-11-03 18:51:12 +01:00
Heiko Schaefer
4754753cfc
Elaborate how the signature is calculated 2023-11-03 18:51:12 +01:00
Heiko Schaefer
384f26c1bc
David says the signature type diagram is confusing, maybe it needs more explanation?
I suppose the (at least) 2x2 Matrix of types of component signatures is hard to make sense of, and hard to visualize.
2023-11-03 18:51:12 +01:00
Heiko Schaefer
4d8ade3502
Add diagram for signature packet structure 2023-11-03 18:51:12 +01:00
Heiko Schaefer
e814cc5bb1
tmp: placeholder images, waiting for replacements in skvis-draft 2023-11-03 18:51:12 +01:00
Heiko Schaefer
1ec7d9a2ea
David points out that "magic" can be read as intimidating.
Like a topic is very hard to understand, or only accessible to wizards.
2023-11-03 18:51:12 +01:00
Tammi L. Coles
bac6fbe6fd clause correction in 69f5bce965 2023-11-03 12:31:21 +01:00
Heiko Schaefer
5e97344039
fix link target name 2023-11-03 12:26:06 +01:00
Heiko Schaefer
d33c8d7933
ch3: sharpen our terminology, use "hash digest" by default
Fixes #98
2023-11-03 12:25:50 +01:00
Heiko Schaefer
40924bef0d
Slightly expand/clarify phrasing on quantum resistance 2023-11-03 12:25:50 +01:00
Tammi L. Coles
8bb4baeff7 change verb in ef7a9956e4 2023-11-03 12:20:58 +01:00
Tammi L. Coles
661beb75e4 correct spelling in be01588cce 2023-11-03 12:18:34 +01:00
Tammi L. Coles
94ef48bdee edit 3ca2bc5529 2023-11-03 12:16:27 +01:00
Heiko Schaefer
f6bcc53211
Fix tense 2023-11-03 12:04:05 +01:00
Heiko Schaefer
75ac101a40
Introduce terms: confidentiality and authenticity 2023-11-03 12:04:05 +01:00
Heiko Schaefer
53473b025c
Remove redundancy 2023-11-03 12:04:04 +01:00
Heiko Schaefer
22b05ed942
Motivation text for this document 2023-11-03 12:04:04 +01:00
Heiko Schaefer
a3cf766492
Reorder text 2023-11-03 12:04:04 +01:00
Tammi L. Coles
139a543db2 resolve https://codeberg.org/openpgp/notes/pulls/104#issuecomment-1318049 2023-11-03 11:59:37 +01:00
Heiko Schaefer
080c88909b
Cut redundancy 2023-11-03 11:53:34 +01:00
Heiko Schaefer
e4631e2b23
"Zooming in" content was moved to chapters at the end of the book 2023-11-03 11:53:34 +01:00
Heiko Schaefer
5eb6d310cf
Fix version claims and add a bit more detail about extensions to 4880.
It's not so straightforward: RFC 2440 and 4880 both define OpenPGP version 4 artifacts. So naming versions in the text is tricky.
2023-11-03 11:53:34 +01:00
Heiko Schaefer
1c9b9d8724
Remove stray brace 2023-11-03 11:53:34 +01:00
Heiko Schaefer
31d64fdb37
Fix link syntax 2023-11-03 11:53:34 +01:00
Heiko Schaefer
5f41b4fe64
update link to component_signatures_chapter 2023-11-03 10:56:05 +01:00
Heiko Schaefer
8704758dde
Merge branch 'draft' into tammi-ch4
# Conflicts:
#	book/source/04-certificates.md
2023-11-03 10:43:58 +01:00
Tammi L. Coles
8fc4302338 resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1317436 2023-11-03 10:35:36 +01:00
Tammi L. Coles
783b151af6 Resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291286 2023-11-03 10:20:20 +01:00
Tammi L. Coles
acb1d9f7e1 Resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291281 2023-11-03 10:16:00 +01:00
Tammi L. Coles
86ce3d8ce2 change to bind to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291278 2023-11-03 10:15:16 +01:00
Tammi L. Coles
969fde83b2 change often to typically to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291271 2023-11-03 10:14:19 +01:00
Tammi L. Coles
0febf20d24 correct that fingerprint is not unique to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291270 2023-11-03 10:10:36 +01:00
Tammi L. Coles
accdb48301 clarify distinct role of primary key to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291268 2023-11-03 10:08:55 +01:00
Heiko Schaefer
c563f8a891
Generate updated png (with spelling fix, but for some reason this time with white background 🤷) 2023-11-02 20:07:00 +01:00
Heiko Schaefer
8f5d9f48a1
Add a note that diagram spelling should not be fixed.
We'll fix diagram spellings in the course of the merge into the future 'main' branch.
2023-11-02 19:51:32 +01:00
David Runge
32a05d2c5b
Remove bat based Make file for Windows as it is unused
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:10 +01:00
David Runge
82f59746f2
Add codespell integration, which checks all sources
Add a make target for running `codespell` on all sources.
Skip running codespell on the build directory (we have javascript etc.
in there).
Only emit warnings but do not fail on spelling errors in diagrams.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 19:05:05 +01:00
David Runge
cb4ac38e05
Fix spelling in source files
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 18:41:36 +01:00
Tammi L. Coles
dde0eae900 spell out the "not unique" issue to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291244 2023-11-02 17:52:35 +01:00
Tammi L. Coles
6d9bf44ba5 change fingerprint language to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291232 2023-11-02 17:46:55 +01:00
Tammi L. Coles
4d695764d0 connect metadata paragraphs better to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291216 2023-11-02 17:42:27 +01:00
Tammi L. Coles
e878c637b8 edit 118 to resolve https://codeberg.org/openpgp/notes/pulls/81#issuecomment-1291275 2023-11-02 17:31:14 +01:00
David Runge
e13127e064
When link checking, always build HTML from scratch
To be on the safe side, always build HTML pages from scratch, so that
lychee checks the actual current version of the files.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
c9e7b03f53
Fail on warnings when building with sphinx-build
Fixes https://codeberg.org/openpgp/notes/issues/90

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:18 +01:00
David Runge
5fd9676392
Add a file to keep the static dir around when cloning the repo
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:17 +01:00
David Runge
415fb44ace
Do not fail on footnotes directly following a heading
Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:16 +01:00
David Runge
a88e3023a8
Move 06-terminology.md to a temporary location
As mermaid pulls in many dependencies and is not setup in CI,
sphinx-build will fail on trying to render the file.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-11-02 16:46:15 +01:00
Heiko Schaefer
3e64c68f92
use direct link (link checks in codeberg CI are currently failing for the archive.org link) 2023-11-02 14:55:25 +01:00
Heiko Schaefer
2a5667062e
ch17: use public key and direct key signature packet diagrams 2023-11-02 13:54:39 +01:00
Tammi L. Coles
333a8862ac change to calculated 2023-11-02 13:47:20 +01:00
Tammi L. Coles
43faca00e3 correct for hash digest, move reference 2023-11-02 13:44:28 +01:00
Tammi L. Coles
00270a07e5 remove extra space 2023-11-02 13:07:45 +01:00
Tammi L. Coles
e20658c249 resolve https://codeberg.org/openpgp/notes/pulls/91#issuecomment-1310156 2023-11-02 12:46:02 +01:00
Tammi L. Coles
a6516a949c resolve https://codeberg.org/openpgp/notes/pulls/91#issuecomment-1305908 2023-11-02 12:38:25 +01:00
Tammi L. Coles
d37382d43d Merge branch 'draft' into tammi-ch17 2023-11-02 10:42:41 +00:00
Tammi L. Coles
33cab7b59a change period to colon 2023-11-02 10:17:49 +01:00
Heiko Schaefer
ed7ab4760f
ch6: Use new diagram 2023-11-01 21:40:49 +01:00
Heiko Schaefer
5b0eb1948a
Import new diagrams 2023-11-01 21:34:51 +01:00
Heiko Schaefer
77c901889b
Terminology fix 2023-10-30 00:28:43 +01:00
Heiko Schaefer
1dbe95cb1f
fix link names 2023-10-29 23:47:36 +01:00
Heiko Schaefer
bedae03c42
fix todo admonition syntax 2023-10-29 23:36:35 +01:00