python bindings: import keysben/key-import

* Adapted from prior submissions by Tobias Mueller and Jacob Adams.
* key_import function added to gpg.core.Context().
* Two example scripts added to to examples/howto: import-key-file.py
  imports keys from a local file and import-keys.py accesses the SKS
  keyserver pool using the requests module to search for keys
  (includes check for key IDs which may not include the leading 0x).
* Added documentation demonstrating the use of the key_import()
  function with a large number of keys matching one domain (eff.org;
  the example shows how EFF staff are following their own advice
  issued last month).

1 files changed, 70 insertions, 0 deletions

diff --git a/lang/python/examples/howto/import-key-file.py b/lang/python/examples/howto/import-key-file.py
new file mode 100755
index 00000000..26ec5242
--- /dev/null
+++ b/lang/python/examples/howto/import-key-file.py
@@ -0,0 +1,70 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+from __future__ import absolute_import, division, unicode_literals
+
+# Copyright (C) 2018 Ben McGinnes <[email protected]>
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation; either version 2.1 of the License, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
+# Lesser General Public Licensefor more details.
+#
+# You should have received a copy of the GNU General Public License and the GNU
+# Lesser General Public along with this program; if not, see
+# <http://www.gnu.org/licenses/>.
+
+import gpg
+import os.path
+
+print("""
+This script imports a key or keys matching a pattern from the SKS keyserver
+pool.
+""")
+
+c = gpg.Context()
+
+homedir = input("Enter the GPG configuration directory path (optional): ")
+keyfile = input("Enter the path and filename to the file of key(s): ")
+
+if homedir.startswith("~"):
+    if os.path.exists(os.path.expanduser(homedir)) is True:
+        c.home_dir = os.path.expanduser(homedir)
+    else:
+        pass
+elif os.path.exists(homedir) is True:
+    c.home_dir = homedir
+else:
+    pass
+
+with open(keyfile, "rb") as f:
+    kdata = f.read()
+
+incoming = c.key_import(kdata)
+
+summary = """
+Total number of keys:   {0}
+Total number imported:  {1}
+Number of version 3 keys ignored:  {2}
+
+Number of imported key objects or updates:  {3}
+Number of unchanged keys:  {4}
+Number of new signatures:  {5}
+Number of revoked keys:    {6}
+""".format(incoming.considered, len(incoming.imports),
+           incoming.skipped_v3_keys, incoming.imported, incoming.unchanged,
+           incoming.new_signatures, incoming.new_revocations)
+
+print(summary)
+
+# EOF