tlslite.integration.xmlrpctransport module

TLS Lite + xmlrpclib.

class tlslite.integration.xmlrpctransport.XMLRPCTransport(use_datetime=0, username=None, password=None, certChain=None, privateKey=None, checker=None, settings=None, ignoreAbruptClose=False)[source]

Bases: Transport, ClientHelper

Handles an HTTPS transaction to an XML-RPC server.

__init__(use_datetime=0, username=None, password=None, certChain=None, privateKey=None, checker=None, settings=None, ignoreAbruptClose=False)[source]

Create a new XMLRPCTransport.

An instance of this class can be passed to xmlrpclib.ServerProxy to use TLS with XML-RPC calls:

from tlslite import XMLRPCTransport
from xmlrpclib import ServerProxy

transport = XMLRPCTransport(user="alice", password="abra123")
server = ServerProxy("https://localhost", transport)

For client authentication, use one of these argument combinations:

  • username, password (SRP)

  • certChain, privateKey (certificate)

For server authentication, you can either rely on the implicit mutual authentication performed by SRP or you can do certificate-based server authentication with one of these argument combinations:

  • x509Fingerprint

Certificate-based server authentication is compatible with SRP or certificate-based client authentication.

The constructor does not perform the TLS handshake itself, but simply stores these arguments for later. The handshake is performed only when this class needs to connect with the server. Thus you should be prepared to handle TLS-specific exceptions when calling methods of xmlrpclib.ServerProxy. See the client handshake functions in TLSConnection for details on which exceptions might be raised.

Parameters:

  • username (str) – SRP username. Requires the ‘password’ argument.

  • password (str) – SRP password for mutual authentication. Requires the ‘username’ argument.

  • certChain (X509CertChain) – Certificate chain for client authentication. Requires the ‘privateKey’ argument. Excludes the SRP arguments.

  • privateKey (RSAKey) – Private key for client authentication. Requires the ‘certChain’ argument. Excludes the SRP arguments.

  • checker (Checker) – Callable object called after handshaking to evaluate the connection and raise an Exception if necessary.

  • settings (HandshakeSettings) – Various settings which can be used to control the ciphersuites, certificate types, and SSL/TLS versions offered by the client.

  • ignoreAbruptClose (bool) – ignore the TLSAbruptCloseError on unexpected hangup.

conn_class_is_http = False
make_connection(host)[source]

Make a connection to host. Reuse keepalive connections.