sfa/plc/api.py

   1 #
   2 # Geniwrapper XML-RPC and SOAP interfaces
   3 #
   4 ### $Id$
   5 ### $URL$
   6 #
   7
   8 import sys
   9 import os
  10 import traceback
  11 import string
  12 import xmlrpclib
  13
  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 *
  24
  25 # See "2.2 Characters" in the XML specification:
  26 #
  27 # #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD]
  28 # avoiding
  29 # [#x7F-#x84], [#x86-#x9F], [#xFDD0-#xFDDF]
  30
  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))
  33
  34 def xmlrpclib_escape(s, replace = string.replace):
  35     """
  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.
  39     """
  40
  41     # This is the standard xmlrpclib.escape function
  42     s = replace(s, "&", "&amp;")
  43     s = replace(s, "<", "&lt;")
  44     s = replace(s, ">", "&gt;",)
  45
  46     # Replace invalid 7-bit control characters with '?'
  47     return s.translate(xml_escape_table)
  48
  49 def xmlrpclib_dump(self, value, write):
  50     """
  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.
  55
  56     xmlrpclib also cannot handle invalid 7-bit control characters. See
  57     above.
  58     """
  59
  60     # Use our escape function
  61     args = [self, value, write]
  62     if isinstance(value, (str, unicode)):
  63         args.append(xmlrpclib_escape)
  64
  65     try:
  66         # Try for an exact match first
  67         f = self.dispatch[type(value)]
  68     except KeyError:
  69         raise
  70         # Try for an isinstance() match
  71         for Type, f in self.dispatch.iteritems():
  72             if isinstance(value, Type):
  73                 f(*args)
  74                 return
  75         raise TypeError, "cannot marshal %s objects" % type(value)
  76     else:
  77         f(*args)
  78
  79 # You can't hide from me!
  80 xmlrpclib.Marshaller._Marshaller__dump = xmlrpclib_dump
  81
  82 # SOAP support is optional
  83 try:
  84     import SOAPpy
  85     from SOAPpy.Parser import parseSOAPRPC
  86     from SOAPpy.Types import faultType
  87     from SOAPpy.NS import NS
  88     from SOAPpy.SOAPBuilder import buildSOAP
  89 except ImportError:
  90     SOAPpy = None
  91
  92
  93 def import_deep(name):
  94     mod = __import__(name)
  95     components = name.split('.')
  96     for comp in components[1:]:
  97         mod = getattr(mod, comp)
  98     return mod
  99
 100 class GeniAPI:
 101
 102     # flat list of method names
 103     import sfa.methods
 104     methods = sfa.methods.all
 105
 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
 109
 110         # Better just be documenting the API
 111         if config is None:
 112             return
 113
 114         # Load configuration
 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
 123
 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()
 129
 130         self.hrn = self.config.SFA_INTERFACE_HRN
 131         self.time_format = "%Y-%m-%d %H:%M:%S"
 132         self.logger=get_sfa_logger()
 133
 134     def getPLCShell(self):
 135         self.plauth = {'Username': self.config.SFA_PLC_USER,
 136                        'AuthMethod': 'password',
 137                        'AuthString': self.config.SFA_PLC_PASSWORD}
 138         try:
 139             self.plshell_type = 'direct'
 140             import PLC.Shell
 141             shell = PLC.Shell.Shell(globals = globals())
 142             shell.AuthCheck(self.plauth)
 143             return shell
 144         except ImportError:
 145             self.plshell_type = 'xmlrpc'
 146             # connect via xmlrpc
 147             url = self.config.SFA_PLC_URL
 148             shell = xmlrpclib.Server(url, verbose = 0, allow_none = True)
 149             shell.AuthCheck(self.plauth)
 150             return shell
 151
 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
 155         # the api version.
 156         try:
 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)
 162             return '4.3'
 163         except:
 164             return '4.2'
 165
 166
 167     def getCredential(self):
 168         if self.interface in ['registry']:
 169             return self.getCredentialFromLocalRegistry()
 170         else:
 171             return self.getCredentialFromRegistry()
 172
 173     def getCredentialFromRegistry(self):
 174         """
 175         Get our credential from a remote registry using a geniclient connection
 176         """
 177         type = 'authority'
 178         path = self.config.SFA_BASE_DIR
 179         filename = ".".join([self.interface, self.hrn, type, "cred"])
 180         cred_filename = path + os.sep + filename
 181         try:
 182             credential = Credential(filename = cred_filename)
 183             return credential.save_to_string(save_parents=True)
 184         except IOError:
 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)
 192             # get credential
 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)
 196
 197             # save cred to file
 198             Credential(string=cred).save_to_file(cred_filename, save_parents=True)
 199             return cred
 200
 201     def getCredentialFromLocalRegistry(self):
 202         """
 203         Get our current credential directly from the local registry.
 204         """
 205
 206         hrn = self.hrn
 207         auth_hrn = self.auth.get_authority(hrn)
 208
 209         # is this a root or sub authority
 210         if not auth_hrn or hrn == self.config.SFA_INTERFACE_HRN:
 211             auth_hrn = hrn
 212         auth_info = self.auth.get_auth_info(auth_hrn)
 213         table = GeniTable()
 214         records = table.findObjects(hrn)
 215         if not records:
 216             raise RecordNotFound
 217         record = records[0]
 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)
 227
 228         auth_kind = "authority,ma,sa"
 229
 230         new_cred.set_parent(self.auth.hierarchy.get_auth_cred(auth_hrn, kind=auth_kind))
 231
 232         new_cred.encode()
 233         new_cred.sign()
 234
 235         return new_cred.save_to_string(save_parents=True)
 236
 237
 238     def loadCredential (self):
 239         """
 240         Attempt to load credential from file if it exists. If it doesnt get
 241         credential from registry.
 242         """
 243
 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"
 248         try:
 249             self.credential = Credential(filename = ma_cred_filename)
 250         except IOError:
 251             self.credential = self.getCredentialFromRegistry()
 252
 253     ##
 254     # Convert geni fields to PLC fields for use when registering up updating
 255     # registry record in the PLC database
 256     #
 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)
 261
 262     def geni_fields_to_pl_fields(self, type, hrn, record):
 263
 264         def convert_ints(tmpdict, int_fields):
 265             for field in int_fields:
 266                 if field in tmpdict:
 267                     tmpdict[field] = int(tmpdict[field])
 268
 269         pl_record = {}
 270         #for field in record:
 271         #    pl_record[field] = record[field]
 272
 273         if type == "slice":
 274             if not "instantiation" in pl_record:
 275                 pl_record["instantiation"] = "plc-instantiated"
 276             pl_record["name"] = hrn_to_pl_slicename(hrn)
 277             if "url" in record:
 278                pl_record["url"] = record["url"]
 279             if "description" in record:
 280                 pl_record["description"] = record["description"]
 281
 282         elif type == "node":
 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"
 289
 290         elif type == "authority":
 291             pl_record["login_base"] = hrn_to_pl_login_base(hrn)
 292
 293             if not "name" in pl_record:
 294                 pl_record["name"] = hrn
 295
 296             if not "abbreviated_name" in pl_record:
 297                 pl_record["abbreviated_name"] = hrn
 298
 299             if not "enabled" in pl_record:
 300                 pl_record["enabled"] = True
 301
 302             if not "is_public" in pl_record:
 303                 pl_record["is_public"] = True
 304
 305         return pl_record
 306
 307     def fill_record_pl_info(self, record):
 308         """
 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.
 312
 313         PLC data is filled into the pl_info field of the record.
 314
 315         @param record: record to fill in field (in/out param)
 316         """
 317         type = record['type']
 318         pointer = record['pointer']
 319         auth_hrn = self.hrn
 320         login_base = ''
 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"
 324         if pointer == -1:
 325             record.update({})
 326             return
 327
 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])
 336         else:
 337             raise UnknownGeniType(type)
 338
 339         if not pl_res:
 340             raise PlanetLabRecordDoesNotExist(record['hrn'])
 341
 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'])
 346             site = sites[0]
 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'])
 372             pubkeys = []
 373             if keys:
 374                 pubkeys = [key['key'] for key in keys]
 375             pl_record['keys'] = pubkeys
 376
 377         record.update(pl_record)
 378
 379
 380
 381     def fill_record_geni_info(self, record):
 382         geni_info = {}
 383         type = record['type']
 384         table = GeniTable()
 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
 390
 391         elif (type == "authority"):
 392             person_ids = record.get("person_ids", [])
 393             persons = table.find({'type': 'user', 'pointer': person_ids})
 394             persons_dict = {}
 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']
 401
 402                 if pointer not in persons_dict:
 403                     # this means there is not sfa record for this user
 404                     continue
 405                 hrn = persons_dict[pointer]['hrn']
 406                 if 'pi' in person['roles']:
 407                     pis.append(hrn)
 408                 if 'tech' in person['roles']:
 409                     techs.append(hrn)
 410                 if 'admin' in person['roles']:
 411                     admins.append(hrn)
 412
 413             geni_info['PI'] = pis
 414             geni_info['operator'] = techs
 415             geni_info['owner'] = admins
 416             # xxx TODO: OrganizationName
 417
 418         elif (type == "node"):
 419             geni_info['dns'] = record.get("hostname", "")
 420             # xxx TODO: URI, LatLong, IP, DNS
 421
 422         elif (type == "user"):
 423             geni_info['email'] = record.get("email", "")
 424             # xxx TODO: PostalAddress, Phone
 425
 426         record.update(geni_info)
 427
 428     def fill_record_info(self, record):
 429         """
 430         Given a geni record, fill in the PLC specific and Geni specific
 431         fields in the record.
 432         """
 433         self.fill_record_pl_info(record)
 434         self.fill_record_geni_info(record)
 435
 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
 438         if oldRecord:
 439             oldList = oldRecord.get(listName, [])
 440         else:
 441             oldList = []
 442         newList = record.get(listName, [])
 443
 444         # if the lists are the same, then we don't have to update anything
 445         if (oldList == newList):
 446             return
 447
 448         # build a list of the new person ids, by looking up each person to get
 449         # their pointer
 450         newIdList = []
 451         table = GeniTable()
 452         records = table.find({'type': 'user', 'hrn': newList})
 453         for rec in records:
 454             newIdList.append(rec['pointer'])
 455
 456         # build a list of the old person ids from the person_ids field
 457         if oldRecord:
 458             oldIdList = oldRecord.get("person_ids", [])
 459             containerId = oldRecord.get_pointer()
 460         else:
 461             # if oldRecord==None, then we are doing a Register, instead of an
 462             # update.
 463             oldIdList = []
 464             containerId = record.get_pointer()
 465
 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)
 470
 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)
 475
 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":
 482             # xxx TODO
 483             pass
 484
 485
 486     def callable(self, method):
 487         """
 488         Return a new instance of the specified method.
 489         """
 490         # Look up method
 491         if method not in self.methods:
 492             raise GeniInvalidAPIMethod, method
 493
 494         # Get new instance of method
 495         try:
 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:
 501             raise
 502             raise GeniInvalidAPIMethod, method
 503
 504     def call(self, source, method, *args):
 505         """
 506         Call the named method from the specified source with the
 507         specified arguments.
 508         """
 509         function = self.callable(method)
 510         function.source = source
 511         return function(*args)
 512
 513     def handle(self, source, data):
 514         """
 515         Handle an XML-RPC or SOAP request from the specified source.
 516         """
 517         # Parse request into method name and arguments
 518         try:
 519             interface = xmlrpclib
 520             (args, method) = xmlrpclib.loads(data)
 521             methodresponse = True
 522         except Exception, e:
 523             if SOAPpy is not None:
 524                 interface = SOAPpy
 525                 (r, header, body, attrs) = parseSOAPRPC(data, header = 1, body = 1, attrs = 1)
 526                 method = r._name
 527                 args = r._aslist()
 528                 # XXX Support named arguments
 529             else:
 530                 raise e
 531
 532         try:
 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:
 538                 result = fault
 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))
 543             else:
 544                 raise
 545
 546         # Return result
 547         if interface == xmlrpclib:
 548             if not isinstance(result, GeniFault):
 549                 result = (result,)
 550
 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)
 554
 555         return data
 556