From 6d38a9cc1fe4646d7ea0169a23dfcf2039d9b240 Mon Sep 17 00:00:00 2001 From: Heiko Schaefer Date: Tue, 26 Sep 2023 12:56:56 +0200 Subject: [PATCH] armor: add some content and outline --- book/source/13-armor.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/book/source/13-armor.md b/book/source/13-armor.md index 14b2742..a50c1fe 100644 --- a/book/source/13-armor.md +++ b/book/source/13-armor.md @@ -1,7 +1,31 @@ # ASCII Armor -``` - - Why? - - CRC and [its deprecation in crypto-refresh](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-optional-checksum) +The native format of OpenPGP data is binary. + +However, in many use cases it is customary to use OpenPGP data in a non-binary encoding called "ASCII Armor." For example, ASCII Armored OpenPGP data is often used in email, for encrypted messages or for signatures. + +OpenPGP's ASCII Armor mechanism consists of: + +- A [header line](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-armor-header-line) +- [Headers](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-armor-headers) that can contain additional metadata +- The [Base64 encoded](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-base64-conversions) OpenPGP data + - An optional checksum for this data +- A ["tail line"](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-armor-tail-line) (footer) that matches the header line + +## The Cleartext Signature Framework + +```{admonition} TODO +:class: warning + +Explain/discuss, [link](https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-cleartext-signature-framewo) + - Linebreak normalization? -``` \ No newline at end of file + - Dash escaping +``` + + +## Advanced topics + +### CRC (and its deprecation in crypto-refresh) + +See https://www.ietf.org/archive/id/draft-ietf-openpgp-crypto-refresh-10.html#name-optional-checksum