2 # for get_key_from_incoming_ip
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
15 from sfa.util.printable import printable
17 from sfa.trust.gid import GID
18 from sfa.trust.credential import Credential
19 from sfa.trust.certificate import Certificate, Keypair, convert_public_key
20 from sfa.trust.gid import create_uuid
22 from sfa.storage.model import make_record, RegRecord, RegAuthority, RegUser, RegSlice, RegKey, \
23 augment_with_sfa_builtins
24 ### the types that we need to exclude from sqlobjects before being able to dump
25 # them on the xmlrpc wire
26 from sqlalchemy.orm.collections import InstrumentedList
28 ### historical note -- april 2014
29 # the myslice chaps rightfully complained about the following discrepancy
31 # * read operations (resolve) expose stuff like e.g.
32 # 'reg-researchers', or 'reg-pis', but that
33 # * write operations (register, update) need e.g.
34 # 'researcher' or 'pi' to be set - reg-* are just ignored
36 # the 'normalize' helper functions below aim at ironing this out
37 # however in order to break as few code as possible we essentially make sure that *both* fields are set
38 # upon entering the write methods (so again register and update) for legacy, as some driver code
39 # might depend on the presence of, say, 'researcher'
41 # normalize an input record to a write method - register or update
42 # e.g. registry calls this 'reg-researchers'
43 # while some drivers call this 'researcher'
44 # we need to make sure that both keys appear and are the same
45 def _normalize_input (record, reg_key, driver_key):
46 # this looks right, use this for both keys
48 # and issue a warning if they were both set and different
49 # as we're overwriting some user data here
50 if driver_key in record:
51 logger.warning ("normalize_input_researcher: incoming record has both values, using reg-researchers")
52 record[driver_key]=record[reg_key]
53 # we only have one key set, duplicate for the other one
54 elif driver_key in record:
55 logger.warning ("normalize_input_researcher: you should use '%s' instead ot '%s'"%(reg_key,driver_key))
56 record[reg_key]=record[driver_key]
58 def normalize_input_record (record):
59 _normalize_input (record, 'reg-researchers','researcher')
60 _normalize_input (record, 'reg-pis','pi')
63 class RegistryManager:
65 def __init__ (self, config):
66 logger.info("Creating RegistryManager[%s]"%id(self))
68 # The GENI GetVersion call
69 def GetVersion(self, api, options):
70 peers = dict ( [ (hrn,interface.get_url()) for (hrn,interface) in api.registries.iteritems()
72 xrn=Xrn(api.hrn,type='authority')
73 return version_core({'interface':'registry',
80 def GetCredential(self, api, xrn, input_type, caller_xrn=None):
83 hrn, _ = urn_to_hrn(xrn)
86 hrn, type = urn_to_hrn(xrn)
88 # Slivers don't have credentials but users should be able to
89 # specify a sliver xrn and receive the slice's credential
90 # However if input_type is specified
91 if type == 'sliver' or ( not input_type and '-' in Xrn(hrn).leaf):
92 slice_xrn = api.driver.sliver_to_slice_xrn(hrn)
95 # Is this a root or sub authority
96 auth_hrn = api.auth.get_authority(hrn)
97 if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
99 auth_info = api.auth.get_auth_info(auth_hrn)
102 dbsession = api.dbsession()
103 record=dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
105 raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
107 # get the callers gid
108 # if caller_xrn is not specified assume the caller is the record
112 caller_gid = record.get_gid_object()
114 caller_hrn, caller_type = urn_to_hrn(caller_xrn)
116 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn,type=caller_type).first()
118 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn).first()
119 if not caller_record:
120 raise RecordNotFound("Unable to associated caller (hrn=%s, type=%s) with credential for (hrn: %s, type: %s)"%(caller_hrn, caller_type, hrn, type))
121 caller_gid = GID(string=caller_record.gid)
123 object_hrn = record.get_gid_object().get_hrn()
124 # call the builtin authorization/credential generation engine
125 rights = api.auth.determine_user_rights(caller_hrn, record)
126 # make sure caller has rights to this object
127 if rights.is_empty():
128 raise PermissionError("%s has no rights to %s (%s)" % \
129 (caller_hrn, object_hrn, xrn))
130 object_gid = GID(string=record.gid)
131 new_cred = Credential(subject = object_gid.get_subject())
132 new_cred.set_gid_caller(caller_gid)
133 new_cred.set_gid_object(object_gid)
134 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
135 #new_cred.set_pubkey(object_gid.get_pubkey())
136 new_cred.set_privileges(rights)
137 new_cred.get_privileges().delegate_all_privileges(True)
138 if hasattr(record,'expires'):
139 date = utcparse(record.expires)
140 expires = datetime_to_epoch(date)
141 new_cred.set_expiration(int(expires))
142 auth_kind = "authority,ma,sa"
143 # Parent not necessary, verify with certs
144 #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
148 return new_cred.save_to_string(save_parents=True)
151 # the default for full, which means 'dig into the testbed as well', should be false
152 def Resolve(self, api, xrns, type=None, details=False):
154 dbsession = api.dbsession()
155 if not isinstance(xrns, types.ListType):
156 # try to infer type if not set and we get a single input
158 type = Xrn(xrns).get_type()
160 hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
162 # load all known registry names into a prefix tree and attempt to find
163 # the longest matching prefix
164 # create a dict where key is a registry hrn and its value is a list
165 # of hrns at that registry (determined by the known prefix tree).
167 registries = api.registries
169 registry_hrns = registries.keys()
170 tree.load(registry_hrns)
172 registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
173 if registry_hrn not in xrn_dict:
174 xrn_dict[registry_hrn] = []
175 xrn_dict[registry_hrn].append(xrn)
178 for registry_hrn in xrn_dict:
179 # skip the hrn without a registry hrn
180 # XX should we let the user know the authority is unknown?
184 # if the best match (longest matching hrn) is not the local registry,
185 # forward the request
186 xrns = xrn_dict[registry_hrn]
187 if registry_hrn != api.hrn:
188 credential = api.getCredential()
189 interface = api.registries[registry_hrn]
190 server_proxy = api.server_proxy(interface, credential)
191 # should propagate the details flag but that's not supported in the xmlrpc interface yet
192 #peer_records = server_proxy.Resolve(xrns, credential,type, details=details)
193 peer_records = server_proxy.Resolve(xrns, credential)
194 # pass foreign records as-is
195 # previous code used to read
196 # records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
197 # not sure why the records coming through xmlrpc had to be processed at all
198 records.extend(peer_records)
200 # try resolving the remaining unfound records at the local registry
201 local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
203 local_records = dbsession.query(RegRecord).filter(RegRecord.hrn.in_(local_hrns))
205 local_records = local_records.filter_by(type=type)
206 local_records=local_records.all()
208 for local_record in local_records:
209 augment_with_sfa_builtins (local_record)
211 logger.info("Resolve, (details=%s,type=%s) local_records=%s "%(details,type,local_records))
212 local_dicts = [ record.__dict__ for record in local_records ]
215 # in details mode we get as much info as we can, which involves contacting the
216 # testbed for getting implementation details about the record
217 api.driver.augment_records_with_testbed_info(local_dicts)
218 # also we fill the 'url' field for known authorities
219 # used to be in the driver code, sounds like a poorman thing though
220 def solve_neighbour_url (record):
221 if not record.type.startswith('authority'): return
223 for neighbour_dict in [ api.aggregates, api.registries ]:
224 if hrn in neighbour_dict:
225 record.url=neighbour_dict[hrn].get_url()
227 for record in local_records: solve_neighbour_url (record)
229 # convert local record objects to dicts for xmlrpc
230 # xxx somehow here calling dict(record) issues a weird error
231 # however record.todict() seems to work fine
232 # records.extend( [ dict(record) for record in local_records ] )
233 records.extend( [ record.todict(exclude_types=[InstrumentedList]) for record in local_records ] )
236 raise RecordNotFound(str(hrns))
240 def List (self, api, xrn, origin_hrn=None, options=None):
241 if options is None: options={}
242 dbsession=api.dbsession()
243 # load all know registry names into a prefix tree and attempt to find
244 # the longest matching prefix
245 hrn, type = urn_to_hrn(xrn)
246 registries = api.registries
247 registry_hrns = registries.keys()
249 tree.load(registry_hrns)
250 registry_hrn = tree.best_match(hrn)
252 #if there was no match then this record belongs to an unknow registry
254 raise MissingAuthority(xrn)
255 # if the best match (longest matching hrn) is not the local registry,
256 # forward the request
258 if registry_hrn != api.hrn:
259 credential = api.getCredential()
260 interface = api.registries[registry_hrn]
261 server_proxy = api.server_proxy(interface, credential)
262 record_list = server_proxy.List(xrn, credential, options)
263 # same as above, no need to process what comes from through xmlrpc
264 # pass foreign records as-is
265 record_dicts = record_list
267 # if we still have not found the record yet, try the local registry
268 # logger.debug("before trying local records, %d foreign records"% len(record_dicts))
271 if ('recursive' in options and options['recursive']):
273 elif hrn.endswith('*'):
277 if not api.auth.hierarchy.auth_exists(hrn):
278 raise MissingAuthority(hrn)
280 records = dbsession.query(RegRecord).filter(RegRecord.hrn.startswith(hrn)).all()
281 # logger.debug("recursive mode, found %d local records"%(len(records)))
283 records = dbsession.query(RegRecord).filter_by(authority=hrn).all()
284 # logger.debug("non recursive mode, found %d local records"%(len(records)))
285 # so that sfi list can show more than plain names...
286 for record in records: augment_with_sfa_builtins (record)
287 record_dicts=[ record.todict(exclude_types=[InstrumentedList]) for record in records ]
292 def CreateGid(self, api, xrn, cert):
294 authority = Xrn(xrn=xrn).get_authority_hrn()
295 auth_info = api.auth.get_auth_info(authority)
297 pkey = Keypair(create=True)
299 certificate = Certificate(string=cert)
300 pkey = certificate.get_pubkey()
301 gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey)
302 return gid.save_to_string(save_parents=True)
305 # utility for handling relationships among the SFA objects
307 # subject_record describes the subject of the relationships
308 # ref_record contains the target values for the various relationships we need to manage
309 # (to begin with, this is just the slice x person (researcher) and authority x person (pi) relationships)
310 def update_driver_relations (self, api, subject_obj, ref_obj):
311 type=subject_obj.type
312 #for (k,v) in subject_obj.__dict__.items(): print k,'=',v
313 if type=='slice' and hasattr(ref_obj,'researcher'):
314 self.update_driver_relation(api, subject_obj, ref_obj.researcher, 'user', 'researcher')
315 elif type=='authority' and hasattr(ref_obj,'pi'):
316 self.update_driver_relation(api, subject_obj,ref_obj.pi, 'user', 'pi')
318 # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
319 # hrns is the list of hrns that should be linked to the subject from now on
320 # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
321 def update_driver_relation (self, api, record_obj, hrns, target_type, relation_name):
322 dbsession=api.dbsession()
323 # locate the linked objects in our db
324 subject_type=record_obj.type
325 subject_id=record_obj.pointer
326 # get the 'pointer' field of all matching records
327 link_id_tuples = dbsession.query(RegRecord.pointer).filter_by(type=target_type).filter(RegRecord.hrn.in_(hrns)).all()
328 # sqlalchemy returns named tuples for columns
329 link_ids = [ tuple.pointer for tuple in link_id_tuples ]
330 api.driver.update_relation (subject_type, target_type, relation_name, subject_id, link_ids)
332 def Register(self, api, record_dict):
334 logger.debug("Register: entering with record_dict=%s"%printable(record_dict))
335 normalize_input_record (record_dict)
336 logger.debug("Register: normalized record_dict=%s"%printable(record_dict))
338 dbsession=api.dbsession()
339 hrn, type = record_dict['hrn'], record_dict['type']
340 urn = hrn_to_urn(hrn,type)
342 if type not in ['authority', 'slice', 'node', 'user']:
343 raise UnknownSfaType(type)
345 # check if record_dict already exists
346 existing_records = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).all()
348 raise ExistingRecord(hrn)
350 assert ('type' in record_dict)
351 # returns the right type of RegRecord according to type in record
352 record = make_record(dict=record_dict)
353 record.just_created()
354 record.authority = get_authority(record.hrn)
355 auth_info = api.auth.get_auth_info(record.authority)
357 # make sure record has a gid
360 pkey = Keypair(create=True)
361 if getattr(record,'keys',None):
363 # use only first key in record
364 if isinstance(record.keys, types.ListType):
365 pub_key = record.keys[0]
366 pkey = convert_public_key(pub_key)
368 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
369 gid = gid_object.save_to_string(save_parents=True)
372 if isinstance (record, RegAuthority):
374 if not api.auth.hierarchy.auth_exists(hrn):
375 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
377 # get the GID from the newly created authority
378 auth_info = api.auth.get_auth_info(hrn)
379 gid = auth_info.get_gid_object()
380 record.gid=gid.save_to_string(save_parents=True)
382 # locate objects for relationships
383 pi_hrns = getattr(record,'reg-pis',None)
384 if pi_hrns is not None: record.update_pis (pi_hrns, dbsession)
386 elif isinstance (record, RegSlice):
387 researcher_hrns = getattr(record,'reg-researchers',None)
388 if researcher_hrns is not None: record.update_researchers (researcher_hrns, dbsession)
390 elif isinstance (record, RegUser):
391 # create RegKey objects for incoming keys
392 if hasattr(record,'keys'):
393 logger.debug ("creating %d keys for user %s"%(len(record.keys),record.hrn))
394 record.reg_keys = [ RegKey (key) for key in record.keys ]
396 # update testbed-specific data if needed
397 pointer = api.driver.register (record.__dict__, hrn, pub_key)
399 record.pointer=pointer
400 dbsession.add(record)
403 # update membership for researchers, pis, owners, operators
404 self.update_driver_relations (api, record, record)
406 return record.get_gid_object().save_to_string(save_parents=True)
408 def Update(self, api, record_dict):
410 logger.debug("Update: entering with record_dict=%s"%printable(record_dict))
411 normalize_input_record (record_dict)
412 logger.debug("Update: normalized record_dict=%s"%printable(record_dict))
414 dbsession=api.dbsession()
415 assert ('type' in record_dict)
416 new_record=make_record(dict=record_dict)
417 (type,hrn) = (new_record.type, new_record.hrn)
419 # make sure the record exists
420 record = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
422 raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
423 record.just_updated()
425 # Use the pointer from the existing record, not the one that the user
426 # gave us. This prevents the user from inserting a forged pointer
427 pointer = record.pointer
429 # is there a change in keys ?
432 if getattr(new_record,'keys',None):
433 new_key=new_record.keys
434 if isinstance (new_key,types.ListType):
437 # take new_key into account
439 # update the openssl key and gid
440 pkey = convert_public_key(new_key)
442 urn = hrn_to_urn(hrn,type)
443 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
444 gid = gid_object.save_to_string(save_parents=True)
446 # xxx should do side effects from new_record to record
447 # not too sure how to do that
448 # not too big a deal with planetlab as the driver is authoritative, but...
450 # update native relations
451 if isinstance (record, RegSlice):
452 researcher_hrns = getattr(new_record,'reg-researchers',None)
453 if researcher_hrns is not None: record.update_researchers (researcher_hrns, dbsession)
455 elif isinstance (record, RegAuthority):
456 pi_hrns = getattr(new_record,'reg-pis',None)
457 if pi_hrns is not None: record.update_pis (pi_hrns, dbsession)
459 # update the PLC information that was specified with the record
460 # xxx oddly enough, without this useless statement,
461 # record.__dict__ as received by the driver seems to be off
462 # anyway the driver should receive an object
463 # (and then extract __dict__ itself if needed)
464 print "DO NOT REMOVE ME before driver.update, record=%s"%record
467 (pointer, new_key_pointer) = api.driver.update (record.__dict__, new_record.__dict__, hrn, new_key)
470 if new_key and new_key_pointer:
471 record.reg_keys=[ RegKey (new_key, new_key_pointer)]
475 # update membership for researchers, pis, owners, operators
476 self.update_driver_relations (api, record, new_record)
480 # expecting an Xrn instance
481 def Remove(self, api, xrn, origin_hrn=None):
482 dbsession=api.dbsession()
485 request=dbsession.query(RegRecord).filter_by(hrn=hrn)
486 if type and type not in ['all', '*']:
487 request=request.filter_by(type=type)
489 record = request.first()
491 msg="Could not find hrn %s"%hrn
492 if type: msg += " type=%s"%type
493 raise RecordNotFound(msg)
496 if type not in ['slice', 'user', 'node', 'authority'] :
497 raise UnknownSfaType(type)
499 credential = api.getCredential()
500 registries = api.registries
502 # Try to remove the object from the PLCDB of federated agg.
503 # This is attempted before removing the object from the local agg's PLCDB and sfa table
504 if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
505 for registry in registries:
506 if registry not in [api.hrn]:
508 result=registries[registry].remove_peer_object(credential, record, origin_hrn)
512 # call testbed callback first
513 # IIUC this is done on the local testbed TOO because of the refreshpeer link
514 if not api.driver.remove(record.__dict__):
515 logger.warning("driver.remove failed")
518 dbsession.delete(record)
523 # This is a PLC-specific thing, won't work with other platforms
524 def get_key_from_incoming_ip (self, api):
525 dbsession=api.dbsession()
526 # verify that the callers's ip address exist in the db and is an interface
527 # for a node in the db
528 (ip, port) = api.remote_addr
529 interfaces = api.driver.shell.GetInterfaces({'ip': ip}, ['node_id'])
531 raise NonExistingRecord("no such ip %(ip)s" % locals())
532 nodes = api.driver.shell.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
534 raise NonExistingRecord("no such node using ip %(ip)s" % locals())
537 # look up the sfa record
538 record=dbsession.query(RegRecord).filter_by(type='node',pointer=node['node_id']).first()
540 raise RecordNotFound("node with pointer %s"%node['node_id'])
542 # generate a new keypair and gid
544 pkey = Keypair(create=True)
545 urn = hrn_to_urn(record.hrn, record.type)
546 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
547 gid = gid_object.save_to_string(save_parents=True)
553 # attempt the scp the key
554 # and gid onto the node
555 # this will only work for planetlab based components
556 (kfd, key_filename) = tempfile.mkstemp()
557 (gfd, gid_filename) = tempfile.mkstemp()
558 pkey.save_to_file(key_filename)
559 gid_object.save_to_file(gid_filename, save_parents=True)
560 host = node['hostname']
561 key_dest="/etc/sfa/node.key"
562 gid_dest="/etc/sfa/node.gid"
564 #identity = "/etc/planetlab/root_ssh_key.rsa"
565 identity = "/etc/sfa/root_ssh_key"
566 scp_options=" -i %(identity)s " % locals()
567 scp_options+="-o StrictHostKeyChecking=no " % locals()
568 scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
570 scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
573 all_commands = [scp_key_command, scp_gid_command]
575 for command in all_commands:
576 (status, output) = commands.getstatusoutput(command)
578 raise Exception, output
580 for filename in [key_filename, gid_filename]: