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