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.record import SfaRecord
12 from sfa.util.table import SfaTable
13 from sfa.util.xrn import Xrn, get_authority, hrn_to_urn, urn_to_hrn
14 from sfa.util.plxrn import hrn_to_pl_login_base
15 from sfa.util.version import version_core
16 from sfa.util.sfalogging import logger
18 from sfa.trust.gid import GID
19 from sfa.trust.credential import Credential
20 from sfa.trust.certificate import Certificate, Keypair, convert_public_key
21 from sfa.trust.gid import create_uuid
23 class RegistryManager:
25 def __init__ (self): pass
27 # The GENI GetVersion call
28 def GetVersion(self, api):
29 peers = dict ( [ (hrn,interface._ServerProxy__host) for (hrn,interface) in api.registries.iteritems()
32 return version_core({'interface':'registry',
37 def GetCredential(self, api, xrn, type, is_self=False):
40 hrn = urn_to_hrn(xrn)[0]
42 hrn, type = urn_to_hrn(xrn)
44 # Is this a root or sub authority
45 auth_hrn = api.auth.get_authority(hrn)
46 if not auth_hrn or hrn == api.config.SFA_INTERFACE_HRN:
49 auth_info = api.auth.get_auth_info(auth_hrn)
51 records = table.findObjects({'type': type, 'hrn': hrn})
53 raise RecordNotFound(hrn)
56 # verify_cancreate_credential requires that the member lists
57 # (researchers, pis, etc) be filled in
58 if not self.driver.is_enabled_entity (record):
59 raise AccountNotEnabled(": PlanetLab account %s is not enabled. Please contact your site PI" %(record['email']))
62 # if this is a self cred the record's gid is the caller's gid
65 caller_gid = record.get_gid_object()
67 caller_gid = api.auth.client_cred.get_gid_caller()
68 caller_hrn = caller_gid.get_hrn()
70 object_hrn = record.get_gid_object().get_hrn()
71 rights = api.auth.determine_user_rights(caller_hrn, record)
72 # make sure caller has rights to this object
74 raise PermissionError(caller_hrn + " has no rights to " + record['name'])
76 object_gid = GID(string=record['gid'])
77 new_cred = Credential(subject = object_gid.get_subject())
78 new_cred.set_gid_caller(caller_gid)
79 new_cred.set_gid_object(object_gid)
80 new_cred.set_issuer_keys(auth_info.get_privkey_filename(), auth_info.get_gid_filename())
81 #new_cred.set_pubkey(object_gid.get_pubkey())
82 new_cred.set_privileges(rights)
83 new_cred.get_privileges().delegate_all_privileges(True)
84 if 'expires' in record:
85 new_cred.set_expiration(int(record['expires']))
86 auth_kind = "authority,ma,sa"
87 # Parent not necessary, verify with certs
88 #new_cred.set_parent(api.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
92 return new_cred.save_to_string(save_parents=True)
95 def Resolve(self, api, xrns, type=None, full=True):
97 if not isinstance(xrns, types.ListType):
99 # try to infer type if not set and we get a single input
101 type = Xrn(xrns).get_type()
102 hrns = [urn_to_hrn(xrn)[0] for xrn in xrns]
103 # load all known registry names into a prefix tree and attempt to find
104 # the longest matching prefix
105 # create a dict where key is a registry hrn and its value is a
106 # hrns at that registry (determined by the known prefix tree).
108 registries = api.registries
110 registry_hrns = registries.keys()
111 tree.load(registry_hrns)
113 registry_hrn = tree.best_match(urn_to_hrn(xrn)[0])
114 if registry_hrn not in xrn_dict:
115 xrn_dict[registry_hrn] = []
116 xrn_dict[registry_hrn].append(xrn)
119 for registry_hrn in xrn_dict:
120 # skip the hrn without a registry hrn
121 # XX should we let the user know the authority is unknown?
125 # if the best match (longest matching hrn) is not the local registry,
126 # forward the request
127 xrns = xrn_dict[registry_hrn]
128 if registry_hrn != api.hrn:
129 credential = api.getCredential()
130 interface = api.registries[registry_hrn]
131 server_proxy = api.server_proxy(interface, credential)
132 peer_records = server_proxy.Resolve(xrns, credential)
133 records.extend([SfaRecord(dict=record).as_dict() for record in peer_records])
135 # try resolving the remaining unfound records at the local registry
136 local_hrns = list ( set(hrns).difference([record['hrn'] for record in records]) )
139 local_records = table.findObjects({'hrn': local_hrns})
142 # in full mode we get as much info as we can, which involves contacting the
143 # testbed for getting implementation details about the record
144 self.driver.fill_record_info(local_records)
145 # also we fill the 'url' field for known authorities
146 # used to be in the driver code, sounds like a poorman thing though
147 def solve_neighbour_url (record):
148 if not record['type'].startswith('authority'): return
150 for neighbour_dict in [ api.aggregates, api.registries ]:
151 if hrn in neighbour_dict:
152 record['url']=neighbour_dict[hrn].get_url()
154 [ solve_neighbour_url (record) for record in local_records ]
158 # convert local record objects to dicts
159 records.extend([dict(record) for record in local_records])
161 records = filter(lambda rec: rec['type'] in [type], records)
164 raise RecordNotFound(str(hrns))
168 def List(self, api, xrn, origin_hrn=None):
169 hrn, type = urn_to_hrn(xrn)
170 # load all know registry names into a prefix tree and attempt to find
171 # the longest matching prefix
173 registries = api.registries
174 registry_hrns = registries.keys()
176 tree.load(registry_hrns)
177 registry_hrn = tree.best_match(hrn)
179 #if there was no match then this record belongs to an unknow registry
181 raise MissingAuthority(xrn)
182 # if the best match (longest matching hrn) is not the local registry,
183 # forward the request
185 if registry_hrn != api.hrn:
186 credential = api.getCredential()
187 interface = api.registries[registry_hrn]
188 server_proxy = api.server_proxy(interface, credential)
189 record_list = server_proxy.List(xrn, credential)
190 records = [SfaRecord(dict=record).as_dict() for record in record_list]
192 # if we still have not found the record yet, try the local registry
194 if not api.auth.hierarchy.auth_exists(hrn):
195 raise MissingAuthority(hrn)
198 records = table.find({'authority': hrn})
203 def CreateGid(self, api, xrn, cert):
205 authority = Xrn(xrn=xrn).get_authority_hrn()
206 auth_info = api.auth.get_auth_info(authority)
208 pkey = Keypair(create=True)
210 certificate = Certificate(string=cert)
211 pkey = certificate.get_pubkey()
212 gid = api.auth.hierarchy.create_gid(xrn, create_uuid(), pkey)
213 return gid.save_to_string(save_parents=True)
215 # utility for handling relationships among the SFA objects
216 # given that the SFA db does not handle this sort of relationsships
217 # it will rely on side-effects in the testbed to keep this persistent
218 # field_key is the name of one field in the record, typically 'researcher' for a 'slice' record
219 # hrns is the list of hrns that should be linked to the subject from now on
220 # target_type would be e.g. 'user' in the 'slice' x 'researcher' example
221 def update_relation (self, sfa_record, field_key, hrns, target_type):
222 # locate the linked objects in our db
223 subject_type=sfa_record['type']
224 subject_id=sfa_record['pointer']
226 link_sfa_records = table.find ({'type':target_type, 'hrn': hrns})
227 link_ids = [ rec.get('pointer') for rec in link_sfa_records ]
228 self.driver.update_relation (subject_type, target_type, subject_id, link_ids)
231 def Register(self, api, record):
233 hrn, type = record['hrn'], record['type']
234 urn = hrn_to_urn(hrn,type)
236 if type not in ['authority', 'slice', 'node', 'user']:
237 raise UnknownSfaType(type)
239 # check if record already exists
241 existing_records = table.find({'type': type, 'hrn': hrn})
243 raise ExistingRecord(hrn)
245 record = SfaRecord(dict = record)
246 record['authority'] = get_authority(record['hrn'])
247 auth_info = api.auth.get_auth_info(record['authority'])
249 # make sure record has a gid
250 if 'gid' not in record:
252 pkey = Keypair(create=True)
253 if 'keys' in record and record['keys']:
254 pub_key=record['keys']
255 # use only first key in record
256 if isinstance(record['keys'], types.ListType):
257 pub_key = record['keys'][0]
258 pkey = convert_public_key(pub_key)
260 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
261 gid = gid_object.save_to_string(save_parents=True)
265 if type in ["authority"]:
267 if not api.auth.hierarchy.auth_exists(hrn):
268 api.auth.hierarchy.create_auth(hrn_to_urn(hrn,'authority'))
270 # get the GID from the newly created authority
271 gid = auth_info.get_gid_object()
272 record.set_gid(gid.save_to_string(save_parents=True))
274 # update testbed-specific data f needed
275 logger.info("Getting driver from manager=%s"%self)
276 pointer = self.driver.register (record, hrn, pub_key)
278 record.set_pointer(pointer)
279 record_id = table.insert(record)
280 record['record_id'] = record_id
282 # update membership for researchers, pis, owners, operators
283 self.update_relation(record, 'researcher', record.get('researcher'), 'user')
285 return record.get_gid_object().save_to_string(save_parents=True)
287 def Update(self, 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)
293 # make sure the record exists
294 records = table.findObjects({'type': type, 'hrn': hrn})
296 raise RecordNotFound(hrn)
298 record['last_updated'] = time.gmtime()
301 if type not in ['authority', 'slice', 'node', 'user']:
302 raise UnknownSfaType(type)
304 # Use the pointer from the existing record, not the one that the user
305 # gave us. This prevents the user from inserting a forged pointer
306 pointer = record['pointer']
308 # is the a change in keys ?
311 if 'keys' in new_record and new_record['keys']:
312 new_key=new_record['keys']
313 if isinstance (new_key,types.ListType):
316 # update the PLC information that was specified with the record
317 if not self.driver.update (record, new_record, hrn, new_key):
318 logger.warning("driver.update failed")
320 # take new_key into account
322 # update the openssl key and gid
323 pkey = convert_public_key(new_key)
325 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
326 gid = gid_object.save_to_string(save_parents=True)
328 record = SfaRecord(dict=record)
331 # update membership for researchers, pis, owners, operators
332 self.update_relation(record, 'researcher', new_record.get('researcher'), 'user')
336 # expecting an Xrn instance
337 def Remove(self, api, xrn, origin_hrn=None):
340 filter = {'hrn': xrn.get_hrn()}
343 if type and type not in ['all', '*']:
344 filter['type'] = type
346 records = table.find(filter)
347 if not records: raise RecordNotFound(hrn)
349 type = record['type']
351 if type not in ['slice', 'user', 'node', 'authority'] :
352 raise UnknownSfaType(type)
354 credential = api.getCredential()
355 registries = api.registries
357 # Try to remove the object from the PLCDB of federated agg.
358 # This is attempted before removing the object from the local agg's PLCDB and sfa table
359 if hrn.startswith(api.hrn) and type in ['user', 'slice', 'authority']:
360 for registry in registries:
361 if registry not in [api.hrn]:
363 result=registries[registry].remove_peer_object(credential, record, origin_hrn)
367 # call testbed callback first
368 # IIUC this is done on the local testbed TOO because of the refreshpeer link
369 if not self.driver.remove(record):
370 logger.warning("driver.remove failed")
377 # This is a PLC-specific thing...
378 def get_key_from_incoming_ip (self, api):
379 # verify that the callers's ip address exist in the db and is an interface
380 # for a node in the db
381 (ip, port) = api.remote_addr
382 interfaces = self.driver.GetInterfaces({'ip': ip}, ['node_id'])
384 raise NonExistingRecord("no such ip %(ip)s" % locals())
385 nodes = self.driver.GetNodes([interfaces[0]['node_id']], ['node_id', 'hostname'])
387 raise NonExistingRecord("no such node using ip %(ip)s" % locals())
390 # look up the sfa record
392 records = table.findObjects({'type': 'node', 'pointer': node['node_id']})
394 raise RecordNotFound("pointer:" + str(node['node_id']))
397 # generate a new keypair and gid
399 pkey = Keypair(create=True)
400 urn = hrn_to_urn(record['hrn'], record['type'])
401 gid_object = api.auth.hierarchy.create_gid(urn, uuid, pkey)
402 gid = gid_object.save_to_string(save_parents=True)
409 # attempt the scp the key
410 # and gid onto the node
411 # this will only work for planetlab based components
412 (kfd, key_filename) = tempfile.mkstemp()
413 (gfd, gid_filename) = tempfile.mkstemp()
414 pkey.save_to_file(key_filename)
415 gid_object.save_to_file(gid_filename, save_parents=True)
416 host = node['hostname']
417 key_dest="/etc/sfa/node.key"
418 gid_dest="/etc/sfa/node.gid"
420 #identity = "/etc/planetlab/root_ssh_key.rsa"
421 identity = "/etc/sfa/root_ssh_key"
422 scp_options=" -i %(identity)s " % locals()
423 scp_options+="-o StrictHostKeyChecking=no " % locals()
424 scp_key_command="%(scp)s %(scp_options)s %(key_filename)s root@%(host)s:%(key_dest)s" %\
426 scp_gid_command="%(scp)s %(scp_options)s %(gid_filename)s root@%(host)s:%(gid_dest)s" %\
429 all_commands = [scp_key_command, scp_gid_command]
431 for command in all_commands:
432 (status, output) = commands.getstatusoutput(command)
434 raise Exception, output
436 for filename in [key_filename, gid_filename]: