673fe62e1e1c202f859634582d1ea7dcae6de492
[gpgme.git] / lang / python / examples / howto / pmkey-import-hkp-alt.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3
4 from __future__ import absolute_import, division, unicode_literals
5
6 import gpg
7 import hkp4py
8 import os.path
9 import sys
10
11 del absolute_import, division, unicode_literals
12
13 # Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
14 #
15 # This program is free software; you can redistribute it and/or modify it under
16 # the terms of the GNU General Public License as published by the Free Software
17 # Foundation; either version 2 of the License, or (at your option) any later
18 # version.
19 #
20 # This program is free software; you can redistribute it and/or modify it under
21 # the terms of the GNU Lesser General Public License as published by the Free
22 # Software Foundation; either version 2.1 of the License, or (at your option)
23 # any later version.
24 #
25 # This program is distributed in the hope that it will be useful, but WITHOUT
26 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
27 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
28 # Lesser General Public License for more details.
29 #
30 # You should have received a copy of the GNU General Public License and the GNU
31 # Lesser General Public along with this program; if not, see
32 # <https://www.gnu.org/licenses/>.
33
34 print("""
35 This script searches the ProtonMail key server for the specified key and
36 imports it.  Optionally enables specifying a different GnuPG home directory.
37
38 Usage:  pmkey-import-hkp.py [homedir] [search string]
39    or:  pmkey-import-hkp.py [search string]
40 """)
41
42 c = gpg.Context(armor=True)
43 server = hkp4py.KeyServer("hkps://api.protonmail.ch")
44 keyterms = []
45 ksearch = []
46 allkeys = []
47 results = []
48 paradox = []
49 homeless = None
50
51 if len(sys.argv) > 3:
52     homedir = sys.argv[1]
53     keyterms = sys.argv[2:]
54 elif len(sys.argv) == 3:
55     homedir = sys.argv[1]
56     keyterm = sys.argv[2]
57     keyterms.append(keyterm)
58 elif len(sys.argv) == 2:
59     homedir = ""
60     keyterm = sys.argv[1]
61     keyterms.append(keyterm)
62 else:
63     keyterm = input("Enter the key ID, UID or search string: ")
64     homedir = input("Enter the GPG configuration directory path (optional): ")
65     keyterms.append(keyterm)
66
67 if len(homedir) == 0:
68     homedir = None
69     homeless = False
70
71 if homedir is not None:
72     if homedir.startswith("~"):
73         if os.path.exists(os.path.expanduser(homedir)) is True:
74             if os.path.isdir(os.path.expanduser(homedir)) is True:
75                 c.home_dir = os.path.realpath(os.path.expanduser(homedir))
76             else:
77                 homeless = True
78         else:
79             homeless = True
80     elif os.path.exists(os.path.realpath(homedir)) is True:
81         if os.path.isdir(os.path.realpath(homedir)) is True:
82             c.home_dir = os.path.realpath(homedir)
83         else:
84             homeless = True
85     else:
86         homeless = True
87
88 # First check to see if the homedir really is a homedir and if not, treat it as
89 # a search string.
90 if homeless is True:
91     keyterms.append(homedir)
92     c.home_dir = None
93 else:
94     pass
95
96 for keyterm in keyterms:
97     if keyterm.count("@") == 2 and keyterm.startswith("@") is True:
98         ksearch.append(keyterm[1:])
99         ksearch.append(keyterm[1:])
100         ksearch.append(keyterm[1:])
101     elif keyterm.count("@") == 1 and keyterm.startswith("@") is True:
102         ksearch.append("{0}@protonmail.com".format(keyterm[1:]))
103         ksearch.append("{0}@protonmail.ch".format(keyterm[1:]))
104         ksearch.append("{0}@pm.me".format(keyterm[1:]))
105     elif keyterm.count("@") == 0:
106         ksearch.append("{0}@protonmail.com".format(keyterm))
107         ksearch.append("{0}@protonmail.ch".format(keyterm))
108         ksearch.append("{0}@pm.me".format(keyterm))
109     elif keyterm.count("@") == 2 and keyterm.startswith("@") is False:
110         uidlist = keyterm.split("@")
111         for uid in uidlist:
112             ksearch.append("{0}@protonmail.com".format(uid))
113             ksearch.append("{0}@protonmail.ch".format(uid))
114             ksearch.append("{0}@pm.me".format(uid))
115     elif keyterm.count("@") > 2:
116         uidlist = keyterm.split("@")
117         for uid in uidlist:
118             ksearch.append("{0}@protonmail.com".format(uid))
119             ksearch.append("{0}@protonmail.ch".format(uid))
120             ksearch.append("{0}@pm.me".format(uid))
121     else:
122         ksearch.append(keyterm)
123
124 for k in ksearch:
125     print("Checking for key for: {0}".format(k))
126     try:
127         keys = server.search(k)
128         if isinstance(keys, list) is True:
129             for key in keys:
130                 allkeys.append(key)
131                 try:
132                     import_result = c.key_import(key.key_blob)
133                 except Exception as e:
134                     import_result = c.key_import(key.key)
135         else:
136             paradox.append(keys)
137             import_result = None
138     except Exception as e:
139         import_result = None
140     results.append(import_result)
141
142 for result in results:
143     if result is not None and hasattr(result, "considered") is False:
144         print("{0} for {1}".format(result.decode(), k))
145     elif result is not None and hasattr(result, "considered") is True:
146         num_keys = len(result.imports)
147         new_revs = result.new_revocations
148         new_sigs = result.new_signatures
149         new_subs = result.new_sub_keys
150         new_uids = result.new_user_ids
151         new_scrt = result.secret_imported
152         nochange = result.unchanged
153         print("""
154 The total number of keys considered for import was:  {0}
155
156 With UIDs wholely or partially matching the following string:
157
158         {1}
159
160    Number of keys revoked:  {2}
161  Number of new signatures:  {3}
162     Number of new subkeys:  {4}
163    Number of new user IDs:  {5}
164 Number of new secret keys:  {6}
165  Number of unchanged keys:  {7}
166
167 The key IDs for all considered keys were:
168 """.format(num_keys, k, new_revs, new_sigs, new_subs, new_uids, new_scrt,
169            nochange))
170         for i in range(num_keys):
171             print(result.imports[i].fpr)
172         print("")
173     elif result is None:
174         pass