xmlrpcssl package

Subpackages

• xmlrpcssl.handlers package
  • Submodules
  • xmlrpcssl.handlers.ldap_handler module
  • Module contents

Submodules

xmlrpcssl.xmlrpcssl module

Xmlrpc server with SSL and configurable authentication plugin method

class xmlrpcssl.xmlrpcssl.BaseRequestHandler(req, addr, server)

Bases: xmlrpcssl.xmlrpcssl.SecureXMLRPCRequestHandler

Base Handler providing methods to handle xmlrpc incoming requests

authenticate(headers)

Performs user authentication

Parameters:headers (str) – http/https headers received from client Returns:True if user successfully authenticated, False otherwise Return type:ret (bool) Returns:Error message if authentication failed, None otherwise Return type:error_msg (str) Returns:Error code if authentication failed, None otherwise Return type:error_code (str)

parse_request()

Parses incoming requests and perform user authentication

verify_user_credentials()

Verify the user credentials

Returns:True if user successfully authenticated, False otherwise Return type:ret (bool) Returns:Error message if authentication failed, None otherwise Return type:error_msg (str) Returns:Error code if authentication failed, None otherwise Return type:error_code (str)

OBS: Must be overwritten with a proper authentication method in the child class

class xmlrpcssl.xmlrpcssl.SecureAuthenticatedXMLRPCServer(server_address, keyfile, certfile, **kwargs)

Bases: BaseHTTPServer.HTTPServer, SocketServer.BaseServer, SimpleXMLRPCServer.SimpleXMLRPCDispatcher

Xmlrpc server secured with ssl

Parameters:

• server_address (str) – ip address of the xmlrpc server
• keyfile (str) – path of the ssl/tls private keyfile generated for the xmlrpc server
• certfile (str) – path of the ssl/tls certificate file signed by the Certification Authority

Keyword Arguments:  

• log_requests (str,optional, default =True) – enable log all requests
• path (str,optional, default =’/’) – server http path
• RequestHandler (class,optional, default =BaseRequestHandler) – class to handle client requests
• ssl_version (int, optional, default = ssl.PROTOCOL_TLSv1) – ssl protocol version code

class xmlrpcssl.xmlrpcssl.SecureXMLRPCRequestHandler(req, addr, server)

Bases: SimpleXMLRPCServer.SimpleXMLRPCRequestHandler

Provides a ssl secured handler class for xmlrpc requests

do_POST()

Send POST responses with proper xml content

setup()

Perform prior base class initializations

Module contents