]> git.decadent.org.uk Git - dak.git/blob - dak/import_keyring.py
Merge commit 'lamby/master' into merge
[dak.git] / dak / import_keyring.py
1 #!/usr/bin/env python
2
3 """ Imports a keyring into the database """
4 # Copyright (C) 2007  Anthony Towns <aj@erisian.com.au>
5
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19
20 ################################################################################
21
22 import sys, os, re
23 import apt_pkg, ldap, email.Utils
24
25 from daklib.config import Config
26 from daklib.dbconn import *
27
28
29 # Globals
30 Options = None
31
32 ################################################################################
33
34 def get_uid_info(session):
35     byname = {}
36     byid = {}
37     q = session.execute("SELECT id, uid, name FROM uid")
38     for (keyid, uid, name) in q.fetchall():
39         byname[uid] = (keyid, name)
40         byid[keyid] = (uid, name)
41     return (byname, byid)
42
43 def get_fingerprint_info(session):
44     fins = {}
45     q = session.execute("SELECT f.fingerprint, f.id, f.uid, f.keyring FROM fingerprint f")
46     for (fingerprint, fingerprint_id, uid, keyring) in q.fetchall():
47         fins[fingerprint] = (uid, fingerprint_id, keyring)
48     return fins
49
50 ################################################################################
51
52 def get_ldap_name(entry):
53     name = []
54     for k in ["cn", "mn", "sn"]:
55         ret = entry.get(k)
56         if ret and ret[0] != "" and ret[0] != "-":
57             name.append(ret[0])
58     return " ".join(name)
59
60 ################################################################################
61
62 class Keyring(object):
63     gpg_invocation = "gpg --no-default-keyring --keyring %s" +\
64                      " --with-colons --fingerprint --fingerprint"
65     keys = {}
66     fpr_lookup = {}
67
68     def de_escape_gpg_str(self, str):
69         esclist = re.split(r'(\\x..)', str)
70         for x in range(1,len(esclist),2):
71             esclist[x] = "%c" % (int(esclist[x][2:],16))
72         return "".join(esclist)
73
74     def __init__(self, keyring):
75         self.cnf = Config()
76         k = os.popen(self.gpg_invocation % keyring, "r")
77         keys = self.keys
78         key = None
79         fpr_lookup = self.fpr_lookup
80         signingkey = False
81         for line in k.xreadlines():
82             field = line.split(":")
83             if field[0] == "pub":
84                 key = field[4]
85                 (name, addr) = email.Utils.parseaddr(field[9])
86                 name = re.sub(r"\s*[(].*[)]", "", name)
87                 if name == "" or addr == "" or "@" not in addr:
88                     name = field[9]
89                     addr = "invalid-uid"
90                 name = self.de_escape_gpg_str(name)
91                 keys[key] = {"email": addr}
92                 if name != "": keys[key]["name"] = name
93                 keys[key]["aliases"] = [name]
94                 keys[key]["fingerprints"] = []
95                 signingkey = True
96             elif key and field[0] == "sub" and len(field) >= 12:
97                 signingkey = ("s" in field[11])
98             elif key and field[0] == "uid":
99                 (name, addr) = email.Utils.parseaddr(field[9])
100                 if name and name not in keys[key]["aliases"]:
101                     keys[key]["aliases"].append(name)
102             elif signingkey and field[0] == "fpr":
103                 keys[key]["fingerprints"].append(field[9])
104                 fpr_lookup[field[9]] = key
105
106     def generate_desired_users(self):
107         if Options["Generate-Users"]:
108             format = Options["Generate-Users"]
109             return self.generate_users_from_keyring(format)
110         if Options["Import-Ldap-Users"]:
111             return self.import_users_from_ldap()
112         return ({}, {})
113
114     def import_users_from_ldap(self):
115         LDAPDn = self.cnf["Import-LDAP-Fingerprints::LDAPDn"]
116         LDAPServer = self.cnf["Import-LDAP-Fingerprints::LDAPServer"]
117         l = ldap.open(LDAPServer)
118         l.simple_bind_s("","")
119         Attrs = l.search_s(LDAPDn, ldap.SCOPE_ONELEVEL,
120                "(&(keyfingerprint=*)(gidnumber=%s))" % (self.cnf["Import-Users-From-Passwd::ValidGID"]),
121                ["uid", "keyfingerprint", "cn", "mn", "sn"])
122
123         ldap_fin_uid_id = {}
124
125         byuid = {}
126         byname = {}
127         keys = self.keys
128         fpr_lookup = self.fpr_lookup
129
130         for i in Attrs:
131             entry = i[1]
132             uid = entry["uid"][0]
133             name = get_ldap_name(entry)
134             fingerprints = entry["keyFingerPrint"]
135             keyid = None
136             for f in fingerprints:
137                 key = fpr_lookup.get(f, None)
138                 if key not in keys: continue
139                 keys[key]["uid"] = uid
140
141                 if keyid != None: continue
142                 keyid = get_or_set_uid(uid).uid
143                 byuid[keyid] = (uid, name)
144                 byname[uid] = (keyid, name)
145
146         return (byname, byuid)
147
148     def generate_users_from_keyring(self, format):
149         byuid = {}
150         byname = {}
151         keys = self.keys
152         any_invalid = False
153         for x in keys.keys():
154             if keys[x]["email"] == "invalid-uid":
155                 any_invalid = True
156                 keys[x]["uid"] = format % "invalid-uid"
157             else:
158                 uid = format % keys[x]["email"]
159                 keyid = get_or_set_uid(uid).uid
160                 byuid[keyid] = (uid, keys[x]["name"])
161                 byname[uid] = (keyid, keys[x]["name"])
162                 keys[x]["uid"] = uid
163         if any_invalid:
164             uid = format % "invalid-uid"
165             keyid = get_or_set_uid(uid).uid
166             byuid[keyid] = (uid, "ungeneratable user id")
167             byname[uid] = (keyid, "ungeneratable user id")
168         return (byname, byuid)
169
170 ################################################################################
171
172 def usage (exit_code=0):
173     print """Usage: dak import-keyring [OPTION]... [KEYRING]
174   -h, --help                  show this help and exit.
175   -L, --import-ldap-users     generate uid entries for keyring from LDAP
176   -U, --generate-users FMT    generate uid entries from keyring as FMT"""
177     sys.exit(exit_code)
178
179
180 ################################################################################
181
182 def main():
183     global Options
184
185     cnf = Config()
186     Arguments = [('h',"help","Import-Keyring::Options::Help"),
187                  ('L',"import-ldap-users","Import-Keyring::Options::Import-Ldap-Users"),
188                  ('U',"generate-users","Import-Keyring::Options::Generate-Users", "HasArg"),
189                 ]
190
191     for i in [ "help", "report-changes", "generate-users", "import-ldap-users" ]:
192         if not cnf.has_key("Import-Keyring::Options::%s" % (i)):
193             cnf["Import-Keyring::Options::%s" % (i)] = ""
194
195     keyring_names = apt_pkg.ParseCommandLine(cnf.Cnf, Arguments, sys.argv)
196
197     ### Parse options
198
199     Options = cnf.SubTree("Import-Keyring::Options")
200     if Options["Help"]:
201         usage()
202
203     if len(keyring_names) != 1:
204         usage(1)
205
206     ### Keep track of changes made
207
208     changes = []   # (uid, changes strings)
209
210     ### Initialise
211     session = DBConn().session()
212
213     ### Cache all the existing fingerprint entries
214     db_fin_info = get_fingerprint_info(session)
215
216     ### Parse the keyring
217
218     keyringname = keyring_names[0]
219     keyring = Keyring(keyringname)
220
221     is_dm = "false"
222     if cnf.has_key("Import-Keyring::"+keyringname+"::Debian-Maintainer"):
223         session.execute("UPDATE keyrings SET debian_maintainer = :dm WHERE name = :name",
224                         {'dm': cnf["Import-Keyring::"+keyringname+"::Debian-Maintainer"],
225                          'name': keyringname.split("/")[-1]})
226
227         is_dm = cnf["Import-Keyring::"+keyringname+"::Debian-Maintainer"]
228
229     keyring_id = get_or_set_keyring(
230         keyringname.split("/")[-1], session,
231     ).keyring_id
232
233     ### Generate new uid entries if they're needed (from LDAP or the keyring)
234     (desuid_byname, desuid_byid) = keyring.generate_desired_users()
235
236     ### Cache all the existing uid entries
237     (db_uid_byname, db_uid_byid) = get_uid_info(session)
238
239     ### Update full names of applicable users
240     for keyid in desuid_byid.keys():
241         uid = (keyid, desuid_byid[keyid][0])
242         name = desuid_byid[keyid][1]
243         oname = db_uid_byname[keyid][1]
244         if name and oname != name:
245             changes.append((uid[1], "Full name: %s" % (name)))
246             session.execute("UPDATE uid SET name = :name WHERE id = :keyid",
247                             {'name': name, 'keyid': keyid})
248
249     # The fingerprint table (fpr) points to a uid and a keyring.
250     #   If the uid is being decided here (ldap/generate) we set it to it.
251     #   Otherwise, if the fingerprint table already has a uid (which we've
252     #     cached earlier), we preserve it.
253     #   Otherwise we leave it as None
254
255     fpr = {}
256     for z in keyring.keys.keys():
257         keyid = db_uid_byname.get(keyring.keys[z].get("uid", None), [None])[0]
258         if keyid == None:
259             keyid = db_fin_info.get(keyring.keys[z]["fingerprints"][0], [None])[0]
260         for y in keyring.keys[z]["fingerprints"]:
261             fpr[y] = (keyid,keyring_id)
262
263     # For any keys that used to be in this keyring, disassociate them.
264     # We don't change the uid, leaving that for historical info; if
265     # the id should change, it'll be set when importing another keyring.
266
267     for f,(u,fid,kr) in db_fin_info.iteritems():
268         if kr != keyring_id: continue
269         if f in fpr: continue
270         changes.append((db_uid_byid.get(u, [None])[0], "Removed key: %s" % (f)))
271         session.execute("UPDATE fingerprint SET keyring = NULL WHERE id = :fprid", {'fprid': fid})
272
273     # For the keys in this keyring, add/update any fingerprints that've
274     # changed.
275
276     for f in fpr:
277         newuid = fpr[f][0]
278         newuiduid = db_uid_byid.get(newuid, [None])[0]
279         (olduid, oldfid, oldkid) = db_fin_info.get(f, [-1,-1,-1])
280         if olduid == None: olduid = -1
281         if oldkid == None: oldkid = -1
282         if oldfid == -1:
283             changes.append((newuiduid, "Added key: %s" % (f)))
284             if newuid:
285                 session.execute("""INSERT INTO fingerprint (fingerprint, uid, keyring)
286                                         VALUES (:fpr, :uid, :keyring)""",
287                                 {'fpr': f, 'uid': uid, 'keyring': keyring_id})
288             else:
289                 session.execute("""INSERT INTO fingerprint (fingerprint, keyring)
290                                         VALUES (:fpr, :keyring)""",
291                                 {'fpr': f, 'keyring': keyring_id})
292         else:
293             if newuid and olduid != newuid:
294                 if olduid != -1:
295                     changes.append((newuiduid, "Linked key: %s" % f))
296                     changes.append((newuiduid, "  (formerly belonging to %s)" % (db_uid_byid[olduid][0])))
297                 else:
298                     changes.append((newuiduid, "Linked key: %s" % f))
299                     changes.append((newuiduid, "  (formerly unowned)"))
300                 session.execute("UPDATE fingerprint SET uid = :uid WHERE id = :fpr",
301                                 {'uid': newuid, 'fpr': oldfid})
302
303             if oldkid != keyring_id:
304                 # Only change the keyring if it won't result in a loss of permissions
305                 q = session.execute("SELECT debian_maintainer FROM keyrings WHERE id = :keyring",
306                                     {'keyring': keyring_id})
307                 if is_dm == "false" and not q.fetchall()[0][0]:
308                     session.execute("UPDATE fingerprint SET keyring = :keyring WHERE id = :fpr",
309                                     {'keyring': keyring_id, 'fpr': oldfid})
310                 else:
311                     print "Key %s exists in both DM and DD keyrings. Not demoting." % (f)
312
313     # All done!
314     session.commit()
315
316     changesd = {}
317     for (k, v) in changes:
318         if k not in changesd: changesd[k] = ""
319         changesd[k] += "    %s\n" % (v)
320
321     keys = changesd.keys()
322     keys.sort()
323     for k in keys:
324         print "%s\n%s\n" % (k, changesd[k])
325
326 ################################################################################
327
328 if __name__ == '__main__':
329     main()