sfa/managers/registry_manager.py

   1 import types
   2 # for get_key_from_incoming_ip
   3 import tempfile
   4 import os
   5 import commands
   6
   7 from sfa.util.faults import RecordNotFound, AccountNotEnabled, PermissionError, MissingAuthority, \
   8     UnknownSfaType, ExistingRecord, NonExistingRecord
   9 from sfa.util.sfatime import utcparse, datetime_to_epoch
  10 from sfa.util.prefixTree import prefixTree
  11 from sfa.util.xrn import Xrn, get_authority, hrn_to_urn, urn_to_hrn
  12 from sfa.util.plxrn import hrn_to_pl_login_base
  13 from sfa.util.version import version_core
  14 from sfa.util.sfalogging import logger
  15
  16 from sfa.trust.gid import GID
  17 from sfa.trust.credential import Credential
  18 from sfa.trust.certificate import Certificate, Keypair, convert_public_key
  19 from sfa.trust.gid import create_uuid
  20
  21 from sfa.storage.model import make_record, RegRecord, RegUser
  22 from sfa.storage.alchemy import dbsession
  23
  24 class RegistryManager:
  25
  26     def __init__ (self, config): pass
  27
  28     # The GENI GetVersion call
  29     def GetVersion(self, api, options):
  30         peers = dict ( [ (hrn,interface.get_url()) for (hrn,interface) in api.registries.iteritems()
  31                        if hrn != api.hrn])
  32         xrn=Xrn(api.hrn)
  33         return version_core({'interface':'registry',
  34                              'sfa': 2,
  35                              'geni_api': 2,
  36                              'hrn':xrn.get_hrn(),
  37                              'urn':xrn.get_urn(),
  38                              'peers':peers})
  39
  40     def GetCredential(self, api, xrn, type, is_self=False):
  41         # convert xrn to hrn
  42         if type:
  43             hrn = urn_to_hrn(xrn)[0]
  44         else:
  45             hrn, type = urn_to_hrn(xrn)
  46
  47         # Is this a root or sub authority
  48         auth_hrn = api.auth.get_authority(hrn)
  49         if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
  50             auth_hrn = hrn
  51         auth_info = api.auth.get_auth_info(auth_hrn)
  52         # get record info
  53         record=dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
  54         if not record:
  55             raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
  56
  57         # verify_cancreate_credential requires that the member lists
  58         # (researchers, pis, etc) be filled in
  59         logger.debug("get credential before augment dict, keys=%s"%record.__dict__.keys())
  60         self.driver.augment_records_with_testbed_info (record.__dict__)
  61         logger.debug("get credential after augment dict, keys=%s"%record.__dict__.keys())
  62         if not self.driver.is_enabled (record.__dict__):
  63               raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record.email))
  64
  65         # get the callers gid
  66         # if this is a self cred the record's gid is the caller's gid
  67         if is_self:
  68             caller_hrn = hrn
  69             caller_gid = record.get_gid_object()
  70         else:
  71             caller_gid = api.auth.client_cred.get_gid_caller()
  72             caller_hrn = caller_gid.get_hrn()
  73
  74         object_hrn = record.get_gid_object().get_hrn()
  75         rights = api.auth.determine_user_rights(caller_hrn, record.__dict__)
  76         # make sure caller has rights to this object
  77         if rights.is_empty():
  78             raise PermissionError("%s has no rights to %s (%s)" % \
  79                                   (caller_hrn, object_hrn, xrn))
  80         object_gid = GID(string=record.gid)
  81         new_cred = Credential(subject = object_gid.get_subject())
  82         new_cred.set_gid_caller(caller_gid)
  83         new_cred.set_gid_object(object_gid)
  84         new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
  85         #new_cred.set_pubkey(object_gid.get_pubkey())
  86         new_cred.set_privileges(rights)
  87         new_cred.get_privileges().delegate_all_privileges(True)
  88         if hasattr(record,'expires'):
  89             date = utcparse(record.expires)
  90             expires = datetime_to_epoch(date)
  91             new_cred.set_expiration(int(expires))
  92         auth_kind = "authority,ma,sa"
  93         # Parent not necessary, verify with certs
  94         #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
  95         new_cred.encode()
  96         new_cred.sign()
  97
  98         return new_cred.save_to_string(save_parents=True)
  99
 100
 101     def Resolve(self, api, xrns, type=None, full=True):
 102
 103         if not isinstance(xrns, types.ListType):
 104             xrns = [xrns]
 105             # try to infer type if not set and we get a single input
 106             if not type:
 107                 type = Xrn(xrns).get_type()
 108         hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
 109
 110         # load all known registry names into a prefix tree and attempt to find
 111         # the longest matching prefix
 112         # create a dict where key is a registry hrn and its value is a list
 113         # of hrns at that registry (determined by the known prefix tree).
 114         xrn_dict = {}
 115         registries = api.registries
 116         tree = prefixTree()
 117         registry_hrns = registries.keys()
 118         tree.load(registry_hrns)
 119         for xrn in xrns:
 120             registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
 121             if registry_hrn not in xrn_dict:
 122                 xrn_dict[registry_hrn] = []
 123             xrn_dict[registry_hrn].append(xrn)
 124
 125         records = []
 126         for registry_hrn in xrn_dict:
 127             # skip the hrn without a registry hrn
 128             # XX should we let the user know the authority is unknown?
 129             if not registry_hrn:
 130                 continue
 131
 132             # if the best match (longest matching hrn) is not the local registry,
 133             # forward the request
 134             xrns = xrn_dict[registry_hrn]
 135             if registry_hrn != api.hrn:
 136                 credential = api.getCredential()
 137                 interface = api.registries[registry_hrn]
 138                 server_proxy = api.server_proxy(interface, credential)
 139                 peer_records = server_proxy.Resolve(xrns, credential,type)
 140                 # pass foreign records as-is
 141                 # previous code used to read
 142                 # records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
 143                 # not sure why the records coming through xmlrpc had to be processed at all
 144                 records.extend(peer_records)
 145
 146         # try resolving the remaining unfound records at the local registry
 147         local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
 148         #
 149         local_records = dbsession.query(RegRecord).filter(RegRecord.hrn.in_(local_hrns))
 150         if type:
 151             local_records = local_records.filter_by(type=type)
 152         local_records=local_records.all()
 153         logger.info("Resolve: local_records=%s (type=%s)"%(local_records,type))
 154         local_dicts = [ record.__dict__ for record in local_records ]
 155
 156         if full:
 157             # in full mode we get as much info as we can, which involves contacting the
 158             # testbed for getting implementation details about the record
 159             self.driver.augment_records_with_testbed_info(local_dicts)
 160             # also we fill the 'url' field for known authorities
 161             # used to be in the driver code, sounds like a poorman thing though
 162             def solve_neighbour_url (record):
 163                 if not record.type.startswith('authority'): return
 164                 hrn=record.hrn
 165                 for neighbour_dict in [ api.aggregates, api.registries ]:
 166                     if hrn in neighbour_dict:
 167                         record.url=neighbour_dict[hrn].get_url()
 168                         return
 169             for record in local_records: solve_neighbour_url (record)
 170
 171         # convert local record objects to dicts for xmlrpc
 172         # xxx somehow here calling dict(record) issues a weird error
 173         # however record.todict() seems to work fine
 174         # records.extend( [ dict(record) for record in local_records ] )
 175         records.extend( [ record.todict() for record in local_records ] )
 176         if not records:
 177             raise RecordNotFound(str(hrns))
 178
 179         return records
 180
 181     def List (self, api, xrn, origin_hrn=None):
 182         hrn, type = urn_to_hrn(xrn)
 183         # load all know registry names into a prefix tree and attempt to find
 184         # the longest matching prefix
 185         registries = api.registries
 186         registry_hrns = registries.keys()
 187         tree = prefixTree()
 188         tree.load(registry_hrns)
 189         registry_hrn = tree.best_match(hrn)
 190
 191         #if there was no match then this record belongs to an unknow registry
 192         if not registry_hrn:
 193             raise MissingAuthority(xrn)
 194         # if the best match (longest matching hrn) is not the local registry,
 195         # forward the request
 196         record_dicts = []
 197         if registry_hrn != api.hrn:
 198             credential = api.getCredential()
 199             interface = api.registries[registry_hrn]
 200             server_proxy = api.server_proxy(interface, credential)
 201             record_list = server_proxy.List(xrn, credential)
 202             # same as above, no need to process what comes from through xmlrpc
 203             # pass foreign records as-is
 204             record_dicts = record_list
 205
 206         # if we still have not found the record yet, try the local registry
 207         if not record_dicts:
 208             if not api.auth.hierarchy.auth_exists(hrn):
 209                 raise MissingAuthority(hrn)
 210             records = dbsession.query(RegRecord).filter_by(authority=hrn)
 211             record_dicts=[ record.todict() for record in records ]
 212
 213         return record_dicts
 214
 215
 216     def CreateGid(self, api, xrn, cert):
 217         # get the authority
 218         authority = Xrn(xrn=xrn).get_authority_hrn()
 219         auth_info = api.auth.get_auth_info(authority)
 220         if not cert:
 221             pkey = Keypair(create=True)
 222         else:
 223             certificate = Certificate(string=cert)
 224             pkey = certificate.get_pubkey()
 225         gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey)
 226         return gid.save_to_string(save_parents=True)
 227
 228     ####################
 229     # utility for handling relationships among the SFA objects
 230     # given that the SFA db does not handle this sort of relationsships
 231     # it will rely on side-effects in the testbed to keep this persistent
 232
 233     # subject_record describes the subject of the relationships
 234     # ref_record contains the target values for the various relationships we need to manage
 235     # (to begin with, this is just the slice x person relationship)
 236     def update_relations (self, subject_obj, ref_obj):
 237         type=subject_obj.type
 238         if type=='slice':
 239             self.update_relation(subject_obj, 'researcher', ref_obj.researcher, 'user')
 240
 241     # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
 242     # hrns is the list of hrns that should be linked to the subject from now on
 243     # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
 244     def update_relation (self, record_obj, field_key, hrns, target_type):
 245         # locate the linked objects in our db
 246         subject_type=record_obj.type
 247         subject_id=record_obj.pointer
 248         # get the 'pointer' field of all matching records
 249         link_id_tuples = dbsession.query(RegRecord.pointer).filter_by(type=target_type).filter(RegRecord.hrn.in_(hrns)).all()
 250         # sqlalchemy returns named tuples for columns
 251         link_ids = [ tuple.pointer for tuple in link_id_tuples ]
 252         self.driver.update_relation (subject_type, target_type, subject_id, link_ids)
 253
 254     def Register(self, api, record_dict):
 255
 256         hrn, type = record_dict['hrn'], record_dict['type']
 257         urn = hrn_to_urn(hrn,type)
 258         # validate the type
 259         if type not in ['authority', 'slice', 'node', 'user']:
 260             raise UnknownSfaType(type)
 261
 262         # check if record_dict already exists
 263         existing_records = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).all()
 264         if existing_records:
 265             raise ExistingRecord(hrn)
 266
 267         assert ('type' in record_dict)
 268         # returns the right type of RegRecord according to type in record
 269         record = make_record(dict=record_dict)
 270         record.just_created()
 271         record.authority = get_authority(record.hrn)
 272         auth_info = api.auth.get_auth_info(record.authority)
 273         pub_key = None
 274         # make sure record has a gid
 275         if not record.gid:
 276             uuid = create_uuid()
 277             pkey = Keypair(create=True)
 278             if getattr(record,'keys',None):
 279                 pub_key=record.keys
 280                 # use only first key in record
 281                 if isinstance(record.keys, types.ListType):
 282                     pub_key = record.keys[0]
 283                 pkey = convert_public_key(pub_key)
 284
 285             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
 286             gid = gid_object.save_to_string(save_parents=True)
 287             record.gid = gid
 288
 289         if type in ["authority"]:
 290             # update the tree
 291             if not api.auth.hierarchy.auth_exists(hrn):
 292                 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
 293
 294             # get the GID from the newly created authority
 295             gid = auth_info.get_gid_object()
 296             record.gid=gid.save_to_string(save_parents=True)
 297
 298         # post-process / cleanup for relation ships
 299         if isinstance (record, RegUser):
 300             record.normalize_xml()
 301
 302         # update testbed-specific data if needed
 303         pointer = self.driver.register (record.__dict__, hrn, pub_key)
 304
 305         record.pointer=pointer
 306         dbsession.add(record)
 307         dbsession.commit()
 308
 309         # update membership for researchers, pis, owners, operators
 310         self.update_relations (record, record)
 311
 312         return record.get_gid_object().save_to_string(save_parents=True)
 313
 314     def Update(self, api, record_dict):
 315         assert ('type' in record_dict)
 316         new_record=RegRecord(dict=record_dict)
 317         type = new_record.type
 318         hrn = new_record.hrn
 319
 320         # make sure the record exists
 321         record = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
 322         if not record:
 323             raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
 324         record.just_updated()
 325
 326         # validate the type
 327         if type not in ['authority', 'slice', 'node', 'user']:
 328             raise UnknownSfaType(type)
 329
 330         # Use the pointer from the existing record, not the one that the user
 331         # gave us. This prevents the user from inserting a forged pointer
 332         pointer = record.pointer
 333
 334         # is the a change in keys ?
 335         new_key=None
 336         if type=='user':
 337             if getattr(new_key,'keys',None):
 338                 new_key=new_record.keys
 339                 if isinstance (new_key,types.ListType):
 340                     new_key=new_key[0]
 341
 342         # update the PLC information that was specified with the record
 343         if not self.driver.update (record.__dict__, new_record.__dict__, hrn, new_key):
 344             logger.warning("driver.update failed")
 345
 346         # take new_key into account
 347         if new_key:
 348             # update the openssl key and gid
 349             pkey = convert_public_key(new_key)
 350             uuid = create_uuid()
 351             urn = hrn_to_urn(hrn,type)
 352             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
 353             gid = gid_object.save_to_string(save_parents=True)
 354             record.gid = gid
 355             dsession.commit()
 356
 357         # update membership for researchers, pis, owners, operators
 358         self.update_relations (record, new_record)
 359
 360         return 1
 361
 362     # expecting an Xrn instance
 363     def Remove(self, api, xrn, origin_hrn=None):
 364         hrn=xrn.get_hrn()
 365         type=xrn.get_type()
 366         request=dbsession.query(RegRecord).filter_by(hrn=hrn)
 367         if type and type not in ['all', '*']:
 368             request=request.filter_by(type=type)
 369
 370         record = request.first()
 371         if not record:
 372             msg="Could not find hrn %s"%hrn
 373             if type: msg += " type=%s"%type
 374             raise RecordNotFound(msg)
 375
 376         type = record.type
 377         if type not in ['slice', 'user', 'node', 'authority'] :
 378             raise UnknownSfaType(type)
 379
 380         credential = api.getCredential()
 381         registries = api.registries
 382
 383         # Try to remove the object from the PLCDB of federated agg.
 384         # This is attempted before removing the object from the local agg's PLCDB and sfa table
 385         if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
 386             for registry in registries:
 387                 if registry not in [api.hrn]:
 388                     try:
 389                         result=registries[registry].remove_peer_object(credential, record, origin_hrn)
 390                     except:
 391                         pass
 392
 393         # call testbed callback first
 394         # IIUC this is done on the local testbed TOO because of the refreshpeer link
 395         if not self.driver.remove(record.__dict__):
 396             logger.warning("driver.remove failed")
 397
 398         # delete from sfa db
 399         dbsession.delete(record)
 400         dbsession.commit()
 401
 402         return 1
 403
 404     # This is a PLC-specific thing, won't work with other platforms
 405     def get_key_from_incoming_ip (self, api):
 406         # verify that the callers's ip address exist in the db and is an interface
 407         # for a node in the db
 408         (ip, port) = api.remote_addr
 409         interfaces = self.driver.shell.GetInterfaces({'ip': ip}, ['node_id'])
 410         if not interfaces:
 411             raise NonExistingRecord("no such ip %(ip)s" % locals())
 412         nodes = self.driver.shell.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
 413         if not nodes:
 414             raise NonExistingRecord("no such node using ip %(ip)s" % locals())
 415         node = nodes[0]
 416
 417         # look up the sfa record
 418         record=dbsession.query(RegRecord).filter_by(type='node',pointer=node['node_id']).first()
 419         if not record:
 420             raise RecordNotFound("node with pointer %s"%node['node_id'])
 421
 422         # generate a new keypair and gid
 423         uuid = create_uuid()
 424         pkey = Keypair(create=True)
 425         urn = hrn_to_urn(record.hrn, record.type)
 426         gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
 427         gid = gid_object.save_to_string(save_parents=True)
 428         record.gid = gid
 429
 430         # update the record
 431         dbsession.commit()
 432
 433         # attempt the scp the key
 434         # and gid onto the node
 435         # this will only work for planetlab based components
 436         (kfd, key_filename) = tempfile.mkstemp()
 437         (gfd, gid_filename) = tempfile.mkstemp()
 438         pkey.save_to_file(key_filename)
 439         gid_object.save_to_file(gid_filename, save_parents=True)
 440         host = node['hostname']
 441         key_dest="/etc/sfa/node.key"
 442         gid_dest="/etc/sfa/node.gid"
 443         scp = "/usr/bin/scp"
 444         #identity = "/etc/planetlab/root_ssh_key.rsa"
 445         identity = "/etc/sfa/root_ssh_key"
 446         scp_options=" -i %(identity)s " % locals()
 447         scp_options+="-o StrictHostKeyChecking=no " % locals()
 448         scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
 449                          locals()
 450         scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
 451                          locals()
 452
 453         all_commands = [scp_key_command, scp_gid_command]
 454
 455         for command in all_commands:
 456             (status, output) = commands.getstatusoutput(command)
 457             if status:
 458                 raise Exception, output
 459
 460         for filename in [key_filename, gid_filename]:
 461             os.unlink(filename)
 462
 463         return 1