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.persistentobjs 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 # maybe could use a call to persistentobjs.init_tables somewhere
  70 # however now import s expected to be done after service creation..
  71 def main():
  72
  73     process_options()
  74     config = Config()
  75     if not config.SFA_REGISTRY_ENABLED:
  76         sys.exit(0)
  77     root_auth = config.SFA_REGISTRY_ROOT_AUTH
  78     interface_hrn = config.SFA_INTERFACE_HRN
  79     keys_filename = config.config_path + os.sep + 'person_keys.py'
  80     sfaImporter = sfaImport()
  81     sfaImporter.create_top_level_records()
  82     logger=sfaImporter.logger
  83     logger.setLevelFromOptVerbose(config.SFA_API_LOGLEVEL)
  84     shell = PlShell (config)
  85
  86     # create dict of all existing sfa records
  87     existing_records = {}
  88     existing_hrns = []
  89     key_ids = []
  90     person_keys = {}
  91     for record in dbsession.query(RegRecord):
  92         existing_records[ (record.hrn, record.type,) ] = record
  93         existing_hrns.append(record.hrn)
  94
  95     # Get all plc sites
  96     sites = shell.GetSites({'peer_id': None})
  97     sites_dict = {}
  98     for site in sites:
  99         sites_dict[site['login_base']] = site
 100
 101     # Get all plc users
 102     persons = shell.GetPersons({'peer_id': None, 'enabled': True},
 103                                ['person_id', 'email', 'key_ids', 'site_ids'])
 104     persons_dict = {}
 105     for person in persons:
 106         persons_dict[person['person_id']] = person
 107         key_ids.extend(person['key_ids'])
 108
 109     # Get all public keys
 110     keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids})
 111     keys_dict = {}
 112     for key in keys:
 113         keys_dict[key['key_id']] = key['key']
 114
 115     # create a dict of person keys keyed on key_id
 116     old_person_keys = load_keys(keys_filename)
 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.hrn=site_hrn
 151             auth_record.gid=auth_info.get_gid_object()
 152             auth_record.pointer=site['site_id']
 153             auth_record.authority=get_authority(site_hrn)
 154             dbsession.add(auth_record)
 155             dbsession.commit()
 156             logger.info("Import: Imported authority (vini site) %s"%auth_record)
 157
 158     # start importing
 159     for site in sites:
 160         site_hrn = _get_site_hrn(interface_hrn, site)
 161
 162         # import if hrn is not in list of existing hrns or if the hrn exists
 163         # but its not a site record
 164         if site_hrn not in existing_hrns or \
 165            (site_hrn, 'authority') not in existing_records:
 166             try:
 167                 urn = hrn_to_urn(site_hrn, 'authority')
 168                 if not sfaImporter.AuthHierarchy.auth_exists(urn):
 169                     sfaImporter.AuthHierarchy.create_auth(urn)
 170                 auth_info = sfaImporter.AuthHierarchy.get_auth_info(urn)
 171                 auth_record = RegAuthority()
 172                 auth_record.hrn=site_hrn
 173                 auth_record.gid=auth_info.get_gid_object()
 174                 auth_record.pointer=site['site_id']
 175                 auth_record.authority=get_authority(site_hrn)
 176                 dbsession.add(auth_record)
 177                 dbsession.commit()
 178                 logger.info("Import: imported authority (site) : %s" % auth_record)
 179             except:
 180                 # if the site import fails then there is no point in trying to import the
 181                 # site's child records (node, slices, persons), so skip them.
 182                 logger.log_exc("Import: failed to import site. Skipping child records")
 183                 continue
 184
 185         # import node records
 186         for node_id in site['node_ids']:
 187             if node_id not in nodes_dict:
 188                 continue
 189             node = nodes_dict[node_id]
 190             site_auth = get_authority(site_hrn)
 191             site_name = get_leaf(site_hrn)
 192             hrn =  hostname_to_hrn(site_auth, site_name, node['hostname'])
 193             if len(hrn) > 64:
 194                 hrn = hrn[:64]
 195             if hrn not in existing_hrns or \
 196                (hrn, 'node') not in existing_records:
 197                 try:
 198                     pkey = Keypair(create=True)
 199                     urn = hrn_to_urn(hrn, 'node')
 200                     node_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 201                     node_record = RegNode ()
 202                     node_record.hrn=hrn
 203                     node_record.gid=node_gid
 204                     node_record.pointer =node['node_id']
 205                     node_record.authority=get_authority(hrn)
 206                     dbsession.add(node_record)
 207                     dbsession.commit()
 208                     logger.info("Import: imported node: %s" % node_record)
 209                 except:
 210                     logger.log_exc("Import: failed to import node")
 211
 212
 213         # import slices
 214         for slice_id in site['slice_ids']:
 215             if slice_id not in slices_dict:
 216                 continue
 217             slice = slices_dict[slice_id]
 218             hrn = slicename_to_hrn(interface_hrn, slice['name'])
 219             #slicename = slice['name'].split("_",1)[-1]
 220             #slicename = _cleanup_string(slicename)
 221             if hrn not in existing_hrns or \
 222                (hrn, 'slice') not in existing_records:
 223                 try:
 224                     pkey = Keypair(create=True)
 225                     urn = hrn_to_urn(hrn, 'slice')
 226                     slice_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 227                     slice_record = RegSlice ()
 228                     slice_record.hrn=hrn
 229                     slice_record.gid=slice_gid
 230                     slice_record.pointer=slice['slice_id']
 231                     slice_record.authority=get_authority(hrn)
 232                     dbsession.add(slice_record)
 233                     dbsession.commit()
 234                     logger.info("Import: imported slice: %s" % slice_record)
 235                 except:
 236                     logger.log_exc("Import: failed to  import slice")
 237
 238         # import persons
 239         for person_id in site['person_ids']:
 240             if person_id not in persons_dict:
 241                 continue
 242             person = persons_dict[person_id]
 243             hrn = email_to_hrn(site_hrn, person['email'])
 244             if len(hrn) > 64:
 245                 hrn = hrn[:64]
 246
 247             # if user's primary key has changed then we need to update the
 248             # users gid by forcing an update here
 249             old_keys = []
 250             new_keys = []
 251             if person_id in old_person_keys:
 252                 old_keys = old_person_keys[person_id]
 253             if person_id in person_keys:
 254                 new_keys = person_keys[person_id]
 255             update_record = False
 256             for key in new_keys:
 257                 if key not in old_keys:
 258                     update_record = True
 259
 260             if hrn not in existing_hrns or \
 261                (hrn, 'user') not in existing_records or update_record:
 262                 try:
 263                     if 'key_ids' in person and person['key_ids']:
 264                         key = new_keys[0]
 265                         try:
 266                             pkey = convert_public_key(key)
 267                         except:
 268                             logger.warn('unable to convert public key for %s' % hrn)
 269                             pkey = Keypair(create=True)
 270                     else:
 271                         # the user has no keys. Creating a random keypair for the user's gid
 272                         logger.warn("Import: person %s does not have a PL public key"%hrn)
 273                         pkey = Keypair(create=True)
 274                     urn = hrn_to_urn(hrn, 'user')
 275                     person_gid = sfaImporter.AuthHierarchy.create_gid(urn, create_uuid(), pkey)
 276                     person_record = RegUser ()
 277                     person_record.hrn=hrn
 278                     person_record.gid=person_gid
 279                     person_record.pointer=person['person_id']
 280                     person_record.authority=get_authority(hrn)
 281                     dbsession.add (person_record)
 282                     dbsession.commit()
 283                     logger.info("Import: imported person: %s" % person_record)
 284                 except:
 285                     logger.log_exc("Import: failed to import person.")
 286
 287     # remove stale records
 288     system_records = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
 289     for (record_hrn, type) in existing_records.keys():
 290         if record_hrn in system_records:
 291             continue
 292
 293         record = existing_records[(record_hrn, type)]
 294         if record.peer_authority:
 295             continue
 296
 297         # dont delete vini's internet2 placeholdder record
 298         # normally this would be deleted becuase it does not have a plc record
 299         if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
 300            record_hrn.endswith("internet2"):
 301             continue
 302
 303         found = False
 304
 305         if type == 'authority':
 306             for site in sites:
 307                 site_hrn = interface_hrn + "." + site['login_base']
 308                 if site_hrn == record_hrn and site['site_id'] == record.pointer:
 309                     found = True
 310                     break
 311
 312         elif type == 'user':
 313             login_base = get_leaf(get_authority(record_hrn))
 314             username = get_leaf(record_hrn)
 315             if login_base in sites_dict:
 316                 site = sites_dict[login_base]
 317                 for person in persons:
 318                     tmp_username = person['email'].split("@")[0]
 319                     alt_username = person['email'].split("@")[0].replace(".", "_").replace("+", "_")
 320                     if username in [tmp_username, alt_username] and \
 321                        site['site_id'] in person['site_ids'] and \
 322                        person['person_id'] == record.pointer:
 323                         found = True
 324                         break
 325
 326         elif type == 'slice':
 327             slicename = hrn_to_pl_slicename(record_hrn)
 328             for slice in slices:
 329                 if slicename == slice['name'] and \
 330                    slice['slice_id'] == record.pointer:
 331                     found = True
 332                     break
 333
 334         elif type == 'node':
 335             login_base = get_leaf(get_authority(record_hrn))
 336             nodename = Xrn.unescape(get_leaf(record_hrn))
 337             if login_base in sites_dict:
 338                 site = sites_dict[login_base]
 339                 for node in nodes:
 340                     tmp_nodename = node['hostname']
 341                     if tmp_nodename == nodename and \
 342                        node['site_id'] == site['site_id'] and \
 343                        node['node_id'] == record.pointer:
 344                         found = True
 345                         break
 346         else:
 347             continue
 348
 349         if not found:
 350             try:
 351                 record_object = existing_records[(record_hrn, type)]
 352                 logger.info("Import: deleting record: %s" % record)
 353                 dbsession.delete(record_object)
 354                 dbsession.commit()
 355             except:
 356                 logger.log_exc("Import: failded to delete record")
 357     # save pub keys
 358     logger.info('Import: saving current pub keys')
 359     save_keys(keys_filename, person_keys)
 360
 361 if __name__ == "__main__":
 362     main()