Skip to content
This repository

A python interface to running gpg in a subprocess

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README
PyGPG  is a python interface wrapper for gnupg's gpg command.  It runs gpg and
gathers data from gpg's outputs, making that data availabe to python code
consumers.

It aims to provide a very flexible, reliable and secure method to integrate
gnupg functionality into python programs.  It also has (IMHO) a very good,
flexible method of mining and making available all the data obtained from
gpg's status-fd messages.

What makes this wrapper work more flexibly is that it is very much config based
for runnning the gpg subprocesses.  The focus is not about providing a specific
python function for every action gpg is capable of.  GPG itself is very much
option based, so to that end so is this wrapper.  All that is needed is to
tweak the options to your liking, then runGPG() passing it your desired
action, and either text for stdin input or a filepath for it to process.

    So far there is a general runGPG() capable of almost any action gpg is
    capable of.  It is early in development, so have not tested all the
    actions.  There are a few other convience functions which in turn
    establish some parameters and call runGPG() for you.  They are decrypt,
    verify, sign.  There are also version and options properties which return
    the information gleaned from running gpg.

    Update: 20130706

    I've renamed the python pygpg pkg to pyGPG the same as the project
    name.  I did this for some consistency.  There is another pygpg project
    started at about the same time as this one.  It's python pkg is named gpg,
    so could be installed side by side with this one. It is different, and very
    limited in it's capabilities.

    There are a great many more task options available for gpg than I have added
    to the config.  I have onlt added some basic task options that I have tested
    myself.  You are welcome to add additional command options, test and send
    them in to me for inclusion.

    A more recent addition, is the ability for pyGPG to mine the colon listings
    data output by using the --with-colons option.  It places the data obtained
    into namedtuple classes just like the status_fd output.


quick example usage:

brian@big_daddy ~/Dev/git/pyGPG $ python
Python 2.7.5 (default, Nov 26 2013, 07:47:30)
[GCC 4.6.4] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import pyGPG;from pyGPG.config import GPGConfig;c=GPGConfig();from pyGPG.gpg import GPG;g=GPG(c);c.options['tasks']['fingerprint'] = ['--attribute-fd', '2', '--with-colons'];r=g.fingerprint('dolsen@gentoo.org')
>>> r
<pyGPG.output.GPGResult object at 0x7f57a714c810>
>>> r.status.data
[TRU(reason='', model='1', db_created='1385327559', db_expires='0', marginal_num='3', completely_num='1', max_depth='5'), PUB(validity='-', keylength='2048', pubkey_algo='1', long_keyid='2214D90A014F17CB', creation_date='1267578490', expiredate='1393894470', serial_num='', ownertrust='-', user_ID='', sig_class='', key_capabilities='scESC', fingerprint=''), FPR(validity='', keylength='', pubkey_algo='', long_keyid='', creation_date='', expiredate='', serial_num='', ownertrust='', fingerprint='8688FD1CC71C1C04EAEA42372214D90A014F17CB', key_capabilities=''), UID(validity='-', keylength='', pubkey_algo='', long_keyid='', creation_date='1350795716', expiredate='', serial_num='168E5EBB59AFA46B7A26FCC95F377BCF26202C8B', ownertrust='', user_ID='Brian Dolbec <brian.dolbec@gmail.com>', sig_class=''), UID(validity='-', keylength='', pubkey_algo='', long_keyid='', creation_date='1350795605', expiredate='', serial_num='C25D1F20E350D3CB86FC477A74F5BBAFF2119B50', ownertrust='', user_ID='Brian Dolbec <dolsen@gentoo.org>', sig_class=''), UID(validity='-', keylength='', pubkey_algo='', long_keyid='', creation_date='1330822470', expiredate='', serial_num='F107C1F60159DD59F568B512EC20954A025C3423', ownertrust='', user_ID="Brian Dolbec (Yes it's really me. Although which one of me is another question.) <brian.dolbec@gmail.com>", sig_class=''), SUB(validity='-', keylength='2048', pubkey_algo='1', long_keyid='65E309F2189DB0B8', creation_date='1267578490', expiredate='1393895072', serial_num='', ownertrust='', user_ID='', sig_class='', key_capabilities='e', fingerprint='')]
>>> r.fingerprint
'8688FD1CC71C1C04EAEA42372214D90A014F17CB'
>>> r.output
"tru::1:1385327559:0:3:1:5\npub:-:2048:1:2214D90A014F17CB:1267578490:1393894470::-:::scESC:\nfpr:::::::::8688FD1CC71C1C04EAEA42372214D90A014F17CB:\nuid:-::::1350795716::168E5EBB59AFA46B7A26FCC95F377BCF26202C8B::Brian Dolbec <brian.dolbec@gmail.com>:\nuid:-::::1350795605::C25D1F20E350D3CB86FC477A74F5BBAFF2119B50::Brian Dolbec <dolsen@gentoo.org>:\nuid:-::::1330822470::F107C1F60159DD59F568B512EC20954A025C3423::Brian Dolbec (Yes it's really me. Although which one of me is another question.) <brian.dolbec@gmail.com>:\nsub:-:2048:1:65E309F2189DB0B8:1267578490:1393895072:::::e:\n"
>>> print(r.output)
tru::1:1385327559:0:3:1:5
pub:-:2048:1:2214D90A014F17CB:1267578490:1393894470::-:::scESC:
fpr:::::::::8688FD1CC71C1C04EAEA42372214D90A014F17CB:
uid:-::::1350795716::168E5EBB59AFA46B7A26FCC95F377BCF26202C8B::Brian Dolbec <brian.dolbec@gmail.com>:
uid:-::::1350795605::C25D1F20E350D3CB86FC477A74F5BBAFF2119B50::Brian Dolbec <dolsen@gentoo.org>:
uid:-::::1330822470::F107C1F60159DD59F568B512EC20954A025C3423::Brian Dolbec (Yes it's really me. Although which one of me is another question.) <brian.dolbec@gmail.com>:
sub:-:2048:1:65E309F2189DB0B8:1267578490:1393895072:::::e:

>>>
Something went wrong with that request. Please try again.