python-gnupg-0.3.8/0000775000175000017500000000000012601062466014464 5ustar vinayvinay00000000000000python-gnupg-0.3.8/PKG-INFO0000664000175000017500000000274712601062466015573 0ustar vinayvinay00000000000000Metadata-Version: 1.0 Name: python-gnupg Version: 0.3.8 Summary: A wrapper for the Gnu Privacy Guard (GPG or GnuPG) Home-page: http://packages.python.org/python-gnupg/index.html Author: Vinay Sajip Author-email: vinay_sajip@red-dove.com License: Copyright (C) 2008-2014 by Vinay Sajip. All Rights Reserved. See LICENSE.txt for license. Download-URL: https://pypi.python.org/packages/source/p/python-gnupg/python-gnupg-0.3.8.tar.gz Description: This module allows easy access to GnuPG's key management, encryption and signature functionality from Python programs. It is intended for use with Python 2.4 or greater. Platform: No particular restrictions Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: BSD License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 2.4 Classifier: Programming Language :: Python :: 2.5 Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3.2 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Operating System :: OS Independent Classifier: Topic :: Software Development :: Libraries :: Python Modules python-gnupg-0.3.8/test_pubring.gpg0000664000175000017500000001045712425647460017706 0ustar vinayvinay00000000000000 S=3vDd4OKbm8x>>MP`p [%"Rh뼿gf%7$ӟ1`гvy3/qӆw[.X1Lׁ ԶGr'(sS*ޜ>qM)%.^3}9r1ىxKk2P(vS\}Au@ۂ4=yRtpk;Wem75Ys e*&bBʱ)c1Andrew Able (A test user) 8"S/   ЮLw?av=dmEK9S QdlO]g8WJPNA,cnm6>TI\ w7|@^^#o0طs;Юx}.җ>$4P[cdbSr\Cܻ=A2yL,\/UA1{TQ2l?r?ev[ fWVE5=Ά51 ?lON:zx|qbtV S=|,Րa'~I|-^/ZP,|NEP-י1U r^wkH rU}b4 H*2kCt!>YŠ|O+Rj env#G\טws;: '/+пJ/B9)}"Zd.M#k׶Mik;RykGYjazJ57ֆ>.咱2T1~7%汘QUrC i]PvױB J _$Pd.!Em,W׀rD^fGum}>5wFvbA spˮBX%S#Uّ: &$%3?챒̙ $ Jլ=Dg#^ Go9ڶW#Kc)CRmy/~_3gv` J S ЮLw-E?ǧR_ B'מ%ua؄~mo3JG_R}ikj2Kb#Z{ԅ^XrvBU)t4:dj6?%ߣ[yK*2w*03B&ڒl α(uQWXC4F̸t0ꈢz-3RP!O2Bu :cA nA!phˠOzxSyХb޹ a֡ ^۱J]ǟH {<+P:ZvMy S!);TϫcpsV tyGޤsA͔Jrn]ˏ<՟m>7 >^qd9cO'{'q?aZ ^O΂S)N찀8"S/   )gOԸh$AIvc45\ =`mLp;[A Bho3+[/g^ < 0澶d1:Zd1B"hh!ݮ'1"\]. j 2i:>$i5G':8hX%{J׃xc5SrGҜkcUԲL)Nx NRZenD|ȼdm{*u 9Һ&ZJE  Sw%P_}i @#Lxh,[Y^Tu<]uލX8T}6,W% ߚ}ia6W?Ҙ.<~1 yj;V9%vt[W-:Q^@ -$z JM=hy {(ȚŚb6󠈵% k=]yɭ2Ѭɖt}2@~ɨGS+㒄?!ɖ }WPLsǙ%+7&w!oj3mjî븸>ʚ+q{Y c[A4Kz|^|mD8e?P>/G::>"YV=^M#C8̰c} S )gOԸ 2ĝ3X1^?FāE"cLWMG4U؛x0MC_4F\"͛XaέTD֨n ںڕCz7 Μ C)!+{mڷitu7u@䝒jӑ15rߟU$6“qV>TH@PG2aѠ6sAY#u[g o\pAh<~gF@%an.ܞ;W̟]&X`@xy9 ^ SJ6:ר5Et_hGJP3w ũUJg(T9#fDg(i9%uWT[yLI8܍xaf!՟P,)͛pZE[P_ HiE.ΓpZz}Nz?GH'. 'fyn fPtXs8"S/   sƷ؋Qa"7׌:a`-;.ݛ6K|G{W  IG*:~/jɩAߏIna__P^ OJ4]- 螨[~J6yRag'nj ,Ur["bH"W.Z"+qFi{a?y$*2vG2G v L̪Ȯ)N8 fSXRBDH.6ۓIb6 SgH7

