vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2024-11-23 16:12:05 +01:00
Code Issues Projects Releases Packages Wiki Activity
openpgp-notes/book/source/01-intro.md
Tammi L. Coles 82a9aca693 edit audience and RFC sections
2023-09-15 15:52:58 +02:00

3.1 KiB
Raw Blame History

Introducing OpenPGP

This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.

This document describes OpenPGP version 6, with occasional remarks about differences to earlier versions.

This text is not intended as a guide for end-users of OpenPGP-related software.

What is OpenPGP?

OpenPGP is an open standard for cryptographic operations. OpenPGP supports the secure delivery of files and messages between a sender and a recipient as well as verification of the sender. OpenPGP is an outgrowth of the "Pretty Good Privacy (PGP)" encryption program and has many widely used and interoperable implementations.
{::comment} Heiko, let's be sure to create our own page on interoperability instead of linking to this {:/comment}

Who is the audience for this document?

OpenPGP is a system based on well-understood cryptographic building blocks. Three groups of people interact with OpenPGP:

  1. End-users, who use software that contains OpenPGP functionality (e.g., the Thunderbird email software)
  2. Software developers who build applications that contain OpenPGP functionality
  3. Implementers of libraries or software that handles the processing of internal OpenPGP data structures

This document is focused on the second group, software developers, who use OpenPGP functionality in their software projects. It describes the properties of the OpenPGP system and its uses. It presupposes solid knowledge of software development concepts and of general cryptographic concepts. Thus, this text describes OpenPGP at the "library-level," teaching concepts that will help software developers get started as a user of any implementation (e.g., OpenPGP JS, Sequoia PGP).

{::comment} Heiko, we should elaborate a bit on why here {:/comment}

This document is not intended for end-users. It is also not for implementers of libraries or software.

Why not just use the OpenPGP RFC?

The OpenPGP RFC defines the message formats used in OpenPGP to provide encryption with public-key or symmetric cryptographic algorithms, digital signatures, compression and key management.

The RFC explains details (what goes where) that are crucial for implementers of software that handle internal OpenPGP data structures. However, it is not as critical for software developers who use OpenPGP through a library.

This document describes OpenPGP concepts at the "library" level of abstraction, ignoring much about how OpenPGP artifacts are encoded at the lowest level to address common OpenPGP artifacts as they are currently used.

Which version of OpenPGP does this address?

The documentation will mainly cover version 4 of OpenPGP, while occasionally noting differences to previous versions that are relevant to application developers.

Version 4 of OpenPGP will remain relevant for a number of years; some version 3 artifacts are still in use as of this writing.