Commit graph

509 commits

Author SHA1 Message Date
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
Heiko Schaefer
14e3919b9d
add new key diagrams for ch3 2023-10-22 09:59:41 +02:00
Tammi L. Coles
bd468da34f
expand on hybrid concept, mark for move 2023-10-22 09:59:41 +02:00
Tammi L. Coles
e1f0452ccd
expand on hybrid concept 2023-10-22 09:59:41 +02:00
Tammi L. Coles
b9341d921e
clarify MDC 2023-10-22 09:59:41 +02:00
Tammi L. Coles
6734930bd9
edit hybrid cryptosystems 2023-10-22 09:59:41 +02:00
Tammi L. Coles
5e6a857040
clarify private vs secret in this document 2023-10-22 09:59:41 +02:00
Tammi L. Coles
d810608dc6
swap parts for components 2023-10-22 09:59:41 +02:00
Tammi L. Coles
773015bdf4
clarify private vs secret in this document 2023-10-22 09:59:41 +02:00
Tammi L. Coles
bef3a69be9
rewrite header and note on Usage and terminology 2023-10-22 09:59:41 +02:00
Tammi L. Coles
b33251aa31
rework language of digital signatures and signers 2023-10-22 09:59:41 +02:00
Tammi L. Coles
57c4d2ef31
improve language of asymmetric key pair section 2023-10-22 09:59:41 +02:00
Tammi L. Coles
891ce892fc
simplify public-key cryptophay section for dummies like me 2023-10-22 09:59:41 +02:00
Tammi L. Coles
61f8a76bd6
simplify AEAD language, correct punctuation of footnote 2023-10-22 09:59:41 +02:00
Tammi L. Coles
4d0fbb3f43
simplify sessionkey footnote 2023-10-22 09:59:41 +02:00
Tammi L. Coles
3fb0179a77
clarify and question the benefits and downsides section 2023-10-22 09:59:41 +02:00
Tammi L. Coles
ce6d28020c
weave in asymmetric cryptography formerly in ch3 as symm-key explainer 2023-10-22 09:59:41 +02:00
Tammi L. Coles
2a828cd0fd
simplify cryptographic hash functions 2023-10-22 09:59:41 +02:00
Tammi L. Coles
173d23bb65 edit ch4, rewrite 3rd-party certifications 2023-10-21 15:01:50 +02:00
Tammi L. Coles
25af6a907a continue edits to ch4 2023-10-21 12:58:44 +02:00
Tammi L. Coles
498b01f01a get remote changes 2023-10-19 19:49:53 +02:00
Tammi L. Coles
b484018f41
edit key flags in part 2023-10-19 19:42:05 +02:00
Tammi L. Coles
17e0efb421
add warning/task regarding capitalization 2023-10-19 19:42:05 +02:00
Tammi L. Coles
9a5ff9f2ab
edit ch4 subkeys 2023-10-19 19:42:05 +02:00
Tammi L. Coles
f981225261
edit ch4 primary key 2023-10-19 19:42:05 +02:00
Tammi L. Coles
6abd5336cf
edit ch4 2023-10-19 19:42:05 +02:00
Tammi L. Coles
bedd68855a Merge remote-tracking branch 'refs/remotes/origin/tammi-ch4' into tammi-ch4 2023-10-19 19:28:17 +02:00
Tammi L. Coles
bec23c73f7
edit key flags in part 2023-10-19 19:19:53 +02:00
Tammi L. Coles
e7bf063c92
add warning/task regarding capitalization 2023-10-19 19:19:36 +02:00
Tammi L. Coles
23954ef803
edit ch4 subkeys 2023-10-19 19:19:34 +02:00
Tammi L. Coles
9cfc933e86
edit ch4 primary key 2023-10-19 19:18:37 +02:00
Tammi L. Coles
615ade4cfa
edit ch4 2023-10-19 19:18:34 +02:00
Tammi L. Coles
0b7ac3402f edit key flags in part 2023-10-19 19:16:11 +02:00
Tammi L. Coles
435b52593c add warning/task regarding capitalization 2023-10-19 17:44:47 +02:00
Tammi L. Coles
5eb49aee3e edit ch4 subkeys 2023-10-19 17:40:57 +02:00
Tammi L. Coles
4bcb73e5ec edit ch4 primary key 2023-10-19 17:35:17 +02:00
Tammi L. Coles
4edf20da61 edit ch4 2023-10-19 17:30:13 +02:00
Heiko Schaefer
14de863d53
index: add current date; limit toc to "maxdepth 2" 2023-10-19 09:26:07 +02:00
Heiko Schaefer
f16f4f341d
ch4: add "advanced" section about primary key metadata 2023-10-18 17:57:47 +02:00
Heiko Schaefer
e066c2e7a2
ch5: writing 2023-10-18 17:48:45 +02:00
Heiko Schaefer
fbd4126a63
ch4: move misplaced text 2023-10-17 18:16:24 +02:00
Heiko Schaefer
2cdcd6aebd
ch4: adjust fingerprint in text to diagram 2023-10-17 18:15:59 +02:00
Heiko Schaefer
9d79096f24
ch4: flatten section structure
(And remove todo that was moved to ch6)
2023-10-17 18:08:42 +02:00
Heiko Schaefer
9be2dfc539
ch4: shorten "Linking" section; most of it goes to ch6 2023-10-17 17:58:26 +02:00
Heiko Schaefer
1f9f953aa6
use new diagram for ch4 2023-10-17 17:58:26 +02:00
Heiko Schaefer
5525be4c5e
update certificate diagram 2023-10-17 17:58:26 +02:00
Heiko Schaefer
a40a2654f4
a: Add link anchor for bob's key 2023-10-16 15:25:24 +02:00
Heiko Schaefer
7873c72f97
annex a: add a key for bob, with Argon2 protected Secret-Key packets 2023-10-16 15:23:56 +02:00
Heiko Schaefer
86329e757b
restructure: move "zooming in" texts from ch4 to a new chapter 17 2023-10-16 15:22:37 +02:00
Heiko Schaefer
13a3d84526
ch4: move revocations section 2023-10-16 13:20:38 +02:00
Heiko Schaefer
0965fa4fae
ch4, zooming in: remove material that involves private key
(All of that should be in ch5)
2023-10-15 14:10:21 +02:00
Heiko Schaefer
2b018c73ee
ch4: clarify that this chapter deals with "public keys" only 2023-10-15 10:56:38 +02:00
Heiko Schaefer
3ed3d5ed6a
ch4: elaborate on user id conventions 2023-10-14 22:48:55 +02:00
Heiko Schaefer
2df7aa779d
ch4: Outline how key flags are set
(addresses one point of #63)
2023-10-14 22:48:55 +02:00
Heiko Schaefer
443023b8e9
ch4: fix phrasing 2023-10-14 22:45:03 +02:00
Heiko Schaefer
13f5cd5d73
ch4: clarify text in draft user id diagram 2023-10-14 20:50:30 +02:00
Heiko Schaefer
83ccdda6b4
Terminology fixes 2023-10-12 16:07:28 +02:00
Tammi L. Coles
f0959a2b0f
Adjust
to updated RFC terminology

Fixes #52
2023-10-12 16:03:08 +02:00
Heiko Schaefer
7617d7eea6
ch4: write "user id" zooming in section 2023-10-12 14:11:21 +02:00
Heiko Schaefer
3688054f4f
ch4: restructure packet splitting text sections 2023-10-12 14:11:02 +02:00
Heiko Schaefer
1aa4696f3e
ch4: add todo notes 2023-10-12 14:11:02 +02:00
Heiko Schaefer
d1203075d1
ch4: move text into a "note" block
And add a remark that a visualization would help.
2023-10-12 14:11:02 +02:00
Heiko Schaefer
69f7eb60e5
ch4: clarify linking 2023-10-12 14:11:02 +02:00
Heiko Schaefer
bab5e427e9
ch4: add a section to talk about "no more user facing hex fingerprints in v6" 2023-10-12 14:11:02 +02:00
Heiko Schaefer
2a3605f731
ch4: move diagram up 2023-10-12 14:11:02 +02:00
Heiko Schaefer
af355ae81e
ch4: adjust markup/styling of critical flags 2023-10-12 14:11:02 +02:00
Heiko Schaefer
c1acc328d0
ch4: move "criticality" footnote into a more visible note block 2023-10-12 14:11:02 +02:00
Heiko Schaefer
a1fe545e88
ch4: add a note that the example key isn't password protected
Add link to ch5 for discussion of encrypted private key material.
2023-10-12 14:11:02 +02:00
Heiko Schaefer
134407ee2f
ch4: add a TODO note 2023-10-12 14:11:02 +02:00
Heiko Schaefer
66087b3ec9
ch4: clarify terms, use "identity components" 2023-10-12 14:11:02 +02:00
Heiko Schaefer
1f89d39740
ch4: link to glossary for "CA" 2023-10-12 14:11:02 +02:00
Heiko Schaefer
74710d804a
ch4: clarify the primary key can't confer validity beyond its own 2023-10-12 14:11:02 +02:00
Heiko Schaefer
fd2469e0e4
ch4: make links for "more on this below" pointers 2023-10-12 14:11:02 +02:00
Heiko Schaefer
8bf3440373
ch4: zooming in, write subkey sections 2023-10-12 14:11:02 +02:00
Heiko Schaefer
74e3810e84
ch4: zooming in, edits 2023-10-12 14:11:02 +02:00
Heiko Schaefer
96d9eff25f
ch4: zooming in, fix indentation of sq dump output 2023-10-12 14:11:02 +02:00
Heiko Schaefer
b1acb31ed0
ch4: zooming in, add subkey dumps 2023-10-12 14:11:02 +02:00
Heiko Schaefer
5fdb9be451
ch4: minor edits to "Seen as an OpenPGP certificate" 2023-10-12 14:11:02 +02:00
Heiko Schaefer
ac070e5229
ch4 "zooming in": fix capitalizations/styling
- Don't use quotation marks for RFC terms. Use italics, when appropriate.
- The word "packet" isn't capitalized when referring to a specific packet.
2023-10-12 14:11:02 +02:00
Heiko Schaefer
c592c6c02d
ch4: don't use title case 2023-10-12 14:11:02 +02:00
Tammi L. Coles
44eba4a6bb
change to 'may refer to' 2023-10-12 14:07:26 +02:00
Tammi L. Coles
6f179d2c07
remove asysmmetric explainer, evaluate for ch3 2023-10-12 14:07:26 +02:00
Tammi L. Coles
b353129bcc
add digital signatures 2023-10-12 14:07:26 +02:00
Tammi L. Coles
2beba67d13
edit section on layers of keys, integrating previoous Ch2 section 2023-10-12 14:07:26 +02:00
Tammi L. Coles
4e9ddaee0b
clarify in section on public vs private keys 2023-10-12 14:07:26 +02:00
Tammi L. Coles
ab926334bd
edit section intro on understanding keys 2023-10-12 14:07:26 +02:00
Tammi L. Coles
7da0131ea7
change opening lines/introduction to chapter 2023-10-12 14:07:26 +02:00
Tammi L. Coles
e5625f43db Merge branch 'draft' into tammi-ch4 2023-10-12 12:07:20 +00:00
Tammi L. Coles
1672ecc4c2 change to 'may refer to' 2023-10-12 14:06:10 +02:00
Tammi L. Coles
54a4f3457a remove asysmmetric explainer, evaluate for ch3 2023-10-12 13:54:51 +02:00