X-Git-Url: https://git.decadent.org.uk/gitweb/?p=dak.git;a=blobdiff_plain;f=dak%2Fimport_keyring.py;h=3b53bff39f5973a496be04d730b3e34f1e601b7b;hp=f61cc2c9ca3aba1ba45175cc86c4b6cb2507d3ca;hb=fdbef587c29814f97c192de5a8b7e9f09cc45fa4;hpb=080d94a27b1a06954ce37cff1c8515d8b1a7113b diff --git a/dak/import_keyring.py b/dak/import_keyring.py index f61cc2c9..3b53bff3 100755 --- a/dak/import_keyring.py +++ b/dak/import_keyring.py @@ -1,7 +1,8 @@ #!/usr/bin/env python -# Imports a keyring into the database +""" Imports a keyring into the database """ # Copyright (C) 2007 Anthony Towns +# Copyright (C) 2009 Mark Hymers # 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 @@ -19,231 +20,246 @@ ################################################################################ -import daklib.database, daklib.logging -import apt_pkg, pg -import sys, os, email.Utils, re +import sys, os, re +import apt_pkg, ldap + +from daklib.config import Config +from daklib.dbconn import * # Globals -Cnf = None Options = None -projectB = None -Logger = None ################################################################################ -# These could possibly be daklib.db functions, and reused by -# import-ldap-fingerprints - -def get_uid_info(): +def get_uid_info(session): byname = {} byid = {} - q = projectB.query("SELECT id, uid, name FROM uid") - for (id, uid, name) in q.getresult(): - byname[uid] = (id, name) - byid[id] = (uid, name) + q = session.execute("SELECT id, uid, name FROM uid") + for (keyid, uid, name) in q.fetchall(): + byname[uid] = (keyid, name) + byid[keyid] = (uid, name) + return (byname, byid) -def get_fingerprint_info(): +def get_fingerprint_info(session): fins = {} - q = projectB.query("SELECT f.fingerprint, f.id, f.uid, f.keyring FROM fingerprint f") - for (fingerprint, fingerprint_id, uid, keyring) in q.getresult(): + q = session.execute("SELECT f.fingerprint, f.id, f.uid, f.keyring FROM fingerprint f") + for (fingerprint, fingerprint_id, uid, keyring) in q.fetchall(): fins[fingerprint] = (uid, fingerprint_id, keyring) return fins -################################################################################ - -class Keyring: - gpg_invocation = "gpg --no-default-keyring --keyring %s" +\ - " --with-colons --fingerprint --fingerprint" - keys = {} - - def de_escape_str(self, str): - esclist = re.split(r'(\\x..)', str) - for x in range(1,len(esclist),2): - esclist[x] = "%c" % (int(esclist[x][2:],16)) - return "".join(esclist) - - def __init__(self, keyring): - k = os.popen(self.gpg_invocation % keyring, "r") - keys = self.keys - key = None - signingkey = False - for line in k.xreadlines(): - field = line.split(":") - if field[0] == "pub": - key = field[4] - (name, addr) = email.Utils.parseaddr(field[9]) - name = re.sub(r"\s*[(].*[)]", "", name) - if name == "" or addr == "" or "@" not in addr: - name = field[9] - addr = "invalid-uid" - name = self.de_escape_str(name) - keys[key] = {"email": addr} - if name != "": keys[key]["name"] = name - keys[key]["aliases"] = [name] - keys[key]["fingerprints"] = [] - signingkey = True - elif key and field[0] == "sub" and len(field) >= 12: - signingkey = ("s" in field[11]) - elif key and field[0] == "uid": - (name, addr) = email.Utils.parseaddr(field[9]) - if name and name not in keys[key]["aliases"]: - keys[key]["aliases"].append(name) - elif signingkey and field[0] == "fpr": - keys[key]["fingerprints"].append(field[9]) - - def desired_users(self, format="%s"): - if not Options["Generate-Users"]: - return ({}, {}) - - byuid = {} - byname = {} - keys = self.keys - any_invalid = False - for x in keys.keys(): - if keys[x]["email"] == "invalid-uid": - any_invalid = True - else: - uid = format % keys[x]["email"] - id = daklib.database.get_or_set_uid_id(uid) - byuid[id] = (uid, keys[x]["name"]) - byname[uid] = (id, keys[x]["name"]) - if any_invalid: - uid = format % "invalid-uid" - id = daklib.database.get_or_set_uid_id(uid) - byuid[id] = (uid, "ungeneratable user id") - byname[uid] = (id, "ungeneratable user id") - return (byname, byuid) +def list_uids(session, pattern): + sql_pattern = "%%%s%%" % pattern + message = "List UIDs matching pattern %s" % sql_pattern + message += "\n" + ("=" * len(message)) + print message + uid_query = session.query(Uid).filter(Uid.uid.ilike(sql_pattern)) + for uid in uid_query.all(): + print "\nuid %s" % uid.uid + for fp in uid.fingerprint: + print " fingerprint %s" % fp.fingerprint + keyring = "unknown" + if fp.keyring: + keyring = fp.keyring.keyring_name + print " keyring %s" % keyring ################################################################################ def usage (exit_code=0): print """Usage: dak import-keyring [OPTION]... [KEYRING] -h, --help show this help and exit. - -U, --generate-users FMT generate uid entries from keyring as FMT""" + -L, --import-ldap-users generate uid entries for keyring from LDAP + -U, --generate-users FMT generate uid entries from keyring as FMT + -l, --list-uids STRING list all uids matching *STRING* + -n, --no-action don't change database""" sys.exit(exit_code) ################################################################################ def main(): - global Cnf, projectB, Options + global Options - Cnf = daklib.utils.get_conf() + cnf = Config() Arguments = [('h',"help","Import-Keyring::Options::Help"), - ('U',"generate-users","Import-Keyring::Options::Generate-Users", "HasArg"), - ] + ('L',"import-ldap-users","Import-Keyring::Options::Import-Ldap-Users"), + ('U',"generate-users","Import-Keyring::Options::Generate-Users", "HasArg"), + ('l',"list-uids","Import-Keyring::Options::List-UIDs", "HasArg"), + ('n',"no-action","Import-Keyring::Options::No-Action"), + ] - for i in [ "help", "report-changes", "generate-users" ]: - if not Cnf.has_key("Import-Keyring::Options::%s" % (i)): - Cnf["Import-Keyring::Options::%s" % (i)] = "" + for i in [ "help", "report-changes", "generate-users", + "import-ldap-users", "list-uids", "no-action" ]: + if not cnf.has_key("Import-Keyring::Options::%s" % (i)): + cnf["Import-Keyring::Options::%s" % (i)] = "" - keyring_names = apt_pkg.ParseCommandLine(Cnf, Arguments, sys.argv) + keyring_names = apt_pkg.parse_commandline(cnf.Cnf, Arguments, sys.argv) - Options = Cnf.SubTree("Import-Keyring::Options") - if Options["Help"]: - usage() + ### Parse options - uid_format = "%s" - if Options["Generate-Users"]: - uid_format = Options["Generate-Users"] + Options = cnf.subtree("Import-Keyring::Options") - changes = [] # (uid, changes strings) + if Options["Help"]: + usage() - projectB = pg.connect(Cnf["DB::Name"], Cnf["DB::Host"], int(Cnf["DB::Port"])) - daklib.database.init(Cnf, projectB) + ### Initialise + session = DBConn().session() - projectB.query("BEGIN WORK") + if Options["List-UIDs"]: + list_uids(session, Options["List-UIDs"]) + sys.exit(0) if len(keyring_names) != 1: - usage(1) + usage(1) - # Parse the keyring - keyringname = keyring_names[0] - keyring = Keyring(keyringname) + ### Keep track of changes made + changes = [] # (uid, changes strings) - keyring_id = daklib.database.get_or_set_keyring_id( - keyringname.split("/")[-1]) + ### Cache all the existing fingerprint entries + db_fin_info = get_fingerprint_info(session) - # If we're generating uids, make sure we have entries in the uid - # table for every uid - (desuid_byname, desuid_byid) = keyring.desired_users(uid_format) + ### Parse the keyring - # Cache all the existing fingerprint and uid entries - db_fin_info = get_fingerprint_info() - (db_uid_byname, db_uid_byid) = get_uid_info() + keyringname = keyring_names[0] + keyring = get_keyring(keyringname, session) + if not keyring: + print "E: Can't load keyring %s from database" % keyringname + sys.exit(1) - # Update full names of uids + keyring.load_keys(keyringname) - for id in desuid_byid.keys(): - uid = (id, desuid_byid[id][0]) - name = desuid_byid[id][1] - oname = db_uid_byid[id][1] - if name and oname != name: - changes.append((uid[1], "Full name: %s\n" % (name))) - projectB.query("UPDATE uid SET name = '%s' WHERE id = %s" % - (pg.escape_string(name), id)) + ### Generate new uid entries if they're needed (from LDAP or the keyring) + if Options["Generate-Users"]: + format = Options["Generate-Users"] + (desuid_byname, desuid_byid) = keyring.generate_users_from_keyring(Options["Generate-Users"], session) + elif Options["Import-Ldap-Users"]: + (desuid_byname, desuid_byid) = keyring.import_users_from_ldap(session) + else: + (desuid_byname, desuid_byid) = ({}, {}) + + ### Cache all the existing uid entries + (db_uid_byname, db_uid_byid) = get_uid_info(session) + + ### Update full names of applicable users + for keyid in desuid_byid.keys(): + uid = (keyid, desuid_byid[keyid][0]) + name = desuid_byid[keyid][1] + oname = db_uid_byid[keyid][1] + if name and oname != name: + changes.append((uid[1], "Full name: %s" % (name))) + session.execute("UPDATE uid SET name = :name WHERE id = :keyid", + {'name': name, 'keyid': keyid}) + + # The fingerprint table (fpr) points to a uid and a keyring. + # If the uid is being decided here (ldap/generate) we set it to it. + # Otherwise, if the fingerprint table already has a uid (which we've + # cached earlier), we preserve it. + # Otherwise we leave it as None - # Work out what the fingerprint table should look like for the keys - # in this keyring fpr = {} for z in keyring.keys.keys(): - id = db_uid_byname.get(uid_format % keyring.keys[z]["email"], [None])[0] - if id == None: - id = db_fin_info.get(keyring.keys[z]["fingerprints"][0], [None])[0] - for y in keyring.keys[z]["fingerprints"]: - fpr[y] = (id,keyring_id) + keyid = db_uid_byname.get(keyring.keys[z].get("uid", None), [None])[0] + if keyid == None: + keyid = db_fin_info.get(keyring.keys[z]["fingerprints"][0], [None])[0] + for y in keyring.keys[z]["fingerprints"]: + fpr[y] = (keyid, keyring.keyring_id) # For any keys that used to be in this keyring, disassociate them. - # We don't change the uid, leaving that to for historical info; if - # the id should change, it'll be set when importing another keyring - # or importing ldap fingerprints. + # We don't change the uid, leaving that for historical info; if + # the id should change, it'll be set when importing another keyring. for f,(u,fid,kr) in db_fin_info.iteritems(): - if kr != keyring_id: continue - if f in fpr: continue - changes.append((db_uid_byid.get(u, [None])[0], "Removed key: %s\n" % (f))) - projectB.query("UPDATE fingerprint SET keyring = NULL WHERE id = %d" % (fid)) - + if kr != keyring.keyring_id: + continue + + if f in fpr: + continue + + changes.append((db_uid_byid.get(u, [None])[0], "Removed key: %s" % (f))) + session.execute("""UPDATE fingerprint + SET keyring = NULL + WHERE id = :fprid""", {'fprid': fid}) + # For the keys in this keyring, add/update any fingerprints that've # changed. for f in fpr: newuid = fpr[f][0] - newuiduid = db_uid_byid.get(newuid, [None])[0] - (olduid, oldfid, oldkid) = db_fin_info.get(f, [-1,-1,-1]) - if olduid == None: olduid = -1 - if oldkid == None: oldkid = -1 - if oldfid == -1: - changes.append((newuiduid, "Added key: %s\n" % (f))) + newuiduid = db_uid_byid.get(newuid, [None])[0] + + (olduid, oldfid, oldkid) = db_fin_info.get(f, [-1,-1,-1]) + + if olduid == None: + olduid = -1 + + if oldkid == None: + oldkid = -1 + + if oldfid == -1: + changes.append((newuiduid, "Added key: %s" % (f))) + fp = Fingerprint() + fp.fingerprint = f + fp.keyring_id = keyring.keyring_id if newuid: - projectB.query("INSERT INTO fingerprint (fingerprint, uid, keyring) VALUES ('%s', %d, %d)" % (f, newuid, keyring_id)) - else: - projectB.query("INSERT INTO fingerprint (fingerprint, keyring) VALUES ('%s', %d)" % (f, keyring_id)) - else: - if newuid and olduid != newuid: - if olduid != -1: - changes.append((newuiduid, "Linked key: %s (formerly belonging to %s)" % (f, db_uid_byid[olduid][0]))) - else: - changes.append((newuiduid, "Linked key: %s (formerly unowned)\n" % (f))) - projectB.query("UPDATE fingerprint SET uid = %d WHERE id = %d" % (newuid, oldfid)) - - if oldkid != keyring_id: - projectB.query("UPDATE fingerprint SET keyring = %d WHERE id = %d" % (keyring_id, oldfid)) + fp.uid_id = newuid + + session.add(fp) + session.flush() + + else: + if newuid and olduid != newuid and olduid == -1: + changes.append((newuiduid, "Linked key: %s" % f)) + changes.append((newuiduid, " (formerly unowned)")) + session.execute("UPDATE fingerprint SET uid = :uid WHERE id = :fpr", + {'uid': newuid, 'fpr': oldfid}) + + # Don't move a key from a keyring with a higher priority to a lower one + if oldkid != keyring.keyring_id: + movekey = False + if oldkid == -1: + movekey = True + else: + try: + oldkeyring = session.query(Keyring).filter_by(keyring_id=oldkid).one() + except NotFoundError: + print "ERROR: Cannot find old keyring with id %s" % oldkid + sys.exit(1) + + if oldkeyring.priority < keyring.priority: + movekey = True + + # Only change the keyring if it won't result in a loss of permissions + if movekey: + session.execute("""UPDATE fingerprint + SET keyring = :keyring + WHERE id = :fpr""", + {'keyring': keyring.keyring_id, + 'fpr': oldfid}) + + session.flush() + + else: + print "Key %s exists in both %s and %s keyrings. Not demoting." % (f, + oldkeyring.keyring_name, + keyring.keyring_name) # All done! + if Options["No-Action"]: + session.rollback() + else: + session.commit() - projectB.query("COMMIT WORK") - + # Print a summary changesd = {} for (k, v) in changes: - if k not in changesd: changesd[k] = "" - changesd[k] += " " + v + if k not in changesd: + changesd[k] = "" + changesd[k] += " %s\n" % (v) keys = changesd.keys() keys.sort() for k in keys: - print "%s\n%s" % (k, changesd[k]) + print "%s\n%s\n" % (k, changesd[k]) ################################################################################