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