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

emphasize version agnostic, general applicability

Browse source
This commit is contained in:
Tammi L. Coles 2023-12-09 15:45:37 +01:00
parent d04b91eb48
commit 162d24a55a
1 changed files with 4 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
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 major release 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,6 @@ This document describes OpenPGP concepts at the "library" level of abstraction,
## Which version of OpenPGP does this address?
This documentation covers all aspects of modern OpenPGP, most of which are common between current and upcoming versions. The basic concepts of OpenPGP are shared between all versions. Where there are differences, we center version 6, while occasionally noting differences to previous versions that are relevant to application developers.
This documentation encompasses the core aspects of modern OpenPGP, demonstrating that, at a foundational level, there is a significant overlap in functionality across various versions. Our focus on version 6 does not imply a preference or superiority over other versions; rather, it serves as a current reference point. We acknowledge that earlier versions, particularly version 4, continue to be relevant and widely used in ongoing projects.
Version 4 of OpenPGP will remain relevant for a number of years;
some version 3 artifacts are still in use as of this writing.
Where differences between versions exist, specific attention is given to those aspects pertinent to application developers, ensuring that the content is version-agnostic and broadly applicable.