2 # Geniwrapper XML-RPC and SOAP interfaces
14 from sfa.trust.auth import Auth
15 from sfa.util.config import *
16 from sfa.util.faults import *
17 from sfa.util.debug import *
18 from sfa.trust.rights import *
19 from sfa.trust.credential import *
20 from sfa.trust.certificate import *
21 from sfa.util.misc import *
22 from sfa.util.sfalogging import *
23 from sfa.util.genitable import *
25 # See "2.2 Characters" in the XML specification:
27 # #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
29 # [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
31 invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F))
32 xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii))
34 def xmlrpclib_escape(s, replace = string.replace):
36 xmlrpclib does not handle invalid 7-bit control characters. This
37 function augments xmlrpclib.escape, which by default only replaces
38 '&', '<', and '>' with entities.
41 # This is the standard xmlrpclib.escape function
42 s = replace(s, "&", "&")
43 s = replace(s, "<", "<")
44 s = replace(s, ">", ">",)
46 # Replace invalid 7-bit control characters with '?'
47 return s.translate(xml_escape_table)
49 def xmlrpclib_dump(self, value, write):
51 xmlrpclib cannot marshal instances of subclasses of built-in
52 types. This function overrides xmlrpclib.Marshaller.__dump so that
53 any value that is an instance of one of its acceptable types is
54 marshalled as that type.
56 xmlrpclib also cannot handle invalid 7-bit control characters. See
60 # Use our escape function
61 args = [self, value, write]
62 if isinstance(value, (str, unicode)):
63 args.append(xmlrpclib_escape)
66 # Try for an exact match first
67 f = self.dispatch[type(value)]
70 # Try for an isinstance() match
71 for Type, f in self.dispatch.iteritems():
72 if isinstance(value, Type):
75 raise TypeError, "cannot marshal %s objects" % type(value)
79 # You can't hide from me!
80 xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
82 # SOAP support is optional
85 from SOAPpy.Parser import parseSOAPRPC
86 from SOAPpy.Types import faultType
87 from SOAPpy.NS import NS
88 from SOAPpy.SOAPBuilder import buildSOAP
93 def import_deep(name):
94 mod = __import__(name)
95 components = name.split('.')
96 for comp in components[1:]:
97 mod = getattr(mod, comp)
102 # flat list of method names
104 methods = sfa.methods.all
106 def __init__(self, config = "/etc/sfa/sfa_config", encoding = "utf-8",
107 peer_cert = None, interface = None, key_file = None, cert_file = None):
108 self.encoding = encoding
110 # Better just be documenting the API
115 self.config = Config(config)
116 self.auth = Auth(peer_cert)
117 self.interface = interface
118 self.key_file = key_file
119 self.key = Keypair(filename=self.key_file)
120 self.cert_file = cert_file
121 self.cert = Certificate(filename=self.cert_file)
122 self.credential = None
124 # Initialize the PLC shell only if SFA wraps a myPLC
125 rspec_type = self.config.get_aggregate_rspec_type()
126 if (rspec_type == 'pl' or rspec_type == 'vini'):
127 self.plshell = self.getPLCShell()
128 self.plshell_version = self.getPLCShellVersion()
130 self.hrn = self.config.SFA_INTERFACE_HRN
131 self.time_format = "%Y-%m-%d %H:%M:%S"
132 self.logger=get_sfa_logger()
134 def getPLCShell(self):
135 self.plauth = {'Username': self.config.SFA_PLC_USER,
136 'AuthMethod': 'password',
137 'AuthString': self.config.SFA_PLC_PASSWORD}
139 self.plshell_type = 'direct'
141 shell = PLC.Shell.Shell(globals = globals())
142 shell.AuthCheck(self.plauth)
145 self.plshell_type = 'xmlrpc'
147 url = self.config.SFA_PLC_URL
148 shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
149 shell.AuthCheck(self.plauth)
152 def getPLCShellVersion(self):
153 # We need to figure out what version of PLCAPI we are talking to.
154 # Some calls we need to make later will be different depending on
157 # This is probably a bad way to determine api versions
158 # but its easy and will work for now. Lets try to make
159 # a call that only exists is PLCAPI.4.3. If it fails, we
160 # can assume the api version is 4.2
161 self.plshell.GetTagTypes(self.plauth)
167 def getCredential(self):
168 if self.interface in ['registry']:
169 return self.getCredentialFromLocalRegistry()
171 return self.getCredentialFromRegistry()
173 def getCredentialFromRegistry(self):
175 Get our credential from a remote registry using a geniclient connection
178 path = self.config.SFA_BASE_DIR
179 filename = ".".join([self.interface, self.hrn, type, "cred"])
180 cred_filename = path + os.sep + filename
182 credential = Credential(filename = cred_filename)
183 return credential.save_to_string(save_parents=True)
185 from sfa.server.registry import Registries
186 registries = Registries(self)
187 registry = registries[self.hrn]
188 # get self credential
189 arg_list = [None,type,self.hrn]
190 request_hash=self.key.compute_hash(arg_list)
191 self_cred = registry.get_credential(None, type, self.hrn, request_hash)
193 arg_list = [self_cred,type,self.hrn]
194 request_hash=self.key.compute_hash(arg_list)
195 cred = registry.get_credential(self_cred, type, self.hrn, request_hash)
198 Credential(string=cred).save_to_file(cred_filename, save_parents=True)
201 def getCredentialFromLocalRegistry(self):
203 Get our current credential directly from the local registry.
207 auth_hrn = self.auth.get_authority(hrn)
209 # is this a root or sub authority
210 if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
212 auth_info = self.auth.get_auth_info(auth_hrn)
214 records = table.findObjects(hrn)
218 type = record['type']
219 object_gid = record.get_gid_object()
220 new_cred = Credential(subject = object_gid.get_subject())
221 new_cred.set_gid_caller(object_gid)
222 new_cred.set_gid_object(object_gid)
223 new_cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
224 new_cred.set_pubkey(object_gid.get_pubkey())
225 r1 = determine_rights(type, hrn)
226 new_cred.set_privileges(r1)
228 auth_kind = "authority,ma,sa"
230 new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
235 return new_cred.save_to_string(save_parents=True)
238 def loadCredential (self):
240 Attempt to load credential from file if it exists. If it doesnt get
241 credential from registry.
244 # see if this file exists
245 # XX This is really the aggregate's credential. Using this is easier than getting
246 # the registry's credential from iteslf (ssl errors).
247 ma_cred_filename = self.config.SFA_BASE_DIR + os.sep + self.interface + self.hrn + ".ma.cred"
249 self.credential = Credential(filename = ma_cred_filename)
251 self.credential = self.getCredentialFromRegistry()
254 # Convert geni fields to PLC fields for use when registering up updating
255 # registry record in the PLC database
257 # @param type type of record (user, slice, ...)
258 # @param hrn human readable name
259 # @param geni_fields dictionary of geni fields
260 # @param pl_fields dictionary of PLC fields (output)
262 def geni_fields_to_pl_fields(self, type, hrn, record):
264 def convert_ints(tmpdict, int_fields):
265 for field in int_fields:
267 tmpdict[field] = int(tmpdict[field])
270 #for field in record:
271 # pl_record[field] = record[field]
274 if not "instantiation" in pl_record:
275 pl_record["instantiation"] = "plc-instantiated"
276 pl_record["name"] = hrn_to_pl_slicename(hrn)
278 pl_record["url"] = record["url"]
279 if "description" in record:
280 pl_record["description"] = record["description"]
283 if not "hostname" in pl_record:
284 if not "hostname" in record:
285 raise MissingGeniInfo("hostname")
286 pl_record["hostname"] = record["hostname"]
287 if not "model" in pl_record:
288 pl_record["model"] = "geni"
290 elif type == "authority":
291 pl_record["login_base"] = hrn_to_pl_login_base(hrn)
293 if not "name" in pl_record:
294 pl_record["name"] = hrn
296 if not "abbreviated_name" in pl_record:
297 pl_record["abbreviated_name"] = hrn
299 if not "enabled" in pl_record:
300 pl_record["enabled"] = True
302 if not "is_public" in pl_record:
303 pl_record["is_public"] = True
307 def fill_record_pl_info(self, record):
309 Fill in the planetlab specific fields of a Geni record. This
310 involves calling the appropriate PLC method to retrieve the
311 database record for the object.
313 PLC data is filled into the pl_info field of the record.
315 @param record: record to fill in field (in/out param)
317 type = record['type']
318 pointer = record['pointer']
321 # records with pointer==-1 do not have plc info associated with them.
322 # for example, the top level authority records which are
323 # authorities, but not PL "sites"
328 if (type in ["authority"]):
329 pl_res = self.plshell.GetSites(self.plauth, [pointer])
330 elif (type == "slice"):
331 pl_res = self.plshell.GetSlices(self.plauth, [pointer])
332 elif (type == "user"):
333 pl_res = self.plshell.GetPersons(self.plauth, [pointer])
334 elif (type == "node"):
335 pl_res = self.plshell.GetNodes(self.plauth, [pointer])
337 raise UnknownGeniType(type)
340 raise PlanetLabRecordDoesNotExist(record['hrn'])
342 # convert ids to hrns
343 pl_record = pl_res[0]
344 if 'site_id' in pl_record:
345 sites = self.plshell.GetSites(self.plauth, pl_record['site_id'], ['login_base'])
347 login_base = site['login_base']
348 pl_record['site'] = ".".join([auth_hrn, login_base])
349 if 'person_ids' in pl_record:
350 persons = self.plshell.GetPersons(self.plauth, pl_record['person_ids'], ['email'])
351 emails = [person['email'] for person in persons]
352 usernames = [email.split('@')[0] for email in emails]
353 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
354 pl_record['persons'] = person_hrns
355 if 'slice_ids' in pl_record:
356 slices = self.plshell.GetSlices(self.plauth, pl_record['slice_ids'], ['name'])
357 slicenames = [slice['name'] for slice in slices]
358 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
359 pl_record['slices'] = slice_hrns
360 if 'node_ids' in pl_record:
361 nodes = self.plshell.GetNodes(self.plauth, pl_record['node_ids'], ['hostname'])
362 hostnames = [node['hostname'] for node in nodes]
363 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
364 pl_record['nodes'] = node_hrns
365 if 'site_ids' in pl_record:
366 sites = self.plshell.GetSites(self.plauth, pl_record['site_ids'], ['login_base'])
367 login_bases = [site['login_base'] for site in sites]
368 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
369 pl_record['sites'] = site_hrns
370 if 'key_ids' in pl_record:
371 keys = self.plshell.GetKeys(self.plauth, pl_record['key_ids'])
374 pubkeys = [key['key'] for key in keys]
375 pl_record['keys'] = pubkeys
377 record.update(pl_record)
381 def fill_record_geni_info(self, record):
383 type = record['type']
385 if (type == "slice"):
386 person_ids = record.get("person_ids", [])
387 persons = table.find({'type': 'user', 'pointer': person_ids})
388 researchers = [person['hrn'] for person in persons]
389 geni_info['researcher'] = researchers
391 elif (type == "authority"):
392 person_ids = record.get("person_ids", [])
393 persons = table.find({'type': 'user', 'pointer': person_ids})
395 for person in persons:
396 persons_dict[person['pointer']] = person
397 pl_persons = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'roles'])
398 pis, techs, admins = [], [], []
399 for person in pl_persons:
400 pointer = person['person_id']
402 if pointer not in persons_dict:
403 # this means there is not sfa record for this user
405 hrn = persons_dict[pointer]['hrn']
406 if 'pi' in person['roles']:
408 if 'tech' in person['roles']:
410 if 'admin' in person['roles']:
413 geni_info['PI'] = pis
414 geni_info['operator'] = techs
415 geni_info['owner'] = admins
416 # xxx TODO: OrganizationName
418 elif (type == "node"):
419 geni_info['dns'] = record.get("hostname", "")
420 # xxx TODO: URI, LatLong, IP, DNS
422 elif (type == "user"):
423 geni_info['email'] = record.get("email", "")
424 # xxx TODO: PostalAddress, Phone
426 record.update(geni_info)
428 def fill_record_info(self, record):
430 Given a geni record, fill in the PLC specific and Geni specific
431 fields in the record.
433 self.fill_record_pl_info(record)
434 self.fill_record_geni_info(record)
436 def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
437 # get a list of the HRNs tht are members of the old and new records
439 oldList = oldRecord.get(listName, [])
442 newList = record.get(listName, [])
444 # if the lists are the same, then we don't have to update anything
445 if (oldList == newList):
448 # build a list of the new person ids, by looking up each person to get
452 records = table.find({'type': 'user', 'hrn': newList})
454 newIdList.append(rec['pointer'])
456 # build a list of the old person ids from the person_ids field
458 oldIdList = oldRecord.get("person_ids", [])
459 containerId = oldRecord.get_pointer()
461 # if oldRecord==None, then we are doing a Register, instead of an
464 containerId = record.get_pointer()
466 # add people who are in the new list, but not the oldList
467 for personId in newIdList:
468 if not (personId in oldIdList):
469 addFunc(self.plauth, personId, containerId)
471 # remove people who are in the old list, but not the new list
472 for personId in oldIdList:
473 if not (personId in newIdList):
474 delFunc(self.plauth, personId, containerId)
476 def update_membership(self, oldRecord, record):
477 if record.type == "slice":
478 self.update_membership_list(oldRecord, record, 'researcher',
479 self.plshell.AddPersonToSlice,
480 self.plshell.DeletePersonFromSlice)
481 elif record.type == "authority":
486 def callable(self, method):
488 Return a new instance of the specified method.
491 if method not in self.methods:
492 raise GeniInvalidAPIMethod, method
494 # Get new instance of method
496 classname = method.split(".")[-1]
497 module = __import__("sfa.methods." + method, globals(), locals(), [classname])
498 callablemethod = getattr(module, classname)(self)
499 return getattr(module, classname)(self)
500 except ImportError, AttributeError:
502 raise GeniInvalidAPIMethod, method
504 def call(self, source, method, *args):
506 Call the named method from the specified source with the
509 function = self.callable(method)
510 function.source = source
511 return function(*args)
513 def handle(self, source, data):
515 Handle an XML-RPC or SOAP request from the specified source.
517 # Parse request into method name and arguments
519 interface = xmlrpclib
520 (args, method) = xmlrpclib.loads(data)
521 methodresponse = True
523 if SOAPpy is not None:
525 (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
528 # XXX Support named arguments
533 result = self.call(source, method, *args)
534 except Exception, fault:
535 traceback.print_exc(file = log)
536 # Handle expected faults
537 if interface == xmlrpclib:
539 methodresponse = None
540 elif interface == SOAPpy:
541 result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
542 result._setDetail("Fault %d: %s" % (fault.faultCode, fault.faultString))
547 if interface == xmlrpclib:
548 if not isinstance(result, GeniFault):
551 data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1)
552 elif interface == SOAPpy:
553 data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)