4nca+YS]&rd'U zT\@;uxꎐB?YG/IH2uB"Bhʨu]$HOd?mc6Z?jąt֋ lIyLd&Vz}@/E bPQyM=.Ѿ9Ĩު3ry[dCLF A`Ȕ;7;Vsy S sƷ؋QPZMvEfFi(Lg͋: F8aa:8/ux]Nu O[Tw\D8? -(vBH"r6okgt=ƼGܼHvܢ_=+0*,zI瓗xt)RLv3Nq J䤊6aBIW(?f%_Paڥx/f>{.j]/=8v.k72Z2#4⅀python-gnupg-0.3.8/LICENSE.txt0000600000175000017500000000267412274532516016312 0ustar vinayvinay00000000000000Copyright (c) 2008-2014 by Vinay Sajip. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * The name(s) of the copyright holder(s) may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. python-gnupg-0.3.8/test_gnupg.py0000664000175000017500000007441112601026514017216 0ustar vinayvinay00000000000000# -*- coding: utf-8 -*- """ A test harness for gnupg.py. Copyright (C) 2008-2014 Vinay Sajip. All rights reserved. """ import doctest import logging import os.path import os import shutil import stat import sys import tempfile import unittest import gnupg __author__ = "Vinay Sajip" __date__ = "$24-Sep-2015 18:05:15$" ALL_TESTS = True logger = logging.getLogger(__name__) GPGBINARY = os.environ.get('GPGBINARY', 'gpg') KEYS_TO_IMPORT = """-----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1.4.9 (MingW32) mQGiBEiH4QERBACm48JJsg2XGzWfL7f/fjp3wtrY+JIz6P07s7smr35kve+wl605 nqHtgjnIVpUVsbI9+xhIAPIkFIR6ZcQ7gRDhoT0bWKGkfdQ7YzXedVRPlQLdbpmR K2pKKySpF35pJsPAYa73EVaxu2KrII4CyBxVQgNWfGwEbtL5FfzuHhVOZwCg6JF7 bgOMPmEwBLEHLmgiXbb5K48D/2xsXtWMkvgRp/ubcLxzbNjaHH6gSb2IfDi1+W/o Bmfua6FksPnEDn7PWnBhCEO9rf1tV0FcrvkR9m2FGfx38tjssxDdLvX511gbfc/Q DJxZ00A63BxI3xav8RiXlqpfQGXpLJmCLdeCh5DXOsVMCfepqRbWyJF0St7LDcq9 SmuXA/47dzb8puo9dNxA5Nj48I5g4ke3dg6nPn7aiBUQ35PfXjIktXB6/sQJtWWx XNFX/GVUxqMM0/aCMPdtaoDkFtz1C6b80ngEz94vXzmON7PCgDY6LqZP1B1xbrkr 4jGSr68iq7ERT+7E/iF9xp+Ynl91KK7h8llY6zFw+yIe6vGlcLQvR2FyeSBHcm9z cyAoQSB0ZXN0IHVzZXIpIDxnYXJ5Lmdyb3NzQGdhbW1hLmNvbT6IYAQTEQIAIAUC SIfhAQIbAwYLCQgHAwIEFQIIAwQWAgMBAh4BAheAAAoJEJZ2Ekdc7S4UtEcAoJIA iZurfuzIUE9Dtn86o6vC14qoAJ9P79mxR88wRr/ac9h5/BIf5cZKMbkCDQRIh+EB EAgAyYCvtS43J/OfuGHPGPZT0q8C+Y15YLItSQ3H6IMZWFY+sX+ZocaIiM4noVRG +mrEqzO9JNh4KP1OdFju1ZC8HZXpPVur48XlTNSm0yjmvvfmi+aGSuyQ0NkfLyi1 aBeRvB4na/oFUgl908l7vpSYWYn4EY3xpvwJdyTWHTh4o7+zvrR1fByDt49k2b3z yTACoxYPVQfknt8gxqLqHZsbgn02Ml7HS17bSWr5Z7PlWqDlmsdqUikVU9d2RvIq R+YIJbOdHSklbVQQDhr+xgHPi39e7nXMxR/rMjMbz7E5vSNkge45n8Pzim8iyqy+ MTMW8psV/OyrHUJzBEA7M6hA1wADBwgAnB0HzI1iyiQmIymO0Hj0BgqU6/avFw9R ggBuE2v7KsvuLP6ohXDEhYopjw5hgeotobpg6tS15ynch+6L8uWsJ0rcY2X9dsJy O8/5mjrNDHwCKiYRuZfmRZjzW03vO/9+rjtZ0NzoWYMP3UR8lUTVp2LTygefBA88 Zgw6dWBVzn+/c0vdwcF4Y3njYKE7eq4VrfcwqRgD0hDyIJd1OpqzHfXXnTtLlAsm UwtdONzlwu7KkgafMo4vzKY6dCtUkR6pXAE/rLQfCTonwl9SnyusoYZgjDoj4Pvw ePxIl2q05dcn96NJGS+SfS/5B4H4irbfaEYmCfKps+45sjncYGhZ/ohJBBgRAgAJ BQJIh+EBAhsMAAoJEJZ2Ekdc7S4U2lkAoIwZLMHVldC0v9wse53xU0NsNIskAKDc Ft0XWUJ9yajOEUqCVHNs3F99t5kBogRIh+FVEQQAhk/ROtJ5/O+YERl4tZZBEhGH JendDBDfzmfRO9GIDcZI20nx5KJ1M/zGguqgKiVRlBy32NS/IRqwSI158npWYLfJ rYCWrC2duMK2i/8prOEfaktnqZXVCHudGtP4mTqNSs+867LnGhQ4w3HmB09zCIpD eIhhhPOb5H19H8UlojsAoLwsq5BACqUKoiz8lUufpTTFMbaDA/4v1fWmprYAxGq9 cZ9svae772ymN/RRPDb/D+UJoJCCJSjE8m4MukVchyJVT8GmpJM2+dlt62eYwtz8 bGNt+Yzzxr0N8rLutsSks7RaM16MaqiAlM20gAXEovxBiocgP/p5bO3FGKOBbrfd h47BZDEqLvfJefXjZEsElbZ9oL2zDgP9EsoDS9mbfesHDsagE5jCZRTY1C/FRLBO zhGgP2IlqBdOX8BYBYZiIlLM+pN5fU0Hcu3VOZY1Hnj6r3VbK1bOScQzqrZ7qgmw TRgyxUQalaOhMb5rUD0+dUFxa/mhTerx5POrX6zOWmmK0ldYTZO4/+nWr4FwmU8R 41nYYYdi0yS0MURhbm55IERhdmlzIChBIHRlc3QgdXNlcikgPGRhbm55LmRhdmlz QGRlbHRhLmNvbT6IYAQTEQIAIAUCSIfhVQIbAwYLCQgHAwIEFQIIAwQWAgMBAh4B AheAAAoJEG7bKmS7rMYAEt8An2jxsmsE1MZVZc4Ev8RB9Gu1zbsCAJ9G5kkYIIf0 OoDqCjkDMDJcpd4MqLkCDQRIh+FVEAgAgHQ+EyseLw6A3BS2EUz6U1ZGzuJ5CXxY BY8xaQtE+9AJ0WHyzKeptnlnY1x9et3ny1BcVC5aR1OgsDiuVRvSFwpFfVxMKbRT kvERWADfB0N5EyWwyE0E4BT5hyEhW7fS0bucJL6UK5PKvfE5wexWlUI3yV4K1z6W 2gSNL60o3kmoGn9K5ICWO/jbi6MkPptSoDu/laCJHv/aid6Gf94ckDClQQyLsccj 0ibynm6rI3cIzpPMbimKIsKT1smAqZEBsTucBlOjIuIROANTZUN3reGIRh/kVNyg YTrkUnIqVS9FnbHa2wxeb6F/cO33fPiVfiCmZuKI1Uh4PMGaaSCh0wADBQf/SaXN WcuD0mrEnxqgEJRx67ZeFZjZM53Obu3JYQ++lqsthf8MxE7K4J/67xDpOh6waK0G 6GCLwEm3Z7wjCaz1DYg2uJp/3pispWxZio3PLVe7WrMY+oEBHEsiJXicS5dV620a uoaBnnc0aQWT/DREE5s35IrZCh4WDQgO9rl0i/qcIITm77TmQbq2Xdj5vt6s0cx7 oHKRaFBpQ8DBsCQ+D8Xz7i1oUygNp4Z5xPhItWeCfE9YoCoem4jSB4HGwmMOEicp VSpY43k01cd0Yfb1OMhA5C8OBwcwn3zvQB7nbxyxyQ9qphfwhMookIL4+tKKBIQL CnOGhApkAGbjRwuLi4hJBBgRAgAJBQJIh+FVAhsMAAoJEG7bKmS7rMYA+JQAn0E2 WdPQjKEfKnr+bW4yubwMUYKyAJ4uiE8Rv/oEED1oM3xeJqa+MJ9V1w== =sqld -----END PGP PUBLIC KEY BLOCK-----""" def is_list_with_len(o, n): return isinstance(o, list) and len(o) == n def compare_keys(k1, k2): "Compare ASCII keys" k1 = k1.split('\n') k2 = k2.split('\n') del k1[1] # remove version lines del k2[1] return k1 != k2 class GPGTestCase(unittest.TestCase): def setUp(self): hd = os.path.join(os.getcwd(), 'keys') if os.path.exists(hd): self.assertTrue(os.path.isdir(hd), "Not a directory: %s" % hd) shutil.rmtree(hd) self.homedir = hd self.gpg = gpg = gnupg.GPG(gnupghome=hd, gpgbinary=GPGBINARY) v = gpg.version if v: if v >= (2,): gpg.options = ['--debug-quick-random'] else: gpg.options = ['--quick-random'] self.test_fn = test_fn = 'random_binary_data' if not os.path.exists(test_fn): data_file = open(test_fn, 'wb') data_file.write(os.urandom(5120 * 1024)) data_file.close() def test_environment(self): "Test the environment by ensuring that setup worked" hd = self.homedir self.assertTrue(os.path.exists(hd) and os.path.isdir(hd), "Not an existing directory: %s" % hd) def test_list_keys_initial(self): "Test that initially there are no keys" logger.debug("test_list_keys_initial begins") public_keys = self.gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 0), "Empty list expected") private_keys = self.gpg.list_keys(secret=True) self.assertTrue(is_list_with_len(private_keys, 0), "Empty list expected") logger.debug("test_list_keys_initial ends") def generate_key(self, first_name, last_name, domain, passphrase=None): "Generate a key" params = { 'Key-Type': 'DSA', 'Key-Length': 1024, 'Subkey-Type': 'ELG-E', 'Subkey-Length': 2048, 'Name-Comment': 'A test user', 'Expire-Date': 0, } options = self.gpg.options or [] if '--debug-quick-random' in options or '--quick-random' in options: # If using the fake RNG, a key isn't regarded as valid # unless its comment has the text (insecure!) in it. params['Name-Comment'] = 'A test user (insecure!)' params['Name-Real'] = '%s %s' % (first_name, last_name) params['Name-Email'] = ("%s.%s@%s" % (first_name, last_name, domain)).lower() if passphrase is None: passphrase = ("%s%s" % (first_name[0], last_name)).lower() params['Passphrase'] = passphrase cmd = self.gpg.gen_key_input(**params) return self.gpg.gen_key(cmd) def do_key_generation(self): "Test that key generation succeeds" result = self.generate_key("Barbara", "Brown", "beta.com") self.assertNotEqual(None, result, "Non-null result") return result def test_key_generation_with_invalid_key_type(self): "Test that key generation handles invalid key type" params = { 'Key-Type': 'INVALID', 'Key-Length': 1024, 'Subkey-Type': 'ELG-E', 'Subkey-Length': 2048, 'Name-Comment': 'A test user', 'Expire-Date': 0, 'Name-Real': 'Test Name', 'Name-Email': 'test.name@example.com', } cmd = self.gpg.gen_key_input(**params) result = self.gpg.gen_key(cmd) self.assertFalse(result.data, 'Null data result') self.assertEqual(None, result.fingerprint, 'Null fingerprint result') def test_key_generation_with_colons(self): "Test that key generation handles colons in key fields" params = { 'key_type': 'RSA', 'name_real': 'urn:uuid:731c22c4-830f-422f-80dc-14a9fdae8c19', 'name_comment': 'dummy comment', 'name_email': 'test.name@example.com', } cmd = self.gpg.gen_key_input(**params) result = self.gpg.gen_key(cmd) keys = self.gpg.list_keys() self.assertEqual(len(keys), 1) key = keys[0] uids = key['uids'] self.assertEqual(len(uids), 1) uid = uids[0] self.assertEqual(uid, 'urn:uuid:731c22c4-830f-422f-80dc-14a9fdae8c19 ' '(dummy comment) ') def test_key_generation_with_escapes(self): "Test that key generation handles escape characters" cmd = self.gpg.gen_key_input(name_comment='Funny chars: ' '\\r\\n\\f\\v\\0\\b', name_real='Test Name', name_email='test.name@example.com') result = self.gpg.gen_key(cmd) keys = self.gpg.list_keys() self.assertEqual(len(keys), 1) key = keys[0] uids = key['uids'] self.assertEqual(len(uids), 1) uid = uids[0] self.assertEqual(uid, 'Test Name (Funny chars: ' '\r\n\x0c\x0b\x00\x08) ') def test_key_generation_with_empty_value(self): "Test that key generation handles empty values" params = { 'key_type': ' ', 'key_length': 2048, } cmd = self.gpg.gen_key_input(**params) self.assertTrue('Key-Type: RSA\n' in cmd) params['key_type'] = 'DSA' cmd = self.gpg.gen_key_input(**params) self.assertTrue('Key-Type: DSA\n' in cmd) def test_list_keys_after_generation(self): "Test that after key generation, the generated key is available" self.test_list_keys_initial() self.do_key_generation() public_keys = self.gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 1), "1-element list expected") key_info = public_keys[0] fp = key_info['fingerprint'] self.assertTrue(fp in public_keys.key_map) self.assertTrue(public_keys.key_map[fp] is key_info) for _, _, sfp in key_info['subkeys']: self.assertTrue(sfp in public_keys.key_map) self.assertTrue(public_keys.key_map[sfp] is key_info) private_keys = self.gpg.list_keys(secret=True) self.assertTrue(is_list_with_len(private_keys, 1), "1-element list expected") # Now do the same test, but using keyring and secret_keyring arguments hd = os.path.join(os.getcwd(), 'keys') gpg = gnupg.GPG(gnupghome=hd, gpgbinary=GPGBINARY, keyring=os.path.join(hd, 'pubring.gpg'), secret_keyring=os.path.join(hd, 'secring.gpg')) public_keys_2 = gpg.list_keys() self.assertEqual(public_keys_2, public_keys) private_keys_2 = gpg.list_keys(secret=True) self.assertEqual(private_keys_2, private_keys) # generate additional keys so that we can test listing a subset of # keys def get_names(key_map): result = set() for info in key_map.values(): for uid in info['uids']: uid = uid.replace(' (A test user (insecure!))', '') result.add(uid) return result result = self.generate_key("Charlie", "Clark", "gamma.com") self.assertNotEqual(None, result, "Non-null result") result = self.generate_key("Donna", "Davis", "delta.com") self.assertNotEqual(None, result, "Non-null result") public_keys = gpg.list_keys() self.assertEqual(len(public_keys), 3) actual = get_names(public_keys.key_map) expected = set(['Barbara Brown ', 'Charlie Clark ', 'Donna Davis ']) self.assertEqual(actual, expected) # specify a single key as a string public_keys = gpg.list_keys(keys='Donna Davis') actual = get_names(public_keys.key_map) expected = set(['Donna Davis ']) self.assertEqual(actual, expected) # specify multiple keys public_keys = gpg.list_keys(keys=['Donna', 'Barbara']) actual = get_names(public_keys.key_map) expected = set(['Barbara Brown ', 'Donna Davis ']) self.assertEqual(actual, expected) def test_scan_keys(self): "Test that external key files can be scanned" expected = set([ 'Andrew Able (A test user) ', 'Barbara Brown (A test user) ', 'Charlie Clark (A test user) ', ]) for fn in ('test_pubring.gpg', 'test_secring.gpg'): data = self.gpg.scan_keys(fn) uids = set() for d in data: uids.add(d['uids'][0]) self.assertEqual(uids, expected) def test_encryption_and_decryption(self): "Test that encryption and decryption works" logger.debug("test_encryption_and_decryption begins") key = self.generate_key("Andrew", "Able", "alpha.com", passphrase="andy") andrew = key.fingerprint key = self.generate_key("Barbara", "Brown", "beta.com") barbara = key.fingerprint gpg = self.gpg gpg.encoding = 'latin-1' if gnupg._py3k: data = 'Hello, André!' else: data = unicode('Hello, André', gpg.encoding) data = data.encode(gpg.encoding) edata = str(gpg.encrypt(data, barbara)) self.assertNotEqual(data, edata, "Data must have changed") ddata = gpg.decrypt(edata, passphrase="bbrown") if data != ddata.data: logger.debug("was: %r", data) logger.debug("new: %r", ddata.data) self.assertEqual(data, ddata.data, "Round-trip must work") edata = str(gpg.encrypt(data, [andrew, barbara])) self.assertNotEqual(data, edata, "Data must have changed") ddata = gpg.decrypt(edata, passphrase="andy") self.assertEqual(data, ddata.data, "Round-trip must work") ddata = gpg.decrypt(edata, passphrase="bbrown") self.assertEqual(data, ddata.data, "Round-trip must work") logger.debug("test_encryption_and_decryption ends") # Test symmetric encryption data = "chippy was here" edata = str(gpg.encrypt(data, None, passphrase='bbrown', symmetric=True)) ddata = gpg.decrypt(edata, passphrase='bbrown') self.assertEqual(data, str(ddata)) # Test symmetric encryption with non-default cipher edata = str(gpg.encrypt(data, None, passphrase='bbrown', symmetric='AES256')) ddata = gpg.decrypt(edata, passphrase='bbrown') self.assertEqual(data, str(ddata)) # Test that you can't encrypt with no recipients self.assertRaises(ValueError, self.gpg.encrypt, data, []) def test_import_and_export(self): "Test that key import and export works" logger.debug("test_import_and_export begins") self.test_list_keys_initial() gpg = self.gpg result = gpg.import_keys(KEYS_TO_IMPORT) self.assertEqual(result.summary(), '2 imported') public_keys = gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 2), "2-element list expected") private_keys = gpg.list_keys(secret=True) self.assertTrue(is_list_with_len(private_keys, 0), "Empty list expected") ascii = gpg.export_keys([k['keyid'] for k in public_keys]) self.assertTrue(ascii.find("PGP PUBLIC KEY BLOCK") >= 0, "Exported key should be public") ascii = ascii.replace("\r", "").strip() match = compare_keys(ascii, KEYS_TO_IMPORT) if match: logger.debug("was: %r", KEYS_TO_IMPORT) logger.debug("now: %r", ascii) self.assertEqual(0, match, "Keys must match") #Generate a key so we can test exporting private keys key = self.do_key_generation() ascii = gpg.export_keys(key.fingerprint, True) self.assertTrue(ascii.find("PGP PRIVATE KEY BLOCK") >= 0, "Exported key should be private") logger.debug("test_import_and_export ends") def test_import_only(self): "Test that key import works" logger.debug("test_import_only begins") self.test_list_keys_initial() self.gpg.import_keys(KEYS_TO_IMPORT) public_keys = self.gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 2), "2-element list expected") private_keys = self.gpg.list_keys(secret=True) self.assertTrue(is_list_with_len(private_keys, 0), "Empty list expected") ascii = self.gpg.export_keys([k['keyid'] for k in public_keys]) self.assertTrue(ascii.find("PGP PUBLIC KEY BLOCK") >= 0, "Exported key should be public") ascii = ascii.replace("\r", "").strip() match = compare_keys(ascii, KEYS_TO_IMPORT) if match: logger.debug("was: %r", KEYS_TO_IMPORT) logger.debug("now: %r", ascii) self.assertEqual(0, match, "Keys must match") logger.debug("test_import_only ends") def test_signature_verification(self): "Test that signing and verification works" logger.debug("test_signature_verification begins") key = self.generate_key("Andrew", "Able", "alpha.com") self.gpg.encoding = 'latin-1' if gnupg._py3k: data = 'Hello, André!' else: data = unicode('Hello, André', self.gpg.encoding) data = data.encode(self.gpg.encoding) sig = self.gpg.sign(data, keyid=key.fingerprint, passphrase='bbrown') self.assertFalse(sig, "Bad passphrase should fail") sig = self.gpg.sign(data, keyid=key.fingerprint, passphrase='aable') self.assertTrue(sig, "Good passphrase should succeed") self.assertTrue(sig.hash_algo) verified = self.gpg.verify(sig.data) if key.fingerprint != verified.fingerprint: logger.debug("key: %r", key.fingerprint) logger.debug("ver: %r", verified.fingerprint) self.assertEqual(key.fingerprint, verified.fingerprint, "Fingerprints must match") self.assertEqual(verified.trust_level, verified.TRUST_ULTIMATE) self.assertEqual(verified.trust_text, 'TRUST_ULTIMATE') data_file = open(self.test_fn, 'rb') sig = self.gpg.sign_file(data_file, keyid=key.fingerprint, passphrase='aable') data_file.close() self.assertTrue(sig, "File signing should succeed") self.assertTrue(sig.hash_algo) try: file = gnupg._make_binary_stream(sig.data, self.gpg.encoding) verified = self.gpg.verify_file(file) except UnicodeDecodeError: #happens in Python 2.6 from io import BytesIO verified = self.gpg.verify_file(BytesIO(sig.data)) if key.fingerprint != verified.fingerprint: logger.debug("key: %r", key.fingerprint) logger.debug("ver: %r", verified.fingerprint) self.assertEqual(key.fingerprint, verified.fingerprint, "Fingerprints must match") data_file = open(self.test_fn, 'rb') sig = self.gpg.sign_file(data_file, keyid=key.fingerprint, passphrase='aable', detach=True) data_file.close() self.assertTrue(sig, "File signing should succeed") self.assertTrue(sig.hash_algo) try: file = gnupg._make_binary_stream(sig.data, self.gpg.encoding) verified = self.gpg.verify_file(file, self.test_fn) except UnicodeDecodeError: #happens in Python 2.6 from io import BytesIO verified = self.gpg.verify_file(BytesIO(sig.data)) if key.fingerprint != verified.fingerprint: logger.debug("key: %r", key.fingerprint) logger.debug("ver: %r", verified.fingerprint) self.assertEqual(key.fingerprint, verified.fingerprint, "Fingerprints must match") # Test in-memory verification data_file = open(self.test_fn, 'rb') data = data_file.read() data_file.close() fd, fn = tempfile.mkstemp() os.write(fd, sig.data) os.close(fd) try: verified = self.gpg.verify_data(fn, data) finally: os.unlink(fn) if key.fingerprint != verified.fingerprint: logger.debug("key: %r", key.fingerprint) logger.debug("ver: %r", verified.fingerprint) self.assertEqual(key.fingerprint, verified.fingerprint, "Fingerprints must match") logger.debug("test_signature_verification ends") def test_signature_file(self): "Test that signing and verification works via the GPG output" logger.debug("test_signature_file begins") key = self.generate_key("Andrew", "Able", "alpha.com") data_file = open(self.test_fn, 'rb') sig_file = self.test_fn + '.asc' sig = self.gpg.sign_file(data_file, keyid=key.fingerprint, passphrase='aable', detach=True, output=sig_file) data_file.close() self.assertTrue(sig, "File signing should succeed") self.assertTrue(sig.hash_algo) self.assertTrue(os.path.exists(sig_file)) # Test in-memory verification data_file = open(self.test_fn, 'rb') data = data_file.read() data_file.close() try: verified = self.gpg.verify_data(sig_file, data) finally: os.unlink(sig_file) if key.fingerprint != verified.fingerprint: logger.debug("key: %r", key.fingerprint) logger.debug("ver: %r", verified.fingerprint) self.assertEqual(key.fingerprint, verified.fingerprint, "Fingerprints must match") logger.debug("test_signature_file ends") def test_deletion(self): "Test that key deletion works" logger.debug("test_deletion begins") self.gpg.import_keys(KEYS_TO_IMPORT) public_keys = self.gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 2), "2-element list expected") self.gpg.delete_keys(public_keys[0]['fingerprint']) public_keys = self.gpg.list_keys() self.assertTrue(is_list_with_len(public_keys, 1), "1-element list expected") logger.debug("test_deletion ends") def test_nogpg(self): "Test that absence of gpg is handled correctly" self.assertRaises(OSError, gnupg.GPG, gnupghome=self.homedir, gpgbinary='frob') def test_make_args(self): "Test argument line construction" self.gpg.options = ['--foo', '--bar'] args = self.gpg.make_args(['a', 'b'], False) self.assertTrue(len(args) > 4) self.assertEqual(args[-4:], ['--foo', '--bar', 'a', 'b']) def do_file_encryption_and_decryption(self, encfname, decfname): "Do the actual encryption.decryptin test using given filenames" mode = None if os.name == 'posix': # pick a mode that won't be already in effect via umask if os.path.exists(encfname) and os.path.exists(decfname): mode = os.stat(encfname).st_mode | stat.S_IXUSR os.chmod(encfname, mode) # assume same for decfname os.chmod(decfname, mode) logger.debug('Encrypting to: %r', encfname) logger.debug('Decrypting to: %r', decfname) try: key = self.generate_key("Andrew", "Able", "alpha.com", passphrase="andy") andrew = key.fingerprint key = self.generate_key("Barbara", "Brown", "beta.com") barbara = key.fingerprint data = "Hello, world!" file = gnupg._make_binary_stream(data, self.gpg.encoding) edata = self.gpg.encrypt_file(file, barbara, armor=False, output=encfname) efile = open(encfname, 'rb') ddata = self.gpg.decrypt_file(efile, passphrase="bbrown", output=decfname) efile.seek(0, 0) # can't use os.SEEK_SET in 2.4 edata = efile.read() efile.close() dfile = open(decfname, 'rb') ddata = dfile.read() dfile.close() data = data.encode(self.gpg.encoding) if ddata != data: logger.debug("was: %r", data) logger.debug("new: %r", ddata) self.assertEqual(data, ddata, "Round-trip must work") # Try opening the encrypted file in text mode (Issue #39) # this doesn't fail in 2.x if gnupg._py3k: efile = open(encfname, 'r') ddata = self.gpg.decrypt_file(efile, passphrase="bbrown", output=decfname) self.assertFalse(ddata) self.assertEqual(ddata.status, "no data was provided") efile.close() finally: for fn in (encfname, decfname): if os.name == 'posix' and mode is not None: # Check that the file wasn't deleted, and that the # mode bits we set are still in effect self.assertEqual(os.stat(fn).st_mode, mode) if os.path.exists(fn): os.remove(fn) def test_file_encryption_and_decryption(self): "Test that encryption/decryption to/from file works" logger.debug("test_file_encryption_and_decryption begins") encfno, encfname = tempfile.mkstemp() decfno, decfname = tempfile.mkstemp() # On Windows, if the handles aren't closed, the files can't be deleted os.close(encfno) os.close(decfno) self.do_file_encryption_and_decryption(encfname, decfname) logger.debug("test_file_encryption_and_decryption ends") def test_filenames_with_spaces(self): # See Issue #16 "Test that filenames with spaces are correctly handled" logger.debug("test_filename_with_spaces begins") d = tempfile.mkdtemp() try: encfname = os.path.join(d, 'encrypted file') decfname = os.path.join(d, 'decrypted file') self.do_file_encryption_and_decryption(encfname, decfname) finally: shutil.rmtree(d) logger.debug("test_filename_with_spaces ends") def test_search_keys(self): "Test that searching for keys works" r = self.gpg.search_keys('') self.assertTrue(r) self.assertTrue('Vinay Sajip ' in r[0]['uids']) r = self.gpg.search_keys('92905378') self.assertTrue(r) self.assertTrue('Vinay Sajip ' in r[0]['uids']) def test_quote_with_shell(self): "Test shell quoting with a real shell" if os.name != 'posix': return from subprocess import PIPE, Popen workdir = tempfile.mkdtemp() try: s = "'\\\"; touch %s/foo #'" % workdir cmd = 'echo %s' % gnupg.shell_quote(s) p = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) p.communicate() self.assertEqual(p.returncode, 0) files = os.listdir(workdir) self.assertEqual(files, []) fn = "'ab?'" cmd = 'touch %s/%s' % (workdir, gnupg.shell_quote(fn)) p = Popen(cmd, shell=True, stdout=PIPE, stderr=PIPE) p.communicate() self.assertEqual(p.returncode, 0) files = os.listdir(workdir) self.assertEqual(files, ["'ab?'"]) finally: shutil.rmtree(workdir) def disabled_test_signing_with_uid(self): "Test that signing with uids works. On hold for now." logger.debug("test_signing_with_uid begins") key = self.generate_key("Andrew", "Able", "alpha.com") uid = self.gpg.list_keys(True)[-1]['uids'][0] try: signfile = open(self.test_fn,'rb') signed = self.gpg.sign_file(signfile, keyid=uid, passphrase='aable', detach=True) finally: signfile.close() self.assertTrue(signed.data) logger.debug("test_signing_with_uid ends") TEST_GROUPS = { 'sign' : set(['test_signature_verification']), 'crypt' : set(['test_encryption_and_decryption', 'test_file_encryption_and_decryption', 'test_filenames_with_spaces']), 'key' : set(['test_deletion', 'test_import_and_export', 'test_list_keys_after_generation', 'test_key_generation_with_invalid_key_type', 'test_key_generation_with_escapes', 'test_key_generation_with_empty_value', 'test_key_generation_with_colons', 'test_search_keys', 'test_scan_keys']), 'import' : set(['test_import_only']), 'basic' : set(['test_environment', 'test_list_keys_initial', 'test_nogpg', 'test_make_args', 'test_quote_with_shell']), 'test': set(['test_search_keys']), } def suite(args=None): if args is None: args = sys.argv[1:] if not args or args == ['--no-doctests']: result = unittest.TestLoader().loadTestsFromTestCase(GPGTestCase) want_doctests = not args else: tests = set() want_doctests = False for arg in args: if arg in TEST_GROUPS: tests.update(TEST_GROUPS[arg]) elif arg == "doc": want_doctests = True else: print("Ignoring unknown test group %r" % arg) result = unittest.TestSuite(list(map(GPGTestCase, tests))) if want_doctests: result.addTest(doctest.DocTestSuite(gnupg)) return result def init_logging(): logging.basicConfig(level=logging.DEBUG, filename="test_gnupg.log", filemode="w", format="%(asctime)s %(levelname)-5s %(name)-10s %(threadName)-10s %(message)s") def main(): init_logging() tests = suite() results = unittest.TextTestRunner(verbosity=2).run(tests) return not results.wasSuccessful() if __name__ == "__main__": sys.exit(main()) python-gnupg-0.3.8/test_secring.gpg0000664000175000017500000001510412425647460017664 0ustar vinayvinay00000000000000S=3vDd4OKbm8x>>MP`p [%"Rh뼿gf%7$ӟ1`гvy3/qӆw[.X1Lׁ ԶGr'(sS*ޜ>qM)%.^3}9r1ىxKk2P(vS\}Au@ۂ4=yRtpk;Wem75Ys e*&bBʱ)cZ`as !^jq NޥMOr}y?'pQ5&QNտt~Bg℥p t.4 <(HZ5F1G|dM7jRΧd3Zlz;`KjؠDw1`DSeneF+%(A9OXD4xsu-F-tֳc $PFgk܏iDF}=nACEН $JK"![A2f%Hj\aϙOm-٭zIq$Gіy hkda?zqE$LU{/]//}G~{cASU{Uvkn>Ga=Ѣ#=̛ɢ\=s+tk;'vw/T5xX17$Z BYϣIQHZʩ]jtͽȸ F63EHXhCv>BrԸ D8NM;^Jr W,cRt/!0)l{˷*WtA$gkPEQ)T\acIe *Yw]}n1Andrew Able (A test user) 8"S/   ЮLw?av=dmEK9S QdlO]g8WJPNA,cnm6>TI\ w7|@^^#o0طs;Юx}.җ>$4P[cdbSr\Cܻ=A2yL,\/UA1{TQ2l?r?ev[ fWVE5=Ά51 ?lON:zx|qbtVcS=|,Րa'~I|-^/ZP,|NEP-י1U r^wkH rU}b4 H*2kCt!>YŠ|O+Rj env#G\טws;: '/+пJ/B9)}"Zd.M#k׶Mik;RykGYjazJ57ֆ>.咱2T1~7%汘QUrC i]PvױB J _$Pd.!Em,W׀rD^fGum}>5wFvbA spˮBX%S#Uّ: &$%3?챒̙ $ Jլ=Dg#^ Go9ڶW#Kc)CRmy/~_3gv` JZ`xX  v85swߥ','_f@6ؼMJ/!ek>b %t;|d S ЮLw-E?ǧR_ B'מ%ua؄~mo3JG_R}ikj2Kb#Z{ԅ^XrvBU)t4:dj6?%ߣ[yK*2w*03B&ڒl α(uQWXC4F̸t0ꈢz-3RP!O2Bu :cA nA!phˠOzxSyХb޹ a֡ ^۱J]ǟH {<+P:ZvMyS!);TϫcpsV tyGޤsA͔Jrn]ˏ<՟m>7 >^qd9cO'{'q?aZ ^O΂S)N찀8"S/   )gOԸh$AIvc45\ =`mLp;[A Bho3+[/g^ < 0澶d1:Zd1B"hh!ݮ'1"\]. j 2i:>$i5G':8hX%{J׃xc5SrGҜkcUԲL)Nx NRZenD|ȼdm{*u 9Һ&ZJE cSw%P_}i @#Lxh,[Y^Tu<]uލX8T}6,W% ߚ}ia6W?Ҙ.<~1 yj;V9%vt[W-:Q^@ -$z JM=hy {(ȚŚb6󠈵% k=]yɭ2Ѭɖt}2@~ɨGS+㒄?!ɖ }WPLsǙ%+7&w!oj3mjî븸>ʚ+q{Y c[A4Kz|^|mD8e?P>/G::>"YV=^M#C8̰c}S(ɐ`0qEzsW=ֿf*" ,,_RJMN*7ZM#fI:Bm81Ëm) S )gOԸ 2ĝ3X1^?FāE"cLWMG4U؛x0MC_4F\"͛XaέTD֨n ںڕCz7 Μ C)!+{mڷitu7u@䝒jӑ15rߟU$6“qV>TH@PG2aѠ6sAY#u[g o\pAh<~gF@%an.ܞ;W̟]&X`@xy9 ^SJ6:ר5Et_hGJP3w ũUJg(T9#fDg(i9%uWT[yLI8܍xaf!՟P,)͛pZE[P_ HiE.ΓpZz}Nz?GH'. 'fyn fPtXs*7T?#^>8AdY-V0~n{*!a?TгfG{sNU_uMr'/hPted`aJLImdd)loKZb,/0R0W%p9 7PFfzD+"S5Charlie Clark (A test user) 8"S/   sƷ؋Qa"7׌:a`-;.ݛ6K|G{W  IG*:~/jɩAߏIna__P^ OJ4]- 螨[~J6yRag'nj ,Ur["bH"W.Z"+qFi{a?y$*2vG2G v L̪Ȯ)N8 fSXRBDH.6ۓIb6cSgH7

4nca+YS]&rd'U zT\@;uxꎐB?YG/IH2uB"Bhʨu]$HOd?mc6Z?jąt֋ lIyLd&Vz}@/E bPQyM=.Ѿ9Ĩު3ry[dCLF A`Ȕ;7;VsyN~ `)Ylu &.l$!?k qe>*p8v`7NÉ S sƷ؋QPZMvEfFi(Lg͋: F8aa:8/ux]Nu O[Tw\D8? -(vBH"r6okgt=ƼGܼHvܢ_=+0*,zI瓗xt)RLv3Nq J䤊6aBIW(?f%_Paڥx/f>{.j]/=8v.k72Z2#4⅀python-gnupg-0.3.8/setup.py0000664000175000017500000000334312601030174016170 0ustar vinayvinay00000000000000from distutils.core import setup from gnupg import __version__ as version setup(name = "python-gnupg", description="A wrapper for the Gnu Privacy Guard (GPG or GnuPG)", long_description = "This module allows easy access to GnuPG's key \ management, encryption and signature functionality from Python programs. \ It is intended for use with Python 2.4 or greater.", license="""Copyright (C) 2008-2014 by Vinay Sajip. All Rights Reserved. See LICENSE.txt for license.""", version=version, author="Vinay Sajip", author_email="vinay_sajip@red-dove.com", maintainer="Vinay Sajip", maintainer_email="vinay_sajip@red-dove.com", url="http://packages.python.org/python-gnupg/index.html", py_modules=["gnupg"], platforms="No particular restrictions", download_url="https://pypi.python.org/packages/source/p/python-gnupg/python-gnupg-%s.tar.gz" % version, classifiers=[ 'Development Status :: 5 - Production/Stable', "Intended Audience :: Developers", 'License :: OSI Approved :: BSD License', "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Programming Language :: Python :: 2.4", "Programming Language :: Python :: 2.5", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Operating System :: OS Independent", "Topic :: Software Development :: Libraries :: Python Modules" ] ) python-gnupg-0.3.8/gnupg.py0000664000175000017500000013730212601026374016162 0ustar vinayvinay00000000000000""" A wrapper for the 'gpg' command:: Portions of this module are derived from A.M. Kuchling's well-designed GPG.py, using Richard Jones' updated version 1.3, which can be found in the pycrypto CVS repository on Sourceforge: http://pycrypto.cvs.sourceforge.net/viewvc/pycrypto/gpg/GPG.py This module is *not* forward-compatible with amk's; some of the old interface has changed. For instance, since I've added decrypt functionality, I elected to initialize with a 'gnupghome' argument instead of 'keyring', so that gpg can find both the public and secret keyrings. I've also altered some of the returned objects in order for the caller to not have to know as much about the internals of the result classes. While the rest of ISconf is released under the GPL, I am releasing this single file under the same terms that A.M. Kuchling used for pycrypto. Steve Traugott, stevegt@terraluna.org Thu Jun 23 21:27:20 PDT 2005 This version of the module has been modified from Steve Traugott's version (see http://trac.t7a.org/isconf/browser/trunk/lib/python/isconf/GPG.py) by Vinay Sajip to make use of the subprocess module (Steve's version uses os.fork() and so does not work on Windows). Renamed to gnupg.py to avoid confusion with the previous versions. Modifications Copyright (C) 2008-2014 Vinay Sajip. All rights reserved. A unittest harness (test_gnupg.py) has also been added. """ __version__ = "0.3.8" __author__ = "Vinay Sajip" __date__ = "$24-Sep-2015 18:03:55$" try: from io import StringIO except ImportError: from cStringIO import StringIO import codecs import locale import logging import os import re import socket from subprocess import Popen from subprocess import PIPE import sys import threading STARTUPINFO = None if os.name == 'nt': try: from subprocess import STARTUPINFO, STARTF_USESHOWWINDOW, SW_HIDE except ImportError: STARTUPINFO = None try: import logging.NullHandler as NullHandler except ImportError: class NullHandler(logging.Handler): def handle(self, record): pass try: unicode _py3k = False string_types = basestring text_type = unicode except NameError: _py3k = True string_types = str text_type = str logger = logging.getLogger(__name__) if not logger.handlers: logger.addHandler(NullHandler()) # We use the test below because it works for Jython as well as CPython if os.path.__name__ == 'ntpath': # On Windows, we don't need shell quoting, other than worrying about # paths with spaces in them. def shell_quote(s): return '"%s"' % s else: # Section copied from sarge # This regex determines which shell input needs quoting # because it may be unsafe UNSAFE = re.compile(r'[^\w%+,./:=@-]') def shell_quote(s): """ Quote text so that it is safe for Posix command shells. For example, "*.py" would be converted to "'*.py'". If the text is considered safe it is returned unquoted. :param s: The value to quote :type s: str (or unicode on 2.x) :return: A safe version of the input, from the point of view of Posix command shells :rtype: The passed-in type """ if not isinstance(s, string_types): raise TypeError('Expected string type, got %s' % type(s)) if not s: result = "''" elif not UNSAFE.search(s): result = s else: result = "'%s'" % s.replace("'", r"'\''") return result # end of sarge code # Now that we use shell=False, we shouldn't need to quote arguments. # Use no_quote instead of shell_quote to remind us of where quoting # was needed. However, note that we still need, on 2.x, to encode any # Unicode argument with the file system encoding - see Issue #41 and # Python issue #1759845 ("subprocess.call fails with unicode strings in # command line"). # Allows the encoding used to be overridden in special cases by setting # this module attribute appropriately. fsencoding = sys.getfilesystemencoding() def no_quote(s): if not _py3k and isinstance(s, text_type): s = s.encode(fsencoding) return s def _copy_data(instream, outstream): # Copy one stream to another sent = 0 if hasattr(sys.stdin, 'encoding'): enc = sys.stdin.encoding else: enc = 'ascii' while True: # See issue #39: read can fail when e.g. a text stream is provided # for what is actually a binary file try: data = instream.read(1024) except UnicodeError: logger.warning('Exception occurred while reading', exc_info=1) break if not data: break sent += len(data) logger.debug("sending chunk (%d): %r", sent, data[:256]) try: outstream.write(data) except UnicodeError: outstream.write(data.encode(enc)) except: # Can sometimes get 'broken pipe' errors even when the data has all # been sent logger.exception('Error sending data') break try: outstream.close() except IOError: logger.warning('Exception occurred while closing: ignored', exc_info=1) logger.debug("closed output, %d bytes sent", sent) def _threaded_copy_data(instream, outstream): wr = threading.Thread(target=_copy_data, args=(instream, outstream)) wr.setDaemon(True) logger.debug('data copier: %r, %r, %r', wr, instream, outstream) wr.start() return wr def _write_passphrase(stream, passphrase, encoding): passphrase = '%s\n' % passphrase passphrase = passphrase.encode(encoding) stream.write(passphrase) logger.debug('Wrote passphrase') def _is_sequence(instance): return isinstance(instance, (list, tuple, set, frozenset)) def _make_memory_stream(s): try: from io import BytesIO rv = BytesIO(s) except ImportError: rv = StringIO(s) return rv def _make_binary_stream(s, encoding): if _py3k: if isinstance(s, str): s = s.encode(encoding) else: if type(s) is not str: s = s.encode(encoding) return _make_memory_stream(s) class Verify(object): "Handle status messages for --verify" TRUST_UNDEFINED = 0 TRUST_NEVER = 1 TRUST_MARGINAL = 2 TRUST_FULLY = 3 TRUST_ULTIMATE = 4 TRUST_LEVELS = { "TRUST_UNDEFINED" : TRUST_UNDEFINED, "TRUST_NEVER" : TRUST_NEVER, "TRUST_MARGINAL" : TRUST_MARGINAL, "TRUST_FULLY" : TRUST_FULLY, "TRUST_ULTIMATE" : TRUST_ULTIMATE, } def __init__(self, gpg): self.gpg = gpg self.valid = False self.fingerprint = self.creation_date = self.timestamp = None self.signature_id = self.key_id = None self.username = None self.key_status = None self.status = None self.pubkey_fingerprint = None self.expire_timestamp = None self.sig_timestamp = None self.trust_text = None self.trust_level = None def __nonzero__(self): return self.valid __bool__ = __nonzero__ def handle_status(self, key, value): if key in self.TRUST_LEVELS: self.trust_text = key self.trust_level = self.TRUST_LEVELS[key] elif key in ("RSA_OR_IDEA", "NODATA", "IMPORT_RES", "PLAINTEXT", "PLAINTEXT_LENGTH", "POLICY_URL", "DECRYPTION_INFO", "DECRYPTION_OKAY", "INV_SGNR", "FILE_START", "FILE_ERROR", "FILE_DONE", "PKA_TRUST_GOOD", "PKA_TRUST_BAD", "BADMDC", "GOODMDC", "NO_SGNR", "NOTATION_NAME", "NOTATION_DATA", "PROGRESS", "PINENTRY_LAUNCHED", "NEWSIG"): pass elif key == "BADSIG": self.valid = False self.status = 'signature bad' self.key_id, self.username = value.split(None, 1) elif key == "ERRSIG": self.valid = False (self.key_id, algo, hash_algo, cls, self.timestamp) = value.split()[:5] self.status = 'signature error' elif key == "EXPSIG": self.valid = False self.status = 'signature expired' self.key_id, self.username = value.split(None, 1) elif key == "GOODSIG": self.valid = True self.status = 'signature good' self.key_id, self.username = value.split(None, 1) elif key == "VALIDSIG": (self.fingerprint, self.creation_date, self.sig_timestamp, self.expire_timestamp) = value.split()[:4] # may be different if signature is made with a subkey self.pubkey_fingerprint = value.split()[-1] self.status = 'signature valid' elif key == "SIG_ID": (self.signature_id, self.creation_date, self.timestamp) = value.split() elif key == "DECRYPTION_FAILED": self.valid = False self.key_id = value self.status = 'decryption failed' elif key == "NO_PUBKEY": self.valid = False self.key_id = value self.status = 'no public key' elif key in ("KEYEXPIRED", "SIGEXPIRED", "KEYREVOKED"): # these are useless in verify, since they are spit out for any # pub/subkeys on the key, not just the one doing the signing. # if we want to check for signatures with expired key, # the relevant flag is EXPKEYSIG or REVKEYSIG. pass elif key in ("EXPKEYSIG", "REVKEYSIG"): # signed with expired or revoked key self.valid = False self.key_id = value.split()[0] if key == "EXPKEYSIG": self.key_status = 'signing key has expired' else: self.key_status = 'signing key was revoked' self.status = self.key_status elif key == "UNEXPECTED": self.valid = False self.key_id = value self.status = 'unexpected data' else: raise ValueError("Unknown status message: %r" % key) class ImportResult(object): "Handle status messages for --import" counts = '''count no_user_id imported imported_rsa unchanged n_uids n_subk n_sigs n_revoc sec_read sec_imported sec_dups not_imported'''.split() def __init__(self, gpg): self.gpg = gpg self.imported = [] self.results = [] self.fingerprints = [] for result in self.counts: setattr(self, result, None) def __nonzero__(self): if self.not_imported: return False if not self.fingerprints: return False return True __bool__ = __nonzero__ ok_reason = { '0': 'Not actually changed', '1': 'Entirely new key', '2': 'New user IDs', '4': 'New signatures', '8': 'New subkeys', '16': 'Contains private key', } problem_reason = { '0': 'No specific reason given', '1': 'Invalid Certificate', '2': 'Issuer Certificate missing', '3': 'Certificate Chain too long', '4': 'Error storing certificate', } def handle_status(self, key, value): if key == "IMPORTED": # this duplicates info we already see in import_ok & import_problem pass elif key == "NODATA": self.results.append({'fingerprint': None, 'problem': '0', 'text': 'No valid data found'}) elif key == "IMPORT_OK": reason, fingerprint = value.split() reasons = [] for code, text in list(self.ok_reason.items()): if int(reason) | int(code) == int(reason): reasons.append(text) reasontext = '\n'.join(reasons) + "\n" self.results.append({'fingerprint': fingerprint, 'ok': reason, 'text': reasontext}) self.fingerprints.append(fingerprint) elif key == "IMPORT_PROBLEM": try: reason, fingerprint = value.split() except: reason = value fingerprint = '' self.results.append({'fingerprint': fingerprint, 'problem': reason, 'text': self.problem_reason[reason]}) elif key == "IMPORT_RES": import_res = value.split() for i, count in enumerate(self.counts): setattr(self, count, int(import_res[i])) elif key == "KEYEXPIRED": self.results.append({'fingerprint': None, 'problem': '0', 'text': 'Key expired'}) elif key == "SIGEXPIRED": self.results.append({'fingerprint': None, 'problem': '0', 'text': 'Signature expired'}) else: raise ValueError("Unknown status message: %r" % key) def summary(self): l = [] l.append('%d imported' % self.imported) if self.not_imported: l.append('%d not imported' % self.not_imported) return ', '.join(l) ESCAPE_PATTERN = re.compile(r'\\x([0-9a-f][0-9a-f])', re.I) BASIC_ESCAPES = { r'\n': '\n', r'\r': '\r', r'\f': '\f', r'\v': '\v', r'\b': '\b', r'\0': '\0', } class SendResult(object): def __init__(self, gpg): self.gpg = gpg def handle_status(self, key, value): logger.debug('SendResult: %s: %s', key, value) class SearchKeys(list): ''' Handle status messages for --search-keys. Handle pub and uid (relating the latter to the former). Don't care about the rest ''' UID_INDEX = 1 FIELDS = 'type keyid algo length date expires'.split() def __init__(self, gpg): self.gpg = gpg self.curkey = None self.fingerprints = [] self.uids = [] def get_fields(self, args): result = {} for i, var in enumerate(self.FIELDS): result[var] = args[i] result['uids'] = [] return result def pub(self, args): self.curkey = curkey = self.get_fields(args) self.append(curkey) def uid(self, args): uid = args[self.UID_INDEX] uid = ESCAPE_PATTERN.sub(lambda m: chr(int(m.group(1), 16)), uid) for k, v in BASIC_ESCAPES.items(): uid = uid.replace(k, v) self.curkey['uids'].append(uid) self.uids.append(uid) def handle_status(self, key, value): pass class ListKeys(SearchKeys): ''' Handle status messages for --list-keys. Handle pub and uid (relating the latter to the former). Don't care about (info from src/DETAILS): crt = X.509 certificate crs = X.509 certificate and private key available ssb = secret subkey (secondary key) uat = user attribute (same as user id except for field 10). sig = signature rev = revocation signature pkd = public key data (special field format, see below) grp = reserved for gpgsm rvk = revocation key ''' UID_INDEX = 9 FIELDS = 'type trust length algo keyid date expires dummy ownertrust uid'.split() def __init__(self, gpg): super(ListKeys, self).__init__(gpg) self.in_subkey = False self.key_map = {} def key(self, args): self.curkey = curkey = self.get_fields(args) if curkey['uid']: curkey['uids'].append(curkey['uid']) del curkey['uid'] curkey['subkeys'] = [] self.append(curkey) self.in_subkey = False pub = sec = key def fpr(self, args): fp = args[9] if fp in self.key_map: raise ValueError('Unexpected fingerprint collision: %s' % fp) if not self.in_subkey: self.curkey['fingerprint'] = fp self.fingerprints.append(fp) self.key_map[fp] = self.curkey else: self.curkey['subkeys'][-1].append(fp) self.key_map[fp] = self.curkey def sub(self, args): subkey = [args[4], args[11]] # keyid, type self.curkey['subkeys'].append(subkey) self.in_subkey = True class ScanKeys(ListKeys): ''' Handle status messages for --with-fingerprint.''' def sub(self, args): # --with-fingerprint --with-colons somehow outputs fewer colons, # use the last value args[-1] instead of args[11] subkey = [args[4], args[-1]] self.curkey['subkeys'].append(subkey) self.in_subkey = True class TextHandler(object): def _as_text(self): return self.data.decode(self.gpg.encoding, self.gpg.decode_errors) if _py3k: __str__ = _as_text else: __unicode__ = _as_text def __str__(self): return self.data class Crypt(Verify, TextHandler): "Handle status messages for --encrypt and --decrypt" def __init__(self, gpg): Verify.__init__(self, gpg) self.data = '' self.ok = False self.status = '' def __nonzero__(self): if self.ok: return True return False __bool__ = __nonzero__ def handle_status(self, key, value): if key in ("ENC_TO", "USERID_HINT", "GOODMDC", "END_DECRYPTION", "BEGIN_SIGNING", "NO_SECKEY", "ERROR", "NODATA", "PROGRESS", "CARDCTRL", "BADMDC", "SC_OP_FAILURE", "SC_OP_SUCCESS", "PINENTRY_LAUNCHED"): # in the case of ERROR, this is because a more specific error # message will have come first if key == "NODATA": self.status = "no data was provided" elif key in ("NEED_PASSPHRASE", "BAD_PASSPHRASE", "GOOD_PASSPHRASE", "MISSING_PASSPHRASE", "DECRYPTION_FAILED", "KEY_NOT_CREATED", "NEED_PASSPHRASE_PIN"): self.status = key.replace("_", " ").lower() elif key == "NEED_PASSPHRASE_SYM": self.status = 'need symmetric passphrase' elif key == "BEGIN_DECRYPTION": self.status = 'decryption incomplete' elif key == "BEGIN_ENCRYPTION": self.status = 'encryption incomplete' elif key == "DECRYPTION_OKAY": self.status = 'decryption ok' self.ok = True elif key == "END_ENCRYPTION": self.status = 'encryption ok' self.ok = True elif key == "INV_RECP": self.status = 'invalid recipient' elif key == "KEYEXPIRED": self.status = 'key expired' elif key == "SIG_CREATED": self.status = 'sig created' elif key == "SIGEXPIRED": self.status = 'sig expired' else: Verify.handle_status(self, key, value) class GenKey(object): "Handle status messages for --gen-key" def __init__(self, gpg): self.gpg = gpg self.type = None self.fingerprint = None def __nonzero__(self): if self.fingerprint: return True return False __bool__ = __nonzero__ def __str__(self): return self.fingerprint or '' def handle_status(self, key, value): if key in ("PROGRESS", "GOOD_PASSPHRASE", "NODATA", "KEY_NOT_CREATED", "PINENTRY_LAUNCHED"): pass elif key == "KEY_CREATED": (self.type,self.fingerprint) = value.split() else: raise ValueError("Unknown status message: %r" % key) class ExportResult(GenKey): """Handle status messages for --export[-secret-key]. For now, just use an existing class to base it on - if needed, we can override handle_status for more specific message handling. """ pass class DeleteResult(object): "Handle status messages for --delete-key and --delete-secret-key" def __init__(self, gpg): self.gpg = gpg self.status = 'ok' def __str__(self): return self.status problem_reason = { '1': 'No such key', '2': 'Must delete secret key first', '3': 'Ambiguous specification', } def handle_status(self, key, value): if key == "DELETE_PROBLEM": self.status = self.problem_reason.get(value, "Unknown error: %r" % value) else: raise ValueError("Unknown status message: %r" % key) def __nonzero__(self): return self.status == 'ok' __bool__ = __nonzero__ class Sign(TextHandler): "Handle status messages for --sign" def __init__(self, gpg): self.gpg = gpg self.type = None self.hash_algo = None self.fingerprint = None def __nonzero__(self): return self.fingerprint is not None __bool__ = __nonzero__ def handle_status(self, key, value): if key in ("USERID_HINT", "NEED_PASSPHRASE", "BAD_PASSPHRASE", "GOOD_PASSPHRASE", "BEGIN_SIGNING", "CARDCTRL", "INV_SGNR", "NO_SGNR", "MISSING_PASSPHRASE", "NEED_PASSPHRASE_PIN", "SC_OP_FAILURE", "SC_OP_SUCCESS", "PROGRESS", "PINENTRY_LAUNCHED"): pass elif key in ("KEYEXPIRED", "SIGEXPIRED"): self.status = 'key expired' elif key == "KEYREVOKED": self.status = 'key revoked' elif key == "SIG_CREATED": (self.type, algo, self.hash_algo, cls, self.timestamp, self.fingerprint ) = value.split() else: raise ValueError("Unknown status message: %r" % key) VERSION_RE = re.compile(r'gpg \(GnuPG\) (\d+(\.\d+)*)'.encode('ascii'), re.I) HEX_DIGITS_RE = re.compile(r'[0-9a-f]+$', re.I) class GPG(object): decode_errors = 'strict' result_map = { 'crypt': Crypt, 'delete': DeleteResult, 'generate': GenKey, 'import': ImportResult, 'send': SendResult, 'list': ListKeys, 'scan': ScanKeys, 'search': SearchKeys, 'sign': Sign, 'verify': Verify, 'export': ExportResult, } "Encapsulate access to the gpg executable" def __init__(self, gpgbinary='gpg', gnupghome=None, verbose=False, use_agent=False, keyring=None, options=None, secret_keyring=None): """Initialize a GPG process wrapper. Options are: gpgbinary -- full pathname for GPG binary. gnupghome -- full pathname to where we can find the public and private keyrings. Default is whatever gpg defaults to. keyring -- name of alternative keyring file to use, or list of such keyrings. If specified, the default keyring is not used. options =-- a list of additional options to pass to the GPG binary. secret_keyring -- name of alternative secret keyring file to use, or list of such keyrings. """ self.gpgbinary = gpgbinary self.gnupghome = gnupghome if keyring: # Allow passing a string or another iterable. Make it uniformly # a list of keyring filenames if isinstance(keyring, string_types): keyring = [keyring] self.keyring = keyring if secret_keyring: # Allow passing a string or another iterable. Make it uniformly # a list of keyring filenames if isinstance(secret_keyring, string_types): secret_keyring = [secret_keyring] self.secret_keyring = secret_keyring self.verbose = verbose self.use_agent = use_agent if isinstance(options, str): options = [options] self.options = options # Changed in 0.3.7 to use Latin-1 encoding rather than # locale.getpreferredencoding falling back to sys.stdin.encoding # falling back to utf-8, because gpg itself uses latin-1 as the default # encoding. self.encoding = 'latin-1' if gnupghome and not os.path.isdir(self.gnupghome): os.makedirs(self.gnupghome,0x1C0) p = self._open_subprocess(["--version"]) result = self.result_map['verify'](self) # any result will do for this self._collect_output(p, result, stdin=p.stdin) if p.returncode != 0: raise ValueError("Error invoking gpg: %s: %s" % (p.returncode, result.stderr)) m = VERSION_RE.match(result.data) if not m: self.version = None else: dot = '.'.encode('ascii') self.version = tuple([int(s) for s in m.groups()[0].split(dot)]) def make_args(self, args, passphrase): """ Make a list of command line elements for GPG. The value of ``args`` will be appended. The ``passphrase`` argument needs to be True if a passphrase will be sent to GPG, else False. """ cmd = [self.gpgbinary, '--status-fd', '2', '--no-tty'] if self.gnupghome: cmd.extend(['--homedir', no_quote(self.gnupghome)]) if self.keyring: cmd.append('--no-default-keyring') for fn in self.keyring: cmd.extend(['--keyring', no_quote(fn)]) if self.secret_keyring: for fn in self.secret_keyring: cmd.extend(['--secret-keyring', no_quote(fn)]) if passphrase: cmd.extend(['--batch', '--passphrase-fd', '0']) if self.use_agent: cmd.append('--use-agent') if self.options: cmd.extend(self.options) cmd.extend(args) return cmd def _open_subprocess(self, args, passphrase=False): # Internal method: open a pipe to a GPG subprocess and return # the file objects for communicating with it. cmd = self.make_args(args, passphrase) if self.verbose: pcmd = ' '.join(cmd) print(pcmd) logger.debug("%s", cmd) if not STARTUPINFO: si = None else: si = STARTUPINFO() si.dwFlags = STARTF_USESHOWWINDOW si.wShowWindow = SW_HIDE return Popen(cmd, shell=False, stdin=PIPE, stdout=PIPE, stderr=PIPE, startupinfo=si) def _read_response(self, stream, result): # Internal method: reads all the stderr output from GPG, taking notice # only of lines that begin with the magic [GNUPG:] prefix. # # Calls methods on the response object for each valid token found, # with the arg being the remainder of the status line. lines = [] while True: line = stream.readline() if len(line) == 0: break lines.append(line) line = line.rstrip() if self.verbose: print(line) logger.debug("%s", line) if line[0:9] == '[GNUPG:] ': # Chop off the prefix line = line[9:] L = line.split(None, 1) keyword = L[0] if len(L) > 1: value = L[1] else: value = "" result.handle_status(keyword, value) result.stderr = ''.join(lines) def _read_data(self, stream, result): # Read the contents of the file from GPG's stdout chunks = [] while True: data = stream.read(1024) if len(data) == 0: break logger.debug("chunk: %r" % data[:256]) chunks.append(data) if _py3k: # Join using b'' or '', as appropriate result.data = type(data)().join(chunks) else: result.data = ''.join(chunks) def _collect_output(self, process, result, writer=None, stdin=None): """ Drain the subprocesses output streams, writing the collected output to the result. If a writer thread (writing to the subprocess) is given, make sure it's joined before returning. If a stdin stream is given, close it before returning. """ stderr = codecs.getreader(self.encoding)(process.stderr) rr = threading.Thread(target=self._read_response, args=(stderr, result)) rr.setDaemon(True) logger.debug('stderr reader: %r', rr) rr.start() stdout = process.stdout dr = threading.Thread(target=self._read_data, args=(stdout, result)) dr.setDaemon(True) logger.debug('stdout reader: %r', dr) dr.start() dr.join() rr.join() if writer is not None: writer.join() process.wait() if stdin is not None: try: stdin.close() except IOError: pass stderr.close() stdout.close() def _handle_io(self, args, fileobj, result, passphrase=None, binary=False): "Handle a call to GPG - pass input data, collect output data" # Handle a basic data call - pass data to GPG, handle the output # including status information. Garbage In, Garbage Out :) p = self._open_subprocess(args, passphrase is not None) if not binary: stdin = codecs.getwriter(self.encoding)(p.stdin) else: stdin = p.stdin if passphrase: _write_passphrase(stdin, passphrase, self.encoding) writer = _threaded_copy_data(fileobj, stdin) self._collect_output(p, result, writer, stdin) return result # # SIGNATURE METHODS # def sign(self, message, **kwargs): """sign message""" f = _make_binary_stream(message, self.encoding) result = self.sign_file(f, **kwargs) f.close() return result def set_output_without_confirmation(self, args, output): "If writing to a file which exists, avoid a confirmation message." if os.path.exists(output): # We need to avoid an overwrite confirmation message args.extend(['--batch', '--yes']) args.extend(['--output', output]) def sign_file(self, file, keyid=None, passphrase=None, clearsign=True, detach=False, binary=False, output=None): """sign file""" logger.debug("sign_file: %s", file) if binary: args = ['-s'] else: args = ['-sa'] # You can't specify detach-sign and clearsign together: gpg ignores # the detach-sign in that case. if detach: args.append("--detach-sign") elif clearsign: args.append("--clearsign") if keyid: args.extend(['--default-key', no_quote(keyid)]) if output: # write the output to a file with the specified name self.set_output_without_confirmation(args, output) result = self.result_map['sign'](self) #We could use _handle_io here except for the fact that if the #passphrase is bad, gpg bails and you can't write the message. p = self._open_subprocess(args, passphrase is not None) try: stdin = p.stdin if passphrase: _write_passphrase(stdin, passphrase, self.encoding) writer = _threaded_copy_data(file, stdin) except IOError: logging.exception("error writing message") writer = None self._collect_output(p, result, writer, stdin) return result def verify(self, data): """Verify the signature on the contents of the string 'data' >>> gpg = GPG(gnupghome="keys") >>> input = gpg.gen_key_input(Passphrase='foo') >>> key = gpg.gen_key(input) >>> assert key >>> sig = gpg.sign('hello',keyid=key.fingerprint,passphrase='bar') >>> assert not sig >>> sig = gpg.sign('hello',keyid=key.fingerprint,passphrase='foo') >>> assert sig >>> verify = gpg.verify(sig.data) >>> assert verify """ f = _make_binary_stream(data, self.encoding) result = self.verify_file(f) f.close() return result def verify_file(self, file, data_filename=None): "Verify the signature on the contents of the file-like object 'file'" logger.debug('verify_file: %r, %r', file, data_filename) result = self.result_map['verify'](self) args = ['--verify'] if data_filename is None: self._handle_io(args, file, result, binary=True) else: logger.debug('Handling detached verification') import tempfile fd, fn = tempfile.mkstemp(prefix='pygpg') s = file.read() file.close() logger.debug('Wrote to temp file: %r', s) os.write(fd, s) os.close(fd) args.append(no_quote(fn)) args.append(no_quote(data_filename)) try: p = self._open_subprocess(args) self._collect_output(p, result, stdin=p.stdin) finally: os.unlink(fn) return result def verify_data(self, sig_filename, data): "Verify the signature in sig_filename against data in memory" logger.debug('verify_data: %r, %r ...', sig_filename, data[:16]) result = self.result_map['verify'](self) args = ['--verify', no_quote(sig_filename), '-'] stream = _make_memory_stream(data) self._handle_io(args, stream, result, binary=True) return result # # KEY MANAGEMENT # def import_keys(self, key_data): """ import the key_data into our keyring >>> import shutil >>> shutil.rmtree("keys") >>> gpg = GPG(gnupghome="keys") >>> input = gpg.gen_key_input() >>> result = gpg.gen_key(input) >>> print1 = result.fingerprint >>> result = gpg.gen_key(input) >>> print2 = result.fingerprint >>> pubkey1 = gpg.export_keys(print1) >>> seckey1 = gpg.export_keys(print1,secret=True) >>> seckeys = gpg.list_keys(secret=True) >>> pubkeys = gpg.list_keys() >>> assert print1 in seckeys.fingerprints >>> assert print1 in pubkeys.fingerprints >>> str(gpg.delete_keys(print1)) 'Must delete secret key first' >>> str(gpg.delete_keys(print1,secret=True)) 'ok' >>> str(gpg.delete_keys(print1)) 'ok' >>> str(gpg.delete_keys("nosuchkey")) 'No such key' >>> seckeys = gpg.list_keys(secret=True) >>> pubkeys = gpg.list_keys() >>> assert not print1 in seckeys.fingerprints >>> assert not print1 in pubkeys.fingerprints >>> result = gpg.import_keys('foo') >>> assert not result >>> result = gpg.import_keys(pubkey1) >>> pubkeys = gpg.list_keys() >>> seckeys = gpg.list_keys(secret=True) >>> assert not print1 in seckeys.fingerprints >>> assert print1 in pubkeys.fingerprints >>> result = gpg.import_keys(seckey1) >>> assert result >>> seckeys = gpg.list_keys(secret=True) >>> pubkeys = gpg.list_keys() >>> assert print1 in seckeys.fingerprints >>> assert print1 in pubkeys.fingerprints >>> assert print2 in pubkeys.fingerprints """ result = self.result_map['import'](self) logger.debug('import_keys: %r', key_data[:256]) data = _make_binary_stream(key_data, self.encoding) self._handle_io(['--import'], data, result, binary=True) logger.debug('import_keys result: %r', result.__dict__) data.close() return result def recv_keys(self, keyserver, *keyids): """Import a key from a keyserver >>> import shutil >>> shutil.rmtree("keys") >>> gpg = GPG(gnupghome="keys") >>> os.chmod('keys', 0x1C0) >>> result = gpg.recv_keys('keyserver.ubuntu.com', '92905378') >>> assert result """ result = self.result_map['import'](self) logger.debug('recv_keys: %r', keyids) data = _make_binary_stream("", self.encoding) #data = "" args = ['--keyserver', no_quote(keyserver), '--recv-keys'] args.extend([no_quote(k) for k in keyids]) self._handle_io(args, data, result, binary=True) logger.debug('recv_keys result: %r', result.__dict__) data.close() return result def send_keys(self, keyserver, *keyids): """Send a key to a keyserver. Note: it's not practical to test this function without sending arbitrary data to live keyservers. """ result = self.result_map['send'](self) logger.debug('send_keys: %r', keyids) data = _make_binary_stream('', self.encoding) #data = "" args = ['--keyserver', no_quote(keyserver), '--send-keys'] args.extend([no_quote(k) for k in keyids]) self._handle_io(args, data, result, binary=True) logger.debug('send_keys result: %r', result.__dict__) data.close() return result def delete_keys(self, fingerprints, secret=False): which='key' if secret: which='secret-key' if _is_sequence(fingerprints): fingerprints = [no_quote(s) for s in fingerprints] else: fingerprints = [no_quote(fingerprints)] args = ['--batch', '--delete-%s' % which] args.extend(fingerprints) result = self.result_map['delete'](self) p = self._open_subprocess(args) self._collect_output(p, result, stdin=p.stdin) return result def export_keys(self, keyids, secret=False, armor=True, minimal=False): "export the indicated keys. 'keyid' is anything gpg accepts" which='' if secret: which='-secret-key' if _is_sequence(keyids): keyids = [no_quote(k) for k in keyids] else: keyids = [no_quote(keyids)] args = ['--export%s' % which] if armor: args.append('--armor') if minimal: args.extend(['--export-options','export-minimal']) args.extend(keyids) p = self._open_subprocess(args) # gpg --export produces no status-fd output; stdout will be # empty in case of failure #stdout, stderr = p.communicate() result = self.result_map['export'](self) self._collect_output(p, result, stdin=p.stdin) logger.debug('export_keys result: %r', result.data) return result.data.decode(self.encoding, self.decode_errors) def _get_list_output(self, p, kind): # Get the response information result = self.result_map[kind](self) self._collect_output(p, result, stdin=p.stdin) lines = result.data.decode(self.encoding, self.decode_errors).splitlines() valid_keywords = 'pub uid sec fpr sub'.split() for line in lines: if self.verbose: print(line) logger.debug("line: %r", line.rstrip()) if not line: break L = line.strip().split(':') if not L: continue keyword = L[0] if keyword in valid_keywords: getattr(result, keyword)(L) return result def list_keys(self, secret=False, keys=None): """ list the keys currently in the keyring >>> import shutil >>> shutil.rmtree("keys") >>> gpg = GPG(gnupghome="keys") >>> input = gpg.gen_key_input() >>> result = gpg.gen_key(input) >>> print1 = result.fingerprint >>> result = gpg.gen_key(input) >>> print2 = result.fingerprint >>> pubkeys = gpg.list_keys() >>> assert print1 in pubkeys.fingerprints >>> assert print2 in pubkeys.fingerprints """ which='keys' if secret: which='secret-keys' args = ['--list-%s' % which, '--fixed-list-mode', '--fingerprint', '--fingerprint', # get subkey FPs, too '--with-colons'] if keys: if isinstance(keys, string_types): keys = [keys] args.extend(keys) p = self._open_subprocess(args) return self._get_list_output(p, 'list') def scan_keys(self, filename): """ List details of an ascii armored or binary key file without first importing it to the local keyring. The function achieves this by running: $ gpg --with-fingerprint --with-colons filename """ args = ['--with-fingerprint', '--with-colons'] args.append(no_quote(filename)) p = self._open_subprocess(args) return self._get_list_output(p, 'scan') def search_keys(self, query, keyserver='pgp.mit.edu'): """ search keyserver by query (using --search-keys option) >>> import shutil >>> shutil.rmtree('keys') >>> gpg = GPG(gnupghome='keys') >>> os.chmod('keys', 0x1C0) >>> result = gpg.search_keys('') >>> assert result, 'Failed using default keyserver' >>> keyserver = 'keyserver.ubuntu.com' >>> result = gpg.search_keys('', keyserver) >>> assert result, 'Failed using keyserver.ubuntu.com' """ query = query.strip() if HEX_DIGITS_RE.match(query): query = '0x' + query args = ['--fixed-list-mode', '--fingerprint', '--with-colons', '--keyserver', no_quote(keyserver), '--search-keys', no_quote(query)] p = self._open_subprocess(args) # Get the response information result = self.result_map['search'](self) self._collect_output(p, result, stdin=p.stdin) lines = result.data.decode(self.encoding, self.decode_errors).splitlines() valid_keywords = ['pub', 'uid'] for line in lines: if self.verbose: print(line) logger.debug('line: %r', line.rstrip()) if not line: # sometimes get blank lines on Windows continue L = line.strip().split(':') if not L: continue keyword = L[0] if keyword in valid_keywords: getattr(result, keyword)(L) return result def gen_key(self, input): """Generate a key; you might use gen_key_input() to create the control input. >>> gpg = GPG(gnupghome="keys") >>> input = gpg.gen_key_input() >>> result = gpg.gen_key(input) >>> assert result >>> result = gpg.gen_key('foo') >>> assert not result """ args = ["--gen-key", "--batch"] result = self.result_map['generate'](self) f = _make_binary_stream(input, self.encoding) self._handle_io(args, f, result, binary=True) f.close() return result def gen_key_input(self, **kwargs): """ Generate --gen-key input per gpg doc/DETAILS """ parms = {} for key, val in list(kwargs.items()): key = key.replace('_','-').title() if str(val).strip(): # skip empty strings parms[key] = val parms.setdefault('Key-Type','RSA') parms.setdefault('Key-Length',2048) parms.setdefault('Name-Real', "Autogenerated Key") logname = (os.environ.get('LOGNAME') or os.environ.get('USERNAME') or 'unspecified') hostname = socket.gethostname() parms.setdefault('Name-Email', "%s@%s" % (logname.replace(' ', '_'), hostname)) out = "Key-Type: %s\n" % parms.pop('Key-Type') for key, val in list(parms.items()): out += "%s: %s\n" % (key, val) out += "%commit\n" return out # Key-Type: RSA # Key-Length: 1024 # Name-Real: ISdlink Server on %s # Name-Comment: Created by %s # Name-Email: isdlink@%s # Expire-Date: 0 # %commit # # # Key-Type: DSA # Key-Length: 1024 # Subkey-Type: ELG-E # Subkey-Length: 1024 # Name-Real: Joe Tester # Name-Comment: with stupid passphrase # Name-Email: joe@foo.bar # Expire-Date: 0 # Passphrase: abc # %pubring foo.pub # %secring foo.sec # %commit # # ENCRYPTION # def encrypt_file(self, file, recipients, sign=None, always_trust=False, passphrase=None, armor=True, output=None, symmetric=False): "Encrypt the message read from the file-like object 'file'" args = ['--encrypt'] if symmetric: # can't be False or None - could be True or a cipher algo value # such as AES256 args = ['--symmetric'] if symmetric is not True: args.extend(['--cipher-algo', no_quote(symmetric)]) # else use the default, currently CAST5 else: if not recipients: raise ValueError('No recipients specified with asymmetric ' 'encryption') if not _is_sequence(recipients): recipients = (recipients,) for recipient in recipients: args.extend(['--recipient', no_quote(recipient)]) if armor: # create ascii-armored output - False for binary output args.append('--armor') if output: # write the output to a file with the specified name self.set_output_without_confirmation(args, output) if sign is True: args.append('--sign') elif sign: args.extend(['--sign', '--default-key', no_quote(sign)]) if always_trust: args.append('--always-trust') result = self.result_map['crypt'](self) self._handle_io(args, file, result, passphrase=passphrase, binary=True) logger.debug('encrypt result: %r', result.data) return result def encrypt(self, data, recipients, **kwargs): """Encrypt the message contained in the string 'data' >>> import shutil >>> if os.path.exists("keys"): ... shutil.rmtree("keys") >>> gpg = GPG(gnupghome="keys") >>> input = gpg.gen_key_input(passphrase='foo') >>> result = gpg.gen_key(input) >>> print1 = result.fingerprint >>> input = gpg.gen_key_input() >>> result = gpg.gen_key(input) >>> print2 = result.fingerprint >>> result = gpg.encrypt("hello",print2) >>> message = str(result) >>> assert message != 'hello' >>> result = gpg.decrypt(message) >>> assert result >>> str(result) 'hello' >>> result = gpg.encrypt("hello again",print1) >>> message = str(result) >>> result = gpg.decrypt(message,passphrase='bar') >>> result.status in ('decryption failed', 'bad passphrase') True >>> assert not result >>> result = gpg.decrypt(message,passphrase='foo') >>> result.status == 'decryption ok' True >>> str(result) 'hello again' >>> result = gpg.encrypt("signed hello",print2,sign=print1,passphrase='foo') >>> result.status == 'encryption ok' True >>> message = str(result) >>> result = gpg.decrypt(message) >>> result.status == 'decryption ok' True >>> assert result.fingerprint == print1 """ data = _make_binary_stream(data, self.encoding) result = self.encrypt_file(data, recipients, **kwargs) data.close() return result def decrypt(self, message, **kwargs): data = _make_binary_stream(message, self.encoding) result = self.decrypt_file(data, **kwargs) data.close() return result def decrypt_file(self, file, always_trust=False, passphrase=None, output=None): args = ["--decrypt"] if output: # write the output to a file with the specified name self.set_output_without_confirmation(args, output) if always_trust: args.append("--always-trust") result = self.result_map['crypt'](self) self._handle_io(args, file, result, passphrase, binary=True) logger.debug('decrypt result: %r', result.data) return result python-gnupg-0.3.8/README.rst0000664000175000017500000002340212601026731016147 0ustar vinayvinay00000000000000.. image:: https://travis-ci.org/vsajip/python-gnupg.svg :target: https://travis-ci.org/vsajip/python-gnupg .. image:: https://coveralls.io/repos/vsajip/python-gnupg/badge.svg :target: https://coveralls.io/github/vsajip/python-gnupg What is it? =========== The GNU Privacy Guard (gpg, or gpg.exe on Windows) is a command-line program which provides support for programmatic access via spawning a separate process to run it and then communicating with that process from your program. This project, ``python-gnupg``, implements a Python library which takes care of the internal details and allows its users to generate and manage keys, encrypt and decrypt data, and sign and verify messages. Installation ============ Installing from PyPI -------------------- You can install this package from the Python Package Index (pyPI) by running:: pip install python-gnupg Installing from a source distribution archive --------------------------------------------- To install this package from a source distribution archive, do the following: 1. Extract all the files in the distribution archive to some directory on your system. 2. In that directory, run ``python setup.py install``. 3. Optionally, run ``python test_gnupg.py`` to ensure that the package is working as expected. Credits ======= * The developers of the GNU Privacy Guard. * The original version of this module was developed by Andrew Kuchling. * It was improved by Richard Jones. * It was further improved by Steve Traugott. The present incarnation, based on the earlier versions, uses the ``subprocess`` module and so works on Windows as well as Unix/Linux platforms. It's not, however, 100% backwards-compatible with earlier incarnations. Change log ========== N.B: GCnn refers to an issue nn on Google Code. 0.3.9 (future) -------------- Released: Not yet 0.3.8 ----- Released: 2015-09-24 * Fixed #22: handled ``PROGRESS`` messages during verification and signing. * Fixed #26: handled ``PINENTRY_LAUNCHED`` messages during verification, decryption and key generation. * Fixed #28: Allowed a default Name-Email to be computed even when neither of ``LOGNAME`` and ``USERNAME`` are in the environment. * Fixed #29: Included test files missing from the tarball in previous versions. * Fixed #39: On Python 3.x, passing a text instead of a binary stream caused file decryption to hang due to a ``UnicodeDecodeError``. This has now been correctly handled: The decryption fails with a "no data" status. * Fixed #41: Handled Unicode filenames correctly by encoding them on 2.x using the file system encoding. * Fixed #43: handled ``PINENTRY_LAUNCHED`` messages during key export. Thanks to Ian Denhardt for looking into this. * Hide the console window which appears on Windows when gpg is spawned. Thanks to Kévin Bernard-Allies for the patch. * Subkey fingerprints are now captured. * The returned value from the ``list_keys`` method now has a new attribute, ``key_map``, which is a dictionary mapping key and subkey fingerprints to the corresponding key's dictionary. With this change, you don't need to iterate over the (potentially large) returned list to search for a key with a given fingerprint - the ``key_map`` dict will take you straight to the key info, whether the fingerprint you have is for a key or a subkey. Thanks to Nick Daly for the initial suggestion. 0.3.7 ----- Released: 2014-12-07 Signed with PGP key: Vinay Sajip (CODE SIGNING KEY) Key Fingerprint : CA74 9061 914E AC13 8E66 EADB 9147 B477 339A 9B86 * Added an ``output`` keyword parameter to the ``sign`` and ``sign_file`` methods, to allow writing the signature to a file. Thanks to Jannis Leidel for the patch. * Allowed specifying ``True`` for the ``sign`` keyword parameter, which allows use of the default key for signing and avoids having to specify a key id when it's desired to use the default. Thanks to Fabian Beutel for the patch. * Used a uniform approach with subprocess on Windows and POSIX: shell=True is not used on either. * When signing/verifying, the status is updated to reflect any expired or revoked keys or signatures. * Handled 'NOTATION_NAME' and 'NOTATION_DATA' during verification. * Fixed #1, #16, #18, #20: Quoting approach changed, since now shell=False. * Fixed #14: Handled 'NEED_PASSPHRASE_PIN' message. * Fixed #8: Added a scan_keys method to allow scanning of keys without the need to import into a keyring. Thanks to Venzen Khaosan for the suggestion. * Fixed #5: Added '0x' prefix when searching for keys. Thanks to Aaron Toponce for the report. * Fixed #4: Handled 'PROGRESS' message during encryption. Thanks to Daniel Mills for the report. * Fixed #3: Changed default encoding to Latin-1. * Fixed #2: Raised ValueError if no recipients were specified for an asymmetric encryption request. * Handled 'UNEXPECTED' message during verification. Thanks to David Andersen for the patch. * Replaced old range(len(X)) idiom with enumerate(). * Refactored ``ListKeys`` / ``SearchKeys`` classes to maximise use of common functions. * Fixed GC94: Added ``export-minimal`` and ``armor`` options when exporting keys. This addition was inadvertently left out of 0.3.6. 0.3.6 ----- Released: 2014-02-05 * Fixed GC82: Enabled fast random tests on gpg as well as gpg2. * Fixed GC85: Avoided deleting temporary file to preserve its permissions. * Fixed GC87: Avoided writing passphrase to log. * Fixed GC95: Added ``verify_data()`` method to allow verification of signatures in memory. * Fixed GC96: Regularised end-of-line characters. * Fixed GC98: Rectified problems with earlier fix for shell injection. 0.3.5 ----- Released: 2013-08-30 * Added improved shell quoting to guard against shell injection. * Fixed GC76: Added ``search_keys()`` and ``send_keys()`` methods. * Fixed GC77: Allowed specifying a symmetric cipher algorithm. * Fixed GC78: Fell back to utf-8 encoding when no other could be determined. * Fixed GC79: Default key length is now 2048 bits. * Fixed GC80: Removed the Name-Comment default in key generation. 0.3.4 ----- Released: 2013-06-05 * Fixed GC65: Fixed encoding exception when getting version. * Fixed GC66: Now accepts sets and frozensets where appropriate. * Fixed GC67: Hash algorithm now captured in sign result. * Fixed GC68: Added support for ``--secret-keyring``. * Fixed GC70: Added support for multiple keyrings. 0.3.3 ----- Released: 2013-03-11 * Fixed GC57: Handled control characters in ``list_keys()``. * Fixed GC61: Enabled fast random for testing. * Fixed GC62: Handled ``KEYEXPIRED`` status. * Fixed GC63: Handled ``NO_SGNR`` status. 0.3.2 ----- Released: 2013-01-17 * Fixed GC56: Disallowed blank values in key generation. * Fixed GC57: Handled colons and other characters in ``list_keys()``. * Fixed GC59/GC60: Handled ``INV_SGNR`` status during verification and removed calls requiring interactive password input from doctests. 0.3.1 ----- Released: 2012-09-01 * Fixed GC45: Allowed additional arguments to gpg executable. * Fixed GC50: Used latin-1 encoding in tests when it's known to be required. * Fixed GC51: Test now returns non-zero exit status on test failure. * Fixed GC53: Now handles ``INV_SGNR`` and ``KEY_NOT_CREATED`` statuses. * Fixed GC55: Verification and decryption now return trust level of signer in integer and text form. 0.3.0 ----- Released: 2012-05-12 * Fixed GC49: Reinstated Yann Leboulanger's change to support subkeys (accidentally left out in 0.2.7). 0.2.9 ----- Released: 2012-03-29 * Fixed GC36: Now handles ``CARDCTRL`` and ``POLICY_URL`` messages. * Fixed GC40: Now handles ``DECRYPTION_INFO``, ``DECRYPTION_FAILED`` and ``DECRYPTION_OKAY`` messages. * The ``random_binary_data file`` is no longer shipped, but constructed by the test suite if needed. 0.2.8 ----- Released: 2011-09-02 * Fixed GC29: Now handles ``IMPORT_RES`` while verifying. * Fixed GC30: Fixed an encoding problem. * Fixed GC33: Quoted arguments for added safety. 0.2.7 ----- Released: 2011-04-10 * Fixed GC24: License is clarified as BSD. * Fixed GC25: Incorporated Daniel Folkinshteyn's changes. * Fixed GC26: Incorporated Yann Leboulanger's subkey change. * Fixed GC27: Incorporated hysterix's support for symmetric encryption. * Did some internal cleanups of Unicode handling. 0.2.6 ----- Released: 2011-01-25 * Fixed GC14: Should be able to accept passphrases from GPG-Agent. * Fixed GC19: Should be able to create a detached signature. * Fixed GC21/GC23: Better handling of less common responses from GPG. 0.2.5 ----- Released: 2010-10-13 * Fixed GC11/GC16: Detached signatures can now be created. * Fixed GC3: Detached signatures can be verified. * Fixed GC12: Better support for RSA and IDEA. * Fixed GC15/GC17: Better support for non-ASCII input. 0.2.4 ----- Released: 2010-03-01 * Fixed GC9: Now allows encryption without armor and the ability to encrypt and decrypt directly to/from files. 0.2.3 ----- Released: 2010-01-07 * Fixed GC7: Made sending data to process threaded and added a test case. With a test data file used by the test case, the archive size has gone up to 5MB (the size of the test file). 0.2.2 ----- Released: 2009-10-06 * Fixed GC5/GC6: Added ``--batch`` when specifying ``--passphrase-fd`` and changed the name of the distribution file to add the ``python-`` prefix. 0.2.1 ----- Released: 2009-08-07 * Fixed GC2: Added ``handle_status()`` method to the ``ListKeys`` class. 0.2.0 ----- Released: 2009-07-16 * Various changes made to support Python 3.0. 0.1.0 ----- Released: 2009-07-04 * Initial release.