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