From 1c7179bd8e2421ea3dd49f21a9106b0e50f60287 Mon Sep 17 00:00:00 2001 From: Heiko Schaefer Date: Mon, 11 Dec 2023 17:35:55 +0100 Subject: [PATCH] restructuring experiment --- book/source/{ => adv}/17a-adv-certificates.md | 2 +- book/source/{ => adv}/17b-adv-private.md | 0 book/source/{ => adv}/17c-adv-signatures.md | 0 book/source/{ => adv}/17d-adv-sign-data.md | 0 .../source/{ => adv}/17e-adv-sig-component.md | 0 book/source/index.md | 34 ++++++++++++++++++- .../certificates.md} | 8 ++--- .../encyption.md} | 2 +- .../private_keys.md} | 2 +- .../signatures.md} | 0 10 files changed, 40 insertions(+), 8 deletions(-) rename book/source/{ => adv}/17a-adv-certificates.md (99%) rename book/source/{ => adv}/17b-adv-private.md (100%) rename book/source/{ => adv}/17c-adv-signatures.md (100%) rename book/source/{ => adv}/17d-adv-sign-data.md (100%) rename book/source/{ => adv}/17e-adv-sig-component.md (100%) rename book/source/{18-zoom_certificates.md => zoom/certificates.md} (99%) rename book/source/{21-zoom_encyption.md => zoom/encyption.md} (98%) rename book/source/{19-zoom_private_keys.md => zoom/private_keys.md} (99%) rename book/source/{20-zoom_signatures.md => zoom/signatures.md} (100%) diff --git a/book/source/17a-adv-certificates.md b/book/source/adv/17a-adv-certificates.md similarity index 99% rename from book/source/17a-adv-certificates.md rename to book/source/adv/17a-adv-certificates.md index a48488e..5a8d727 100644 --- a/book/source/17a-adv-certificates.md +++ b/book/source/adv/17a-adv-certificates.md @@ -7,7 +7,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0 ## When are certificates valid? -Certificates are composites of components that are linked together using [signatures](08-signing_components). +Certificates are composites of components that are linked together using [signatures](../08-signing_components). A certificate can be valid or invalid as a whole. However, even when a certificate is valid, individual components (subkeys or identities) of it can be invalid. diff --git a/book/source/17b-adv-private.md b/book/source/adv/17b-adv-private.md similarity index 100% rename from book/source/17b-adv-private.md rename to book/source/adv/17b-adv-private.md diff --git a/book/source/17c-adv-signatures.md b/book/source/adv/17c-adv-signatures.md similarity index 100% rename from book/source/17c-adv-signatures.md rename to book/source/adv/17c-adv-signatures.md diff --git a/book/source/17d-adv-sign-data.md b/book/source/adv/17d-adv-sign-data.md similarity index 100% rename from book/source/17d-adv-sign-data.md rename to book/source/adv/17d-adv-sign-data.md diff --git a/book/source/17e-adv-sig-component.md b/book/source/adv/17e-adv-sig-component.md similarity index 100% rename from book/source/17e-adv-sig-component.md rename to book/source/adv/17e-adv-sig-component.md diff --git a/book/source/index.md b/book/source/index.md index 23e7fcd..0e4a7ac 100644 --- a/book/source/index.md +++ b/book/source/index.md @@ -12,5 +12,37 @@ SPDX-License-Identifier: CC-BY-SA-4.0 :maxdepth: 2 :glob: -* +01-intro.md +02-highlevel.md +03-cryptography.md +04-certificates.md +05-private.md +06-signatures.md +07-signing_data.md +08-signing_components.md +09-verification.md +10-encryption.md +11-decryption.md +12-compression.md +13-armor.md +14-pitfalls.md +15-policy.md +16-versions.md +17-migration.md + +adv/17a-adv-certificates.md +adv/17b-adv-private.md +adv/17c-adv-signatures.md +adv/17d-adv-sign-data.md +adv/17e-adv-sig-component.md + +zoom/certificates.md +zoom/private_keys.md +zoom/signatures.md +zoom/encyption.md + +22-resources.md +23-glossary.md +24-acknowledgements.md +a-artifacts.md ``` diff --git a/book/source/18-zoom_certificates.md b/book/source/zoom/certificates.md similarity index 99% rename from book/source/18-zoom_certificates.md rename to book/source/zoom/certificates.md index b43f44d..9c09a64 100644 --- a/book/source/18-zoom_certificates.md +++ b/book/source/zoom/certificates.md @@ -47,7 +47,7 @@ alice.pub-9--Signature ``` -```{figure} plain_svg/certificate_packet_list.svg +```{figure} ../plain_svg/certificate_packet_list.svg :name: fig-certificate-packet-list :alt: Depicts a box with white background and the title "Certificate packet list". Inside, a list of several boxes on white background and varying frame colors represent a list of OpenPGP packets from top to bottom. The first box, with green frame, represents the "Public-Key packet", and includes the green public key symbol. The second box, with yellow frame, represents a "Signature packet" ("Direct Key Signature") and includes the green cryptographic signature symbol. The third box, with black frame, represents a "User ID packet", and includes the black User ID symbol. The fourth box, with yellow frame, represents a "Signature packet" ("Certifying self-signature for User ID"), and includes the green cryptographic signature symbol. The fifth box, with green frame, represents a "Public-Subkey packet" and includes the green public key symbol. The sixth box, with yellow frame, represents a "Signature packet" ("Subkey binding signature") and includes the green cryptographic signature symbol. The seventh box, with green frame, represents a "Public-Subkey packet" and includes the green public key symbol. The eighth box, with yellow frame, represents a "Signature packet" ("Subkey binding signature") and includes the green cryptographic signature symbol. The ninth box, with green frame, represents a "Public-Subkey packet" and includes the green public key symbol. The tenth box, with yellow frame, represents a "Signature packet" ("Subkey binding signature") and includes the green cryptographic signature symbol. @@ -77,7 +77,7 @@ This version of Alice's certificate contains just two packets: This is the shape of the packets we'll explore in the subsequent sections: -```{figure} plain_svg/Minimal_OpenPGP_certificate.svg +```{figure} ../plain_svg/Minimal_OpenPGP_certificate.svg :name: fig-public-certificate-minimal :alt: TODO @@ -173,7 +173,7 @@ The packet type ID ("6") defines the semantics of the following data within the Note that the *Public-Key packet* contains only the public part of the key. -```{figure} plain_svg/public-key_packet.svg +```{figure} ../plain_svg/public-key_packet.svg :name: fig-public-key-packet :alt: Depicts a box with white background and title "Public-Key packet". In the center a box with white background and green frame is shown. Inside it several items are listed, separated by green dotted horizontal lines. The first three are "Version", "Creation Time", "Public-Key Algorithm" written in black. The last one is written in green and reads "Public Key Material" and has the green public key symbol at its right side. @@ -365,7 +365,7 @@ The hash digest is calculated from the following data (see [Computing Signatures The signature is calculated from this hash digest. -```{figure} plain_svg/direct_key_signature_packet.svg +```{figure} ../plain_svg/direct_key_signature_packet.svg :name: fig-direct-key-signature-packet :alt: Depicts a box with white background, title "Signature packet" and subtitle "Direct Key Signature (type ID 0x1F)". In the center a box with white background and yellow frame is shown. Inside it several items are listed, separated by yellow dotted horizontal lines. The first three are "Version", "Public-Key Algorithm" and "Hash Algorithm". The fourth item is called "Hashed area" and confines further sub-items by a light-yellow frame on the top and left side. The sub-items are "Signature Creation Time", "Key Expiration Time", "Preferred Symmetric Ciphers for v1 SEIPD", "Preferred Hash Algorithms", "Key Flags", "Features" and "Issuer Fingerprint". The fifth item is named "Unhashed area" and again introduces an area for sub-items, this time using a light-gray border on the top and left side. The unhashed area has no sub-items though. The last item is called "Cryptographic Signature", with the subtitle "by the primary key over primary key, subkey and signature metadata" and includes the green cryptographic signature symbol on the right side. diff --git a/book/source/21-zoom_encyption.md b/book/source/zoom/encyption.md similarity index 98% rename from book/source/21-zoom_encyption.md rename to book/source/zoom/encyption.md index f48b73b..0005314 100644 --- a/book/source/21-zoom_encyption.md +++ b/book/source/zoom/encyption.md @@ -18,7 +18,7 @@ $ echo "hello world" | sq encrypt --recipient-file alice.pub This produces an ASCII armored encrypted message: -```{literalinclude} examples/ascii_armored_encrypted_message.asc +```{literalinclude} ../examples/ascii_armored_encrypted_message.asc :language: text ``` diff --git a/book/source/19-zoom_private_keys.md b/book/source/zoom/private_keys.md similarity index 99% rename from book/source/19-zoom_private_keys.md rename to book/source/zoom/private_keys.md index 6454bbd..ef4b90e 100644 --- a/book/source/19-zoom_private_keys.md +++ b/book/source/zoom/private_keys.md @@ -22,7 +22,7 @@ The output starts with the (primary) [Secret-Key packet](https://www.ietf.org/ar This is the structure of the Secret-Key packet we will now look at. -```{figure} plain_svg/secret-key_packet.svg +```{figure} ../plain_svg/secret-key_packet.svg :name: fig-secret-key-packet :alt: Depicts a box with white background and title "Secret-Key packet". In the center a box with white background and red frame is shown. Inside it several items are listed, separated by red dotted horizontal lines. The first three are "Version", "Creation Time", "Public-Key Algorithm" written in black. The fourth one is written in green and reads "Public Key Material" and has the green public key symbol at its right side. The fifth one is again written in black and reads "S2K Usage (Secret Key Encryption)". The sixth item reads "Secret Key Material", written in red and has the red private key symbol at its right side. diff --git a/book/source/20-zoom_signatures.md b/book/source/zoom/signatures.md similarity index 100% rename from book/source/20-zoom_signatures.md rename to book/source/zoom/signatures.md