Commit graph

498 commits

Author SHA1 Message Date
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
Heiko Schaefer
b257e9a366
moved "VISUAL" admonitions to #95
we should consider if we want such diagrams after the core writing phase (if we have time).
2023-10-29 23:14:32 +01:00
Heiko Schaefer
d44226d288
ch5: use new diagrams 2023-10-29 23:07:51 +01:00
Heiko Schaefer
4a568be351
import new diagrams 2023-10-29 23:07:50 +01:00
Heiko Schaefer
3f536dfaaa
ch7: merge in old text, edits 2023-10-29 22:44:07 +01:00
3ec73a8549
Initial work on Data Signatures chapter 2023-10-29 22:44:07 +01:00
Heiko Schaefer
4c52063536
ch6: add link anchor 2023-10-29 22:44:07 +01:00
Heiko Schaefer
e33ead3bb9
ch19: fix signature examples
- now the inline signature has a v6 One-Pass Signature packet
- don't generate differing signatures by running the non-deterministic `sq sign` multiple times
2023-10-29 22:44:07 +01:00
Heiko Schaefer
79f122114b
ch19: "zooming in" data signature examples 2023-10-29 22:44:07 +01:00
Heiko Schaefer
6c85ca62de
ch6: add short text about notations 2023-10-29 22:44:07 +01:00
Heiko Schaefer
a3b143d732
ch8: edits 2023-10-29 22:44:07 +01:00
Heiko Schaefer
fd0f0fe713
ch8: add clarifications 2023-10-29 22:44:07 +01:00
Heiko Schaefer
67ee9bfbe7
ch6, ch7: add notes 2023-10-29 22:44:07 +01:00
Heiko Schaefer
e7350e8f7a
ch6: rfc links 2023-10-29 22:44:07 +01:00
Heiko Schaefer
f9ab3ca17b
ch8: rfc links 2023-10-29 22:44:07 +01:00
Heiko Schaefer
e2d3fabdc5
ch8: more introductory text 2023-10-29 22:44:07 +01:00
Heiko Schaefer
33ad6fcd69
ch6: visual note 2023-10-29 22:44:07 +01:00
Heiko Schaefer
0cf0c2069c
swap chapters on signing components and data 2023-10-29 22:44:07 +01:00
Heiko Schaefer
06d3e1f230
edit moved/split out ch7 2023-10-29 22:44:07 +01:00
Heiko Schaefer
4000e1efdc
edit new ch6 2023-10-29 22:44:07 +01:00
Heiko Schaefer
604c801710
reorder chapters: 6 is now a general introduction to openpgp signatures 2023-10-29 22:44:07 +01:00
Heiko Schaefer
c27600fb6f
edits, more restructuring 2023-10-29 22:44:07 +01:00
Heiko Schaefer
8184304cd8
more restructuring 2023-10-29 22:44:07 +01:00
Heiko Schaefer
6440318fcc
minor restructure 2023-10-29 22:44:07 +01:00
Heiko Schaefer
03f8bf21c1
ch6: import new diagrams from skvis-draft 2023-10-29 22:44:07 +01:00
Heiko Schaefer
7417462441
edits 2023-10-29 22:44:07 +01:00
Heiko Schaefer
b332753936
include diagram as generated png, for now 2023-10-29 22:30:16 +01:00
Heiko Schaefer
19ac66ee5c
restructure 2023-10-29 22:30:16 +01:00
Heiko Schaefer
1b95fa95a3
myst markup fixes 2023-10-29 22:30:16 +01:00
Heiko Schaefer
9b3d3c51b2
early version of new binding diagram 2023-10-29 22:26:39 +01:00
49f30fc8df
Remove todo list 2023-10-29 22:26:39 +01:00
37d026a78b
Hard vs soft 2023-10-29 22:26:39 +01:00
f46ed006b9
Shift around the 4.2.3 text segments in ch6. 2023-10-29 22:26:39 +01:00
ff9f6bf1b3
Move 4.2.3 to chapter 6 2023-10-29 22:26:36 +01:00
fae5a5de50
Rename node 2023-10-29 22:26:29 +01:00
0d47939501
Move diagram to separate file 2023-10-29 22:26:29 +01:00
ae776d2b13
Signature Types 2023-10-29 22:26:29 +01:00
d4d02dffba
Add / revoke subkeys 2023-10-29 22:26:29 +01:00
7bbc2f2434
Revocation 2023-10-29 22:26:29 +01:00
23bd402f4e
Fix targets 2023-10-29 22:26:29 +01:00
1ce91b8820
Complete diagram 2023-10-29 22:26:29 +01:00
5f8e36a605
Add signature diagram 2023-10-29 22:26:29 +01:00
c5ba06dc78
s/user ID/User ID/ 2023-10-29 22:26:29 +01:00
be5fff67ab
Progress 2023-10-29 22:26:29 +01:00
c80678e8f1
Move conflict-related changes to conflicts and duplication section 2023-10-29 22:26:29 +01:00
f04987df80
Add section on packet criticality 2023-10-29 22:26:29 +01:00
6c88b1631d
Fix notes on subpackets 2023-10-29 22:26:29 +01:00
heiko
55a6aac9dd Merge branch 'draft' into tammi-ch3-MAC 2023-10-29 14:07:39 +00:00
Heiko Schaefer
543b1a8cc1
clearly mark different sections of packet discussions 2023-10-28 01:50:07 +02:00
Heiko Schaefer
1612dfd5ba
wording fix 2023-10-28 01:47:40 +02:00
Heiko Schaefer
c3d7d5f8b5
ch4: updated user ids diagram 2023-10-28 01:04:45 +02:00
Heiko Schaefer
f0d240c5fa
this fixes a git mixup i made 2023-10-28 01:02:54 +02:00
Heiko Schaefer
3e3b7477bb
wording fix 2023-10-28 00:59:25 +02:00
Heiko Schaefer
4febf47bf0
add TODO note 2023-10-28 00:58:26 +02:00
Heiko Schaefer
a890aeddd5
wording fix 2023-10-27 23:40:07 +02:00
Heiko Schaefer
890f90c5f3
typo fix 2023-10-27 23:38:54 +02:00
Heiko Schaefer
38f5139600
word fix 2023-10-27 23:37:45 +02:00
Heiko Schaefer
a590637762
fixes to Direct Key Signature section 2023-10-27 23:34:41 +02:00
Heiko Schaefer
2c57712c3b
fix title 2023-10-27 23:24:59 +02:00
Tammi L. Coles
05d2e15fee finish current version of ch17, UserID+certification self-sig 2023-10-27 17:17:47 +02:00
Tammi L. Coles
a487db6996 correct packet type ID capitalization 2023-10-27 16:46:14 +02:00
Tammi L. Coles
a2b8f75ea2 edit User ID packet 2023-10-27 16:45:41 +02:00
Tammi L. Coles
580325dca4 edit ## Adding an identity component 2023-10-27 16:33:45 +02:00
Tammi L. Coles
63fbd49dcf edit subkey binding signature, correct comma placement 2023-10-27 16:20:48 +02:00
Tammi L. Coles
c2405f53ef edit next part of subkex binding signature 2023-10-27 15:01:20 +02:00
Tammi L. Coles
b6da12d0ee edit part 1 of subkey binding signature 2023-10-27 14:55:17 +02:00
Tammi L. Coles
fb24639ea1 edit Public-Subkey packet 2023-10-27 14:37:26 +02:00
Tammi L. Coles
1f8411caa6 edit encryption subkey 2023-10-27 14:17:25 +02:00
Tammi L. Coles
c8b417ccdb finish direct key signature section 2023-10-27 11:59:39 +02:00
Tammi L. Coles
199d0bb5e8 reformat subpacket details to ease comprehension 2023-10-27 11:05:18 +02:00
Tammi L. Coles
6283630e6c edits to ch17 field-by-field explainer 2023-10-27 09:45:26 +02:00
Tammi L. Coles
3f38d588f5 edit ch17 2023-10-27 09:26:13 +02:00
Tammi L. Coles
a2aa3c9109 edit KDFs section 2023-10-26 14:12:48 +02:00
David Runge
6aeaa0d35d
fix: Use current link for flowcrypt on sending password protected mails
Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-26 13:08:50 +02:00
David Runge
d342884ecf
feat: Add make target to check links in html output using lychee
Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-26 13:08:06 +02:00
Tammi L. Coles
4bf1ded007 edit ch3 MAC section 2023-10-26 12:12:26 +02:00
Tammi L. Coles
647b2494f5 Merge pull request 'Add section on KDFs' (#83) from 03-key_derivation into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/83
2023-10-26 09:32:04 +00:00
Heiko Schaefer
5496d54772
add link to gcm discussion, as a note for writing 2023-10-25 16:17:03 +02:00
Heiko Schaefer
460bc9d5a4
ch5: fix admonition type 2023-10-24 21:09:39 +02:00
Heiko Schaefer
87e26fa6cd
ch5: process input from wiktor 2023-10-24 21:08:14 +02:00
Heiko Schaefer
74d58454ea
ch17: import new diagram from skvis-draft 2023-10-24 00:53:53 +02:00
Tammi L. Coles
01103ebcf6
manually add link to zoom_certificates from issue #73 2023-10-24 00:53:18 +02:00
Heiko Schaefer
576c8de26d
ch18: add "secret-key packet" diagram 2023-10-24 00:41:10 +02:00
David Runge
121e352b59
feat: Add license attribution for all files
Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-23 20:55:08 +02:00
e4164aab4d
Add section on HMAC 2023-10-23 13:04:42 +02:00
0b078830f2
Add section on KDFs 2023-10-23 12:40:15 +02:00
Heiko Schaefer
1ba8ac2884
ch3: fix myst syntax 2023-10-23 11:54:42 +02:00
Tammi L. Coles
9e4944064c manually add issue #73 again 2023-10-22 13:10:10 +02:00
Tammi L. Coles
27a43977cb remove misplaced section 2023-10-22 13:05:35 +02:00
Tammi L. Coles
7e709c6a00 manually add issue #73 2023-10-22 11:49:41 +02:00
Heiko Schaefer
a8467cd166
ch3: drop todo, the key types are now visualized 2023-10-22 10:15:42 +02:00
Heiko Schaefer
cf8c754624
use new diagrams for ch3 2023-10-22 09:59:41 +02:00