vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2025-12-05 05:01:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update other references to the RFC

Browse source
This commit is contained in:
Heiko Schaefer 2025-10-19 15:09:24 +02:00
parent 9e1ba07748
commit 8ab7abc76d
No known key found for this signature in database
GPG key ID: DAE9A9050FCCF1EB
5 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

7
book/source/about.md
View file

@ -5,7 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
# Introducing OpenPGP # Introducing OpenPGP
This documentation project is designed to provide a comprehensive understanding of OpenPGP, highlighting its functionalities and applications for software developers. While this document predominantly references [OpenPGP version 6, as outlined in the latest RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), it is important to note that the fundamental principles and functionalities of OpenPGP have remained consistent across its versions since its first release as an open standard in RFC 2440 in 1998. This documentation project is designed to provide a comprehensive understanding of OpenPGP, highlighting its functionalities and applications for software developers. While this document predominantly references [OpenPGP version 6, as specified in RFC 9580](https://www.rfc-editor.org/rfc/rfc9580.html), it is important to note that the fundamental principles and functionalities of OpenPGP have remained consistent across its versions since its first release as an open standard in RFC 2440 in 1998.
This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects. This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects.
@ -33,14 +33,13 @@ Instead, this document is mainly aimed at the second group, application develope
The document may also serve as a useful supplement to the RFC for implementers of OpenPGP libraries (or other software that directly handles internal OpenPGP data structures). The document may also serve as a useful supplement to the RFC for implementers of OpenPGP libraries (or other software that directly handles internal OpenPGP data structures).
With the emergence of a new crop of modern, high-quality OpenPGP libraries, and the imminent release of the updated [OpenPGP version 6 specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), we think that now is a great time to implement OpenPGP functionality in applications or to modernize existing OpenPGP subsystems. With the emergence of a new crop of modern, high-quality OpenPGP libraries, and the release of the updated [OpenPGP RFC 9580](https://www.rfc-editor.org/rfc/rfc9580.html), we think that now is a great time to implement OpenPGP functionality in applications or to modernize existing OpenPGP subsystems.
The goal of this document is to offer an implementation-independent introduction to the OpenPGP technology, assisting software developers in quickly familiarizing themselves and serving as a pathway to relevant information in the RFC. The goal of this document is to offer an implementation-independent introduction to the OpenPGP technology, assisting software developers in quickly familiarizing themselves and serving as a pathway to relevant information in the RFC.
## Why not just use the OpenPGP RFC? ## Why not just use the OpenPGP RFC?
The [OpenPGP RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) The [OpenPGP RFC 9580](https://www.rfc-editor.org/rfc/rfc9580.html) defines *the message formats used in OpenPGP.* That is, it describes the internal structure of OpenPGP data, which is crucial for OpenPGP library implementers. However, this level of detail is not required for software developers who use OpenPGP via a library.
defines *the message formats used in OpenPGP.* That is, it describes the internal structure of OpenPGP data, which is crucial for OpenPGP library implementers. However, this level of detail is not required for software developers who use OpenPGP via a library.
This document describes OpenPGP concepts at the "library" level of abstraction, omitting unnecessary detail about the internal encoding of OpenPGP artifacts. Instead, we focus on the properties of these OpenPGP artifacts and how they are used, while adding context that is not elaborated on in the [RFC](https://en.wikipedia.org/wiki/Request_for_Comments). This document describes OpenPGP concepts at the "library" level of abstraction, omitting unnecessary detail about the internal encoding of OpenPGP artifacts. Instead, we focus on the properties of these OpenPGP artifacts and how they are used, while adding context that is not elaborated on in the [RFC](https://en.wikipedia.org/wiki/Request_for_Comments).

2
book/source/adv/certificates.md
View file

@ -369,7 +369,7 @@ Additional mechanisms [are upcoming](support-for-1pa3pc).
This mechanism uses the *attested certifications* signature subpacket (type ID `37`), which currently only exists as a proposed feature in [draft-ietf-openpgp-rfc4880bis](https://www.ietf.org/archive/id/draft-ietf-openpgp-rfc4880bis-10.html#table-3)[^ac-draft]. This mechanism uses the *attested certifications* signature subpacket (type ID `37`), which currently only exists as a proposed feature in [draft-ietf-openpgp-rfc4880bis](https://www.ietf.org/archive/id/draft-ietf-openpgp-rfc4880bis-10.html#table-3)[^ac-draft].
[^ac-draft]: Introducing the *attested certifications* signature subpacket (type ID `37`) was unfortunately not in scope of the chartered topics for the current "crypto-refresh" work of the OpenPGP working group. However, hopefully the working group can handle this feature in future rechartering. [^ac-draft]: Introducing the *attested certifications* signature subpacket (type ID `37`) was unfortunately not in scope of the chartered topics for the recent "RFC 9580" work of the OpenPGP working group. However, hopefully the working group can handle this feature in future rechartering.
(support-for-1pa3pc)= (support-for-1pa3pc)=
### Support ### Support

2
book/source/glossary.md
View file

@ -555,7 +555,7 @@ Revocation Signature Packet
Additionally, with the deprecated *Revocation Key* mechanism, {term}`third-party<Third-party Signature>` *Key-* and *Subkey revocations* also exist. Additionally, with the deprecated *Revocation Key* mechanism, {term}`third-party<Third-party Signature>` *Key-* and *Subkey revocations* also exist.
RFC RFC
This document, unless noted otherwise, refers to the [OpenPGP version 6 specification](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/) when referring to *RFC*. This document, unless noted otherwise, refers to [OpenPGP RFC 9580](https://www.rfc-editor.org/rfc/rfc9580.html) when referring to *RFC*.
SEIPD SEIPD
See {term}`Symmetrically Encrypted Integrity Protected Data`. See {term}`Symmetrically Encrypted Integrity Protected Data`.

2
book/source/migration.md
View file

@ -11,7 +11,7 @@ Some of these changes might be subtle, like the addition of a new hash algorithm
This makes it necessary to migrate both implementations and existing user keys and certificates. This makes it necessary to migrate both implementations and existing user keys and certificates.
In this chapter, we want to explore possible steps to migrate from OpenPGP v4 as defined by RFC4880 to v6 (crypto-refresh). In this chapter, we want to explore possible steps to migrate from OpenPGP v4 as defined by RFC4880 to OpenPGP v6 as defined by RFC 9580 (crypto-refresh).
## Adoption of new features ## Adoption of new features

2
book/source/openpgp.md
View file

@ -108,6 +108,6 @@ There is [ongoing work](https://datatracker.ietf.org/doc/draft-ietf-openpgp-pqc/
OpenPGP data is internally structured as "packets." We'll look into examples of this internal structure in a series of chapters at the end of this document. OpenPGP data is internally structured as "packets." We'll look into examples of this internal structure in a series of chapters at the end of this document.
Getting familiar with the internal format of OpenPGP data provides practical insight into the [RFC](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), which describes the internal structure of OpenPGP {term}`packets<Packet>` in full detail, and may also come in handy for debugging issues. Getting familiar with the internal format of OpenPGP data provides practical insight into [RFC 9580](https://www.rfc-editor.org/rfc/rfc9580.html), which describes the internal structure of OpenPGP {term}`packets<Packet>` in full detail, and may also come in handy for debugging issues.
(Most of the time, however, we will look at OpenPGP artifacts at a higher level of abstraction.) (Most of the time, however, we will look at OpenPGP artifacts at a higher level of abstraction.)