2022-07-06 23:56:41 +02:00
|
|
|
PGPainless - Painless OpenPGP
|
|
|
|
|
=============================
|
|
|
|
|
|
2022-07-12 08:49:30 +02:00
|
|
|
**OpenPGP** (`RFC 4480 <https://datatracker.ietf.org/doc/rfc4880/>`_) is an Internet Standard mostly used for email
|
|
|
|
|
encryption.
|
2022-07-06 23:56:41 +02:00
|
|
|
It provides mechanisms to ensure *confidentiality*, *integrity* and *authenticity* of messages.
|
2022-07-12 08:49:30 +02:00
|
|
|
However, OpenPGP can also be used for other purposes, such as secure messaging or as a signature mechanism for
|
|
|
|
|
software distribution.
|
2022-07-06 23:56:41 +02:00
|
|
|
|
2022-07-12 08:49:30 +02:00
|
|
|
**PGPainless** strives to improve the (currently pretty dire) state of the ecosystem of Java libraries and tooling
|
|
|
|
|
for OpenPGP.
|
2022-07-06 23:56:41 +02:00
|
|
|
|
|
|
|
|
The library focuses on being easy and intuitive to use without getting into your way.
|
2022-07-12 08:49:30 +02:00
|
|
|
Common functions such as creating keys, encrypting data, and so on are implemented using a builder structure that
|
|
|
|
|
guides you through the necessary steps.
|
2022-07-06 23:56:41 +02:00
|
|
|
|
2022-07-12 08:49:30 +02:00
|
|
|
Internally, it is based on `Bouncy Castles <https://www.bouncycastle.org/java.html>`_ mighty, but low-level ``bcpg``
|
|
|
|
|
OpenPGP API.
|
|
|
|
|
PGPainless' goal is to empower you to use OpenPGP without needing to write all the boilerplate code required by
|
|
|
|
|
Bouncy Castle.
|
2022-07-06 23:56:41 +02:00
|
|
|
It aims to be secure by default while allowing customization if required.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Contents
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
|
|
|
|
ecosystem.md
|
2022-07-08 00:21:40 +02:00
|
|
|
quickstart.md
|
2022-07-08 18:57:03 +02:00
|
|
|
pgpainless-cli/usage.md
|
2022-07-06 23:56:41 +02:00
|
|
|
sop.md
|
2022-07-11 16:11:40 +02:00
|
|
|
pgpainless-core/indepth.rst
|
