class SslClient(object):
"""
High level API implementing an insecure SSL client.
"""
def __init__(self,
sock=None,
sslVersion=SSLV23,
sslVerify=SSL_VERIFY_PEER,
sslVerifyLocations=None):
# A Python socket handles transmission of the data
self._sock = sock
self._handshakeDone = False
# OpenSSL objects
# SSL_CTX
self._sslCtx = SSL_CTX(sslVersion)
self._sslCtx.set_verify(sslVerify)
if sslVerifyLocations:
self._sslCtx.load_verify_locations(sslVerifyLocations)
# SSL
self._ssl = SSL(self._sslCtx)
self._ssl.set_connect_state()
# Specific servers do not reply to a client hello that is bigger than 255 bytes
# See http://rt.openssl.org/Ticket/Display.html?id=2771&user=guest&pass=guest
# So we make the default cipher list smaller (to make the client hello smaller)
if sslVersion != SSLV2: # This makes SSLv2 fail
self._ssl.set_cipher_list(
'HIGH:-aNULL:-eNULL:-3DES:-SRP:-PSK:-CAMELLIA')
# BIOs
self._internalBio = BIO()
self._networkBio = BIO()
# http://www.openssl.org/docs/crypto/BIO_s_bio.html
BIO.make_bio_pair(self._internalBio, self._networkBio)
self._ssl.set_bio(self._internalBio)
def do_handshake(self):
if (self._sock == None):
# TODO: Auto create a socket ?
raise IOError(
'Internal socket set to None; cannot perform handshake.')
while True:
try:
if self._ssl.do_handshake() == 1:
self._handshakeDone = True
return True # Handshake was successful
except WantReadError:
# OpenSSL is expecting more data from the peer
# Send available handshake data to the peer
lenToRead = self._networkBio.pending()
while lenToRead:
# Get the data from the SSL engine
handshakeDataOut = self._networkBio.read(lenToRead)
# Send it to the peer
self._sock.send(handshakeDataOut)
lenToRead = self._networkBio.pending()
# Recover the peer's encrypted response
handshakeDataIn = self._sock.recv(DEFAULT_BUFFER_SIZE)
if len(handshakeDataIn) == 0:
raise IOError(
'Nassl SSL handshake failed: peer did not send data back.'
)
# Pass the data to the SSL engine
self._networkBio.write(handshakeDataIn)
except WantX509LookupError:
# Server asked for a client certificate and we didn't provide one
raise ClientCertificateRequested(
self._ssl.get_client_CA_list())
def read(self, size):
if (self._handshakeDone == False):
raise IOError(
'SSL Handshake was not completed; cannot receive data.')
while True:
# Receive available encrypted data from the peer
encData = self._sock.recv(DEFAULT_BUFFER_SIZE)
# Pass it to the SSL engine
self._networkBio.write(encData)
try:
# Try to read the decrypted data
decData = self._ssl.read(size)
return decData
except WantReadError:
# The SSL engine needs more data
# before it can decrypt the whole message
pass
def write(self, data):
"""
Returns the number of (encrypted) bytes sent.
"""
if (self._handshakeDone == False):
raise IOError('SSL Handshake was not completed; cannot send data.')
# Pass the cleartext data to the SSL engine
self._ssl.write(data)
# Recover the corresponding encrypted data
lenToRead = self._networkBio.pending()
finalLen = lenToRead
while lenToRead:
encData = self._networkBio.read(lenToRead)
# Send the encrypted data to the peer
self._sock.send(encData)
lenToRead = self._networkBio.pending()
finalLen += lenToRead
return finalLen
def shutdown(self):
self._handshakeDone = False
try:
self._ssl.shutdown()
except OpenSSLError as e:
# Ignore "uninitialized" exception
if 'SSL_shutdown:uninitialized' not in str(e):
raise
def get_secure_renegotiation_support(self):
return self._ssl.get_secure_renegotiation_support()
def get_current_compression_method(self):
return self._ssl.get_current_compression_method()
@staticmethod
def get_available_compression_methods():
"""
Returns the list of SSL compression methods supported by SslClient.
"""
return SSL.get_available_compression_methods()
def set_verify(self, verifyMode):
return self._ssl.set_verify(verifyMode)
def set_tlsext_host_name(self, nameIndication):
return self._ssl.set_tlsext_host_name(nameIndication)
def get_peer_certificate(self):
_x509 = self._ssl.get_peer_certificate()
if _x509:
return X509Certificate(_x509)
else:
return None
def set_cipher_list(self, cipherList):
return self._ssl.set_cipher_list(cipherList)
def get_cipher_list(self):
return self._ssl.get_cipher_list()
def get_current_cipher_name(self):
return self._ssl.get_cipher_name()
def get_current_cipher_bits(self):
return self._ssl.get_cipher_bits()
def use_private_key(self,
certFile,
certType,
keyFile,
keyType,
keyPassword=''):
self._ssl.use_certificate_file(certFile, certType)
if isinstance(keyPassword, basestring):
self._sslCtx.set_private_key_password(keyPassword)
else:
raise TypeError('keyPassword is not a string')
self._ssl.use_PrivateKey_file(keyFile, keyType)
return self._ssl.check_private_key()
def get_certificate_chain_verify_result(self):
verifyResult = self._ssl.get_verify_result()
verifyResultStr = X509.verify_cert_error_string(verifyResult)
return (verifyResult, verifyResultStr)
def do_renegotiate(self):
if (self._handshakeDone == False):
raise IOError(
'SSL Handshake was not completed; cannot renegotiate.')
self._ssl.renegotiate()
return self.do_handshake()
def get_session(self):
return self._ssl.get_session()
def set_session(self, sslSession):
return self._ssl.set_session(sslSession)
def set_options(self, options):
return self._ssl.set_options(options)
def set_tlsext_status_ocsp(self):
return self._ssl.set_tlsext_status_type(TLSEXT_STATUSTYPE_ocsp)
def get_tlsext_status_ocsp_resp(self):
ocspResp = self._ssl.get_tlsext_status_ocsp_resp()
if ocspResp:
return OcspResponse(ocspResp)
else:
return None
class SslClient(object):
"""
High level API implementing an insecure SSL client.
"""
def __init__(self, sock=None, sslVersion=SSLV23, sslVerify=SSL_VERIFY_PEER, sslVerifyLocations=None):
# A Python socket handles transmission of the data
self._sock = sock
self._handshakeDone = False
# OpenSSL objects
# SSL_CTX
self._sslCtx = SSL_CTX(sslVersion)
self._sslCtx.set_verify(sslVerify)
if sslVerifyLocations:
self._sslCtx.load_verify_locations(sslVerifyLocations)
# SSL
self._ssl = SSL(self._sslCtx)
self._ssl.set_connect_state()
# Specific servers do not reply to a client hello that is bigger than 255 bytes
# See http://rt.openssl.org/Ticket/Display.html?id=2771&user=guest&pass=guest
# So we make the default cipher list smaller (to make the client hello smaller)
if sslVersion != SSLV2: # This makes SSLv2 fail
self._ssl.set_cipher_list('HIGH:-aNULL:-eNULL:-3DES:-SRP:-PSK:-CAMELLIA')
# BIOs
self._internalBio = BIO()
self._networkBio = BIO()
# http://www.openssl.org/docs/crypto/BIO_s_bio.html
BIO.make_bio_pair(self._internalBio, self._networkBio)
self._ssl.set_bio(self._internalBio)
def do_handshake(self):
if self._sock is None:
# TODO: Auto create a socket ?
raise IOError('Internal socket set to None; cannot perform handshake.')
while True:
try:
if self._ssl.do_handshake() == 1:
self._handshakeDone = True
return True # Handshake was successful
except WantReadError:
# OpenSSL is expecting more data from the peer
# Send available handshake data to the peer
lenToRead = self._networkBio.pending()
while lenToRead:
# Get the data from the SSL engine
handshakeDataOut = self._networkBio.read(lenToRead)
# Send it to the peer
self._sock.send(handshakeDataOut)
lenToRead = self._networkBio.pending()
# Recover the peer's encrypted response
handshakeDataIn = self._sock.recv(DEFAULT_BUFFER_SIZE)
if len(handshakeDataIn) == 0:
raise IOError('Nassl SSL handshake failed: peer did not send data back.')
# Pass the data to the SSL engine
self._networkBio.write(handshakeDataIn)
except WantX509LookupError:
# Server asked for a client certificate and we didn't provide one
raise ClientCertificateRequested(self._ssl.get_client_CA_list())
def read(self, size):
if not self._handshakeDone:
raise IOError('SSL Handshake was not completed; cannot receive data.')
while True:
# Receive available encrypted data from the peer
encData = self._sock.recv(DEFAULT_BUFFER_SIZE)
# Pass it to the SSL engine
self._networkBio.write(encData)
try:
# Try to read the decrypted data
decData = self._ssl.read(size)
return decData
except WantReadError:
# The SSL engine needs more data
# before it can decrypt the whole message
pass
def write(self, data):
"""
Returns the number of (encrypted) bytes sent.
"""
if not self._handshakeDone:
raise IOError('SSL Handshake was not completed; cannot send data.')
# Pass the cleartext data to the SSL engine
self._ssl.write(data)
# Recover the corresponding encrypted data
lenToRead = self._networkBio.pending()
finalLen = lenToRead
while lenToRead:
encData = self._networkBio.read(lenToRead)
# Send the encrypted data to the peer
self._sock.send(encData)
lenToRead = self._networkBio.pending()
finalLen += lenToRead
return finalLen
def shutdown(self):
self._handshakeDone = False
try:
self._ssl.shutdown()
except OpenSSLError as e:
# Ignore "uninitialized" exception
if 'SSL_shutdown:uninitialized' not in str(e):
raise
def get_secure_renegotiation_support(self):
return self._ssl.get_secure_renegotiation_support()
def get_current_compression_method(self):
return self._ssl.get_current_compression_method()
@staticmethod
def get_available_compression_methods():
"""
Returns the list of SSL compression methods supported by SslClient.
"""
return SSL.get_available_compression_methods()
def set_verify(self, verifyMode):
return self._ssl.set_verify(verifyMode)
def set_tlsext_host_name(self, nameIndication):
return self._ssl.set_tlsext_host_name(nameIndication)
def get_peer_certificate(self):
_x509 = self._ssl.get_peer_certificate()
if _x509:
return X509Certificate(_x509)
else:
return None
def set_cipher_list(self, cipherList):
return self._ssl.set_cipher_list(cipherList)
def get_cipher_list(self):
return self._ssl.get_cipher_list()
def get_current_cipher_name(self):
return self._ssl.get_cipher_name()
def get_current_cipher_bits(self):
return self._ssl.get_cipher_bits()
def use_private_key(self, certFile, certType, keyFile, keyType, keyPassword=''):
self._ssl.use_certificate_file(certFile, certType)
if isinstance(keyPassword, basestring):
self._sslCtx.set_private_key_password(keyPassword)
else:
raise TypeError('keyPassword is not a string')
self._ssl.use_PrivateKey_file(keyFile, keyType)
return self._ssl.check_private_key()
def get_certificate_chain_verify_result(self):
verifyResult = self._ssl.get_verify_result()
verifyResultStr = X509.verify_cert_error_string(verifyResult)
return verifyResult, verifyResultStr
def do_renegotiate(self):
if not self._handshakeDone:
raise IOError('SSL Handshake was not completed; cannot renegotiate.')
self._ssl.renegotiate()
return self.do_handshake()
def get_session(self):
return self._ssl.get_session()
def set_session(self, sslSession):
return self._ssl.set_session(sslSession)
def set_options(self, options):
return self._ssl.set_options(options)
def set_tlsext_status_ocsp(self):
return self._ssl.set_tlsext_status_type(TLSEXT_STATUSTYPE_ocsp)
def get_tlsext_status_ocsp_resp(self):
ocspResp = self._ssl.get_tlsext_status_ocsp_resp()
if ocspResp:
return OcspResponse(ocspResp)
else:
return None