File: //usr/lib/python3/dist-packages/OpenSSL/__pycache__/SSL.cpython-39.pyc
a
���_�L � @ s d dl Z d dlZd dlmZ d dlmZmZ d dlmZm Z d dl
m Z d dl m
Z
d dlmZmZmZ d dlmZmZmZmZmZ m Z m Z m!Z"m#Z$m%Z& d d l'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z- g d
�Z.ze/Z0W n" e1y� G d d � d e2�Z0Y n0 e j3Z3e j4Z4e j5Z5e j6Z6e j7Z7e j8Z8e j9Z:e j;Z<d
Z=dZ>dZ?dZ@dZAdZBe jCZDe jEZFe jGZHe jIZJe jKZLz
e jMZNW n eO�yp Y n0 e jPZQe jRZSe jTZUe jVZWe jXZYe jZZ[e j\Z]e j^Z_e j`Zae jbZce jdZee jfZge jhZie jjZke jlZme jnZoe jpZqe jrZse jtZue jvZwe jxZye jzZ{e j|Z}e j~Ze j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�e j�Z�g d�Z�dgZ�dZ�dZ�G dd� de��Z�eee��Z�e e��Z�G dd� de��Z�G dd � d e��Z�G d d � d e��Z�G d d � d e��Z�G d!d"� d"e��Z�G d#d$� d$e2�Z�G d%d&� d&e��Z�e2� Z�G d'd(� d(e��Z�G d)d*� d*e��Z�G d+d,� d,e��Z�d-d.� Z�d/d0� Z�d1d2� Z�e�e j�d3�Z�e�e�e d4d�d5�Z�G d6d7� d7e2�Z�G d8d9� d9e2�Z�G d:d;� d;e2�Z�e �ǡ dS )<� N)�platform)�wraps�partial)�count�chain)�WeakValueDictionary)� errorcode)�
integer_types�int2byte�
indexbytes)
� UNSPECIFIED�exception_from_error_queue�ffi� from_buffer�lib� make_assert�native� path_string�text_to_bytes_and_warn�no_zero_allocator)� FILETYPE_PEM�_PassphraseHelper�PKey�X509Name�X509� X509Store)S�OPENSSL_VERSION_NUMBER�SSLEAY_VERSION�
SSLEAY_CFLAGS�SSLEAY_PLATFORM�
SSLEAY_DIR�SSLEAY_BUILT_ON�
SENT_SHUTDOWN�RECEIVED_SHUTDOWN� SSLv2_METHOD� SSLv3_METHOD�
SSLv23_METHOD� TLSv1_METHOD�TLSv1_1_METHOD�TLSv1_2_METHOD� OP_NO_SSLv2� OP_NO_SSLv3� OP_NO_TLSv1�
OP_NO_TLSv1_1�
OP_NO_TLSv1_2�
OP_NO_TLSv1_3�MODE_RELEASE_BUFFERS�OP_SINGLE_DH_USE�OP_SINGLE_ECDH_USE�OP_EPHEMERAL_RSA�OP_MICROSOFT_SESS_ID_BUG�OP_NETSCAPE_CHALLENGE_BUG�#OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG� OP_SSLREF2_REUSE_CERT_TYPE_BUG� OP_MICROSOFT_BIG_SSLV3_BUFFER�OP_MSIE_SSLV2_RSA_PADDING�OP_SSLEAY_080_CLIENT_DH_BUG�
OP_TLS_D5_BUG�OP_TLS_BLOCK_PADDING_BUG� OP_DONT_INSERT_EMPTY_FRAGMENTS�OP_CIPHER_SERVER_PREFERENCE�OP_TLS_ROLLBACK_BUG�OP_PKCS1_CHECK_1�OP_PKCS1_CHECK_2�OP_NETSCAPE_CA_DN_BUG�"OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG�OP_NO_COMPRESSION�OP_NO_QUERY_MTU�OP_COOKIE_EXCHANGE� OP_NO_TICKET�OP_ALL� VERIFY_PEER�VERIFY_FAIL_IF_NO_PEER_CERT�VERIFY_CLIENT_ONCE� VERIFY_NONE�SESS_CACHE_OFF�SESS_CACHE_CLIENT�SESS_CACHE_SERVER�SESS_CACHE_BOTH�SESS_CACHE_NO_AUTO_CLEAR� SESS_CACHE_NO_INTERNAL_LOOKUP� SESS_CACHE_NO_INTERNAL_STORE�SESS_CACHE_NO_INTERNAL�SSL_ST_CONNECT�
SSL_ST_ACCEPT� SSL_ST_MASK� SSL_CB_LOOP� SSL_CB_EXIT� SSL_CB_READ� SSL_CB_WRITE� SSL_CB_ALERT�SSL_CB_READ_ALERT�SSL_CB_WRITE_ALERT�SSL_CB_ACCEPT_LOOP�SSL_CB_ACCEPT_EXIT�SSL_CB_CONNECT_LOOP�SSL_CB_CONNECT_EXIT�SSL_CB_HANDSHAKE_START�SSL_CB_HANDSHAKE_DONE�Error�
WantReadError�WantWriteError�WantX509LookupError�ZeroReturnError� SysCallError�SSLeay_version�Session�Context�
Connectionc @ s e Zd ZdS )�_bufferN��__name__�
__module__� __qualname__� rt rt �-/usr/lib/python3/dist-packages/OpenSSL/SSL.pyro { s ro � � � � � � )z"/etc/ssl/certs/ca-certificates.crtz /etc/pki/tls/certs/ca-bundle.crtz/etc/ssl/ca-bundle.pemz/etc/pki/tls/cacert.pemz1/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pemz/etc/ssl/certss$ /opt/pyca/cryptography/openssl/certss' /opt/pyca/cryptography/openssl/cert.pemc @ s e Zd ZdZdS )re z4
An error occurred in an `OpenSSL.SSL` API.
N�rq rr rs �__doc__rt rt rt ru re � s re c @ s e Zd ZdS )rf Nrp rt rt rt ru rf � s rf c @ s e Zd ZdS )rg Nrp rt rt rt ru rg � s rg c @ s e Zd ZdS )rh Nrp rt rt rt ru rh s rh c @ s e Zd ZdS )ri Nrp rt rt rt ru ri s ri c @ s e Zd ZdS )rj Nrp rt rt rt ru rj s rj c @ s e Zd ZdZdd� Zdd� ZdS )�_CallbackExceptionHelpera�
A base class for wrapper classes that allow for intelligent exception
handling in OpenSSL callbacks.
:ivar list _problems: Any exceptions that occurred while executing in a
context where they could not be raised in the normal way. Typically
this is because OpenSSL has called into some Python code and requires a
return value. The exceptions are saved to be raised later when it is
possible to do so.
c C s
g | _ d S �N)� _problems��selfrt rt ru �__init__ s z!_CallbackExceptionHelper.__init__c C s4 | j r0z
t� W n ty" Y n0 | j �d��dS )z�
Raise an exception from the OpenSSL error queue or that was previously
captured whe running a callback.
r N)r� �_raise_current_errorre �popr� rt rt ru �raise_if_problem s
z)_CallbackExceptionHelper.raise_if_problemN)rq rr rs r} r� r� rt rt rt ru r~ s r~ c @ s e Zd ZdZdd� ZdS )�
_VerifyHelperz^
Wrap a callback such that it can be used as a certificate verification
callback.
c s2 t ��� t� �� �fdd��}t�d|��_d S )Nc
s� t �|�}t �|� t�|�}t �|�}t �|�}t �� }t �||�}t j
| }z� ||||| �} W n2 t y� }
z�j �
|
� W Y d }
~
dS d }
~
0 0 | r�t �|t j� dS dS d S )Nr rv )�_lib� X509_STORE_CTX_get_current_cert� X509_up_refr �_from_raw_x509_ptr�X509_STORE_CTX_get_error� X509_STORE_CTX_get_error_depth�"SSL_get_ex_data_X509_STORE_CTX_idx�X509_STORE_CTX_get_ex_datarn �_reverse_mapping� Exceptionr� �append�X509_STORE_CTX_set_error� X509_V_OK) �ok� store_ctx�x509�certZ error_numberZ error_depth�index�ssl�
connection�result�e��callbackr� rt ru �wrapper1 s&
� z'_VerifyHelper.__init__.<locals>.wrapperz int (*)(int, X509_STORE_CTX *)�r~ r� r �_ffir� �r� r� r� rt r� ru r� . s
�z_VerifyHelper.__init__N�rq rr rs r} r� rt rt rt ru r� ( s r� c @ s e Zd ZdZdd� ZdS )�_ALPNSelectHelperzQ
Wrap a callback such that it can be used as an ALPN selection callback.
c s2 t ��� t� �� �fdd��}t�d|��_d S )Nc
s z�t j| }t�||�d d � }g }|r^t|d�} |d| d � }
|�|
� || d d � }q$� ||�} d} | tu r~d} d} nt| t�s�t d��t�
dt | ��t�
d| �g|_ |j d d |d< |j d |d< | s�t
jW S t
jW S t�y }
z �j�|
� t
jW Y d }
~
S d }
~
0 0 d S ) Nr rv T� Fz^ALPN callback must return a bytestring or the special NO_OVERLAPPING_PROTOCOLS sentinel value.zunsigned char *�unsigned char[])rn r� r� �bufferr r� �NO_OVERLAPPING_PROTOCOLS�
isinstance�bytes� TypeError�new�len�_alpn_select_callback_argsr� �SSL_TLSEXT_ERR_NOACK�SSL_TLSEXT_ERR_OKr� r� �SSL_TLSEXT_ERR_ALERT_FATAL)r� �outZoutlenZin_Zinlen�arg�conn�instrZ protolistZ encoded_len�protoZoutbytesZ any_acceptedr� r� rt ru r� [ s:
�
� z+_ALPNSelectHelper.__init__.<locals>.wrapperz^int (*)(SSL *, unsigned char **, unsigned char *, const unsigned char *, unsigned int, void *)r� r� rt r� ru r� X s
+�z_ALPNSelectHelper.__init__Nr� rt rt rt ru r� S s r� c @ s e Zd ZdZdd� ZdS )�_OCSPServerCallbackHelpera�
Wrap a callback such that it can be used as an OCSP callback for the server
side.
Annoyingly, OpenSSL defines one OCSP callback but uses it in two different
ways. For servers, that callback is expected to retrieve some OCSP data and
hand it to OpenSSL, and may return only SSL_TLSEXT_ERR_OK,
SSL_TLSEXT_ERR_FATAL, and SSL_TLSEXT_ERR_NOACK. For clients, that callback
is expected to check the OCSP data, and returns a negative value on error,
0 if the response is not acceptable, or positive if it is. These are
mutually exclusive return code behaviours, and they mean that we need two
helpers so that we always return an appropriate error code if the user's
code throws an exception.
Given that we have to have two helpers anyway, these helpers are a bit more
helpery than most: specifically, they hide a few more of the OpenSSL
functions so that the user has an easier time writing these callbacks.
This helper implements the server side.
c s2 t ��� t� �� �fdd��}t�d|��_d S )Nc
s� z�t j| }|tjkr"t�|�}nd }� ||�}t|t�sBtd��|sLW dS t|�}t �
|�}|t� ||�d d �< t � | ||� W dS t
y� } z�j�|� W Y d }~dS d }~0 0 d S )Nz'OCSP callback must return a bytestring.rx r rw )rn r� r� �NULL� from_handler� r� r� r� r� �OPENSSL_mallocr� � SSL_set_tlsext_status_ocsp_respr� r� r� )r� �cdatar� �data� ocsp_dataZocsp_data_lengthZdata_ptrr� r� rt ru r� � s(
� z3_OCSPServerCallbackHelper.__init__.<locals>.wrapper�int (*)(SSL *, void *)r� r� rt r� ru r� � s
&z"_OCSPServerCallbackHelper.__init__Nr� rt rt rt ru r� � s r� c @ s e Zd ZdZdd� ZdS )�_OCSPClientCallbackHelpera�
Wrap a callback such that it can be used as an OCSP callback for the client
side.
Annoyingly, OpenSSL defines one OCSP callback but uses it in two different
ways. For servers, that callback is expected to retrieve some OCSP data and
hand it to OpenSSL, and may return only SSL_TLSEXT_ERR_OK,
SSL_TLSEXT_ERR_FATAL, and SSL_TLSEXT_ERR_NOACK. For clients, that callback
is expected to check the OCSP data, and returns a negative value on error,
0 if the response is not acceptable, or positive if it is. These are
mutually exclusive return code behaviours, and they mean that we need two
helpers so that we always return an appropriate error code if the user's
code throws an exception.
Given that we have to have two helpers anyway, these helpers are a bit more
helpery than most: specifically, they hide a few more of the OpenSSL
functions so that the user has an easier time writing these callbacks.
This helper implements the client side.
c s2 t ��� t� �� �fdd��}t�d|��_d S )Nc
s� zzt j| }|tjkr"t�|�}nd }t�d�}t�| |�}|dk rJd}nt�|d |�d d � }� |||�}t t
|��W S t y� } z�j �
|� W Y d }~dS d }~0 0 d S )N�unsigned char **r r� ���)rn r� r� r� r� r� r� � SSL_get_tlsext_status_ocsp_respr� �int�boolr� r� r� ) r� r� r� r� Zocsp_ptrZocsp_lenr� Zvalidr� r� rt ru r� � s
z3_OCSPClientCallbackHelper.__init__.<locals>.wrapperr� r� r� rt r� ru r� � s
z"_OCSPClientCallbackHelper.__init__Nr� rt rt rt ru r� � s r� c C sd d }t | t�s(t| dd �}|d ur(|� } t | t�r6| }t |t�sJtd��n|dk r`td|f ��|S )N�filenoz3argument must be an int, or have a fileno() method.r z1file descriptor cannot be a negative integer (%i))r� r �getattrr� �
ValueError)�obj�fd�methrt rt ru �_asFileDescriptor s
�r� c C s t �t�| ��S )z�
Return a string describing the version of OpenSSL in use.
:param type: One of the :const:`SSLEAY_` constants defined in this module.
)r� �stringr� rk )�typert rt ru rk " s rk c s � �fdd�}|S )a�
Builds a decorator that ensures that functions that rely on OpenSSL
functions that are not present in this build raise NotImplementedError,
rather than AttributeError coming out of cryptography.
:param flag: A cryptography flag that guards the functions, e.g.
``Cryptography_HAS_NEXTPROTONEG``.
:param error: The string to be used in the exception if the flag is false.
c s$ �s t | �� fdd��}|S | S d S )Nc s t � ��d S r ��NotImplementedError)�args�kwargs)�errorrt ru �explode9 s z<_make_requires.<locals>._requires_decorator.<locals>.explode)r )�funcr� �r� �flagrt ru �_requires_decorator6 s
z+_make_requires.<locals>._requires_decoratorrt )r� r� r� rt r� ru �_make_requires+ s r� zALPN not available�Cryptography_HAS_KEYLOGzKey logging not availablec @ s e Zd ZdZdS )rl z�
A class representing an SSL session. A session defines certain connection
parameters which may be re-used to speed up the setup of subsequent
connections.
.. versionadded:: 0.14
Nr| rt rt rt ru rl N s rl c @ s� e Zd ZdZededededede diZ
e dd � e
� � D ��Z
d
d � Z
dcd
d�Zdd� Zdddd�Zdd� Zdd� Zdd� Zdd� Zefdd �Zd d � Zd d � Zd!d"� Zefd#d$�Zd%d&� Z d'd(� Z d)d*� Z d+d,� Z d-d.� Z d/d0� Z!ded1d2�Z"d3d4� Z#d5d6� Z$d7d8� Z%d9d:� Z&d;d<� Z'd=d>� Z(d?d@� Z)dAdB� Z*dCdD� Z+dEdF� Z,dGdH� Z-e.dIdJ� �Z/dKdL� Z0dMdN� Z1dOdP� Z2dQdR� Z3dSdT� Z4dUdV� Z5dWdX� Z6e7dYdZ� �Z8e7d[d\� �Z9d]d^� Z:dfd_d`�Z;dgdadb�Z<d S )hrm z�
:class:`OpenSSL.SSL.Context` instances define the parameters for setting
up new SSL connections.
:param method: One of SSLv2_METHOD, SSLv3_METHOD, SSLv23_METHOD, or
TLSv1_METHOD.
Z SSLv2_method� SSLv3_method�
SSLv23_method� TLSv1_method�TLSv1_1_method�TLSv1_2_methodc c s0 | ](\}}t t|d �d ur|t t|�fV qd S r )r� r� )�.0Z
identifier�namert rt ru � <genexpr>k s �zContext.<genexpr>c C s� t |t�std��z| j| }W n ty: td��Y n0 |� }t|tjk� t �
|�}t|tjk� t� |t j �}t �
|d�}t|dk� || _d | _d | _d | _d | _d | _d | _d | _d | _d | _d | _d | _d | _d | _d | _ | � t j � d S )Nzmethod must be an integerzNo such protocolrv ) r� r r� �_methods�KeyErrorr� �_openssl_assertr� r� r� � SSL_CTX_new�gc� SSL_CTX_free�SSL_CTX_set_ecdh_auto�_context�_passphrase_helper�_passphrase_callback�_passphrase_userdata�_verify_helper�_verify_callback�_info_callback�_keylog_callback�_tlsext_servername_callback� _app_data�_alpn_select_helper�_alpn_select_callback� _ocsp_helper�_ocsp_callback�
_ocsp_data�set_mode� SSL_MODE_ENABLE_PARTIAL_WRITE)r� �methodZ method_funcZ
method_obj�context�resrt rt ru r� q s:
zContext.__init__Nc C sN |du rt j}nt|�}|du r(t j}nt|�}t�| j||�}|sJt� dS )aU
Let SSL know where we can find trusted certificates for the certificate
chain. Note that the certificates have to be in PEM format.
If capath is passed, it must be a directory prepared using the
``c_rehash`` tool included with OpenSSL. Either, but not both, of
*pemfile* or *capath* may be :data:`None`.
:param cafile: In which file we can find the certificates (``bytes`` or
``unicode``).
:param capath: In which directory we can find the certificates
(``bytes`` or ``unicode``).
:return: None
N)r� r� � _path_stringr� � SSL_CTX_load_verify_locationsr� r� )r� �cafile�capath� load_resultrt rt ru �load_verify_locations� s �z Context.load_verify_locationsc s& t � �� �fdd��}tt|ddd�S )Nc s � | |�j �S r )r� )�size�verify�userdatar� rt ru r� � s z'Context._wrap_callback.<locals>.wrapperT)� more_args�truncate)r r r r� rt r� ru �_wrap_callback� s
�zContext._wrap_callbackc C s@ t |�std��| �|�| _| jj| _t�| j| j� || _ dS )a�
Set the passphrase callback. This function will be called
when a private key with a passphrase is loaded.
:param callback: The Python callback to use. This must accept three
positional arguments. First, an integer giving the maximum length
of the passphrase it may return. If the returned passphrase is
longer than this, it will be truncated. Second, a boolean value
which will be true if the user should be prompted for the
passphrase twice and the callback should verify that the two values
supplied are equal. Third, the value given as the *userdata*
parameter to :meth:`set_passwd_cb`. The *callback* must return
a byte string. If an error occurs, *callback* should return a false
value (e.g. an empty string).
:param userdata: (optional) A Python object which will be given as
argument to the callback
:return: None
�callback must be callableN)
�callabler� r
r� r� r� r� � SSL_CTX_set_default_passwd_cbr� r� )r� r� r rt rt ru �
set_passwd_cb� s
�zContext.set_passwd_cbc C s� t �| j�}t|dk� t�t �� ��d�}t�t �� ��d�}| � ||�s�t�t �
� �}t�t � � �}|t kr�|t
kr�| �tt� dS )a�
Specify that the platform provided CA certificates are to be used for
verification purposes. This method has some caveats related to the
binary wheels that cryptography (pyOpenSSL's primary dependency) ships:
* macOS will only load certificates using this method if the user has
the ``openssl@1.1`` `Homebrew <https://brew.sh>`_ formula installed
in the default location.
* Windows will not work.
* manylinux1 cryptography wheels will work on most common Linux
distributions in pyOpenSSL 17.1.0 and above. pyOpenSSL detects the
manylinux1 wheel and attempts to load roots via a fallback path.
:return: None
rv �asciiN)r� � SSL_CTX_set_default_verify_pathsr� r� r� r� � X509_get_default_cert_dir_env�decode� X509_get_default_cert_file_env�_check_env_vars_set�X509_get_default_cert_dir�X509_get_default_cert_file� _CRYPTOGRAPHY_MANYLINUX1_CA_DIR� _CRYPTOGRAPHY_MANYLINUX1_CA_FILE� _fallback_default_verify_paths�_CERTIFICATE_FILE_LOCATIONS�_CERTIFICATE_PATH_LOCATIONS)r� �
set_result� dir_env_var� file_env_varZ default_dirZ default_filert rt ru �set_default_verify_paths� s( ��� ���z Context.set_default_verify_pathsc C s t j�|�dup t j�|�duS )zp
Check to see if the default cert dir/file environment vars are present.
:return: bool
N)�os�environ�get)r� r r rt rt ru r s �zContext._check_env_vars_setc C sN |D ] }t j�|�r| �|� q$q|D ] }t j�|�r(| �d|� qJq(dS )aW
Default verify paths are based on the compiled version of OpenSSL.
However, when pyca/cryptography is compiled as a manylinux1 wheel
that compiled location can potentially be wrong. So, like Go, we
will try a predefined set of paths and attempt to load roots
from there.
:return: None
N)r �path�isfiler �isdir)r� Z file_pathZdir_pathr r rt rt ru r s
z&Context._fallback_default_verify_pathsc C s$ t |�}t�| j|�}|s t� dS )z�
Load a certificate chain from a file.
:param certfile: The name of the certificate chain file (``bytes`` or
``unicode``). Must be PEM encoded.
:return: None
N)r� r� �"SSL_CTX_use_certificate_chain_filer� r� )r� �certfiler� rt rt ru �use_certificate_chain_file. s �z"Context.use_certificate_chain_filec C s8 t |�}t|t�std��t�| j||�}|s4t� dS )ah
Load a certificate from a file
:param certfile: The name of the certificate file (``bytes`` or
``unicode``).
:param filetype: (optional) The encoding of the file, which is either
:const:`FILETYPE_PEM` or :const:`FILETYPE_ASN1`. The default is
:const:`FILETYPE_PEM`.
:return: None
�filetype must be an integerN)r� r� r r� r� � SSL_CTX_use_certificate_filer� r� )r� r' �filetype�
use_resultrt rt ru �use_certificate_file? s
�z Context.use_certificate_filec C s0 t |t�std��t�| j|j�}|s,t� dS )zs
Load a certificate from a X509 object
:param cert: The X509 object
:return: None
z cert must be an X509 instanceN)r� r r� r� �SSL_CTX_use_certificater� �_x509r� )r� r� r, rt rt ru �use_certificateU s
zContext.use_certificatec C sD t |t�std��t�|j�}t�| j|�}|s@t�|� t � dS )z�
Add certificate to chain
:param certobj: The X509 certificate object to add to the chain
:return: None
z certobj must be an X509 instanceN)
r� r r� r� �X509_dupr/ � SSL_CTX_add_extra_chain_certr� � X509_freer� )r� Zcertobj�copy�
add_resultrt rt ru �add_extra_chain_certc s
z Context.add_extra_chain_certc C s | j d ur| j �t� t� d S r )r� r� re r� r� rt rt ru �_raise_passphrase_exceptiont s
z#Context._raise_passphrase_exceptionc C sH t |�}|tu rt}nt|t�s(td��t�| j||�}|sD| � � dS )aR
Load a private key from a file
:param keyfile: The name of the key file (``bytes`` or ``unicode``)
:param filetype: (optional) The encoding of the file, which is either
:const:`FILETYPE_PEM` or :const:`FILETYPE_ASN1`. The default is
:const:`FILETYPE_PEM`.
:return: None
r) N)
r� � _UNSPECIFIEDr r� r r� r� �SSL_CTX_use_PrivateKey_filer� r7 )r� Zkeyfiler+ r, rt rt ru �use_privatekey_filez s
�zContext.use_privatekey_filec C s2 t |t�std��t�| j|j�}|s.| �� dS )zs
Load a private key from a PKey object
:param pkey: The PKey object
:return: None
z pkey must be a PKey instanceN)r� r r� r� �SSL_CTX_use_PrivateKeyr� �_pkeyr7 )r� �pkeyr, rt rt ru �use_privatekey� s
zContext.use_privatekeyc C s t �| j�st� dS )z�
Check if the private key (loaded with :meth:`use_privatekey`) matches
the certificate (loaded with :meth:`use_certificate`)
:return: :data:`None` (raises :exc:`Error` if something's wrong)
N)r� �SSL_CTX_check_private_keyr� r� r� rt rt ru �check_privatekey� s zContext.check_privatekeyc C s0 t �td|��}t|tjk� t �| j|� dS )a%
Load the trusted certificates that will be sent to the client. Does
not actually imply any of the certificates are trusted; that must be
configured separately.
:param bytes cafile: The path to a certificates file in PEM format.
:return: None
r N)r� �SSL_load_client_CA_file�_text_to_bytes_and_warnr� r� r� �SSL_CTX_set_client_CA_listr� )r� r Zca_listrt rt ru �load_client_ca� s
�zContext.load_client_cac C s* t d|�}tt�| j|t|��dk� dS )aV
Set the session id to *buf* within which a session can be reused for
this Context object. This is needed when doing session resumption,
because there is no way for a stored session to know which Context
object it is associated with.
:param bytes buf: The session id.
:returns: None
�bufrv N)rB r� r� � SSL_CTX_set_session_id_contextr� r� )r� rE rt rt ru �set_session_id� s
��zContext.set_session_idc C s t |t�std��t�| j|�S )a�
Set the behavior of the session cache used by all connections using
this Context. The previously set mode is returned. See
:const:`SESS_CACHE_*` for details about particular modes.
:param mode: One or more of the SESS_CACHE_* flags (combine using
bitwise or)
:returns: The previously set caching mode.
.. versionadded:: 0.14
�mode must be an integer)r� r r� r� � SSL_CTX_set_session_cache_moder� �r� �modert rt ru �set_session_cache_mode� s
z Context.set_session_cache_modec C s t �| j�S )z�
Get the current session cache mode.
:returns: The currently used cache mode.
.. versionadded:: 0.14
)r� � SSL_CTX_get_session_cache_moder� r� rt rt ru �get_session_cache_mode� s z Context.get_session_cache_modec C st t |t�std��|du r:d| _d| _t�| j|tj � n6t
|�sJtd��t |�| _| jj | _t�| j|| j� dS )a�
Set the verification flags for this Context object to *mode* and
specify that *callback* should be used for verification callbacks.
:param mode: The verify mode, this should be one of
:const:`VERIFY_NONE` and :const:`VERIFY_PEER`. If
:const:`VERIFY_PEER` is used, *mode* can be OR:ed with
:const:`VERIFY_FAIL_IF_NO_PEER_CERT` and
:const:`VERIFY_CLIENT_ONCE` to further control the behaviour.
:param callback: The optional Python verification callback to use.
This should take five arguments: A Connection object, an X509
object, and three integer variables, which are in turn potential
error number, error depth and return code. *callback* should
return True if verification passes and False otherwise.
If omitted, OpenSSL's default verification is used.
:return: None
See SSL_CTX_set_verify(3SSL) for further details.
rH Nr )
r� r r� r� r� r� �SSL_CTX_set_verifyr� r� r� r r� r� )r� rK r� rt rt ru �
set_verify� s
zContext.set_verifyc C s$ t |t�std��t�| j|� dS )z�
Set the maximum depth for the certificate chain verification that shall
be allowed for this Context object.
:param depth: An integer specifying the verify depth
:return: None
zdepth must be an integerN)r� r r� r� �SSL_CTX_set_verify_depthr� )r� �depthrt rt ru �set_verify_depth s
zContext.set_verify_depthc C s t �| j�S )z�
Retrieve the Context object's verify mode, as set by
:meth:`set_verify`.
:return: The verify mode
)r� �SSL_CTX_get_verify_moder� r� rt rt ru �get_verify_mode s zContext.get_verify_modec C s t �| j�S )z�
Retrieve the Context object's verify depth, as set by
:meth:`set_verify_depth`.
:return: The verify depth
)r� �SSL_CTX_get_verify_depthr� r� rt rt ru �get_verify_depth s zContext.get_verify_depthc C st t |�}t�|d�}|tjkr$t� t�|tj�}t�|tjtjtj�}t�|tj �}t�
| j |�}t |dk� dS )z�
Load parameters for Ephemeral Diffie-Hellman
:param dhfile: The file to load EDH parameters from (``bytes`` or
``unicode``).
:return: None
� rrv N)
r� r� � BIO_new_filer� r� r� r� �BIO_free�PEM_read_bio_DHparams�DH_free�SSL_CTX_set_tmp_dhr� r� )r� Zdhfile�bioZdhr� rt rt ru � load_tmp_dh' s
zContext.load_tmp_dhc C s t �| j|�� � dS )a
Select a curve to use for ECDHE key exchange.
:param curve: A curve object to use as returned by either
:meth:`OpenSSL.crypto.get_elliptic_curve` or
:meth:`OpenSSL.crypto.get_elliptic_curves`.
:return: None
N)r� �SSL_CTX_set_tmp_ecdhr� �
_to_EC_KEY)r� �curvert rt ru � set_tmp_ecdh< s
zContext.set_tmp_ecdhc C sZ t d|�}t|t�s td��tt�| j|�dk� t| d�}|� � g d�krVt
dg��dS )z�
Set the list of ciphers to be used in this context.
See the OpenSSL manual for more information (e.g.
:manpage:`ciphers(1)`).
:param bytes cipher_list: An OpenSSL cipher string.
:return: None
� cipher_listz"cipher_list must be a byte string.rv N)ZTLS_AES_256_GCM_SHA384Z TLS_CHACHA20_POLY1305_SHA256ZTLS_AES_128_GCM_SHA256)z SSL routines�SSL_CTX_set_cipher_listzno cipher match) rB r� r� r� r� r� re r� rn �get_cipher_listre )r� rd Ztmpconnrt rt ru �set_cipher_listH s
�
��zContext.set_cipher_listc C s� t �� }t|tjk� zf|D ]\}t|t�s>tdt|�j f ��t �
|j �}t|tjk� t � ||�}|s t �
|� t� q W n ty� t �|� � Y n0 t �| j|� dS )a_
Set the list of preferred client certificate signers for this server
context.
This list of certificate authorities will be sent to the client when
the server requests a client certificate.
:param certificate_authorities: a sequence of X509Names.
:return: None
.. versionadded:: 0.10
z3client CAs must be X509Name objects, not %s objectsN)r� �sk_X509_NAME_new_nullr� r� r� r� r r� r� rq �
X509_NAME_dup�_name�sk_X509_NAME_push�X509_NAME_freer� r� �sk_X509_NAME_freerC r� )r� Zcertificate_authoritiesZ
name_stackZca_namer4 Z push_resultrt rt ru �set_client_ca_listo s(
��
zContext.set_client_ca_listc C s2 t |t�std��t�| j|j�}t|dk� dS )ai
Add the CA certificate to the list of preferred signers for this
context.
The list of certificate authorities will be sent to the client when the
server requests a client certificate.
:param certificate_authority: certificate authority's X509 certificate.
:return: None
.. versionadded:: 0.10
z.certificate_authority must be an X509 instancerv N)r� r r� r� �SSL_CTX_add_client_CAr� r/ r� )r� Zcertificate_authorityr5 rt rt ru �
add_client_ca� s
�zContext.add_client_cac C s t |t�std��t�| j|�S )aQ
Set the timeout for newly created sessions for this Context object to
*timeout*. The default value is 300 seconds. See the OpenSSL manual
for more information (e.g. :manpage:`SSL_CTX_set_timeout(3)`).
:param timeout: The timeout in (whole) seconds
:return: The previous session timeout
ztimeout must be an integer)r� r r� r� �SSL_CTX_set_timeoutr� )r� �timeoutrt rt ru � set_timeout� s
zContext.set_timeoutc C s t �| j�S )z�
Retrieve session timeout, as set by :meth:`set_timeout`. The default
is 300 seconds.
:return: The session timeout
)r� �SSL_CTX_get_timeoutr� r� rt rt ru � get_timeout� s zContext.get_timeoutc s6 t � �� fdd��}t�d|�| _t�| j| j� dS )a�
Set the information callback to *callback*. This function will be
called from time to time during SSL handshakes.
:param callback: The Python callback to use. This should take three
arguments: a Connection object and two integers. The first integer
specifies where in the SSL handshake the function was called, and
the other the return code from a (possibly failed) internal
function call.
:return: None
c s � t j| ||� d S r �rn r� )r� �whereZ return_code�r� rt ru r� � s z*Context.set_info_callback.<locals>.wrapperz void (*)(const SSL *, int, int)N)r r� r� r� r� �SSL_CTX_set_info_callbackr� r� rt rx ru �set_info_callback� s
�zContext.set_info_callbackc s6 t � �� fdd��}t�d|�| _t�| j| j� dS )a
Set the TLS key logging callback to *callback*. This function will be
called whenever TLS key material is generated or received, in order
to allow applications to store this keying material for debugging
purposes.
:param callback: The Python callback to use. This should take two
arguments: a Connection object and a bytestring that contains
the key material in the format used by NSS for its SSLKEYLOGFILE
debugging output.
:return: None
c s t �|�}� tj| |� d S r )r� r� rn r� )r� �linerx rt ru r� � s
z,Context.set_keylog_callback.<locals>.wrapperz#void (*)(const SSL *, const char *)N)r r� r� r� r� �SSL_CTX_set_keylog_callbackr� r� rt rx ru �set_keylog_callback� s �zContext.set_keylog_callbackc C s | j S )zw
Get the application data (supplied via :meth:`set_app_data()`)
:return: The application data
�r� r� rt rt ru � get_app_data� s zContext.get_app_datac C s
|| _ dS )z�
Set the application data (will be returned from get_app_data())
:param data: Any Python object
:return: None
Nr~ �r� r� rt rt ru � set_app_data� s zContext.set_app_datac C s. t �| j�}|tjkrdS t�t�}||_|S )z�
Get the certificate store for the context. This can be used to add
"trusted" certificates without using the
:meth:`load_verify_locations` method.
:return: A X509Store object or None if it does not have one.
N)r� �SSL_CTX_get_cert_storer� r� r� r �__new__�_store)r� �storeZpystorert rt ru �get_cert_store� s
zContext.get_cert_storec C s t |t�std��t�| j|�S )z�
Add options. Options set before are not cleared!
This method should be used with the :const:`OP_*` constants.
:param options: The options to add.
:return: The new option bitmask.
zoptions must be an integer)r� r r� r� �SSL_CTX_set_optionsr� )r� �optionsrt rt ru � set_options s
zContext.set_optionsc C s t |t�std��t�| j|�S )z�
Add modes via bitmask. Modes set before are not cleared! This method
should be used with the :const:`MODE_*` constants.
:param mode: The mode to add.
:return: The new mode bitmask.
rH )r� r r� r� �SSL_CTX_set_moder� rJ rt rt ru r� s
zContext.set_modec s6 t � �� fdd��}t�d|�| _t�| j| j� dS )a
Specify a callback function to be called when clients specify a server
name.
:param callback: The callback function. It will be invoked with one
argument, the Connection instance.
.. versionadded:: 0.13
c s � t j| � dS )Nr rv )r� �alertr� rx rt ru r� 4 s z7Context.set_tlsext_servername_callback.<locals>.wrapperz int (*)(SSL *, int *, void *)N)r r� r� r� r� �&SSL_CTX_set_tlsext_servername_callbackr� r� rt rx ru � set_tlsext_servername_callback) s ��z&Context.set_tlsext_servername_callbackc C s, t |t�std��tt�| j|�dk� dS )z�
Enable support for negotiating SRTP keying material.
:param bytes profiles: A colon delimited list of protection profile
names, like ``b'SRTP_AES128_CM_SHA1_80:SRTP_AES128_CM_SHA1_32'``.
:return: None
z profiles must be a byte string.r N)r� r� r� r� r� �SSL_CTX_set_tlsext_use_srtpr� )r� Zprofilesrt rt ru �set_tlsext_use_srtp@ s
�zContext.set_tlsext_use_srtpc C s> d� t�dd� |D ���}t�d|�}t�| j|t|�� dS )a�
Specify the protocols that the client is prepared to speak after the
TLS connection has been negotiated using Application Layer Protocol
Negotiation.
:param protos: A list of the protocols to be offered to the server.
This list should be a Python list of bytestrings representing the
protocols to offer, e.g. ``[b'http/1.1', b'spdy/2']``.
r� c s s | ]}t t|��|fV qd S r �r
r� �r� �prt rt ru r� ] r� z*Context.set_alpn_protos.<locals>.<genexpr>r� N) �joinr �
from_iterabler� r� r� �SSL_CTX_set_alpn_protosr� r� �r� ZprotosZprotostrZ input_strrt rt ru �set_alpn_protosO s
� zContext.set_alpn_protosc C s, t |�| _| jj| _t�| j| jtj� dS )a�
Specify a callback function that will be called on the server when a
client offers protocols using ALPN.
:param callback: The callback function. It will be invoked with two
arguments: the Connection, and a list of offered protocols as
bytestrings, e.g ``[b'http/1.1', b'spdy/2']``. It can return
one of those bytestrings to indicate the chosen protocol, the
empty bytestring to terminate the TLS connection, or the
:py:obj:`NO_OVERLAPPING_PROTOCOLS` to indicate that no offered
protocol was selected, but that the connection should not be
aborted.
N) r� r� r� r� r� �SSL_CTX_set_alpn_select_cbr� r� r� )r� r� rt rt ru �set_alpn_select_callbacke s
�z Context.set_alpn_select_callbackc C sh || _ |j| _|du r tj| _n t�|�| _t�| j | j�}t
|dk� t� | j | j�}t
|dk� dS )z�
This internal helper does the common work for
``set_ocsp_server_callback`` and ``set_ocsp_client_callback``, which is
almost all of it.
Nrv ) r� r� r� r� r� r� �
new_handler� � SSL_CTX_set_tlsext_status_cbr� r� � SSL_CTX_set_tlsext_status_arg)r� �helperr� �rcrt rt ru �_set_ocsp_callbackz s
� zContext._set_ocsp_callbackc C s t |�}| �||� dS )a�
Set a callback to provide OCSP data to be stapled to the TLS handshake
on the server side.
:param callback: The callback function. It will be invoked with two
arguments: the Connection, and the optional arbitrary data you have
provided. The callback must return a bytestring that contains the
OCSP data to staple to the handshake. If no OCSP data is available
for this connection, return the empty bytestring.
:param data: Some opaque data that will be passed into the callback
function when called. This can be used to avoid needing to do
complex data lookups or to keep track of what context is being
used. This parameter is optional.
N)r� r� �r� r� r� r� rt rt ru �set_ocsp_server_callback� s z Context.set_ocsp_server_callbackc C s t |�}| �||� dS )a�
Set a callback to validate OCSP data stapled to the TLS handshake on
the client side.
:param callback: The callback function. It will be invoked with three
arguments: the Connection, a bytestring containing the stapled OCSP
assertion, and the optional arbitrary data you have provided. The
callback must return a boolean that indicates the result of
validating the OCSP data: ``True`` if the OCSP data is valid and
the certificate can be trusted, or ``False`` if either the OCSP
data is invalid or the certificate has been revoked.
:param data: Some opaque data that will be passed into the callback
function when called. This can be used to avoid needing to do
complex data lookups or to keep track of what context is being
used. This parameter is optional.
N)r� r� r� rt rt ru �set_ocsp_client_callback� s z Context.set_ocsp_client_callback)N)N)N)N)N)=rq rr rs r} r$ r% r& r' r( r) r� �dict�itemsr� r r
r r r r r( r r- r0 r6 r7 r8 r: r> r@ rD rG rL rN rP rS rU rW r_ rc rg rn rp rs ru rz �_requires_keylogr} r r� r� r� r� r� r� �_requires_alpnr� r� r� r� r� rt rt rt ru rm Z st ��(
0
#
'#
rm c @ s
e Zd Ze� Zdydd�Zdd� Zdd� Zdd � Zd
d � Z d d
� Z
dd� Z dd� Z dzdd�Z
e
Zd{dd�Zd|dd�ZeZd}dd�Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Z d/d0� Z d1d2� Z d3d4� Z d5d6� Z d7d8� Z!d9d:� Z"d;d<� Z#d=d>� Z$d?d@� Z%dAdB� Z&dCdD� Z'dEdF� Z(dGdH� Z)d~dIdJ�Z*dKdL� Z+dMdN� Z,dOdP� Z-e.dQdR� �Z/dSdT� Z0dUdV� Z1dWdX� Z2dYdZ� Z3d[d\� Z4d]d^� Z5d_d`� Z6dadb� Z7dcdd� Z8dedf� Z9dgdh� Z:didj� Z;dkdl� Z<dmdn� Z=dodp� Z>dqdr� Z?e@dsdt� �ZAe@dudv� �ZBdwdx� ZCdS )rn Nc C s t |t�std��t�|j�}t�|tj�| _ t�
| j tj � || _d| _ d| _
|j| _|j| _| | j| j < |du r�d| _t�t�� �| _t| jtjk� t�t�� �| _t| jtjk� t�| j | j| j� n2d| _d| _|| _t�| j t| j��}t|dk� dS )z�
Create a new Connection object, using the given OpenSSL.SSL.Context
instance and socket.
:param context: An SSL Context to use for this connection
:param socket: The socket to use for transport layer
�"context must be a Context instanceNrv )r� rm r� r� �SSL_newr� r� r� �SSL_free�_ssl� SSL_set_mode�SSL_MODE_AUTO_RETRYr� r� r� r� r� �_socket�BIO_new� BIO_s_mem� _into_sslr� r� � _from_ssl� SSL_set_bio�
SSL_set_fdr� )r� r� �socketr� r rt rt ru r� � s2
�zConnection.__init__c C s0 | j du r td| jj|f ��n t| j |�S dS )zy
Look up attributes on the wrapped socket object if they are not found
on the Connection object.
Nz!'%s' object has no attribute '%s')r� �AttributeError� __class__rq r� �r� r� rt rt ru � __getattr__� s
��zConnection.__getattr__c C s | j jd ur| j j�� | j jd ur0| j j�� | j jd urH| j j�� t�||�}|tjkrft� �n�|tj krxt
� �n�|tj kr�t � �n�|tj
kr�t� �n||tjk�rt�� dkr�|dk r�tdkr�t�� d }ntj}|dkr�t|t�|���tdd��nt� n|tjk�rnt� d S )Nr �win32r� zUnexpected EOF)r� r� r� r� r� r� �
SSL_get_error�SSL_ERROR_WANT_READrf �SSL_ERROR_WANT_WRITErg �SSL_ERROR_ZERO_RETURNri �SSL_ERROR_WANT_X509_LOOKUPrh �SSL_ERROR_SYSCALL�ERR_peek_errorr r� Z getwinerror�errnorj r r" r� �SSL_ERROR_NONE)r� r� r� r� r� rt rt ru �_raise_ssl_error� s8
zConnection._raise_ssl_errorc C s | j S )zh
Retrieve the :class:`Context` object associated with this
:class:`Connection`.
)r� r� rt rt ru � get_context s zConnection.get_contextc C s, t |t�std��t�| j|j� || _dS )z�
Switch this connection to a new session context.
:param context: A :class:`Context` instance giving the new session
context to use.
r� N)r� rm r� r� �SSL_set_SSL_CTXr� r� )r� r� rt rt ru � set_context' s
zConnection.set_contextc C s( t �| jt j�}|tjkr dS t�|�S )z�
Retrieve the servername extension value if provided in the client hello
message, or None if there wasn't one.
:return: A byte string giving the server name or :data:`None`.
.. versionadded:: 0.13
N)r� �SSL_get_servernamer� �TLSEXT_NAMETYPE_host_namer� r� r� r� rt rt ru �get_servername4 s �
zConnection.get_servernamec C s6 t |t�std��nd|v r$td��t�| j|� dS )z�
Set the value of the servername extension to send in the client hello.
:param name: A byte string giving the name.
.. versionadded:: 0.13
zname must be a byte string� z name must not contain NUL byteN)r� r� r� r� �SSL_set_tlsext_host_namer� r� rt rt ru �set_tlsext_host_nameE s
z Connection.set_tlsext_host_namec C s t �| j�S )z�
Get the number of bytes that can be safely read from the SSL buffer
(**not** the underlying transport buffer).
:return: The number of bytes available in the receive buffer.
)r� � SSL_pendingr� r� rt rt ru �pendingU s zConnection.pendingr c C sp t d|�}t|��J}t|�dkr(td��t�| j|t|��}| �| j|� |W d � S 1 sb0 Y dS )a�
Send data on the connection. NOTE: If you get one of the WantRead,
WantWrite or WantX509Lookup exceptions on this, you have to call the
method again with the SAME buffer.
:param buf: The string, buffer or memoryview to send
:param flags: (optional) Included for compatibility with the socket
API, the value is ignored
:return: The number of bytes written
rE ��z,Cannot send more than 2**31-1 bytes at once.N)rB � _from_bufferr� r� r� � SSL_writer� r� )r� rE �flagsr� r� rt rt ru �send^ s
�zConnection.sendc C s� t d|�}t|��^}t|�}d}|r^t�| j|| t|d��}| �| j|� ||7 }||8 }q |W d � S 1 sv0 Y dS )a�
Send "all" data on the connection. This calls send() repeatedly until
all data is sent. If an error occurs, it's impossible to tell how much
data has been sent.
:param buf: The string, buffer or memoryview to send
:param flags: (optional) Included for compatibility with the socket
API, the value is ignored
:return: The number of bytes written
rE r r� N)rB r� r� r� r� r� �minr� )r� rE r� r� Z left_to_send�
total_sentr� rt rt ru �sendallz s
�
zConnection.sendallc C s` t d|�}|dur.|tj@ r.t�| j||�}nt�| j||�}| �| j|� t� ||�dd� S )a
Receive data on the connection.
:param bufsiz: The maximum number of bytes to read
:param flags: (optional) The only supported flag is ``MSG_PEEK``,
all other flags are ignored.
:return: The string read from the Connection
�char[]N)
�_no_zero_allocatorr� �MSG_PEEKr� �SSL_peekr� �SSL_readr� r� r� )r� �bufsizr� rE r� rt rt ru �recv� s
zConnection.recvc C s� |du rt |�}nt|t |��}td|�}|durN|tj@ rNt�| j||�}nt�| j||�}| � | j|� t
t � ||��|d|�< |S )ae
Receive data on the connection and copy it directly into the provided
buffer, rather than creating a new string.
:param buffer: The buffer to copy into.
:param nbytes: (optional) The maximum number of bytes to read into the
buffer. If not present, defaults to the size of the buffer. If
larger than the size of the buffer, is reduced to the size of the
buffer.
:param flags: (optional) The only supported flag is ``MSG_PEEK``,
all other flags are ignored.
:return: The number of bytes read into the buffer.
Nr� )
r� r� r� r� r� r� r� r� r� r� �
memoryviewr� r� )r� r� �nbytesr� rE r� rt rt ru � recv_into� s
zConnection.recv_intoc C sV t �|�rLt �|�r t� �qRt �|�r.t� �qRt �|�rBtd��qRtd��nt� d S )N�BIO_should_io_specialzunknown bio failure) r� �BIO_should_retry�BIO_should_readrf �BIO_should_writerg r� r� r� )r� r^ r� rt rt ru �_handle_bio_errors� s
z Connection._handle_bio_errorsc C sh | j du rtd��t|t�s$td��td|�}t�| j ||�}|dkrT| �| j |� t� ||�dd� S )a�
If the Connection was created with a memory BIO, this method can be
used to read bytes from the write end of that memory BIO. Many
Connection methods will add bytes which must be read in this manner or
the buffer will eventually fill up and the Connection will be able to
take no further actions.
:param bufsiz: The maximum number of bytes to read
:return: The string read.
N� Connection sock was not Nonezbufsiz must be an integerr� r )
r� r� r� r r� r� �BIO_readr� r� r� )r� r� rE r� rt rt ru �bio_read� s
zConnection.bio_readc C sv t d|�}| jdu r td��t|��>}t�| j|t|��}|dkrP| �| j|� |W d � S 1 sh0 Y dS )aj
If the Connection was created with a memory BIO, this method can be
used to add bytes to the read end of that memory BIO. The Connection
can then read the bytes (for example, in response to a call to
:meth:`recv`).
:param buf: The string to put into the memory BIO.
:return: The number of bytes written
rE Nr� r )rB r� r� r� r� � BIO_writer� r� )r� rE r� r� rt rt ru � bio_write� s
zConnection.bio_writec C s$ | � � s tt�| j�dk� dS dS )z�
Renegotiate the session.
:return: True if the renegotiation can be started, False otherwise
:rtype: bool
rv TF)�renegotiate_pendingr� r� �SSL_renegotiater� r� rt rt ru � renegotiate s zConnection.renegotiatec C s t �| j�}| �| j|� dS )a
Perform an SSL handshake (usually called after :meth:`renegotiate` or
one of :meth:`set_accept_state` or :meth:`set_connect_state`). This can
raise the same exceptions as :meth:`send` and :meth:`recv`.
:return: None.
N)r� �SSL_do_handshaker� r� �r� r� rt rt ru � do_handshake s zConnection.do_handshakec C s t �| j�dkS )z�
Check if there's a renegotiation in progress, it will return False once
a renegotiation is finished.
:return: Whether there's a renegotiation in progress
:rtype: bool
rv )r� �SSL_renegotiate_pendingr� r� rt rt ru r� & s z Connection.renegotiate_pendingc C s t �| j�S )z�
Find out the total number of renegotiations.
:return: The number of renegotiations.
:rtype: int
)r� �SSL_total_renegotiationsr� r� rt rt ru �total_renegotiations0 s z Connection.total_renegotiationsc C s t �| j� | j�|�S )a4
Call the :meth:`connect` method of the underlying socket and set up SSL
on the socket, using the :class:`Context` object supplied to this
:class:`Connection` object at creation.
:param addr: A remote address
:return: What the socket's connect method returns
)r� �SSL_set_connect_stater� r� �connect)r� �addrrt rt ru r� 9 s zConnection.connectc C s | j j}| �� ||�S )a�
Call the :meth:`connect_ex` method of the underlying socket and set up
SSL on the socket, using the Context object supplied to this Connection
object at creation. Note that if the :meth:`connect_ex` method of the
socket doesn't return 0, SSL won't be initialized.
:param addr: A remove address
:return: What the socket's connect_ex method returns
)r� �
connect_ex�set_connect_state)r� r� r� rt rt ru r� E s
zConnection.connect_exc C s* | j �� \}}t| j|�}|�� ||fS )a�
Call the :meth:`accept` method of the underlying socket and set up SSL
on the returned socket, using the Context object supplied to this
:class:`Connection` object at creation.
:return: A *(conn, addr)* pair where *conn* is the new
:class:`Connection` object created, and *address* is as returned by
the socket's :meth:`accept`.
)r� �acceptrn r� �set_accept_state)r� �clientr� r� rt rt ru r� S s
zConnection.acceptc C s$ | j du rtd��t�| jd� dS )z�
If the Connection was created with a memory BIO, this method can be
used to indicate that *end of file* has been reached on the read end of
that memory BIO.
:return: None
Nr� r )r� r� r� �BIO_set_mem_eof_returnr� r� rt rt ru � bio_shutdownb s
zConnection.bio_shutdownc C s8 t �| j�}|dk r$| �| j|� n|dkr0dS dS dS )aQ
Send the shutdown message to the Connection.
:return: True if the shutdown completed successfully (i.e. both sides
have sent closure alerts), False otherwise (in which case you
call :meth:`recv` or :meth:`send` when the connection becomes
readable/writeable).
r TFN)r� � SSL_shutdownr� r� r� rt rt ru �shutdowno s zConnection.shutdownc C sD g }t � D ]4}t�| j|�}|tjkr* q@|�tt�|��� q
|S )z�
Retrieve the list of ciphers used by the Connection object.
:return: A list of native cipher strings.
) r r� �SSL_get_cipher_listr� r� r� r� �_nativer� )r� �ciphers�ir� rt rt ru rf � s
zConnection.get_cipher_listc C s~ t �| j�}|tjkrg S g }tt �|��D ]L}t �||�}t �|�}t |tjk� t
� t
�}t� |t j
�|_|�|� q,|S )a�
Get CAs whose certificates are suggested for client authentication.
:return: If this is a server connection, the list of certificate
authorities that will be sent or has been sent to the client, as
controlled by this :class:`Connection`'s :class:`Context`.
If this is a client connection, the list will be empty until the
connection with the server is established.
.. versionadded:: 0.10
)r� �SSL_get_client_CA_listr� r� r� �range�sk_X509_NAME_num�sk_X509_NAME_valueri r� r r� r� rl rj r� )r� Zca_namesr� r r� r4 Zpynamert rt ru �get_client_ca_list� s
z Connection.get_client_ca_listc O s t d��dS )z�
The makefile() method is not implemented, since there is no dup
semantics for SSL connections
:raise: NotImplementedError
z1Cannot make file object of OpenSSL.SSL.ConnectionNr� �r� r� r� rt rt ru �makefile� s �zConnection.makefilec C s | j S )zr
Retrieve application data as set by :meth:`set_app_data`.
:return: The application data
r~ r� rt rt ru r � s zConnection.get_app_datac C s
|| _ dS )zg
Set application data
:param data: The application data
:return: None
Nr~ r� rt rt ru r� � s zConnection.set_app_datac C s t �| j�S )z�
Get the shutdown state of the Connection.
:return: The shutdown state, a bitvector of SENT_SHUTDOWN,
RECEIVED_SHUTDOWN.
)r� �SSL_get_shutdownr� r� rt rt ru � get_shutdown� s zConnection.get_shutdownc C s$ t |t�std��t�| j|� dS )z�
Set the shutdown state of the Connection.
:param state: bitvector of SENT_SHUTDOWN, RECEIVED_SHUTDOWN.
:return: None
zstate must be an integerN)r� r r� r� �SSL_set_shutdownr� )r� �statert rt ru � set_shutdown� s
zConnection.set_shutdownc C s t �t�| j��S )z�
Retrieve a verbose string detailing the state of the Connection.
:return: A string representing the state
:rtype: bytes
)r� r� r� �SSL_state_string_longr� r� rt rt ru �get_state_string� s zConnection.get_state_stringc C sf t �| j�}|tjkrdS t �| jtjd�}t|dk� td|�}t �| j||� t�||�dd� S )z�
Retrieve the random value used with the server hello message.
:return: A string representing the state
Nr r� ) r� �SSL_get_sessionr� r� r� �SSL_get_server_randomr� r� r� �r� �session�length�outprt rt ru �
server_random� s
zConnection.server_randomc C sf t �| j�}|tjkrdS t �| jtjd�}t|dk� td|�}t �| j||� t�||�dd� S )z�
Retrieve the random value used with the client hello message.
:return: A string representing the state
Nr r� ) r� r r� r� r� �SSL_get_client_randomr� r� r� r rt rt ru �
client_random� s
zConnection.client_randomc C sb t �| j�}|tjkrdS t �|tjd�}t|dk� td|�}t �|||� t�||�dd� S )zz
Retrieve the value of the master key for this session.
:return: A string representing the state
Nr r� ) r� r r� r� r� �SSL_SESSION_get_master_keyr� r� r� r rt rt ru �
master_key s
zConnection.master_keyc
C sn t d|�}tj}d}d}|dur0|}t|�}d}t�| j|||t|�|||�}t|dk� t�||�dd� S )aH
Obtain keying material for application use.
:param: label - a disambiguating label string as described in RFC 5705
:param: olen - the length of the exported key material in bytes
:param: context - a per-association context value
:return: the exported key material bytes or None
r� r Nrv ) r� r� r� r� r� �SSL_export_keying_materialr� r� r� ) r� �labelZolenr� r Z context_bufZ context_lenZ use_contextZsuccessrt rt ru �export_keying_material s(
�
z!Connection.export_keying_materialc O s | j j|i |��S )z�
Call the :meth:`shutdown` method of the underlying socket.
See :manpage:`shutdown(2)`.
:return: What the socket's shutdown() method returns
)r� r� r rt rt ru �
sock_shutdown2 s zConnection.sock_shutdownc C s. t �| j�}|tjkr*t �|� t�|�S dS )za
Retrieve the local certificate (if any)
:return: The local certificate
N)r� �SSL_get_certificater� r� r� r� r r� �r� r� rt rt ru �get_certificate; s
zConnection.get_certificatec C s$ t �| j�}|tjkr t�|�S dS )zi
Retrieve the other side's certificate (if any)
:return: The peer's certificate
N)r� �SSL_get_peer_certificater� r� r� r r� r" rt rt ru �get_peer_certificateG s
z Connection.get_peer_certificatec C s` g }t t�| ��D ]H}t�| |�}t|tjk� t�|�}t|dk� t� |�}|�
|� q|S )zb
Internal helper to convert a STACK_OF(X509) to a list of X509
instances.
rv ) r r� � sk_X509_num�
sk_X509_valuer� r� r� r� r r� r� )�
cert_stackr� r r� r� �pycertrt rt ru �_cert_stack_to_listR s
z Connection._cert_stack_to_listc C s$ t �| j�}|tjkrdS | �|�S )z�
Retrieve the other side's certificate (if any)
:return: A list of X509 instances giving the peer's certificate chain,
or None if it does not have one.
N)r� �SSL_get_peer_cert_chainr� r� r� r* �r� r( rt rt ru �get_peer_cert_chainb s
z Connection.get_peer_cert_chainc C s$ t �| j�}|tjkrdS | �|�S )a�
Retrieve the verified certificate chain of the peer including the
peer's end entity certificate. It must be called after a session has
been successfully established. If peer verification was not successful
the chain may be incomplete, invalid, or None.
:return: A list of X509 instances giving the peer's verified
certificate chain, or None if it does not have one.
.. versionadded:: 20.0
N)r� �SSL_get0_verified_chainr� r� r� r* r, rt rt ru �get_verified_chaino s
z Connection.get_verified_chainc C s t �| j�S )z�
Checks if more data has to be read from the transport layer to complete
an operation.
:return: True iff more data has to be read
)r� �
SSL_want_readr� r� rt rt ru � want_read� s zConnection.want_readc C s t �| j�S )z�
Checks if there is data to write to the transport layer to complete an
operation.
:return: True iff there is data to write
)r� �SSL_want_writer� r� rt rt ru �
want_write� s zConnection.want_writec C s t �| j� dS )z�
Set the connection to work in server mode. The handshake will be
handled automatically by read/write.
:return: None
N)r� �SSL_set_accept_stater� r� rt rt ru r� � s zConnection.set_accept_statec C s t �| j� dS )z�
Set the connection to work in client mode. The handshake will be
handled automatically by read/write.
:return: None
N)r� r� r� r� rt rt ru r� � s z Connection.set_connect_statec C s8 t �| j�}|tjkrdS t�t�}t�|t j�|_ |S )z�
Returns the Session currently used.
:return: An instance of :class:`OpenSSL.SSL.Session` or
:obj:`None` if no session exists.
.. versionadded:: 0.14
N)
r� �SSL_get1_sessionr� r� r� rl r� r� �SSL_SESSION_free�_session)r� r Z pysessionrt rt ru � get_session� s
zConnection.get_sessionc C s2 t |t�std��t�| j|j�}t|dk� dS )z�
Set the session to be used when the TLS/SSL connection is established.
:param session: A Session instance representing the session to use.
:returns: None
.. versionadded:: 0.14
z"session must be a Session instancerv N)r� rl r� r� �SSL_set_sessionr� r7 r� )r� r r� rt rt ru � set_session� s
zConnection.set_sessionc C sR t �dd�}|| j|d�}|dkr&dS td|�}|| j||� t �||�dd� S )a�
Helper to implement :meth:`get_finished` and
:meth:`get_peer_finished`.
:param function: Either :data:`SSL_get_finished`: or
:data:`SSL_get_peer_finished`.
:return: :data:`None` if the desired message has not yet been
received, otherwise the contents of the message.
:rtype: :class:`bytes` or :class:`NoneType`
r� r N)r� r� r� r� r� )r� �function�emptyr rE rt rt ru �_get_finished_message� s
z Connection._get_finished_messagec C s | � tj�S )a
Obtain the latest TLS Finished message that we sent.
:return: The contents of the message or :obj:`None` if the TLS
handshake has not yet completed.
:rtype: :class:`bytes` or :class:`NoneType`
.. versionadded:: 0.15
)r= r� �SSL_get_finishedr� rt rt ru � get_finished� s
zConnection.get_finishedc C s | � tj�S )a!
Obtain the latest TLS Finished message that we received from the peer.
:return: The contents of the message or :obj:`None` if the TLS
handshake has not yet completed.
:rtype: :class:`bytes` or :class:`NoneType`
.. versionadded:: 0.15
)r= r� �SSL_get_peer_finishedr� rt rt ru �get_peer_finished� s
z Connection.get_peer_finishedc C s8 t �| j�}|tjkrdS t�t �|��}|�d�S dS )a
Obtain the name of the currently used cipher.
:returns: The name of the currently used cipher or :obj:`None`
if no connection has been established.
:rtype: :class:`unicode` or :class:`NoneType`
.. versionadded:: 0.15
N�utf-8)r� �SSL_get_current_cipherr� r� r� r� �SSL_CIPHER_get_namer )r� �cipherr� rt rt ru �get_cipher_name s
zConnection.get_cipher_namec C s, t �| j�}|tjkrdS t �|tj�S dS )a.
Obtain the number of secret bits of the currently used cipher.
:returns: The number of secret bits of the currently used cipher
or :obj:`None` if no connection has been established.
:rtype: :class:`int` or :class:`NoneType`
.. versionadded:: 0.15
N)r� rC r� r� r� �SSL_CIPHER_get_bits)r� rE rt rt ru �get_cipher_bits s
zConnection.get_cipher_bitsc C s8 t �| j�}|tjkrdS t�t �|��}|�d�S dS )a%
Obtain the protocol version of the currently used cipher.
:returns: The protocol name of the currently used cipher
or :obj:`None` if no connection has been established.
:rtype: :class:`unicode` or :class:`NoneType`
.. versionadded:: 0.15
NrB )r� rC r� r� r� r� �SSL_CIPHER_get_versionr )r� rE �versionrt rt ru �get_cipher_version! s
z Connection.get_cipher_versionc C s t �t�| j��}|�d�S )a>
Retrieve the protocol version of the current connection.
:returns: The TLS version of the current connection, for example
the value for TLS 1.2 would be ``TLSv1.2``or ``Unknown``
for connections that were not successfully established.
:rtype: :class:`unicode`
rB )r� r� r� �SSL_get_versionr� r �r� rJ rt rt ru �get_protocol_version_name2 s z$Connection.get_protocol_version_namec C s t �| j�}|S )a
Retrieve the SSL or TLS protocol version of the current connection.
:returns: The TLS version of the current connection. For example,
it will return ``0x769`` for connections made over TLS version 1.
:rtype: :class:`int`
)r� � SSL_versionr� rM rt rt ru �get_protocol_version> s z Connection.get_protocol_versionc C s> d� t�dd� |D ���}t�d|�}t�| j|t|�� dS )ah
Specify the client's ALPN protocol list.
These protocols are offered to the server during protocol negotiation.
:param protos: A list of the protocols to be offered to the server.
This list should be a Python list of bytestrings representing the
protocols to offer, e.g. ``[b'http/1.1', b'spdy/2']``.
r� c s s | ]}t t|��|fV qd S r r� r� rt rt ru r� W r� z-Connection.set_alpn_protos.<locals>.<genexpr>r� N) r� r r� r� r� r� �SSL_set_alpn_protosr� r� r� rt rt ru r� I s
� zConnection.set_alpn_protosc C sH t �d�}t �d�}t�| j||� |s,dS t �|d |d �dd� S )z�
Get the protocol that was negotiated by ALPN.
:returns: A bytestring of the protocol name. If no protocol has been
negotiated yet, returns an empty string.
r� zunsigned int *r� r N)r� r� r� �SSL_get0_alpn_selectedr� r� )r� r� Zdata_lenrt rt ru �get_alpn_proto_negotiated_ s
z$Connection.get_alpn_proto_negotiatedc C s t �| jt j�}t|dk� dS )a
Called to request that the server sends stapled OCSP data, if
available. If this is not called on the client side then the server
will not send OCSP data. Should be used in conjunction with
:meth:`Context.set_ocsp_client_callback`.
rv N)r� �SSL_set_tlsext_status_typer� �TLSEXT_STATUSTYPE_ocspr� )r� r� rt rt ru � request_ocspq s �zConnection.request_ocsp)N)r )r )N)NN)N)Drq rr rs r r� r� r� r� r� r� r� r� r� r� �writer� r� �readr� r� r� r� r� r� r� r� r� r� r� r� r� rf r r
r r� r r r r r r r r r# r% � staticmethodr* r- r/ r1 r3 r� r� r8 r: r= r? rA rF rH rK rN rP r� r� rS rV rt rt rt ru rn � s�
6
%
%
"
rn )�r r� �sysr � functoolsr r � itertoolsr r �weakrefr r� r �sixr r
r �
OpenSSL._utilr r8 r
�_exception_from_error_queuer r� r r� r r� r � _make_assertr r r r� r rB r r� ZOpenSSL.cryptor r r r r r �__all__r� ro � NameError�objectr r r r r r! �SSL_SENT_SHUTDOWNr" �SSL_RECEIVED_SHUTDOWNr# r$ r% r& r' r( r) �SSL_OP_NO_SSLv2r* �SSL_OP_NO_SSLv3r+ �SSL_OP_NO_TLSv1r, �SSL_OP_NO_TLSv1_1r- �SSL_OP_NO_TLSv1_2r. �SSL_OP_NO_TLSv1_3r/ r� �SSL_MODE_RELEASE_BUFFERSr0 �SSL_OP_SINGLE_DH_USEr1 �SSL_OP_SINGLE_ECDH_USEr2 �SSL_OP_EPHEMERAL_RSAr3 � SSL_OP_MICROSOFT_SESS_ID_BUGr4 � SSL_OP_NETSCAPE_CHALLENGE_BUGr5 �'SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUGr6 �"SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUGr7 �!SSL_OP_MICROSOFT_BIG_SSLV3_BUFFERr8 � SSL_OP_MSIE_SSLV2_RSA_PADDINGr9 � SSL_OP_SSLEAY_080_CLIENT_DH_BUGr: �SSL_OP_TLS_D5_BUGr; � SSL_OP_TLS_BLOCK_PADDING_BUGr< �"SSL_OP_DONT_INSERT_EMPTY_FRAGMENTSr= � SSL_OP_CIPHER_SERVER_PREFERENCEr> �SSL_OP_TLS_ROLLBACK_BUGr? �SSL_OP_PKCS1_CHECK_1r@ �SSL_OP_PKCS1_CHECK_2rA �SSL_OP_NETSCAPE_CA_DN_BUGrB �&SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUGrC �SSL_OP_NO_COMPRESSIONrD �SSL_OP_NO_QUERY_MTUrE �SSL_OP_COOKIE_EXCHANGErF �SSL_OP_NO_TICKETrG �
SSL_OP_ALLrH �SSL_VERIFY_PEERrI � SSL_VERIFY_FAIL_IF_NO_PEER_CERTrJ �SSL_VERIFY_CLIENT_ONCErK �SSL_VERIFY_NONErL �SSL_SESS_CACHE_OFFrM �SSL_SESS_CACHE_CLIENTrN �SSL_SESS_CACHE_SERVERrO �SSL_SESS_CACHE_BOTHrP � SSL_SESS_CACHE_NO_AUTO_CLEARrQ �!SSL_SESS_CACHE_NO_INTERNAL_LOOKUPrR � SSL_SESS_CACHE_NO_INTERNAL_STORErS �SSL_SESS_CACHE_NO_INTERNALrT rU rV rW rX rY rZ r[ r\ r] r^ r_ r` ra rb rc rd r r r r r� re r� r� rf rg rh ri rj r~ r� r� r� r� r� r� rk r� �Cryptography_HAS_ALPNr� r� r� rl rm rn �SSL_library_initrt rt rt ru �<module> s 0
V
�� �
(=C; � � a R