vanitasvitae/openpgp-notes
1
0
Fork 0
mirror of https://codeberg.org/openpgp/notes.git synced 2024-11-26 17:42:06 +01:00
Code Issues Projects Releases Packages Wiki Activity

simplify organization and text; request info

Browse source
This commit is contained in:
Tammi L. Coles 2023-09-15 14:20:19 +02:00
parent 6f58af0aa8
commit 0ea6b907ab
1 changed files with 17 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,52 +1,39 @@
# Notes on OpenPGP # Introducing OpenPGP
An introduction to the concepts of OpenPGP, aimed mainly at software This documentation project seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.
developers who are looking to use OpenPGP functionality in their projects.
This document describes This document describes [OpenPGP version 6](https://datatracker.ietf.org/doc/draft-ietf-openpgp-crypto-refresh/), with occasional remarks about differences to earlier versions.
[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 who use OpenPGP-related software. This text is *not* intended as a guide for end-users of OpenPGP-related software.
## What is OpenPGP? ## What is OpenPGP?
OpenPGP is an open standard for cryptographic operations. 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)"](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) encryption program and has many widely used and interoperable implementations.
It has grown out of the
["Pretty Good Privacy (PGP)"](https://en.wikipedia.org/wiki/Pretty_Good_Privacy)
software.
OpenPGP is an open standard, there are many widely used
(and [interoperable](https://tests.sequoia-pgp.org/)) implementations.
{::comment} {::comment}
Heiko, let's be sure to create our own page on iteroperability instead of linking to this Heiko, let's be sure to create our own page on interoperability instead of linking to this
{:/comment} {:/comment}
## Goals of this document ## Who is the audience for this document?
There are three groups of people who interact with OpenPGP: Three groups of people interact with OpenPGP:
1. End-Users, who use software that contains OpenPGP functionality (e.g., the Thunderbird email software) 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 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 3. Implementers of libraries or software that handles the processing of internal OpenPGP data structures
This document is focused at the second of these groups: This document is focused on software developers who use OpenPGP functionality in their software projects. It is not intended for end-users.
software developers who use OpenPGP functionality in their software projects. {::comment}
Heiko, we should elaborate a bit on why here
It is not intended for end-users who use software that contains OpenPGP functionality. {:/comment}
Thus, this text describes OpenPGP at the "library-level," teaching concepts that will help software developers get started as a user of any implementation
This text aims to describe OpenPGP at the "library-level": (e.g., OpenPGP JS, Sequoia PGP).
we teach the concepts that will help you get started as a user of any implementation
(such as OpenPGP JS, Sequoia PGP, ...)
### Requirements ### Requirements
We presuppose solid knowledge in both software development concepts, We presuppose solid knowledge of software development concepts and of general cryptographic concepts.
and of general cryptographic concepts.
OpenPGP is a system based on well-understood cryptographic building blocks. OpenPGP is a system based on well-understood cryptographic building blocks.
We describe the properties of the OpenPGP system, and how to use it. We describe the properties of the OpenPGP system and how to use it.
### A companion for the OpenPGP RFC ### A companion for the OpenPGP RFC