python-pgp aims to reproduce the full functionality of GnuPG in Python. It may also be used for creating raw OpenPGP packets and packet streams for test purposes. This may be a bit of a heavyweight solution for some purposes.
Other Python packages which provide related functionality:
- pyassuan - communicate with GnuPG using its socket protocol.
- pgpdump - a pure python library for parsing OpenPGP packets.
- gnupg - a wrapper around the GnuPG executable.
- python-gnupg - another wrapper around the GnuPG executable.
- gpgkeys - another wrapper around the GnuPG executable.
- gpglib - a pure python library for parsing OpenPGP packets and decrypting messages.
- OpenPGP - an unmaintained pure python library with much of the functionality of old versions of GnuPG.
- encryptedfile - a pure python library for symmetrically encrypting files in an OpenPGP-compatible way.
- PGPy - a pure python library with basic parsing and signing of OpenPGP packets.
- OpenPGP-Python - a pure python port of openpgp-php. It can parse OpenPGP packets and verify & create signatures.
- build-essential
- libtwofish-dev
- libgmp10-dev (for fastmath extension of pycrypto)
pip install pgp
with Twofish support:
pip install pgp[twofish]
with Camellia support:
pip install pgp[camellia]
with Twofish & Camellia support:
pip install pgp[camellia,twofish]
from pgp import read_message message = read_message(data)
from pgp import read_key key = read_key(data)
from pgp import get_gnupg_db db = get_gnupg_db() key = db.search(user_id='Joe')[0]
>>> import datetime
>>> from pgp import *
>>> from pgp.keyserver import get_keyserver
>>> ks = get_keyserver('hkp://pgp.mit.edu/')
>>> results = ks.search('Joe Bloggs')
>>> recipient_key = results[0].get()
>>> recipient_subkey = recipient_key.subkeys[0]
>>> message = message.TextMessage(
... u"This message was encrypted using Python PGP\n",
... u"somefilename.txt",
... datetime.datetime.now())
>>> my_secret_key = read_key_file('secret_key.gpg')
>>> my_secret_key.unlock('My passphrase')
>>> message = message.sign(my_secret_key)
>>> message = message.compress(2, 6) # 2=ZLIB, 6=default-level
>>> message = message.public_key_encrypt(9, recipient_subkey)
>>> message_packets = message.to_packets()
>>> message_data = b''.join(map(bytes, message_packets))
>>> armored_message = armor.ASCIIArmor(
... armor.PGP_MESSAGE, message_data)
>>> with open('message.asc', 'w') as file_handle:
... file_handle.write(str(armored_message))
from pgp.packets import parsers parsers.parse_binary_packet_data(packet_data)
from pgp.packets import parsers packets = parsers.parse_binary_packet_data(packet_data) b''.join(map(bytes, packets))
If you are using this package to handle private key data and decryption, please note that there is no (reasonable) way currently in Python to securely erase memory and that copies of things are made often and in non-obvious ways. If you are concerned about key data being compromised by a memory leak, do not use this package for handling secret key data. On the other hand, "if your memory is constantly being compromised, I would re-think your security setup."
OpenPGP uses compression algorithms. Beware when feeding untrusted data into this library of Zip bomb or similar denial of service attacks.
The main repository for this package is on GitHub. To develop on the package and install development dependencies, clone the repository and install the 'dev' extras.:
git clone [email protected]:mitchellrj/python-pgp.git cd python-pgp virtualenv . bin/pip install -e ".[dev]"
bin/python setup.py nosetests
bin/python setup.py build_sphinx