sfa/importer/plimporter.py

   1 #
   2 # PlanetLab importer
   3 #
   4 # requirements
   5 #
   6 # read the planetlab database and update the local registry database accordingly
   7 # (in other words, with this testbed, the SFA registry is *not* authoritative)
   8 # so we update the following collections
   9 # . authorities                 (from pl sites)
  10 # . node                        (from pl nodes)
  11 # . users+keys                  (from pl persons and attached keys)
  12 #                       known limitation : *one* of the ssh keys is chosen at random here
  13 #                       xxx todo/check xxx at the very least, when a key is known to the registry
  14 #                       and is still current in plc
  15 #                       then we should definitely make sure to keep that one in sfa...
  16 # . slice+researchers           (from pl slices and attached users)
  17 #
  18
  19 import os
  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.storage.alchemy import dbsession
  29 from sfa.storage.model import RegRecord, RegAuthority, RegSlice, RegNode, RegUser, RegKey
  30
  31 from sfa.plc.plshell import PlShell
  32
  33 def _get_site_hrn(interface_hrn, site):
  34     # Hardcode 'internet2' into the hrn for sites hosting
  35     # internet2 nodes. This is a special operation for some vini
  36     # sites only
  37     hrn = ".".join([interface_hrn, site['login_base']])
  38     if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
  39         if site['login_base'].startswith("i2") or site['login_base'].startswith("nlr"):
  40             hrn = ".".join([interface_hrn, "internet2", site['login_base']])
  41     return hrn
  42
  43
  44 class PlImporter:
  45
  46     def __init__ (self, auth_hierarchy, logger):
  47         self.auth_hierarchy = auth_hierarchy
  48         self.logger=logger
  49
  50     def add_options (self, parser):
  51         # we don't have any options for now
  52         pass
  53
  54     # hrn hash is initialized from current db
  55     # remember just-created records as we go
  56     # xxx might make sense to add a UNIQUE constraint in the db itself
  57     def remember_record_by_hrn (self, record):
  58         tuple = (record.type, record.hrn)
  59         if tuple in self.records_by_type_hrn:
  60             self.logger.warning ("PlImporter.remember_record_by_hrn: duplicate (%s,%s)"%tuple)
  61             return
  62         self.records_by_type_hrn [ tuple ] = record
  63
  64     # ditto for pointer hash
  65     def remember_record_by_pointer (self, record):
  66         if record.pointer == -1:
  67             self.logger.warning ("PlImporter.remember_record_by_pointer: pointer is void")
  68             return
  69         tuple = (record.type, record.pointer)
  70         if tuple in self.records_by_type_pointer:
  71             self.logger.warning ("PlImporter.remember_record_by_pointer: duplicate (%s,%s)"%tuple)
  72             return
  73         self.records_by_type_pointer [ ( record.type, record.pointer,) ] = record
  74
  75     def remember_record (self, record):
  76         self.remember_record_by_hrn (record)
  77         self.remember_record_by_pointer (record)
  78
  79     def locate_by_type_hrn (self, type, hrn):
  80         return self.records_by_type_hrn.get ( (type, hrn), None)
  81
  82     def locate_by_type_pointer (self, type, pointer):
  83         return self.records_by_type_pointer.get ( (type, pointer), None)
  84
  85     # convenience : try to locate first based on type+pointer
  86     # if so, the record was created already even if e.g. its hrn has changed meanwhile
  87     # otherwise we try by type+hrn (is this truly useful ?)
  88     def locate (self, type, hrn=None, pointer=-1):
  89         if pointer!=-1:
  90             attempt = self.locate_by_type_pointer (type, pointer)
  91             if attempt : return attempt
  92         if hrn is not None:
  93             attempt = self.locate_by_type_hrn (type, hrn,)
  94             if attempt : return attempt
  95         return None
  96
  97     # this makes the run method a bit abtruse - out of the way
  98     def create_special_vini_record (self, interface_hrn):
  99         # special case for vini
 100         if ".vini" in interface_hrn and interface_hrn.endswith('vini'):
 101             # create a fake internet2 site first
 102             i2site = {'name': 'Internet2', 'login_base': 'internet2', 'site_id': -1}
 103             site_hrn = _get_site_hrn(interface_hrn, i2site)
 104             # import if hrn is not in list of existing hrns or if the hrn exists
 105             # but its not a site record
 106             if ( 'authority', site_hrn, ) not in self.records_by_type_hrn:
 107                 urn = hrn_to_urn(site_hrn, 'authority')
 108                 if not self.auth_hierarchy.auth_exists(urn):
 109                     self.auth_hierarchy.create_auth(urn)
 110                 auth_info = self.auth_hierarchy.get_auth_info(urn)
 111                 auth_record = RegAuthority(hrn=site_hrn, gid=auth_info.get_gid_object(),
 112                                            pointer=site['site_id'],
 113                                            authority=get_authority(site_hrn))
 114                 auth_record.just_created()
 115                 dbsession.add(auth_record)
 116                 dbsession.commit()
 117                 self.logger.info("PlImporter: Imported authority (vini site) %s"%auth_record)
 118                 self.remember_record ( site_record )
 119
 120     def run (self, options):
 121         config = Config ()
 122         interface_hrn = config.SFA_INTERFACE_HRN
 123         root_auth = config.SFA_REGISTRY_ROOT_AUTH
 124         shell = PlShell (config)
 125
 126         ######## retrieve all existing SFA objects
 127         all_records = dbsession.query(RegRecord).all()
 128
 129         # create hash by (type,hrn)
 130         # we essentially use this to know if a given record is already known to SFA
 131         self.records_by_type_hrn = \
 132             dict ( [ ( (record.type, record.hrn) , record ) for record in all_records ] )
 133         # create hash by (type,pointer)
 134         self.records_by_type_pointer = \
 135             dict ( [ ( (record.type, record.pointer) , record ) for record in all_records
 136                      if record.pointer != -1] )
 137
 138         # initialize record.stale to True by default, then mark stale=False on the ones that are in use
 139         for record in all_records: record.stale=True
 140
 141         ######## retrieve PLC data
 142         # Get all plc sites
 143         # retrieve only required stuf
 144         sites = shell.GetSites({'peer_id': None, 'enabled' : True},
 145                                ['site_id','login_base','node_ids','slice_ids','person_ids',])
 146         # create a hash of sites by login_base
 147 #        sites_by_login_base = dict ( [ ( site['login_base'], site ) for site in sites ] )
 148         # Get all plc users
 149         persons = shell.GetPersons({'peer_id': None, 'enabled': True},
 150                                    ['person_id', 'email', 'key_ids', 'site_ids'])
 151         # create a hash of persons by person_id
 152         persons_by_id = dict ( [ ( person['person_id'], person) for person in persons ] )
 153         # Get all plc public keys
 154         # accumulate key ids for keys retrieval
 155         key_ids = []
 156         for person in persons:
 157             key_ids.extend(person['key_ids'])
 158         keys = shell.GetKeys( {'peer_id': None, 'key_id': key_ids} )
 159         # create a hash of keys by key_id
 160         keys_by_id = dict ( [ ( key['key_id'], key ) for key in keys ] )
 161         # create a dict person_id -> [ (plc)keys ]
 162         keys_by_person_id = {}
 163         for person in persons:
 164             pubkeys = []
 165             for key_id in person['key_ids']:
 166                 pubkeys.append(keys_by_id[key_id])
 167             keys_by_person_id[person['person_id']] = pubkeys
 168         # Get all plc nodes
 169         nodes = shell.GetNodes( {'peer_id': None}, ['node_id', 'hostname', 'site_id'])
 170         # create hash by node_id
 171         nodes_by_id = dict ( [ ( node['node_id'], node, ) for node in nodes ] )
 172         # Get all plc slices
 173         slices = shell.GetSlices( {'peer_id': None}, ['slice_id', 'name', 'person_ids'])
 174         # create hash by slice_id
 175         slices_by_id = dict ( [ (slice['slice_id'], slice ) for slice in slices ] )
 176
 177         # isolate special vini case in separate method
 178         self.create_special_vini_record (interface_hrn)
 179
 180         # start importing
 181         for site in sites:
 182             site_hrn = _get_site_hrn(interface_hrn, site)
 183             # import if hrn is not in list of existing hrns or if the hrn exists
 184             # but its not a site record
 185             site_record=self.locate ('authority', site_hrn, site['site_id'])
 186             if not site_record:
 187                 try:
 188                     urn = hrn_to_urn(site_hrn, 'authority')
 189                     if not self.auth_hierarchy.auth_exists(urn):
 190                         self.auth_hierarchy.create_auth(urn)
 191                     auth_info = self.auth_hierarchy.get_auth_info(urn)
 192                     site_record = RegAuthority(hrn=site_hrn, gid=auth_info.get_gid_object(),
 193                                                pointer=site['site_id'],
 194                                                authority=get_authority(site_hrn))
 195                     site_record.just_created()
 196                     dbsession.add(site_record)
 197                     dbsession.commit()
 198                     self.logger.info("PlImporter: imported authority (site) : %s" % site_record)
 199                     self.remember_record (site_record)
 200                 except:
 201                     # if the site import fails then there is no point in trying to import the
 202                     # site's child records (node, slices, persons), so skip them.
 203                     self.logger.log_exc("PlImporter: failed to import site. Skipping child records")
 204                     continue
 205             else:
 206                 # xxx update the record ...
 207                 pass
 208             site_record.stale=False
 209
 210             # import node records
 211             for node_id in site['node_ids']:
 212                 try:
 213                     node = nodes_by_id[node_id]
 214                 except:
 215                     self.logger.warning ("PlImporter: cannot find node_id %s - ignored"%node_id)
 216                     continue
 217                 site_auth = get_authority(site_hrn)
 218                 site_name = site['login_base']
 219                 hrn =  hostname_to_hrn(site_auth, site_name, node['hostname'])
 220                 # xxx this sounds suspicious
 221                 if len(hrn) > 64: hrn = hrn[:64]
 222                 node_record = self.locate ( 'node', hrn , node['node_id'] )
 223                 if not node_record:
 224                     try:
 225                         pkey = Keypair(create=True)
 226                         urn = hrn_to_urn(hrn, 'node')
 227                         node_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
 228                         node_record = RegNode (hrn=hrn, gid=node_gid,
 229                                                pointer =node['node_id'],
 230                                                authority=get_authority(hrn))
 231                         node_record.just_created()
 232                         dbsession.add(node_record)
 233                         dbsession.commit()
 234                         self.logger.info("PlImporter: imported node: %s" % node_record)
 235                         self.remember_record (node_record)
 236                     except:
 237                         self.logger.log_exc("PlImporter: failed to import node")
 238                 else:
 239                     # xxx update the record ...
 240                     pass
 241                 node_record.stale=False
 242
 243             # import persons
 244             for person_id in site['person_ids']:
 245                 try:
 246                     person = persons_by_id[person_id]
 247                 except:
 248                     self.logger.warning ("PlImporter: cannot locate person_id %s - ignored"%person_id)
 249                 person_hrn = email_to_hrn(site_hrn, person['email'])
 250                 # xxx suspicious again
 251                 if len(person_hrn) > 64: person_hrn = person_hrn[:64]
 252                 person_urn = hrn_to_urn(person_hrn, 'user')
 253
 254                 user_person = self.locate ( 'user', person_hrn, person['person_id'])
 255
 256                 # return a tuple pubkey (a plc key object) and pkey (a Keypair object)
 257                 def init_person_key (person, plc_keys):
 258                     pubkey=None
 259                     if  person['key_ids']:
 260                         # randomly pick first key in set
 261                         pubkey = plc_keys[0]
 262                         try:
 263                             pkey = convert_public_key(pubkey['key'])
 264                         except:
 265                             self.logger.warn('PlImporter: unable to convert public key for %s' % person_hrn)
 266                             pkey = Keypair(create=True)
 267                     else:
 268                         # the user has no keys. Creating a random keypair for the user's gid
 269                         self.logger.warn("PlImporter: person %s does not have a PL public key"%person_hrn)
 270                         pkey = Keypair(create=True)
 271                     return (pubkey, pkey)
 272
 273                 # new person
 274                 try:
 275                     plc_keys = keys_by_person_id.get(person['person_id'],[])
 276                     if not user_person:
 277                         (pubkey,pkey) = init_person_key (person, plc_keys )
 278                         person_gid = self.auth_hierarchy.create_gid(person_urn, create_uuid(), pkey)
 279                         user_person = RegUser (hrn=person_hrn, gid=person_gid,
 280                                                  pointer=person['person_id'],
 281                                                  authority=get_authority(person_hrn),
 282                                                  email=person['email'])
 283                         if pubkey:
 284                             user_person.reg_keys=[RegKey (pubkey['key'], pubkey['key_id'])]
 285                         else:
 286                             self.logger.warning("No key found for user %s"%user_person)
 287                         dbsession.add (user_person)
 288                         dbsession.commit()
 289                         self.logger.info("PlImporter: imported person: %s" % user_person)
 290                         self.remember_record ( user_person )
 291                     else:
 292                         # update the record ?
 293                         # if user's primary key has changed then we need to update the
 294                         # users gid by forcing an update here
 295                         sfa_keys = user_person.reg_keys
 296                         def key_in_list (key,sfa_keys):
 297                             for reg_key in sfa_keys:
 298                                 if reg_key.key==key['key']: return True
 299                             return False
 300                         # is there a new key in myplc ?
 301                         new_keys=False
 302                         for key in plc_keys:
 303                             if not key_in_list (key,sfa_keys):
 304                                 new_keys = True
 305                         if new_keys:
 306                             (pubkey,pkey) = init_person_key (person, plc_keys)
 307                             person_gid = self.auth_hierarchy.create_gid(person_urn, create_uuid(), pkey)
 308                             if not pubkey:
 309                                 user_person.reg_keys=[]
 310                             else:
 311                                 user_person.reg_keys=[ RegKey (pubkey['key'], pubkey['key_id'])]
 312                             self.logger.info("PlImporter: updated person: %s" % user_person)
 313                     user_person.email = person['email']
 314                     dbsession.commit()
 315                     user_person.stale=False
 316                 except:
 317                     self.logger.log_exc("PlImporter: failed to import person %d %s"%(person['person_id'],person['email']))
 318
 319             # import slices
 320             for slice_id in site['slice_ids']:
 321                 try:
 322                     slice = slices_by_id[slice_id]
 323                 except:
 324                     self.logger.warning ("PlImporter: cannot locate slice_id %s - ignored"%slice_id)
 325                 slice_hrn = slicename_to_hrn(interface_hrn, slice['name'])
 326                 slice_record = self.locate ('slice', slice_hrn, slice['slice_id'])
 327                 if not slice_record:
 328                     try:
 329                         pkey = Keypair(create=True)
 330                         urn = hrn_to_urn(slice_hrn, 'slice')
 331                         slice_gid = self.auth_hierarchy.create_gid(urn, create_uuid(), pkey)
 332                         slice_record = RegSlice (hrn=slice_hrn, gid=slice_gid,
 333                                                  pointer=slice['slice_id'],
 334                                                  authority=get_authority(slice_hrn))
 335                         slice_record.just_created()
 336                         dbsession.add(slice_record)
 337                         dbsession.commit()
 338                         self.logger.info("PlImporter: imported slice: %s" % slice_record)
 339                         self.remember_record ( slice_record )
 340                     except:
 341                         self.logger.log_exc("PlImporter: failed to import slice")
 342                 else:
 343                     # xxx update the record ...
 344                     self.logger.warning ("Slice update not yet implemented")
 345                     pass
 346                 # record current users affiliated with the slice
 347                 slice_record.reg_researchers = \
 348                     [ self.locate_by_type_pointer ('user',user_id) for user_id in slice['person_ids'] ]
 349                 dbsession.commit()
 350                 slice_record.stale=False
 351
 352         ### remove stale records
 353         # special records must be preserved
 354         system_hrns = [interface_hrn, root_auth, interface_hrn + '.slicemanager']
 355         for record in all_records:
 356             if record.hrn in system_hrns:
 357                 record.stale=False
 358             if record.peer_authority:
 359                 record.stale=False
 360             if ".vini" in interface_hrn and interface_hrn.endswith('vini') and \
 361                 record.hrn.endswith("internet2"):
 362                 record.stale=False
 363
 364         for record in all_records:
 365             try:        stale=record.stale
 366             except:
 367                 stale=True
 368                 self.logger.warning("stale not found with %s"%record)
 369             if stale:
 370                 self.logger.info("PlImporter: deleting stale record: %s" % record)
 371                 dbsession.delete(record)
 372                 dbsession.commit()