sfa/managers/registry_manager_pl.py

   1 import types
   2 import time
   3
   4 from sfa.util.faults import *
   5 from sfa.util.prefixTree import prefixTree
   6 from sfa.util.record import SfaRecord
   7 from sfa.util.table import SfaTable
   8 from sfa.util.record import SfaRecord
   9 from sfa.trust.gid import GID
  10 from sfa.util.xrn import Xrn, get_leaf, get_authority, hrn_to_urn, urn_to_hrn
  11 from sfa.util.plxrn import hrn_to_pl_login_base
  12 from sfa.trust.credential import Credential
  13 from sfa.trust.certificate import Certificate, Keypair
  14 from sfa.trust.gid import create_uuid
  15 from sfa.util.version import version_core
  16
  17 # The GENI GetVersion call
  18 def GetVersion(api):
  19     peers =dict ([ (peername,v._ServerProxy__host) for (peername,v) in api.registries.iteritems()
  20                    if peername != api.hrn])
  21     xrn=Xrn(api.hrn)
  22     return version_core({'interface':'registry',
  23                          'hrn':xrn.get_hrn(),
  24                          'urn':xrn.get_urn(),
  25                          'peers':peers})
  26
  27 def get_credential(api, xrn, type, is_self=False):
  28     # convert xrn to hrn
  29     if type:
  30         hrn = urn_to_hrn(xrn)[0]
  31     else:
  32         hrn, type = urn_to_hrn(xrn)
  33
  34     # Is this a root or sub authority
  35     auth_hrn = api.auth.get_authority(hrn)
  36     if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
  37         auth_hrn = hrn
  38     # get record info
  39     auth_info = api.auth.get_auth_info(auth_hrn)
  40     table = SfaTable()
  41     records = table.findObjects({'type': type, 'hrn': hrn})
  42     if not records:
  43         raise RecordNotFound(hrn)
  44     record = records[0]
  45
  46     # verify_cancreate_credential requires that the member lists
  47     # (researchers, pis, etc) be filled in
  48     api.fill_record_info(record)
  49     if record['type']=='user':
  50        if not record['enabled']:
  51           raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record['email']))
  52
  53     # get the callers gid
  54     # if this is a self cred the record's gid is the caller's gid
  55     if is_self:
  56         caller_hrn = hrn
  57         caller_gid = record.get_gid_object()
  58     else:
  59         caller_gid = api.auth.client_cred.get_gid_caller()
  60         caller_hrn = caller_gid.get_hrn()
  61
  62     object_hrn = record.get_gid_object().get_hrn()
  63     rights = api.auth.determine_user_rights(caller_hrn, record)
  64     # make sure caller has rights to this object
  65     if rights.is_empty():
  66         raise PermissionError(caller_hrn + " has no rights to " + record['name'])
  67
  68     object_gid = GID(string=record['gid'])
  69     new_cred = Credential(subject = object_gid.get_subject())
  70     new_cred.set_gid_caller(caller_gid)
  71     new_cred.set_gid_object(object_gid)
  72     new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
  73     #new_cred.set_pubkey(object_gid.get_pubkey())
  74     new_cred.set_privileges(rights)
  75     new_cred.get_privileges().delegate_all_privileges(True)
  76     if 'expires' in record:
  77         new_cred.set_expiration(int(record['expires']))
  78     auth_kind = "authority,ma,sa"
  79     # Parent not necessary, verify with certs
  80     #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
  81     new_cred.encode()
  82     new_cred.sign()
  83
  84     return new_cred.save_to_string(save_parents=True)
  85
  86
  87 def resolve(api, xrns, type=None, full=True):
  88
  89     # load all known registry names into a prefix tree and attempt to find
  90     # the longest matching prefix
  91     if not isinstance(xrns, types.ListType):
  92         if not type:
  93             type = Xrn(xrns).get_type()
  94         xrns = [xrns]
  95     hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
  96     # create a dict where key is a registry hrn and its value is a
  97     # hrns at that registry (determined by the known prefix tree).
  98     xrn_dict = {}
  99     registries = api.registries
 100     tree = prefixTree()
 101     registry_hrns = registries.keys()
 102     tree.load(registry_hrns)
 103     for xrn in xrns:
 104         registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
 105         if registry_hrn not in xrn_dict:
 106             xrn_dict[registry_hrn] = []
 107         xrn_dict[registry_hrn].append(xrn)
 108
 109     records = []
 110     for registry_hrn in xrn_dict:
 111         # skip the hrn without a registry hrn
 112         # XX should we let the user know the authority is unknown?
 113         if not registry_hrn:
 114             continue
 115
 116         # if the best match (longest matching hrn) is not the local registry,
 117         # forward the request
 118         xrns = xrn_dict[registry_hrn]
 119         if registry_hrn != api.hrn:
 120             credential = api.getCredential()
 121             peer_records = registries[registry_hrn].Resolve(xrns, credential)
 122             records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
 123
 124     # try resolving the remaining unfound records at the local registry
 125     remaining_hrns = set(hrns).difference([record['hrn'] for record in records])
 126     # convert set to list
 127     remaining_hrns = [hrn for hrn in remaining_hrns]
 128     table = SfaTable()
 129     local_records = table.findObjects({'hrn': remaining_hrns})
 130     if full:
 131         api.fill_record_info(local_records)
 132
 133     # convert local record objects to dicts
 134     records.extend([dict(record) for record in local_records])
 135     if not records:
 136         raise RecordNotFound(str(hrns))
 137
 138     if type:
 139         records = filter(lambda rec: rec['type'] in [type], records)
 140
 141     return records
 142
 143 def list(api, xrn, origin_hrn=None):
 144     hrn, type = urn_to_hrn(xrn)
 145     # load all know registry names into a prefix tree and attempt to find
 146     # the longest matching prefix
 147     records = []
 148     registries = api.registries
 149     registry_hrns = registries.keys()
 150     tree = prefixTree()
 151     tree.load(registry_hrns)
 152     registry_hrn = tree.best_match(hrn)
 153
 154     #if there was no match then this record belongs to an unknow registry
 155     if not registry_hrn:
 156         raise MissingAuthority(xrn)
 157
 158     # if the best match (longest matching hrn) is not the local registry,
 159     # forward the request
 160     records = []
 161     if registry_hrn != api.hrn:
 162         credential = api.getCredential()
 163         record_list = registries[registry_hrn].List(xrn, credential)
 164         records = [SfaRecord(dict=record).as_dict() for record in record_list]
 165
 166     # if we still have not found the record yet, try the local registry
 167     if not records:
 168         if not api.auth.hierarchy.auth_exists(hrn):
 169             raise MissingAuthority(hrn)
 170
 171         table = SfaTable()
 172         records = table.find({'authority': hrn})
 173
 174     return records
 175
 176
 177 def create_gid(api, xrn, cert):
 178     pass
 179
 180 def register(api, record):
 181
 182     hrn, type = record['hrn'], record['type']
 183     urn = hrn_to_urn(hrn,type)
 184     # validate the type
 185     if type not in ['authority', 'slice', 'node', 'user']:
 186         raise UnknownSfaType(type)
 187
 188     # check if record already exists
 189     table = SfaTable()
 190     existing_records = table.find({'type': type, 'hrn': hrn})
 191     if existing_records:
 192         raise ExistingRecord(hrn)
 193
 194     record = SfaRecord(dict = record)
 195     record['authority'] = get_authority(record['hrn'])
 196     type = record['type']
 197     hrn = record['hrn']
 198     api.auth.verify_object_permission(hrn)
 199     auth_info = api.auth.get_auth_info(record['authority'])
 200     pub_key = None
 201     # make sure record has a gid
 202     if 'gid' not in record:
 203         uuid = create_uuid()
 204         pkey = Keypair(create=True)
 205         if 'key' in record and record['key']:
 206             if isinstance(record['key'], types.ListType):
 207                 pub_key = record['key'][0]
 208             else:
 209                 pub_key = record['key']
 210             pkey = convert_public_key(pub_key)
 211
 212         gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
 213         gid = gid_object.save_to_string(save_parents=True)
 214         record['gid'] = gid
 215         record.set_gid(gid)
 216
 217     if type in ["authority"]:
 218         # update the tree
 219         if not api.auth.hierarchy.auth_exists(hrn):
 220             api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
 221
 222         # get the GID from the newly created authority
 223         gid = auth_info.get_gid_object()
 224         record.set_gid(gid.save_to_string(save_parents=True))
 225         pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
 226         sites = api.plshell.GetSites(api.plauth, [pl_record['login_base']])
 227         if not sites:
 228             pointer = api.plshell.AddSite(api.plauth, pl_record)
 229         else:
 230             pointer = sites[0]['site_id']
 231
 232         record.set_pointer(pointer)
 233         record['pointer'] = pointer
 234
 235     elif (type == "slice"):
 236         acceptable_fields=['url', 'instantiation', 'name', 'description']
 237         pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
 238         for key in pl_record.keys():
 239             if key not in acceptable_fields:
 240                 pl_record.pop(key)
 241         slices = api.plshell.GetSlices(api.plauth, [pl_record['name']])
 242         if not slices:
 243              pointer = api.plshell.AddSlice(api.plauth, pl_record)
 244         else:
 245              pointer = slices[0]['slice_id']
 246         record.set_pointer(pointer)
 247         record['pointer'] = pointer
 248
 249     elif  (type == "user"):
 250         persons = api.plshell.GetPersons(api.plauth, [record['email']])
 251         if not persons:
 252             pointer = api.plshell.AddPerson(api.plauth, dict(record))
 253         else:
 254             pointer = persons[0]['person_id']
 255
 256         if 'enabled' in record and record['enabled']:
 257             api.plshell.UpdatePerson(api.plauth, pointer, {'enabled': record['enabled']})
 258         # add this persons to the site only if he is being added for the first
 259         # time by sfa and doesont already exist in plc
 260         if not persons or not persons[0]['site_ids']:
 261             login_base = get_leaf(record['authority'])
 262             api.plshell.AddPersonToSite(api.plauth, pointer, login_base)
 263
 264         # What roles should this user have?
 265         api.plshell.AddRoleToPerson(api.plauth, 'user', pointer)
 266         # Add the user's key
 267         if pub_key:
 268             api.plshell.AddPersonKey(api.plauth, pointer, {'key_type' : 'ssh', 'key' : pub_key})
 269
 270     elif (type == "node"):
 271         pl_record = api.sfa_fields_to_pl_fields(type, hrn, record)
 272         login_base = hrn_to_pl_login_base(record['authority'])
 273         nodes = api.plshell.GetNodes(api.plauth, [pl_record['hostname']])
 274         if not nodes:
 275             pointer = api.plshell.AddNode(api.plauth, login_base, pl_record)
 276         else:
 277             pointer = nodes[0]['node_id']
 278
 279     record['pointer'] = pointer
 280     record.set_pointer(pointer)
 281     record_id = table.insert(record)
 282     record['record_id'] = record_id
 283
 284     # update membership for researchers, pis, owners, operators
 285     api.update_membership(None, record)
 286
 287     return record.get_gid_object().save_to_string(save_parents=True)
 288
 289 def update(api, record_dict):
 290     new_record = SfaRecord(dict = record_dict)
 291     type = new_record['type']
 292     hrn = new_record['hrn']
 293     urn = hrn_to_urn(hrn,type)
 294     table = SfaTable()
 295     # make sure the record exists
 296     records = table.findObjects({'type': type, 'hrn': hrn})
 297     if not records:
 298         raise RecordNotFound(hrn)
 299     record = records[0]
 300     record['last_updated'] = time.gmtime()
 301
 302     # Update_membership needs the membership lists in the existing record
 303     # filled in, so it can see if members were added or removed
 304     api.fill_record_info(record)
 305
 306     # Use the pointer from the existing record, not the one that the user
 307     # gave us. This prevents the user from inserting a forged pointer
 308     pointer = record['pointer']
 309     # update the PLC information that was specified with the record
 310
 311     if (type == "authority"):
 312         api.plshell.UpdateSite(api.plauth, pointer, new_record)
 313
 314     elif type == "slice":
 315         pl_record=api.sfa_fields_to_pl_fields(type, hrn, new_record)
 316         if 'name' in pl_record:
 317             pl_record.pop('name')
 318             api.plshell.UpdateSlice(api.plauth, pointer, pl_record)
 319
 320     elif type == "user":
 321         # SMBAKER: UpdatePerson only allows a limited set of fields to be
 322         #    updated. Ideally we should have a more generic way of doing
 323         #    this. I copied the field names from UpdatePerson.py...
 324         update_fields = {}
 325         all_fields = new_record
 326         for key in all_fields.keys():
 327             if key in ['first_name', 'last_name', 'title', 'email',
 328                        'password', 'phone', 'url', 'bio', 'accepted_aup',
 329                        'enabled']:
 330                 update_fields[key] = all_fields[key]
 331         api.plshell.UpdatePerson(api.plauth, pointer, update_fields)
 332
 333         if 'key' in new_record and new_record['key']:
 334             # must check this key against the previous one if it exists
 335             persons = api.plshell.GetPersons(api.plauth, [pointer], ['key_ids'])
 336             person = persons[0]
 337             keys = person['key_ids']
 338             keys = api.plshell.GetKeys(api.plauth, person['key_ids'])
 339             key_exists = False
 340             if isinstance(new_record['key'], types.ListType):
 341                 new_key = new_record['key'][0]
 342             else:
 343                 new_key = new_record['key']
 344
 345             # Delete all stale keys
 346             for key in keys:
 347                 if new_record['key'] != key['key']:
 348                     api.plshell.DeleteKey(api.plauth, key['key_id'])
 349                 else:
 350                     key_exists = True
 351             if not key_exists:
 352                 api.plshell.AddPersonKey(api.plauth, pointer, {'key_type': 'ssh', 'key': new_key})
 353
 354             # update the openssl key and gid
 355             pkey = convert_public_key(new_key)
 356             uuid = create_uuid()
 357             gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
 358             gid = gid_object.save_to_string(save_parents=True)
 359             record['gid'] = gid
 360             record = SfaRecord(dict=record)
 361             table.update(record)
 362
 363     elif type == "node":
 364         api.plshell.UpdateNode(api.plauth, pointer, new_record)
 365
 366     else:
 367         raise UnknownSfaType(type)
 368
 369     # update membership for researchers, pis, owners, operators
 370     api.update_membership(record, new_record)
 371
 372     return 1
 373
 374 # expecting an Xrn instance
 375 def remove(api, xrn, origin_hrn=None):
 376
 377     table = SfaTable()
 378     filter = {'hrn': xrn.get_hrn()}
 379     hrn=xrn.get_hrn()
 380     type=xrn.get_type()
 381     if type and type not in ['all', '*']:
 382         filter['type'] = type
 383
 384     records = table.find(filter)
 385     if not records: raise RecordNotFound(hrn)
 386     record = records[0]
 387     type = record['type']
 388
 389     credential = api.getCredential()
 390     registries = api.registries
 391
 392     # Try to remove the object from the PLCDB of federated agg.
 393     # This is attempted before removing the object from the local agg's PLCDB and sfa table
 394     if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
 395         for registry in registries:
 396             if registry not in [api.hrn]:
 397                 try:
 398                     result=registries[registry].remove_peer_object(credential, record, origin_hrn)
 399                 except:
 400                     pass
 401     if type == "user":
 402         persons = api.plshell.GetPersons(api.plauth, record['pointer'])
 403         # only delete this person if he has site ids. if he doesnt, it probably means
 404         # he was just removed from a site, not actually deleted
 405         if persons and persons[0]['site_ids']:
 406             api.plshell.DeletePerson(api.plauth, record['pointer'])
 407     elif type == "slice":
 408         if api.plshell.GetSlices(api.plauth, record['pointer']):
 409             api.plshell.DeleteSlice(api.plauth, record['pointer'])
 410     elif type == "node":
 411         if api.plshell.GetNodes(api.plauth, record['pointer']):
 412             api.plshell.DeleteNode(api.plauth, record['pointer'])
 413     elif type == "authority":
 414         if api.plshell.GetSites(api.plauth, record['pointer']):
 415             api.plshell.DeleteSite(api.plauth, record['pointer'])
 416     else:
 417         raise UnknownSfaType(type)
 418
 419     table.remove(record)
 420
 421     return 1
 422
 423 def remove_peer_object(api, record, origin_hrn=None):
 424     pass
 425
 426 def register_peer_object(api, record, origin_hrn=None):
 427     pass