196 lines
14 KiB
ReStructuredText
196 lines
14 KiB
ReStructuredText
PGPy: Pretty Good Privacy for Python
|
|
====================================
|
|
|
|
.. image:: https://badge.fury.io/py/PGPy.svg
|
|
:target: http://badge.fury.io/py/PGPy
|
|
:alt: Latest version
|
|
|
|
.. image:: https://travis-ci.org/Commod0re/PGPy.svg?branch=master
|
|
:target: https://travis-ci.org/Commod0re/PGPy
|
|
:alt: Travis-CI
|
|
|
|
.. image:: https://coveralls.io/repos/Commod0re/PGPy/badge.png
|
|
:target: https://coveralls.io/r/Commod0re/PGPy
|
|
:alt: Coveralls
|
|
|
|
Homepage: None yet.
|
|
|
|
`PGPy` is a Python (2 and 3) library for implementing Pretty Good Privacy into Python programs.
|
|
|
|
Features
|
|
--------
|
|
|
|
RFC 4880 compliance with the following data:
|
|
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| Feature | Completion |
|
|
+=====================+=========+=========+============+==============+==============+============+
|
|
| Packet Tags | Old Format | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | New Format | Done |
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| ASCII-armoring | Decoding | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | Encoding | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | CRC24 Computation | Done |
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| Unversioned Packets | **Tag** | **Name** |
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| | 1 | Public-Key Encrypted Session Key Packets | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 3 | Symmetric-Key Encrypted Session Key Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 4 | One-Pass Signature Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 8 | Compressed Data Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 9 | Sym. Encrypted Data Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 10 | Marker Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 11 | Literal Data Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 12 | Trust Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 13 | User ID Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 17 | User Attribute Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 18 | Sym. Enc. & Integrity Protected Data Packet | No |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 19 | Modification Detection Code Packet | No |
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| Versioned Packets | **Tag** | **Name** |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 2 | Signature Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 5 | Secret-Key Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 6 | Public-Key Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 7 | Secret-Subkey Packet | Done |
|
|
+ +---------+---------+------------+--------------+--------------+------------+
|
|
| | 14 | Public-Subkey Packet | Done |
|
|
+---------------------+---------+---------+------------+--------------+--------------+------------+
|
|
| Actions | Keys | Loading | ASCII | Done |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | GPG Keyrings | Done |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | GPG Agents | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | Generate | RSA | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | DSA | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | ElGamal | No |
|
|
+ +--------+----------+------------+--------------+--------------+------------+
|
|
| | Symmetric-Key | IDEA | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | TripleDES | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | CAST5 | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | Blowfish | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | AES | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | Twofish | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ +--------+----------+------------+--------------+--------------+------------+
|
|
| | Public-Key | RSA | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Sign | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Verify | Done |
|
|
+ + +------------+--------------+--------------+------------+
|
|
| | | DSA | Encrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Decrypt | Key Material | No |
|
|
+ + + + +--------------+------------+
|
|
| | | | | Messages | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Sign | No |
|
|
+ + + +--------------+--------------+------------+
|
|
| | | | Verify | No |
|
|
+---------------------+--------+----------+------------+--------------+--------------+------------+
|
|
|
|
Installation
|
|
------------
|
|
|
|
To install PGPy, simply:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install PGPy
|
|
|
|
Examples
|
|
--------
|
|
|
|
None yet!
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
None yet!
|
|
|
|
Requirements
|
|
------------
|
|
|
|
- Python >= 2.7
|
|
|
|
Tested with: 3.4, 3.3, 3.2, 2.7
|
|
|
|
- `Requests <https://pypi.python.org/pypi/requests>`
|
|
|
|
- `Cryptography <https://pypi.python.org/pypi/cryptography>`
|
|
|
|
License
|
|
-------
|
|
|
|
MIT licensed. See the bundled `LICENSE`_ file for more details.
|
|
|