xmlrpcssl package¶
Subpackages¶
Submodules¶
xmlrpcssl.xmlrpcssl module¶
Xmlrpc server with SSL and configurable authentication plugin method
-
class
xmlrpcssl.xmlrpcssl.
BaseRequestHandler
(req, addr, server)[source]¶ Bases:
xmlrpcssl.xmlrpcssl.SecureXMLRPCRequestHandler
Base Handler providing methods to handle xmlrpc incoming requests
-
authenticate
(headers)[source]¶ Performs user authentication
Parameters: headers ( str
) – http/https headers received from clientReturns: 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
)
-
verify_user_credentials
()[source]¶ 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)[source]¶ 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
- server_address (