fix threading, ignore operation in decode_authentication when it is none
[sfa.git] / util / geniserver.py
index c4cd60a..b997571 100644 (file)
@@ -1,34 +1,35 @@
-# geniserver.py
-#
-# geniwrapper server
-#
-# implements a general-purpose server layer for geni. This should be usable on
-# the registry, component, or other interfaces.
+##
+# This module implements a general-purpose server layer for geni.
+# The same basic server should be usable on the registry, component, or
+# other interfaces.
 #
 # TODO: investigate ways to combine this with existing PLC server?
+##
 
 import SimpleXMLRPCServer
 
+import sys
+import traceback
+import threading
 import SocketServer
-import BaseHTTPServer\r
-import SimpleHTTPServer\r
-import SimpleXMLRPCServer\r
-\r
-from excep import *\r
-from cert import *\r
-from credential import *\r
-\r
-import socket, os\r
-from OpenSSL import SSL\r
-\r
-# verify_callback\r
-#\r
-# verification callback for pyOpenSSL. We do our own checking of keys because\r
-# we have our own authentication spec. Thus we disable several of the normal\r
-# prohibitions that OpenSSL places on certificates\r
-\r
-def verify_callback(conn, x509, err, depth, preverify):\r
-    # if the cert has been preverified, then it is ok\r
+import BaseHTTPServer
+import SimpleHTTPServer
+import SimpleXMLRPCServer
+
+from excep import *
+from cert import *
+from credential import *
+
+import socket, os
+from OpenSSL import SSL
+
+##
+# Verification callback for pyOpenSSL. We do our own checking of keys because
+# we have our own authentication spec. Thus we disable several of the normal
+# prohibitions that OpenSSL places on certificates
+
+def verify_callback(conn, x509, err, depth, preverify):
+    # if the cert has been preverified, then it is ok
     if preverify:
        #print "  preverified"
        return 1
@@ -48,6 +49,12 @@ def verify_callback(conn, x509, err, depth, preverify):
     # that we aren't interested in, so we look out for those error messages
     # and ignore them
 
+    # XXX SMBAKER: I don't know what this error is, but it's being returned
+    # by newer pl nodes.
+    if err == 9:
+       #print "  X509_V_ERR_CERT_NOT_YET_VALID"
+       return 1
+
     # allow self-signed certificates
     if err == 18:
        #print "  X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT"
@@ -71,96 +78,124 @@ def verify_callback(conn, x509, err, depth, preverify):
     print "  error", err, "in verify_callback"
 
     return 0\r
