X-Git-Url: http://git.onelab.eu/?p=nodemanager.git;a=blobdiff_plain;f=api.py;h=756c89490ab34b57c533883f2b578b145b0b7031;hp=97d35d9124871030ba83f1ce7e328b2cd0771796;hb=HEAD;hpb=dfbec103d5234340d11f454c70c82891e5ac9344 diff --git a/api.py b/api.py index 97d35d9..756c894 100644 --- a/api.py +++ b/api.py @@ -1,160 +1,112 @@ -import SimpleXMLRPCServer -import SocketServer -import cPickle +# +"""Sliver manager API. + +This module exposes an XMLRPC interface that allows PlanetLab users to +create/destroy slivers with delegated instantiation, start and stop +slivers, make resource loans, and examine resource allocations. The +XMLRPC is provided on a localhost-only TCP port as well as via a Unix +domain socket that is accessible by ssh-ing into a delegate account +with the forward_api_calls shell. +""" + +import xmlrpc.server +import socketserver import errno import os import pwd import socket import struct import threading -import xmlrpclib +import xmlrpc.client +import sys -import accounts import database -import logger import tools +from api_calls import * +import logger +try: + sys.path.append("/etc/planetlab") + from plc_config import * +except: + logger.log("api: Warning: Configuration file /etc/planetlab/plc_config.py not found", 2) + PLC_SLICE_PREFIX="pl" + logger.log("api: Warning: admin slice prefix set to %s" %(PLC_SLICE_PREFIX), 2) API_SERVER_PORT = 812 +UNIX_ADDR = '/tmp/nodemanager.api' - -api_method_dict = {} -nargs_dict = {} - -def export_to_api(nargs): - def export(method): - nargs_dict[method.__name__] = nargs - api_method_dict[method.__name__] = method - return method - return export - -@export_to_api(0) -def DumpDatabase(): - """DumpDatabase(): return the entire node manager DB, pickled""" - return cPickle.dumps(dict(database._db), 0) - -@export_to_api(0) -def Help(): - """Help(): get help""" - return ''.join([method.__doc__ + '\n' for method in api_method_dict.itervalues()]) - -@export_to_api(1) -def CreateSliver(rec): - """CreateSliver(sliver_name): set up a non-PLC-instantiated sliver""" - if not rec['plc_instantiated']: - accounts.get(rec['name']).ensure_created(rec) - -@export_to_api(1) -def DeleteSliver(rec): - """DeleteSliver(sliver_name): tear down a non-PLC-instantiated sliver""" - if not rec['plc_instantiated']: - accounts.get(rec['name']).ensure_destroyed() - -@export_to_api(1) -def Start(rec): - """Start(sliver_name): run start scripts belonging to the specified sliver""" - accounts.get(rec['name']).start() - -@export_to_api(1) -def Stop(rec): - """Stop(sliver_name): kill all processes belonging to the specified sliver""" - accounts.get(rec['name']).stop() - -@export_to_api(1) -def GetEffectiveRSpec(rec): - """GetEffectiveRSpec(sliver_name): return the RSpec allocated to the specified sliver, including loans""" - return tools.deepcopy(rec.get('eff_rspec', {})) - -@export_to_api(1) -def GetRSpec(rec): - """GetRSpec(sliver_name): return the RSpec allocated to the specified sliver, excluding loans""" - return tools.deepcopy(rec.get('rspec', {})) - -@export_to_api(1) -def GetLoans(rec): - """GetLoans(sliver_name): return the list of loans made by the specified sliver""" - return tools.deepcopy(rec.get('loans', [])) - -def validate_loans(obj): - """Check that is a valid loan specification.""" - def validate_loan(obj): - return (type(obj)==list or type(obj)==tuple) and len(obj)==3 and \ - type(obj[0])==str and \ - type(obj[1])==str and obj[1] in LOANABLE_RESOURCES and \ - type(obj[2])==int and obj[2]>0 - return type(obj)==list and False not in map(validate_loan, obj) - -@export_to_api(2) -def SetLoans(rec, loans): - """SetLoans(sliver_name, loans): overwrite the list of loans made by the specified sliver""" - if not validate_loans(loans): - raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification') - rec['loans'] = loans - database.deliver_records([rec]) - -api_method_list = api_method_dict.keys() -api_method_list.sort() - - -class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler): +class APIRequestHandler(xmlrpc.server.SimpleXMLRPCRequestHandler): # overriding _dispatch to achieve this effect is officially deprecated, - # but I can't figure out how to get access to .request - # without duplicating SimpleXMLRPCServer code here, - # which is more likely to change than the deprecated behavior - # is to be broken + # but I can't figure out how to get access to .request without + # duplicating SimpleXMLRPCServer code here, which is more likely to + # change than the deprecated behavior is to be broken @database.synchronized - def _dispatch(self, method_name, args): - method_name = str(method_name) + def _dispatch(self, method_name_unicode, args): + method_name = str(method_name_unicode) try: method = api_method_dict[method_name] except KeyError: - raise xmlrpclib.Fault(100, 'Invalid API method %s. Valid choices are %s' % (method_name, ', '.join(api_method_list))) - + api_method_list = list(api_method_dict.keys()) + api_method_list.sort() + raise xmlrpc.client.Fault(100, 'Invalid API method %s. Valid choices are %s' % \ + (method_name, ', '.join(api_method_list))) expected_nargs = nargs_dict[method_name] - if len(args) != nargs_dict[method_name]: - raise xmlrpclib.Fault(101, 'Invalid argument count: got %d, expecting %d.' % (len(args), expected_nargs)) + if len(args) != expected_nargs: + raise xmlrpc.client.Fault(101, 'Invalid argument count: got %d, expecting %d.' % \ + (len(args), expected_nargs)) else: # Figure out who's calling. # XXX - these ought to be imported directly from some .h file SO_PEERCRED = 17 sizeof_struct_ucred = 12 - ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, - sizeof_struct_ucred) - xid = struct.unpack('3i', ucred)[2] + ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, sizeof_struct_ucred) + xid = struct.unpack('3i', ucred)[1] caller_name = pwd.getpwuid(xid)[0] - - if expected_nargs >= 1: - target_name = args[0] - target_rec = database.get_sliver(target_name) - if not target_rec: raise xmlrpclib.Fault(102, 'Invalid argument: the first argument must be a sliver name.') - - if caller_name not in (args[0], 'root') and \ - (caller_name, method_name) not in target_rec['delegations']: - raise xmlrpclib.Fault(108, 'Permission denied.') - result = method(target_rec, *args[1:]) - else: - if method_name == 'DumpDatabase' and caller_name != 'root': - raise xmlrpclib.Fault(108, 'Permission denied.') - result = method() + # Special case : the sfa component manager + if caller_name == PLC_SLICE_PREFIX+"_sfacm": + try: result = method(*args) + except Exception as err: raise xmlrpc.client.Fault(104, 'Error in call: %s' %err) + # Anyone can call these functions + elif method_name in ('Help', 'Ticket', 'GetXIDs', 'GetSSHKeys'): + try: result = method(*args) + except Exception as err: raise xmlrpc.client.Fault(104, 'Error in call: %s' %err) + else: # Execute anonymous call. + # Authenticate the caller if not in the above fncts. + if method_name == "GetRecord": + target_name = caller_name + else: + target_name = args[0] + + # Gather target slice's object. + target_rec = database.db.get(target_name) + + # only work on slivers or self. Sanity check. + if not (target_rec and target_rec['type'].startswith('sliver.')): + raise xmlrpc.client.Fault(102, \ + 'Invalid argument: the first argument must be a sliver name.') + + # only manipulate slivers who delegate you authority + if caller_name in (target_name, target_rec['delegations']): + try: result = method(target_rec, *args[1:]) + except Exception as err: raise xmlrpc.client.Fault(104, 'Error in call: %s' %err) + else: + raise xmlrpc.client.Fault(108, '%s: Permission denied.' % caller_name) if result == None: result = 1 return result -class APIServer_INET(SocketServer.ThreadingMixIn, - SimpleXMLRPCServer.SimpleXMLRPCServer): - allow_reuse_address = True +class APIServer_INET(socketserver.ThreadingMixIn, xmlrpc.server.SimpleXMLRPCServer): allow_reuse_address = True class APIServer_UNIX(APIServer_INET): address_family = socket.AF_UNIX def start(): """Start two XMLRPC interfaces: one bound to localhost, the other bound to a Unix domain socket.""" - serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), - requestHandler=APIRequestHandler, logRequests=0) + logger.log('api.start') + serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), requestHandler=APIRequestHandler, logRequests=0) tools.as_daemon_thread(serv1.serve_forever) - unix_addr = '/tmp/node_mgr_api' - try: os.unlink(unix_addr) - except OSError, e: + try: os.unlink(UNIX_ADDR) + except OSError as e: if e.errno != errno.ENOENT: raise - serv2 = APIServer_UNIX(unix_addr, - requestHandler=APIRequestHandler, logRequests=0) + serv2 = APIServer_UNIX(UNIX_ADDR, requestHandler=APIRequestHandler, logRequests=0) tools.as_daemon_thread(serv2.serve_forever) - os.chmod(unix_addr, 0666) + os.chmod(UNIX_ADDR, 0o666)