X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=api.py;h=8da28efa90f598dc7070069f5346cb9e3c4bb1fb;hb=refs%2Fheads%2Fplanetlab-4_0-branch;hp=c4dec5749887e97df07d319ae707927327affa66;hpb=af198e0763c05705ba87a1753209b17df38e3f69;p=nodemanager.git diff --git a/api.py b/api.py index c4dec57..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 @@ -12,12 +21,15 @@ import xmlrpclib import accounts import database import logger +import sliver_vs +import ticket import tools API_SERVER_PORT = 812 -UNIX_ADDR = '/tmp/node_mgr.api' +UNIX_ADDR = '/tmp/sliver_mgr.api' +deliver_ticket = None # set in sm.py:start() api_method_dict = {} nargs_dict = {} @@ -36,13 +48,40 @@ def Help(): return ''.join([method.__doc__ + '\n' for method in api_method_dict.itervalues()]) @export_to_api(1) -def CreateSliver(rec): - """CreateSliver(sliver_name): create a non-PLC-instantiated sliver""" +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 DestroySliver(rec): - """DestroySliver(sliver_name): destroy a non-PLC-instantiated sliver""" +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) @@ -68,11 +107,11 @@ def GetRSpec(rec): @export_to_api(1) def GetLoans(rec): """GetLoans(sliver_name): return the list of loans made by the specified sliver""" - return rec.get('_loans', []).copy() + 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 database.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) @@ -96,9 +135,12 @@ class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler): except KeyError: 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))) + 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) != expected_nargs: 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 @@ -107,13 +149,16 @@ class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler): 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.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 (args[0], 'root') or (caller_name, method_name) in target_rec['delegations']): raise xmlrpclib.Fault(108, 'Permission denied.') + 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: result = method() + else: result = method(*args) if result == None: result = 1 return result