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

correct spacing, line breaks

Browse source
This commit is contained in:
Tammi L. Coles 2023-09-15 16:02:19 +02:00
parent 0ce597c62b
commit 123297faeb
1 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,22 +1,22 @@
# Introducing OpenPGP # 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 seeks to introduce OpenPGP concepts and functionalities to software developers who wish to use it in their projects.
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 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 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 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. 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.
{::comment} {::comment}
Heiko, let's be sure to create our own page on interoperability instead of linking to this Heiko, let's be sure to create our own page on interoperability instead of linking to this
{:/comment} {:/comment}
## Who is the audience for this document? ## 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: 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) 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
@ -24,14 +24,11 @@ OpenPGP is a system based on well-understood cryptographic building blocks. Thre
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). 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} {::comment}
Heiko, we should elaborate a bit on why here Heiko, we should elaborate a bit on why here
{:/comment} {:/comment}
This document is not intended for end-users. It is also not for implementers of libraries or software. 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? ## Why not just use the OpenPGP RFC?
@ -47,7 +44,7 @@ currently used.
## Which version of OpenPGP does this address? ## 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. 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; Version 4 of OpenPGP will remain relevant for a number of years;
some version 3 artifacts are still in use as of this writing. some version 3 artifacts are still in use as of this writing.