sfa/importer/sfa-import-plc.py

   1 #!/usr/bin/python
   2 #
   3 ##
   4 # Import PLC records into the SFA database. It is indended that this tool be
   5 # run once to create SFA records that reflect the current state of the
   6 # planetlab database.
   7 #
   8 # The import tool assumes that the existing PLC hierarchy should all be part
   9 # of "planetlab.us" (see the root_auth and level1_auth variables below).
  10 #
  11 # Public keys are extracted from the users' SSH keys automatically and used to
  12 # create GIDs. This is relatively experimental as a custom tool had to be
  13 # written to perform conversion from SSH to OpenSSL format. It only supports
  14 # RSA keys at this time, not DSA keys.
  15 ##
  16
  17 import os
  18 import getopt
  19 import sys
  20
  21 from sfa.util.config import Config
  22 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn
  23 from sfa.util.plxrn import hostname_to_hrn, slicename_to_hrn, email_to_hrn, hrn_to_pl_slicename
  24
  25 from sfa.trust.gid import create_uuid
  26 from sfa.trust.certificate import convert_public_key, Keypair
  27
  28 from sfa.plc.plshell import PlShell
  29
  30 from sfa.storage.alchemy import dbsession
  31 from sfa.storage.model import RegRecord, RegAuthority, RegUser, RegSlice, RegNode
  32
  33 from sfa.importer.sfaImport import sfaImport, _cleanup_string
  34
  35 def process_options():
  36
  37    (options, args) = getopt.getopt(sys.argv[1:], '', [])
  38    for opt in options:
  39        name = opt[0]
  40        val = opt[1]
  41
  42
  43 def load_keys(filename):
  44     keys = {}
  45     tmp_dict = {}
  46     try:
  47         execfile(filename, tmp_dict)
  48         if 'keys' in tmp_dict:
  49             keys = tmp_dict['keys']
  50         return keys
  51     except:
  52         return keys
  53
  54 def save_keys(filename, keys):
  55     f = open(filename, 'w')
  56     f.write("keys = %s" % str(keys))
  57     f.close()
  58
  59 def _get_site_hrn(interface_hrn, site):
  60     # Hardcode 'internet2' into the hrn for sites hosting
  61     # internet2 nodes. This is a special operation for some vini
  62     # sites only
  63     hrn = ".".join([interface_hrn, site['login_base']])
  64     if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
  65         if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
  66             hrn = ".".join([interface_hrn, "internet2", site['login_base']])
  67     return hrn
  68
  69 # one would think this code could use a call to DBSchema
  70 # however now import s expected to be done after service creation
  71 def main():
  72
  73     process_options()
  74     config = Config()
  75     sfaImporter = sfaImport()
  76     logger=sfaImporter.logger
  77     logger.setLevelFromOptVerbose(config.SFA_API_LOGLEVEL)
  78     if not config.SFA_REGISTRY_ENABLED:
  79         sys.exit(0)
  80     root_auth = config.SFA_REGISTRY_ROOT_AUTH
  81     interface_hrn = config.SFA_INTERFACE_HRN
  82     shell = PlShell (config)
  83     sfaImporter.create_top_level_records()
  84
  85     # create dict of all existing sfa records
  86     existing_records = {}
  87     existing_hrns = []
  88     key_ids = []
  89     for record in dbsession.query(RegRecord):
  90         existing_records[ (record.hrn, record.type,) ] = record
  91         existing_hrns.append(record.hrn)
  92
  93     # Get all plc sites
  94     sites = shell.GetSites({'peer_id': None})
  95     sites_dict = {}
  96     for site in sites:
  97         sites_dict[site['login_base']] = site
  98
  99     # Get all plc users
 100     persons = shell.GetPersons({'peer_id': None, 'enabled': True},
 101                                ['person_id', 'email', 'key_ids', 'site_ids'])
 102     persons_dict = {}
 103     for person in persons:
 104         persons_dict[person['person_id']] = person
 105         key_ids.extend(person['key_ids'])
 106
 107     # Get all public keys
 108     keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids})
 109     keys_dict = {}
 110     for key in keys:
 111         keys_dict[key['key_id']] = key['key']
 112
 113     # create a dict of person keys keyed on key_id
 114     keys_filename = config.config_path + os.sep + 'person_keys.py'
 115     old_person_keys = load_keys(keys_filename)
 116     person_keys = {}
 117     for person in persons:
 118         pubkeys = []
 119         for key_id in person['key_ids']:
 120             pubkeys.append(keys_dict[key_id])
 121         person_keys[person['person_id']] = pubkeys
 122
 123     # Get all plc nodes
 124     nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
 125     nodes_dict = {}
 126     for node in nodes:
 127         nodes_dict[node['node_id']] = node
 128
 129     # Get all plc slices
 130     slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name'])
 131     slices_dict = {}
 132     for slice in slices:
 133         slices_dict[slice['slice_id']] = slice
 134
 135     # special case for vini
 136     if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
 137         # create a fake internet2 site first
 138         i2site = {'name': 'Internet2', 'abbreviated_name': 'I2',
 139                     'login_base': 'internet2', 'site_id': -1}
 140         site_hrn = _get_site_hrn(interface_hrn, i2site)
 141         # import if hrn is not in list of existing hrns or if the hrn exists
 142         # but its not a site record
 143         if site_hrn not in existing_hrns or \
 144            (site_hrn, 'authority') not in existing_records:
 145             urn = hrn_to_urn(site_hrn, 'authority')
 146             if not sfaImporter.AuthHierarchy.auth_exists(urn):
 147                 sfaImporter.AuthHierarchy.create_auth(urn)
 148             auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
 149             auth_record = RegAuthority()
 150             auth_record.type='authority'
 151             auth_record.hrn=site_hrn
 152             auth_record.gid=auth_info.get_gid_object()
 153             auth_record.pointer=site['site_id']
 154             auth_record.authority=get_authority(site_hrn)
 155             dbsession.add(auth_record)
 156             dbsession.commit()
 157             logger.info("Import: Imported authority (vini site) %s"%auth_record)
 158
 159     # start importing
 160     for site in sites:
 161         site_hrn = _get_site_hrn(interface_hrn, site)
 162
 163         # import if hrn is not in list of existing hrns or if the hrn exists
 164         # but its not a site record
 165         if site_hrn not in existing_hrns or \
 166            (site_hrn, 'authority') not in existing_records:
 167             try:
 168                 urn = hrn_to_urn(site_hrn, 'authority')
 169                 if not sfaImporter.AuthHierarchy.auth_exists(urn):
 170                     sfaImporter.AuthHierarchy.create_auth(urn)
 171                 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
 172                 auth_record = RegAuthority()
 173                 auth_record.type='authority'
 174                 auth_record.hrn=site_hrn
 175                 auth_record.gid=auth_info.get_gid_object()
 176                 auth_record.pointer=site['site_id']
 177                 auth_record.authority=get_authority(site_hrn)
 178                 dbsession.add(auth_record)
 179                 dbsession.commit()
 180                 logger.info("Import: imported authority (site) : %s" % auth_record)
 181             except:
 182                 # if the site import fails then there is no point in trying to import the
 183                 # site's child records (node, slices, persons), so skip them.
 184                 logger.log_exc("Import: failed to import site. Skipping child records")
 185                 continue
 186
 187         # import node records
 188         for node_id in site['node_ids']:
 189             if node_id not in nodes_dict:
 190                 continue
 191             node = nodes_dict[node_id]
 192             site_auth = get_authority(site_hrn)
 193             site_name = get_leaf(site_hrn)
 194             hrn =  hostname_to_hrn(site_auth, site_name, node['hostname'])
 195             if len(hrn) > 64:
 196                 hrn = hrn[:64]
 197             if hrn not in existing_hrns or \
 198                (hrn, 'node') not in existing_records:
 199                 try:
 200                     pkey = Keypair(create=True)
 201                     urn = hrn_to_urn(hrn, 'node')
 202                     node_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 203                     node_record = RegNode ()
 204                     node_record.type='node'
 205                     node_record.hrn=hrn
 206                     node_record.gid=node_gid
 207                     node_record.pointer =node['node_id']
 208                     node_record.authority=get_authority(hrn)
 209                     dbsession.add(node_record)
 210                     dbsession.commit()
 211                     logger.info("Import: imported node: %s" % node_record)
 212                 except:
 213                     logger.log_exc("Import: failed to import node")
 214
 215
 216         # import slices
 217         for slice_id in site['slice_ids']:
 218             if slice_id not in slices_dict:
 219                 continue
 220             slice = slices_dict[slice_id]
 221             hrn = slicename_to_hrn(interface_hrn, slice['name'])
 222             #slicename = slice['name'].split("_",1)[-1]
 223             #slicename = _cleanup_string(slicename)
 224             if hrn not in existing_hrns or \
 225                (hrn, 'slice') not in existing_records:
 226                 try:
 227                     pkey = Keypair(create=True)
 228                     urn = hrn_to_urn(hrn, 'slice')
 229                     slice_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 230                     slice_record = RegSlice ()
 231                     slice_record.type='slice'
 232                     slice_record.hrn=hrn
 233                     slice_record.gid=slice_gid
 234                     slice_record.pointer=slice['slice_id']
 235                     slice_record.authority=get_authority(hrn)
 236                     dbsession.add(slice_record)
 237                     dbsession.commit()
 238                     logger.info("Import: imported slice: %s" % slice_record)
 239                 except:
 240                     logger.log_exc("Import: failed to  import slice")
 241
 242         # import persons
 243         for person_id in site['person_ids']:
 244             if person_id not in persons_dict:
 245                 continue
 246             person = persons_dict[person_id]
 247             hrn = email_to_hrn(site_hrn, person['email'])
 248             if len(hrn) > 64:
 249                 hrn = hrn[:64]
 250
 251             # if user's primary key has changed then we need to update the
 252             # users gid by forcing an update here
 253             old_keys = []
 254             new_keys = []
 255             if person_id in old_person_keys:
 256                 old_keys = old_person_keys[person_id]
 257             if person_id in person_keys:
 258                 new_keys = person_keys[person_id]
 259             update_record = False
 260             for key in new_keys:
 261                 if key not in old_keys:
 262                     update_record = True
 263
 264             if hrn not in existing_hrns or \
 265                (hrn, 'user') not in existing_records or update_record:
 266                 try:
 267                     if 'key_ids' in person and person['key_ids']:
 268                         key = new_keys[0]
 269                         try:
 270                             pkey = convert_public_key(key)
 271                         except:
 272                             logger.warn('unable to convert public key for %s' % hrn)
 273                             pkey = Keypair(create=True)
 274                     else:
 275                         # the user has no keys. Creating a random keypair for the user's gid
 276                         logger.warn("Import: person %s does not have a PL public key"%hrn)
 277                         pkey = Keypair(create=True)
 278                     urn = hrn_to_urn(hrn, 'user')
 279                     person_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 280                     person_record = RegUser ()
 281                     person_record.type='user'
 282                     person_record.hrn=hrn
 283                     person_record.gid=person_gid
 284                     person_record.pointer=person['person_id']
 285                     person_record.authority=get_authority(hrn)
 286                     dbsession.add (person_record)
 287                     dbsession.commit()
 288                     logger.info("Import: imported person: %s" % person_record)
 289                 except:
 290                     logger.log_exc("Import: failed to import person.")
 291
 292     # remove stale records
 293     system_records = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
 294     for (record_hrn, type) in existing_records.keys():
 295         if record_hrn in system_records:
 296             continue
 297
 298         record = existing_records[(record_hrn, type)]
 299         if record.peer_authority:
 300             continue
 301
 302         # dont delete vini's internet2 placeholdder record
 303         # normally this would be deleted becuase it does not have a plc record
 304         if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
 305            record_hrn.endswith("internet2"):
 306             continue
 307
 308         found = False
 309
 310         if type == 'authority':
 311             for site in sites:
 312                 site_hrn = interface_hrn + "." + site['login_base']
 313                 if site_hrn == record_hrn and site['site_id'] == record.pointer:
 314                     found = True
 315                     break
 316
 317         elif type == 'user':
 318             login_base = get_leaf(get_authority(record_hrn))
 319             username = get_leaf(record_hrn)
 320             if login_base in sites_dict:
 321                 site = sites_dict[login_base]
 322                 for person in persons:
 323                     tmp_username = person['email'].split("@")[0]
 324                     alt_username = person['email'].split("@")[0].replace(".", "_").replace("+", "_")
 325                     if username in [tmp_username, alt_username] and \
 326                        site['site_id'] in person['site_ids'] and \
 327                        person['person_id'] == record.pointer:
 328                         found = True
 329                         break
 330
 331         elif type == 'slice':
 332             slicename = hrn_to_pl_slicename(record_hrn)
 333             for slice in slices:
 334                 if slicename == slice['name'] and \
 335                    slice['slice_id'] == record.pointer:
 336                     found = True
 337                     break
 338
 339         elif type == 'node':
 340             login_base = get_leaf(get_authority(record_hrn))
 341             nodename = Xrn.unescape(get_leaf(record_hrn))
 342             if login_base in sites_dict:
 343                 site = sites_dict[login_base]
 344                 for node in nodes:
 345                     tmp_nodename = node['hostname']
 346                     if tmp_nodename == nodename and \
 347                        node['site_id'] == site['site_id'] and \
 348                        node['node_id'] == record.pointer:
 349                         found = True
 350                         break
 351         else:
 352             continue
 353
 354         if not found:
 355             try:
 356                 record_object = existing_records[(record_hrn, type)]
 357                 logger.info("Import: deleting record: %s" % record)
 358                 dbsession.delete(record_object)
 359                 dbsession.commit()
 360             except:
 361                 logger.log_exc("Import: failded to delete record")
 362     # save pub keys
 363     logger.info('Import: saving current pub keys')
 364     save_keys(keys_filename, person_keys)
 365
 366 if __name__ == "__main__":
 367     main()