python-gnupg

A modified version of python-gnupg, including security patches, extensive documentation, and extra features.

Go to file

Isis Lovecruft f8ab757b46 Add generated Emacs orgmode → html output for docs/NOTES…audit.org file.		2013-07-03 10:20:41 +00:00
docs	Add generated Emacs orgmode → html output for docs/NOTES…audit.org file.	2013-07-03 10:20:41 +00:00
gnupg	Start Pythonising the Makefile test cleanup actions.	2013-07-02 09:36:48 +00:00
patches	Add quilt patches/ directory, series file, and first external patch.	2013-03-18 19:36:30 +00:00
scripts	Make sure setuptools/distribute is present in new dev virtualenvs.	2013-06-09 05:41:25 +00:00
.gitattributes	Add .gitattributes file for versioneer.	2013-05-13 10:16:39 +00:00
.gitignore	Unignore MANIFEST.in file.	2013-07-02 08:34:10 +00:00
.travis.yml	Add TravisCI config file for continuous integration testing.	2013-03-18 19:36:29 +00:00
LICENSE	Reorganise docs and update README.	2013-07-02 08:32:34 +00:00
Makefile	Fix whitespace to be a TAB instead on spaces in Makefile. le sigh	2013-06-03 21:27:44 +00:00
README	Reorganise docs and update README.	2013-07-02 08:32:34 +00:00
TODO	Reorganise docs and update README.	2013-07-02 08:32:34 +00:00
requirements.txt	If using a virtualenv, we don't want the env pip and distribute to be upgraded.	2013-06-09 05:44:43 +00:00
setup.cfg	Add GPG signing for PyPI uploads to setup.cfg.	2013-07-02 10:12:54 +00:00
setup.py	Remove unused code from setup.py script.	2013-07-02 11:40:20 +00:00
versioneer.py	Add versioneer and restructure the repo into a src/ dir.	2013-05-12 09:32:46 +00:00

README

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

# python-gnupg #

Fork of [python-gnupg-0.3.2](https://code.google.com/p/python-gnupg/), patched
to fix a potential vulnerability which could result in remote code execution,
do to unsanitised inputs being passed to ```subprocess.Popen([...], shell=True)```.

### Installation ###

#### From [PyPI](https://pypi.python.org) ####
It's simple. Just do:
```
[sudo] pip install gnupg
```

#### From this git repository ####
To install this package from this git repository, do:

```
git clone https://github.com/isislovecruft/python-gnupg.git
cd python-gnupg
make install
make test
```

Optionally to build the documentation after installation, do:
```
make docs
```

To get started using python-gnupg's API, see the [online documentation](https://python-gnupg.readthedocs.org/en/latest/),
and import the module like so:
```
>>> import gnupg
```

The primary interface class you'll likely want to interact with is
[```gnupg.GPG```](https://python-gnupg.readthedocs.org/en/latest/gnupg.html#gpg):
```
>>> gpg = gnupg.GPG(gpgbinary='/usr/bin/gpg',
...     gpghome='./keys',
...     pubring='pubring.gpg',
...     secring='secring.gpg')
>>> batch_key_input = gpg.gen_key_input()
>>> print batch_key_input
Key-Type: RSA
Name-Email: isis@wintermute
Name-Comment: Generated by gnupg.py
Key-Length: 4096
Name-Real: Autogenerated Key
%pubring /home/isis/code/python-gnupg/keys/pubring.gpg
%secring /home/isis/code/python-gnupg/keys/secring.gpg
%commit

>>> key = gpg.gen_key(batch_key_input)
>>> print key.fingerprint
245D8FA30F543B742053949F553C0E154F2E7A98

```

### Bug Reports & Feature Requests ###

Currently, the bugtracker is
[here](https://github.com/isislovecruft/python-gnupg/issues) on Github. This
may change in the future, but for now please feel free to use it to make
bugreports and feature requests.

Public comments and discussions are also welcome on the bugtracker, or as
[tweets](https://twitter.com/isislovecruft).

Patches are greatly appreciated, and if unsuitable for merging I will make
improvement suggestions based on code review until the patch is acceptable.

README Unescape Escape

README