2 # Geniwrapper XML-RPC and SOAP interfaces
11 from geni.util.auth import Auth
12 from geni.util.config import *
13 from geni.util.faults import *
14 from geni.util.debug import *
15 from geni.util.rights import *
16 from geni.util.credential import *
17 from geni.util.misc import *
19 # See "2.2 Characters" in the XML specification:
21 # #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
23 # [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
25 invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F))
26 xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii))
28 def xmlrpclib_escape(s, replace = string.replace):
30 xmlrpclib does not handle invalid 7-bit control characters. This
31 function augments xmlrpclib.escape, which by default only replaces
32 '&', '<', and '>' with entities.
35 # This is the standard xmlrpclib.escape function
36 s = replace(s, "&", "&")
37 s = replace(s, "<", "<")
38 s = replace(s, ">", ">",)
40 # Replace invalid 7-bit control characters with '?'
41 return s.translate(xml_escape_table)
43 def xmlrpclib_dump(self, value, write):
45 xmlrpclib cannot marshal instances of subclasses of built-in
46 types. This function overrides xmlrpclib.Marshaller.__dump so that
47 any value that is an instance of one of its acceptable types is
48 marshalled as that type.
50 xmlrpclib also cannot handle invalid 7-bit control characters. See
54 # Use our escape function
55 args = [self, value, write]
56 if isinstance(value, (str, unicode)):
57 args.append(xmlrpclib_escape)
60 # Try for an exact match first
61 f = self.dispatch[type(value)]
64 # Try for an isinstance() match
65 for Type, f in self.dispatch.iteritems():
66 if isinstance(value, Type):
69 raise TypeError, "cannot marshal %s objects" % type(value)
73 # You can't hide from me!
74 xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
76 # SOAP support is optional
79 from SOAPpy.Parser import parseSOAPRPC
80 from SOAPpy.Types import faultType
81 from SOAPpy.NS import NS
82 from SOAPpy.SOAPBuilder import buildSOAP
87 def import_deep(name):
88 mod = __import__(name)
89 components = name.split('.')
90 for comp in components[1:]:
91 mod = getattr(mod, comp)
96 # flat list of method names
98 methods = geni.methods.all
100 def __init__(self, config = "/etc/geni/geni_config", encoding = "utf-8", peer_cert = None, interface = None, key_file = None, cert_file = None):
101 self.encoding = encoding
103 # Better just be documenting the API
108 self.config = Config(config)
109 self.auth = Auth(peer_cert)
110 self.interface = interface
111 self.key_file = key_file
112 self.cert_file = cert_file
113 self.credential = None
114 self.plshell = self.getPLCShell()
115 self.plshell_version = self.getPLCShellVersion()
116 self.basedir = self.config.GENI_BASE_DIR + os.sep
117 self.server_basedir = self.basedir + os.sep + "geni" + os.sep
118 self.hrn = self.config.GENI_INTERFACE_HRN
119 self.time_format = "%Y-%m-%d %H:%M:%S"
122 def getPLCShell(self):
123 self.plauth = {'Username': self.config.GENI_PLC_USER,
124 'AuthMethod': 'password',
125 'AuthString': self.config.GENI_PLC_PASSWORD}
128 shell = PLC.Shell.Shell(globals = globals())
129 shell.AuthCheck(self.plauth)
133 plc_host = self.config.GENI_PLC_HOST
134 plc_port = self.config.GENI_PLC_PORT
135 plc_api_path = self.config.GENI_PLC_API_PATH
136 url = "https://%(plc_host)s:%(plc_port)s/%(plc_api_path)s/" % locals()
138 shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
139 shell.AuthCheck(self.plauth)
142 def getPLCShellVersion(self):
143 # We need to figure out what version of PLCAPI we are talking to.
144 # Some calls we need to make later will be different depending on
147 # This is probably a bad way to determine api versions
148 # but its easy and will work for now. Lets try to make
149 # a call that only exists is PLCAPI.4.3. If it fails, we
150 # can assume the api version is 4.2
151 self.plshell.GetTagTypes(self.plauth)
157 def getCredential(self):
158 if self.interface in ['registry']:
159 return self.getCredentialFromLocalRegistry()
161 return self.getCredentialFromRegistry()
164 def getCredentialFromRegistry(self):
166 Get our credential from a remote registry using a geniclient connection
169 path = self.config.basepath
170 filename = ".".join([self.interface, self.hrn, type, "cred"])
171 cred_filename = path + os.sep + filename
173 credential = Credential(filename = cred_filename)
176 from geni.registry import Registries
177 registries = Registries(self)
178 registry = registries[self.hrn]
179 self_cred = registry.get_credential(None, type, self.hrn)
180 cred = registry.get_credential(self_cred, type, self.hrn)
181 cred.save_to_file(cred_filename, save_parents=True)
184 def getCredentialFromLocalRegistry(self):
186 Get our current credential directly from the local registry.
190 auth_hrn = self.auth.get_authority(hrn)
193 auth_info = self.auth.get_auth_info(auth_hrn)
194 table = self.auth.get_auth_table(auth_hrn)
195 records = table.resolve('*', hrn)
199 type = record.get_type()
200 object_gid = record.get_gid_object()
201 new_cred = Credential(subject = object_gid.get_subject())
202 new_cred.set_gid_caller(object_gid)
203 new_cred.set_gid_object(object_gid)
204 new_cred.set_issuer(key=auth_info.get_pkey_object(), subject=auth_hrn)
205 new_cred.set_pubkey(object_gid.get_pubkey())
206 r1 = determine_rights(type, hrn)
207 new_cred.set_privileges(r1)
209 auth_kind = "authority,ma,sa"
211 new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
219 def loadCredential(self):
221 Attempt to load credential from file if it exists. If it doesnt get
222 credential from registry.
225 # see if this file exists
226 # XX This is really the aggregate's credential. Using this is easier than getting
227 # the registry's credential from iteslf (ssl errors).
228 ma_cred_filename = self.server_basedir + os.sep + self.interface + self.hrn + ".ma.cred"
230 self.credential = Credential(filename = ma_cred_filename)
232 self.credential = self.getCredentialFromRegistry()
235 # Convert geni fields to PLC fields for use when registering up updating
236 # registry record in the PLC database
238 # @param type type of record (user, slice, ...)
239 # @param hrn human readable name
240 # @param geni_fields dictionary of geni fields
241 # @param pl_fields dictionary of PLC fields (output)
243 def geni_fields_to_pl_fields(self, type, hrn, record):
246 pl_record[field] = record[field]
249 if not "instantiation" in pl_record:
250 pl_record["instantiation"] = "delegated" # "plc-instantiated"
251 if not "name" in pl_record:
252 pl_record["name"] = hrn_to_pl_slicename(hrn)
253 if not "max_nodes" in pl_record:
254 pl_record["max_nodes"] = 10
257 if not "hostname" in pl_record:
258 if not "dns" in record:
259 raise MissingGeniInfo("dns")
260 pl_record["hostname"] = record["dns"]
261 if not "model" in pl_record:
262 pl_record["model"] = "geni"
264 elif type == "authority":
265 pl_record["login_base"] = hrn_to_pl_login_base(hrn)
267 if not "name" in pl_record:
268 pl_record["name"] = hrn
270 if not "abbreviated_name" in pl_record:
271 pl_record["abbreviated_name"] = hrn
273 if not "enabled" in pl_record:
274 pl_record["enabled"] = True
276 if not "is_public" in pl_record:
277 pl_record["is_public"] = True
281 def fill_record_pl_info(self, record):
283 Fill in the planetlab specific fields of a Geni record. This
284 involves calling the appropriate PLC method to retrieve the
285 database record for the object.
287 PLC data is filled into the pl_info field of the record.
289 @param record: record to fill in field (in/out param)
291 type = record.get_type()
292 pointer = record.get_pointer()
295 # records with pointer==-1 do not have plc info associated with them.
296 # for example, the top level authority records which are
297 # authorities, but not PL "sites"
302 if (type in ["authority", "sa", "ma"]):
303 pl_res = self.plshell.GetSites(self.plauth, [pointer])
304 elif (type == "slice"):
305 pl_res = self.plshell.GetSlices(self.plauth, [pointer])
306 elif (type == "user"):
307 pl_res = self.plshell.GetPersons(self.plauth, [pointer])
308 elif (type == "node"):
309 pl_res = self.plshell.GetNodes(self.plauth, [pointer])
311 raise UnknownGeniType(type)
314 raise PlanetLabRecordDoesNotExist(record.get_name())
316 # convert ids to hrns
317 pl_record = pl_res[0]
318 if 'site_id' in pl_record:
319 sites = self.plshell.GetSites(self.plauth, pl_record['site_id'], ['login_base'])
321 login_base = site['login_base']
322 pl_record['site'] = ".".join([auth_hrn, login_base])
323 if 'person_ids' in pl_record:
324 persons = self.plshell.GetPersons(self.plauth, pl_record['person_ids'], ['email'])
325 emails = [person['email'] for person in persons]
326 usernames = [email.split('@')[0] for email in emails]
327 person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
328 pl_record['persons'] = person_hrns
329 if 'slice_ids' in pl_record:
330 slices = self.plshell.GetSlices(self.plauth, pl_record['slice_ids'], ['name'])
331 slicenames = [slice['name'] for slice in slices]
332 slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
333 pl_record['slices'] = slice_hrns
334 if 'node_ids' in pl_record:
335 nodes = self.plshell.GetNodes(self.plauth, pl_record['node_ids'], ['hostname'])
336 hostnames = [node['hostname'] for node in nodes]
337 node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
338 pl_record['nodes'] = node_hrns
339 if 'site_ids' in pl_record:
340 sites = self.plshell.GetSites(self.plauth, pl_record['site_ids'], ['login_base'])
341 login_bases = [site['login_base'] for site in sites]
342 site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
343 pl_record['sites'] = site_hrns
344 if 'key_ids' in pl_record:
345 keys = self.plshell.GetKeys(self.plauth, pl_record['key_ids'])
348 pubkeys = [key['key'] for key in keys]
349 pl_record['keys'] = pubkeys
351 record.update(pl_record)
354 def lookup_users(self, auth_table, user_id_list, role="*"):
356 for person_id in user_id_list:
357 user_records = auth_table.find("user", person_id, "pointer")
358 for user_record in user_records:
359 self.fill_record_info(user_record)
361 user_roles = user_record.get("roles")
362 if (role=="*") or (role in user_roles):
363 record_list.append(user_record.get_name())
366 def fill_record_geni_info(self, record):
368 type = record.get_type()
370 if (type == "slice"):
371 auth_table = self.auth.get_auth_table(self.auth.get_authority(record.get_name()))
372 person_ids = record.get("person_ids", [])
373 researchers = self.lookup_users(auth_table, person_ids)
374 geni_info['researcher'] = researchers
376 elif (type == "authority"):
377 auth_table = self.auth.get_auth_table(record.get_name())
378 person_ids = record.get("person_ids", [])
379 pis = self.lookup_users(auth_table, person_ids, "pi")
380 operators = self.lookup_users(auth_table, person_ids, "tech")
381 owners = self.lookup_users(auth_table, person_ids, "admin")
382 geni_info['pi'] = pis
383 geni_info['operator'] = operators
384 geni_info['owner'] = owners
385 # xxx TODO: OrganizationName
387 elif (type == "node"):
388 geni_info['dns'] = record.get("hostname", "")
389 # xxx TODO: URI, LatLong, IP, DNS
391 elif (type == "user"):
392 geni_info['email'] = record.get("email", "")
393 # xxx TODO: PostalAddress, Phone
395 record.update(geni_info)
397 def fill_record_info(self, record):
399 Given a geni record, fill in the PLC specific and Geni specific
400 fields in the record.
402 self.fill_record_pl_info(record)
403 self.fill_record_geni_info(record)
405 def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
406 # get a list of the HRNs tht are members of the old and new records
407 oldList = oldRecord.get(listName, [])
408 newList = record.get(listName, [])
410 # if the lists are the same, then we don't have to update anything
411 if (oldList == newList):
414 # build a list of the new person ids, by looking up each person to get
418 auth_hrn = self.auth.get_authority(hrn)
421 auth_info = self.auth.get_auth_info(auth_hrn)
422 table = self.auth.get_auth_table(auth_hrn)
423 records = table.resolve('user', hrn)
425 userRecord = records[0]
426 newIdList.append(userRecord.get_pointer())
428 # build a list of the old person ids from the person_ids field
430 oldIdList = oldRecord.get("person_ids", [])
431 containerId = oldRecord.get_pointer()
433 # if oldRecord==None, then we are doing a Register, instead of an
436 containerId = record.get_pointer()
438 # add people who are in the new list, but not the oldList
439 for personId in newIdList:
440 if not (personId in oldIdList):
441 print "adding id", personId, "to", record.get_name()
442 addFunc(self.plauth, personId, containerId)
444 # remove people who are in the old list, but not the new list
445 for personId in oldIdList:
446 if not (personId in newIdList):
447 print "removing id", personId, "from", record.get_name()
448 delFunc(self.plauth, personId, containerId)
450 def update_membership(self, oldRecord, record):
451 if record.type == "slice":
452 self.update_membership_list(oldRecord, record, 'researcher',
453 self.plshell.AddPersonToSlice,
454 self.plshell.DeletePersonFromSlice)
455 elif record.type == "authority":
460 def callable(self, method):
462 Return a new instance of the specified method.
465 if method not in self.methods:
466 raise GeniInvalidAPIMethod, method
468 # Get new instance of method
470 classname = method.split(".")[-1]
471 module = __import__("geni.methods." + method, globals(), locals(), [classname])
472 callablemethod = getattr(module, classname)(self)
473 return getattr(module, classname)(self)
474 except ImportError, AttributeError:
476 raise GeniInvalidAPIMethod, method
478 def call(self, source, method, *args):
480 Call the named method from the specified source with the
483 function = self.callable(method)
484 function.source = source
485 return function(*args)
487 def handle(self, source, data):
489 Handle an XML-RPC or SOAP request from the specified source.
492 # Parse request into method name and arguments
494 interface = xmlrpclib
495 (args, method) = xmlrpclib.loads(data)
496 methodresponse = True
498 if SOAPpy is not None:
500 (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
503 # XXX Support named arguments
508 result = self.call(source, method, *args)
509 except Exception, fault:
510 traceback.print_exc(file = log)
511 # Handle expected faults
512 if interface == xmlrpclib:
514 methodresponse = None
515 elif interface == SOAPpy:
516 result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
517 result._setDetail("Fault %d: %s" % (fault.faultCode, fault.faultString))
520 if interface == xmlrpclib:
521 if not isinstance(result, GeniFault):
524 data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1)
525 elif interface == SOAPpy:
526 data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)