-\r
-# SecureXMLServer\r
-#\r
-# taken from the web (XXX find reference). Implements an HTTPS xmlrpc server\r
-
-class SecureXMLRPCServer(BaseHTTPServer.HTTPServer,SimpleXMLRPCServer.SimpleXMLRPCDispatcher):\r
-    def __init__(self, server_address, HandlerClass, key_file, cert_file, logRequests=True):\r
-        """Secure XML-RPC server.\r
-\r
-        It it very similar to SimpleXMLRPCServer but it uses HTTPS for transporting XML data.\r
-        """\r
-        self.logRequests = logRequests\r
-\r
-        SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__(self, None, None)\r
-        SocketServer.BaseServer.__init__(self, server_address, HandlerClass)\r
-        ctx = SSL.Context(SSL.SSLv23_METHOD)\r
-        ctx.use_privatekey_file(key_file)\r
-        ctx.use_certificate_file(cert_file)\r
-        ctx.set_verify(SSL.VERIFY_PEER | SSL.VERIFY_FAIL_IF_NO_PEER_CERT, verify_callback)\r
-        ctx.set_app_data(self)\r
-        self.socket = SSL.Connection(ctx, socket.socket(self.address_family,\r
-                                                        self.socket_type))\r
-        self.server_bind()\r
-        self.server_activate()\r
-\r
-# SecureXMLRpcRequestHandler\r
-#\r
-# taken from the web (XXX find reference). Implents HTTPS xmlrpc request handler\r
-\r
-class SecureXMLRpcRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):\r
-    """Secure XML-RPC request handler class.\r
-\r
-    It it very similar to SimpleXMLRPCRequestHandler but it uses HTTPS for transporting XML data.\r
-    """\r
-    def setup(self):\r
-        self.connection = self.request\r
-        self.rfile = socket._fileobject(self.request, "rb", self.rbufsize)\r
-        self.wfile = socket._fileobject(self.request, "wb", self.wbufsize)\r
-\r
-    def do_POST(self):\r
-        """Handles the HTTPS POST request.\r
-\r
-        It was copied out from SimpleXMLRPCServer.py and modified to shutdown the socket cleanly.\r
-        """\r
-\r
-        try:\r
-            # get arguments\r
-            data = self.rfile.read(int(self.headers["content-length"]))\r
-            # In previous versions of SimpleXMLRPCServer, _dispatch\r
-            # could be overridden in this class, instead of in\r
-            # SimpleXMLRPCDispatcher. To maintain backwards compatibility,\r
-            # check to see if a subclass implements _dispatch and dispatch\r
-            # using that method if present.\r
-            response = self.server._marshaled_dispatch(\r
-                    data, getattr(self, '_dispatch', None)\r
-                )\r
-        except: # This should only happen if the module is buggy\r
-            # internal error, report as HTTP server error\r
-            self.send_response(500)\r
-            self.end_headers()\r
-        else:\r
-            # got a valid XML RPC response\r
-            self.send_response(200)\r
-            self.send_header("Content-type", "text/xml")\r
-            self.send_header("Content-length", str(len(response)))\r
-            self.end_headers()\r
-            self.wfile.write(response)\r
-\r
-            # shut down the connection\r
-            self.wfile.flush()\r
-            self.connection.shutdown() # Modified here!\r
-
-# GeniServer
-#
-# Class for a general purpose geni server.
-#
+
+##
+# Taken from the web (XXX find reference). Implements an HTTPS xmlrpc server
+
+class SecureXMLRPCServer(BaseHTTPServer.HTTPServer,SimpleXMLRPCServer.SimpleXMLRPCDispatcher):
+    def __init__(self, server_address, HandlerClass, key_file, cert_file, logRequests=True):
+        """Secure XML-RPC server.
+
+        It it very similar to SimpleXMLRPCServer but it uses HTTPS for transporting XML data.
+        """
+        self.logRequests = logRequests
+
+        SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__(self, True, None)
+        SocketServer.BaseServer.__init__(self, server_address, HandlerClass)
+        ctx = SSL.Context(SSL.SSLv23_METHOD)
+        ctx.use_privatekey_file(key_file)
+        ctx.use_certificate_file(cert_file)
+        ctx.set_verify(SSL.VERIFY_PEER | SSL.VERIFY_FAIL_IF_NO_PEER_CERT, verify_callback)
+        ctx.set_app_data(self)
+        self.socket = SSL.Connection(ctx, socket.socket(self.address_family,
+                                                        self.socket_type))
+        self.server_bind()
+        self.server_activate()
+
+    # _dispatch
+    #
+    # Convert an exception on the server to a full stack trace and send it to
+    # the client.
+
+    def _dispatch(self, method, params):
+        try:
+            return SimpleXMLRPCServer.SimpleXMLRPCDispatcher._dispatch(self, method, params)
+        except:
+            # can't use format_exc() as it is not available in jython yet
+            # (evein in trunk).
+            type, value, tb = sys.exc_info()
+            raise xmlrpclib.Fault(1,''.join(traceback.format_exception(type, value, tb)))
+
+##
+# taken from the web (XXX find reference). Implents HTTPS xmlrpc request handler
+
+class SecureXMLRpcRequestHandler(SimpleXMLRPCServer.SimpleXMLRPCRequestHandler):
+    """Secure XML-RPC request handler class.
+
+    It it very similar to SimpleXMLRPCRequestHandler but it uses HTTPS for transporting XML data.
+    """
+    def setup(self):
+        self.connection = self.request
+        self.rfile = socket._fileobject(self.request, "rb", self.rbufsize)
+        self.wfile = socket._fileobject(self.request, "wb", self.wbufsize)
+
+    def do_POST(self):
+        """Handles the HTTPS POST request.
+
+        It was copied out from SimpleXMLRPCServer.py and modified to shutdown the socket cleanly.
+        """
+
+        try:
+            # get arguments
+            data = self.rfile.read(int(self.headers["content-length"]))
+            # In previous versions of SimpleXMLRPCServer, _dispatch
+            # could be overridden in this class, instead of in
+            # SimpleXMLRPCDispatcher. To maintain backwards compatibility,
+            # check to see if a subclass implements _dispatch and dispatch
+            # using that method if present.
+            response = self.server._marshaled_dispatch(
+                    data, getattr(self, '_dispatch', None)
+                )
+        except: # This should only happen if the module is buggy
+            # internal error, report as HTTP server error
+            self.send_response(500)
+
+            self.end_headers()
+        else:
+            # got a valid XML RPC response
+            self.send_response(200)
+            self.send_header("Content-type", "text/xml")
+            self.send_header("Content-length", str(len(response)))
+            self.end_headers()
+            self.wfile.write(response)
+
+            # shut down the connection
+            self.wfile.flush()
+            self.connection.shutdown() # Modified here!
+
+##
 # Implements an HTTPS XML-RPC server. Generally it is expected that GENI
 # functions will take a credential string, which is passed to
 # decode_authentication. Decode_authentication() will verify the validity of
 # the credential, and verify that the user is using the key that matches the
 # GID supplied in the credential.
 
