3 This module exposes an XMLRPC interface that allows PlanetLab users to
4 create/destroy slivers with delegated instantiation, start and stop
5 slivers, make resource loans, and examine resource allocations. The
6 XMLRPC is provided on a localhost-only TCP port as well as via a Unix
7 domain socket that is accessible by ssh-ing into a delegate account
8 with the forward_api_calls shell.
11 import SimpleXMLRPCServer
30 UNIX_ADDR = '/tmp/sliver_mgr.api'
32 deliver_ticket = None # set in sm.py:start()
34 from api_calls import *
36 class APIRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
37 # overriding _dispatch to achieve this effect is officially deprecated,
38 # but I can't figure out how to get access to .request without
39 # duplicating SimpleXMLRPCServer code here, which is more likely to
40 # change than the deprecated behavior is to be broken
42 @database.synchronized
43 def _dispatch(self, method_name_unicode, args):
44 method_name = str(method_name_unicode)
45 try: method = api_method_dict[method_name]
47 api_method_list = api_method_dict.keys()
48 api_method_list.sort()
49 raise xmlrpclib.Fault(100, 'Invalid API method %s. Valid choices are %s' % \
50 (method_name, ', '.join(api_method_list)))
51 expected_nargs = nargs_dict[method_name]
52 if len(args) != expected_nargs:
53 raise xmlrpclib.Fault(101, 'Invalid argument count: got %d, expecting %d.' % \
54 (len(args), expected_nargs))
56 # Figure out who's calling.
57 # XXX - these ought to be imported directly from some .h file
59 sizeof_struct_ucred = 12
60 ucred = self.request.getsockopt(socket.SOL_SOCKET, SO_PEERCRED, sizeof_struct_ucred)
61 xid = struct.unpack('3i', ucred)[2]
62 caller_name = pwd.getpwuid(xid)[0]
63 if method_name not in ('ReCreate', 'Help', 'Ticket', 'GetXIDs', 'GetSSHKeys'):
65 target_rec = database.db.get(target_name)
66 if not (target_rec and target_rec['type'].startswith('sliver.')):
67 raise xmlrpclib.Fault(102, \
68 'Invalid argument: the first argument must be a sliver name.')
69 if not caller_name in (target_name, target_rec['delegations']):
70 raise xmlrpclib.Fault(108, 'Permission denied.')
71 result = method(target_rec, *args[1:])
72 else: result = method(*args)
73 if result == None: result = 1
76 class APIServer_INET(SocketServer.ThreadingMixIn, SimpleXMLRPCServer.SimpleXMLRPCServer): allow_reuse_address = True
78 class APIServer_UNIX(APIServer_INET): address_family = socket.AF_UNIX
81 """Start two XMLRPC interfaces: one bound to localhost, the other bound to a Unix domain socket."""
82 serv1 = APIServer_INET(('127.0.0.1', API_SERVER_PORT), requestHandler=APIRequestHandler, logRequests=0)
83 tools.as_daemon_thread(serv1.serve_forever)
84 try: os.unlink(UNIX_ADDR)
86 if e.errno != errno.ENOENT: raise
87 serv2 = APIServer_UNIX(UNIX_ADDR, requestHandler=APIRequestHandler, logRequests=0)
88 tools.as_daemon_thread(serv2.serve_forever)
89 os.chmod(UNIX_ADDR, 0666)