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.plxrn import hrn_to_pl_login_base
13 from sfa.util.version import version_core
14 from sfa.util.sfalogging import logger
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
21 from sfa.storage.model import make_record, RegRecord, RegAuthority, RegUser, RegSlice, RegKey
22 from sfa.storage.alchemy import dbsession
24 class RegistryManager:
26 def __init__ (self, config): pass
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()
33 return version_core({'interface':'registry',
40 def GetCredential(self, api, xrn, type, caller_xrn=None):
43 hrn = urn_to_hrn(xrn)[0]
45 hrn, type = urn_to_hrn(xrn)
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:
51 auth_info = api.auth.get_auth_info(auth_hrn)
53 record=dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
55 raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
57 # verify_cancreate_credential requires that the member lists
58 # (researchers, pis, etc) be filled in
59 logger.debug("get credential before augment dict, keys=%s"%record.__dict__.keys())
60 self.driver.augment_records_with_testbed_info (record.__dict__)
61 logger.debug("get credential after augment dict, keys=%s"%record.__dict__.keys())
62 if not self.driver.is_enabled (record.__dict__):
63 raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record.email))
66 # if caller_xrn is not specified assume the caller is the record
70 caller_gid = record.get_gid_object()
72 caller_hrn, caller_type = urn_to_hrn(caller_xrn)
73 caller_record = dbsession.query(RegRecord).filter_by(hrn=caller_hrn).first()
75 caller_record = caller_record.filter_by(type=caller_type)
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)
80 object_hrn = record.get_gid_object().get_hrn()
81 rights = api.auth.determine_user_rights(caller_hrn, record.__dict__)
82 # make sure caller has rights to this object
84 raise PermissionError("%s has no rights to %s (%s)" % \
85 (caller_hrn, object_hrn, xrn))
86 object_gid = GID(string=record.gid)
87 new_cred = Credential(subject = object_gid.get_subject())
88 new_cred.set_gid_caller(caller_gid)
89 new_cred.set_gid_object(object_gid)
90 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
91 #new_cred.set_pubkey(object_gid.get_pubkey())
92 new_cred.set_privileges(rights)
93 new_cred.get_privileges().delegate_all_privileges(True)
94 if hasattr(record,'expires'):
95 date = utcparse(record.expires)
96 expires = datetime_to_epoch(date)
97 new_cred.set_expiration(int(expires))
98 auth_kind = "authority,ma,sa"
99 # Parent not necessary, verify with certs
100 #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
104 return new_cred.save_to_string(save_parents=True)
107 def Resolve(self, api, xrns, type=None, full=True):
109 if not isinstance(xrns, types.ListType):
110 # try to infer type if not set and we get a single input
112 type = Xrn(xrns).get_type()
114 hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
116 # load all known registry names into a prefix tree and attempt to find
117 # the longest matching prefix
118 # create a dict where key is a registry hrn and its value is a list
119 # of hrns at that registry (determined by the known prefix tree).
121 registries = api.registries
123 registry_hrns = registries.keys()
124 tree.load(registry_hrns)
126 registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
127 if registry_hrn not in xrn_dict:
128 xrn_dict[registry_hrn] = []
129 xrn_dict[registry_hrn].append(xrn)
132 for registry_hrn in xrn_dict:
133 # skip the hrn without a registry hrn
134 # XX should we let the user know the authority is unknown?
138 # if the best match (longest matching hrn) is not the local registry,
139 # forward the request
140 xrns = xrn_dict[registry_hrn]
141 if registry_hrn != api.hrn:
142 credential = api.getCredential()
143 interface = api.registries[registry_hrn]
144 server_proxy = api.server_proxy(interface, credential)
145 peer_records = server_proxy.Resolve(xrns, credential,type)
146 # pass foreign records as-is
147 # previous code used to read
148 # records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
149 # not sure why the records coming through xmlrpc had to be processed at all
150 records.extend(peer_records)
152 # try resolving the remaining unfound records at the local registry
153 local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
155 local_records = dbsession.query(RegRecord).filter(RegRecord.hrn.in_(local_hrns))
157 local_records = local_records.filter_by(type=type)
158 local_records=local_records.all()
159 logger.info("Resolve: local_records=%s (type=%s)"%(local_records,type))
160 local_dicts = [ record.__dict__ for record in local_records ]
163 # in full mode we get as much info as we can, which involves contacting the
164 # testbed for getting implementation details about the record
165 self.driver.augment_records_with_testbed_info(local_dicts)
166 # also we fill the 'url' field for known authorities
167 # used to be in the driver code, sounds like a poorman thing though
168 def solve_neighbour_url (record):
169 if not record.type.startswith('authority'): return
171 for neighbour_dict in [ api.aggregates, api.registries ]:
172 if hrn in neighbour_dict:
173 record.url=neighbour_dict[hrn].get_url()
175 for record in local_records: solve_neighbour_url (record)
177 # convert local record objects to dicts for xmlrpc
178 # xxx somehow here calling dict(record) issues a weird error
179 # however record.todict() seems to work fine
180 # records.extend( [ dict(record) for record in local_records ] )
181 records.extend( [ record.todict() for record in local_records ] )
183 raise RecordNotFound(str(hrns))
187 def List (self, api, xrn, origin_hrn=None):
188 hrn, type = urn_to_hrn(xrn)
189 # load all know registry names into a prefix tree and attempt to find
190 # the longest matching prefix
191 registries = api.registries
192 registry_hrns = registries.keys()
194 tree.load(registry_hrns)
195 registry_hrn = tree.best_match(hrn)
197 #if there was no match then this record belongs to an unknow registry
199 raise MissingAuthority(xrn)
200 # if the best match (longest matching hrn) is not the local registry,
201 # forward the request
203 if registry_hrn != api.hrn:
204 credential = api.getCredential()
205 interface = api.registries[registry_hrn]
206 server_proxy = api.server_proxy(interface, credential)
207 record_list = server_proxy.List(xrn, credential)
208 # same as above, no need to process what comes from through xmlrpc
209 # pass foreign records as-is
210 record_dicts = record_list
212 # if we still have not found the record yet, try the local registry
214 if not api.auth.hierarchy.auth_exists(hrn):
215 raise MissingAuthority(hrn)
216 records = dbsession.query(RegRecord).filter_by(authority=hrn)
217 record_dicts=[ record.todict() for record in records ]
222 def CreateGid(self, api, xrn, cert):
224 authority = Xrn(xrn=xrn).get_authority_hrn()
225 auth_info = api.auth.get_auth_info(authority)
227 pkey = Keypair(create=True)
229 certificate = Certificate(string=cert)
230 pkey = certificate.get_pubkey()
231 gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey)
232 return gid.save_to_string(save_parents=True)
235 # utility for handling relationships among the SFA objects
236 # given that the SFA db does not handle this sort of relationsships
237 # it will rely on side-effects in the testbed to keep this persistent
239 # subject_record describes the subject of the relationships
240 # ref_record contains the target values for the various relationships we need to manage
241 # (to begin with, this is just the slice x person relationship)
242 def update_relations (self, subject_obj, ref_obj):
243 type=subject_obj.type
245 self.update_relation(subject_obj, 'researcher', ref_obj.researcher, 'user')
247 # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
248 # hrns is the list of hrns that should be linked to the subject from now on
249 # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
250 def update_relation (self, record_obj, field_key, hrns, target_type):
251 # locate the linked objects in our db
252 subject_type=record_obj.type
253 subject_id=record_obj.pointer
254 # get the 'pointer' field of all matching records
255 link_id_tuples = dbsession.query(RegRecord.pointer).filter_by(type=target_type).filter(RegRecord.hrn.in_(hrns)).all()
256 # sqlalchemy returns named tuples for columns
257 link_ids = [ tuple.pointer for tuple in link_id_tuples ]
258 self.driver.update_relation (subject_type, target_type, subject_id, link_ids)
260 def Register(self, api, record_dict):
262 hrn, type = record_dict['hrn'], record_dict['type']
263 urn = hrn_to_urn(hrn,type)
265 if type not in ['authority', 'slice', 'node', 'user']:
266 raise UnknownSfaType(type)
268 # check if record_dict already exists
269 existing_records = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).all()
271 raise ExistingRecord(hrn)
273 assert ('type' in record_dict)
274 # returns the right type of RegRecord according to type in record
275 record = make_record(dict=record_dict)
276 record.just_created()
277 record.authority = get_authority(record.hrn)
278 auth_info = api.auth.get_auth_info(record.authority)
280 # make sure record has a gid
283 pkey = Keypair(create=True)
284 if getattr(record,'keys',None):
286 # use only first key in record
287 if isinstance(record.keys, types.ListType):
288 pub_key = record.keys[0]
289 pkey = convert_public_key(pub_key)
291 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
292 gid = gid_object.save_to_string(save_parents=True)
295 if isinstance (record, RegAuthority):
297 if not api.auth.hierarchy.auth_exists(hrn):
298 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
300 # get the GID from the newly created authority
301 gid = auth_info.get_gid_object()
302 record.gid=gid.save_to_string(save_parents=True)
304 elif isinstance (record, RegSlice):
305 # locate objects for relationships
306 if hasattr (record, 'researcher'):
307 # we get the list of researcher hrns as
308 researcher_hrns = record.researcher
309 # strip that in case we have <researcher> words </researcher>
310 researcher_hrns = [ x.strip() for x in researcher_hrns ]
311 logger.info ("incoming researchers %s"%researcher_hrns)
312 request = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns))
313 logger.info ("%d incoming hrns, %d matches found"%(len(researcher_hrns),request.count()))
314 researchers = dbsession.query (RegUser).filter(RegUser.hrn.in_(researcher_hrns)).all()
315 record.reg_researchers = researchers
317 elif isinstance (record, RegUser):
318 # create RegKey objects for incoming keys
319 if hasattr(record,'keys'):
320 logger.debug ("creating %d keys for user %s"%(len(record.keys),record.hrn))
321 record.reg_keys = [ RegKey (key) for key in record.keys ]
323 # update testbed-specific data if needed
324 pointer = self.driver.register (record.__dict__, hrn, pub_key)
326 record.pointer=pointer
327 dbsession.add(record)
330 # update membership for researchers, pis, owners, operators
331 self.update_relations (record, record)
333 return record.get_gid_object().save_to_string(save_parents=True)
335 def Update(self, api, record_dict):
336 assert ('type' in record_dict)
337 new_record=RegRecord(dict=record_dict)
338 type = new_record.type
341 # make sure the record exists
342 record = dbsession.query(RegRecord).filter_by(type=type,hrn=hrn).first()
344 raise RecordNotFound("hrn=%s, type=%s"%(hrn,type))
345 record.just_updated()
348 if type not in ['authority', 'slice', 'node', 'user']:
349 raise UnknownSfaType(type)
351 # Use the pointer from the existing record, not the one that the user
352 # gave us. This prevents the user from inserting a forged pointer
353 pointer = record.pointer
355 # is the a change in keys ?
358 if getattr(new_key,'keys',None):
359 new_key=new_record.keys
360 if isinstance (new_key,types.ListType):
363 # update the PLC information that was specified with the record
364 if not self.driver.update (record.__dict__, new_record.__dict__, hrn, new_key):
365 logger.warning("driver.update failed")
367 # take new_key into account
369 # update the openssl key and gid
370 pkey = convert_public_key(new_key)
372 urn = hrn_to_urn(hrn,type)
373 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
374 gid = gid_object.save_to_string(save_parents=True)
378 # update membership for researchers, pis, owners, operators
379 self.update_relations (record, new_record)
383 # expecting an Xrn instance
384 def Remove(self, api, xrn, origin_hrn=None):
387 request=dbsession.query(RegRecord).filter_by(hrn=hrn)
388 if type and type not in ['all', '*']:
389 request=request.filter_by(type=type)
391 record = request.first()
393 msg="Could not find hrn %s"%hrn
394 if type: msg += " type=%s"%type
395 raise RecordNotFound(msg)
398 if type not in ['slice', 'user', 'node', 'authority'] :
399 raise UnknownSfaType(type)
401 credential = api.getCredential()
402 registries = api.registries
404 # Try to remove the object from the PLCDB of federated agg.
405 # This is attempted before removing the object from the local agg's PLCDB and sfa table
406 if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
407 for registry in registries:
408 if registry not in [api.hrn]:
410 result=registries[registry].remove_peer_object(credential, record, origin_hrn)
414 # call testbed callback first
415 # IIUC this is done on the local testbed TOO because of the refreshpeer link
416 if not self.driver.remove(record.__dict__):
417 logger.warning("driver.remove failed")
420 dbsession.delete(record)
425 # This is a PLC-specific thing, won't work with other platforms
426 def get_key_from_incoming_ip (self, api):
427 # verify that the callers's ip address exist in the db and is an interface
428 # for a node in the db
429 (ip, port) = api.remote_addr
430 interfaces = self.driver.shell.GetInterfaces({'ip': ip}, ['node_id'])
432 raise NonExistingRecord("no such ip %(ip)s" % locals())
433 nodes = self.driver.shell.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
435 raise NonExistingRecord("no such node using ip %(ip)s" % locals())
438 # look up the sfa record
439 record=dbsession.query(RegRecord).filter_by(type='node',pointer=node['node_id']).first()
441 raise RecordNotFound("node with pointer %s"%node['node_id'])
443 # generate a new keypair and gid
445 pkey = Keypair(create=True)
446 urn = hrn_to_urn(record.hrn, record.type)
447 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
448 gid = gid_object.save_to_string(save_parents=True)
454 # attempt the scp the key
455 # and gid onto the node
456 # this will only work for planetlab based components
457 (kfd, key_filename) = tempfile.mkstemp()
458 (gfd, gid_filename) = tempfile.mkstemp()
459 pkey.save_to_file(key_filename)
460 gid_object.save_to_file(gid_filename, save_parents=True)
461 host = node['hostname']
462 key_dest="/etc/sfa/node.key"
463 gid_dest="/etc/sfa/node.gid"
465 #identity = "/etc/planetlab/root_ssh_key.rsa"
466 identity = "/etc/sfa/root_ssh_key"
467 scp_options=" -i %(identity)s " % locals()
468 scp_options+="-o StrictHostKeyChecking=no " % locals()
469 scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
471 scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
474 all_commands = [scp_key_command, scp_gid_command]
476 for command in all_commands:
477 (status, output) = commands.getstatusoutput(command)
479 raise Exception, output
481 for filename in [key_filename, gid_filename]: