#
-# Geniwrapper XML-RPC and SOAP interfaces
+# SFA XML-RPC and SOAP interfaces
#
### $Id$
### $URL$
import traceback
import string
import xmlrpclib
-
from sfa.trust.auth import Auth
from sfa.util.config import *
from sfa.util.faults import *
from sfa.trust.rights import *
from sfa.trust.credential import *
from sfa.trust.certificate import *
-from sfa.util.misc import *
+from sfa.util.namespace import *
+from sfa.util.api import *
+from sfa.util.nodemanager import NodeManager
from sfa.util.sfalogging import *
-from sfa.util.genitable import *
-# See "2.2 Characters" in the XML specification:
-#
-# #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
-# avoiding
-# [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
-
-invalid_xml_ascii = map(chr, range(0x0, 0x8) + [0xB, 0xC] + range(0xE, 0x1F))
-xml_escape_table = string.maketrans("".join(invalid_xml_ascii), "?" * len(invalid_xml_ascii))
-
-def xmlrpclib_escape(s, replace = string.replace):
- """
- xmlrpclib does not handle invalid 7-bit control characters. This
- function augments xmlrpclib.escape, which by default only replaces
- '&', '<', and '>' with entities.
- """
-
- # This is the standard xmlrpclib.escape function
- s = replace(s, "&", "&")
- s = replace(s, "<", "<")
- s = replace(s, ">", ">",)
-
- # Replace invalid 7-bit control characters with '?'
- return s.translate(xml_escape_table)
-
-def xmlrpclib_dump(self, value, write):
- """
- xmlrpclib cannot marshal instances of subclasses of built-in
- types. This function overrides xmlrpclib.Marshaller.__dump so that
- any value that is an instance of one of its acceptable types is
- marshalled as that type.
-
- xmlrpclib also cannot handle invalid 7-bit control characters. See
- above.
- """
-
- # Use our escape function
- args = [self, value, write]
- if isinstance(value, (str, unicode)):
- args.append(xmlrpclib_escape)
-
- try:
- # Try for an exact match first
- f = self.dispatch[type(value)]
- except KeyError:
- raise
- # Try for an isinstance() match
- for Type, f in self.dispatch.iteritems():
- if isinstance(value, Type):
- f(*args)
- return
- raise TypeError, "cannot marshal %s objects" % type(value)
- else:
- f(*args)
-
-# You can't hide from me!
-xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
-
-# SOAP support is optional
-try:
- import SOAPpy
- from SOAPpy.Parser import parseSOAPRPC
- from SOAPpy.Types import faultType
- from SOAPpy.NS import NS
- from SOAPpy.SOAPBuilder import buildSOAP
-except ImportError:
- SOAPpy = None
-
-
-def import_deep(name):
- mod = __import__(name)
- components = name.split('.')
- for comp in components[1:]:
- mod = getattr(mod, comp)
- return mod
-
-class GeniAPI:
+def list_to_dict(recs, key):
+ keys = [rec[key] for rec in recs]
+ return dict(zip(keys, recs))
+
+class SfaAPI(BaseAPI):
# flat list of method names
import sfa.methods
methods = sfa.methods.all
- def __init__(self, config = "/etc/sfa/sfa_config", encoding = "utf-8",
+ def __init__(self, config = "/etc/sfa/sfa_config.py", encoding = "utf-8", methods='sfa.methods', \
peer_cert = None, interface = None, key_file = None, cert_file = None):
+ BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, \
+ peer_cert=peer_cert, interface=interface, key_file=key_file, \
+ cert_file=cert_file)
+
self.encoding = encoding
+ from sfa.util.table import SfaTable
+ self.SfaTable = SfaTable
# Better just be documenting the API
if config is None:
return
self.cert_file = cert_file
self.cert = Certificate(filename=self.cert_file)
self.credential = None
-
# Initialize the PLC shell only if SFA wraps a myPLC
- rspec_type = self.config.get_aggregate_rspec_type()
+ rspec_type = self.config.get_aggregate_type()
if (rspec_type == 'pl' or rspec_type == 'vini'):
self.plshell = self.getPLCShell()
self.plshell_version = self.getPLCShellVersion()
self.plauth = {'Username': self.config.SFA_PLC_USER,
'AuthMethod': 'password',
'AuthString': self.config.SFA_PLC_PASSWORD}
+
try:
+ sys.path.append(os.path.dirname(os.path.realpath("/usr/bin/plcsh")))
self.plshell_type = 'direct'
import PLC.Shell
shell = PLC.Shell.Shell(globals = globals())
- shell.AuthCheck(self.plauth)
return shell
except ImportError:
self.plshell_type = 'xmlrpc'
# connect via xmlrpc
url = self.config.SFA_PLC_URL
shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
- shell.AuthCheck(self.plauth)
return shell
def getPLCShellVersion(self):
else:
return self.getCredentialFromRegistry()
-
def getCredentialFromRegistry(self):
"""
- Get our credential from a remote registry using a geniclient connection
+ Get our credential from a remote registry
"""
type = 'authority'
- path = self.config.SFA_BASE_DIR
+ path = self.config.SFA_DATA_DIR
filename = ".".join([self.interface, self.hrn, type, "cred"])
cred_filename = path + os.sep + filename
try:
credential = Credential(filename = cred_filename)
- return credential
+ return credential.save_to_string(save_parents=True)
except IOError:
from sfa.server.registry import Registries
registries = Registries(self)
registry = registries[self.hrn]
+ cert_string=self.cert.save_to_string(save_parents=True)
# get self credential
- arg_list = [None,type,self.hrn]
- request_hash=self.key.compute_hash(arg_list)
- self_cred = registry.get_credential(None, type, self.hrn, request_hash)
+ self_cred = registry.get_self_credential(cert_string, type, self.hrn)
# get credential
- arg_list = [self_cred,type,self.hrn]
- request_hash=self.key.compute_hash(arg_list)
- cred = registry.get_credential(self_cred, type, self.hrn, request_hash)
+ cred = registry.get_credential(self_cred, type, self.hrn)
# save cred to file
Credential(string=cred).save_to_file(cred_filename, save_parents=True)
if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
auth_hrn = hrn
auth_info = self.auth.get_auth_info(auth_hrn)
- table = GeniTable()
+ table = self.SfaTable()
records = table.findObjects(hrn)
if not records:
raise RecordNotFound
# see if this file exists
# XX This is really the aggregate's credential. Using this is easier than getting
# the registry's credential from iteslf (ssl errors).
- ma_cred_filename = self.config.SFA_BASE_DIR + os.sep + self.interface + self.hrn + ".ma.cred"
+ ma_cred_filename = self.config.SFA_DATA_DIR + os.sep + self.interface + self.hrn + ".ma.cred"
try:
self.credential = Credential(filename = ma_cred_filename)
except IOError:
self.credential = self.getCredentialFromRegistry()
##
- # Convert geni fields to PLC fields for use when registering up updating
+ # Convert SFA fields to PLC fields for use when registering up updating
# registry record in the PLC database
#
# @param type type of record (user, slice, ...)
# @param hrn human readable name
- # @param geni_fields dictionary of geni fields
+ # @param sfa_fields dictionary of SFA fields
# @param pl_fields dictionary of PLC fields (output)
- def geni_fields_to_pl_fields(self, type, hrn, record):
+ def sfa_fields_to_pl_fields(self, type, hrn, record):
def convert_ints(tmpdict, int_fields):
for field in int_fields:
pl_record["url"] = record["url"]
if "description" in record:
pl_record["description"] = record["description"]
+ if "expires" in record:
+ pl_record["expires"] = int(record["expires"])
elif type == "node":
if not "hostname" in pl_record:
if not "hostname" in record:
- raise MissingGeniInfo("hostname")
+ raise MissingSfaInfo("hostname")
pl_record["hostname"] = record["hostname"]
if not "model" in pl_record:
pl_record["model"] = "geni"
return pl_record
- def fill_record_pl_info(self, record):
+ def fill_record_pl_info(self, records):
"""
- Fill in the planetlab specific fields of a Geni record. This
+ Fill in the planetlab specific fields of a SFA record. This
involves calling the appropriate PLC method to retrieve the
database record for the object.
@param record: record to fill in field (in/out param)
"""
- type = record['type']
- pointer = record['pointer']
- auth_hrn = self.hrn
- login_base = ''
- # records with pointer==-1 do not have plc info associated with them.
- # for example, the top level authority records which are
- # authorities, but not PL "sites"
- if pointer == -1:
- record.update({})
- return
+ # get ids by type
+ node_ids, site_ids, slice_ids = [], [], []
+ person_ids, key_ids = [], []
+ type_map = {'node': node_ids, 'authority': site_ids,
+ 'slice': slice_ids, 'user': person_ids}
+
+ for record in records:
+ for type in type_map:
+ if type == record['type']:
+ type_map[type].append(record['pointer'])
+
+ # get pl records
+ nodes, sites, slices, persons, keys = {}, {}, {}, {}, {}
+ if node_ids:
+ node_list = self.plshell.GetNodes(self.plauth, node_ids)
+ nodes = list_to_dict(node_list, 'node_id')
+ if site_ids:
+ site_list = self.plshell.GetSites(self.plauth, site_ids)
+ sites = list_to_dict(site_list, 'site_id')
+ if slice_ids:
+ slice_list = self.plshell.GetSlices(self.plauth, slice_ids)
+ slices = list_to_dict(slice_list, 'slice_id')
+ if person_ids:
+ person_list = self.plshell.GetPersons(self.plauth, person_ids)
+ persons = list_to_dict(person_list, 'person_id')
+ for person in persons:
+ key_ids.extend(persons[person]['key_ids'])
+
+ pl_records = {'node': nodes, 'authority': sites,
+ 'slice': slices, 'user': persons}
+
+ if key_ids:
+ key_list = self.plshell.GetKeys(self.plauth, key_ids)
+ keys = list_to_dict(key_list, 'key_id')
+
+ # fill record info
+ for record in records:
+ # records with pointer==-1 do not have plc info associated with them.
+ # for example, the top level authority records which are
+ # authorities, but not PL "sites"
+ if record['pointer'] == -1:
+ continue
+
+ for type in pl_records:
+ if record['type'] == type:
+ if record['pointer'] in pl_records[type]:
+ record.update(pl_records[type][record['pointer']])
+ break
+ # fill in key info
+ if record['type'] == 'user':
+ pubkeys = [keys[key_id]['key'] for key_id in record['key_ids'] if key_id in keys]
+ record['keys'] = pubkeys
+
+ # fill in record hrns
+ records = self.fill_record_hrns(records)
+
+ return records
- if (type in ["authority"]):
- pl_res = self.plshell.GetSites(self.plauth, [pointer])
- elif (type == "slice"):
- pl_res = self.plshell.GetSlices(self.plauth, [pointer])
- elif (type == "user"):
- pl_res = self.plshell.GetPersons(self.plauth, [pointer])
- elif (type == "node"):
- pl_res = self.plshell.GetNodes(self.plauth, [pointer])
- else:
- raise UnknownGeniType(type)
-
- if not pl_res:
- raise PlanetLabRecordDoesNotExist(record['hrn'])
+ def fill_record_hrns(self, records):
+ """
+ convert pl ids to hrns
+ """
+ # get ids
+ slice_ids, person_ids, site_ids, node_ids = [], [], [], []
+ for record in records:
+ if 'site_id' in record:
+ site_ids.append(record['site_id'])
+ if 'site_ids' in records:
+ site_ids.extend(record['site_ids'])
+ if 'person_ids' in record:
+ person_ids.extend(record['person_ids'])
+ if 'slice_ids' in record:
+ slice_ids.extend(record['slice_ids'])
+ if 'node_ids' in record:
+ node_ids.extend(record['node_ids'])
+
+ # get pl records
+ slices, persons, sites, nodes = {}, {}, {}, {}
+ if site_ids:
+ site_list = self.plshell.GetSites(self.plauth, site_ids, ['site_id', 'login_base'])
+ sites = list_to_dict(site_list, 'site_id')
+ if person_ids:
+ person_list = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'email'])
+ persons = list_to_dict(person_list, 'person_id')
+ if slice_ids:
+ slice_list = self.plshell.GetSlices(self.plauth, slice_ids, ['slice_id', 'name'])
+ slices = list_to_dict(slice_list, 'slice_id')
+ if node_ids:
+ node_list = self.plshell.GetNodes(self.plauth, node_ids, ['node_id', 'hostname'])
+ nodes = list_to_dict(node_list, 'node_id')
+
# convert ids to hrns
- pl_record = pl_res[0]
- if 'site_id' in pl_record:
- sites = self.plshell.GetSites(self.plauth, pl_record['site_id'], ['login_base'])
- site = sites[0]
- login_base = site['login_base']
- pl_record['site'] = ".".join([auth_hrn, login_base])
- if 'person_ids' in pl_record:
- persons = self.plshell.GetPersons(self.plauth, pl_record['person_ids'], ['email'])
- emails = [person['email'] for person in persons]
- usernames = [email.split('@')[0] for email in emails]
- person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
- pl_record['persons'] = person_hrns
- if 'slice_ids' in pl_record:
- slices = self.plshell.GetSlices(self.plauth, pl_record['slice_ids'], ['name'])
- slicenames = [slice['name'] for slice in slices]
- slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
- pl_record['slices'] = slice_hrns
- if 'node_ids' in pl_record:
- nodes = self.plshell.GetNodes(self.plauth, pl_record['node_ids'], ['hostname'])
- hostnames = [node['hostname'] for node in nodes]
- node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
- pl_record['nodes'] = node_hrns
- if 'site_ids' in pl_record:
- sites = self.plshell.GetSites(self.plauth, pl_record['site_ids'], ['login_base'])
- login_bases = [site['login_base'] for site in sites]
- site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
- pl_record['sites'] = site_hrns
- if 'key_ids' in pl_record:
- keys = self.plshell.GetKeys(self.plauth, pl_record['key_ids'])
- pubkeys = []
- if keys:
- pubkeys = [key['key'] for key in keys]
- pl_record['keys'] = pubkeys
-
- record.update(pl_record)
-
-
-
- def fill_record_geni_info(self, record):
- geni_info = {}
- type = record['type']
- table = GeniTable()
- if (type == "slice"):
- person_ids = record.get("person_ids", [])
- persons = table.find({'type': 'user', 'pointer': person_ids})
- researchers = [person['hrn'] for person in persons]
- geni_info['researcher'] = researchers
-
- elif (type == "authority"):
- person_ids = record.get("person_ids", [])
- persons = table.find({'type': 'user', 'pointer': person_ids})
- persons_dict = {}
- for person in persons:
- persons_dict[person['pointer']] = person
- pl_persons = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'roles'])
- pis, techs, admins = [], [], []
- for person in pl_persons:
- pointer = person['person_id']
-
- if pointer not in persons_dict:
- # this means there is not sfa record for this user
- continue
- hrn = persons_dict[pointer]['hrn']
- if 'pi' in person['roles']:
- pis.append(hrn)
- if 'tech' in person['roles']:
- techs.append(hrn)
- if 'admin' in person['roles']:
- admins.append(hrn)
+ for record in records:
+
+ # get all relevant data
+ type = record['type']
+ pointer = record['pointer']
+ auth_hrn = self.hrn
+ login_base = ''
+ if pointer == -1:
+ continue
+
+ if 'site_id' in record:
+ site = sites[record['site_id']]
+ login_base = site['login_base']
+ record['site'] = ".".join([auth_hrn, login_base])
+ if 'person_ids' in record:
+ emails = [persons[person_id]['email'] for person_id in record['person_ids'] \
+ if person_id in persons]
+ usernames = [email.split('@')[0] for email in emails]
+ person_hrns = [".".join([auth_hrn, login_base, username]) for username in usernames]
+ record['persons'] = person_hrns
+ if 'slice_ids' in record:
+ slicenames = [slices[slice_id]['name'] for slice_id in record['slice_ids'] \
+ if slice_id in slices]
+ slice_hrns = [slicename_to_hrn(auth_hrn, slicename) for slicename in slicenames]
+ record['slices'] = slice_hrns
+ if 'node_ids' in record:
+ hostnames = [nodes[node_id]['hostname'] for node_id in record['node_ids'] \
+ if node_id in nodes]
+ node_hrns = [hostname_to_hrn(auth_hrn, login_base, hostname) for hostname in hostnames]
+ record['nodes'] = node_hrns
+ if 'site_ids' in record:
+ login_bases = [sites[site_id]['login_base'] for site_id in record['site_ids'] \
+ if site_id in sites]
+ site_hrns = [".".join([auth_hrn, lbase]) for lbase in login_bases]
+ record['sites'] = site_hrns
+
+ return records
+
+ def fill_record_sfa_info(self, records):
+ # get person ids
+ has_authority = False
+ has_slice = False
+ person_ids = []
+ for record in records:
+ if record['type'] == 'authority':
+ has_authority = True
+ person_ids.extend(record.get("person_ids", []))
+
+ # get sfa info
+ table = self.SfaTable()
+ person_list, persons = [], {}
+ pl_person_list, pl_persons = [], {}
+ person_list = table.find({'type': 'user', 'pointer': person_ids})
+ persons = list_to_dict(person_list, 'pointer')
+ if has_authority:
+ pl_person_list = self.plshell.GetPersons(self.plauth, person_ids, ['person_id', 'roles'])
+ pl_persons = list_to_dict(pl_person_list, 'person_id')
- geni_info['PI'] = pis
- geni_info['operator'] = techs
- geni_info['owner'] = admins
- # xxx TODO: OrganizationName
-
- elif (type == "node"):
- geni_info['dns'] = record.get("hostname", "")
- # xxx TODO: URI, LatLong, IP, DNS
-
- elif (type == "user"):
- geni_info['email'] = record.get("email", "")
- # xxx TODO: PostalAddress, Phone
- record.update(geni_info)
+ # fill sfa info
+ for record in records:
+ # skip records with no pl info (top level authorities)
+ if record['pointer'] == -1:
+ continue
+ sfa_info = {}
+ type = record['type']
+ if (type == "slice"):
+ researchers = [persons[person_id]['hrn'] for person_id in record['person_ids'] \
+ if person_id in persons]
+ sfa_info['researcher'] = researchers
+
+ elif (type == "authority"):
+ pis, techs, admins = [], [], []
+ for pointer in record['person_ids']:
+ if pointer not in persons or pointer not in pl_persons:
+ # this means there is not sfa or pl record for this user
+ continue
+ hrn = persons[pointer]['hrn']
+ roles = pl_persons[pointer]['roles']
+ if 'pi' in roles:
+ pis.append(hrn)
+ if 'tech' in roles:
+ techs.append(hrn)
+ if 'admin' in roles:
+ admins.append(hrn)
+
+ sfa_info['PI'] = pis
+ sfa_info['operator'] = techs
+ sfa_info['owner'] = admins
+ # xxx TODO: OrganizationName
+ elif (type == "node"):
+ sfa_info['dns'] = record.get("hostname", "")
+ # xxx TODO: URI, LatLong, IP, DNS
+
+ elif (type == "user"):
+ sfa_info['email'] = record.get("email", "")
+ # xxx TODO: PostalAddress, Phone
+ record.update(sfa_info)
- def fill_record_info(self, record):
+ def fill_record_info(self, records):
"""
- Given a geni record, fill in the PLC specific and Geni specific
+ Given a SFA record, fill in the PLC specific and SFA specific
fields in the record.
"""
- self.fill_record_pl_info(record)
- self.fill_record_geni_info(record)
+ if not isinstance(records, list):
+ records = [records]
+
+ self.fill_record_pl_info(records)
+ self.fill_record_sfa_info(records)
def update_membership_list(self, oldRecord, record, listName, addFunc, delFunc):
# get a list of the HRNs tht are members of the old and new records
# build a list of the new person ids, by looking up each person to get
# their pointer
newIdList = []
- table = GeniTable()
+ table = self.SfaTable()
records = table.find({'type': 'user', 'hrn': newList})
for rec in records:
newIdList.append(rec['pointer'])
pass
- def callable(self, method):
- """
- Return a new instance of the specified method.
- """
- # Look up method
- if method not in self.methods:
- raise GeniInvalidAPIMethod, method
-
- # Get new instance of method
- try:
- classname = method.split(".")[-1]
- module = __import__("sfa.methods." + method, globals(), locals(), [classname])
- callablemethod = getattr(module, classname)(self)
- return getattr(module, classname)(self)
- except ImportError, AttributeError:
- raise
- raise GeniInvalidAPIMethod, method
-
- def call(self, source, method, *args):
- """
- Call the named method from the specified source with the
- specified arguments.
- """
- function = self.callable(method)
- function.source = source
- return function(*args)
- def handle(self, source, data):
- """
- Handle an XML-RPC or SOAP request from the specified source.
- """
- # Parse request into method name and arguments
- try:
- interface = xmlrpclib
- (args, method) = xmlrpclib.loads(data)
- methodresponse = True
- except Exception, e:
- if SOAPpy is not None:
- interface = SOAPpy
- (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
- method = r._name
- args = r._aslist()
- # XXX Support named arguments
- else:
- raise e
+class ComponentAPI(BaseAPI):
- try:
- result = self.call(source, method, *args)
- except Exception, fault:
- traceback.print_exc(file = log)
- # Handle expected faults
- if interface == xmlrpclib:
- result = fault
- methodresponse = None
- elif interface == SOAPpy:
- result = faultParameter(NS.ENV_T + ":Server", "Method Failed", method)
- result._setDetail("Fault %d: %s" % (fault.faultCode, fault.faultString))
- else:
- raise
-
- # Return result
- if interface == xmlrpclib:
- if not isinstance(result, GeniFault):
- result = (result,)
-
- data = xmlrpclib.dumps(result, methodresponse = True, encoding = self.encoding, allow_none = 1)
- elif interface == SOAPpy:
- data = buildSOAP(kw = {'%sResponse' % method: {'Result': result}}, encoding = self.encoding)
-
- return data
+ def __init__(self, config = "/etc/sfa/sfa_config.py", encoding = "utf-8", methods='sfa.methods',
+ peer_cert = None, interface = None, key_file = None, cert_file = None):
+
+ BaseAPI.__init__(self, config=config, encoding=encoding, methods=methods, peer_cert=peer_cert,
+ interface=interface, key_file=key_file, cert_file=cert_file)
+ self.encoding = encoding
+
+ # Better just be documenting the API
+ if config is None:
+ return
+ self.nodemanager = NodeManager(self.config)
+
+ def sliver_exists(self):
+ sliver_dict = self.nodemanager.GetXIDs()
+ if slicename in sliver_dict.keys():
+ return True
+ else:
+ return False
git://git.onelab.eu / sfa.git / blobdiff