Commit graph

591 commits

Author SHA1 Message Date
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
Tammi L. Coles
6130da92f3 add digital signatures 2023-10-12 13:42:38 +02:00
Heiko Schaefer
a0a33b13b4
ch1: notes on the elaboration 2023-10-12 12:06:53 +02:00
Heiko Schaefer
9a3bb16236
sphinx conf: more minimalistic output 2023-10-12 12:05:46 +02:00
Tammi L. Coles
f93b74638d
change to 'enable' for clarity 2023-10-12 12:01:34 +02:00
Heiko Schaefer
ea74ed2128
moved to https://codeberg.org/openpgp/notes/issues/58 2023-10-12 11:56:53 +02:00
Heiko Schaefer
b18f1eefec
moved to https://codeberg.org/openpgp/notes/issues/57 2023-10-12 11:56:18 +02:00
Heiko Schaefer
731c92d9fc
moved note into https://codeberg.org/openpgp/notes/issues/56 2023-10-12 11:50:15 +02:00
Heiko Schaefer
4fb5fb4fff
use myst "note" markup 2023-10-12 11:46:18 +02:00
Heiko Schaefer
62bf41b040
re-add (interop_section) link target 2023-10-12 11:46:18 +02:00
Tammi L. Coles
cf553aba38
edit details on PGP distribution 2023-10-12 11:46:18 +02:00
Tammi L. Coles
121119c709
clarify timeframe on v4 popularity 2023-10-12 11:46:18 +02:00
Tammi L. Coles
25f9252e48
add Bouncy Castle, remove PGPainless 2023-10-12 11:46:18 +02:00
Tammi L. Coles
250c9f42eb
insert comma 2023-10-12 11:46:18 +02:00
Tammi L. Coles
705f651a89
add s 2023-10-12 11:46:18 +02:00
Tammi L. Coles
e968ad9c75
added in 2023-10-12 11:46:18 +02:00
Tammi L. Coles
6947239101
removed extra a, changed like to such as 2023-10-12 11:46:18 +02:00
Tammi L. Coles
7fdcdb2391
edit, change to 'personally identifiable information (PII)' 2023-10-12 11:46:18 +02:00
Tammi L. Coles
e5b114a9ef
remove html in markdown 2023-10-12 11:46:18 +02:00
Tammi L. Coles
ff96d27b2e
move certificate and keys section to Ch4 2023-10-12 11:46:18 +02:00
Tammi L. Coles
f0db3cb5cc
move building blocks to Ch1 2023-10-12 11:46:18 +02:00
Tammi L. Coles
9ff8b69cb7
move high-level operations to Ch1 2023-10-12 11:46:18 +02:00
Tammi L. Coles
c65141a712
clarify why there is no v5 2023-10-12 11:46:18 +02:00
Tammi L. Coles
8e8507ebbf
add note regarding zoom in intructions 2023-10-12 11:46:18 +02:00
Tammi L. Coles
9ba166f4df
remove (interop_section)= line 2023-10-12 11:46:18 +02:00
Tammi L. Coles
b39d808290
move interoperability section 2023-10-12 11:46:18 +02:00
Tammi L. Coles
a8c14033a7
correct typo 2023-10-12 11:46:18 +02:00
Tammi L. Coles
02603ef7db
correct typo 2023-10-12 11:46:18 +02:00
Tammi L. Coles
bfb34f8f6b
change header on implementations 2023-10-12 11:46:18 +02:00
Tammi L. Coles
5b5e449925
note that an issue needs to be created re v5 2023-10-12 11:46:18 +02:00
Tammi L. Coles
b3338bb4e2
note that an issue needs to be created re OpenPGP line 2023-10-12 11:46:18 +02:00
Tammi L. Coles
985f29d4c7
fix punctuation 2023-10-12 11:46:18 +02:00
Tammi L. Coles
3c75ccc3c5
edit certificates and keys concept section 2023-10-12 11:46:18 +02:00
Tammi L. Coles
5077358a99
add line breaks for legibility 2023-10-12 11:46:18 +02:00
Tammi L. Coles
fb0b47d4f4
add line breaks for legibility 2023-10-12 11:46:18 +02:00
Tammi L. Coles
9b81ebb8fe
improve text re version 6 2023-10-12 11:46:18 +02:00
Tammi L. Coles
9ef56526bc
improve text re version 4 and its implementations 2023-10-12 11:46:18 +02:00
Tammi L. Coles
7a0b4832ec
edit history to of PGP, standardizing, and GnuPG 2023-10-12 11:46:18 +02:00
Tammi L. Coles
6679f2fdf9
edit language and punctuation of PGP line 2023-10-12 11:46:18 +02:00
Tammi L. Coles
e103ac0797
expand "why OpenPGP" section 2023-10-12 11:46:18 +02:00
Tammi L. Coles
797ff78719 Merge pull request 'ch1: high level text moved here (formerly from ch2)' (#44) from tammi-ch1 into draft
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/44
2023-10-12 09:43:26 +00:00
Heiko Schaefer
b1dab566a8
ch3: move terminology note into an
"admonition"
2023-10-09 18:04:54 +02:00
Tammi L. Coles
63c3a2c94a edit section on layers of keys, integrating previoous Ch2 section 2023-10-07 15:13:58 +02:00
Tammi L. Coles
f9d0c132ee clarify in section on public vs private keys 2023-10-07 15:03:43 +02:00
Tammi L. Coles
edad5d19bf edit section intro on understanding keys 2023-10-07 14:49:26 +02:00
Tammi L. Coles
b28166a251 change opening lines/introduction to chapter 2023-10-07 14:45:56 +02:00
Tammi L. Coles
3f8fb4690f change format to standard and clarify role 2023-10-07 14:12:45 +02:00
Tammi L. Coles
6a22002cb8 remove unnecessary line breaks 2023-10-07 13:34:50 +02:00
Tammi L. Coles
67bdc2f64b integrate operations & building blocks statements formerly in Ch2 2023-10-07 13:29:31 +02:00
Heiko Schaefer
7e760f2035
ch4: minor edits 2023-10-05 10:33:42 +02:00
Heiko Schaefer
c657d64734
ch4: improvements to "zooming in" 2023-10-05 10:33:42 +02:00
Heiko Schaefer
ec78df2453
ch4: clarify terminology
Also see #43
2023-10-05 10:30:35 +02:00
Heiko Schaefer
d20fbbc13d
ch3: processed feedback from wiktor 2023-10-04 21:21:04 +02:00
Heiko Schaefer
305f039dff
ch4: feedback from wiktor 2023-10-04 18:40:02 +02:00
Heiko Schaefer
810cec05e2
ch2: feedback from david 2023-10-04 16:25:04 +02:00
Heiko Schaefer
8ca953e39e
diag: Use png versions of diagrams for now
In the epub version, some viewers don't show text for svg diagrams (probably a missing font issue).
2023-10-04 16:25:04 +02:00
Heiko Schaefer
0368edef16
ch4: flesh out first part of "zooming in" section 2023-10-04 15:37:39 +02:00
Heiko Schaefer
0a41338801
ch4: simplify "note" markup 2023-10-04 15:35:46 +02:00
Heiko Schaefer
c1e6630f9f
ch10/11: outline adjustments
Move legacy "SED" mode from "encrypt" to "decrypt" chapter
2023-10-04 15:19:12 +02:00
Heiko Schaefer
061f4a9625
ch2: add section about PQC work; move "zooming in" to the end 2023-10-04 14:55:40 +02:00
Heiko Schaefer
ee35f4af51
ch4: remove duplication 2023-10-04 14:33:41 +02:00
Heiko Schaefer
f62fb72190
ch3: drop task (it's done) 2023-10-04 14:33:40 +02:00
Heiko Schaefer
664f3cec86
conf: enable show_relbars
fixes #40
2023-10-04 14:01:51 +02:00
Heiko Schaefer
55d1ce73a1
ch3: improvements suggested by @vanitasvitae
fixes #34
2023-10-04 10:56:10 +02:00
Heiko Schaefer
a59190bf4b
diag: new component key diagram 2023-10-03 20:39:05 +02:00
Heiko Schaefer
724a0673fd
fix/normalize "zooming in" section titles 2023-10-03 20:08:02 +02:00
Heiko Schaefer
cc6077e27c
ch4: use new diagrams 2023-10-03 19:34:48 +02:00
Heiko Schaefer
1f18e9a8ff
ch4: Edit main part of the text 2023-10-03 19:34:48 +02:00
Heiko Schaefer
ea7dc03e46
diag: backsig 2023-10-03 19:34:48 +02:00
Heiko Schaefer
59e292a3ec
diag: clarify metadata 2023-10-03 19:34:48 +02:00
Heiko Schaefer
0cbc17840e
diag: clarify metadata in component keys 2023-10-03 19:34:48 +02:00
Heiko Schaefer
d69617afbd
Appendix A: adjust chapter name
This name is shown when linking to (alice_priv) and not providing a link text.
2023-10-03 19:34:48 +02:00
Heiko Schaefer
59b19eeb89
ch3: use new diagram 2023-10-03 19:34:48 +02:00
Heiko Schaefer
f855a35284
diag: remove duplicate files 2023-10-03 19:18:10 +02:00
skvisual
df73987719
png/svg-Version of
-crypotgraphic keypair
-fingerprint
-OpenPGP_Certificate
-Subkeys
and updated diagram file
2023-10-03 19:14:39 +02:00
Heiko Schaefer
42e37a6260
ch4: Introduce "component" term 2023-10-03 19:14:39 +02:00
Heiko Schaefer
7c94b45ea8
ch4: Add new certificate diagram 2023-10-03 19:14:39 +02:00
skvisual
c19d77e0c0
diag library & openpgp certificate update 2023-10-03 19:14:39 +02:00
skvisual
a488e737f5
diag library & openpgp cert first draft 2023-10-03 19:14:39 +02:00
Heiko Schaefer
85b4003a53
conf: make code_font_size smaller
So that "sq packet dump" output fits into the view column.
2023-10-02 15:38:26 +02:00
Heiko Schaefer
854bda18ad
ch4: adjust to use alice's v6 key; minor edits 2023-10-01 18:32:06 +02:00
Heiko Schaefer
f080803555
ch4: add alt text to figure 2023-10-01 18:30:56 +02:00
Heiko Schaefer
47867b32f4
ch4: update links from 4880 to crypto-refresh 2023-10-01 16:35:17 +02:00
Heiko Schaefer
2640c84181
diag: update to alice's v6 test key 2023-10-01 16:35:16 +02:00
Heiko Schaefer
911b5dfebe
conf: set version to 0.01
EPUB3 generation warns if no version is set.
2023-10-01 15:08:38 +02:00
Heiko Schaefer
9c8a4c388b
drop "indices and tables" from index, for now 2023-10-01 12:41:25 +02:00
Heiko Schaefer
bce536b786
Set project name, copyright 2023-10-01 10:45:31 +02:00
Heiko Schaefer
e8a47130ee
app a: set "language" to text (to avoid odd coloring) 2023-09-30 19:03:42 +02:00
Heiko Schaefer
9d0d27d515
ch3: minor cleanup 2023-09-29 19:01:22 +02:00
Heiko Schaefer
c6ef5266dd
Add appendix chapter for OpenPGP artifacts 2023-09-29 17:24:10 +02:00
Heiko Schaefer
d4306da504
ch3: Flesh out more of the text 2023-09-29 15:57:53 +02:00
Heiko Schaefer
a35573c5a7
fix styling 2023-09-29 09:08:10 +02:00
Heiko Schaefer
278cae874f
Fix styling of Proton Mail 2023-09-28 17:31:13 +02:00
Heiko Schaefer
a9f14e54e9
Rename ch6 to reflect #30 2023-09-28 16:05:27 +02:00
Heiko Schaefer
c494d60176
Note about SKESK use by flowcrypt 2023-09-28 16:02:47 +02:00
Heiko Schaefer
eef2a11842
Add input from Wiktor 2023-09-28 16:02:30 +02:00
Heiko Schaefer
3ef4f265d1
ch1/2: add/improve links
Tighten "Building blocks" section.

(Processing input from Wiktor)
2023-09-28 12:00:45 +02:00
Heiko Schaefer
49cd4f88f3
ch1: tighten terminology 2023-09-28 11:16:40 +02:00
Heiko Schaefer
a649c1fe6d
ch4: tweak structure 2023-09-27 10:04:56 +02:00
Heiko Schaefer
2f2ec4e3e2
ch2: start with a "what's good about OpenPGP" section (needs more work).
Weave in RFC 1991.
2023-09-26 20:52:17 +02:00
Heiko Schaefer
a16d60db4b
ch3: edits 2023-09-26 20:06:44 +02:00
Heiko Schaefer
99cad4bad6
ch2: removing "the present" from title
Also see #22
2023-09-26 16:48:32 +02:00
Heiko Schaefer
9c08792205
mark "TODO"-block with admonition markup 2023-09-26 13:24:03 +02:00
Heiko Schaefer
225e3c3a8d
mark "TODO"-blocks with admonition markup
(also see https://codeberg.org/openpgp/notes/issues/3)
2023-09-26 13:22:12 +02:00
Heiko Schaefer
c72432af4b
ch6: add snapshot of Paul's changes from #25 (for easier test-reading) 2023-09-26 13:20:34 +02:00
Heiko Schaefer
6d38a9cc1f
armor: add some content and outline 2023-09-26 12:56:56 +02:00
Heiko Schaefer
abc73e463a
resources: add crypto-refresh draft
Move (somewhat) GnuPG-specific document to separate section
2023-09-26 12:04:52 +02:00
Heiko Schaefer
9d0b84e7a6
ch3/4: Include diagrams as figures with caption
Fixes #28
2023-09-25 19:39:25 +02:00
Heiko Schaefer
db65d8ec6b
ch2: Fix GnuGP styling 2023-09-25 18:02:23 +02:00
Heiko Schaefer
1eb38338f2
ch15: add link to EmailSummit202305Notes 2023-09-25 17:27:16 +02:00
Heiko Schaefer
0013875b7f
ch8: sections 2023-09-25 17:23:37 +02:00
Heiko Schaefer
2bfd321c90
fix filename 2023-09-25 17:18:51 +02:00
Heiko Schaefer
a7e435c31d
move certificate validity from ch9 to ch4 2023-09-25 17:14:10 +02:00
Heiko Schaefer
0a51073367
add "compression" and "migration chapters" 2023-09-25 16:48:18 +02:00
Heiko Schaefer
3f5e1c170a
ch10: outline 2023-09-25 16:43:36 +02:00
Heiko Schaefer
8390a4b23c
ch3: add section for signatures 2023-09-25 16:43:26 +02:00
Heiko Schaefer
1834ef9a5e
ch4: move packet section to the end 2023-09-25 16:42:48 +02:00
Heiko Schaefer
f985121444
Insert new chapter "signatures over data" after ch6 2023-09-25 14:19:24 +02:00
Heiko Schaefer
319f258aca
ch4: work on structure
Move introduction of asymmetric key pairs and diagrams to ch3.
2023-09-25 14:11:44 +02:00
Heiko Schaefer
e5500ac6f8
ch5: outline sketch 2023-09-25 14:00:14 +02:00
Heiko Schaefer
61d5b010f8
ch4: white background for diagram pngs 2023-09-23 14:43:12 +02:00
Heiko Schaefer
5cef8e87c6
ch4: edits for clarity 2023-09-21 20:15:13 +02:00
Heiko Schaefer
cd09323991
ch4: component keys, edits
(process feedback from https://codeberg.org/openpgp/doc-int/issues/5)
2023-09-21 20:12:55 +02:00
Heiko Schaefer
606acf6be9
ch4: fingerprint diag shouldn't show private key material 2023-09-21 20:12:47 +02:00
Heiko Schaefer
a6da5bacc2
ch4: add diagram for "only public part of keypair" 2023-09-21 19:12:56 +02:00
Heiko Schaefer
aae6fbcd36
ch2: minor edits 2023-09-21 19:12:56 +02:00
Heiko Schaefer
740451c2c6
index: transform from .rst to .md
(And comment out "Indices and tables" for the time being)
2023-09-21 16:25:32 +02:00
Heiko Schaefer
60025101f5
ch4: drop linebreaks, very minor edits 2023-09-21 16:09:44 +02:00
Heiko Schaefer
8aa34dfa59
ch4: fold outline notes into section structure 2023-09-21 15:46:03 +02:00
Heiko Schaefer
46c465ed06
ch3: add note 2023-09-21 13:09:48 +02:00
Heiko Schaefer
5524208814
Glossary: migrate back to markdown
fixes #15
2023-09-21 12:50:17 +02:00
Heiko Schaefer
428b61f4d9
ch12: use outline notes as sections 2023-09-21 11:37:24 +02:00
Heiko Schaefer
e1174a2c79
ch11: add note 2023-09-21 11:36:43 +02:00
Heiko Schaefer
3a57e9b614
Glossary: adjust to appropriate syntax
As outlined in #15
2023-09-21 11:36:14 +02:00
Heiko Schaefer
6a37e6966d
Edits of chapter 2
Integrates Paul's suggestions in #20
2023-09-20 22:33:52 +02:00
Heiko Schaefer
b56b56f9b6
ch4 rename file 2023-09-20 20:49:05 +02:00
Heiko Schaefer
00caec7a1f
Include chapters automatically (":glob:" adds files in alphabetical order) 2023-09-20 18:26:11 +02:00
Heiko Schaefer
55f8b85006
Edits in chapter two; add link anchors to point to 2023-09-20 14:48:26 +02:00
heiko
d5fab425d5 Merge pull request 'Add examples to key terminology section' (#9) from vanitasvitae/openpgp-notes:certsExamples into draft
Good points, thanks!

Reviewed-on: https://codeberg.org/openpgp/notes/pulls/9
2023-09-18 10:03:05 +00:00
20ffb8e53b
Add examples to key terminology section 2023-09-18 11:43:13 +02:00
e826b78605
Add note about 'pgp key' vs. 'gpg key' 2023-09-18 11:26:21 +02:00
Heiko Schaefer
1dab72fc59
Rename ch3->ch2; add a new possible ch3 based on a suggestion by Lars 2023-09-16 18:01:26 +02:00
Heiko Schaefer
10c7bfe182
ch3: remove hard line breaks, some edits 2023-09-15 18:10:28 +02:00
Heiko Schaefer
be11d61d35
ch1: minor changes to structure; some clarifications and fixes. 2023-09-15 18:08:14 +02:00
Tammi L. Coles
591942bd83 reformat comments as code blocks for visibility 2023-09-15 16:09:28 +02:00
Tammi L. Coles
123297faeb correct spacing, line breaks 2023-09-15 16:02:19 +02:00
Tammi L. Coles
0ce597c62b add line break for comment visibility 2023-09-15 15:55:13 +02:00
Tammi L. Coles
82a9aca693 edit audience and RFC sections 2023-09-15 15:52:58 +02:00
Tammi L. Coles
0ea6b907ab simplify organization and text; request info 2023-09-15 14:34:32 +02:00
Heiko Schaefer
6f58af0aa8
Slightly more structure for "highlevel" 2023-09-15 14:12:26 +02:00
Tammi L. Coles
bb00bb33fe suggest Heiko create page on interoperability 2023-09-15 13:57:26 +02:00
Tammi L. Coles
b4d9c10668 remove test message to proceed 2023-09-15 13:36:01 +02:00
Tammi L. Coles
3e1236db39 test setup 2023-09-15 13:34:54 +02:00
Heiko Schaefer
8e63fe49c9
fold "goals" into ch1 2023-09-15 13:05:07 +02:00
Heiko Schaefer
5d5079ccb8
move history and present to ch3 2023-09-15 13:03:59 +02:00
Heiko Schaefer
558a3720d8
Ch2: edit 2023-09-15 12:14:20 +02:00
Heiko Schaefer
902467aa86
Ch2: versions 2023-09-15 12:13:18 +02:00
Heiko Schaefer
0679507b03
Sort out rough flow of ch2 2023-09-15 11:54:36 +02:00
Heiko Schaefer
913612b0ee
Sorted out rough flow of ch1 2023-09-15 11:14:06 +02:00
Heiko Schaefer
c8054b9120
Initial outline and old notes
(Rough merge of two precursor projects by Heiko, and outline notes by Paul)
2023-09-14 21:30:43 +02:00