X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=api.py;h=8da28efa90f598dc7070069f5346cb9e3c4bb1fb;hb=refs%2Fheads%2Fplanetlab-4_0-branch;hp=73f38e797ca303deabb7326c34a8dd24e4ebd0b5;hpb=aac3e5d7c3443d6e1cb33525aefad35be5fe077a;p=nodemanager.git diff --git a/api.py b/api.py index 73f38e7..8da28ef 100644 --- a/api.py +++ b/api.py @@ -1,6 +1,15 @@ +"""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 SimpleXMLRPCServer import SocketServer -import cPickle import errno import os import pwd @@ -9,13 +18,19 @@ import struct import threading import xmlrpclib -from config import * import accounts import database import logger +import sliver_vs +import ticket import tools +API_SERVER_PORT = 812 +UNIX_ADDR = '/tmp/sliver_mgr.api' + +deliver_ticket = None # set in sm.py:start() + api_method_dict = {} nargs_dict = {} @@ -26,10 +41,6 @@ def export_to_api(nargs): 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(): @@ -37,16 +48,41 @@ def 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) +def Ticket(tkt): + """Ticket(tkt): deliver a ticket""" + try: + data = ticket.verify(tkt) + name = data['slivers'][0]['name'] + if data != None: + deliver_ticket(data) + logger.log('Ticket delivered for %s' % name) + Create(database.db.get(name)) + except Exception, err: + raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err)) + +@export_to_api(0) +def GetXIDs(): + """GetXIDs(): return an dictionary mapping slice names to XIDs""" + return dict([(pwent[0], pwent[2]) for pwent in pwd.getpwall() if pwent[6] == sliver_vs.Sliver_VS.SHELL]) + +@export_to_api(0) +def GetSSHKeys(): + """GetSSHKeys(): return an dictionary mapping slice names to SSH keys""" + keydict = {} + for rec in database.db.itervalues(): + if 'keys' in rec: + keydict[rec['name']] = rec['keys'] + return keydict + +@export_to_api(1) +def Create(rec): + """Create(sliver_name): create a non-PLC-instantiated sliver""" + if rec['instantiation'] == 'delegated': 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() +def Destroy(rec): + """Destroy(sliver_name): destroy a non-PLC-instantiated sliver""" + if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_destroyed() @export_to_api(1) def Start(rec): @@ -61,96 +97,82 @@ def Stop(rec): @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', {})) + return rec.get('_rspec', {}).copy() @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', {})) + return rec.get('rspec', {}).copy() @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', [])) + return 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 + 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 database.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() + 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.db.sync() class APIRequestHandler(SimpleXMLRPCServer.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 = api_method_dict.keys() + api_method_list.sort() + raise xmlrpclib.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 xmlrpclib.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) + ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, sizeof_struct_ucred) xid = struct.unpack('3i', ucred)[2] caller_name = pwd.getpwuid(xid)[0] - - if expected_nargs >= 1: + if method_name not in ('ReCreate', 'Help', 'Ticket', 'GetXIDs', 'GetSSHKeys'): 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']: + target_rec = database.db.get(target_name) + if not (target_rec and target_rec['type'].startswith('sliver.')): + raise xmlrpclib.Fault(102, \ + 'Invalid argument: the first argument must be a sliver name.') + if not caller_name in (target_name, 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() + else: result = method(*args) if result == None: result = 1 return result -class APIServer_INET(SocketServer.ThreadingMixIn, - SimpleXMLRPCServer.SimpleXMLRPCServer): - allow_reuse_address = True +class APIServer_INET(SocketServer.ThreadingMixIn, SimpleXMLRPCServer.SimpleXMLRPCServer): allow_reuse_address = True class APIServer_UNIX(APIServer_INET): address_family = socket.AF_UNIX def start(): - serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), - requestHandler=APIRequestHandler, logRequests=0) + """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) tools.as_daemon_thread(serv1.serve_forever) - unix_addr = '/tmp/node_mgr_api' - try: os.unlink(unix_addr) + try: os.unlink(UNIX_ADDR) except OSError, 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, 0666)