vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2025-09-09 11:19:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request 'Edits to clarify that OpenPGP versions aren't super-relevant at the "library level" that we (mostly) write about' (#190) from heiko-ch1 into draft

Browse source 
Reviewed-on: https://codeberg.org/openpgp/notes/pulls/190
This commit is contained in:
heiko 2023-12-09 23:37:48 +00:00
commit f49fb59abc
1 changed files with 6 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
book/source/01-intro.md
View file

@ -5,11 +5,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0
# Introducing OpenPGP
This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.
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 document describes [OpenPGP version 6](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), with occasional remarks about differences to earlier versions.
This text is *not* intended as a guide for end-users of OpenPGP-related software.
This documentation project seeks to introduce all OpenPGP concepts and functionalities to application developers who wish to use it in their projects.
## What is OpenPGP?
@ -46,7 +44,8 @@ This document describes OpenPGP concepts at the "library" level of abstraction,
## Which version of OpenPGP does this address?
The documentation mainly covers version 6 of OpenPGP, while occasionally noting differences to previous versions that are relevant to application developers.
This documentation encompasses the core aspects of modern OpenPGP practices, applicable across different versions. This respects that, at a foundational level, there is significant overlap, continuity, and consistency from its earliest version to its latest.
Version 4 of OpenPGP will remain relevant for a number of years;
some version 3 artifacts are still in use as of this writing.
While using version 6 as a reference for current standards, we include insights derived from earlier versions, particularly version 4, which continues to be widely used in ongoing projects.
Where differences between OpenPGP versions are relevant to application development, we provide focused insights to ensure the content remains as version-agnostic as possible and, thus, broadly applicable for developers working with various iterations of OpenPGP.