-class GeniServer():
+class GeniServer(threading.Thread):
+
+    ##
+    # Create a new GeniServer object.
+    #
+    # @param ip the ip address to listen on
+    # @param port the port to listen on
+    # @param key_file private key filename of registry
+    # @param cert_file certificate filename containing public key 
+    #   (could be a GID file)
+
     def __init__(self, ip, port, key_file, cert_file):
+        threading.Thread.__init__(self)
         self.key = Keypair(filename = key_file)
         self.cert = Certificate(filename = cert_file)
         self.server = SecureXMLRPCServer((ip, port), SecureXMLRpcRequestHandler, key_file, cert_file)
+        self.trusted_cert_list = None
         self.register_functions()
 
-    def decode_authentication(self, cred_string):
+    ##
+    # Decode the credential string that was submitted by the caller. Several
+    # checks are performed to ensure that the credential is valid, and that the
+    # callerGID included in the credential matches the caller that is
+    # connected to the HTTPS connection.
+
+    def decode_authentication(self, cred_string, operation):
         self.client_cred = Credential(string = cred_string)
         self.client_gid = self.client_cred.get_gid_caller()
         self.object_gid = self.client_cred.get_gid_object()
@@ -169,20 +204,42 @@ class GeniServer():
         if not self.client_gid:
             raise MissingCallerGID(self.client_cred.get_subject())
 
-        # make sure the client_gid matches the certificate that the client is using
+        # make sure the client_gid matches client's certificate
         peer_cert = self.server.peer_cert
         if not peer_cert.is_pubkey(self.client_gid.get_pubkey()):
             raise ConnectionKeyGIDMismatch(self.client_gid.get_subject())
 
-    # register_functions override this to add more functions
+        # make sure the client is allowed to perform the operation
+        if operation:
+            if not self.client_cred.can_perform(operation):
+                raise InsufficientRights(operation)
+
+        if self.trusted_cert_list:
+            self.client_cred.verify_chain(self.trusted_cert_list)
+            if self.client_gid:
+                self.client_gid.verify_chain(self.trusted_cert_list)
+            if self.object_gid:
+                self.object_gid.verify_chain(self.trusted_cert_list)
+
+    ##
+    # Register functions that will be served by the XMLRPC server. This
+    # function should be overrided by each descendant class.
+
     def register_functions(self):
         self.server.register_function(self.noop)
 
+    ##
+    # Sample no-op server function. The no-op function decodes the credential
+    # that was passed to it.
+
     def noop(self, cred, anything):
         self.decode_authentication(cred)
 
         return anything
 
+    ##
+    # Execute the server, serving requests forever. 
+
     def run(self):
         self.server.serve_forever()