3 # for get_key_from_incoming_ip
8 from sfa.util.faults import RecordNotFound, AccountNotEnabled, PermissionError, MissingAuthority, \
9 UnknownSfaType, ExistingRecord, NonExistingRecord
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.record import SfaRecord
22 from sfa.storage.table import SfaTable
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',
38 def GetCredential(self, api, xrn, type, is_self=False):
41 hrn = urn_to_hrn(xrn)[0]
43 hrn, type = urn_to_hrn(xrn)
45 # Is this a root or sub authority
46 auth_hrn = api.auth.get_authority(hrn)
47 if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
50 auth_info = api.auth.get_auth_info(auth_hrn)
52 records = table.findObjects({'type': type, 'hrn': hrn})
54 raise RecordNotFound(hrn)
57 # verify_cancreate_credential requires that the member lists
58 # (researchers, pis, etc) be filled in
59 self.driver.augment_records_with_testbed_info (record)
60 if not self.driver.is_enabled (record):
61 raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record['email']))
64 # if this is a self cred the record's gid is the caller's gid
67 caller_gid = record.get_gid_object()
69 caller_gid = api.auth.client_cred.get_gid_caller()
70 caller_hrn = caller_gid.get_hrn()
72 object_hrn = record.get_gid_object().get_hrn()
73 rights = api.auth.determine_user_rights(caller_hrn, record)
74 # make sure caller has rights to this object
76 raise PermissionError(caller_hrn + " has no rights to " + record['name'])
78 object_gid = GID(string=record['gid'])
79 new_cred = Credential(subject = object_gid.get_subject())
80 new_cred.set_gid_caller(caller_gid)
81 new_cred.set_gid_object(object_gid)
82 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
83 #new_cred.set_pubkey(object_gid.get_pubkey())
84 new_cred.set_privileges(rights)
85 new_cred.get_privileges().delegate_all_privileges(True)
86 if 'expires' in record:
87 new_cred.set_expiration(int(record['expires']))
88 auth_kind = "authority,ma,sa"
89 # Parent not necessary, verify with certs
90 #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
94 return new_cred.save_to_string(save_parents=True)
97 def Resolve(self, api, xrns, type=None, full=True):
99 if not isinstance(xrns, types.ListType):
101 # try to infer type if not set and we get a single input
103 type = Xrn(xrns).get_type()
104 hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
105 # load all known registry names into a prefix tree and attempt to find
106 # the longest matching prefix
107 # create a dict where key is a registry hrn and its value is a
108 # hrns at that registry (determined by the known prefix tree).
110 registries = api.registries
112 registry_hrns = registries.keys()
113 tree.load(registry_hrns)
115 registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
116 if registry_hrn not in xrn_dict:
117 xrn_dict[registry_hrn] = []
118 xrn_dict[registry_hrn].append(xrn)
121 for registry_hrn in xrn_dict:
122 # skip the hrn without a registry hrn
123 # XX should we let the user know the authority is unknown?
127 # if the best match (longest matching hrn) is not the local registry,
128 # forward the request
129 xrns = xrn_dict[registry_hrn]
130 if registry_hrn != api.hrn:
131 credential = api.getCredential()
132 interface = api.registries[registry_hrn]
133 server_proxy = api.server_proxy(interface, credential)
134 peer_records = server_proxy.Resolve(xrns, credential)
135 records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
137 # try resolving the remaining unfound records at the local registry
138 local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
141 local_records = table.findObjects({'hrn': local_hrns})
144 # in full mode we get as much info as we can, which involves contacting the
145 # testbed for getting implementation details about the record
146 self.driver.augment_records_with_testbed_info(local_records)
147 # also we fill the 'url' field for known authorities
148 # used to be in the driver code, sounds like a poorman thing though
149 def solve_neighbour_url (record):
150 if not record['type'].startswith('authority'): return
152 for neighbour_dict in [ api.aggregates, api.registries ]:
153 if hrn in neighbour_dict:
154 record['url']=neighbour_dict[hrn].get_url()
156 [ solve_neighbour_url (record) for record in local_records ]
160 # convert local record objects to dicts
161 records.extend([dict(record) for record in local_records])
163 records = filter(lambda rec: rec['type'] in [type], records)
166 raise RecordNotFound(str(hrns))
170 def List(self, api, xrn, origin_hrn=None):
171 hrn, type = urn_to_hrn(xrn)
172 # load all know registry names into a prefix tree and attempt to find
173 # the longest matching prefix
175 registries = api.registries
176 registry_hrns = registries.keys()
178 tree.load(registry_hrns)
179 registry_hrn = tree.best_match(hrn)
181 #if there was no match then this record belongs to an unknow registry
183 raise MissingAuthority(xrn)
184 # if the best match (longest matching hrn) is not the local registry,
185 # forward the request
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 record_list = server_proxy.List(xrn, credential)
192 records = [SfaRecord(dict=record).as_dict() for record in record_list]
194 # if we still have not found the record yet, try the local registry
196 if not api.auth.hierarchy.auth_exists(hrn):
197 raise MissingAuthority(hrn)
200 records = table.find({'authority': hrn})
205 def CreateGid(self, api, xrn, cert):
207 authority = Xrn(xrn=xrn).get_authority_hrn()
208 auth_info = api.auth.get_auth_info(authority)
210 pkey = Keypair(create=True)
212 certificate = Certificate(string=cert)
213 pkey = certificate.get_pubkey()
214 gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey)
215 return gid.save_to_string(save_parents=True)
218 # utility for handling relationships among the SFA objects
219 # given that the SFA db does not handle this sort of relationsships
220 # it will rely on side-effects in the testbed to keep this persistent
222 # subject_record describes the subject of the relationships
223 # ref_record contains the target values for the various relationships we need to manage
224 # (to begin with, this is just the slice x person relationship)
225 def update_relations (self, subject_record, ref_record):
226 type=subject_record['type']
228 self.update_relation(subject_record, 'researcher', ref_record.get('researcher'), 'user')
230 # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
231 # hrns is the list of hrns that should be linked to the subject from now on
232 # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
233 def update_relation (self, sfa_record, field_key, hrns, target_type):
234 # locate the linked objects in our db
235 subject_type=sfa_record['type']
236 subject_id=sfa_record['pointer']
238 link_sfa_records = table.find ({'type':target_type, 'hrn': hrns})
239 link_ids = [ rec.get('pointer') for rec in link_sfa_records ]
240 self.driver.update_relation (subject_type, target_type, subject_id, link_ids)
243 def Register(self, api, record):
245 hrn, type = record['hrn'], record['type']
246 urn = hrn_to_urn(hrn,type)
248 if type not in ['authority', 'slice', 'node', 'user']:
249 raise UnknownSfaType(type)
251 # check if record already exists
253 existing_records = table.find({'type': type, 'hrn': hrn})
255 raise ExistingRecord(hrn)
257 record = SfaRecord(dict = record)
258 record['authority'] = get_authority(record['hrn'])
259 auth_info = api.auth.get_auth_info(record['authority'])
261 # make sure record has a gid
262 if 'gid' not in record:
264 pkey = Keypair(create=True)
265 if 'keys' in record and record['keys']:
266 pub_key=record['keys']
267 # use only first key in record
268 if isinstance(record['keys'], types.ListType):
269 pub_key = record['keys'][0]
270 pkey = convert_public_key(pub_key)
272 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
273 gid = gid_object.save_to_string(save_parents=True)
277 if type in ["authority"]:
279 if not api.auth.hierarchy.auth_exists(hrn):
280 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
282 # get the GID from the newly created authority
283 gid = auth_info.get_gid_object()
284 record.set_gid(gid.save_to_string(save_parents=True))
286 # update testbed-specific data if needed
287 pointer = self.driver.register (record, hrn, pub_key)
289 record.set_pointer(pointer)
290 record_id = table.insert(record)
291 record['record_id'] = record_id
293 # update membership for researchers, pis, owners, operators
294 self.update_relations (record, record)
296 return record.get_gid_object().save_to_string(save_parents=True)
298 def Update(self, api, record_dict):
299 new_record = SfaRecord(dict = record_dict)
300 type = new_record['type']
301 hrn = new_record['hrn']
302 urn = hrn_to_urn(hrn,type)
304 # make sure the record exists
305 records = table.findObjects({'type': type, 'hrn': hrn})
307 raise RecordNotFound(hrn)
309 record['last_updated'] = time.gmtime()
312 if type not in ['authority', 'slice', 'node', 'user']:
313 raise UnknownSfaType(type)
315 # Use the pointer from the existing record, not the one that the user
316 # gave us. This prevents the user from inserting a forged pointer
317 pointer = record['pointer']
319 # is the a change in keys ?
322 if 'keys' in new_record and new_record['keys']:
323 new_key=new_record['keys']
324 if isinstance (new_key,types.ListType):
327 # update the PLC information that was specified with the record
328 if not self.driver.update (record, new_record, hrn, new_key):
329 logger.warning("driver.update failed")
331 # take new_key into account
333 # update the openssl key and gid
334 pkey = convert_public_key(new_key)
336 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
337 gid = gid_object.save_to_string(save_parents=True)
339 record = SfaRecord(dict=record)
342 # update membership for researchers, pis, owners, operators
343 self.update_relations (record, new_record)
347 # expecting an Xrn instance
348 def Remove(self, api, xrn, origin_hrn=None):
351 filter = {'hrn': xrn.get_hrn()}
354 if type and type not in ['all', '*']:
355 filter['type'] = type
357 records = table.find(filter)
358 if not records: raise RecordNotFound(hrn)
360 type = record['type']
362 if type not in ['slice', 'user', 'node', 'authority'] :
363 raise UnknownSfaType(type)
365 credential = api.getCredential()
366 registries = api.registries
368 # Try to remove the object from the PLCDB of federated agg.
369 # This is attempted before removing the object from the local agg's PLCDB and sfa table
370 if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
371 for registry in registries:
372 if registry not in [api.hrn]:
374 result=registries[registry].remove_peer_object(credential, record, origin_hrn)
378 # call testbed callback first
379 # IIUC this is done on the local testbed TOO because of the refreshpeer link
380 if not self.driver.remove(record):
381 logger.warning("driver.remove failed")
388 # This is a PLC-specific thing...
389 def get_key_from_incoming_ip (self, api):
390 # verify that the callers's ip address exist in the db and is an interface
391 # for a node in the db
392 (ip, port) = api.remote_addr
393 interfaces = self.driver.GetInterfaces({'ip': ip}, ['node_id'])
395 raise NonExistingRecord("no such ip %(ip)s" % locals())
396 nodes = self.driver.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
398 raise NonExistingRecord("no such node using ip %(ip)s" % locals())
401 # look up the sfa record
403 records = table.findObjects({'type': 'node', 'pointer': node['node_id']})
405 raise RecordNotFound("pointer:" + str(node['node_id']))
408 # generate a new keypair and gid
410 pkey = Keypair(create=True)
411 urn = hrn_to_urn(record['hrn'], record['type'])
412 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
413 gid = gid_object.save_to_string(save_parents=True)
420 # attempt the scp the key
421 # and gid onto the node
422 # this will only work for planetlab based components
423 (kfd, key_filename) = tempfile.mkstemp()
424 (gfd, gid_filename) = tempfile.mkstemp()
425 pkey.save_to_file(key_filename)
426 gid_object.save_to_file(gid_filename, save_parents=True)
427 host = node['hostname']
428 key_dest="/etc/sfa/node.key"
429 gid_dest="/etc/sfa/node.gid"
431 #identity = "/etc/planetlab/root_ssh_key.rsa"
432 identity = "/etc/sfa/root_ssh_key"
433 scp_options=" -i %(identity)s " % locals()
434 scp_options+="-o StrictHostKeyChecking=no " % locals()
435 scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
437 scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
440 all_commands = [scp_key_command, scp_gid_command]
442 for command in all_commands:
443 (status, output) = commands.getstatusoutput(command)
445 raise Exception, output
447 for filename in [key_filename, gid_filename]: