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_input' 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: incoming record has both values, using %s"%reg_key)
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: you should use '%s' instead of '%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')
61 _normalize_input (record, 'reg-keys','keys')
62 # xxx the keys thing could use a little bit more attention:
63 # some parts of the code are using 'keys' while they should use 'reg-keys'
64 # but I run out of time for now
65 if 'reg-keys' in record:
66 record['keys'] = record['reg-keys']
69 class RegistryManager:
71 def __init__ (self, config):
72 logger.info("Creating RegistryManager[%s]"%id(self))
74 # The GENI GetVersion call
75 def GetVersion(self, api, options):
76 peers = dict ( [ (hrn,interface.get_url()) for (hrn,interface) in api.registries.iteritems()
78 xrn=Xrn(api.hrn,type='authority')
79 return version_core({'interface':'registry',
85 def GetCredential(self, api, xrn, input_type, caller_xrn=None):
88 hrn, _ = urn_to_hrn(xrn)
91 hrn, type = urn_to_hrn(xrn)
93 # Slivers don't have credentials but users should be able to
94 # specify a sliver xrn and receive the slice's credential
95 # However if input_type is specified
96 if type == 'sliver' or ( not input_type and '-' in Xrn(hrn).leaf):
97 slice_xrn = api.driver.sliver_to_slice_xrn(hrn)
100 # Is this a root or sub authority
101 auth_hrn = api.auth.get_authority(hrn)
102 if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
104 auth_info = api.auth.get_auth_info(auth_hrn)
107 dbsession = api.dbsession()
108 record=dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
110 raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
112 # get the callers gid
113 # if caller_xrn is not specified assume the caller is the record
117 caller_gid = record.get_gid_object()
119 caller_hrn, caller_type = urn_to_hrn(caller_xrn)
121 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn,type=caller_type).first()
123 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn).first()
124 if not caller_record:
125 raise RecordNotFound("Unable to associated caller (hrn=%s, type=%s) with credential for (hrn: %s, type: %s)"%(caller_hrn, caller_type, hrn, type))
126 caller_gid = GID(string=caller_record.gid)
128 object_hrn = record.get_gid_object().get_hrn()
129 # call the builtin authorization/credential generation engine
130 rights = api.auth.determine_user_rights(caller_hrn, record)
131 # make sure caller has rights to this object
132 if rights.is_empty():
133 raise PermissionError("%s has no rights to %s (%s)" % \
134 (caller_hrn, object_hrn, xrn))
135 object_gid = GID(string=record.gid)
136 new_cred = Credential(subject = object_gid.get_subject())
137 new_cred.set_gid_caller(caller_gid)
138 new_cred.set_gid_object(object_gid)
139 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
140 #new_cred.set_pubkey(object_gid.get_pubkey())
141 new_cred.set_privileges(rights)
142 new_cred.get_privileges().delegate_all_privileges(True)
143 if hasattr(record,'expires'):
144 date = utcparse(record.expires)
145 expires = datetime_to_epoch(date)
146 new_cred.set_expiration(int(expires))
147 auth_kind = "authority,ma,sa"
148 # Parent not necessary, verify with certs
149 #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
153 return new_cred.save_to_string(save_parents=True)
156 # the default for full, which means 'dig into the testbed as well', should be false
157 def Resolve(self, api, xrns, type=None, details=False):
159 dbsession = api.dbsession()
160 if not isinstance(xrns, types.ListType):
161 # try to infer type if not set and we get a single input
163 type = Xrn(xrns).get_type()
165 hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
167 # load all known registry names into a prefix tree and attempt to find
168 # the longest matching prefix
169 # create a dict where key is a registry hrn and its value is a list
170 # of hrns at that registry (determined by the known prefix tree).
172 registries = api.registries
174 registry_hrns = registries.keys()
175 tree.load(registry_hrns)
177 registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
178 if registry_hrn not in xrn_dict:
179 xrn_dict[registry_hrn] = []
180 xrn_dict[registry_hrn].append(xrn)
183 for registry_hrn in xrn_dict:
184 # skip the hrn without a registry hrn
185 # XX should we let the user know the authority is unknown?
189 # if the best match (longest matching hrn) is not the local registry,
190 # forward the request
191 xrns = xrn_dict[registry_hrn]
192 if registry_hrn != api.hrn:
193 credential = api.getCredential()
194 interface = api.registries[registry_hrn]
195 server_proxy = api.server_proxy(interface, credential)
196 # should propagate the details flag but that's not supported in the xmlrpc interface yet
197 #peer_records = server_proxy.Resolve(xrns, credential,type, details=details)
198 peer_records = server_proxy.Resolve(xrns, credential)
199 # pass foreign records as-is
200 # previous code used to read
201 # records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
202 # not sure why the records coming through xmlrpc had to be processed at all
203 records.extend(peer_records)
205 # try resolving the remaining unfound records at the local registry
206 local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
208 local_records = dbsession.query(RegRecord).filter(RegRecord.hrn.in_(local_hrns))
210 local_records = local_records.filter_by(type=type)
211 local_records=local_records.all()
213 for local_record in local_records:
214 augment_with_sfa_builtins(local_record)
216 logger.info("Resolve, (details=%s,type=%s) local_records=%s "%(details,type,local_records))
217 local_dicts = [ record.__dict__ for record in local_records ]
220 # in details mode we get as much info as we can, which involves contacting the
221 # testbed for getting implementation details about the record
222 api.driver.augment_records_with_testbed_info(local_dicts)
223 # also we fill the 'url' field for known authorities
224 # used to be in the driver code, sounds like a poorman thing though
225 def solve_neighbour_url (record):
226 if not record.type.startswith('authority'): return
228 for neighbour_dict in [ api.aggregates, api.registries ]:
229 if hrn in neighbour_dict:
230 record.url=neighbour_dict[hrn].get_url()
232 for record in local_records: solve_neighbour_url (record)
234 # convert local record objects to dicts for xmlrpc
235 # xxx somehow here calling dict(record) issues a weird error
236 # however record.todict() seems to work fine
237 # records.extend( [ dict(record) for record in local_records ] )
238 records.extend( [ record.todict(exclude_types=(InstrumentedList,)) for record in local_records ] )
241 raise RecordNotFound(str(hrns))
245 def List (self, api, xrn, origin_hrn=None, options=None):
246 if options is None: options={}
247 dbsession = api.dbsession()
248 # load all know registry names into a prefix tree and attempt to find
249 # the longest matching prefix
250 hrn, type = urn_to_hrn(xrn)
251 registries = api.registries
252 registry_hrns = registries.keys()
254 tree.load(registry_hrns)
255 registry_hrn = tree.best_match(hrn)
257 #if there was no match then this record belongs to an unknow registry
259 raise MissingAuthority(xrn)
260 # if the best match (longest matching hrn) is not the local registry,
261 # forward the request
263 if registry_hrn != api.hrn:
264 credential = api.getCredential()
265 interface = api.registries[registry_hrn]
266 server_proxy = api.server_proxy(interface, credential)
267 record_list = server_proxy.List(xrn, credential, options)
268 # same as above, no need to process what comes from through xmlrpc
269 # pass foreign records as-is
270 record_dicts = record_list
272 # if we still have not found the record yet, try the local registry
273 # logger.debug("before trying local records, %d foreign records"% len(record_dicts))
276 if ('recursive' in options and options['recursive']):
278 elif hrn.endswith('*'):
282 if not api.auth.hierarchy.auth_exists(hrn):
283 raise MissingAuthority(hrn)
285 records = dbsession.query(RegRecord).filter(RegRecord.hrn.startswith(hrn)).all()
286 # logger.debug("recursive mode, found %d local records"%(len(records)))
288 records = dbsession.query(RegRecord).filter_by(authority=hrn).all()
289 # logger.debug("non recursive mode, found %d local records"%(len(records)))
290 # so that sfi list can show more than plain names...
291 for record in records: augment_with_sfa_builtins (record)
292 record_dicts=[ record.todict(exclude_types=[InstrumentedList]) for record in records ]
296 def CreateGid(self, api, xrn, cert):
298 authority = Xrn(xrn=xrn).get_authority_hrn()
299 auth_info = api.auth.get_auth_info(authority)
301 pkey = Keypair(create=True)
303 certificate = Certificate(string=cert)
304 pkey = certificate.get_pubkey()
306 # Add the email of the user to SubjectAltName in the GID
308 hrn = Xrn(xrn).get_hrn()
309 dbsession = api.dbsession()
310 record=dbsession.query(RegUser).filter_by(hrn=hrn).first()
312 email = getattr(record,'email',None)
313 gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey, email=email)
314 return gid.save_to_string(save_parents=True)
317 # utility for handling relationships among the SFA objects
319 # subject_record describes the subject of the relationships
320 # ref_record contains the target values for the various relationships we need to manage
321 # (to begin with, this is just the slice x person (researcher) and authority x person (pi) relationships)
322 def update_driver_relations (self, api, subject_obj, ref_obj):
323 type=subject_obj.type
324 #for (k,v) in subject_obj.__dict__.items(): print k,'=',v
325 if type=='slice' and hasattr(ref_obj,'researcher'):
326 self.update_driver_relation(api, subject_obj, ref_obj.researcher, 'user', 'researcher')
327 elif type=='authority' and hasattr(ref_obj,'pi'):
328 self.update_driver_relation(api, subject_obj,ref_obj.pi, 'user', 'pi')
330 # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
331 # hrns is the list of hrns that should be linked to the subject from now on
332 # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
333 def update_driver_relation (self, api, record_obj, hrns, target_type, relation_name):
334 dbsession = api.dbsession()
335 # locate the linked objects in our db
336 subject_type=record_obj.type
337 subject_id=record_obj.pointer
338 # get the 'pointer' field of all matching records
339 link_id_tuples = dbsession.query(RegRecord.pointer).filter_by(type=target_type).filter(RegRecord.hrn.in_(hrns)).all()
340 # sqlalchemy returns named tuples for columns
341 link_ids = [ tuple.pointer for tuple in link_id_tuples ]
342 api.driver.update_relation (subject_type, target_type, relation_name, subject_id, link_ids)
344 def Register(self, api, record_dict):
346 logger.debug("Register: entering with record_dict=%s"%printable(record_dict))
347 normalize_input_record (record_dict)
348 logger.debug("Register: normalized record_dict=%s"%printable(record_dict))
350 dbsession = api.dbsession()
351 hrn, type = record_dict['hrn'], record_dict['type']
352 urn = hrn_to_urn(hrn,type)
354 if type not in ['authority', 'slice', 'node', 'user']:
355 raise UnknownSfaType(type)
357 # check if record_dict already exists
358 existing_records = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).all()
360 raise ExistingRecord(hrn)
362 assert ('type' in record_dict)
363 # returns the right type of RegRecord according to type in record
364 record = make_record(dict=record_dict)
365 record.just_created()
366 record.authority = get_authority(record.hrn)
367 auth_info = api.auth.get_auth_info(record.authority)
369 # make sure record has a gid
372 pkey = Keypair(create=True)
373 pub_key=getattr(record,'reg-keys',None)
374 if pub_key is not None:
375 # use only first key in record
376 if pub_key and isinstance(pub_key, types.ListType): pub_key = pub_key[0]
377 pkey = convert_public_key(pub_key)
379 email = getattr(record,'email',None)
380 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey, email = email)
381 gid = gid_object.save_to_string(save_parents=True)
384 if isinstance (record, RegAuthority):
386 if not api.auth.hierarchy.auth_exists(hrn):
387 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
389 # get the GID from the newly created authority
390 auth_info = api.auth.get_auth_info(hrn)
391 gid = auth_info.get_gid_object()
392 record.gid=gid.save_to_string(save_parents=True)
394 # locate objects for relationships
395 pi_hrns = getattr(record,'reg-pis',None)
396 if pi_hrns is not None: record.update_pis (pi_hrns, dbsession)
398 elif isinstance (record, RegSlice):
399 researcher_hrns = getattr(record,'reg-researchers',None)
400 if researcher_hrns is not None: record.update_researchers (researcher_hrns, dbsession)
402 elif isinstance (record, RegUser):
403 # create RegKey objects for incoming keys
404 if hasattr(record,'reg-keys'):
405 keys=getattr(record,'reg-keys')
406 # some people send the key as a string instead of a list of strings
407 if isinstance(keys,types.StringTypes): keys=[keys]
408 logger.debug ("creating %d keys for user %s"%(len(keys),record.hrn))
409 record.reg_keys = [ RegKey (key) for key in keys ]
411 # update testbed-specific data if needed
412 pointer = api.driver.register (record.__dict__, hrn, pub_key)
414 record.pointer=pointer
415 dbsession.add(record)
418 # update membership for researchers, pis, owners, operators
419 self.update_driver_relations (api, record, record)
421 return record.get_gid_object().save_to_string(save_parents=True)
423 def Update(self, api, record_dict):
425 logger.debug("Update: entering with record_dict=%s"%printable(record_dict))
426 normalize_input_record (record_dict)
427 logger.debug("Update: normalized record_dict=%s"%printable(record_dict))
429 dbsession = api.dbsession()
430 assert ('type' in record_dict)
431 new_record = make_record(dict=record_dict)
432 (type, hrn) = (new_record.type, new_record.hrn)
434 # make sure the record exists
435 record = dbsession.query(RegRecord).filter_by(type=type, hrn=hrn).first()
437 raise RecordNotFound("hrn={}, type={}".format(hrn, type))
438 record.just_updated()
440 # Use the pointer from the existing record, not the one that the user
441 # gave us. This prevents the user from inserting a forged pointer
442 pointer = record.pointer
444 # is there a change in keys ?
447 if getattr(new_record, 'keys', None):
448 new_key = new_record.keys
449 if isinstance (new_key, types.ListType):
452 # take new_key into account
454 # update the openssl key and gid
455 pkey = convert_public_key(new_key)
457 urn = hrn_to_urn(hrn,type)
459 email = getattr(new_record, 'email', None)
461 email = getattr(record, 'email', None)
462 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey, email = email)
463 gid = gid_object.save_to_string(save_parents=True)
465 # xxx should do side effects from new_record to record
466 # not too sure how to do that
467 # not too big a deal with planetlab as the driver is authoritative, but...
469 # update native relations
470 if isinstance(record, RegSlice):
471 researcher_hrns = getattr(new_record, 'reg-researchers', None)
472 if researcher_hrns is not None:
473 record.update_researchers (researcher_hrns, dbsession)
475 elif isinstance(record, RegAuthority):
476 pi_hrns = getattr(new_record, 'reg-pis', None)
477 if pi_hrns is not None:
478 record.update_pis(pi_hrns, dbsession)
479 name = getattr(new_record, 'name', None)
483 elif isinstance(record, RegUser):
484 email = getattr(new_record, 'email', None)
485 if email is not None:
488 # update the PLC information that was specified with the record
489 # xxx oddly enough, without this useless statement,
490 # record.__dict__ as received by the driver seems to be off
491 # anyway the driver should receive an object
492 # (and then extract __dict__ itself if needed)
493 print "DO NOT REMOVE ME before driver.update, record=%s"%record
496 (pointer, new_key_pointer) = api.driver.update (record.__dict__, new_record.__dict__, hrn, new_key)
499 if new_key and new_key_pointer:
500 record.reg_keys = [ RegKey (new_key, new_key_pointer)]
504 # update membership for researchers, pis, owners, operators
505 self.update_driver_relations(api, record, new_record)
509 # expecting an Xrn instance
510 def Remove(self, api, xrn, origin_hrn=None):
511 dbsession = api.dbsession()
514 request=dbsession.query(RegRecord).filter_by(hrn=hrn)
515 if type and type not in ['all', '*']:
516 request=request.filter_by(type=type)
518 record = request.first()
520 msg="Could not find hrn %s"%hrn
521 if type: msg += " type=%s"%type
522 raise RecordNotFound(msg)
525 if type not in ['slice', 'user', 'node', 'authority'] :
526 raise UnknownSfaType(type)
528 credential = api.getCredential()
529 registries = api.registries
531 # Try to remove the object from the PLCDB of federated agg.
532 # This is attempted before removing the object from the local agg's PLCDB and sfa table
533 if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
534 for registry in registries:
535 if registry not in [api.hrn]:
537 result=registries[registry].remove_peer_object(credential, record, origin_hrn)
541 # call testbed callback first
542 # IIUC this is done on the local testbed TOO because of the refreshpeer link
543 if not api.driver.remove(record.__dict__):
544 logger.warning("driver.remove failed")
547 dbsession.delete(record)
552 # This is a PLC-specific thing, won't work with other platforms
553 def get_key_from_incoming_ip (self, api):
554 dbsession = api.dbsession()
555 # verify that the callers's ip address exist in the db and is an interface
556 # for a node in the db
557 (ip, port) = api.remote_addr
558 interfaces = api.driver.shell.GetInterfaces({'ip': ip}, ['node_id'])
560 raise NonExistingRecord("no such ip %(ip)s" % locals())
561 nodes = api.driver.shell.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
563 raise NonExistingRecord("no such node using ip %(ip)s" % locals())
566 # look up the sfa record
567 record=dbsession.query(RegRecord).filter_by(type='node',pointer=node['node_id']).first()
569 raise RecordNotFound("node with pointer %s"%node['node_id'])
571 # generate a new keypair and gid
573 pkey = Keypair(create=True)
574 urn = hrn_to_urn(record.hrn, record.type)
576 email = getattr(record, 'email', None)
577 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey, email)
578 gid = gid_object.save_to_string(save_parents=True)
584 # attempt the scp the key
585 # and gid onto the node
586 # this will only work for planetlab based components
587 (kfd, key_filename) = tempfile.mkstemp()
588 (gfd, gid_filename) = tempfile.mkstemp()
589 pkey.save_to_file(key_filename)
590 gid_object.save_to_file(gid_filename, save_parents=True)
591 host = node['hostname']
592 key_dest="/etc/sfa/node.key"
593 gid_dest="/etc/sfa/node.gid"
595 #identity = "/etc/planetlab/root_ssh_key.rsa"
596 identity = "/etc/sfa/root_ssh_key"
597 scp_options=" -i %(identity)s " % locals()
598 scp_options+="-o StrictHostKeyChecking=no " % locals()
599 scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
601 scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
604 all_commands = [scp_key_command, scp_gid_command]
606 for command in all_commands:
607 (status, output) = commands.getstatusoutput(command)
609 raise Exception, output
611 for filename in [key_filename, gid_filename]: