File manager - Edit - /home/u478019808/domains/bestandroidphones.store/public_html/static/img/logo/OpenSSL.tar
Back
__pycache__/_util.cpython-39.pyc 0000644 00000010131 15025013455 0012515 0 ustar 00 a �Sae � @ s� d dl Z d dlZd dlmZmZ d dlmZ e� Ze�� ej Z ej Z e j dd�Z dd� Z dd � Zd d � Zd d � Zdd� Zer�dd� Zndd� Ze� Zejd Zdd� ZdS )� N)�PY2� text_type)�BindingF)Zshould_clear_after_allocc C s | sdS t t�| ��S )z� Get a native string type representing of the given CFFI ``char*`` object. :param charp: A C-style string represented using CFFI. :return: :class:`str` � )�native�ffi�string)Zcharp� r �1/usr/lib/python3.9/site-packages/OpenSSL/_util.py�text s r c C sR g }t �� }|dkrqF|�tt �|��tt �|��tt �|��f� q| |��dS )ac Convert an OpenSSL library failure into a Python exception. When a call to the native OpenSSL library fails, this is usually signalled by the return value, and an error code is stored in an error queue associated with the current thread. The err library provides functions to obtain these error codes and textual error messages. r N)�libZ ERR_get_error�appendr ZERR_lib_error_stringZERR_func_error_stringZERR_reason_error_string)Zexception_type�errors�errorr r r �exception_from_error_queue" s ��r c s � fdd�}|S )z~ Create an assert function that uses :func:`exception_from_error_queue` to raise an exception wrapped by *error*. c s | durt � � dS )zT If *ok* is not True, retrieve the error from OpenSSL and raise it. TN)r )�ok�r r r �openssl_assertB s z#make_assert.<locals>.openssl_assertr )r r r r r � make_assert< s r c C sL t | ttf�std| ��tr4t | t�rH| �d�S nt | t�rH| �d�S | S )a6 Convert :py:class:`bytes` or :py:class:`unicode` to the native :py:class:`str` type, using UTF-8 encoding if conversion is necessary. :raise UnicodeError: The input string is not UTF-8 decodeable. :raise TypeError: The input is neither :py:class:`bytes` nor :py:class:`unicode`. z %r is neither bytes nor unicode�utf-8)� isinstance�bytesr � TypeErrorr �encode�decode��sr r r r L s r c C s2 t | t�r| S t | t�r&| �t�� �S td��dS )a Convert a Python string to a :py:class:`bytes` string identifying the same path and which can be passed into an OpenSSL API accepting a filename. :param s: An instance of :py:class:`bytes` or :py:class:`unicode`. :return: An instance of :py:class:`bytes`. z3Path must be represented as bytes or unicode stringN)r r r r �sys�getfilesystemencodingr r r r r � path_stringa s r c C s | S )Nr r r r r � byte_stringt s r c C s | � d�S )N�charmap)r r r r r r z s z) for {0} is no longer accepted, use bytesc C s. t |t�r*tjt�| �tdd� |�d�S |S )a� If ``obj`` is text, emit a warning that it should be bytes instead and try to convert it to bytes automatically. :param str label: The name of the parameter from which ``obj`` was taken (so a developer can easily find the source of the problem and correct it). :return: If ``obj`` is the text string type, a ``bytes`` object giving the UTF-8 encoding of that text is returned. Otherwise, ``obj`` itself is returned. � )�category� stacklevelr )r r �warnings�warn� _TEXT_WARNING�format�DeprecationWarningr )Zlabel�objr r r �text_to_bytes_and_warn� s � r+ )r r% Zsixr r Z,cryptography.hazmat.bindings.openssl.bindingr ZbindingZinit_static_locksr r Z new_allocatorZno_zero_allocatorr r r r r r �objectZ UNSPECIFIED�__name__r' r+ r r r r �<module> s( � __pycache__/crypto.cpython-39.opt-1.pyc 0000644 00000265636 15025013455 0013706 0 ustar 00 a �Saӛ � @ s d dl Z d dlZd dlmZ d dlmZ d dlmZmZm Z m Z m Z m Z d dl mZmZmZ d dlmZmZ d dlmZmZ d dlmZ m Z m Z m!Z"m#Z$m%Z&m'Z(m)Z*m+Z, g d �Z-e j.Z/e j0Z1d Z2e j3Z4e j5Z6e j7Z8e j9Z:G d d � d e;�Z<ee e<�Z=e,e<�Z>d d� Z?dd� Z@d^dd�ZAdd� ZBdd� ZCdd� ZDG dd� deE�ZFG dd � d eE�ZGG d d � d eE�ZHd d � ZId!d"� ZJG d#d$� d$eE�ZKG d%d&� d&eE�ZLG d'd(� d(eE�ZMG d)d*� d*eE�ZNG d+d,� d,eE�ZOG d-d.� d.eE�ZPG d/d0� d0e;�ZQG d1d2� d2eE�ZRd3d4� ZSd5d6� ZTd7d8� ZUd_d9d:�ZVG d;d<� d<eE�ZWG d=d>� d>eE�ZXG d?d@� d@eE�ZYG dAdB� dBeE�ZZG dCdD� dDeE�Z[G dEdF� dFeE�Z\dGdH� Z]d`dIdJ�Z^dKdL� Z_dMdN� Z`dOdP� ZadQdR� ZbdSdT� ZcdUdV� ZddWdX� Zee�feeegdYeh�ZedadZd[�Zie�feiegd\eh�Zie �j� e �k� e �ld]� dS )b� N)� b16encode)�partial)�__eq__�__ne__�__lt__�__le__�__gt__�__ge__)� integer_types� text_type�PY2)�utils�x509)�dsa�rsa) �ffi�lib�exception_from_error_queue� byte_string�native� path_string� UNSPECIFIED�text_to_bytes_and_warn� make_assert)$� FILETYPE_PEM� FILETYPE_ASN1� FILETYPE_TEXT�TYPE_RSA�TYPE_DSA�Error�PKey�get_elliptic_curves�get_elliptic_curve�X509Name� X509Extension�X509Req�X509�X509StoreFlags� X509Store�X509StoreContextError�X509StoreContext�load_certificate�dump_certificate�dump_publickey�dump_privatekey�Revoked�CRL�PKCS7�PKCS12� NetscapeSPKI�load_publickey�load_privatekey�dump_certificate_request�load_certificate_request�sign�verify�dump_crl�load_crl�load_pkcs7_data� load_pkcs12i�� c @ s e Zd ZdZdS )r z7 An error occurred in an `OpenSSL.crypto` API. N)�__name__� __module__� __qualname__�__doc__� rB rB �2/usr/lib/python3.9/site-packages/OpenSSL/crypto.pyr P s r c C s ddl m} | S )ap Importing the backend from cryptography has the side effect of activating the osrandom engine. This mutates the global state of OpenSSL in the process and causes issues for various programs that use subinterpreters or embed Python. By putting the import in this function we can avoid triggering this side effect unless _get_backend is called. r ��backend)Z,cryptography.hazmat.backends.openssl.backendrE rD rB rB rC � _get_backendZ s rF c C s t d| f ��dS )z� An OpenSSL API failed somehow. Additionally, the failure which was encountered isn't one that's exercised by the test suite so future behavior of pyOpenSSL is now somewhat less predictable. zUnknown %s failureN)� RuntimeError)�whererB rB rC �_untested_errorg s rI c C sd | du r t �t �� �}t j}n(t�d| �}t �|t| ��}|fdd�}t|tj k� t� ||�}|S )z� Allocate a new OpenSSL memory BIO. Arrange for the garbage collector to clean it up automatically. :param buffer: None or some bytes to use to put into the BIO so that they can be read out. N�char[]c S s t �| �S �N)�_lib�BIO_free)�bio�refrB rB rC �free� s z_new_mem_buf.<locals>.free) rL �BIO_new� BIO_s_memrM �_ffi�newZBIO_new_mem_buf�len�_openssl_assert�NULL�gc)�bufferrN rP �datarB rB rC � _new_mem_bufp s r[ c C s. t �d�}t�| |�}t �|d |�dd� S )zO Copy the contents of an OpenSSL BIO object into a Python byte string. zchar**r N)rS rT rL ZBIO_get_mem_datarY )rN � result_bufferZ buffer_lengthrB rB rC �_bio_to_string� s r] c C s2 t |t�std��t�| |�}|dkr.td��dS )a� The the time value of an ASN1 time object. @param boundary: An ASN1_TIME pointer (or an object safely castable to that type) which will have its value set. @param when: A string representation of the desired time value. @raise TypeError: If C{when} is not a L{bytes} string. @raise ValueError: If C{when} does not represent a time in the required format. @raise RuntimeError: If the time value cannot be set for some other (unspecified) reason. zwhen must be a byte stringr zInvalid stringN)� isinstance�bytes� TypeErrorrL ZASN1_TIME_set_string� ValueError)�boundary�when� set_resultrB rB rC �_set_asn1_time� s re c C s� t �d| �}t�|�dkr dS t�|�tjkr>t �t�|��S t �d�}t� | |� |d t j krlt d� n6t �d|d �}t�|�}t �|�}t� |d � |S dS )a] Retrieve the time value of an ASN1 time object. @param timestamp: An ASN1_GENERALIZEDTIME* (or an object safely castable to that type) from which the time value will be retrieved. @return: The time value from C{timestamp} as a L{bytes} string in a certain format. Or C{None} if the object contains no time value. � ASN1_STRING*r NzASN1_GENERALIZEDTIME**� ASN1_TIME_to_generalizedtime) rS �castrL �ASN1_STRING_lengthZASN1_STRING_typeZV_ASN1_GENERALIZEDTIME�string�ASN1_STRING_datarT rg rW rI ZASN1_GENERALIZEDTIME_free)Z timestampZstring_timestampZgeneralized_timestampZ string_data� string_resultrB rB rC �_get_asn1_time� s" � � rm c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )�_X509NameInvalidatorc C s g | _ d S rK )�_names��selfrB rB rC �__init__� s z _X509NameInvalidator.__init__c C s | j �|� d S rK )ro �append�rq �namerB rB rC �add� s z_X509NameInvalidator.addc C s | j D ]}|`qd S rK )ro �_namert rB rB rC �clear� s z_X509NameInvalidator.clearN)r> r? r@ rr rv rx rB rB rB rC rn � s rn c @ sT e Zd ZdZdZdZdd� Zdd� Zedd � �Z d d � Z d d � Z dd� Z dd� Z dS )r zD A class representing an DSA or RSA public key or key pair. FTc C s" t �� }t�|t j�| _d| _d S )NF)rL Z EVP_PKEY_newrS rX � EVP_PKEY_free�_pkey� _initialized�rq �pkeyrB rB rC rr � s z PKey.__init__c C sJ ddl m}m} t� }| jr0tt| �}|||�S tt| �}||d|�S dS )a Export as a ``cryptography`` key. :rtype: One of ``cryptography``'s `key interfaces`_. .. _key interfaces: https://cryptography.io/en/latest/hazmat/ primitives/asymmetric/rsa/#key-interfaces .. versionadded:: 16.1.0 r )�load_der_private_key�load_der_public_keyN)�,cryptography.hazmat.primitives.serializationr~ r rF � _only_publicr- r r. )rq r~ r rE �derrB rB rC �to_cryptography_key� s zPKey.to_cryptography_keyc C s� t |tjtjtjtjf�s"td��ddlm }m }m }m } t |tjtjf�rbt t|�|j|j��S |�|j|j|� �}tt|�S dS )z� Construct based on a ``cryptography`` *crypto_key*. :param crypto_key: A ``cryptography`` key. :type crypto_key: One of ``cryptography``'s `key interfaces`_. :rtype: PKey .. versionadded:: 16.1.0 zUnsupported key typer )�Encoding� NoEncryption� PrivateFormat� PublicFormatN)r^ r Z RSAPublicKeyZ RSAPrivateKeyr Z DSAPublicKeyZ DSAPrivateKeyr` r� r� r� r� r� r4 r � public_bytes�DERZSubjectPublicKeyInfoZ private_bytesZPKCS8r5 )�clsZ crypto_keyr� r� r� r� r� rB rB rC �from_cryptography_key s* �� �� �zPKey.from_cryptography_keyc C s6 t |t�std��t |t�s$td��|tkr�|dkr<td��t�� }t�|tj �}t� |tj � t� � }t� |||tj�}t|dk� t�| j|�}t|dk� n�|tk�r$t�� }t|tjk� t�|tj�}t�||tjdtjtjtj�}t|dk� tt�|�dk� tt�| j|�dk� ntd��d| _dS ) a3 Generate a key pair of the given type, with the given number of bits. This generates a key "into" the this object. :param type: The key type. :type type: :py:data:`TYPE_RSA` or :py:data:`TYPE_DSA` :param bits: The number of bits. :type bits: :py:data:`int` ``>= 0`` :raises TypeError: If :py:data:`type` or :py:data:`bits` isn't of the appropriate type. :raises ValueError: If the number of bits isn't an integer of the appropriate size. :return: ``None`` �type must be an integerzbits must be an integerr zInvalid number of bits� zNo such key typeTN)r^ �intr` r ra rL �BN_newrS rX �BN_freeZ BN_set_wordZRSA_F4ZRSA_newZRSA_generate_key_exrW rV ZEVP_PKEY_assign_RSArz r ZDSA_newZDSA_freeZDSA_generate_parameters_exZDSA_generate_keyZEVP_PKEY_set1_DSAr r{ )rq �type�bitsZexponentr �resultr �resrB rB rC � generate_key/ s6 � zPKey.generate_keyc C sd | j rtd��t�| �� �tjkr*td��t�| j�}t� |tj �}t� |�}|dkrZdS t � dS )ax Check the consistency of an RSA private key. This is the Python equivalent of OpenSSL's ``RSA_check_key``. :return: ``True`` if key is consistent. :raise OpenSSL.crypto.Error: if the key is inconsistent. :raise TypeError: if the key is of a type which cannot be checked. Only RSA keys can currently be checked. zpublic key onlyzkey type unsupportedr� TN) r� r` rL Z EVP_PKEY_typer� � EVP_PKEY_RSA�EVP_PKEY_get1_RSArz rS rX �RSA_freeZ RSA_check_key�_raise_current_error)rq r r� rB rB rC �checkg s z PKey.checkc C s t �| j�S )zT Returns the type of the key :return: The type of the key. )rL � EVP_PKEY_idrz rp rB rB rC r� � s z PKey.typec C s t �| j�S )zh Returns the number of bits of the key :return: The number of bits of the key. )rL Z EVP_PKEY_bitsrz rp rB rB rC r� � s z PKey.bitsN)r> r? r@ rA r� r{ rr r� � classmethodr� r� r� r� r� rB rB rB rC r � s *8r c sd e Zd ZdZdZes � fdd�Zedd� �Zedd� �Z ed d � �Z d d � Z d d� Z dd� Z � ZS )�_EllipticCurveaZ A representation of a supported elliptic curve. @cvar _curves: :py:obj:`None` until an attempt is made to load the curves. Thereafter, a :py:type:`set` containing :py:type:`_EllipticCurve` instances each of which represents one curve supported by the system. @type _curves: :py:type:`NoneType` or :py:type:`set` Nc s t |t�rtt| ��|�S tS )z� Implement cooperation with the right-hand side argument of ``!=``. Python 3 seems to have dropped this cooperation in this very narrow circumstance. )r^ r� �superr �NotImplemented)rq �other�� __class__rB rC r � s z_EllipticCurve.__ne__c s> �� tjd�}t�d|�}�� ||� t� �fdd�|D ��S )z� Get the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. r zEC_builtin_curve[]c 3 s | ]}� � �|j�V qd S rK )�from_nid�nid)�.0�c�r� r rB rC � <genexpr>� � z7_EllipticCurve._load_elliptic_curves.<locals>.<genexpr>)ZEC_get_builtin_curvesrS rW rT �set)r� r Z num_curvesZbuiltin_curvesrB r� rC �_load_elliptic_curves� s z$_EllipticCurve._load_elliptic_curvesc C s | j du r| �|�| _ | j S )a Get, cache, and return the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. N)�_curvesr� r� rB rB rC �_get_elliptic_curves� s z#_EllipticCurve._get_elliptic_curvesc C s | ||t �|�|���d��S )a� Instantiate a new :py:class:`_EllipticCurve` associated with the given OpenSSL NID. :param lib: The OpenSSL library binding object. :param nid: The OpenSSL NID the resulting curve object will represent. This must be a curve NID (and not, for example, a hash NID) or subsequent operations will fail in unpredictable ways. :type nid: :py:class:`int` :return: The curve object. �ascii)rS rj � OBJ_nid2sn�decode)r� r r� rB rB rC r� � s z_EllipticCurve.from_nidc C s || _ || _|| _dS )a� :param _lib: The :py:mod:`cryptography` binding instance used to interface with OpenSSL. :param _nid: The OpenSSL NID identifying the curve this object represents. :type _nid: :py:class:`int` :param name: The OpenSSL short name identifying the curve this object represents. :type name: :py:class:`unicode` N)rL �_nidru )rq r r� ru rB rB rC rr � s z_EllipticCurve.__init__c C s d| j f S )Nz <Curve %r>)ru rp rB rB rC �__repr__� s z_EllipticCurve.__repr__c C s | j �| j�}t�|t j�S )z� Create a new OpenSSL EC_KEY structure initialized to use this curve. The structure is automatically garbage collected when the Python object is garbage collected. )rL ZEC_KEY_new_by_curve_namer� rS rX Z EC_KEY_free)rq �keyrB rB rC � _to_EC_KEY� s z_EllipticCurve._to_EC_KEY)r> r? r@ rA r� �_PY2r r� r� r� r� rr r� r� � __classcell__rB rB r� rC r� � s r� c C s t �t�S )a� Return a set of objects representing the elliptic curves supported in the OpenSSL build in use. The curve objects have a :py:class:`unicode` ``name`` attribute by which they identify themselves. The curve objects are useful as values for the argument accepted by :py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be used for ECDHE key exchange. )r� r� rL rB rB rB rC r! � s r! c C s, t � D ]}|j| kr| S qtd| ��dS )aT Return a single curve object selected by name. See :py:func:`get_elliptic_curves` for information about curve objects. :param name: The OpenSSL short name identifying the curve object to retrieve. :type name: :py:class:`unicode` If the named curve is not supported then :py:class:`ValueError` is raised. zunknown curve nameN)r! ru ra )ru ZcurverB rB rC r" s r" c s� e Zd ZdZdd� Z� fdd�Z� fdd�Zdd � Zee�Zee �Z ee �Z ee �Z ee �Z ee �Z d d � Zd d � Zdd� Zdd� Z� ZS )r# a An X.509 Distinguished Name. :ivar countryName: The country of the entity. :ivar C: Alias for :py:attr:`countryName`. :ivar stateOrProvinceName: The state or province of the entity. :ivar ST: Alias for :py:attr:`stateOrProvinceName`. :ivar localityName: The locality of the entity. :ivar L: Alias for :py:attr:`localityName`. :ivar organizationName: The organization name of the entity. :ivar O: Alias for :py:attr:`organizationName`. :ivar organizationalUnitName: The organizational unit of the entity. :ivar OU: Alias for :py:attr:`organizationalUnitName` :ivar commonName: The common name of the entity. :ivar CN: Alias for :py:attr:`commonName`. :ivar emailAddress: The e-mail address of the entity. c C s t �|j�}t�|t j�| _dS )z� Create a new X509Name, copying the given X509Name instance. :param name: The name to copy. :type name: :py:class:`X509Name` N)rL � X509_NAME_duprw rS rX �X509_NAME_freert rB rB rC rr 5 s zX509Name.__init__c s |� d�r tt| ��||�S t|�tur<tdt|�jf ��t� t |��}|tj krzz t � W n t yp Y n0 td��tt�| j��D ]J}t�| j|�}t�|�}t�|�}||kr�t�| j|�}t�|� q�q�t|t�r�|�d�}t�| j|tj|ddd�}|�st � d S )N�_z+attribute name must be string, not '%.200s'zNo such attribute�utf-8���r ) � startswithr� r# � __setattr__r� �strr` r> rL � OBJ_txt2nid� _byte_string� NID_undefr� r �AttributeError�range�X509_NAME_entry_countrw �X509_NAME_get_entry�X509_NAME_ENTRY_get_object� OBJ_obj2nidZX509_NAME_delete_entryZX509_NAME_ENTRY_freer^ � _text_type�encodeZX509_NAME_add_entry_by_NIDZ MBSTRING_UTF8) rq ru �valuer� �i�entZent_objZent_nid� add_resultr� rB rC r� ? s< �� �zX509Name.__setattr__c s� t �t|��}|t jkrFz t� W n ty4 Y n0 tt| ��|�S t � | j |d�}|dkrbdS t � | j |�}t � |�}t �d�}t �||�}t|dk� z0t �|d |�dd� �d�}W t �|d � nt �|d � 0 |S )a Find attribute. An X509Name object has the following attributes: countryName (alias C), stateOrProvince (alias ST), locality (alias L), organization (alias O), organizationalUnit (alias OU), commonName (alias CN) and more... r� N�unsigned char**r r� )rL r� r� r� r� r r� r# � __getattr__ZX509_NAME_get_index_by_NIDrw r� �X509_NAME_ENTRY_get_datarS rT ZASN1_STRING_to_UTF8rV rY r� � OPENSSL_free) rq ru r� Z entry_index�entryrZ r\ Z data_lengthr� r� rB rC r� f s* � zX509Name.__getattr__c s � fdd�}|S )Nc s( t |t�stS t�| j|j�}� |d�S �Nr )r^ r# r� rL Z X509_NAME_cmprw )rq r� r� ��oprB rC �f� s zX509Name._cmp.<locals>.frB )r� r� rB r� rC �_cmp� s z X509Name._cmpc C sB t �dd�}t�| j|t|��}t|t jk� dtt � |��f S )z6 String representation of an X509Name rJ i z<X509Name object '%s'>) rS rT rL ZX509_NAME_onelinerw rU rV rW �_nativerj )rq r\ Z format_resultrB rB rC r� � s � �zX509Name.__repr__c C s t �| j�S )a& Return an integer representation of the first four bytes of the MD5 digest of the DER representation of the name. This is the Python equivalent of OpenSSL's ``X509_NAME_hash``. :return: The (integer) hash of this name. :rtype: :py:class:`int` )rL ZX509_NAME_hashrw rp rB rB rC �hash� s z X509Name.hashc C sN t �d�}t�| j|�}t|dk� t �|d |�dd� }t�|d � |S )z� Return the DER encoding of this name. :return: The DER encoded form of this name. :rtype: :py:class:`bytes` r� r N)rS rT rL Z i2d_X509_NAMErw rV rY r� )rq r\ Z encode_resultrl rB rB rC r� � s z X509Name.derc C s� g }t t�| j��D ]n}t�| j|�}t�|�}t�|�}t�|�}t�|�}t � t� |�t� |��dd� }|� t �|�|f� q|S )z� Returns the components of this name, as a sequence of 2-tuples. :return: The components of this name. :rtype: :py:class:`list` of ``name, value`` tuples. N)r� rL r� rw r� r� r� r� r� rS rY rk ri rs rj ) rq r� r� r� �fnameZfvalr� ru r� rB rB rC �get_components� s ��zX509Name.get_components)r> r? r@ rA rr r� r� r� r r r r r r r� r� r� r� r� rB rB r� rC r# s ' ( r# c @ sd e Zd ZdZddd�Zedd� �Zejdej dej d iZ d d � Z d d � Z dd� Zdd� Zdd� ZdS )r$ z, An X.509 v3 certificate extension. Nc C s� t �d�}t�|t jt jt jt jd� t�|� |durRt|t�sJtd��|j |_ |durtt|t�sltd��|j |_ |r�d| }t� t j|||�}|t jkr�t � t �|tj�| _dS )a� Initializes an X509 extension. :param type_name: The name of the type of extension_ to create. :type type_name: :py:data:`bytes` :param bool critical: A flag indicating whether this is a critical extension. :param value: The value of the extension. :type value: :py:data:`bytes` :param subject: Optional X509 certificate to use as subject. :type subject: :py:class:`X509` :param issuer: Optional X509 certificate to use as issuer. :type issuer: :py:class:`X509` .. _extension: https://www.openssl.org/docs/manmaster/man5/ x509v3_config.html#STANDARD-EXTENSIONS z X509V3_CTX*r Nz issuer must be an X509 instancez subject must be an X509 instances critical,)rS rT rL ZX509V3_set_ctxrW ZX509V3_set_ctx_nodbr^ r& r` �_x509� issuer_certZ subject_certZX509V3_EXT_nconfr� rX �X509_EXTENSION_free� _extension)rq � type_nameZcriticalr� �subject�issuer�ctx� extensionrB rB rC rr � s" zX509Extension.__init__c C s t �t �| j��S rK )rL r� �X509_EXTENSION_get_objectr� rp rB rB rC r� & s �zX509Extension._nidZemailZDNSZURIc C s� t �dt�| j��}t �|tj�}g }tt�|��D ]�}t� ||�}z| j |j }W n6 t y� t � }t�||� |�tt|��� Y q40 tt �|jjj|jjj�d d � �}|�|d | � q4d�|�S )NzGENERAL_NAMES*�:z, )rS rh rL ZX509V3_EXT_d2ir� rX ZGENERAL_NAMES_freer� Zsk_GENERAL_NAME_numZsk_GENERAL_NAME_value� _prefixesr� �KeyErrorr[ ZGENERAL_NAME_printrs r� r] rY �dZia5rZ �length�join)rq �names�partsr� ru ZlabelrN r� rB rB rC �_subjectAltNameString2 s$ � �z#X509Extension._subjectAltNameStringc C sD t j| jkr| �� S t� }t �|| jdd�}t|dk� tt |��S )zF :return: a nice text representation of the extension r ) rL ZNID_subject_alt_namer� r� r[ �X509V3_EXT_printr� rV r� r] )rq rN � print_resultrB rB rC �__str__H s zX509Extension.__str__c C s t �| j�S )zk Returns the critical field of this X.509 extension. :return: The critical field. )rL ZX509_EXTENSION_get_criticalr� rp rB rB rC � get_criticalU s zX509Extension.get_criticalc C s& t �| j�}t �|�}t�t �|��S )z� Returns the short type name of this X.509 extension. The result is a byte string such as :py:const:`b"basicConstraints"`. :return: The short type name. :rtype: :py:data:`bytes` .. versionadded:: 0.12 )rL r� r� r� rS rj r� )rq �objr� rB rB rC �get_short_name] s z X509Extension.get_short_namec C s@ t �| j�}t�d|�}t �|�}t �|�}t�||�dd� S )z� Returns the data of the X509 extension, encoded as ASN.1. :return: The ASN.1 encoded data of this X509 extension. :rtype: :py:data:`bytes` .. versionadded:: 0.12 rf N)rL �X509_EXTENSION_get_datar� rS rh rk ri rY )rq Z octet_resultrl Z char_result� result_lengthrB rB rC �get_datal s zX509Extension.get_data)NN)r> r? r@ rA rr �propertyr� rL Z GEN_EMAILZGEN_DNSZGEN_URIr� r� r� r� r� r� rB rB rB rC r$ � s = � r$ c @ st e Zd ZdZdd� Zdd� Zedd� �Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� ZdS )r% z0 An X.509 certificate signing requests. c C s& t �� }t�|t j�| _| �d� d S r� )rL Z X509_REQ_newrS rX � X509_REQ_free�_req� set_version)rq �reqrB rB rC rr � s zX509Req.__init__c C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` certificate signing request. :rtype: ``cryptography.x509.CertificateSigningRequest`` .. versionadded:: 17.1.0 r )�load_der_x509_csr)�cryptography.x509r� r6 r rF )rq r� r� rE rB rB rC �to_cryptography� s zX509Req.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )a Construct based on a ``cryptography`` *crypto_req*. :param crypto_req: A ``cryptography`` X.509 certificate signing request :type crypto_req: ``cryptography.x509.CertificateSigningRequest`` :rtype: X509Req .. versionadded:: 17.1.0 z%Must be a certificate signing requestr �r� ) r^ r ZCertificateSigningRequestr` r� r� r� r� r7 r )r� Z crypto_reqr� r� rB rB rC �from_cryptography� s zX509Req.from_cryptographyc C s t �| j|j�}t|dk� dS )z� Set the public key of the certificate signing request. :param pkey: The public key to use. :type pkey: :py:class:`PKey` :return: ``None`` r� N)rL ZX509_REQ_set_pubkeyr� rz rV �rq r} rd rB rB rC � set_pubkey� s zX509Req.set_pubkeyc C sD t �t �}t�| j�|_t|jtjk� t� |jtj �|_d|_ |S )z� Get the public key of the certificate signing request. :return: The public key. :rtype: :py:class:`PKey` T) r �__new__rL ZX509_REQ_get_pubkeyr� rz rV rS rW rX ry r� r| rB rB rC � get_pubkey� s zX509Req.get_pubkeyc C s t �| j|�}t|dk� dS )z� Set the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :param int version: The version number. :return: ``None`` r� N)rL ZX509_REQ_set_versionr� rV )rq �versionrd rB rB rC r� � s zX509Req.set_versionc C s t �| j�S )z� Get the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :return: The value of the version subfield. :rtype: :py:class:`int` )rL ZX509_REQ_get_versionr� rp rB rB rC � get_version� s zX509Req.get_versionc C s2 t �t �}t�| j�|_t|jtjk� | |_ |S )a� Return the subject of this certificate signing request. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate signing request. Modifying it will modify the underlying signing request, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate signing request. :rtype: :class:`X509Name` ) r# r rL ZX509_REQ_get_subject_namer� rw rV rS rW �_ownerrt rB rB rC � get_subject� s zX509Req.get_subjectc C sl t �� }t|tjk� t�|t j�}|D ]$}t|t�s>t d��t � ||j � q(t � | j |�}t|dk� dS )z� Add extensions to the certificate signing request. :param extensions: The X.509 extensions to add. :type extensions: iterable of :py:class:`X509Extension` :return: ``None`` �+One of the elements is not an X509Extensionr� N)rL Zsk_X509_EXTENSION_new_nullrV rS rW rX Zsk_X509_EXTENSION_freer^ r$ ra Zsk_X509_EXTENSION_pushr� ZX509_REQ_add_extensionsr� )rq � extensions�stack�extr� rB rB rC �add_extensions� s zX509Req.add_extensionsc C sn g }t �| j�}t�|dd� �}tt �|��D ]:}t�t�}t � t � ||��}t�|t j �|_ |� |� q.|S )z� Get X.509 extensions in the certificate signing request. :return: The X.509 extensions in this request. :rtype: :py:class:`list` of :py:class:`X509Extension` objects. .. versionadded:: 0.15 c S s t �| t�t jd��S )Nr� )rL Zsk_X509_EXTENSION_pop_freerS Z addressofZ _original_lib)�xrB rB rC �<lambda> s �z(X509Req.get_extensions.<locals>.<lambda>)rL ZX509_REQ_get_extensionsr� rS rX r� Zsk_X509_EXTENSION_numr$ r �X509_EXTENSION_dupZsk_X509_EXTENSION_valuer� r� rs )rq ZextsZnative_exts_objr� r r� rB rB rC �get_extensions s � � zX509Req.get_extensionsc C s^ |j rtd��|js td��t�t|��}|tjkr<td��t�| j |j |�}t |dk� dS )ad Sign the certificate signing request with this key and digest type. :param pkey: The key pair to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use for the signature, e.g. :py:data:`b"sha256"`. :type digest: :py:class:`bytes` :return: ``None`` �Key has only public part�Key is uninitialized�No such digest methodr N) r� ra r{ rL �EVP_get_digestbynamer� rS rW Z X509_REQ_signr� rz rV �rq r} �digest� digest_obj� sign_resultrB rB rC r8 " s z X509Req.signc C s4 t |t�std��t�| j|j�}|dkr0t� |S )a@ Verifies the signature on this certificate signing request. :param PKey key: A public key. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid or there is a problem verifying the signature. � pkey must be a PKey instancer )r^ r r` rL ZX509_REQ_verifyr� rz r� )rq r} r� rB rB rC r9 : s zX509Req.verifyN)r> r? r@ rA rr r� r� r r r r� r r r r r8 r9 rB rB rB rC r% | s r% c @ s e Zd ZdZdd� Zedd� �Zdd� Zedd � �Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Z d2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z!d<d=� Z"d>d?� Z#d@dA� Z$dBS )Cr& z An X.509 certificate. c C s: t �� }t|tjk� t�|t j�| _t� | _ t� | _ d S rK ) rL ZX509_newrV rS rW rX � X509_freer� rn �_issuer_invalidator�_subject_invalidator)rq r rB rB rC rr U s z X509.__init__c C s. | � | �}t�|tj�|_t� |_t� |_|S rK ) r rS rX rL r r� rn r r )r� r �certrB rB rC �_from_raw_x509_ptr] s zX509._from_raw_x509_ptrc C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` certificate. :rtype: ``cryptography.x509.Certificate`` .. versionadded:: 17.1.0 r )�load_der_x509_certificate)r� r! r, r rF )rq r! r� rE rB rB rC r� e s zX509.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )z� Construct based on a ``cryptography`` *crypto_cert*. :param crypto_key: A ``cryptography`` X.509 certificate. :type crypto_key: ``cryptography.x509.Certificate`` :rtype: X509 .. versionadded:: 17.1.0 zMust be a certificater r ) r^ r Z Certificater` r� r� r� r� r+ r )r� Z crypto_certr� r� rB rB rC r s s zX509.from_cryptographyc C s$ t |t�std��t�| j|� dS )a Set the version number of the certificate. Note that the version value is zero-based, eg. a value of 0 is V1. :param version: The version number of the certificate. :type version: :py:class:`int` :return: ``None`` zversion must be an integerN)r^ r� r` rL ZX509_set_versionr� �rq r rB rB rC r� � s zX509.set_versionc C s t �| j�S )z� Return the version number of the certificate. :return: The version number of the certificate. :rtype: :py:class:`int` )rL ZX509_get_versionr� rp rB rB rC r � s zX509.get_versionc C sF t �t �}t�| j�|_|jtjkr*t� t� |jtj �|_d|_ |S )z{ Get the public key of the certificate. :return: The public key. :rtype: :py:class:`PKey` T) r r rL �X509_get_pubkeyr� rz rS rW r� rX ry r� r| rB rB rC r � s zX509.get_pubkeyc C s2 t |t�std��t�| j|j�}t|dk� dS )z� Set the public key of the certificate. :param pkey: The public key. :type pkey: :py:class:`PKey` :return: :py:data:`None` r r� N)r^ r r` rL ZX509_set_pubkeyr� rz rV r rB rB rC r � s zX509.set_pubkeyc C sp t |t�std��|jr td��|js.td��t�t|��}|t j krNtd��t� | j |j |�}t|dk� dS )a Sign the certificate with this key and digest type. :param pkey: The key to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use. :type digest: :py:class:`bytes` :return: :py:data:`None` r zKey only has public partr r r N)r^ r r` r� ra r{ rL r r� rS rW Z X509_signr� rz rV )rq r} r Zevp_mdr rB rB rC r8 � s z X509.signc C s: t �| j�}t �|j�}|t jkr*td��t�t � |��S )z� Return the signature algorithm used in the certificate. :return: The name of the algorithm. :rtype: :py:class:`bytes` :raises ValueError: If the signature algorithm is undefined. .. versionadded:: 0.13 z Undefined signature algorithm) rL ZX509_get0_tbs_sigalgr� r� � algorithmr� ra rS rj Z OBJ_nid2ln)rq Zalgorr� rB rB rC �get_signature_algorithm� s z X509.get_signature_algorithmc C s� t �t|��}|tjkr td��t�dt j�}t�dd�}t|�|d< t � | j |||�}t |dk� d� dd� t� ||d �D ��S ) a7 Return the digest of the X509 object. :param digest_name: The name of the digest algorithm to use. :type digest_name: :py:class:`bytes` :return: The digest of the object, formatted as :py:const:`b":"`-delimited hex pairs. :rtype: :py:class:`bytes` r �unsigned char[]zunsigned int[]r� r � :c S s g | ]}t |��� �qS rB )r �upper)r� ZchrB rB rC � <listcomp> s �z X509.digest.<locals>.<listcomp>)rL r r� rS rW ra rT ZEVP_MAX_MD_SIZErU Z X509_digestr� rV r� rY )rq Z digest_namer r\ r� Z digest_resultrB rB rC r � s � ��z X509.digestc C s t �| j�S )z� Return the hash of the X509 subject. :return: The hash of the subject. :rtype: :py:class:`bytes` )rL ZX509_subject_name_hashr� rp rB rB rC �subject_name_hash s zX509.subject_name_hashc C s� t |t�std��t|�dd� }t |t�s6|�d�}t�d�}t� ||�}|d tj krzt� t� | j �|�}|r�t� nXt�|d tj �}t�|d � |tj kr�t� t�|tj�}t�| j |�}t|dk� dS )z� Set the serial number of the certificate. :param serial: The new serial number. :type serial: :py:class:`int` :return: :py:data`None` zserial must be an integer� Nr� �BIGNUM**r r� )r^ �_integer_typesr` �hexr_ r� rS rT rL � BN_hex2bnrW ZASN1_INTEGER_set�X509_get_serialNumberr� r� �BN_to_ASN1_INTEGERr� rX �ASN1_INTEGER_freeZX509_set_serialNumberrV )rq �serial� hex_serial� bignum_serialZ small_serialrd � asn1_serialrB rB rC �set_serial_number s( � zX509.set_serial_numberc C s� t �| j�}t �|tj�}zVt �|�}z0t�|�}t|d�}|W t � |� W t � |� S t � |� 0 W t � |� n t � |� 0 dS )zx Return the serial number of this certificate. :return: The serial number. :rtype: int � N) rL r0 r� ZASN1_INTEGER_to_BNrS rW Z BN_bn2hexrj r� r� r� )rq r6 r5 r4 Zhexstring_serialr3 rB rB rC �get_serial_number: s � �zX509.get_serial_numberc C s. t |t�std��t�| j�}t�||� dS )z� Adjust the time stamp on which the certificate stops being valid. :param int amount: The number of seconds by which to adjust the timestamp. :return: ``None`` �amount must be an integerN)r^ r� r` rL �X509_getm_notAfterr� �X509_gmtime_adj)rq �amountZnotAfterrB rB rC �gmtime_adj_notAfterN s zX509.gmtime_adj_notAfterc C s. t |t�std��t�| j�}t�||� dS )z� Adjust the timestamp on which the certificate starts being valid. :param amount: The number of seconds by which to adjust the timestamp. :return: ``None`` r: N)r^ r� r` rL �X509_getm_notBeforer� r< )rq r= Z notBeforerB rB rC �gmtime_adj_notBefore\ s zX509.gmtime_adj_notBeforec C s( t | �� �}tj�|d�}|tj�� k S )z� Check whether the certificate has expired. :return: ``True`` if the certificate has expired, ``False`` otherwise. :rtype: bool z %Y%m%d%H%M%SZ)r� � get_notAfter�datetime�strptimeZutcnow)rq Z time_stringZ not_afterrB rB rC � has_expiredi s zX509.has_expiredc C s t || j��S rK )rm r� )rq �whichrB rB rC �_get_boundary_timeu s zX509._get_boundary_timec C s | � tj�S )a Get the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType )rF rL r? rp rB rB rC � get_notBeforex s zX509.get_notBeforec C s t || j�|�S rK )re r� �rq rE rc rB rB rC �_set_boundary_time� s zX509._set_boundary_timec C s | � tj|�S )z� Set the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` )rI rL r? �rq rc rB rB rC � set_notBefore� s zX509.set_notBeforec C s | � tj�S )a Get the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType )rF rL r; rp rB rB rC rA � s zX509.get_notAfterc C s | � tj|�S )z� Set the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` )rI rL r; rJ rB rB rC � set_notAfter� s zX509.set_notAfterc C s0 t �t �}|| j�|_t|jtjk� | |_|S rK )r# r r� rw rV rS rW r )rq rE ru rB rB rC � _get_name� s zX509._get_namec C s0 t |t�std��|| j|j�}t|dk� d S )Nzname must be an X509Namer� )r^ r# r` r� rw rV )rq rE ru rd rB rB rC � _set_name� s zX509._set_namec C s | � tj�}| j�|� |S )a� Return the issuer of this certificate. This creates a new :class:`X509Name` that wraps the underlying issuer name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this issuer. :return: The issuer of this certificate. :rtype: :class:`X509Name` )rM rL ZX509_get_issuer_namer rv rt rB rB rC � get_issuer� s zX509.get_issuerc C s | � tj|� | j�� dS )z� Set the issuer of this certificate. :param issuer: The issuer. :type issuer: :py:class:`X509Name` :return: ``None`` N)rN rL ZX509_set_issuer_namer rx )rq r� rB rB rC � set_issuer� s zX509.set_issuerc C s | � tj�}| j�|� |S )a� Return the subject of this certificate. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate. :rtype: :class:`X509Name` )rM rL �X509_get_subject_namer rv rt rB rB rC r � s zX509.get_subjectc C s | � tj|� | j�� dS )z� Set the subject of this certificate. :param subject: The subject. :type subject: :py:class:`X509Name` :return: ``None`` N)rN rL ZX509_set_subject_namer rx )rq r� rB rB rC � set_subject� s zX509.set_subjectc C s t �| j�S )z� Get the number of extensions on this certificate. :return: The number of extensions. :rtype: :py:class:`int` .. versionadded:: 0.12 )rL ZX509_get_ext_countr� rp rB rB rC �get_extension_count� s zX509.get_extension_countc C s< |D ]2}t |t�std��t�| j|jd�}|st� qdS )z� Add extensions to the certificate. :param extensions: The extensions to add. :type extensions: An iterable of :py:class:`X509Extension` objects. :return: ``None`` r r� N)r^ r$ ra rL Z X509_add_extr� r� r� )rq r r r� rB rB rC r s zX509.add_extensionsc C sN t �t �}t�| j|�|_|jtjkr.td��t� |j�}t� |tj �|_|S )a� Get a specific extension of the certificate by index. Extensions on a certificate are kept in order. The index parameter selects which extension will be returned. :param int index: The index of the extension to retrieve. :return: The extension at the specified index. :rtype: :py:class:`X509Extension` :raises IndexError: If the extension index was out of bounds. .. versionadded:: 0.12 z extension index out of bounds) r$ r rL Z X509_get_extr� r� rS rW � IndexErrorr rX r� )rq �indexr r� rB rB rC � get_extension s zX509.get_extensionN)%r> r? r@ rA rr r� r r� r r� r r r r8 r% r r* r7 r9 r> r@ rD rF rG rI rK rA rL rM rN rO rP r rR rS r rV rB rB rB rC r& P sF ( r& c @ sL e Zd ZdZejZejZej Z ej Z ej ZejZejZejZejZejZdS )r' a Flags for X509 verification, used to change the behavior of :class:`X509Store`. See `OpenSSL Verification Flags`_ for details. .. _OpenSSL Verification Flags: https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_flags.html N)r> r? r@ rA rL ZX509_V_FLAG_CRL_CHECKZ CRL_CHECKZX509_V_FLAG_CRL_CHECK_ALLZ CRL_CHECK_ALLZX509_V_FLAG_IGNORE_CRITICALZIGNORE_CRITICALZX509_V_FLAG_X509_STRICTZ X509_STRICTZ X509_V_FLAG_ALLOW_PROXY_CERTSZALLOW_PROXY_CERTSZX509_V_FLAG_POLICY_CHECKZ POLICY_CHECKZX509_V_FLAG_EXPLICIT_POLICYZEXPLICIT_POLICYZX509_V_FLAG_INHIBIT_MAPZ INHIBIT_MAPZX509_V_FLAG_NOTIFY_POLICYZ NOTIFY_POLICYZ X509_V_FLAG_CHECK_SS_SIGNATUREZCHECK_SS_SIGNATURErB rB rB rC r' + s r' c @ sB e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zdd d�Z d S )r( a� An X.509 store. An X.509 store is used to describe a context in which to verify a certificate. A description of a context may include a set of certificates to trust, a set of certificate revocation lists, verification flags and more. An X.509 store, being only a description, cannot be used by itself to verify a certificate. To carry out the actual verification process, see :class:`X509StoreContext`. c C s t �� }t�|t j�| _d S rK )rL ZX509_STORE_newrS rX ZX509_STORE_free�_store�rq �storerB rB rC rr P s zX509Store.__init__c C s0 t |t�st� �t�| j|j�}t|dk� dS )a� Adds a trusted certificate to this store. Adding a certificate with this method adds this certificate as a *trusted* certificate. :param X509 cert: The certificate to add to this store. :raises TypeError: If the certificate is not an :class:`X509`. :raises OpenSSL.crypto.Error: If OpenSSL was unhappy with your certificate. :return: ``None`` if the certificate was added successfully. r� N)r^ r& r` rL ZX509_STORE_add_certrW r� rV )rq r r� rB rB rC �add_certT s zX509Store.add_certc C s t t�| j|j�dk� dS )a� Add a certificate revocation list to this store. The certificate revocation lists added to a store will only be used if the associated flags are configured to check certificate revocation lists. .. versionadded:: 16.1.0 :param CRL crl: The certificate revocation list to add to this store. :return: ``None`` if the certificate revocation list was added successfully. r N)rV rL ZX509_STORE_add_crlrW �_crl�rq �crlrB rB rC �add_crlj s zX509Store.add_crlc C s t t�| j|�dk� dS )a� Set verification flags to this store. Verification flags can be combined by oring them together. .. note:: Setting a verification flag sometimes requires clients to add additional information to the store, otherwise a suitable error will be raised. For example, in setting flags to enable CRL checking a suitable CRL must be added to the store otherwise an error will be raised. .. versionadded:: 16.1.0 :param int flags: The verification flags to set on this store. See :class:`X509StoreFlags` for available constants. :return: ``None`` if the verification flags were successfully set. r N)rV rL ZX509_STORE_set_flagsrW )rq �flagsrB rB rC � set_flagsz s zX509Store.set_flagsc C sF t �� }t�|t j�}t �|t�|�� �� t t � | j |�dk� dS )a� Set the time against which the certificates are verified. Normally the current time is used. .. note:: For example, you can determine if a certificate was valid at a given time. .. versionadded:: 17.0.0 :param datetime vfy_time: The verification time to set on this store. :return: ``None`` if the verification time was successfully set. r N) rL ZX509_VERIFY_PARAM_newrS rX ZX509_VERIFY_PARAM_freeZX509_VERIFY_PARAM_set_time�calendarZtimegmZ timetuplerV ZX509_STORE_set1_paramrW )rq Zvfy_timeZparamrB rB rC �set_time� s �zX509Store.set_timeNc C sN |du rt j}nt|�}|du r(t j}nt|�}t�| j||�}|sJt� dS )a� Let X509Store 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 *cafile* or *capath* may be ``None``. .. note:: Both *cafile* and *capath* may be set simultaneously. Call this method multiple times to add more than one location. For example, CA certificates, and certificate revocation list bundles may be passed in *cafile* in subsequent calls to this method. .. versionadded:: 20.0 :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`` if the locations were set successfully. :raises OpenSSL.crypto.Error: If both *cafile* and *capath* is ``None`` or the locations could not be set for any reason. N)rS rW � _path_stringrL ZX509_STORE_load_locationsrW r� )rq ZcafileZcapathZ load_resultrB rB rC �load_locations� s �zX509Store.load_locations)N) r> r? r@ rA rr rZ r^ r` rb rd rB rB rB rC r( B s r( c s e Zd ZdZ� fdd�Z� ZS )r) z� An exception raised when an error occurred while verifying a certificate using `OpenSSL.X509StoreContext.verify_certificate`. :ivar certificate: The certificate which caused verificate failure. :type certificate: :class:`X509` c s t t| ��|� || _d S rK )r� r) rr � certificate)rq �messagere r� rB rC rr � s z X509StoreContextError.__init__)r> r? r@ rA rr r� rB rB r� rC r) � s r) c @ sV e Zd ZdZddd�Zedd� �Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dS )r* a� An X.509 store context. An X.509 store context is used to carry out the actual verification process of a certificate in a described context. For describing such a context, see :class:`X509Store`. :ivar _store_ctx: The underlying X509_STORE_CTX structure used by this instance. It is dynamically allocated and automatically garbage collected. :ivar _store: See the ``store`` ``__init__`` parameter. :ivar _cert: See the ``certificate`` ``__init__`` parameter. :ivar _chain: See the ``chain`` ``__init__`` parameter. :param X509Store store: The certificates which will be trusted for the purposes of any verifications. :param X509 certificate: The certificate to be verified. :param chain: List of untrusted certificates that may be used for building the certificate chain. May be ``None``. :type chain: :class:`list` of :class:`X509` Nc C s< t �� }t�|t j�| _|| _|| _| �|�| _ | � � d S rK ) rL ZX509_STORE_CTX_newrS rX ZX509_STORE_CTX_free� _store_ctxrW �_cert�_build_certificate_stack�_chain�_init)rq rY re �chainZ store_ctxrB rB rC rr � s zX509StoreContext.__init__c C s� dd� }| d u s t | �dkr"tjS t�� }t|tjk� t�||�}| D ]N}t|t�s^t d��tt� |j �dk� t� ||j �dkrHt� |j � t� qH|S )Nc S s8 t t�| ��D ]}t�| |�}t�|� qt�| � d S rK )r� rL � sk_X509_num� sk_X509_valuer � sk_X509_free)�sr� r rB rB rC �cleanup s z:X509StoreContext._build_certificate_stack.<locals>.cleanupr z+One of the elements is not an X509 instance)rU rS rW rL �sk_X509_new_nullrV rX r^ r& r` Z X509_up_refr� � sk_X509_pushr r� )Z certificatesrq r r rB rB rC ri s z)X509StoreContext._build_certificate_stackc C s. t �| j| jj| jj| j�}|dkr*t� dS )z� Set up the store context for a subsequent verification operation. Calling this method more than once without first calling :meth:`_cleanup` will leak memory. r N)rL ZX509_STORE_CTX_initrg rW rh r� rj r� �rq �retrB rB rC rk % s �zX509StoreContext._initc C s t �| j� dS )z� Internally cleans up the store context. The store context can then be reused with a new call to :meth:`_init`. N)rL ZX509_STORE_CTX_cleanuprg rp rB rB rC �_cleanup2 s zX509StoreContext._cleanupc C s\ t �| j�t �| j�tt�t �t �| j����g}t �| j�}t � |�}t � |�}t ||�S )z� Convert an OpenSSL native context error failure into a Python exception. When a call to native OpenSSL X509_verify_cert fails, additional information about the failure can be obtained from the store context. ) rL ZX509_STORE_CTX_get_errorrg Z X509_STORE_CTX_get_error_depthr� rS rj Z X509_verify_cert_error_stringZ X509_STORE_CTX_get_current_certZX509_dupr& r r) )rq �errorsr� rh �pycertrB rB rC �_exception_from_context: s ���� z(X509StoreContext._exception_from_contextc C s || _ dS )z� Set the context's X.509 store. .. versionadded:: 0.15 :param X509Store store: The store description which will be used for the purposes of any *future* verifications. N)rW rX rB rB rC � set_storeT s zX509StoreContext.set_storec C s8 | � � | �� t�| j�}| � � |dkr4| �� �dS )a" Verify a certificate in a context. .. versionadded:: 0.15 :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. r N)rv rk rL �X509_verify_certrg ry rt rB rB rC �verify_certificate_ s z#X509StoreContext.verify_certificatec C s� | � � | �� t�| j�}|dkr4| � � | �� �t�| j�}t|tj k� g }t t� |��D ]2}t� ||�}t|tj k� t �|�}|�|� q`t�|� | � � |S )aR Verify a certificate in a context and return the complete validated chain. :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. .. versionadded:: 20.0 r )rv rk rL r{ rg ry ZX509_STORE_CTX_get1_chainrV rS rW r� rm rn r& r rs ro )rq ru Z cert_stackr� r� r rx rB rB rC �get_verified_chainu s" z#X509StoreContext.get_verified_chain)N) r> r? r@ rA rr � staticmethodri rk rv ry rz r| r} rB rB rB rC r* � s r* c C sv t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �|�S )a Load a certificate (X509) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param bytes buffer: The buffer the certificate is stored in :return: The X509 object r� �3type argument must be FILETYPE_PEM or FILETYPE_ASN1)r^ r� r� r[ r rL ZPEM_read_bio_X509rS rW r Z d2i_X509_biora r� r& r )r� rY rN r rB rB rC r+ � s r+ c C sn t � }| tkr t�||j�}n<| tkr6t�||j�}n$| tkrRt�||jdd�}nt d��t |dk� t |�S )a Dump the certificate *cert* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1, or FILETYPE_TEXT) :param cert: The certificate to dump :return: The buffer with the dumped certificate in r �Ctype argument must be FILETYPE_PEM, FILETYPE_ASN1, or FILETYPE_TEXTr� ) r[ r rL ZPEM_write_bio_X509r� r Z i2d_X509_bior Z X509_print_exra rV r] )r� r rN � result_coderB rB rC r, � s � r, c C sP t � }| tkrtj}n| tkr&tj}ntd��|||j�}|dkrHt� t |�S )z� Dump a public key to a buffer. :param type: The file type (one of :data:`FILETYPE_PEM` or :data:`FILETYPE_ASN1`). :param PKey pkey: The public key to dump :return: The buffer with the dumped key in it. :rtype: bytes r r� ) r[ r rL ZPEM_write_bio_PUBKEYr Zi2d_PUBKEY_biora rz r� r] )r� r} rN Z write_bior� rB rB rC r- � s r- c C s t � }t|t�std��|durR|du r0td��t�t|��}|tjkrXt d��ntj}t | |�}| t kr�t� ||j |tjd|j|j�}|�� nh| tkr�t�||j �}nP| tkr�t�|j �tjkr�td��t�t�|j �tj�}t�||d�}nt d��t|dk� t|�S )a� Dump the private key *pkey* into a buffer string encoded with the type *type*. Optionally (if *type* is :const:`FILETYPE_PEM`) encrypting it using *cipher* and *passphrase*. :param type: The file type (one of :const:`FILETYPE_PEM`, :const:`FILETYPE_ASN1`, or :const:`FILETYPE_TEXT`) :param PKey pkey: The PKey to dump :param cipher: (optional) if encrypted PEM format, the cipher to use :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The buffer with the dumped key in :rtype: bytes zpkey must be a PKeyNzDif a value is given for cipher one must also be given for passphrasezInvalid cipher namer z-Only RSA keys are supported for FILETYPE_TEXTr� ) r[ r^ r r` rL ZEVP_get_cipherbynamer� rS rW ra �_PassphraseHelperr ZPEM_write_bio_PrivateKeyrz �callback� callback_args�raise_if_problemr Zi2d_PrivateKey_bior r� r� rX r� r� Z RSA_printrV r] ) r� r} Zcipher� passphraserN Z cipher_obj�helperr� r rB rB rC r. � sH � � � r. c @ s` e Zd ZdZg d�Zdd� Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dd� Z dS )r/ z# A certificate revocation. )s unspecifieds keyCompromises CACompromises affiliationChangeds supersededs cessationOfOperations certificateHoldc C s t �� }t�|t j�| _d S rK )rL ZX509_REVOKED_newrS rX �X509_REVOKED_free�_revoked)rq �revokedrB rB rC rr C s zRevoked.__init__c C sf t �t�� tj�}t �d�}||d< t�||�}|s<td��t �t�|t j �tj �}t� | j |� dS )z� Set the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :param bytes hex_str: The new serial number. :return: ``None`` r, r zbad hex stringN) rS rX rL r� r� rT r/ ra r1 rW r2 Z X509_REVOKED_set_serialNumberr� )rq Zhex_strr5 Z bignum_ptrZ bn_resultr6 rB rB rC � set_serialG s �zRevoked.set_serialc C s@ t � }t�| j�}t|tjk� t�||�}t|dk� t|�S )z� Get the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :return: The serial number. :rtype: bytes r ) r[ rL Z X509_REVOKED_get0_serialNumberr� rV rS rW Zi2a_ASN1_INTEGERr] )rq rN Zasn1_intr� rB rB rC � get_serial_ s zRevoked.get_serialc C s^ t t�| j��D ]H}t�| j|�}t�|�}t�|�tjkrt�|� t� | j|� qZqd S rK ) r� rL �X509_REVOKED_get_ext_countr� �X509_REVOKED_get_extr� r� �NID_crl_reasonr� ZX509_REVOKED_delete_ext)rq r� r r� rB rB rC �_delete_reasonq s zRevoked._delete_reasonc C s� |du r| � � n�t|t�s&td��n�|�� �dd�}dd� | jD ��|�}t� � }t |t j k� t � |tj�}t�||�}t |t j k� | � � t�| jtj|dd�}t |dk� dS ) a� Set the reason of this revocation. If :data:`reason` is ``None``, delete the reason instead. :param reason: The reason string. :type reason: :class:`bytes` or :class:`NoneType` :return: ``None`` .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons which you might pass to this method. Nz$reason must be None or a byte string� r� c S s g | ] }|� � �qS rB )�lower)r� �rrB rB rC r) � r� z&Revoked.set_reason.<locals>.<listcomp>r r� )r� r^ r_ r` r� �replace� _crl_reasonsrU rL ZASN1_ENUMERATED_newrV rS rW rX ZASN1_ENUMERATED_freeZASN1_ENUMERATED_setZX509_REVOKED_add1_ext_i2dr� r� )rq �reasonZ reason_codeZnew_reason_extrd r� rB rB rC � set_reasonz s �zRevoked.set_reasonc C s� t t�| j��D ]p}t�| j|�}t�|�}t�|�tjkrt� }t� ||dd�}|stt� |t� |��}t |dk� t |� S qdS )a Get the reason of this revocation. :return: The reason, or ``None`` if there is none. :rtype: bytes or NoneType .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons this method might return. r N)r� rL r� r� r� r� r� r� r[ r� ZM_ASN1_OCTET_STRING_printr� rV r] )rq r� r r� rN r� rB rB rC � get_reason� s � zRevoked.get_reasonc C s | j dd� S )a Return a list of all the supported reason strings. This list is a copy; modifying it does not change the supported reason strings. :return: A list of reason strings. :rtype: :class:`list` of :class:`bytes` N)r� rp rB rB rC � all_reasons� s zRevoked.all_reasonsc C s t �| j�}t||�S )z� Set the revocation timestamp. :param bytes when: The timestamp of the revocation, as ASN.1 TIME. :return: ``None`` )rL � X509_REVOKED_get0_revocationDater� re )rq rc �dtrB rB rC � set_rev_date� s zRevoked.set_rev_datec C s t �| j�}t|�S )z� Get the revocation timestamp. :return: The timestamp of the revocation, as ASN.1 TIME. :rtype: bytes )rL r� r� rm )rq r� rB rB rC � get_rev_date� s zRevoked.get_rev_dateN)r> r? r@ rA r� rr r� r� r� r� r� r� r� r� rB rB rB rC r/ / s % r/ c @ s| e Zd ZdZdd� Zdd� Zedd� �Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zedefdd�ZdS ) r0 z( A certificate revocation list. c C s t �� }t�|t j�| _d S rK )rL Z X509_CRL_newrS rX � X509_CRL_freer[ r\ rB rB rC rr � s z CRL.__init__c C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` CRL. :rtype: ``cryptography.x509.CertificateRevocationList`` .. versionadded:: 17.1.0 r )�load_der_x509_crl)r� r� r: r rF )rq r� r� rE rB rB rC r� � s zCRL.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )a Construct based on a ``cryptography`` *crypto_crl*. :param crypto_crl: A ``cryptography`` certificate revocation list :type crypto_crl: ``cryptography.x509.CertificateRevocationList`` :rtype: CRL .. versionadded:: 17.1.0 z%Must be a certificate revocation listr r ) r^ r ZCertificateRevocationListr` r� r� r� r� r; r )r� Z crypto_crlr� r� rB rB rC r � s zCRL.from_cryptographyc C sn g }t �| j�}tt �|��D ]>}t �||�}t �|�}t�t�}t � |t j �|_ |� |� q |rjt|�S dS )aA Return the revocations in this certificate revocation list. These revocations will be provided by value, not by reference. That means it's okay to mutate them: it won't affect this CRL. :return: The revocations in this CRL. :rtype: :class:`tuple` of :class:`Revocation` N)rL ZX509_CRL_get_REVOKEDr[ r� Zsk_X509_REVOKED_numZsk_X509_REVOKED_value� Cryptography_X509_REVOKED_dupr/ r rS rX r� r� rs �tuple)rq �resultsZ revoked_stackr� r� Z revoked_copyZpyrevrB rB rC � get_revoked s zCRL.get_revokedc C s8 t �|j�}t|tjk� t �| j|�}t|dk� dS )a9 Add a revoked (by value not reference) to the CRL structure This revocation will be added by value, not by reference. That means it's okay to mutate it after adding: it won't affect this CRL. :param Revoked revoked: The new revocation. :return: ``None`` r N)rL r� r� rV rS rW ZX509_CRL_add0_revokedr[ )rq r� �copyr� rB rB rC � add_revoked s zCRL.add_revokedc C sB t �t �| j��}t|tjk� t�|t j�}t � t �}||_ |S )zc Get the CRL's issuer. .. versionadded:: 16.1.0 :rtype: X509Name ) rL r� ZX509_CRL_get_issuerr[ rV rS rW rX r� r# r rw )rq Z_issuerr� rB rB rC rO . s zCRL.get_issuerc C s t t�| j|�dk� dS )z� Set the CRL version. .. versionadded:: 16.1.0 :param int version: The version of the CRL. :return: ``None`` r N)rV rL ZX509_CRL_set_versionr[ r" rB rB rC r� = s zCRL.set_versionc C s t || j�|�S rK )re r[ rH rB rB rC rI H s zCRL._set_boundary_timec C s | � tj|�S )z� Set when the CRL was last updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` )rI rL ZX509_CRL_get_lastUpdaterJ rB rB rC �set_lastUpdateK s zCRL.set_lastUpdatec C s | � tj|�S )z� Set when the CRL will next be updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` )rI rL ZX509_CRL_get_nextUpdaterJ rB rB rC �set_nextUpdateZ s zCRL.set_nextUpdatec C s\ t �|�}t|tjk� t �| jt �|j�� t � | j� t � | j|j |�}t|dk� dS )a; Sign the CRL. Signing a CRL enables clients to associate the CRL itself with an issuer. Before a CRL is meaningful to other OpenSSL functions, it must be signed by an issuer. This method implicitly sets the issuer's name based on the issuer certificate and private key used to sign the CRL. .. versionadded:: 16.1.0 :param X509 issuer_cert: The issuer's certificate. :param PKey issuer_key: The issuer's private key. :param bytes digest: The digest method to sign the CRL with. r N) rL r rV rS rW �X509_CRL_set_issuer_namer[ rQ r� Z X509_CRL_sort� X509_CRL_signrz )rq r� Z issuer_keyr r r� rB rB rC r8 i s � zCRL.sign�d c C s t |t�std��t |t�s$td��t |t�s6td��|tu rFtd��t�|�}|tj krbt d��t� t� � �}t |tj k� t�� }t |tj k� t�|d� t�| j|� t�||d d d � t�| j|� t�| jt�|j�� t�| j|j|�} | �st� t|| �S ) a� Export the CRL as a string. :param X509 cert: The certificate used to sign the CRL. :param PKey key: The key used to sign the CRL. :param int type: The export format, either :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`, or :data:`FILETYPE_TEXT`. :param int days: The number of days until the next update of this CRL. :param bytes digest: The name of the message digest to use (eg ``b"sha256"``). :rtype: bytes � cert must be an X509 instancezkey must be a PKey instancer� zdigest must be providedr r � �< )r^ r& r` r r� � _UNSPECIFIEDrL r rS rW ra rQ rR rV Z ASN1_TIME_newr< ZX509_CRL_set_lastUpdater[ ZX509_CRL_set_nextUpdater� rQ r� r� rz r� r: ) rq r r� r� Zdaysr r rN Zsometimer rB rB rC �export� s4 �z CRL.exportN)r> r? r@ rA rr r� r� r r� r� rO r� rI r� r� r8 r r� r� rB rB rB rC r0 � s �r0 c @ s4 e Zd Zdd� Zdd� Zdd� Zdd� Zd d � Zd S ) r1 c C s t t�| j��S )zm Check if this NID_pkcs7_signed object :return: True if the PKCS7 is of type signed )�boolrL ZPKCS7_type_is_signed�_pkcs7rp rB rB rC �type_is_signed� s zPKCS7.type_is_signedc C s t t�| j��S )zt Check if this NID_pkcs7_enveloped object :returns: True if the PKCS7 is of type enveloped )r� rL ZPKCS7_type_is_envelopedr� rp rB rB rC �type_is_enveloped� s zPKCS7.type_is_envelopedc C s t t�| j��S )z� Check if this NID_pkcs7_signedAndEnveloped object :returns: True if the PKCS7 is of type signedAndEnveloped )r� rL Z PKCS7_type_is_signedAndEnvelopedr� rp rB rB rC �type_is_signedAndEnveloped� s z PKCS7.type_is_signedAndEnvelopedc C s t t�| j��S )zi Check if this NID_pkcs7_data object :return: True if the PKCS7 is of type data )r� rL ZPKCS7_type_is_datar� rp rB rB rC � type_is_data� s zPKCS7.type_is_datac C s" t �| jj�}t �|�}t�|�S )zk Returns the type name of the PKCS7 structure :return: A string with the typename )rL r� r� r� r� rS rj )rq r� Z string_typerB rB rC � get_type_name� s zPKCS7.get_type_nameN)r> r? r@ r� r� r� r� r� rB rB rB rC r1 � s r1 c @ sb e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dd� Z dd� Z ddd�Z dS )r2 z A PKCS #12 archive. c C s d | _ d | _d | _d | _d S rK )rz rh �_cacerts� _friendlynamerp rB rB rC rr � s zPKCS12.__init__c C s | j S )z� Get the certificate in the PKCS #12 structure. :return: The certificate, or :py:const:`None` if there is none. :rtype: :py:class:`X509` or :py:const:`None` )rh rp rB rB rC �get_certificate� s zPKCS12.get_certificatec C s t |t�std��|| _dS )z� Set the certificate in the PKCS #12 structure. :param cert: The new certificate, or :py:const:`None` to unset it. :type cert: :py:class:`X509` or :py:const:`None` :return: ``None`` r� N)r^ r& r` rh )rq r rB rB rC �set_certificate� s zPKCS12.set_certificatec C s | j S )z� Get the private key in the PKCS #12 structure. :return: The private key, or :py:const:`None` if there is none. :rtype: :py:class:`PKey` )rz rp rB rB rC �get_privatekey s zPKCS12.get_privatekeyc C s t |t�std��|| _dS )z� Set the certificate portion of the PKCS #12 structure. :param pkey: The new private key, or :py:const:`None` to unset it. :type pkey: :py:class:`PKey` or :py:const:`None` :return: ``None`` r N)r^ r r` rz r| rB rB rC �set_privatekey s zPKCS12.set_privatekeyc C s | j durt| j �S dS )a Get the CA certificates in the PKCS #12 structure. :return: A tuple with the CA certificates in the chain, or :py:const:`None` if there are none. :rtype: :py:class:`tuple` of :py:class:`X509` or :py:const:`None` N)r� r� rp rB rB rC �get_ca_certificates s zPKCS12.get_ca_certificatesc C s> |du rd| _ n*t|�}|D ]}t|t�s td��q || _ dS )a Replace or set the CA certificates within the PKCS12 object. :param cacerts: The new CA certificates, or :py:const:`None` to unset them. :type cacerts: An iterable of :py:class:`X509` or :py:const:`None` :return: ``None`` Nz)iterable must only contain X509 instances)r� �listr^ r& r` )rq �cacertsr rB rB rC �set_ca_certificates( s �zPKCS12.set_ca_certificatesc C s2 |du rd| _ nt|t�s(td|f ��|| _ dS )z� Set the friendly name in the PKCS #12 structure. :param name: The new friendly name, or :py:const:`None` to unset. :type name: :py:class:`bytes` or :py:const:`None` :return: ``None`` Nz+name must be a byte string or None (not %r))r� r^ r_ r` rt rB rB rC �set_friendlyname= s �zPKCS12.set_friendlynamec C s | j S )z� Get the friendly name in the PKCS# 12 structure. :returns: The friendly name, or :py:const:`None` if there is none. :rtype: :py:class:`bytes` or :py:const:`None` )r� rp rB rB rC �get_friendlynameN s zPKCS12.get_friendlynameN� r� c C s� t d|�}| jdu r tj}n0t�� }t�|tj�}| jD ]}t�||j � q8|du rZtj}| j }|du rntj}| j du r�tj}n| j j }| j du r�tj}n| j j }t� |||||tjtj||d� }|tjkr�t� t�|tj�}t� } t�| |� t| �S )a� Dump a PKCS12 object as a string. For more information, see the :c:func:`PKCS12_create` man page. :param passphrase: The passphrase used to encrypt the structure. Unlike some other passphrase arguments, this *must* be a string, not a callback. :type passphrase: :py:data:`bytes` :param iter: Number of times to repeat the encryption step. :type iter: :py:data:`int` :param maciter: Number of times to repeat the MAC step. :type maciter: :py:data:`int` :return: The string representation of the PKCS #12 structure. :rtype: r� Nr )�_text_to_bytes_and_warnr� rS rW rL rr rX ro rs r� r� rz rh Z PKCS12_createZ&NID_pbe_WithSHA1And3_Key_TripleDES_CBCr� � PKCS12_freer[ Zi2d_PKCS12_bior] ) rq r� �iterZmaciterr� r � friendlynamer} �pkcs12rN rB rB rC r� W sH � z PKCS12.export)Nr� r� )r> r? r@ rA rr r� r� r� r� r� r� r� r� r� rB rB rB rC r2 � s r2 c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )r3 z! A Netscape SPKI object. c C s t �� }t�|t j�| _d S rK )rL ZNETSCAPE_SPKI_newrS rX ZNETSCAPE_SPKI_free�_spki)rq ZspkirB rB rC rr � s zNetscapeSPKI.__init__c C s^ |j rtd��|js td��t�t|��}|tjkr<td��t�| j |j |�}t |dk� dS )a Sign the certificate request with this key and digest type. :param pkey: The private key to sign with. :type pkey: :py:class:`PKey` :param digest: The message digest to use. :type digest: :py:class:`bytes` :return: ``None`` r r r r N) r� ra r{ rL r r� rS rW ZNETSCAPE_SPKI_signr� rz rV r rB rB rC r8 � s �zNetscapeSPKI.signc C s" t �| j|j�}|dkr t� dS )aY Verifies a signature on a certificate request. :param PKey key: The public key that signature is supposedly from. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid, or there was a problem verifying the signature. r T)rL ZNETSCAPE_SPKI_verifyr� rz r� )rq r� ZanswerrB rB rC r9 � s zNetscapeSPKI.verifyc C s$ t �| j�}t�|�}t �|� |S )z� Generate a base64 encoded representation of this SPKI object. :return: The base64 encoded string. :rtype: :py:class:`bytes` )rL ZNETSCAPE_SPKI_b64_encoder� rS rj r� )rq Zencodedr� rB rB rC � b64_encode� s zNetscapeSPKI.b64_encodec C sD t �t �}t�| j�|_t|jtjk� t� |jtj �|_d|_ |S )z| Get the public key of this certificate. :return: The public key. :rtype: :py:class:`PKey` T) r r rL ZNETSCAPE_SPKI_get_pubkeyr� rz rV rS rW rX ry r� r| rB rB rC r � s zNetscapeSPKI.get_pubkeyc C s t �| j|j�}t|dk� dS )zv Set the public key of the certificate :param pkey: The public key :return: ``None`` r� N)rL ZNETSCAPE_SPKI_set_pubkeyr� rz rV r rB rB rC r � s zNetscapeSPKI.set_pubkeyN) r> r? r@ rA rr r8 r9 r� r r rB rB rB rC r3 � s r3 c @ sB e Zd Zd dd�Zedd� �Zedd� �Zefdd �Zd d � Z d S )r� Fc C s4 |t kr|d urtd��|| _|| _|| _g | _d S )Nz0only FILETYPE_PEM key format supports encryption)r ra � _passphrase� _more_args� _truncate� _problems)rq r� r� Z more_args�truncaterB rB rC rr � s �z_PassphraseHelper.__init__c C s@ | j d u rtjS t| j t�s&t| j �r4t�d| j�S td��d S )NZpem_password_cb�2Last argument must be a byte string or a callable.) r� rS rW r^ r_ �callabler� �_read_passphraser` rp rB rB rC r� s �z_PassphraseHelper.callbackc C s8 | j d u rtjS t| j t�s&t| j �r,tjS td��d S )Nr� )r� rS rW r^ r_ r� r` rp rB rB rC r� s �z _PassphraseHelper.callback_argsc C s6 | j r2z t|� W n |y$ Y n0 | j �d��d S r� )r� �_exception_from_error_queue�pop)rq Z exceptionTyperB rB rC r� s z"_PassphraseHelper.raise_if_problemc C s� z�t | j�r.| jr"| �|||�}q4| �|�}n| j}t|t�sFtd��t|�|krn| jrf|d |� }ntd��tt|��D ]}|||d � ||< qzt|�W S t y� } z| j � |� W Y d }~dS d }~0 0 d S )NzBytes expectedz+passphrase returned by callback is too longr� r ) r� r� r� r^ r_ ra rU r� r� � Exceptionr� rs )rq �buf�sizeZrwflagZuserdatar� r� �erB rB rC r� ! s( � z"_PassphraseHelper._read_passphraseN)FF) r> r? r@ rr r� r� r� r r� r� rB rB rB rC r� � s r� c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_d|_|S )a< Load a public key from a buffer. :param type: The file type (one of :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`). :param buffer: The buffer the key is stored in. :type buffer: A Python string object, either unicode or bytestring. :return: The PKey object. :rtype: :class:`PKey` r� r T)r^ r� r� r[ r rL ZPEM_read_bio_PUBKEYrS rW r Zd2i_PUBKEY_biora r� r r rX ry rz r� )r� rY rN �evp_pkeyr} rB rB rC r4 ; s � r4 c C s� t |t�r|�d�}t|�}t| |�}| tkrNt�|tj |j |j �}|� � n | t krft�|tj �}ntd��|tj kr~t� t�t�}t�|tj�|_|S )a� Load a private key (PKey) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the key is stored in :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The PKey object r� r )r^ r� r� r[ r� r rL ZPEM_read_bio_PrivateKeyrS rW r� r� r� r Zd2i_PrivateKey_biora r� r r rX ry rz )r� rY r� rN r� r� r} rB rB rC r5 ] s" � r5 c C sn t � }| tkr t�||j�}n<| tkr6t�||j�}n$| tkrRt�||jdd�}nt d��t |dk� t |�S )a Dump the certificate request *req* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param req: The certificate request to dump :return: The buffer with the dumped certificate request in r r� ) r[ r rL ZPEM_write_bio_X509_REQr� r Zi2d_X509_REQ_bior ZX509_REQ_print_exra rV r] )r� r� rN r� rB rB rC r6 � s � r6 c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��t |tjk� t �t �}t�|tj�|_|S )a Load a certificate request (X509Req) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the certificate request is stored in :return: The X509Req object r� r )r^ r� r� r[ r rL ZPEM_read_bio_X509_REQrS rW r Zd2i_X509_REQ_biora rV r% r rX r� r� )r� rY rN r� Zx509reqrB rB rC r7 � s r7 c C s� t d|�}t�t|��}|tjkr*td��t�� }t�|tj �}t� ||� t� ||t |�� t� | j�}t|dk� t�d|�}t�d�}t�|||| j�}t|dk� t�||d �dd� S )z� Sign a data string using the given key and message digest. :param pkey: PKey to sign with :param data: data to be signed :param digest: message digest to use :return: signature .. versionadded:: 0.11 rZ r r r& zunsigned int *r� N)r� rL r r� rS rW ra �Cryptography_EVP_MD_CTX_newrX � Cryptography_EVP_MD_CTX_freeZ EVP_SignInitZEVP_SignUpdaterU Z EVP_PKEY_sizerz rV rT Z EVP_SignFinalrY ) r} rZ r r �md_ctxr� Zsignature_bufferZsignature_lengthZ final_resultrB rB rC r8 � s" � r8 c C s� t d|�}t�t|��}|tjkr*td��t�| j�}t |tjk� t� |tj �}t� � }t� |tj �}t�||� t�||t|�� t�||t|�|�}|dkr�t� dS )a� Verify the signature for a data string. :param cert: signing certificate (X509 object) corresponding to the private key which generated the signature. :param signature: signature returned by sign function :param data: data to be verified :param digest: message digest to use :return: ``None`` if the signature is correct, raise exception otherwise. .. versionadded:: 0.11 rZ r r� N)r� rL r r� rS rW ra r# r� rV rX ry r� r� ZEVP_VerifyInitZEVP_VerifyUpdaterU ZEVP_VerifyFinalr� )r Z signaturerZ r r r} r� Z verify_resultrB rB rC r9 � s �r9 c C sj t � }| tkr t�||j�}n8| tkr6t�||j�}n | tkrNt�||j�}nt d��t |dk� t |�S )a Dump a certificate revocation list to a buffer. :param type: The file type (one of ``FILETYPE_PEM``, ``FILETYPE_ASN1``, or ``FILETYPE_TEXT``). :param CRL crl: The CRL to dump. :return: The buffer with the CRL. :rtype: bytes r� r� ) r[ r rL ZPEM_write_bio_X509_CRLr[ r Zi2d_X509_CRL_bior ZX509_CRL_printra rV r] )r� r] rN ru rB rB rC r: s � r: c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_|S )a Load Certificate Revocation List (CRL) data from a string *buffer*. *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the CRL is stored in :return: The PKey object r� r )r^ r� r� r[ r rL ZPEM_read_bio_X509_CRLrS rW r Zd2i_X509_CRL_biora r� r0 r rX r� r[ )r� rY rN r] r� rB rB rC r; s r; c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_|S )z� Load pkcs7 data from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM or FILETYPE_ASN1) :param buffer: The buffer with the pkcs7 data. :return: The PKCS7 object r� r )r^ r� r� r[ r rL ZPEM_read_bio_PKCS7rS rW r Z d2i_PKCS7_biora r� r1 r rX Z PKCS7_freer� )r� rY rN Zpkcs7Zpypkcs7rB rB rC r< < s r< zSPKCS#7 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.c C s� t d|�}t| t�r | �d�} t| �}|s0tj}t�|tj�}|tjkrNt � t� |tj �}t� d�}t� d�}t� d�}t� |||||�}|s�t � t� |d tj�}z t � W n ty� Y n0 |d tjkr�d}n t�t�}t� |d tj�|_|d tjk�rd} d} nPt�|d �} t� d�} t�|d | �} t�| | d �dd� } | tjk�rbd} g } tt�|��D ]&}t�||�}t�|�}| �|� �qt| �s�d} t �t �}||_| |_ | |_ | |_ |S ) a� Load pkcs12 data from the string *buffer*. If the pkcs12 structure is encrypted, a *passphrase* must be included. The MAC is always checked and thus required. See also the man page for the C function :py:func:`PKCS12_parse`. :param buffer: The buffer the certificate is stored in :param passphrase: (Optional) The password to decrypt the PKCS12 lump :returns: The PKCS12 object r� r� z EVP_PKEY**zX509**z Cryptography_STACK_OF_X509**r Nzint*) r� r^ r� r� r[ rS rW rL Zd2i_PKCS12_bior� rX r� rT Z PKCS12_parsero r r r ry rz r& r ZX509_alias_get0rY r� rm rn rs r2 rh r� r� )rY r� rN Zp12r} r r� Z parse_resultZpykeyrx r� Zfriendlyname_lengthZfriendlyname_bufferZ pycacertsr� r Zpycacertr� rB rB rC r= d sj ��� r= zTPKCS#12 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.s utf8only)N)NN)N)N)mra rB �base64r � functoolsr �operatorr r r r r r Zsixr r- r r� r r� Z cryptographyr r Z)cryptography.hazmat.primitives.asymmetricr r Z OpenSSL._utilr rS r rL r r� r r� r r� r rc r r� r r� r Z _make_assert�__all__ZSSL_FILETYPE_PEMr ZSSL_FILETYPE_ASN1r r r� r Z EVP_PKEY_DSAr Z EVP_PKEY_DHZTYPE_DHZ EVP_PKEY_ECZTYPE_ECr� r r� rV rF rI r[ r] re rm �objectrn r r� r! r" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 r1 r2 r3 r� r4 r5 r6 r7 r8 r9 r: r; r< Z deprecatedr> �DeprecationWarningr= ZOpenSSL_add_all_algorithmsZSSL_load_error_stringsZ ASN1_STRING_set_default_mask_ascrB rB rB rC �<module> s� , ' ) 4i I U ^ 6 @ . _, 6ZF" % #$ � W� __pycache__/SSL.cpython-39.opt-1.pyc 0000644 00000225222 15025013455 0013012 0 ustar 00 a �Sa�V � @ sT 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$ d d l%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ g d �Z,ze-Z.W n" e/y� G d d � d e0�Z.Y n0 ej1Z1ej2Z2ej3Z3ej4Z4ej5Z5ej6Z6ej7Z8ej9Z:d Z;dZ<dZ=dZ>dZ?dZ@dZAdZBdZCz"ejDZDejEZEejFZFejGZGejHZHW n( eI�y� dZDdZEdZFdZGdZHY n0 ejJZKejLZMejNZOejPZQejRZSz ejTZUW n eI�y� Y n0 ejVZWejXZYejZZ[ej\Z]ej^Z_ej`ZaejbZcejdZeejfZgejhZiejjZkejlZmejnZoejpZqejrZsejtZuejvZwejxZyejzZ{ej|Z}ej~Zej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�g d�Z�d gZ�d Z�d Z�G d d � d e��Z�eee��Z�e e��Z�G d!d"� 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*e��Z�G d+d,� d,e0�Z�G d-d.� d.e��Z�e0� Z�G d/d0� d0e��Z�G d1d2� d2e��Z�G d3d4� d4e��Z�d5d6� Z�d7d8� Z�d9d:� Z�e�ej�d;�Z�e�e�ed<d�d=�Z�G d>d?� d?e0�Z�G d@dA� dAe0�Z�G dBdC� dCe0�Z�e�͡ dS )D� N)�platform)�wraps�partial)�count�chain)�WeakValueDictionary)� errorcode)� integer_types�int2byte� indexbytes) � UNSPECIFIED�exception_from_error_queue�ffi�lib� make_assert�native� path_string�text_to_bytes_and_warn�no_zero_allocator)� FILETYPE_PEM�_PassphraseHelper�PKey�X509Name�X509� X509Store)\�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� TLS_METHOD�TLS_SERVER_METHOD�TLS_CLIENT_METHOD� SSL3_VERSION� TLS1_VERSION�TLS1_1_VERSION�TLS1_2_VERSION�TLS1_3_VERSION� 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�NO_OVERLAPPING_PROTOCOLS�SSLeay_version�Session�Context� Connectionc @ s e Zd ZdS )�_bufferN��__name__� __module__� __qualname__� r| r| �//usr/lib/python3.9/site-packages/OpenSSL/SSL.pyrw � s rw � � � � � � � � � i i i i i )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 )rl z4 An error occurred in an `OpenSSL.SSL` API. N�ry rz r{ �__doc__r| r| r| r} rl s rl c @ s e Zd ZdS )rm Nrx r| r| r| r} rm s rm c @ s e Zd ZdS )rn Nrx r| r| r| r} rn s rn c @ s e Zd ZdS )ro Nrx r| r| r| r} ro s ro c @ s e Zd ZdS )rp Nrx r| r| r| r} rp s rp c @ s e Zd ZdS )rq Nrx r| r| r| r} rq " s rq 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��selfr| r| r} �__init__2 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_errorrl �popr� r| r| r} �raise_if_problem5 s z)_CallbackExceptionHelper.raise_if_problemN)ry rz r{ r� r� r� r| r| r| r} 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 r~ )�_libZ X509_STORE_CTX_get_current_cert� X509_up_refr �_from_raw_x509_ptrZX509_STORE_CTX_get_errorZ X509_STORE_CTX_get_error_depthZ"SSL_get_ex_data_X509_STORE_CTX_idxZX509_STORE_CTX_get_ex_datarv �_reverse_mapping� Exceptionr� �appendZX509_STORE_CTX_set_errorZ X509_V_OK) �okZ store_ctxZx509�certZ error_numberZ error_depth�index�sslZ connection�result�e��callbackr� r| r} �wrapperK s& � z'_VerifyHelper.__init__.<locals>.wrapperz int (*)(int, X509_STORE_CTX *)�r� r� r �_ffir� �r� r� r� r| r� r} r� H s �z_VerifyHelper.__init__N�ry rz r{ r� r� r| r| r| r} r� B 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 r~ T� Fz^ALPN callback must return a bytestring or the special NO_OVERLAPPING_PROTOCOLS sentinel value.zunsigned char *�unsigned char[])rv r� r� �bufferr r� rr � isinstance�bytes� TypeError�new�len�_alpn_select_callback_argsr� ZSSL_TLSEXT_ERR_NOACKZSSL_TLSEXT_ERR_OKr� r� ZSSL_TLSEXT_ERR_ALERT_FATAL)r� �outZoutlenZin_Zinlen�arg�connZinstrZ protolistZ encoded_len�protoZoutbytesZ any_acceptedr� r� r| r} r� u s: � � z+_ALPNSelectHelper.__init__.<locals>.wrapperz^int (*)(SSL *, unsigned char **, unsigned char *, const unsigned char *, unsigned int, void *)r� r� r| r� r} r� r s +�z_ALPNSelectHelper.__init__Nr� r| r| r| r} r� m 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.r� r r )rv r� r� �NULL� from_handler� r� r� r� r� ZOPENSSL_mallocr� Z SSL_set_tlsext_status_ocsp_respr� r� r� )r� �cdatar� �data� ocsp_dataZocsp_data_lengthZdata_ptrr� r� r| r} r� � s( � z3_OCSPServerCallbackHelper.__init__.<locals>.wrapper�int (*)(SSL *, void *)r� r� r| r� r} r� � s &z"_OCSPServerCallbackHelper.__init__Nr� r| r| r| r} 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� ���)rv r� r� r� r� r� r� Z SSL_get_tlsext_status_ocsp_respr� �int�boolr� r� r� ) r� r� r� r� Zocsp_ptrZocsp_lenr� Zvalidr� r� r| r} r� s z3_OCSPClientCallbackHelper.__init__.<locals>.wrapperr� r� r� r| r� r} r� s z"_OCSPClientCallbackHelper.__init__Nr� r| r| r| r} 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�methr| r| r} �_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� rs )�typer| r| r} rs < s rs 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)�errorr| r} �explodeS s z<_make_requires.<locals>._requires_decorator.<locals>.explode)r )�funcr� �r� �flagr| r} �_requires_decoratorP s z+_make_requires.<locals>._requires_decoratorr| )r� r� r� r| r� r} �_make_requiresE s r� zALPN not availableZCryptography_HAS_KEYLOGzKey logging not availablec @ s e Zd ZdZdS )rt 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� r| r| r| r} rt h s rt c @ s� e Zd ZdZededededede de de d e d i Z ed d � e �� D ��Z d d� Zdd� Zdd� Zdjdd�Zdd� Zdkdd�Zdd� Zd d � Zd d � Zd d!� Zefd"d#�Zd$d%� Z d&d'� Z d(d)� Z e fd*d+�Z d,d-� Z!d.d/� Z"d0d1� Z#d2d3� Z$d4d5� Z%d6d7� Z&dld8d9�Z'd:d;� Z(d<d=� Z)d>d?� Z*d@dA� Z+dBdC� Z,dDdE� Z-dFdG� Z.dHdI� Z/dJdK� Z0dLdM� Z1dNdO� Z2e3dPdQ� �Z4dRdS� Z5dTdU� Z6dVdW� Z7dXdY� Z8dZd[� Z9d\d]� Z:d^d_� Z;e<d`da� �Z=e<dbdc� �Z>ddde� Z?dmdfdg�Z@dndhdi�ZAdS )oru a- :class:`OpenSSL.SSL.Context` instances define the parameters for setting up new SSL connections. :param method: One of TLS_METHOD, TLS_CLIENT_METHOD, or TLS_SERVER_METHOD. SSLv23_METHOD, TLSv1_METHOD, etc. are deprecated and should not be used. Z SSLv2_methodZ SSLv3_methodZ SSLv23_methodZ TLSv1_methodZTLSv1_1_methodZTLSv1_2_methodZ TLS_methodZTLS_server_methodZTLS_client_methodc c s0 | ](\}}t t|d �d ur|t t|�fV qd S r� )r� r� )�.0Z identifier�namer| r| r} � <genexpr>� 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 protocolr~ ) r� r r� �_methods�KeyErrorr� �_openssl_assertr� r� r� Z SSL_CTX_new�gcZ SSL_CTX_freeZSSL_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_modeZ SSL_MODE_ENABLE_PARTIAL_WRITE)r� �methodZ method_funcZ method_obj�context�resr| r| r} r� � s: zContext.__init__c C s t t�| j|�dk� dS )aD Set the minimum supported protocol version. Setting the minimum version to 0 will enable protocol versions down to the lowest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. r~ N)r� r� Z SSL_CTX_set_min_proto_versionr� �r� �versionr| r| r} �set_min_proto_version� s �z Context.set_min_proto_versionc C s t t�| j|�dk� dS )aC Set the maximum supported protocol version. Setting the maximum version to 0 will enable protocol versions up to the highest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. r~ N)r� r� Z SSL_CTX_set_max_proto_versionr� r� r| r| r} �set_max_proto_version� s �z Context.set_max_proto_versionNc 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� Z SSL_CTX_load_verify_locationsr� r� )r� �cafile�capathZ load_resultr| r| r} �load_verify_locations� s �z Context.load_verify_locationsc s& t � �� �fdd��}tt|ddd�S )Nc s � | |�j �S r� )r� )�sizeZverify�userdatar� r| r} r� � s z'Context._wrap_callback.<locals>.wrapperT)Z more_args�truncate)r r r r� r| r� r} �_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� Z SSL_CTX_set_default_passwd_cbr� r� )r� r� r� r| r| r} � 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 r~ �asciiN)r� Z SSL_CTX_set_default_verify_pathsr� r� r� r� Z X509_get_default_cert_dir_env�decodeZ X509_get_default_cert_file_env�_check_env_vars_setZX509_get_default_cert_dirZX509_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_filer| r| r} �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 r| r| r} r� G 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� r| r| r} r 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� Z"SSL_CTX_use_certificate_chain_filer� r� )r� �certfiler� r| r| r} �use_certificate_chain_filef 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� Z SSL_CTX_use_certificate_filer� r� )r� r �filetype� use_resultr| r| r} �use_certificate_filew 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� ZSSL_CTX_use_certificater� �_x509r� )r� r� r r| r| r} �use_certificate� 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� ZX509_dupr Z SSL_CTX_add_extra_chain_certr� Z X509_freer� )r� Zcertobj�copy� add_resultr| r| r} �add_extra_chain_cert� s z Context.add_extra_chain_certc C s | j d ur| j �t� t� d S r� )r� r� rl r� r� r| r| r} �_raise_passphrase_exception� 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� ZSSL_CTX_use_PrivateKey_filer� r )r� Zkeyfiler r r| r| r} �use_privatekey_file� 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� ZSSL_CTX_use_PrivateKeyr� Z_pkeyr )r� Zpkeyr r| r| r} �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� ZSSL_CTX_check_private_keyr� r� r� r| r| r} �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� ZSSL_load_client_CA_file�_text_to_bytes_and_warnr� r� r� �SSL_CTX_set_client_CA_listr� )r� r� Zca_listr| r| r} �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 �bufr~ N)r r� r� Z SSL_CTX_set_session_id_contextr� r� )r� r" r| r| r} �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� Z SSL_CTX_set_session_cache_moder� �r� �moder| r| r} �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� Z SSL_CTX_get_session_cache_moder� r� r| r| r} �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. r$ Nr� ) r� r r� r� r� r� ZSSL_CTX_set_verifyr� r� r� r� r� r� )r� r& r� r| r| r} � 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� ZSSL_CTX_set_verify_depthr� )r� �depthr| r| r} �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� ZSSL_CTX_get_verify_moder� r� r| r| r} �get_verify_modeM 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� ZSSL_CTX_get_verify_depthr� r� r| r| r} �get_verify_depthV 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 � rr~ N) r� r� Z BIO_new_filer� r� r� r� ZBIO_freeZPEM_read_bio_DHparamsZDH_freeZSSL_CTX_set_tmp_dhr� r� )r� Zdhfile�bioZdhr� r| r| r} � 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� ZSSL_CTX_set_tmp_ecdhr� Z _to_EC_KEY)r� Zcurver| r| r} � set_tmp_ecdht 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.r~ N)ZTLS_AES_256_GCM_SHA384Z TLS_CHACHA20_POLY1305_SHA256ZTLS_AES_128_GCM_SHA256)z SSL routines�SSL_CTX_set_cipher_listzno cipher match) r r� r� r� r� r� r3 r� rv �get_cipher_listrl )r� r2 Ztmpconnr| r| r} �set_cipher_list� 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� Zsk_X509_NAME_new_nullr� r� r� r� r r� r� ry � X509_NAME_dup�_nameZsk_X509_NAME_push�X509_NAME_freer� r� Zsk_X509_NAME_freer r� )r� Zcertificate_authoritiesZ name_stackZca_namer Z push_resultr| r| r} �set_client_ca_list� 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 instancer~ N)r� r r� r� ZSSL_CTX_add_client_CAr� r r� )r� Zcertificate_authorityr r| r| r} � 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� ZSSL_CTX_set_timeoutr� )r� �timeoutr| r| r} � 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� ZSSL_CTX_get_timeoutr� r� r| r| r} � 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� �rv r� )r� �whereZ return_code�r� r| r} r� s z*Context.set_info_callback.<locals>.wrapperz void (*)(const SSL *, int, int)N)r r� r� r� r� ZSSL_CTX_set_info_callbackr� r� r| r@ r} �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� rv r� )r� �liner@ r| r} r� s z,Context.set_keylog_callback.<locals>.wrapperz#void (*)(const SSL *, const char *)N)r r� r� r� r� ZSSL_CTX_set_keylog_callbackr� r� r| r@ r} �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� r| r| r} � 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 NrD �r� r� r| r| r} � 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� ZSSL_CTX_get_cert_storer� r� r� r �__new__Z_store)r� �storeZpystorer| r| r} �get_cert_store6 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� ZSSL_CTX_set_optionsr� )r� �optionsr| r| r} � set_optionsG 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. r$ )r� r r� r� ZSSL_CTX_set_moder� r% r| r| r} r� T 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 r> )r� Zalertr� r@ r| r} r� l s z7Context.set_tlsext_servername_callback.<locals>.wrapperz int (*)(SSL *, int *, void *)N)r r� r� r� r� Z&SSL_CTX_set_tlsext_servername_callbackr� r� r| r@ r} � set_tlsext_servername_callbacka 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� ZSSL_CTX_set_tlsext_use_srtpr� )r� Zprofilesr| r| r} �set_tlsext_use_srtpx s �zContext.set_tlsext_use_srtpc C sF d� t�dd� |D ���}t�d|�}tt�| j|t |��dk� 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� �pr| r| r} r� � r� z*Context.set_alpn_protos.<locals>.<genexpr>r� r N) �joinr � from_iterabler� r� r� r� ZSSL_CTX_set_alpn_protosr� r� �r� ZprotosZprotostrZ input_strr| r| r} �set_alpn_protos� 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� ZSSL_CTX_set_alpn_select_cbr� r� r� )r� r� r| r| r} �set_alpn_select_callback� 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. Nr~ ) r� r� r� r� r� r� Z new_handler� Z SSL_CTX_set_tlsext_status_cbr� r� Z SSL_CTX_set_tlsext_status_arg)r� �helperr� �rcr| r| r} �_set_ocsp_callback� 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� rY �r� r� r� rW r| r| r} �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� rY rZ r| r| r} �set_ocsp_client_callback� s z Context.set_ocsp_client_callback)N)N)N)N)N)Bry rz r{ r� r# r$ r% r& r' r( r) r* r+ r� �dict�itemsr� r� r� r� r� r� r r� r r r r r r r r r r r r! r# r' r( r) r+ r, r- r0 r1 r5 r9 r: r< r= rA �_requires_keylogrC rE rG rJ rL r� rM rN �_requires_alpnrU rV rY r[ r\ r| r| r| r} ru t s~ � �( 0 # '# ru 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 )rv 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 instanceNr~ )r� ru r� r� ZSSL_newr� r� r� ZSSL_free�_sslZ SSL_set_modeZSSL_MODE_AUTO_RETRYr� r� r� r� r� �_socketZBIO_newZ BIO_s_mem� _into_sslr� r� � _from_sslZ SSL_set_bioZ SSL_set_fdr� )r� r� �socketr� r r| r| r} 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')rc �AttributeError� __class__ry r� �r� r� r| r| r} � __getattr__0 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� Z SSL_get_errorZSSL_ERROR_WANT_READrm ZSSL_ERROR_WANT_WRITErn ZSSL_ERROR_ZERO_RETURNrp ZSSL_ERROR_WANT_X509_LOOKUPro ZSSL_ERROR_SYSCALLZERR_peek_errorr r� Z getwinerror�errnorq r r r� ZSSL_ERROR_NONE)r� r� r� r� rl r| r| r} �_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� r| r| r} � get_contextb 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. ra N)r� ru r� r� ZSSL_set_SSL_CTXrb r� )r� r� r| r| r} � set_contexti 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� ZSSL_get_servernamerb ZTLSEXT_NAMETYPE_host_namer� r� r� ri r| r| r} �get_servernamev 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� ZSSL_set_tlsext_host_namerb ri r| r| r} �set_tlsext_host_name� 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� Z SSL_pendingrb r� r| r| r} �pending� s zConnection.pendingr c C sr t d|�}t�|��J}t|�dkr*td��t�| j|t|��}| �| j|� |W d � S 1 sd0 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 r" ��z,Cannot send more than 2**31-1 bytes at once.N) r r� � from_bufferr� r� r� � SSL_writerb rm )r� r" �flagsr� r� r| r| r} �send� s �zConnection.sendc C s� t d|�}t�|��^}t|�}d}|r`t�| j|| t|d��}| �| j|� ||7 }||8 }q"|W d � S 1 sx0 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 r" r rt N) r r� ru r� r� rv rb �minrm )r� r" rw r� Z left_to_sendZ total_sentr� r| r| r} �sendall� 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_allocatorrf �MSG_PEEKr� �SSL_peekrb �SSL_readrm r� r� )r� �bufsizrw r" r� r| r| r} �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� ry r| rf r} r� r~ rb r rm � memoryviewr� r� )r� r� �nbytesrw r" r� r| r| r} � 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� ZBIO_should_retryZBIO_should_readrm ZBIO_should_writern r� r� r� )r� r/ r� r| r| r} �_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 ) re r� r� r r| r� ZBIO_readr� r� r� )r� r� r" r� r| r| r} �bio_read$ s zConnection.bio_readc C sx t d|�}| jdu r td��t�|��>}t�| j|t|��}|dkrR| �| j|� |W d � S 1 sj0 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 r" Nr� r ) r rd r� r� ru r� Z BIO_writer� r� )r� r" r� r� r| r| r} � 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 r~ TF)�renegotiate_pendingr� r� ZSSL_renegotiaterb r� r| r| r} � renegotiateQ 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� ZSSL_do_handshakerb rm �r� r� r| r| r} � 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 r~ )r� ZSSL_renegotiate_pendingrb r� r| r| r} r� h 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� ZSSL_total_renegotiationsrb r� r| r| r} �total_renegotiationsr 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_staterb rc �connect)r� �addrr| r| r} r� { 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 )rc � connect_ex�set_connect_state)r� r� r� r| r| r} r� � 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`. )rc �acceptrv r� �set_accept_state)r� Zclientr� r� r| r| r} r� � 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 )re r� r� ZBIO_set_mem_eof_returnrd r� r| r| r} � bio_shutdown� 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� Z SSL_shutdownrb rm r� r| r| r} �shutdown� 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� ZSSL_get_cipher_listrb r� r� r� �_nativer� )r� Zciphers�ir� r| r| r} r4 � 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� ZSSL_get_client_CA_listrb r� r� �rangeZsk_X509_NAME_numZsk_X509_NAME_valuer6 r� r rH r� r8 r7 r� )r� Zca_namesr� r� r� r Zpynamer| r| r} �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� r| r| r} �makefile� s �zConnection.makefilec C s | j S )zr Retrieve application data as set by :meth:`set_app_data`. :return: The application data rD r� r| r| r} rE � s zConnection.get_app_datac C s || _ dS )zg Set application data :param data: The application data :return: None NrD rF r| r| r} rG 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� ZSSL_get_shutdownrb r� r| r| r} � 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� ZSSL_set_shutdownrb )r� �stater| r| r} � 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� ZSSL_state_string_longrb r� r| r| r} �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_sessionrb r� r� ZSSL_get_server_randomr� r| r� �r� �session�length�outpr| r| r} � 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� rb r� r� ZSSL_get_client_randomr� r| r� r� r| r| r} � client_random6 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� rb r� r� ZSSL_SESSION_get_master_keyr� r| r� r� r| r| r} � master_keyF 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 Nr~ ) r| r� r� r� r� ZSSL_export_keying_materialrb r� r� ) r� ZlabelZolenr� r� Z context_bufZ context_lenZ use_context�successr| r| r} �export_keying_materialV 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 )rc r� r� r| r| r} � sock_shutdownt 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� ZSSL_get_certificaterb r� r� r� r r� �r� r� r| r| r} �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� ZSSL_get_peer_certificaterb r� r� r r� r� r| r| r} �get_peer_certificate� 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. r~ ) r� r� Z sk_X509_numZ sk_X509_valuer� r� r� r� r r� r� )� cert_stackr� r� r� r� Zpycertr| r| r} �_cert_stack_to_list� 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� ZSSL_get_peer_cert_chainrb r� r� r� �r� r� r| r| r} �get_peer_cert_chain� 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� ZSSL_get0_verified_chainrb r� r� r� r� r| r| r} �get_verified_chain� 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� Z SSL_want_readrb r� r| r| r} � 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� ZSSL_want_writerb r� r| r| r} � 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� ZSSL_set_accept_staterb r� r| r| r} 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� rb r� r| r| r} 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� ZSSL_get1_sessionrb r� r� rt rH r� ZSSL_SESSION_free�_session)r� r� Z pysessionr| r| r} � 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 instancer~ N)r� rt r� r� ZSSL_set_sessionrb r� r� )r� r� r� r| r| r} � 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� rb r| r� )r� �function�emptyr� r" r| r| r} �_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� ZSSL_get_finishedr� r| r| r} � 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� ZSSL_get_peer_finishedr� r| r| r} �get_peer_finished6 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_cipherrb r� r� r� ZSSL_CIPHER_get_namer� )r� �cipherr� r| r| r} �get_cipher_nameB 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� r� rb r� r� ZSSL_CIPHER_get_bits)r� r� r| r| r} �get_cipher_bitsS 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 Nr� )r� r� rb r� r� r� ZSSL_CIPHER_get_versionr� )r� r� r� r| r| r} �get_cipher_versionc 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` r� )r� r� r� ZSSL_get_versionrb r� r� r| r| r} �get_protocol_version_namet 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� Z SSL_versionrb r� r| r| r} �get_protocol_version� s z Connection.get_protocol_versionc C sF d� t�dd� |D ���}t�d|�}tt�| j|t |��dk� 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� rO rP r| r| r} r� � r� z-Connection.set_alpn_protos.<locals>.<genexpr>r� r N) rR r rS r� r� r� r� ZSSL_set_alpn_protosrb r� rT r| r| r} rU � 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� ZSSL_get0_alpn_selectedrb r� )r� r� Zdata_lenr| r| r} �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`. r~ N)r� ZSSL_set_tlsext_status_typerb ZTLSEXT_STATUSTYPE_ocspr� )r� rX r| r| r} � request_ocsp� s �zConnection.request_ocsp)N)r )r )N)NN)N)Dry rz r{ r r� r� rj rm rn ro rp rr rs rx �writerz r� �readr� r� r� r� r� r� r� r� r� r� r� r� r� r4 r� r� rE rG r� r� r� r� r� r� r� r� r� r� � staticmethodr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r` rU r� r� r| r| r| r} rv � s� 6 % % " rv )�r rf �sysr � functoolsr r � itertoolsr r �weakrefr rl r Zsixr r r Z OpenSSL._utilr r r Z_exception_from_error_queuer r� r r� r Z _make_assertr r� r r� r r r r| ZOpenSSL.cryptor r r r r r �__all__r� rw � NameError�objectr r r r r r ZSSL_SENT_SHUTDOWNr! ZSSL_RECEIVED_SHUTDOWNr" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 rg ZSSL_OP_NO_SSLv2r1 ZSSL_OP_NO_SSLv3r2 ZSSL_OP_NO_TLSv1r3 ZSSL_OP_NO_TLSv1_1r4 ZSSL_OP_NO_TLSv1_2r5 ZSSL_OP_NO_TLSv1_3r6 ZSSL_MODE_RELEASE_BUFFERSr7 ZSSL_OP_SINGLE_DH_USEr8 ZSSL_OP_SINGLE_ECDH_USEr9 ZSSL_OP_EPHEMERAL_RSAr: Z SSL_OP_MICROSOFT_SESS_ID_BUGr; Z SSL_OP_NETSCAPE_CHALLENGE_BUGr< Z'SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUGr= Z"SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUGr> Z!SSL_OP_MICROSOFT_BIG_SSLV3_BUFFERr? Z SSL_OP_MSIE_SSLV2_RSA_PADDINGr@ Z SSL_OP_SSLEAY_080_CLIENT_DH_BUGrA ZSSL_OP_TLS_D5_BUGrB Z SSL_OP_TLS_BLOCK_PADDING_BUGrC Z"SSL_OP_DONT_INSERT_EMPTY_FRAGMENTSrD Z SSL_OP_CIPHER_SERVER_PREFERENCErE ZSSL_OP_TLS_ROLLBACK_BUGrF ZSSL_OP_PKCS1_CHECK_1rG ZSSL_OP_PKCS1_CHECK_2rH ZSSL_OP_NETSCAPE_CA_DN_BUGrI Z&SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUGrJ ZSSL_OP_NO_COMPRESSIONrK ZSSL_OP_NO_QUERY_MTUrL ZSSL_OP_COOKIE_EXCHANGErM ZSSL_OP_NO_TICKETrN Z SSL_OP_ALLrO ZSSL_VERIFY_PEERrP Z SSL_VERIFY_FAIL_IF_NO_PEER_CERTrQ ZSSL_VERIFY_CLIENT_ONCErR ZSSL_VERIFY_NONErS ZSSL_SESS_CACHE_OFFrT ZSSL_SESS_CACHE_CLIENTrU ZSSL_SESS_CACHE_SERVERrV ZSSL_SESS_CACHE_BOTHrW Z SSL_SESS_CACHE_NO_AUTO_CLEARrX Z!SSL_SESS_CACHE_NO_INTERNAL_LOOKUPrY Z SSL_SESS_CACHE_NO_INTERNAL_STORErZ ZSSL_SESS_CACHE_NO_INTERNALr[ r\ r] r^ r_ r` ra rb rc rd re rf rg rh ri rj rk r r r r r� rl r� r� rm rn ro rp rq r� r� rr r� r� r� r� rs r� ZCryptography_HAS_ALPNr` r� r_ rt ru rv ZSSL_library_initr| r| r| r} �<module> s2 , _ �� � (=C; � � Y __pycache__/rand.cpython-39.opt-1.pyc 0000644 00000002376 15025013455 0013300 0 ustar 00 a �Sa � @ s$ d Z ddlmZ dd� Zdd� ZdS )z* PRNG management routines, thin wrappers. � )�libc C s: t | t�std��t |t�s$td��t�| t| �|� dS )a� Mix bytes from *string* into the PRNG state. The *entropy* argument is (the lower bound of) an estimate of how much randomness is contained in *string*, measured in bytes. For more information, see e.g. :rfc:`1750`. This function is only relevant if you are forking Python processes and need to reseed the CSPRNG after fork. :param buffer: Buffer with random data. :param entropy: The entropy (in bytes) measurement of the buffer. :return: :obj:`None` z buffer must be a byte stringzentropy must be an integerN)� isinstance�bytes� TypeError�int�_libZRAND_add�len)�bufferZentropy� r �0/usr/lib/python3.9/site-packages/OpenSSL/rand.py�add s r c C s t �� S )z} Check whether the PRNG has been seeded with enough data. :return: 1 if the PRNG is seeded enough, 0 otherwise. )r Z RAND_statusr r r r �status" s r N)�__doc__Z OpenSSL._utilr r r r r r r r �<module> s __pycache__/rand.cpython-39.pyc 0000644 00000002376 15025013455 0012341 0 ustar 00 a �Sa � @ s$ d Z ddlmZ dd� Zdd� ZdS )z* PRNG management routines, thin wrappers. � )�libc C s: t | t�std��t |t�s$td��t�| t| �|� dS )a� Mix bytes from *string* into the PRNG state. The *entropy* argument is (the lower bound of) an estimate of how much randomness is contained in *string*, measured in bytes. For more information, see e.g. :rfc:`1750`. This function is only relevant if you are forking Python processes and need to reseed the CSPRNG after fork. :param buffer: Buffer with random data. :param entropy: The entropy (in bytes) measurement of the buffer. :return: :obj:`None` z buffer must be a byte stringzentropy must be an integerN)� isinstance�bytes� TypeError�int�_libZRAND_add�len)�bufferZentropy� r �0/usr/lib/python3.9/site-packages/OpenSSL/rand.py�add s r c C s t �� S )z} Check whether the PRNG has been seeded with enough data. :return: 1 if the PRNG is seeded enough, 0 otherwise. )r Z RAND_statusr r r r �status" s r N)�__doc__Z OpenSSL._utilr r r r r r r r �<module> s __pycache__/__init__.cpython-39.pyc 0000644 00000001032 15025013455 0013140 0 ustar 00 a �Sa� � @ sH d Z ddlmZmZ ddlmZmZmZmZm Z m Z m Z m Z g d�Z dS )z9 pyOpenSSL - A simple wrapper around the OpenSSL library � )�crypto�SSL)� __author__� __copyright__� __email__� __license__� __summary__� __title__�__uri__� __version__) r r r r r r r r r r N)�__doc__ZOpenSSLr r ZOpenSSL.versionr r r r r r r r �__all__� r r �4/usr/lib/python3.9/site-packages/OpenSSL/__init__.py�<module> s ( __pycache__/version.cpython-39.opt-1.pyc 0000644 00000001171 15025013455 0014031 0 ustar 00 a �Sa� � @ s6 d Z g d�ZdZdZdZdZdZdZdZd � e�Z d S ) z9 pyOpenSSL - A simple wrapper around the OpenSSL library )� __author__� __copyright__� __email__� __license__� __summary__� __title__�__uri__� __version__z21.0.0Z pyOpenSSLzhttps://pyopenssl.org/z0Python wrapper module around the OpenSSL libraryzThe pyOpenSSL developerszcryptography-dev@python.orgzApache License, Version 2.0zCopyright 2001-2020 {0}N) �__doc__�__all__r r r r r r r �formatr � r r �3/usr/lib/python3.9/site-packages/OpenSSL/version.py�<module> s __pycache__/debug.cpython-39.opt-1.pyc 0000644 00000002172 15025013455 0013434 0 ustar 00 a �Sa � @ s� d dl mZ d dlZd dlZd dlZd dlZd dlZddlm Z dj e j ej j �ej jj��d�ej�ejj��d�eedd�ej ej ejej ejejd � Zed kr�ee� dS ) � )�print_functionN� )�versionaA pyOpenSSL: {pyopenssl} cryptography: {cryptography} cffi: {cffi} cryptography's compiled against OpenSSL: {crypto_openssl_compile} cryptography's linked OpenSSL: {crypto_openssl_link} Python's OpenSSL: {python_openssl} Python executable: {python} Python version: {python_version} Platform: {platform} sys.path: {sys_path}�asciiZOPENSSL_VERSIONzn/a) Z pyopensslZcrypto_openssl_compileZcrypto_openssl_linkZpython_openssl� cryptography�cffiZpythonZpython_version�platformZsys_path�__main__) Z __future__r Zssl�sysZ OpenSSL.SSLZOpenSSLr r � r �format� __version__Z_utilZffi�string�libZOPENSSL_VERSION_TEXT�decodeZSSLZSSLeay_versionZSSLEAY_VERSION�getattr� executabler �pathZ _env_info�__name__�print� r r �1/usr/lib/python3.9/site-packages/OpenSSL/debug.py�<module> s8 ���� � __pycache__/debug.cpython-39.pyc 0000644 00000002172 15025013455 0012475 0 ustar 00 a �Sa � @ s� d dl mZ d dlZd dlZd dlZd dlZd dlZddlm Z dj e j ej j �ej jj��d�ej�ejj��d�eedd�ej ej ejej ejejd � Zed kr�ee� dS ) � )�print_functionN� )�versionaA pyOpenSSL: {pyopenssl} cryptography: {cryptography} cffi: {cffi} cryptography's compiled against OpenSSL: {crypto_openssl_compile} cryptography's linked OpenSSL: {crypto_openssl_link} Python's OpenSSL: {python_openssl} Python executable: {python} Python version: {python_version} Platform: {platform} sys.path: {sys_path}�asciiZOPENSSL_VERSIONzn/a) Z pyopensslZcrypto_openssl_compileZcrypto_openssl_linkZpython_openssl� cryptography�cffiZpythonZpython_version�platformZsys_path�__main__) Z __future__r Zssl�sysZ OpenSSL.SSLZOpenSSLr r � r �format� __version__Z_utilZffi�string�libZOPENSSL_VERSION_TEXT�decodeZSSLZSSLeay_versionZSSLEAY_VERSION�getattr� executabler �pathZ _env_info�__name__�print� r r �1/usr/lib/python3.9/site-packages/OpenSSL/debug.py�<module> s8 ���� � __pycache__/crypto.cpython-39.pyc 0000644 00000265636 15025013455 0012747 0 ustar 00 a �Saӛ � @ s d dl Z d dlZd dlmZ d dlmZ d dlmZmZm Z m Z m Z m Z d dl mZmZmZ d dlmZmZ d dlmZmZ d dlmZ m Z m Z m!Z"m#Z$m%Z&m'Z(m)Z*m+Z, g d �Z-e j.Z/e j0Z1d Z2e j3Z4e j5Z6e j7Z8e j9Z:G d d � d e;�Z<ee e<�Z=e,e<�Z>d d� Z?dd� Z@d^dd�ZAdd� ZBdd� ZCdd� ZDG dd� deE�ZFG dd � d eE�ZGG d d � d eE�ZHd d � ZId!d"� ZJG d#d$� d$eE�ZKG d%d&� d&eE�ZLG d'd(� d(eE�ZMG d)d*� d*eE�ZNG d+d,� d,eE�ZOG d-d.� d.eE�ZPG d/d0� d0e;�ZQG d1d2� d2eE�ZRd3d4� ZSd5d6� ZTd7d8� ZUd_d9d:�ZVG d;d<� d<eE�ZWG d=d>� d>eE�ZXG d?d@� d@eE�ZYG dAdB� dBeE�ZZG dCdD� dDeE�Z[G dEdF� dFeE�Z\dGdH� Z]d`dIdJ�Z^dKdL� Z_dMdN� Z`dOdP� ZadQdR� ZbdSdT� ZcdUdV� ZddWdX� Zee�feeegdYeh�ZedadZd[�Zie�feiegd\eh�Zie �j� e �k� e �ld]� dS )b� N)� b16encode)�partial)�__eq__�__ne__�__lt__�__le__�__gt__�__ge__)� integer_types� text_type�PY2)�utils�x509)�dsa�rsa) �ffi�lib�exception_from_error_queue� byte_string�native� path_string� UNSPECIFIED�text_to_bytes_and_warn� make_assert)$� FILETYPE_PEM� FILETYPE_ASN1� FILETYPE_TEXT�TYPE_RSA�TYPE_DSA�Error�PKey�get_elliptic_curves�get_elliptic_curve�X509Name� X509Extension�X509Req�X509�X509StoreFlags� X509Store�X509StoreContextError�X509StoreContext�load_certificate�dump_certificate�dump_publickey�dump_privatekey�Revoked�CRL�PKCS7�PKCS12� NetscapeSPKI�load_publickey�load_privatekey�dump_certificate_request�load_certificate_request�sign�verify�dump_crl�load_crl�load_pkcs7_data� load_pkcs12i�� c @ s e Zd ZdZdS )r z7 An error occurred in an `OpenSSL.crypto` API. N)�__name__� __module__� __qualname__�__doc__� rB rB �2/usr/lib/python3.9/site-packages/OpenSSL/crypto.pyr P s r c C s ddl m} | S )ap Importing the backend from cryptography has the side effect of activating the osrandom engine. This mutates the global state of OpenSSL in the process and causes issues for various programs that use subinterpreters or embed Python. By putting the import in this function we can avoid triggering this side effect unless _get_backend is called. r ��backend)Z,cryptography.hazmat.backends.openssl.backendrE rD rB rB rC � _get_backendZ s rF c C s t d| f ��dS )z� An OpenSSL API failed somehow. Additionally, the failure which was encountered isn't one that's exercised by the test suite so future behavior of pyOpenSSL is now somewhat less predictable. zUnknown %s failureN)� RuntimeError)�whererB rB rC �_untested_errorg s rI c C sd | du r t �t �� �}t j}n(t�d| �}t �|t| ��}|fdd�}t|tj k� t� ||�}|S )z� Allocate a new OpenSSL memory BIO. Arrange for the garbage collector to clean it up automatically. :param buffer: None or some bytes to use to put into the BIO so that they can be read out. N�char[]c S s t �| �S �N)�_lib�BIO_free)�bio�refrB rB rC �free� s z_new_mem_buf.<locals>.free) rL �BIO_new� BIO_s_memrM �_ffi�newZBIO_new_mem_buf�len�_openssl_assert�NULL�gc)�bufferrN rP �datarB rB rC � _new_mem_bufp s r[ c C s. t �d�}t�| |�}t �|d |�dd� S )zO Copy the contents of an OpenSSL BIO object into a Python byte string. zchar**r N)rS rT rL ZBIO_get_mem_datarY )rN � result_bufferZ buffer_lengthrB rB rC �_bio_to_string� s r] c C s2 t |t�std��t�| |�}|dkr.td��dS )a� The the time value of an ASN1 time object. @param boundary: An ASN1_TIME pointer (or an object safely castable to that type) which will have its value set. @param when: A string representation of the desired time value. @raise TypeError: If C{when} is not a L{bytes} string. @raise ValueError: If C{when} does not represent a time in the required format. @raise RuntimeError: If the time value cannot be set for some other (unspecified) reason. zwhen must be a byte stringr zInvalid stringN)� isinstance�bytes� TypeErrorrL ZASN1_TIME_set_string� ValueError)�boundary�when� set_resultrB rB rC �_set_asn1_time� s re c C s� t �d| �}t�|�dkr dS t�|�tjkr>t �t�|��S t �d�}t� | |� |d t j krlt d� n6t �d|d �}t�|�}t �|�}t� |d � |S dS )a] Retrieve the time value of an ASN1 time object. @param timestamp: An ASN1_GENERALIZEDTIME* (or an object safely castable to that type) from which the time value will be retrieved. @return: The time value from C{timestamp} as a L{bytes} string in a certain format. Or C{None} if the object contains no time value. � ASN1_STRING*r NzASN1_GENERALIZEDTIME**� ASN1_TIME_to_generalizedtime) rS �castrL �ASN1_STRING_lengthZASN1_STRING_typeZV_ASN1_GENERALIZEDTIME�string�ASN1_STRING_datarT rg rW rI ZASN1_GENERALIZEDTIME_free)Z timestampZstring_timestampZgeneralized_timestampZ string_data� string_resultrB rB rC �_get_asn1_time� s" � � rm c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )�_X509NameInvalidatorc C s g | _ d S rK )�_names��selfrB rB rC �__init__� s z _X509NameInvalidator.__init__c C s | j �|� d S rK )ro �append�rq �namerB rB rC �add� s z_X509NameInvalidator.addc C s | j D ]}|`qd S rK )ro �_namert rB rB rC �clear� s z_X509NameInvalidator.clearN)r> r? r@ rr rv rx rB rB rB rC rn � s rn c @ sT e Zd ZdZdZdZdd� Zdd� Zedd � �Z d d � Z d d � Z dd� Z dd� Z dS )r zD A class representing an DSA or RSA public key or key pair. FTc C s" t �� }t�|t j�| _d| _d S )NF)rL Z EVP_PKEY_newrS rX � EVP_PKEY_free�_pkey� _initialized�rq �pkeyrB rB rC rr � s z PKey.__init__c C sJ ddl m}m} t� }| jr0tt| �}|||�S tt| �}||d|�S dS )a Export as a ``cryptography`` key. :rtype: One of ``cryptography``'s `key interfaces`_. .. _key interfaces: https://cryptography.io/en/latest/hazmat/ primitives/asymmetric/rsa/#key-interfaces .. versionadded:: 16.1.0 r )�load_der_private_key�load_der_public_keyN)�,cryptography.hazmat.primitives.serializationr~ r rF � _only_publicr- r r. )rq r~ r rE �derrB rB rC �to_cryptography_key� s zPKey.to_cryptography_keyc C s� t |tjtjtjtjf�s"td��ddlm }m }m }m } t |tjtjf�rbt t|�|j|j��S |�|j|j|� �}tt|�S dS )z� Construct based on a ``cryptography`` *crypto_key*. :param crypto_key: A ``cryptography`` key. :type crypto_key: One of ``cryptography``'s `key interfaces`_. :rtype: PKey .. versionadded:: 16.1.0 zUnsupported key typer )�Encoding� NoEncryption� PrivateFormat� PublicFormatN)r^ r Z RSAPublicKeyZ RSAPrivateKeyr Z DSAPublicKeyZ DSAPrivateKeyr` r� r� r� r� r� r4 r � public_bytes�DERZSubjectPublicKeyInfoZ private_bytesZPKCS8r5 )�clsZ crypto_keyr� r� r� r� r� rB rB rC �from_cryptography_key s* �� �� �zPKey.from_cryptography_keyc C s6 t |t�std��t |t�s$td��|tkr�|dkr<td��t�� }t�|tj �}t� |tj � t� � }t� |||tj�}t|dk� t�| j|�}t|dk� n�|tk�r$t�� }t|tjk� t�|tj�}t�||tjdtjtjtj�}t|dk� tt�|�dk� tt�| j|�dk� ntd��d| _dS ) a3 Generate a key pair of the given type, with the given number of bits. This generates a key "into" the this object. :param type: The key type. :type type: :py:data:`TYPE_RSA` or :py:data:`TYPE_DSA` :param bits: The number of bits. :type bits: :py:data:`int` ``>= 0`` :raises TypeError: If :py:data:`type` or :py:data:`bits` isn't of the appropriate type. :raises ValueError: If the number of bits isn't an integer of the appropriate size. :return: ``None`` �type must be an integerzbits must be an integerr zInvalid number of bits� zNo such key typeTN)r^ �intr` r ra rL �BN_newrS rX �BN_freeZ BN_set_wordZRSA_F4ZRSA_newZRSA_generate_key_exrW rV ZEVP_PKEY_assign_RSArz r ZDSA_newZDSA_freeZDSA_generate_parameters_exZDSA_generate_keyZEVP_PKEY_set1_DSAr r{ )rq �type�bitsZexponentr �resultr �resrB rB rC � generate_key/ s6 � zPKey.generate_keyc C sd | j rtd��t�| �� �tjkr*td��t�| j�}t� |tj �}t� |�}|dkrZdS t � dS )ax Check the consistency of an RSA private key. This is the Python equivalent of OpenSSL's ``RSA_check_key``. :return: ``True`` if key is consistent. :raise OpenSSL.crypto.Error: if the key is inconsistent. :raise TypeError: if the key is of a type which cannot be checked. Only RSA keys can currently be checked. zpublic key onlyzkey type unsupportedr� TN) r� r` rL Z EVP_PKEY_typer� � EVP_PKEY_RSA�EVP_PKEY_get1_RSArz rS rX �RSA_freeZ RSA_check_key�_raise_current_error)rq r r� rB rB rC �checkg s z PKey.checkc C s t �| j�S )zT Returns the type of the key :return: The type of the key. )rL � EVP_PKEY_idrz rp rB rB rC r� � s z PKey.typec C s t �| j�S )zh Returns the number of bits of the key :return: The number of bits of the key. )rL Z EVP_PKEY_bitsrz rp rB rB rC r� � s z PKey.bitsN)r> r? r@ rA r� r{ rr r� � classmethodr� r� r� r� r� rB rB rB rC r � s *8r c sd e Zd ZdZdZes � fdd�Zedd� �Zedd� �Z ed d � �Z d d � Z d d� Z dd� Z � ZS )�_EllipticCurveaZ A representation of a supported elliptic curve. @cvar _curves: :py:obj:`None` until an attempt is made to load the curves. Thereafter, a :py:type:`set` containing :py:type:`_EllipticCurve` instances each of which represents one curve supported by the system. @type _curves: :py:type:`NoneType` or :py:type:`set` Nc s t |t�rtt| ��|�S tS )z� Implement cooperation with the right-hand side argument of ``!=``. Python 3 seems to have dropped this cooperation in this very narrow circumstance. )r^ r� �superr �NotImplemented)rq �other�� __class__rB rC r � s z_EllipticCurve.__ne__c s> �� tjd�}t�d|�}�� ||� t� �fdd�|D ��S )z� Get the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. r zEC_builtin_curve[]c 3 s | ]}� � �|j�V qd S rK )�from_nid�nid)�.0�c�r� r rB rC � <genexpr>� � z7_EllipticCurve._load_elliptic_curves.<locals>.<genexpr>)ZEC_get_builtin_curvesrS rW rT �set)r� r Z num_curvesZbuiltin_curvesrB r� rC �_load_elliptic_curves� s z$_EllipticCurve._load_elliptic_curvesc C s | j du r| �|�| _ | j S )a Get, cache, and return the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. N)�_curvesr� r� rB rB rC �_get_elliptic_curves� s z#_EllipticCurve._get_elliptic_curvesc C s | ||t �|�|���d��S )a� Instantiate a new :py:class:`_EllipticCurve` associated with the given OpenSSL NID. :param lib: The OpenSSL library binding object. :param nid: The OpenSSL NID the resulting curve object will represent. This must be a curve NID (and not, for example, a hash NID) or subsequent operations will fail in unpredictable ways. :type nid: :py:class:`int` :return: The curve object. �ascii)rS rj � OBJ_nid2sn�decode)r� r r� rB rB rC r� � s z_EllipticCurve.from_nidc C s || _ || _|| _dS )a� :param _lib: The :py:mod:`cryptography` binding instance used to interface with OpenSSL. :param _nid: The OpenSSL NID identifying the curve this object represents. :type _nid: :py:class:`int` :param name: The OpenSSL short name identifying the curve this object represents. :type name: :py:class:`unicode` N)rL �_nidru )rq r r� ru rB rB rC rr � s z_EllipticCurve.__init__c C s d| j f S )Nz <Curve %r>)ru rp rB rB rC �__repr__� s z_EllipticCurve.__repr__c C s | j �| j�}t�|t j�S )z� Create a new OpenSSL EC_KEY structure initialized to use this curve. The structure is automatically garbage collected when the Python object is garbage collected. )rL ZEC_KEY_new_by_curve_namer� rS rX Z EC_KEY_free)rq �keyrB rB rC � _to_EC_KEY� s z_EllipticCurve._to_EC_KEY)r> r? r@ rA r� �_PY2r r� r� r� r� rr r� r� � __classcell__rB rB r� rC r� � s r� c C s t �t�S )a� Return a set of objects representing the elliptic curves supported in the OpenSSL build in use. The curve objects have a :py:class:`unicode` ``name`` attribute by which they identify themselves. The curve objects are useful as values for the argument accepted by :py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be used for ECDHE key exchange. )r� r� rL rB rB rB rC r! � s r! c C s, t � D ]}|j| kr| S qtd| ��dS )aT Return a single curve object selected by name. See :py:func:`get_elliptic_curves` for information about curve objects. :param name: The OpenSSL short name identifying the curve object to retrieve. :type name: :py:class:`unicode` If the named curve is not supported then :py:class:`ValueError` is raised. zunknown curve nameN)r! ru ra )ru ZcurverB rB rC r" s r" c s� e Zd ZdZdd� Z� fdd�Z� fdd�Zdd � Zee�Zee �Z ee �Z ee �Z ee �Z ee �Z d d � Zd d � Zdd� Zdd� Z� ZS )r# a An X.509 Distinguished Name. :ivar countryName: The country of the entity. :ivar C: Alias for :py:attr:`countryName`. :ivar stateOrProvinceName: The state or province of the entity. :ivar ST: Alias for :py:attr:`stateOrProvinceName`. :ivar localityName: The locality of the entity. :ivar L: Alias for :py:attr:`localityName`. :ivar organizationName: The organization name of the entity. :ivar O: Alias for :py:attr:`organizationName`. :ivar organizationalUnitName: The organizational unit of the entity. :ivar OU: Alias for :py:attr:`organizationalUnitName` :ivar commonName: The common name of the entity. :ivar CN: Alias for :py:attr:`commonName`. :ivar emailAddress: The e-mail address of the entity. c C s t �|j�}t�|t j�| _dS )z� Create a new X509Name, copying the given X509Name instance. :param name: The name to copy. :type name: :py:class:`X509Name` N)rL � X509_NAME_duprw rS rX �X509_NAME_freert rB rB rC rr 5 s zX509Name.__init__c s |� d�r tt| ��||�S t|�tur<tdt|�jf ��t� t |��}|tj krzz t � W n t yp Y n0 td��tt�| j��D ]J}t�| j|�}t�|�}t�|�}||kr�t�| j|�}t�|� q�q�t|t�r�|�d�}t�| j|tj|ddd�}|�st � d S )N�_z+attribute name must be string, not '%.200s'zNo such attribute�utf-8���r ) � startswithr� r# � __setattr__r� �strr` r> rL � OBJ_txt2nid� _byte_string� NID_undefr� r �AttributeError�range�X509_NAME_entry_countrw �X509_NAME_get_entry�X509_NAME_ENTRY_get_object� OBJ_obj2nidZX509_NAME_delete_entryZX509_NAME_ENTRY_freer^ � _text_type�encodeZX509_NAME_add_entry_by_NIDZ MBSTRING_UTF8) rq ru �valuer� �i�entZent_objZent_nid� add_resultr� rB rC r� ? s< �� �zX509Name.__setattr__c s� t �t|��}|t jkrFz t� W n ty4 Y n0 tt| ��|�S t � | j |d�}|dkrbdS t � | j |�}t � |�}t �d�}t �||�}t|dk� z0t �|d |�dd� �d�}W t �|d � nt �|d � 0 |S )a Find attribute. An X509Name object has the following attributes: countryName (alias C), stateOrProvince (alias ST), locality (alias L), organization (alias O), organizationalUnit (alias OU), commonName (alias CN) and more... r� N�unsigned char**r r� )rL r� r� r� r� r r� r# � __getattr__ZX509_NAME_get_index_by_NIDrw r� �X509_NAME_ENTRY_get_datarS rT ZASN1_STRING_to_UTF8rV rY r� � OPENSSL_free) rq ru r� Z entry_index�entryrZ r\ Z data_lengthr� r� rB rC r� f s* � zX509Name.__getattr__c s � fdd�}|S )Nc s( t |t�stS t�| j|j�}� |d�S �Nr )r^ r# r� rL Z X509_NAME_cmprw )rq r� r� ��oprB rC �f� s zX509Name._cmp.<locals>.frB )r� r� rB r� rC �_cmp� s z X509Name._cmpc C sB t �dd�}t�| j|t|��}t|t jk� dtt � |��f S )z6 String representation of an X509Name rJ i z<X509Name object '%s'>) rS rT rL ZX509_NAME_onelinerw rU rV rW �_nativerj )rq r\ Z format_resultrB rB rC r� � s � �zX509Name.__repr__c C s t �| j�S )a& Return an integer representation of the first four bytes of the MD5 digest of the DER representation of the name. This is the Python equivalent of OpenSSL's ``X509_NAME_hash``. :return: The (integer) hash of this name. :rtype: :py:class:`int` )rL ZX509_NAME_hashrw rp rB rB rC �hash� s z X509Name.hashc C sN t �d�}t�| j|�}t|dk� t �|d |�dd� }t�|d � |S )z� Return the DER encoding of this name. :return: The DER encoded form of this name. :rtype: :py:class:`bytes` r� r N)rS rT rL Z i2d_X509_NAMErw rV rY r� )rq r\ Z encode_resultrl rB rB rC r� � s z X509Name.derc C s� g }t t�| j��D ]n}t�| j|�}t�|�}t�|�}t�|�}t�|�}t � t� |�t� |��dd� }|� t �|�|f� q|S )z� Returns the components of this name, as a sequence of 2-tuples. :return: The components of this name. :rtype: :py:class:`list` of ``name, value`` tuples. N)r� rL r� rw r� r� r� r� r� rS rY rk ri rs rj ) rq r� r� r� �fnameZfvalr� ru r� rB rB rC �get_components� s ��zX509Name.get_components)r> r? r@ rA rr r� r� r� r r r r r r r� r� r� r� r� rB rB r� rC r# s ' ( r# c @ sd e Zd ZdZddd�Zedd� �Zejdej dej d iZ d d � Z d d � Z dd� Zdd� Zdd� ZdS )r$ z, An X.509 v3 certificate extension. Nc C s� t �d�}t�|t jt jt jt jd� t�|� |durRt|t�sJtd��|j |_ |durtt|t�sltd��|j |_ |r�d| }t� t j|||�}|t jkr�t � t �|tj�| _dS )a� Initializes an X509 extension. :param type_name: The name of the type of extension_ to create. :type type_name: :py:data:`bytes` :param bool critical: A flag indicating whether this is a critical extension. :param value: The value of the extension. :type value: :py:data:`bytes` :param subject: Optional X509 certificate to use as subject. :type subject: :py:class:`X509` :param issuer: Optional X509 certificate to use as issuer. :type issuer: :py:class:`X509` .. _extension: https://www.openssl.org/docs/manmaster/man5/ x509v3_config.html#STANDARD-EXTENSIONS z X509V3_CTX*r Nz issuer must be an X509 instancez subject must be an X509 instances critical,)rS rT rL ZX509V3_set_ctxrW ZX509V3_set_ctx_nodbr^ r& r` �_x509� issuer_certZ subject_certZX509V3_EXT_nconfr� rX �X509_EXTENSION_free� _extension)rq � type_nameZcriticalr� �subject�issuer�ctx� extensionrB rB rC rr � s" zX509Extension.__init__c C s t �t �| j��S rK )rL r� �X509_EXTENSION_get_objectr� rp rB rB rC r� & s �zX509Extension._nidZemailZDNSZURIc C s� t �dt�| j��}t �|tj�}g }tt�|��D ]�}t� ||�}z| j |j }W n6 t y� t � }t�||� |�tt|��� Y q40 tt �|jjj|jjj�d d � �}|�|d | � q4d�|�S )NzGENERAL_NAMES*�:z, )rS rh rL ZX509V3_EXT_d2ir� rX ZGENERAL_NAMES_freer� Zsk_GENERAL_NAME_numZsk_GENERAL_NAME_value� _prefixesr� �KeyErrorr[ ZGENERAL_NAME_printrs r� r] rY �dZia5rZ �length�join)rq �names�partsr� ru ZlabelrN r� rB rB rC �_subjectAltNameString2 s$ � �z#X509Extension._subjectAltNameStringc C sD t j| jkr| �� S t� }t �|| jdd�}t|dk� tt |��S )zF :return: a nice text representation of the extension r ) rL ZNID_subject_alt_namer� r� r[ �X509V3_EXT_printr� rV r� r] )rq rN � print_resultrB rB rC �__str__H s zX509Extension.__str__c C s t �| j�S )zk Returns the critical field of this X.509 extension. :return: The critical field. )rL ZX509_EXTENSION_get_criticalr� rp rB rB rC � get_criticalU s zX509Extension.get_criticalc C s& t �| j�}t �|�}t�t �|��S )z� Returns the short type name of this X.509 extension. The result is a byte string such as :py:const:`b"basicConstraints"`. :return: The short type name. :rtype: :py:data:`bytes` .. versionadded:: 0.12 )rL r� r� r� rS rj r� )rq �objr� rB rB rC �get_short_name] s z X509Extension.get_short_namec C s@ t �| j�}t�d|�}t �|�}t �|�}t�||�dd� S )z� Returns the data of the X509 extension, encoded as ASN.1. :return: The ASN.1 encoded data of this X509 extension. :rtype: :py:data:`bytes` .. versionadded:: 0.12 rf N)rL �X509_EXTENSION_get_datar� rS rh rk ri rY )rq Z octet_resultrl Z char_result� result_lengthrB rB rC �get_datal s zX509Extension.get_data)NN)r> r? r@ rA rr �propertyr� rL Z GEN_EMAILZGEN_DNSZGEN_URIr� r� r� r� r� r� rB rB rB rC r$ � s = � r$ c @ st e Zd ZdZdd� Zdd� Zedd� �Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� ZdS )r% z0 An X.509 certificate signing requests. c C s& t �� }t�|t j�| _| �d� d S r� )rL Z X509_REQ_newrS rX � X509_REQ_free�_req� set_version)rq �reqrB rB rC rr � s zX509Req.__init__c C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` certificate signing request. :rtype: ``cryptography.x509.CertificateSigningRequest`` .. versionadded:: 17.1.0 r )�load_der_x509_csr)�cryptography.x509r� r6 r rF )rq r� r� rE rB rB rC �to_cryptography� s zX509Req.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )a Construct based on a ``cryptography`` *crypto_req*. :param crypto_req: A ``cryptography`` X.509 certificate signing request :type crypto_req: ``cryptography.x509.CertificateSigningRequest`` :rtype: X509Req .. versionadded:: 17.1.0 z%Must be a certificate signing requestr �r� ) r^ r ZCertificateSigningRequestr` r� r� r� r� r7 r )r� Z crypto_reqr� r� rB rB rC �from_cryptography� s zX509Req.from_cryptographyc C s t �| j|j�}t|dk� dS )z� Set the public key of the certificate signing request. :param pkey: The public key to use. :type pkey: :py:class:`PKey` :return: ``None`` r� N)rL ZX509_REQ_set_pubkeyr� rz rV �rq r} rd rB rB rC � set_pubkey� s zX509Req.set_pubkeyc C sD t �t �}t�| j�|_t|jtjk� t� |jtj �|_d|_ |S )z� Get the public key of the certificate signing request. :return: The public key. :rtype: :py:class:`PKey` T) r �__new__rL ZX509_REQ_get_pubkeyr� rz rV rS rW rX ry r� r| rB rB rC � get_pubkey� s zX509Req.get_pubkeyc C s t �| j|�}t|dk� dS )z� Set the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :param int version: The version number. :return: ``None`` r� N)rL ZX509_REQ_set_versionr� rV )rq �versionrd rB rB rC r� � s zX509Req.set_versionc C s t �| j�S )z� Get the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :return: The value of the version subfield. :rtype: :py:class:`int` )rL ZX509_REQ_get_versionr� rp rB rB rC � get_version� s zX509Req.get_versionc C s2 t �t �}t�| j�|_t|jtjk� | |_ |S )a� Return the subject of this certificate signing request. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate signing request. Modifying it will modify the underlying signing request, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate signing request. :rtype: :class:`X509Name` ) r# r rL ZX509_REQ_get_subject_namer� rw rV rS rW �_ownerrt rB rB rC � get_subject� s zX509Req.get_subjectc C sl t �� }t|tjk� t�|t j�}|D ]$}t|t�s>t d��t � ||j � q(t � | j |�}t|dk� dS )z� Add extensions to the certificate signing request. :param extensions: The X.509 extensions to add. :type extensions: iterable of :py:class:`X509Extension` :return: ``None`` �+One of the elements is not an X509Extensionr� N)rL Zsk_X509_EXTENSION_new_nullrV rS rW rX Zsk_X509_EXTENSION_freer^ r$ ra Zsk_X509_EXTENSION_pushr� ZX509_REQ_add_extensionsr� )rq � extensions�stack�extr� rB rB rC �add_extensions� s zX509Req.add_extensionsc C sn g }t �| j�}t�|dd� �}tt �|��D ]:}t�t�}t � t � ||��}t�|t j �|_ |� |� q.|S )z� Get X.509 extensions in the certificate signing request. :return: The X.509 extensions in this request. :rtype: :py:class:`list` of :py:class:`X509Extension` objects. .. versionadded:: 0.15 c S s t �| t�t jd��S )Nr� )rL Zsk_X509_EXTENSION_pop_freerS Z addressofZ _original_lib)�xrB rB rC �<lambda> s �z(X509Req.get_extensions.<locals>.<lambda>)rL ZX509_REQ_get_extensionsr� rS rX r� Zsk_X509_EXTENSION_numr$ r �X509_EXTENSION_dupZsk_X509_EXTENSION_valuer� r� rs )rq ZextsZnative_exts_objr� r r� rB rB rC �get_extensions s � � zX509Req.get_extensionsc C s^ |j rtd��|js td��t�t|��}|tjkr<td��t�| j |j |�}t |dk� dS )ad Sign the certificate signing request with this key and digest type. :param pkey: The key pair to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use for the signature, e.g. :py:data:`b"sha256"`. :type digest: :py:class:`bytes` :return: ``None`` �Key has only public part�Key is uninitialized�No such digest methodr N) r� ra r{ rL �EVP_get_digestbynamer� rS rW Z X509_REQ_signr� rz rV �rq r} �digest� digest_obj� sign_resultrB rB rC r8 " s z X509Req.signc C s4 t |t�std��t�| j|j�}|dkr0t� |S )a@ Verifies the signature on this certificate signing request. :param PKey key: A public key. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid or there is a problem verifying the signature. � pkey must be a PKey instancer )r^ r r` rL ZX509_REQ_verifyr� rz r� )rq r} r� rB rB rC r9 : s zX509Req.verifyN)r> r? r@ rA rr r� r� r r r r� r r r r r8 r9 rB rB rB rC r% | s r% c @ s e Zd ZdZdd� Zedd� �Zdd� Zedd � �Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Z d2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z!d<d=� Z"d>d?� Z#d@dA� Z$dBS )Cr& z An X.509 certificate. c C s: t �� }t|tjk� t�|t j�| _t� | _ t� | _ d S rK ) rL ZX509_newrV rS rW rX � X509_freer� rn �_issuer_invalidator�_subject_invalidator)rq r rB rB rC rr U s z X509.__init__c C s. | � | �}t�|tj�|_t� |_t� |_|S rK ) r rS rX rL r r� rn r r )r� r �certrB rB rC �_from_raw_x509_ptr] s zX509._from_raw_x509_ptrc C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` certificate. :rtype: ``cryptography.x509.Certificate`` .. versionadded:: 17.1.0 r )�load_der_x509_certificate)r� r! r, r rF )rq r! r� rE rB rB rC r� e s zX509.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )z� Construct based on a ``cryptography`` *crypto_cert*. :param crypto_key: A ``cryptography`` X.509 certificate. :type crypto_key: ``cryptography.x509.Certificate`` :rtype: X509 .. versionadded:: 17.1.0 zMust be a certificater r ) r^ r Z Certificater` r� r� r� r� r+ r )r� Z crypto_certr� r� rB rB rC r s s zX509.from_cryptographyc C s$ t |t�std��t�| j|� dS )a Set the version number of the certificate. Note that the version value is zero-based, eg. a value of 0 is V1. :param version: The version number of the certificate. :type version: :py:class:`int` :return: ``None`` zversion must be an integerN)r^ r� r` rL ZX509_set_versionr� �rq r rB rB rC r� � s zX509.set_versionc C s t �| j�S )z� Return the version number of the certificate. :return: The version number of the certificate. :rtype: :py:class:`int` )rL ZX509_get_versionr� rp rB rB rC r � s zX509.get_versionc C sF t �t �}t�| j�|_|jtjkr*t� t� |jtj �|_d|_ |S )z{ Get the public key of the certificate. :return: The public key. :rtype: :py:class:`PKey` T) r r rL �X509_get_pubkeyr� rz rS rW r� rX ry r� r| rB rB rC r � s zX509.get_pubkeyc C s2 t |t�std��t�| j|j�}t|dk� dS )z� Set the public key of the certificate. :param pkey: The public key. :type pkey: :py:class:`PKey` :return: :py:data:`None` r r� N)r^ r r` rL ZX509_set_pubkeyr� rz rV r rB rB rC r � s zX509.set_pubkeyc C sp t |t�std��|jr td��|js.td��t�t|��}|t j krNtd��t� | j |j |�}t|dk� dS )a Sign the certificate with this key and digest type. :param pkey: The key to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use. :type digest: :py:class:`bytes` :return: :py:data:`None` r zKey only has public partr r r N)r^ r r` r� ra r{ rL r r� rS rW Z X509_signr� rz rV )rq r} r Zevp_mdr rB rB rC r8 � s z X509.signc C s: t �| j�}t �|j�}|t jkr*td��t�t � |��S )z� Return the signature algorithm used in the certificate. :return: The name of the algorithm. :rtype: :py:class:`bytes` :raises ValueError: If the signature algorithm is undefined. .. versionadded:: 0.13 z Undefined signature algorithm) rL ZX509_get0_tbs_sigalgr� r� � algorithmr� ra rS rj Z OBJ_nid2ln)rq Zalgorr� rB rB rC �get_signature_algorithm� s z X509.get_signature_algorithmc C s� t �t|��}|tjkr td��t�dt j�}t�dd�}t|�|d< t � | j |||�}t |dk� d� dd� t� ||d �D ��S ) a7 Return the digest of the X509 object. :param digest_name: The name of the digest algorithm to use. :type digest_name: :py:class:`bytes` :return: The digest of the object, formatted as :py:const:`b":"`-delimited hex pairs. :rtype: :py:class:`bytes` r �unsigned char[]zunsigned int[]r� r � :c S s g | ]}t |��� �qS rB )r �upper)r� ZchrB rB rC � <listcomp> s �z X509.digest.<locals>.<listcomp>)rL r r� rS rW ra rT ZEVP_MAX_MD_SIZErU Z X509_digestr� rV r� rY )rq Z digest_namer r\ r� Z digest_resultrB rB rC r � s � ��z X509.digestc C s t �| j�S )z� Return the hash of the X509 subject. :return: The hash of the subject. :rtype: :py:class:`bytes` )rL ZX509_subject_name_hashr� rp rB rB rC �subject_name_hash s zX509.subject_name_hashc C s� t |t�std��t|�dd� }t |t�s6|�d�}t�d�}t� ||�}|d tj krzt� t� | j �|�}|r�t� nXt�|d tj �}t�|d � |tj kr�t� t�|tj�}t�| j |�}t|dk� dS )z� Set the serial number of the certificate. :param serial: The new serial number. :type serial: :py:class:`int` :return: :py:data`None` zserial must be an integer� Nr� �BIGNUM**r r� )r^ �_integer_typesr` �hexr_ r� rS rT rL � BN_hex2bnrW ZASN1_INTEGER_set�X509_get_serialNumberr� r� �BN_to_ASN1_INTEGERr� rX �ASN1_INTEGER_freeZX509_set_serialNumberrV )rq �serial� hex_serial� bignum_serialZ small_serialrd � asn1_serialrB rB rC �set_serial_number s( � zX509.set_serial_numberc C s� t �| j�}t �|tj�}zVt �|�}z0t�|�}t|d�}|W t � |� W t � |� S t � |� 0 W t � |� n t � |� 0 dS )zx Return the serial number of this certificate. :return: The serial number. :rtype: int � N) rL r0 r� ZASN1_INTEGER_to_BNrS rW Z BN_bn2hexrj r� r� r� )rq r6 r5 r4 Zhexstring_serialr3 rB rB rC �get_serial_number: s � �zX509.get_serial_numberc C s. t |t�std��t�| j�}t�||� dS )z� Adjust the time stamp on which the certificate stops being valid. :param int amount: The number of seconds by which to adjust the timestamp. :return: ``None`` �amount must be an integerN)r^ r� r` rL �X509_getm_notAfterr� �X509_gmtime_adj)rq �amountZnotAfterrB rB rC �gmtime_adj_notAfterN s zX509.gmtime_adj_notAfterc C s. t |t�std��t�| j�}t�||� dS )z� Adjust the timestamp on which the certificate starts being valid. :param amount: The number of seconds by which to adjust the timestamp. :return: ``None`` r: N)r^ r� r` rL �X509_getm_notBeforer� r< )rq r= Z notBeforerB rB rC �gmtime_adj_notBefore\ s zX509.gmtime_adj_notBeforec C s( t | �� �}tj�|d�}|tj�� k S )z� Check whether the certificate has expired. :return: ``True`` if the certificate has expired, ``False`` otherwise. :rtype: bool z %Y%m%d%H%M%SZ)r� � get_notAfter�datetime�strptimeZutcnow)rq Z time_stringZ not_afterrB rB rC � has_expiredi s zX509.has_expiredc C s t || j��S rK )rm r� )rq �whichrB rB rC �_get_boundary_timeu s zX509._get_boundary_timec C s | � tj�S )a Get the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType )rF rL r? rp rB rB rC � get_notBeforex s zX509.get_notBeforec C s t || j�|�S rK )re r� �rq rE rc rB rB rC �_set_boundary_time� s zX509._set_boundary_timec C s | � tj|�S )z� Set the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` )rI rL r? �rq rc rB rB rC � set_notBefore� s zX509.set_notBeforec C s | � tj�S )a Get the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType )rF rL r; rp rB rB rC rA � s zX509.get_notAfterc C s | � tj|�S )z� Set the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` )rI rL r; rJ rB rB rC � set_notAfter� s zX509.set_notAfterc C s0 t �t �}|| j�|_t|jtjk� | |_|S rK )r# r r� rw rV rS rW r )rq rE ru rB rB rC � _get_name� s zX509._get_namec C s0 t |t�std��|| j|j�}t|dk� d S )Nzname must be an X509Namer� )r^ r# r` r� rw rV )rq rE ru rd rB rB rC � _set_name� s zX509._set_namec C s | � tj�}| j�|� |S )a� Return the issuer of this certificate. This creates a new :class:`X509Name` that wraps the underlying issuer name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this issuer. :return: The issuer of this certificate. :rtype: :class:`X509Name` )rM rL ZX509_get_issuer_namer rv rt rB rB rC � get_issuer� s zX509.get_issuerc C s | � tj|� | j�� dS )z� Set the issuer of this certificate. :param issuer: The issuer. :type issuer: :py:class:`X509Name` :return: ``None`` N)rN rL ZX509_set_issuer_namer rx )rq r� rB rB rC � set_issuer� s zX509.set_issuerc C s | � tj�}| j�|� |S )a� Return the subject of this certificate. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate. :rtype: :class:`X509Name` )rM rL �X509_get_subject_namer rv rt rB rB rC r � s zX509.get_subjectc C s | � tj|� | j�� dS )z� Set the subject of this certificate. :param subject: The subject. :type subject: :py:class:`X509Name` :return: ``None`` N)rN rL ZX509_set_subject_namer rx )rq r� rB rB rC � set_subject� s zX509.set_subjectc C s t �| j�S )z� Get the number of extensions on this certificate. :return: The number of extensions. :rtype: :py:class:`int` .. versionadded:: 0.12 )rL ZX509_get_ext_countr� rp rB rB rC �get_extension_count� s zX509.get_extension_countc C s< |D ]2}t |t�std��t�| j|jd�}|st� qdS )z� Add extensions to the certificate. :param extensions: The extensions to add. :type extensions: An iterable of :py:class:`X509Extension` objects. :return: ``None`` r r� N)r^ r$ ra rL Z X509_add_extr� r� r� )rq r r r� rB rB rC r s zX509.add_extensionsc C sN t �t �}t�| j|�|_|jtjkr.td��t� |j�}t� |tj �|_|S )a� Get a specific extension of the certificate by index. Extensions on a certificate are kept in order. The index parameter selects which extension will be returned. :param int index: The index of the extension to retrieve. :return: The extension at the specified index. :rtype: :py:class:`X509Extension` :raises IndexError: If the extension index was out of bounds. .. versionadded:: 0.12 z extension index out of bounds) r$ r rL Z X509_get_extr� r� rS rW � IndexErrorr rX r� )rq �indexr r� rB rB rC � get_extension s zX509.get_extensionN)%r> r? r@ rA rr r� r r� r r� r r r r8 r% r r* r7 r9 r> r@ rD rF rG rI rK rA rL rM rN rO rP r rR rS r rV rB rB rB rC r& P sF ( r& c @ sL e Zd ZdZejZejZej Z ej Z ej ZejZejZejZejZejZdS )r' a Flags for X509 verification, used to change the behavior of :class:`X509Store`. See `OpenSSL Verification Flags`_ for details. .. _OpenSSL Verification Flags: https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_flags.html N)r> r? r@ rA rL ZX509_V_FLAG_CRL_CHECKZ CRL_CHECKZX509_V_FLAG_CRL_CHECK_ALLZ CRL_CHECK_ALLZX509_V_FLAG_IGNORE_CRITICALZIGNORE_CRITICALZX509_V_FLAG_X509_STRICTZ X509_STRICTZ X509_V_FLAG_ALLOW_PROXY_CERTSZALLOW_PROXY_CERTSZX509_V_FLAG_POLICY_CHECKZ POLICY_CHECKZX509_V_FLAG_EXPLICIT_POLICYZEXPLICIT_POLICYZX509_V_FLAG_INHIBIT_MAPZ INHIBIT_MAPZX509_V_FLAG_NOTIFY_POLICYZ NOTIFY_POLICYZ X509_V_FLAG_CHECK_SS_SIGNATUREZCHECK_SS_SIGNATURErB rB rB rC r' + s r' c @ sB e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zdd d�Z d S )r( a� An X.509 store. An X.509 store is used to describe a context in which to verify a certificate. A description of a context may include a set of certificates to trust, a set of certificate revocation lists, verification flags and more. An X.509 store, being only a description, cannot be used by itself to verify a certificate. To carry out the actual verification process, see :class:`X509StoreContext`. c C s t �� }t�|t j�| _d S rK )rL ZX509_STORE_newrS rX ZX509_STORE_free�_store�rq �storerB rB rC rr P s zX509Store.__init__c C s0 t |t�st� �t�| j|j�}t|dk� dS )a� Adds a trusted certificate to this store. Adding a certificate with this method adds this certificate as a *trusted* certificate. :param X509 cert: The certificate to add to this store. :raises TypeError: If the certificate is not an :class:`X509`. :raises OpenSSL.crypto.Error: If OpenSSL was unhappy with your certificate. :return: ``None`` if the certificate was added successfully. r� N)r^ r& r` rL ZX509_STORE_add_certrW r� rV )rq r r� rB rB rC �add_certT s zX509Store.add_certc C s t t�| j|j�dk� dS )a� Add a certificate revocation list to this store. The certificate revocation lists added to a store will only be used if the associated flags are configured to check certificate revocation lists. .. versionadded:: 16.1.0 :param CRL crl: The certificate revocation list to add to this store. :return: ``None`` if the certificate revocation list was added successfully. r N)rV rL ZX509_STORE_add_crlrW �_crl�rq �crlrB rB rC �add_crlj s zX509Store.add_crlc C s t t�| j|�dk� dS )a� Set verification flags to this store. Verification flags can be combined by oring them together. .. note:: Setting a verification flag sometimes requires clients to add additional information to the store, otherwise a suitable error will be raised. For example, in setting flags to enable CRL checking a suitable CRL must be added to the store otherwise an error will be raised. .. versionadded:: 16.1.0 :param int flags: The verification flags to set on this store. See :class:`X509StoreFlags` for available constants. :return: ``None`` if the verification flags were successfully set. r N)rV rL ZX509_STORE_set_flagsrW )rq �flagsrB rB rC � set_flagsz s zX509Store.set_flagsc C sF t �� }t�|t j�}t �|t�|�� �� t t � | j |�dk� dS )a� Set the time against which the certificates are verified. Normally the current time is used. .. note:: For example, you can determine if a certificate was valid at a given time. .. versionadded:: 17.0.0 :param datetime vfy_time: The verification time to set on this store. :return: ``None`` if the verification time was successfully set. r N) rL ZX509_VERIFY_PARAM_newrS rX ZX509_VERIFY_PARAM_freeZX509_VERIFY_PARAM_set_time�calendarZtimegmZ timetuplerV ZX509_STORE_set1_paramrW )rq Zvfy_timeZparamrB rB rC �set_time� s �zX509Store.set_timeNc C sN |du rt j}nt|�}|du r(t j}nt|�}t�| j||�}|sJt� dS )a� Let X509Store 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 *cafile* or *capath* may be ``None``. .. note:: Both *cafile* and *capath* may be set simultaneously. Call this method multiple times to add more than one location. For example, CA certificates, and certificate revocation list bundles may be passed in *cafile* in subsequent calls to this method. .. versionadded:: 20.0 :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`` if the locations were set successfully. :raises OpenSSL.crypto.Error: If both *cafile* and *capath* is ``None`` or the locations could not be set for any reason. N)rS rW � _path_stringrL ZX509_STORE_load_locationsrW r� )rq ZcafileZcapathZ load_resultrB rB rC �load_locations� s �zX509Store.load_locations)N) r> r? r@ rA rr rZ r^ r` rb rd rB rB rB rC r( B s r( c s e Zd ZdZ� fdd�Z� ZS )r) z� An exception raised when an error occurred while verifying a certificate using `OpenSSL.X509StoreContext.verify_certificate`. :ivar certificate: The certificate which caused verificate failure. :type certificate: :class:`X509` c s t t| ��|� || _d S rK )r� r) rr � certificate)rq �messagere r� rB rC rr � s z X509StoreContextError.__init__)r> r? r@ rA rr r� rB rB r� rC r) � s r) c @ sV e Zd ZdZddd�Zedd� �Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dS )r* a� An X.509 store context. An X.509 store context is used to carry out the actual verification process of a certificate in a described context. For describing such a context, see :class:`X509Store`. :ivar _store_ctx: The underlying X509_STORE_CTX structure used by this instance. It is dynamically allocated and automatically garbage collected. :ivar _store: See the ``store`` ``__init__`` parameter. :ivar _cert: See the ``certificate`` ``__init__`` parameter. :ivar _chain: See the ``chain`` ``__init__`` parameter. :param X509Store store: The certificates which will be trusted for the purposes of any verifications. :param X509 certificate: The certificate to be verified. :param chain: List of untrusted certificates that may be used for building the certificate chain. May be ``None``. :type chain: :class:`list` of :class:`X509` Nc C s< t �� }t�|t j�| _|| _|| _| �|�| _ | � � d S rK ) rL ZX509_STORE_CTX_newrS rX ZX509_STORE_CTX_free� _store_ctxrW �_cert�_build_certificate_stack�_chain�_init)rq rY re �chainZ store_ctxrB rB rC rr � s zX509StoreContext.__init__c C s� dd� }| d u s t | �dkr"tjS t�� }t|tjk� t�||�}| D ]N}t|t�s^t d��tt� |j �dk� t� ||j �dkrHt� |j � t� qH|S )Nc S s8 t t�| ��D ]}t�| |�}t�|� qt�| � d S rK )r� rL � sk_X509_num� sk_X509_valuer � sk_X509_free)�sr� r rB rB rC �cleanup s z:X509StoreContext._build_certificate_stack.<locals>.cleanupr z+One of the elements is not an X509 instance)rU rS rW rL �sk_X509_new_nullrV rX r^ r& r` Z X509_up_refr� � sk_X509_pushr r� )Z certificatesrq r r rB rB rC ri s z)X509StoreContext._build_certificate_stackc C s. t �| j| jj| jj| j�}|dkr*t� dS )z� Set up the store context for a subsequent verification operation. Calling this method more than once without first calling :meth:`_cleanup` will leak memory. r N)rL ZX509_STORE_CTX_initrg rW rh r� rj r� �rq �retrB rB rC rk % s �zX509StoreContext._initc C s t �| j� dS )z� Internally cleans up the store context. The store context can then be reused with a new call to :meth:`_init`. N)rL ZX509_STORE_CTX_cleanuprg rp rB rB rC �_cleanup2 s zX509StoreContext._cleanupc C s\ t �| j�t �| j�tt�t �t �| j����g}t �| j�}t � |�}t � |�}t ||�S )z� Convert an OpenSSL native context error failure into a Python exception. When a call to native OpenSSL X509_verify_cert fails, additional information about the failure can be obtained from the store context. ) rL ZX509_STORE_CTX_get_errorrg Z X509_STORE_CTX_get_error_depthr� rS rj Z X509_verify_cert_error_stringZ X509_STORE_CTX_get_current_certZX509_dupr& r r) )rq �errorsr� rh �pycertrB rB rC �_exception_from_context: s ���� z(X509StoreContext._exception_from_contextc C s || _ dS )z� Set the context's X.509 store. .. versionadded:: 0.15 :param X509Store store: The store description which will be used for the purposes of any *future* verifications. N)rW rX rB rB rC � set_storeT s zX509StoreContext.set_storec C s8 | � � | �� t�| j�}| � � |dkr4| �� �dS )a" Verify a certificate in a context. .. versionadded:: 0.15 :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. r N)rv rk rL �X509_verify_certrg ry rt rB rB rC �verify_certificate_ s z#X509StoreContext.verify_certificatec C s� | � � | �� t�| j�}|dkr4| � � | �� �t�| j�}t|tj k� g }t t� |��D ]2}t� ||�}t|tj k� t �|�}|�|� q`t�|� | � � |S )aR Verify a certificate in a context and return the complete validated chain. :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. .. versionadded:: 20.0 r )rv rk rL r{ rg ry ZX509_STORE_CTX_get1_chainrV rS rW r� rm rn r& r rs ro )rq ru Z cert_stackr� r� r rx rB rB rC �get_verified_chainu s" z#X509StoreContext.get_verified_chain)N) r> r? r@ rA rr � staticmethodri rk rv ry rz r| r} rB rB rB rC r* � s r* c C sv t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �|�S )a Load a certificate (X509) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param bytes buffer: The buffer the certificate is stored in :return: The X509 object r� �3type argument must be FILETYPE_PEM or FILETYPE_ASN1)r^ r� r� r[ r rL ZPEM_read_bio_X509rS rW r Z d2i_X509_biora r� r& r )r� rY rN r rB rB rC r+ � s r+ c C sn t � }| tkr t�||j�}n<| tkr6t�||j�}n$| tkrRt�||jdd�}nt d��t |dk� t |�S )a Dump the certificate *cert* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1, or FILETYPE_TEXT) :param cert: The certificate to dump :return: The buffer with the dumped certificate in r �Ctype argument must be FILETYPE_PEM, FILETYPE_ASN1, or FILETYPE_TEXTr� ) r[ r rL ZPEM_write_bio_X509r� r Z i2d_X509_bior Z X509_print_exra rV r] )r� r rN � result_coderB rB rC r, � s � r, c C sP t � }| tkrtj}n| tkr&tj}ntd��|||j�}|dkrHt� t |�S )z� Dump a public key to a buffer. :param type: The file type (one of :data:`FILETYPE_PEM` or :data:`FILETYPE_ASN1`). :param PKey pkey: The public key to dump :return: The buffer with the dumped key in it. :rtype: bytes r r� ) r[ r rL ZPEM_write_bio_PUBKEYr Zi2d_PUBKEY_biora rz r� r] )r� r} rN Z write_bior� rB rB rC r- � s r- c C s t � }t|t�std��|durR|du r0td��t�t|��}|tjkrXt d��ntj}t | |�}| t kr�t� ||j |tjd|j|j�}|�� nh| tkr�t�||j �}nP| tkr�t�|j �tjkr�td��t�t�|j �tj�}t�||d�}nt d��t|dk� t|�S )a� Dump the private key *pkey* into a buffer string encoded with the type *type*. Optionally (if *type* is :const:`FILETYPE_PEM`) encrypting it using *cipher* and *passphrase*. :param type: The file type (one of :const:`FILETYPE_PEM`, :const:`FILETYPE_ASN1`, or :const:`FILETYPE_TEXT`) :param PKey pkey: The PKey to dump :param cipher: (optional) if encrypted PEM format, the cipher to use :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The buffer with the dumped key in :rtype: bytes zpkey must be a PKeyNzDif a value is given for cipher one must also be given for passphrasezInvalid cipher namer z-Only RSA keys are supported for FILETYPE_TEXTr� ) r[ r^ r r` rL ZEVP_get_cipherbynamer� rS rW ra �_PassphraseHelperr ZPEM_write_bio_PrivateKeyrz �callback� callback_args�raise_if_problemr Zi2d_PrivateKey_bior r� r� rX r� r� Z RSA_printrV r] ) r� r} Zcipher� passphraserN Z cipher_obj�helperr� r rB rB rC r. � sH � � � r. c @ s` e Zd ZdZg d�Zdd� Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dd� Z dd� Z dS )r/ z# A certificate revocation. )s unspecifieds keyCompromises CACompromises affiliationChangeds supersededs cessationOfOperations certificateHoldc C s t �� }t�|t j�| _d S rK )rL ZX509_REVOKED_newrS rX �X509_REVOKED_free�_revoked)rq �revokedrB rB rC rr C s zRevoked.__init__c C sf t �t�� tj�}t �d�}||d< t�||�}|s<td��t �t�|t j �tj �}t� | j |� dS )z� Set the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :param bytes hex_str: The new serial number. :return: ``None`` r, r zbad hex stringN) rS rX rL r� r� rT r/ ra r1 rW r2 Z X509_REVOKED_set_serialNumberr� )rq Zhex_strr5 Z bignum_ptrZ bn_resultr6 rB rB rC � set_serialG s �zRevoked.set_serialc C s@ t � }t�| j�}t|tjk� t�||�}t|dk� t|�S )z� Get the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :return: The serial number. :rtype: bytes r ) r[ rL Z X509_REVOKED_get0_serialNumberr� rV rS rW Zi2a_ASN1_INTEGERr] )rq rN Zasn1_intr� rB rB rC � get_serial_ s zRevoked.get_serialc C s^ t t�| j��D ]H}t�| j|�}t�|�}t�|�tjkrt�|� t� | j|� qZqd S rK ) r� rL �X509_REVOKED_get_ext_countr� �X509_REVOKED_get_extr� r� �NID_crl_reasonr� ZX509_REVOKED_delete_ext)rq r� r r� rB rB rC �_delete_reasonq s zRevoked._delete_reasonc C s� |du r| � � n�t|t�s&td��n�|�� �dd�}dd� | jD ��|�}t� � }t |t j k� t � |tj�}t�||�}t |t j k� | � � t�| jtj|dd�}t |dk� dS ) a� Set the reason of this revocation. If :data:`reason` is ``None``, delete the reason instead. :param reason: The reason string. :type reason: :class:`bytes` or :class:`NoneType` :return: ``None`` .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons which you might pass to this method. Nz$reason must be None or a byte string� r� c S s g | ] }|� � �qS rB )�lower)r� �rrB rB rC r) � r� z&Revoked.set_reason.<locals>.<listcomp>r r� )r� r^ r_ r` r� �replace� _crl_reasonsrU rL ZASN1_ENUMERATED_newrV rS rW rX ZASN1_ENUMERATED_freeZASN1_ENUMERATED_setZX509_REVOKED_add1_ext_i2dr� r� )rq �reasonZ reason_codeZnew_reason_extrd r� rB rB rC � set_reasonz s �zRevoked.set_reasonc C s� t t�| j��D ]p}t�| j|�}t�|�}t�|�tjkrt� }t� ||dd�}|stt� |t� |��}t |dk� t |� S qdS )a Get the reason of this revocation. :return: The reason, or ``None`` if there is none. :rtype: bytes or NoneType .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons this method might return. r N)r� rL r� r� r� r� r� r� r[ r� ZM_ASN1_OCTET_STRING_printr� rV r] )rq r� r r� rN r� rB rB rC � get_reason� s � zRevoked.get_reasonc C s | j dd� S )a Return a list of all the supported reason strings. This list is a copy; modifying it does not change the supported reason strings. :return: A list of reason strings. :rtype: :class:`list` of :class:`bytes` N)r� rp rB rB rC � all_reasons� s zRevoked.all_reasonsc C s t �| j�}t||�S )z� Set the revocation timestamp. :param bytes when: The timestamp of the revocation, as ASN.1 TIME. :return: ``None`` )rL � X509_REVOKED_get0_revocationDater� re )rq rc �dtrB rB rC � set_rev_date� s zRevoked.set_rev_datec C s t �| j�}t|�S )z� Get the revocation timestamp. :return: The timestamp of the revocation, as ASN.1 TIME. :rtype: bytes )rL r� r� rm )rq r� rB rB rC � get_rev_date� s zRevoked.get_rev_dateN)r> r? r@ rA r� rr r� r� r� r� r� r� r� r� rB rB rB rC r/ / s % r/ c @ s| e Zd ZdZdd� Zdd� Zedd� �Zdd � Zd d � Z d d � Z dd� Z dd� Z dd� Z dd� Zdd� Zedefdd�ZdS ) r0 z( A certificate revocation list. c C s t �� }t�|t j�| _d S rK )rL Z X509_CRL_newrS rX � X509_CRL_freer[ r\ rB rB rC rr � s z CRL.__init__c C s& ddl m} tt| �}t� }|||�S )z� Export as a ``cryptography`` CRL. :rtype: ``cryptography.x509.CertificateRevocationList`` .. versionadded:: 17.1.0 r )�load_der_x509_crl)r� r� r: r rF )rq r� r� rE rB rB rC r� � s zCRL.to_cryptographyc C s6 t |tj�std��ddlm} |�|j�}tt |�S )a Construct based on a ``cryptography`` *crypto_crl*. :param crypto_crl: A ``cryptography`` certificate revocation list :type crypto_crl: ``cryptography.x509.CertificateRevocationList`` :rtype: CRL .. versionadded:: 17.1.0 z%Must be a certificate revocation listr r ) r^ r ZCertificateRevocationListr` r� r� r� r� r; r )r� Z crypto_crlr� r� rB rB rC r � s zCRL.from_cryptographyc C sn g }t �| j�}tt �|��D ]>}t �||�}t �|�}t�t�}t � |t j �|_ |� |� q |rjt|�S dS )aA Return the revocations in this certificate revocation list. These revocations will be provided by value, not by reference. That means it's okay to mutate them: it won't affect this CRL. :return: The revocations in this CRL. :rtype: :class:`tuple` of :class:`Revocation` N)rL ZX509_CRL_get_REVOKEDr[ r� Zsk_X509_REVOKED_numZsk_X509_REVOKED_value� Cryptography_X509_REVOKED_dupr/ r rS rX r� r� rs �tuple)rq �resultsZ revoked_stackr� r� Z revoked_copyZpyrevrB rB rC � get_revoked s zCRL.get_revokedc C s8 t �|j�}t|tjk� t �| j|�}t|dk� dS )a9 Add a revoked (by value not reference) to the CRL structure This revocation will be added by value, not by reference. That means it's okay to mutate it after adding: it won't affect this CRL. :param Revoked revoked: The new revocation. :return: ``None`` r N)rL r� r� rV rS rW ZX509_CRL_add0_revokedr[ )rq r� �copyr� rB rB rC � add_revoked s zCRL.add_revokedc C sB t �t �| j��}t|tjk� t�|t j�}t � t �}||_ |S )zc Get the CRL's issuer. .. versionadded:: 16.1.0 :rtype: X509Name ) rL r� ZX509_CRL_get_issuerr[ rV rS rW rX r� r# r rw )rq Z_issuerr� rB rB rC rO . s zCRL.get_issuerc C s t t�| j|�dk� dS )z� Set the CRL version. .. versionadded:: 16.1.0 :param int version: The version of the CRL. :return: ``None`` r N)rV rL ZX509_CRL_set_versionr[ r" rB rB rC r� = s zCRL.set_versionc C s t || j�|�S rK )re r[ rH rB rB rC rI H s zCRL._set_boundary_timec C s | � tj|�S )z� Set when the CRL was last updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` )rI rL ZX509_CRL_get_lastUpdaterJ rB rB rC �set_lastUpdateK s zCRL.set_lastUpdatec C s | � tj|�S )z� Set when the CRL will next be updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` )rI rL ZX509_CRL_get_nextUpdaterJ rB rB rC �set_nextUpdateZ s zCRL.set_nextUpdatec C s\ t �|�}t|tjk� t �| jt �|j�� t � | j� t � | j|j |�}t|dk� dS )a; Sign the CRL. Signing a CRL enables clients to associate the CRL itself with an issuer. Before a CRL is meaningful to other OpenSSL functions, it must be signed by an issuer. This method implicitly sets the issuer's name based on the issuer certificate and private key used to sign the CRL. .. versionadded:: 16.1.0 :param X509 issuer_cert: The issuer's certificate. :param PKey issuer_key: The issuer's private key. :param bytes digest: The digest method to sign the CRL with. r N) rL r rV rS rW �X509_CRL_set_issuer_namer[ rQ r� Z X509_CRL_sort� X509_CRL_signrz )rq r� Z issuer_keyr r r� rB rB rC r8 i s � zCRL.sign�d c C s t |t�std��t |t�s$td��t |t�s6td��|tu rFtd��t�|�}|tj krbt d��t� t� � �}t |tj k� t�� }t |tj k� t�|d� t�| j|� t�||d d d � t�| j|� t�| jt�|j�� t�| j|j|�} | �st� t|| �S ) a� Export the CRL as a string. :param X509 cert: The certificate used to sign the CRL. :param PKey key: The key used to sign the CRL. :param int type: The export format, either :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`, or :data:`FILETYPE_TEXT`. :param int days: The number of days until the next update of this CRL. :param bytes digest: The name of the message digest to use (eg ``b"sha256"``). :rtype: bytes � cert must be an X509 instancezkey must be a PKey instancer� zdigest must be providedr r � �< )r^ r& r` r r� � _UNSPECIFIEDrL r rS rW ra rQ rR rV Z ASN1_TIME_newr< ZX509_CRL_set_lastUpdater[ ZX509_CRL_set_nextUpdater� rQ r� r� rz r� r: ) rq r r� r� Zdaysr r rN Zsometimer rB rB rC �export� s4 �z CRL.exportN)r> r? r@ rA rr r� r� r r� r� rO r� rI r� r� r8 r r� r� rB rB rB rC r0 � s �r0 c @ s4 e Zd Zdd� Zdd� Zdd� Zdd� Zd d � Zd S ) r1 c C s t t�| j��S )zm Check if this NID_pkcs7_signed object :return: True if the PKCS7 is of type signed )�boolrL ZPKCS7_type_is_signed�_pkcs7rp rB rB rC �type_is_signed� s zPKCS7.type_is_signedc C s t t�| j��S )zt Check if this NID_pkcs7_enveloped object :returns: True if the PKCS7 is of type enveloped )r� rL ZPKCS7_type_is_envelopedr� rp rB rB rC �type_is_enveloped� s zPKCS7.type_is_envelopedc C s t t�| j��S )z� Check if this NID_pkcs7_signedAndEnveloped object :returns: True if the PKCS7 is of type signedAndEnveloped )r� rL Z PKCS7_type_is_signedAndEnvelopedr� rp rB rB rC �type_is_signedAndEnveloped� s z PKCS7.type_is_signedAndEnvelopedc C s t t�| j��S )zi Check if this NID_pkcs7_data object :return: True if the PKCS7 is of type data )r� rL ZPKCS7_type_is_datar� rp rB rB rC � type_is_data� s zPKCS7.type_is_datac C s" t �| jj�}t �|�}t�|�S )zk Returns the type name of the PKCS7 structure :return: A string with the typename )rL r� r� r� r� rS rj )rq r� Z string_typerB rB rC � get_type_name� s zPKCS7.get_type_nameN)r> r? r@ r� r� r� r� r� rB rB rB rC r1 � s r1 c @ sb e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dd� Z dd� Z ddd�Z dS )r2 z A PKCS #12 archive. c C s d | _ d | _d | _d | _d S rK )rz rh �_cacerts� _friendlynamerp rB rB rC rr � s zPKCS12.__init__c C s | j S )z� Get the certificate in the PKCS #12 structure. :return: The certificate, or :py:const:`None` if there is none. :rtype: :py:class:`X509` or :py:const:`None` )rh rp rB rB rC �get_certificate� s zPKCS12.get_certificatec C s t |t�std��|| _dS )z� Set the certificate in the PKCS #12 structure. :param cert: The new certificate, or :py:const:`None` to unset it. :type cert: :py:class:`X509` or :py:const:`None` :return: ``None`` r� N)r^ r& r` rh )rq r rB rB rC �set_certificate� s zPKCS12.set_certificatec C s | j S )z� Get the private key in the PKCS #12 structure. :return: The private key, or :py:const:`None` if there is none. :rtype: :py:class:`PKey` )rz rp rB rB rC �get_privatekey s zPKCS12.get_privatekeyc C s t |t�std��|| _dS )z� Set the certificate portion of the PKCS #12 structure. :param pkey: The new private key, or :py:const:`None` to unset it. :type pkey: :py:class:`PKey` or :py:const:`None` :return: ``None`` r N)r^ r r` rz r| rB rB rC �set_privatekey s zPKCS12.set_privatekeyc C s | j durt| j �S dS )a Get the CA certificates in the PKCS #12 structure. :return: A tuple with the CA certificates in the chain, or :py:const:`None` if there are none. :rtype: :py:class:`tuple` of :py:class:`X509` or :py:const:`None` N)r� r� rp rB rB rC �get_ca_certificates s zPKCS12.get_ca_certificatesc C s> |du rd| _ n*t|�}|D ]}t|t�s td��q || _ dS )a Replace or set the CA certificates within the PKCS12 object. :param cacerts: The new CA certificates, or :py:const:`None` to unset them. :type cacerts: An iterable of :py:class:`X509` or :py:const:`None` :return: ``None`` Nz)iterable must only contain X509 instances)r� �listr^ r& r` )rq �cacertsr rB rB rC �set_ca_certificates( s �zPKCS12.set_ca_certificatesc C s2 |du rd| _ nt|t�s(td|f ��|| _ dS )z� Set the friendly name in the PKCS #12 structure. :param name: The new friendly name, or :py:const:`None` to unset. :type name: :py:class:`bytes` or :py:const:`None` :return: ``None`` Nz+name must be a byte string or None (not %r))r� r^ r_ r` rt rB rB rC �set_friendlyname= s �zPKCS12.set_friendlynamec C s | j S )z� Get the friendly name in the PKCS# 12 structure. :returns: The friendly name, or :py:const:`None` if there is none. :rtype: :py:class:`bytes` or :py:const:`None` )r� rp rB rB rC �get_friendlynameN s zPKCS12.get_friendlynameN� r� c C s� t d|�}| jdu r tj}n0t�� }t�|tj�}| jD ]}t�||j � q8|du rZtj}| j }|du rntj}| j du r�tj}n| j j }| j du r�tj}n| j j }t� |||||tjtj||d� }|tjkr�t� t�|tj�}t� } t�| |� t| �S )a� Dump a PKCS12 object as a string. For more information, see the :c:func:`PKCS12_create` man page. :param passphrase: The passphrase used to encrypt the structure. Unlike some other passphrase arguments, this *must* be a string, not a callback. :type passphrase: :py:data:`bytes` :param iter: Number of times to repeat the encryption step. :type iter: :py:data:`int` :param maciter: Number of times to repeat the MAC step. :type maciter: :py:data:`int` :return: The string representation of the PKCS #12 structure. :rtype: r� Nr )�_text_to_bytes_and_warnr� rS rW rL rr rX ro rs r� r� rz rh Z PKCS12_createZ&NID_pbe_WithSHA1And3_Key_TripleDES_CBCr� � PKCS12_freer[ Zi2d_PKCS12_bior] ) rq r� �iterZmaciterr� r � friendlynamer} �pkcs12rN rB rB rC r� W sH � z PKCS12.export)Nr� r� )r> r? r@ rA rr r� r� r� r� r� r� r� r� r� rB rB rB rC r2 � s r2 c @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )r3 z! A Netscape SPKI object. c C s t �� }t�|t j�| _d S rK )rL ZNETSCAPE_SPKI_newrS rX ZNETSCAPE_SPKI_free�_spki)rq ZspkirB rB rC rr � s zNetscapeSPKI.__init__c C s^ |j rtd��|js td��t�t|��}|tjkr<td��t�| j |j |�}t |dk� dS )a Sign the certificate request with this key and digest type. :param pkey: The private key to sign with. :type pkey: :py:class:`PKey` :param digest: The message digest to use. :type digest: :py:class:`bytes` :return: ``None`` r r r r N) r� ra r{ rL r r� rS rW ZNETSCAPE_SPKI_signr� rz rV r rB rB rC r8 � s �zNetscapeSPKI.signc C s" t �| j|j�}|dkr t� dS )aY Verifies a signature on a certificate request. :param PKey key: The public key that signature is supposedly from. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid, or there was a problem verifying the signature. r T)rL ZNETSCAPE_SPKI_verifyr� rz r� )rq r� ZanswerrB rB rC r9 � s zNetscapeSPKI.verifyc C s$ t �| j�}t�|�}t �|� |S )z� Generate a base64 encoded representation of this SPKI object. :return: The base64 encoded string. :rtype: :py:class:`bytes` )rL ZNETSCAPE_SPKI_b64_encoder� rS rj r� )rq Zencodedr� rB rB rC � b64_encode� s zNetscapeSPKI.b64_encodec C sD t �t �}t�| j�|_t|jtjk� t� |jtj �|_d|_ |S )z| Get the public key of this certificate. :return: The public key. :rtype: :py:class:`PKey` T) r r rL ZNETSCAPE_SPKI_get_pubkeyr� rz rV rS rW rX ry r� r| rB rB rC r � s zNetscapeSPKI.get_pubkeyc C s t �| j|j�}t|dk� dS )zv Set the public key of the certificate :param pkey: The public key :return: ``None`` r� N)rL ZNETSCAPE_SPKI_set_pubkeyr� rz rV r rB rB rC r � s zNetscapeSPKI.set_pubkeyN) r> r? r@ rA rr r8 r9 r� r r rB rB rB rC r3 � s r3 c @ sB e Zd Zd dd�Zedd� �Zedd� �Zefdd �Zd d � Z d S )r� Fc C s4 |t kr|d urtd��|| _|| _|| _g | _d S )Nz0only FILETYPE_PEM key format supports encryption)r ra � _passphrase� _more_args� _truncate� _problems)rq r� r� Z more_args�truncaterB rB rC rr � s �z_PassphraseHelper.__init__c C s@ | j d u rtjS t| j t�s&t| j �r4t�d| j�S td��d S )NZpem_password_cb�2Last argument must be a byte string or a callable.) r� rS rW r^ r_ �callabler� �_read_passphraser` rp rB rB rC r� s �z_PassphraseHelper.callbackc C s8 | j d u rtjS t| j t�s&t| j �r,tjS td��d S )Nr� )r� rS rW r^ r_ r� r` rp rB rB rC r� s �z _PassphraseHelper.callback_argsc C s6 | j r2z t|� W n |y$ Y n0 | j �d��d S r� )r� �_exception_from_error_queue�pop)rq Z exceptionTyperB rB rC r� s z"_PassphraseHelper.raise_if_problemc C s� z�t | j�r.| jr"| �|||�}q4| �|�}n| j}t|t�sFtd��t|�|krn| jrf|d |� }ntd��tt|��D ]}|||d � ||< qzt|�W S t y� } z| j � |� W Y d }~dS d }~0 0 d S )NzBytes expectedz+passphrase returned by callback is too longr� r ) r� r� r� r^ r_ ra rU r� r� � Exceptionr� rs )rq �buf�sizeZrwflagZuserdatar� r� �erB rB rC r� ! s( � z"_PassphraseHelper._read_passphraseN)FF) r> r? r@ rr r� r� r� r r� r� rB rB rB rC r� � s r� c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_d|_|S )a< Load a public key from a buffer. :param type: The file type (one of :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`). :param buffer: The buffer the key is stored in. :type buffer: A Python string object, either unicode or bytestring. :return: The PKey object. :rtype: :class:`PKey` r� r T)r^ r� r� r[ r rL ZPEM_read_bio_PUBKEYrS rW r Zd2i_PUBKEY_biora r� r r rX ry rz r� )r� rY rN �evp_pkeyr} rB rB rC r4 ; s � r4 c C s� t |t�r|�d�}t|�}t| |�}| tkrNt�|tj |j |j �}|� � n | t krft�|tj �}ntd��|tj kr~t� t�t�}t�|tj�|_|S )a� Load a private key (PKey) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the key is stored in :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The PKey object r� r )r^ r� r� r[ r� r rL ZPEM_read_bio_PrivateKeyrS rW r� r� r� r Zd2i_PrivateKey_biora r� r r rX ry rz )r� rY r� rN r� r� r} rB rB rC r5 ] s" � r5 c C sn t � }| tkr t�||j�}n<| tkr6t�||j�}n$| tkrRt�||jdd�}nt d��t |dk� t |�S )a Dump the certificate request *req* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param req: The certificate request to dump :return: The buffer with the dumped certificate request in r r� ) r[ r rL ZPEM_write_bio_X509_REQr� r Zi2d_X509_REQ_bior ZX509_REQ_print_exra rV r] )r� r� rN r� rB rB rC r6 � s � r6 c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��t |tjk� t �t �}t�|tj�|_|S )a Load a certificate request (X509Req) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the certificate request is stored in :return: The X509Req object r� r )r^ r� r� r[ r rL ZPEM_read_bio_X509_REQrS rW r Zd2i_X509_REQ_biora rV r% r rX r� r� )r� rY rN r� Zx509reqrB rB rC r7 � s r7 c C s� t d|�}t�t|��}|tjkr*td��t�� }t�|tj �}t� ||� t� ||t |�� t� | j�}t|dk� t�d|�}t�d�}t�|||| j�}t|dk� t�||d �dd� S )z� Sign a data string using the given key and message digest. :param pkey: PKey to sign with :param data: data to be signed :param digest: message digest to use :return: signature .. versionadded:: 0.11 rZ r r r& zunsigned int *r� N)r� rL r r� rS rW ra �Cryptography_EVP_MD_CTX_newrX � Cryptography_EVP_MD_CTX_freeZ EVP_SignInitZEVP_SignUpdaterU Z EVP_PKEY_sizerz rV rT Z EVP_SignFinalrY ) r} rZ r r �md_ctxr� Zsignature_bufferZsignature_lengthZ final_resultrB rB rC r8 � s" � r8 c C s� t d|�}t�t|��}|tjkr*td��t�| j�}t |tjk� t� |tj �}t� � }t� |tj �}t�||� t�||t|�� t�||t|�|�}|dkr�t� dS )a� Verify the signature for a data string. :param cert: signing certificate (X509 object) corresponding to the private key which generated the signature. :param signature: signature returned by sign function :param data: data to be verified :param digest: message digest to use :return: ``None`` if the signature is correct, raise exception otherwise. .. versionadded:: 0.11 rZ r r� N)r� rL r r� rS rW ra r# r� rV rX ry r� r� ZEVP_VerifyInitZEVP_VerifyUpdaterU ZEVP_VerifyFinalr� )r Z signaturerZ r r r} r� Z verify_resultrB rB rC r9 � s �r9 c C sj t � }| tkr t�||j�}n8| tkr6t�||j�}n | tkrNt�||j�}nt d��t |dk� t |�S )a Dump a certificate revocation list to a buffer. :param type: The file type (one of ``FILETYPE_PEM``, ``FILETYPE_ASN1``, or ``FILETYPE_TEXT``). :param CRL crl: The CRL to dump. :return: The buffer with the CRL. :rtype: bytes r� r� ) r[ r rL ZPEM_write_bio_X509_CRLr[ r Zi2d_X509_CRL_bior ZX509_CRL_printra rV r] )r� r] rN ru rB rB rC r: s � r: c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_|S )a Load Certificate Revocation List (CRL) data from a string *buffer*. *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the CRL is stored in :return: The PKey object r� r )r^ r� r� r[ r rL ZPEM_read_bio_X509_CRLrS rW r Zd2i_X509_CRL_biora r� r0 r rX r� r[ )r� rY rN r] r� rB rB rC r; s r; c C s� t |t�r|�d�}t|�}| tkr<t�|tjtjtj�}n | t krTt� |tj�}nt d��|tjkrlt � t �t �}t�|tj�|_|S )z� Load pkcs7 data from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM or FILETYPE_ASN1) :param buffer: The buffer with the pkcs7 data. :return: The PKCS7 object r� r )r^ r� r� r[ r rL ZPEM_read_bio_PKCS7rS rW r Z d2i_PKCS7_biora r� r1 r rX Z PKCS7_freer� )r� rY rN Zpkcs7Zpypkcs7rB rB rC r< < s r< zSPKCS#7 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.c C s� t d|�}t| t�r | �d�} t| �}|s0tj}t�|tj�}|tjkrNt � t� |tj �}t� d�}t� d�}t� d�}t� |||||�}|s�t � t� |d tj�}z t � W n ty� Y n0 |d tjkr�d}n t�t�}t� |d tj�|_|d tjk�rd} d} nPt�|d �} t� d�} t�|d | �} t�| | d �dd� } | tjk�rbd} g } tt�|��D ]&}t�||�}t�|�}| �|� �qt| �s�d} t �t �}||_| |_ | |_ | |_ |S ) a� Load pkcs12 data from the string *buffer*. If the pkcs12 structure is encrypted, a *passphrase* must be included. The MAC is always checked and thus required. See also the man page for the C function :py:func:`PKCS12_parse`. :param buffer: The buffer the certificate is stored in :param passphrase: (Optional) The password to decrypt the PKCS12 lump :returns: The PKCS12 object r� r� z EVP_PKEY**zX509**z Cryptography_STACK_OF_X509**r Nzint*) r� r^ r� r� r[ rS rW rL Zd2i_PKCS12_bior� rX r� rT Z PKCS12_parsero r r r ry rz r& r ZX509_alias_get0rY r� rm rn rs r2 rh r� r� )rY r� rN Zp12r} r r� Z parse_resultZpykeyrx r� Zfriendlyname_lengthZfriendlyname_bufferZ pycacertsr� r Zpycacertr� rB rB rC r= d sj ��� r= zTPKCS#12 support in pyOpenSSL is deprecated. You should use the APIs in cryptography.s utf8only)N)NN)N)N)mra rB �base64r � functoolsr �operatorr r r r r r Zsixr r- r r� r r� Z cryptographyr r Z)cryptography.hazmat.primitives.asymmetricr r Z OpenSSL._utilr rS r rL r r� r r� r r� r rc r r� r r� r Z _make_assert�__all__ZSSL_FILETYPE_PEMr ZSSL_FILETYPE_ASN1r r r� r Z EVP_PKEY_DSAr Z EVP_PKEY_DHZTYPE_DHZ EVP_PKEY_ECZTYPE_ECr� r r� rV rF rI r[ r] re rm �objectrn r r� r! r" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 r1 r2 r3 r� r4 r5 r6 r7 r8 r9 r: r; r< Z deprecatedr> �DeprecationWarningr= ZOpenSSL_add_all_algorithmsZSSL_load_error_stringsZ ASN1_STRING_set_default_mask_ascrB rB rB rC �<module> s� , ' ) 4i I U ^ 6 @ . _, 6ZF" % #$ � W� __pycache__/SSL.cpython-39.pyc 0000644 00000225222 15025013455 0012053 0 ustar 00 a �Sa�V � @ sT 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$ d d l%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+ g d �Z,ze-Z.W n" e/y� G d d � d e0�Z.Y n0 ej1Z1ej2Z2ej3Z3ej4Z4ej5Z5ej6Z6ej7Z8ej9Z:d Z;dZ<dZ=dZ>dZ?dZ@dZAdZBdZCz"ejDZDejEZEejFZFejGZGejHZHW n( eI�y� dZDdZEdZFdZGdZHY n0 ejJZKejLZMejNZOejPZQejRZSz ejTZUW n eI�y� Y n0 ejVZWejXZYejZZ[ej\Z]ej^Z_ej`ZaejbZcejdZeejfZgejhZiejjZkejlZmejnZoejpZqejrZsejtZuejvZwejxZyejzZ{ej|Z}ej~Zej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�ej�Z�g d�Z�d gZ�d Z�d Z�G d d � d e��Z�eee��Z�e e��Z�G d!d"� 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*e��Z�G d+d,� d,e0�Z�G d-d.� d.e��Z�e0� Z�G d/d0� d0e��Z�G d1d2� d2e��Z�G d3d4� d4e��Z�d5d6� Z�d7d8� Z�d9d:� Z�e�ej�d;�Z�e�e�ed<d�d=�Z�G d>d?� d?e0�Z�G d@dA� dAe0�Z�G dBdC� dCe0�Z�e�͡ dS )D� N)�platform)�wraps�partial)�count�chain)�WeakValueDictionary)� errorcode)� integer_types�int2byte� indexbytes) � UNSPECIFIED�exception_from_error_queue�ffi�lib� make_assert�native� path_string�text_to_bytes_and_warn�no_zero_allocator)� FILETYPE_PEM�_PassphraseHelper�PKey�X509Name�X509� X509Store)\�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� TLS_METHOD�TLS_SERVER_METHOD�TLS_CLIENT_METHOD� SSL3_VERSION� TLS1_VERSION�TLS1_1_VERSION�TLS1_2_VERSION�TLS1_3_VERSION� 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�NO_OVERLAPPING_PROTOCOLS�SSLeay_version�Session�Context� Connectionc @ s e Zd ZdS )�_bufferN��__name__� __module__� __qualname__� r| r| �//usr/lib/python3.9/site-packages/OpenSSL/SSL.pyrw � s rw � � � � � � � � � i i i i i )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 )rl z4 An error occurred in an `OpenSSL.SSL` API. N�ry rz r{ �__doc__r| r| r| r} rl s rl c @ s e Zd ZdS )rm Nrx r| r| r| r} rm s rm c @ s e Zd ZdS )rn Nrx r| r| r| r} rn s rn c @ s e Zd ZdS )ro Nrx r| r| r| r} ro s ro c @ s e Zd ZdS )rp Nrx r| r| r| r} rp s rp c @ s e Zd ZdS )rq Nrx r| r| r| r} rq " s rq 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��selfr| r| r} �__init__2 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_errorrl �popr� r| r| r} �raise_if_problem5 s z)_CallbackExceptionHelper.raise_if_problemN)ry rz r{ r� r� r� r| r| r| r} 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 r~ )�_libZ X509_STORE_CTX_get_current_cert� X509_up_refr �_from_raw_x509_ptrZX509_STORE_CTX_get_errorZ X509_STORE_CTX_get_error_depthZ"SSL_get_ex_data_X509_STORE_CTX_idxZX509_STORE_CTX_get_ex_datarv �_reverse_mapping� Exceptionr� �appendZX509_STORE_CTX_set_errorZ X509_V_OK) �okZ store_ctxZx509�certZ error_numberZ error_depth�index�sslZ connection�result�e��callbackr� r| r} �wrapperK s& � z'_VerifyHelper.__init__.<locals>.wrapperz int (*)(int, X509_STORE_CTX *)�r� r� r �_ffir� �r� r� r� r| r� r} r� H s �z_VerifyHelper.__init__N�ry rz r{ r� r� r| r| r| r} r� B 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 r~ T� Fz^ALPN callback must return a bytestring or the special NO_OVERLAPPING_PROTOCOLS sentinel value.zunsigned char *�unsigned char[])rv r� r� �bufferr r� rr � isinstance�bytes� TypeError�new�len�_alpn_select_callback_argsr� ZSSL_TLSEXT_ERR_NOACKZSSL_TLSEXT_ERR_OKr� r� ZSSL_TLSEXT_ERR_ALERT_FATAL)r� �outZoutlenZin_Zinlen�arg�connZinstrZ protolistZ encoded_len�protoZoutbytesZ any_acceptedr� r� r| r} r� u s: � � z+_ALPNSelectHelper.__init__.<locals>.wrapperz^int (*)(SSL *, unsigned char **, unsigned char *, const unsigned char *, unsigned int, void *)r� r� r| r� r} r� r s +�z_ALPNSelectHelper.__init__Nr� r| r| r| r} r� m 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.r� r r )rv r� r� �NULL� from_handler� r� r� r� r� ZOPENSSL_mallocr� Z SSL_set_tlsext_status_ocsp_respr� r� r� )r� �cdatar� �data� ocsp_dataZocsp_data_lengthZdata_ptrr� r� r| r} r� � s( � z3_OCSPServerCallbackHelper.__init__.<locals>.wrapper�int (*)(SSL *, void *)r� r� r| r� r} r� � s &z"_OCSPServerCallbackHelper.__init__Nr� r| r| r| r} 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� ���)rv r� r� r� r� r� r� Z SSL_get_tlsext_status_ocsp_respr� �int�boolr� r� r� ) r� r� r� r� Zocsp_ptrZocsp_lenr� Zvalidr� r� r| r} r� s z3_OCSPClientCallbackHelper.__init__.<locals>.wrapperr� r� r� r| r� r} r� s z"_OCSPClientCallbackHelper.__init__Nr� r| r| r| r} 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�methr| r| r} �_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� rs )�typer| r| r} rs < s rs 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)�errorr| r} �explodeS s z<_make_requires.<locals>._requires_decorator.<locals>.explode)r )�funcr� �r� �flagr| r} �_requires_decoratorP s z+_make_requires.<locals>._requires_decoratorr| )r� r� r� r| r� r} �_make_requiresE s r� zALPN not availableZCryptography_HAS_KEYLOGzKey logging not availablec @ s e Zd ZdZdS )rt 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� r| r| r| r} rt h s rt c @ s� e Zd ZdZededededede de de d e d i Z ed d � e �� D ��Z d d� Zdd� Zdd� Zdjdd�Zdd� Zdkdd�Zdd� Zd d � Zd d � Zd d!� Zefd"d#�Zd$d%� Z d&d'� Z d(d)� Z e fd*d+�Z d,d-� Z!d.d/� Z"d0d1� Z#d2d3� Z$d4d5� Z%d6d7� Z&dld8d9�Z'd:d;� Z(d<d=� Z)d>d?� Z*d@dA� Z+dBdC� Z,dDdE� Z-dFdG� Z.dHdI� Z/dJdK� Z0dLdM� Z1dNdO� Z2e3dPdQ� �Z4dRdS� Z5dTdU� Z6dVdW� Z7dXdY� Z8dZd[� Z9d\d]� Z:d^d_� Z;e<d`da� �Z=e<dbdc� �Z>ddde� Z?dmdfdg�Z@dndhdi�ZAdS )oru a- :class:`OpenSSL.SSL.Context` instances define the parameters for setting up new SSL connections. :param method: One of TLS_METHOD, TLS_CLIENT_METHOD, or TLS_SERVER_METHOD. SSLv23_METHOD, TLSv1_METHOD, etc. are deprecated and should not be used. Z SSLv2_methodZ SSLv3_methodZ SSLv23_methodZ TLSv1_methodZTLSv1_1_methodZTLSv1_2_methodZ TLS_methodZTLS_server_methodZTLS_client_methodc c s0 | ](\}}t t|d �d ur|t t|�fV qd S r� )r� r� )�.0Z identifier�namer| r| r} � <genexpr>� 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 protocolr~ ) r� r r� �_methods�KeyErrorr� �_openssl_assertr� r� r� Z SSL_CTX_new�gcZ SSL_CTX_freeZSSL_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_modeZ SSL_MODE_ENABLE_PARTIAL_WRITE)r� �methodZ method_funcZ method_obj�context�resr| r| r} r� � s: zContext.__init__c C s t t�| j|�dk� dS )aD Set the minimum supported protocol version. Setting the minimum version to 0 will enable protocol versions down to the lowest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. r~ N)r� r� Z SSL_CTX_set_min_proto_versionr� �r� �versionr| r| r} �set_min_proto_version� s �z Context.set_min_proto_versionc C s t t�| j|�dk� dS )aC Set the maximum supported protocol version. Setting the maximum version to 0 will enable protocol versions up to the highest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. r~ N)r� r� Z SSL_CTX_set_max_proto_versionr� r� r| r| r} �set_max_proto_version� s �z Context.set_max_proto_versionNc 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� Z SSL_CTX_load_verify_locationsr� r� )r� �cafile�capathZ load_resultr| r| r} �load_verify_locations� s �z Context.load_verify_locationsc s& t � �� �fdd��}tt|ddd�S )Nc s � | |�j �S r� )r� )�sizeZverify�userdatar� r| r} r� � s z'Context._wrap_callback.<locals>.wrapperT)Z more_args�truncate)r r r r� r| r� r} �_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� Z SSL_CTX_set_default_passwd_cbr� r� )r� r� r� r| r| r} � 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 r~ �asciiN)r� Z SSL_CTX_set_default_verify_pathsr� r� r� r� Z X509_get_default_cert_dir_env�decodeZ X509_get_default_cert_file_env�_check_env_vars_setZX509_get_default_cert_dirZX509_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_filer| r| r} �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 r| r| r} r� G 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� r| r| r} r 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� Z"SSL_CTX_use_certificate_chain_filer� r� )r� �certfiler� r| r| r} �use_certificate_chain_filef 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� Z SSL_CTX_use_certificate_filer� r� )r� r �filetype� use_resultr| r| r} �use_certificate_filew 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� ZSSL_CTX_use_certificater� �_x509r� )r� r� r r| r| r} �use_certificate� 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� ZX509_dupr Z SSL_CTX_add_extra_chain_certr� Z X509_freer� )r� Zcertobj�copy� add_resultr| r| r} �add_extra_chain_cert� s z Context.add_extra_chain_certc C s | j d ur| j �t� t� d S r� )r� r� rl r� r� r| r| r} �_raise_passphrase_exception� 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� ZSSL_CTX_use_PrivateKey_filer� r )r� Zkeyfiler r r| r| r} �use_privatekey_file� 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� ZSSL_CTX_use_PrivateKeyr� Z_pkeyr )r� Zpkeyr r| r| r} �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� ZSSL_CTX_check_private_keyr� r� r� r| r| r} �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� ZSSL_load_client_CA_file�_text_to_bytes_and_warnr� r� r� �SSL_CTX_set_client_CA_listr� )r� r� Zca_listr| r| r} �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 �bufr~ N)r r� r� Z SSL_CTX_set_session_id_contextr� r� )r� r" r| r| r} �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� Z SSL_CTX_set_session_cache_moder� �r� �moder| r| r} �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� Z SSL_CTX_get_session_cache_moder� r� r| r| r} �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. r$ Nr� ) r� r r� r� r� r� ZSSL_CTX_set_verifyr� r� r� r� r� r� )r� r& r� r| r| r} � 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� ZSSL_CTX_set_verify_depthr� )r� �depthr| r| r} �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� ZSSL_CTX_get_verify_moder� r� r| r| r} �get_verify_modeM 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� ZSSL_CTX_get_verify_depthr� r� r| r| r} �get_verify_depthV 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 � rr~ N) r� r� Z BIO_new_filer� r� r� r� ZBIO_freeZPEM_read_bio_DHparamsZDH_freeZSSL_CTX_set_tmp_dhr� r� )r� Zdhfile�bioZdhr� r| r| r} � 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� ZSSL_CTX_set_tmp_ecdhr� Z _to_EC_KEY)r� Zcurver| r| r} � set_tmp_ecdht 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.r~ N)ZTLS_AES_256_GCM_SHA384Z TLS_CHACHA20_POLY1305_SHA256ZTLS_AES_128_GCM_SHA256)z SSL routines�SSL_CTX_set_cipher_listzno cipher match) r r� r� r� r� r� r3 r� rv �get_cipher_listrl )r� r2 Ztmpconnr| r| r} �set_cipher_list� 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� Zsk_X509_NAME_new_nullr� r� r� r� r r� r� ry � X509_NAME_dup�_nameZsk_X509_NAME_push�X509_NAME_freer� r� Zsk_X509_NAME_freer r� )r� Zcertificate_authoritiesZ name_stackZca_namer Z push_resultr| r| r} �set_client_ca_list� 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 instancer~ N)r� r r� r� ZSSL_CTX_add_client_CAr� r r� )r� Zcertificate_authorityr r| r| r} � 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� ZSSL_CTX_set_timeoutr� )r� �timeoutr| r| r} � 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� ZSSL_CTX_get_timeoutr� r� r| r| r} � 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� �rv r� )r� �whereZ return_code�r� r| r} r� s z*Context.set_info_callback.<locals>.wrapperz void (*)(const SSL *, int, int)N)r r� r� r� r� ZSSL_CTX_set_info_callbackr� r� r| r@ r} �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� rv r� )r� �liner@ r| r} r� s z,Context.set_keylog_callback.<locals>.wrapperz#void (*)(const SSL *, const char *)N)r r� r� r� r� ZSSL_CTX_set_keylog_callbackr� r� r| r@ r} �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� r| r| r} � 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 NrD �r� r� r| r| r} � 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� ZSSL_CTX_get_cert_storer� r� r� r �__new__Z_store)r� �storeZpystorer| r| r} �get_cert_store6 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� ZSSL_CTX_set_optionsr� )r� �optionsr| r| r} � set_optionsG 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. r$ )r� r r� r� ZSSL_CTX_set_moder� r% r| r| r} r� T 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 r> )r� Zalertr� r@ r| r} r� l s z7Context.set_tlsext_servername_callback.<locals>.wrapperz int (*)(SSL *, int *, void *)N)r r� r� r� r� Z&SSL_CTX_set_tlsext_servername_callbackr� r� r| r@ r} � set_tlsext_servername_callbacka 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� ZSSL_CTX_set_tlsext_use_srtpr� )r� Zprofilesr| r| r} �set_tlsext_use_srtpx s �zContext.set_tlsext_use_srtpc C sF d� t�dd� |D ���}t�d|�}tt�| j|t |��dk� 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� �pr| r| r} r� � r� z*Context.set_alpn_protos.<locals>.<genexpr>r� r N) �joinr � from_iterabler� r� r� r� ZSSL_CTX_set_alpn_protosr� r� �r� ZprotosZprotostrZ input_strr| r| r} �set_alpn_protos� 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� ZSSL_CTX_set_alpn_select_cbr� r� r� )r� r� r| r| r} �set_alpn_select_callback� 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. Nr~ ) r� r� r� r� r� r� Z new_handler� Z SSL_CTX_set_tlsext_status_cbr� r� Z SSL_CTX_set_tlsext_status_arg)r� �helperr� �rcr| r| r} �_set_ocsp_callback� 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� rY �r� r� r� rW r| r| r} �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� rY rZ r| r| r} �set_ocsp_client_callback� s z Context.set_ocsp_client_callback)N)N)N)N)N)Bry rz r{ r� r# r$ r% r& r' r( r) r* r+ r� �dict�itemsr� r� r� r� r� r� r r� r r r r r r r r r r r r! r# r' r( r) r+ r, r- r0 r1 r5 r9 r: r< r= rA �_requires_keylogrC rE rG rJ rL r� rM rN �_requires_alpnrU rV rY r[ r\ r| r| r| r} ru t s~ � �( 0 # '# ru 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 )rv 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 instanceNr~ )r� ru r� r� ZSSL_newr� r� r� ZSSL_free�_sslZ SSL_set_modeZSSL_MODE_AUTO_RETRYr� r� r� r� r� �_socketZBIO_newZ BIO_s_mem� _into_sslr� r� � _from_sslZ SSL_set_bioZ SSL_set_fdr� )r� r� �socketr� r r| r| r} 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')rc �AttributeError� __class__ry r� �r� r� r| r| r} � __getattr__0 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� Z SSL_get_errorZSSL_ERROR_WANT_READrm ZSSL_ERROR_WANT_WRITErn ZSSL_ERROR_ZERO_RETURNrp ZSSL_ERROR_WANT_X509_LOOKUPro ZSSL_ERROR_SYSCALLZERR_peek_errorr r� Z getwinerror�errnorq r r r� ZSSL_ERROR_NONE)r� r� r� r� rl r| r| r} �_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� r| r| r} � get_contextb 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. ra N)r� ru r� r� ZSSL_set_SSL_CTXrb r� )r� r� r| r| r} � set_contexti 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� ZSSL_get_servernamerb ZTLSEXT_NAMETYPE_host_namer� r� r� ri r| r| r} �get_servernamev 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� ZSSL_set_tlsext_host_namerb ri r| r| r} �set_tlsext_host_name� 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� Z SSL_pendingrb r� r| r| r} �pending� s zConnection.pendingr c C sr t d|�}t�|��J}t|�dkr*td��t�| j|t|��}| �| j|� |W d � S 1 sd0 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 r" ��z,Cannot send more than 2**31-1 bytes at once.N) r r� � from_bufferr� r� r� � SSL_writerb rm )r� r" �flagsr� r� r| r| r} �send� s �zConnection.sendc C s� t d|�}t�|��^}t|�}d}|r`t�| j|| t|d��}| �| j|� ||7 }||8 }q"|W d � S 1 sx0 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 r" r rt N) r r� ru r� r� rv rb �minrm )r� r" rw r� Z left_to_sendZ total_sentr� r| r| r} �sendall� 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_allocatorrf �MSG_PEEKr� �SSL_peekrb �SSL_readrm r� r� )r� �bufsizrw r" r� r| r| r} �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� ry r| rf r} r� r~ rb r rm � memoryviewr� r� )r� r� �nbytesrw r" r� r| r| r} � 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� ZBIO_should_retryZBIO_should_readrm ZBIO_should_writern r� r� r� )r� r/ r� r| r| r} �_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 ) re r� r� r r| r� ZBIO_readr� r� r� )r� r� r" r� r| r| r} �bio_read$ s zConnection.bio_readc C sx t d|�}| jdu r td��t�|��>}t�| j|t|��}|dkrR| �| j|� |W d � S 1 sj0 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 r" Nr� r ) r rd r� r� ru r� Z BIO_writer� r� )r� r" r� r� r| r| r} � 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 r~ TF)�renegotiate_pendingr� r� ZSSL_renegotiaterb r� r| r| r} � renegotiateQ 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� ZSSL_do_handshakerb rm �r� r� r| r| r} � 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 r~ )r� ZSSL_renegotiate_pendingrb r� r| r| r} r� h 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� ZSSL_total_renegotiationsrb r� r| r| r} �total_renegotiationsr 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_staterb rc �connect)r� �addrr| r| r} r� { 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 )rc � connect_ex�set_connect_state)r� r� r� r| r| r} r� � 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`. )rc �acceptrv r� �set_accept_state)r� Zclientr� r� r| r| r} r� � 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 )re r� r� ZBIO_set_mem_eof_returnrd r� r| r| r} � bio_shutdown� 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� Z SSL_shutdownrb rm r� r| r| r} �shutdown� 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� ZSSL_get_cipher_listrb r� r� r� �_nativer� )r� Zciphers�ir� r| r| r} r4 � 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� ZSSL_get_client_CA_listrb r� r� �rangeZsk_X509_NAME_numZsk_X509_NAME_valuer6 r� r rH r� r8 r7 r� )r� Zca_namesr� r� r� r Zpynamer| r| r} �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� r| r| r} �makefile� s �zConnection.makefilec C s | j S )zr Retrieve application data as set by :meth:`set_app_data`. :return: The application data rD r� r| r| r} rE � s zConnection.get_app_datac C s || _ dS )zg Set application data :param data: The application data :return: None NrD rF r| r| r} rG 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� ZSSL_get_shutdownrb r� r| r| r} � 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� ZSSL_set_shutdownrb )r� �stater| r| r} � 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� ZSSL_state_string_longrb r� r| r| r} �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_sessionrb r� r� ZSSL_get_server_randomr� r| r� �r� �session�length�outpr| r| r} � 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� rb r� r� ZSSL_get_client_randomr� r| r� r� r| r| r} � client_random6 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� rb r� r� ZSSL_SESSION_get_master_keyr� r| r� r� r| r| r} � master_keyF 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 Nr~ ) r| r� r� r� r� ZSSL_export_keying_materialrb r� r� ) r� ZlabelZolenr� r� Z context_bufZ context_lenZ use_context�successr| r| r} �export_keying_materialV 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 )rc r� r� r| r| r} � sock_shutdownt 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� ZSSL_get_certificaterb r� r� r� r r� �r� r� r| r| r} �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� ZSSL_get_peer_certificaterb r� r� r r� r� r| r| r} �get_peer_certificate� 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. r~ ) r� r� Z sk_X509_numZ sk_X509_valuer� r� r� r� r r� r� )� cert_stackr� r� r� r� Zpycertr| r| r} �_cert_stack_to_list� 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� ZSSL_get_peer_cert_chainrb r� r� r� �r� r� r| r| r} �get_peer_cert_chain� 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� ZSSL_get0_verified_chainrb r� r� r� r� r| r| r} �get_verified_chain� 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� Z SSL_want_readrb r� r| r| r} � 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� ZSSL_want_writerb r� r| r| r} � 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� ZSSL_set_accept_staterb r� r| r| r} 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� rb r� r| r| r} 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� ZSSL_get1_sessionrb r� r� rt rH r� ZSSL_SESSION_free�_session)r� r� Z pysessionr| r| r} � 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 instancer~ N)r� rt r� r� ZSSL_set_sessionrb r� r� )r� r� r� r| r| r} � 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� rb r| r� )r� �function�emptyr� r" r| r| r} �_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� ZSSL_get_finishedr� r| r| r} � 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� ZSSL_get_peer_finishedr� r| r| r} �get_peer_finished6 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_cipherrb r� r� r� ZSSL_CIPHER_get_namer� )r� �cipherr� r| r| r} �get_cipher_nameB 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� r� rb r� r� ZSSL_CIPHER_get_bits)r� r� r| r| r} �get_cipher_bitsS 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 Nr� )r� r� rb r� r� r� ZSSL_CIPHER_get_versionr� )r� r� r� r| r| r} �get_cipher_versionc 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` r� )r� r� r� ZSSL_get_versionrb r� r� r| r| r} �get_protocol_version_namet 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� Z SSL_versionrb r� r| r| r} �get_protocol_version� s z Connection.get_protocol_versionc C sF d� t�dd� |D ���}t�d|�}tt�| j|t |��dk� 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� rO rP r| r| r} r� � r� z-Connection.set_alpn_protos.<locals>.<genexpr>r� r N) rR r rS r� r� r� r� ZSSL_set_alpn_protosrb r� rT r| r| r} rU � 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� ZSSL_get0_alpn_selectedrb r� )r� r� Zdata_lenr| r| r} �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`. r~ N)r� ZSSL_set_tlsext_status_typerb ZTLSEXT_STATUSTYPE_ocspr� )r� rX r| r| r} � request_ocsp� s �zConnection.request_ocsp)N)r )r )N)NN)N)Dry rz r{ r r� r� rj rm rn ro rp rr rs rx �writerz r� �readr� r� r� r� r� r� r� r� r� r� r� r� r� r4 r� r� rE rG r� r� r� r� r� r� r� r� r� r� � staticmethodr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r` rU r� r� r| r| r| r} rv � s� 6 % % " rv )�r rf �sysr � functoolsr r � itertoolsr r �weakrefr rl r Zsixr r r Z OpenSSL._utilr r r Z_exception_from_error_queuer r� r r� r Z _make_assertr r� r r� r r r r| ZOpenSSL.cryptor r r r r r �__all__r� rw � NameError�objectr r r r r r ZSSL_SENT_SHUTDOWNr! ZSSL_RECEIVED_SHUTDOWNr" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 rg ZSSL_OP_NO_SSLv2r1 ZSSL_OP_NO_SSLv3r2 ZSSL_OP_NO_TLSv1r3 ZSSL_OP_NO_TLSv1_1r4 ZSSL_OP_NO_TLSv1_2r5 ZSSL_OP_NO_TLSv1_3r6 ZSSL_MODE_RELEASE_BUFFERSr7 ZSSL_OP_SINGLE_DH_USEr8 ZSSL_OP_SINGLE_ECDH_USEr9 ZSSL_OP_EPHEMERAL_RSAr: Z SSL_OP_MICROSOFT_SESS_ID_BUGr; Z SSL_OP_NETSCAPE_CHALLENGE_BUGr< Z'SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUGr= Z"SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUGr> Z!SSL_OP_MICROSOFT_BIG_SSLV3_BUFFERr? Z SSL_OP_MSIE_SSLV2_RSA_PADDINGr@ Z SSL_OP_SSLEAY_080_CLIENT_DH_BUGrA ZSSL_OP_TLS_D5_BUGrB Z SSL_OP_TLS_BLOCK_PADDING_BUGrC Z"SSL_OP_DONT_INSERT_EMPTY_FRAGMENTSrD Z SSL_OP_CIPHER_SERVER_PREFERENCErE ZSSL_OP_TLS_ROLLBACK_BUGrF ZSSL_OP_PKCS1_CHECK_1rG ZSSL_OP_PKCS1_CHECK_2rH ZSSL_OP_NETSCAPE_CA_DN_BUGrI Z&SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUGrJ ZSSL_OP_NO_COMPRESSIONrK ZSSL_OP_NO_QUERY_MTUrL ZSSL_OP_COOKIE_EXCHANGErM ZSSL_OP_NO_TICKETrN Z SSL_OP_ALLrO ZSSL_VERIFY_PEERrP Z SSL_VERIFY_FAIL_IF_NO_PEER_CERTrQ ZSSL_VERIFY_CLIENT_ONCErR ZSSL_VERIFY_NONErS ZSSL_SESS_CACHE_OFFrT ZSSL_SESS_CACHE_CLIENTrU ZSSL_SESS_CACHE_SERVERrV ZSSL_SESS_CACHE_BOTHrW Z SSL_SESS_CACHE_NO_AUTO_CLEARrX Z!SSL_SESS_CACHE_NO_INTERNAL_LOOKUPrY Z SSL_SESS_CACHE_NO_INTERNAL_STORErZ ZSSL_SESS_CACHE_NO_INTERNALr[ r\ r] r^ r_ r` ra rb rc rd re rf rg rh ri rj rk r r r r r� rl r� r� rm rn ro rp rq r� r� rr r� r� r� r� rs r� ZCryptography_HAS_ALPNr` r� r_ rt ru rv ZSSL_library_initr| r| r| r} �<module> s2 , _ �� � (=C; � � Y __pycache__/__init__.cpython-39.opt-1.pyc 0000644 00000001032 15025013455 0014077 0 ustar 00 a �Sa� � @ sH d Z ddlmZmZ ddlmZmZmZmZm Z m Z m Z m Z g d�Z dS )z9 pyOpenSSL - A simple wrapper around the OpenSSL library � )�crypto�SSL)� __author__� __copyright__� __email__� __license__� __summary__� __title__�__uri__� __version__) r r r r r r r r r r N)�__doc__ZOpenSSLr r ZOpenSSL.versionr r r r r r r r �__all__� r r �4/usr/lib/python3.9/site-packages/OpenSSL/__init__.py�<module> s ( __pycache__/_util.cpython-39.opt-1.pyc 0000644 00000010131 15025013455 0013454 0 ustar 00 a �Sae � @ s� d dl Z d dlZd dlmZmZ d dlmZ e� Ze�� ej Z ej Z e j dd�Z dd� Z dd � Zd d � Zd d � Zdd� Zer�dd� Zndd� Ze� Zejd Zdd� ZdS )� N)�PY2� text_type)�BindingF)Zshould_clear_after_allocc C s | sdS t t�| ��S )z� Get a native string type representing of the given CFFI ``char*`` object. :param charp: A C-style string represented using CFFI. :return: :class:`str` � )�native�ffi�string)Zcharp� r �1/usr/lib/python3.9/site-packages/OpenSSL/_util.py�text s r c C sR g }t �� }|dkrqF|�tt �|��tt �|��tt �|��f� q| |��dS )ac Convert an OpenSSL library failure into a Python exception. When a call to the native OpenSSL library fails, this is usually signalled by the return value, and an error code is stored in an error queue associated with the current thread. The err library provides functions to obtain these error codes and textual error messages. r N)�libZ ERR_get_error�appendr ZERR_lib_error_stringZERR_func_error_stringZERR_reason_error_string)Zexception_type�errors�errorr r r �exception_from_error_queue" s ��r c s � fdd�}|S )z~ Create an assert function that uses :func:`exception_from_error_queue` to raise an exception wrapped by *error*. c s | durt � � dS )zT If *ok* is not True, retrieve the error from OpenSSL and raise it. TN)r )�ok�r r r �openssl_assertB s z#make_assert.<locals>.openssl_assertr )r r r r r � make_assert< s r c C sL t | ttf�std| ��tr4t | t�rH| �d�S nt | t�rH| �d�S | S )a6 Convert :py:class:`bytes` or :py:class:`unicode` to the native :py:class:`str` type, using UTF-8 encoding if conversion is necessary. :raise UnicodeError: The input string is not UTF-8 decodeable. :raise TypeError: The input is neither :py:class:`bytes` nor :py:class:`unicode`. z %r is neither bytes nor unicode�utf-8)� isinstance�bytesr � TypeErrorr �encode�decode��sr r r r L s r c C s2 t | t�r| S t | t�r&| �t�� �S td��dS )a Convert a Python string to a :py:class:`bytes` string identifying the same path and which can be passed into an OpenSSL API accepting a filename. :param s: An instance of :py:class:`bytes` or :py:class:`unicode`. :return: An instance of :py:class:`bytes`. z3Path must be represented as bytes or unicode stringN)r r r r �sys�getfilesystemencodingr r r r r � path_stringa s r c C s | S )Nr r r r r � byte_stringt s r c C s | � d�S )N�charmap)r r r r r r z s z) for {0} is no longer accepted, use bytesc C s. t |t�r*tjt�| �tdd� |�d�S |S )a� If ``obj`` is text, emit a warning that it should be bytes instead and try to convert it to bytes automatically. :param str label: The name of the parameter from which ``obj`` was taken (so a developer can easily find the source of the problem and correct it). :return: If ``obj`` is the text string type, a ``bytes`` object giving the UTF-8 encoding of that text is returned. Otherwise, ``obj`` itself is returned. � )�category� stacklevelr )r r �warnings�warn� _TEXT_WARNING�format�DeprecationWarningr )Zlabel�objr r r �text_to_bytes_and_warn� s � r+ )r r% Zsixr r Z,cryptography.hazmat.bindings.openssl.bindingr ZbindingZinit_static_locksr r Z new_allocatorZno_zero_allocatorr r r r r r �objectZ UNSPECIFIED�__name__r' r+ r r r r �<module> s( � __pycache__/version.cpython-39.pyc 0000644 00000001171 15025013455 0013072 0 ustar 00 a �Sa� � @ s6 d Z g d�ZdZdZdZdZdZdZdZd � e�Z d S ) z9 pyOpenSSL - A simple wrapper around the OpenSSL library )� __author__� __copyright__� __email__� __license__� __summary__� __title__�__uri__� __version__z21.0.0Z pyOpenSSLzhttps://pyopenssl.org/z0Python wrapper module around the OpenSSL libraryzThe pyOpenSSL developerszcryptography-dev@python.orgzApache License, Version 2.0zCopyright 2001-2020 {0}N) �__doc__�__all__r r r r r r r �formatr � r r �3/usr/lib/python3.9/site-packages/OpenSSL/version.py�<module> s _util.py 0000644 00000010145 15025013455 0006233 0 ustar 00 import sys import warnings from six import PY2, text_type from cryptography.hazmat.bindings.openssl.binding import Binding binding = Binding() binding.init_static_locks() ffi = binding.ffi lib = binding.lib # This is a special CFFI allocator that does not bother to zero its memory # after allocation. This has vastly better performance on large allocations and # so should be used whenever we don't need the memory zeroed out. no_zero_allocator = ffi.new_allocator(should_clear_after_alloc=False) def text(charp): """ Get a native string type representing of the given CFFI ``char*`` object. :param charp: A C-style string represented using CFFI. :return: :class:`str` """ if not charp: return "" return native(ffi.string(charp)) def exception_from_error_queue(exception_type): """ Convert an OpenSSL library failure into a Python exception. When a call to the native OpenSSL library fails, this is usually signalled by the return value, and an error code is stored in an error queue associated with the current thread. The err library provides functions to obtain these error codes and textual error messages. """ errors = [] while True: error = lib.ERR_get_error() if error == 0: break errors.append( ( text(lib.ERR_lib_error_string(error)), text(lib.ERR_func_error_string(error)), text(lib.ERR_reason_error_string(error)), ) ) raise exception_type(errors) def make_assert(error): """ Create an assert function that uses :func:`exception_from_error_queue` to raise an exception wrapped by *error*. """ def openssl_assert(ok): """ If *ok* is not True, retrieve the error from OpenSSL and raise it. """ if ok is not True: exception_from_error_queue(error) return openssl_assert def native(s): """ Convert :py:class:`bytes` or :py:class:`unicode` to the native :py:class:`str` type, using UTF-8 encoding if conversion is necessary. :raise UnicodeError: The input string is not UTF-8 decodeable. :raise TypeError: The input is neither :py:class:`bytes` nor :py:class:`unicode`. """ if not isinstance(s, (bytes, text_type)): raise TypeError("%r is neither bytes nor unicode" % s) if PY2: if isinstance(s, text_type): return s.encode("utf-8") else: if isinstance(s, bytes): return s.decode("utf-8") return s def path_string(s): """ Convert a Python string to a :py:class:`bytes` string identifying the same path and which can be passed into an OpenSSL API accepting a filename. :param s: An instance of :py:class:`bytes` or :py:class:`unicode`. :return: An instance of :py:class:`bytes`. """ if isinstance(s, bytes): return s elif isinstance(s, text_type): return s.encode(sys.getfilesystemencoding()) else: raise TypeError("Path must be represented as bytes or unicode string") if PY2: def byte_string(s): return s else: def byte_string(s): return s.encode("charmap") # A marker object to observe whether some optional arguments are passed any # value or not. UNSPECIFIED = object() _TEXT_WARNING = ( text_type.__name__ + " for {0} is no longer accepted, use bytes" ) def text_to_bytes_and_warn(label, obj): """ If ``obj`` is text, emit a warning that it should be bytes instead and try to convert it to bytes automatically. :param str label: The name of the parameter from which ``obj`` was taken (so a developer can easily find the source of the problem and correct it). :return: If ``obj`` is the text string type, a ``bytes`` object giving the UTF-8 encoding of that text is returned. Otherwise, ``obj`` itself is returned. """ if isinstance(obj, text_type): warnings.warn( _TEXT_WARNING.format(label), category=DeprecationWarning, stacklevel=3, ) return obj.encode("utf-8") return obj crypto.py 0000644 00000315723 15025013455 0006451 0 ustar 00 import calendar import datetime from base64 import b16encode from functools import partial from operator import __eq__, __ne__, __lt__, __le__, __gt__, __ge__ from six import ( integer_types as _integer_types, text_type as _text_type, PY2 as _PY2, ) from cryptography import utils, x509 from cryptography.hazmat.primitives.asymmetric import dsa, rsa from OpenSSL._util import ( ffi as _ffi, lib as _lib, exception_from_error_queue as _exception_from_error_queue, byte_string as _byte_string, native as _native, path_string as _path_string, UNSPECIFIED as _UNSPECIFIED, text_to_bytes_and_warn as _text_to_bytes_and_warn, make_assert as _make_assert, ) __all__ = [ "FILETYPE_PEM", "FILETYPE_ASN1", "FILETYPE_TEXT", "TYPE_RSA", "TYPE_DSA", "Error", "PKey", "get_elliptic_curves", "get_elliptic_curve", "X509Name", "X509Extension", "X509Req", "X509", "X509StoreFlags", "X509Store", "X509StoreContextError", "X509StoreContext", "load_certificate", "dump_certificate", "dump_publickey", "dump_privatekey", "Revoked", "CRL", "PKCS7", "PKCS12", "NetscapeSPKI", "load_publickey", "load_privatekey", "dump_certificate_request", "load_certificate_request", "sign", "verify", "dump_crl", "load_crl", "load_pkcs7_data", "load_pkcs12", ] FILETYPE_PEM = _lib.SSL_FILETYPE_PEM FILETYPE_ASN1 = _lib.SSL_FILETYPE_ASN1 # TODO This was an API mistake. OpenSSL has no such constant. FILETYPE_TEXT = 2 ** 16 - 1 TYPE_RSA = _lib.EVP_PKEY_RSA TYPE_DSA = _lib.EVP_PKEY_DSA TYPE_DH = _lib.EVP_PKEY_DH TYPE_EC = _lib.EVP_PKEY_EC class Error(Exception): """ An error occurred in an `OpenSSL.crypto` API. """ _raise_current_error = partial(_exception_from_error_queue, Error) _openssl_assert = _make_assert(Error) def _get_backend(): """ Importing the backend from cryptography has the side effect of activating the osrandom engine. This mutates the global state of OpenSSL in the process and causes issues for various programs that use subinterpreters or embed Python. By putting the import in this function we can avoid triggering this side effect unless _get_backend is called. """ from cryptography.hazmat.backends.openssl.backend import backend return backend def _untested_error(where): """ An OpenSSL API failed somehow. Additionally, the failure which was encountered isn't one that's exercised by the test suite so future behavior of pyOpenSSL is now somewhat less predictable. """ raise RuntimeError("Unknown %s failure" % (where,)) def _new_mem_buf(buffer=None): """ Allocate a new OpenSSL memory BIO. Arrange for the garbage collector to clean it up automatically. :param buffer: None or some bytes to use to put into the BIO so that they can be read out. """ if buffer is None: bio = _lib.BIO_new(_lib.BIO_s_mem()) free = _lib.BIO_free else: data = _ffi.new("char[]", buffer) bio = _lib.BIO_new_mem_buf(data, len(buffer)) # Keep the memory alive as long as the bio is alive! def free(bio, ref=data): return _lib.BIO_free(bio) _openssl_assert(bio != _ffi.NULL) bio = _ffi.gc(bio, free) return bio def _bio_to_string(bio): """ Copy the contents of an OpenSSL BIO object into a Python byte string. """ result_buffer = _ffi.new("char**") buffer_length = _lib.BIO_get_mem_data(bio, result_buffer) return _ffi.buffer(result_buffer[0], buffer_length)[:] def _set_asn1_time(boundary, when): """ The the time value of an ASN1 time object. @param boundary: An ASN1_TIME pointer (or an object safely castable to that type) which will have its value set. @param when: A string representation of the desired time value. @raise TypeError: If C{when} is not a L{bytes} string. @raise ValueError: If C{when} does not represent a time in the required format. @raise RuntimeError: If the time value cannot be set for some other (unspecified) reason. """ if not isinstance(when, bytes): raise TypeError("when must be a byte string") set_result = _lib.ASN1_TIME_set_string(boundary, when) if set_result == 0: raise ValueError("Invalid string") def _get_asn1_time(timestamp): """ Retrieve the time value of an ASN1 time object. @param timestamp: An ASN1_GENERALIZEDTIME* (or an object safely castable to that type) from which the time value will be retrieved. @return: The time value from C{timestamp} as a L{bytes} string in a certain format. Or C{None} if the object contains no time value. """ string_timestamp = _ffi.cast("ASN1_STRING*", timestamp) if _lib.ASN1_STRING_length(string_timestamp) == 0: return None elif ( _lib.ASN1_STRING_type(string_timestamp) == _lib.V_ASN1_GENERALIZEDTIME ): return _ffi.string(_lib.ASN1_STRING_data(string_timestamp)) else: generalized_timestamp = _ffi.new("ASN1_GENERALIZEDTIME**") _lib.ASN1_TIME_to_generalizedtime(timestamp, generalized_timestamp) if generalized_timestamp[0] == _ffi.NULL: # This may happen: # - if timestamp was not an ASN1_TIME # - if allocating memory for the ASN1_GENERALIZEDTIME failed # - if a copy of the time data from timestamp cannot be made for # the newly allocated ASN1_GENERALIZEDTIME # # These are difficult to test. cffi enforces the ASN1_TIME type. # Memory allocation failures are a pain to trigger # deterministically. _untested_error("ASN1_TIME_to_generalizedtime") else: string_timestamp = _ffi.cast( "ASN1_STRING*", generalized_timestamp[0] ) string_data = _lib.ASN1_STRING_data(string_timestamp) string_result = _ffi.string(string_data) _lib.ASN1_GENERALIZEDTIME_free(generalized_timestamp[0]) return string_result class _X509NameInvalidator(object): def __init__(self): self._names = [] def add(self, name): self._names.append(name) def clear(self): for name in self._names: # Breaks the object, but also prevents UAF! del name._name class PKey(object): """ A class representing an DSA or RSA public key or key pair. """ _only_public = False _initialized = True def __init__(self): pkey = _lib.EVP_PKEY_new() self._pkey = _ffi.gc(pkey, _lib.EVP_PKEY_free) self._initialized = False def to_cryptography_key(self): """ Export as a ``cryptography`` key. :rtype: One of ``cryptography``'s `key interfaces`_. .. _key interfaces: https://cryptography.io/en/latest/hazmat/\ primitives/asymmetric/rsa/#key-interfaces .. versionadded:: 16.1.0 """ from cryptography.hazmat.primitives.serialization import ( load_der_private_key, load_der_public_key, ) backend = _get_backend() if self._only_public: der = dump_publickey(FILETYPE_ASN1, self) return load_der_public_key(der, backend) else: der = dump_privatekey(FILETYPE_ASN1, self) return load_der_private_key(der, None, backend) @classmethod def from_cryptography_key(cls, crypto_key): """ Construct based on a ``cryptography`` *crypto_key*. :param crypto_key: A ``cryptography`` key. :type crypto_key: One of ``cryptography``'s `key interfaces`_. :rtype: PKey .. versionadded:: 16.1.0 """ if not isinstance( crypto_key, ( rsa.RSAPublicKey, rsa.RSAPrivateKey, dsa.DSAPublicKey, dsa.DSAPrivateKey, ), ): raise TypeError("Unsupported key type") from cryptography.hazmat.primitives.serialization import ( Encoding, NoEncryption, PrivateFormat, PublicFormat, ) if isinstance(crypto_key, (rsa.RSAPublicKey, dsa.DSAPublicKey)): return load_publickey( FILETYPE_ASN1, crypto_key.public_bytes( Encoding.DER, PublicFormat.SubjectPublicKeyInfo ), ) else: der = crypto_key.private_bytes( Encoding.DER, PrivateFormat.PKCS8, NoEncryption() ) return load_privatekey(FILETYPE_ASN1, der) def generate_key(self, type, bits): """ Generate a key pair of the given type, with the given number of bits. This generates a key "into" the this object. :param type: The key type. :type type: :py:data:`TYPE_RSA` or :py:data:`TYPE_DSA` :param bits: The number of bits. :type bits: :py:data:`int` ``>= 0`` :raises TypeError: If :py:data:`type` or :py:data:`bits` isn't of the appropriate type. :raises ValueError: If the number of bits isn't an integer of the appropriate size. :return: ``None`` """ if not isinstance(type, int): raise TypeError("type must be an integer") if not isinstance(bits, int): raise TypeError("bits must be an integer") if type == TYPE_RSA: if bits <= 0: raise ValueError("Invalid number of bits") # TODO Check error return exponent = _lib.BN_new() exponent = _ffi.gc(exponent, _lib.BN_free) _lib.BN_set_word(exponent, _lib.RSA_F4) rsa = _lib.RSA_new() result = _lib.RSA_generate_key_ex(rsa, bits, exponent, _ffi.NULL) _openssl_assert(result == 1) result = _lib.EVP_PKEY_assign_RSA(self._pkey, rsa) _openssl_assert(result == 1) elif type == TYPE_DSA: dsa = _lib.DSA_new() _openssl_assert(dsa != _ffi.NULL) dsa = _ffi.gc(dsa, _lib.DSA_free) res = _lib.DSA_generate_parameters_ex( dsa, bits, _ffi.NULL, 0, _ffi.NULL, _ffi.NULL, _ffi.NULL ) _openssl_assert(res == 1) _openssl_assert(_lib.DSA_generate_key(dsa) == 1) _openssl_assert(_lib.EVP_PKEY_set1_DSA(self._pkey, dsa) == 1) else: raise Error("No such key type") self._initialized = True def check(self): """ Check the consistency of an RSA private key. This is the Python equivalent of OpenSSL's ``RSA_check_key``. :return: ``True`` if key is consistent. :raise OpenSSL.crypto.Error: if the key is inconsistent. :raise TypeError: if the key is of a type which cannot be checked. Only RSA keys can currently be checked. """ if self._only_public: raise TypeError("public key only") if _lib.EVP_PKEY_type(self.type()) != _lib.EVP_PKEY_RSA: raise TypeError("key type unsupported") rsa = _lib.EVP_PKEY_get1_RSA(self._pkey) rsa = _ffi.gc(rsa, _lib.RSA_free) result = _lib.RSA_check_key(rsa) if result == 1: return True _raise_current_error() def type(self): """ Returns the type of the key :return: The type of the key. """ return _lib.EVP_PKEY_id(self._pkey) def bits(self): """ Returns the number of bits of the key :return: The number of bits of the key. """ return _lib.EVP_PKEY_bits(self._pkey) class _EllipticCurve(object): """ A representation of a supported elliptic curve. @cvar _curves: :py:obj:`None` until an attempt is made to load the curves. Thereafter, a :py:type:`set` containing :py:type:`_EllipticCurve` instances each of which represents one curve supported by the system. @type _curves: :py:type:`NoneType` or :py:type:`set` """ _curves = None if not _PY2: # This only necessary on Python 3. Moreover, it is broken on Python 2. def __ne__(self, other): """ Implement cooperation with the right-hand side argument of ``!=``. Python 3 seems to have dropped this cooperation in this very narrow circumstance. """ if isinstance(other, _EllipticCurve): return super(_EllipticCurve, self).__ne__(other) return NotImplemented @classmethod def _load_elliptic_curves(cls, lib): """ Get the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. """ num_curves = lib.EC_get_builtin_curves(_ffi.NULL, 0) builtin_curves = _ffi.new("EC_builtin_curve[]", num_curves) # The return value on this call should be num_curves again. We # could check it to make sure but if it *isn't* then.. what could # we do? Abort the whole process, I suppose...? -exarkun lib.EC_get_builtin_curves(builtin_curves, num_curves) return set(cls.from_nid(lib, c.nid) for c in builtin_curves) @classmethod def _get_elliptic_curves(cls, lib): """ Get, cache, and return the curves supported by OpenSSL. :param lib: The OpenSSL library binding object. :return: A :py:type:`set` of ``cls`` instances giving the names of the elliptic curves the underlying library supports. """ if cls._curves is None: cls._curves = cls._load_elliptic_curves(lib) return cls._curves @classmethod def from_nid(cls, lib, nid): """ Instantiate a new :py:class:`_EllipticCurve` associated with the given OpenSSL NID. :param lib: The OpenSSL library binding object. :param nid: The OpenSSL NID the resulting curve object will represent. This must be a curve NID (and not, for example, a hash NID) or subsequent operations will fail in unpredictable ways. :type nid: :py:class:`int` :return: The curve object. """ return cls(lib, nid, _ffi.string(lib.OBJ_nid2sn(nid)).decode("ascii")) def __init__(self, lib, nid, name): """ :param _lib: The :py:mod:`cryptography` binding instance used to interface with OpenSSL. :param _nid: The OpenSSL NID identifying the curve this object represents. :type _nid: :py:class:`int` :param name: The OpenSSL short name identifying the curve this object represents. :type name: :py:class:`unicode` """ self._lib = lib self._nid = nid self.name = name def __repr__(self): return "<Curve %r>" % (self.name,) def _to_EC_KEY(self): """ Create a new OpenSSL EC_KEY structure initialized to use this curve. The structure is automatically garbage collected when the Python object is garbage collected. """ key = self._lib.EC_KEY_new_by_curve_name(self._nid) return _ffi.gc(key, _lib.EC_KEY_free) def get_elliptic_curves(): """ Return a set of objects representing the elliptic curves supported in the OpenSSL build in use. The curve objects have a :py:class:`unicode` ``name`` attribute by which they identify themselves. The curve objects are useful as values for the argument accepted by :py:meth:`Context.set_tmp_ecdh` to specify which elliptical curve should be used for ECDHE key exchange. """ return _EllipticCurve._get_elliptic_curves(_lib) def get_elliptic_curve(name): """ Return a single curve object selected by name. See :py:func:`get_elliptic_curves` for information about curve objects. :param name: The OpenSSL short name identifying the curve object to retrieve. :type name: :py:class:`unicode` If the named curve is not supported then :py:class:`ValueError` is raised. """ for curve in get_elliptic_curves(): if curve.name == name: return curve raise ValueError("unknown curve name", name) class X509Name(object): """ An X.509 Distinguished Name. :ivar countryName: The country of the entity. :ivar C: Alias for :py:attr:`countryName`. :ivar stateOrProvinceName: The state or province of the entity. :ivar ST: Alias for :py:attr:`stateOrProvinceName`. :ivar localityName: The locality of the entity. :ivar L: Alias for :py:attr:`localityName`. :ivar organizationName: The organization name of the entity. :ivar O: Alias for :py:attr:`organizationName`. :ivar organizationalUnitName: The organizational unit of the entity. :ivar OU: Alias for :py:attr:`organizationalUnitName` :ivar commonName: The common name of the entity. :ivar CN: Alias for :py:attr:`commonName`. :ivar emailAddress: The e-mail address of the entity. """ def __init__(self, name): """ Create a new X509Name, copying the given X509Name instance. :param name: The name to copy. :type name: :py:class:`X509Name` """ name = _lib.X509_NAME_dup(name._name) self._name = _ffi.gc(name, _lib.X509_NAME_free) def __setattr__(self, name, value): if name.startswith("_"): return super(X509Name, self).__setattr__(name, value) # Note: we really do not want str subclasses here, so we do not use # isinstance. if type(name) is not str: raise TypeError( "attribute name must be string, not '%.200s'" % (type(value).__name__,) ) nid = _lib.OBJ_txt2nid(_byte_string(name)) if nid == _lib.NID_undef: try: _raise_current_error() except Error: pass raise AttributeError("No such attribute") # If there's an old entry for this NID, remove it for i in range(_lib.X509_NAME_entry_count(self._name)): ent = _lib.X509_NAME_get_entry(self._name, i) ent_obj = _lib.X509_NAME_ENTRY_get_object(ent) ent_nid = _lib.OBJ_obj2nid(ent_obj) if nid == ent_nid: ent = _lib.X509_NAME_delete_entry(self._name, i) _lib.X509_NAME_ENTRY_free(ent) break if isinstance(value, _text_type): value = value.encode("utf-8") add_result = _lib.X509_NAME_add_entry_by_NID( self._name, nid, _lib.MBSTRING_UTF8, value, -1, -1, 0 ) if not add_result: _raise_current_error() def __getattr__(self, name): """ Find attribute. An X509Name object has the following attributes: countryName (alias C), stateOrProvince (alias ST), locality (alias L), organization (alias O), organizationalUnit (alias OU), commonName (alias CN) and more... """ nid = _lib.OBJ_txt2nid(_byte_string(name)) if nid == _lib.NID_undef: # This is a bit weird. OBJ_txt2nid indicated failure, but it seems # a lower level function, a2d_ASN1_OBJECT, also feels the need to # push something onto the error queue. If we don't clean that up # now, someone else will bump into it later and be quite confused. # See lp#314814. try: _raise_current_error() except Error: pass return super(X509Name, self).__getattr__(name) entry_index = _lib.X509_NAME_get_index_by_NID(self._name, nid, -1) if entry_index == -1: return None entry = _lib.X509_NAME_get_entry(self._name, entry_index) data = _lib.X509_NAME_ENTRY_get_data(entry) result_buffer = _ffi.new("unsigned char**") data_length = _lib.ASN1_STRING_to_UTF8(result_buffer, data) _openssl_assert(data_length >= 0) try: result = _ffi.buffer(result_buffer[0], data_length)[:].decode( "utf-8" ) finally: # XXX untested _lib.OPENSSL_free(result_buffer[0]) return result def _cmp(op): def f(self, other): if not isinstance(other, X509Name): return NotImplemented result = _lib.X509_NAME_cmp(self._name, other._name) return op(result, 0) return f __eq__ = _cmp(__eq__) __ne__ = _cmp(__ne__) __lt__ = _cmp(__lt__) __le__ = _cmp(__le__) __gt__ = _cmp(__gt__) __ge__ = _cmp(__ge__) def __repr__(self): """ String representation of an X509Name """ result_buffer = _ffi.new("char[]", 512) format_result = _lib.X509_NAME_oneline( self._name, result_buffer, len(result_buffer) ) _openssl_assert(format_result != _ffi.NULL) return "<X509Name object '%s'>" % ( _native(_ffi.string(result_buffer)), ) def hash(self): """ Return an integer representation of the first four bytes of the MD5 digest of the DER representation of the name. This is the Python equivalent of OpenSSL's ``X509_NAME_hash``. :return: The (integer) hash of this name. :rtype: :py:class:`int` """ return _lib.X509_NAME_hash(self._name) def der(self): """ Return the DER encoding of this name. :return: The DER encoded form of this name. :rtype: :py:class:`bytes` """ result_buffer = _ffi.new("unsigned char**") encode_result = _lib.i2d_X509_NAME(self._name, result_buffer) _openssl_assert(encode_result >= 0) string_result = _ffi.buffer(result_buffer[0], encode_result)[:] _lib.OPENSSL_free(result_buffer[0]) return string_result def get_components(self): """ Returns the components of this name, as a sequence of 2-tuples. :return: The components of this name. :rtype: :py:class:`list` of ``name, value`` tuples. """ result = [] for i in range(_lib.X509_NAME_entry_count(self._name)): ent = _lib.X509_NAME_get_entry(self._name, i) fname = _lib.X509_NAME_ENTRY_get_object(ent) fval = _lib.X509_NAME_ENTRY_get_data(ent) nid = _lib.OBJ_obj2nid(fname) name = _lib.OBJ_nid2sn(nid) # ffi.string does not handle strings containing NULL bytes # (which may have been generated by old, broken software) value = _ffi.buffer( _lib.ASN1_STRING_data(fval), _lib.ASN1_STRING_length(fval) )[:] result.append((_ffi.string(name), value)) return result class X509Extension(object): """ An X.509 v3 certificate extension. """ def __init__(self, type_name, critical, value, subject=None, issuer=None): """ Initializes an X509 extension. :param type_name: The name of the type of extension_ to create. :type type_name: :py:data:`bytes` :param bool critical: A flag indicating whether this is a critical extension. :param value: The value of the extension. :type value: :py:data:`bytes` :param subject: Optional X509 certificate to use as subject. :type subject: :py:class:`X509` :param issuer: Optional X509 certificate to use as issuer. :type issuer: :py:class:`X509` .. _extension: https://www.openssl.org/docs/manmaster/man5/ x509v3_config.html#STANDARD-EXTENSIONS """ ctx = _ffi.new("X509V3_CTX*") # A context is necessary for any extension which uses the r2i # conversion method. That is, X509V3_EXT_nconf may segfault if passed # a NULL ctx. Start off by initializing most of the fields to NULL. _lib.X509V3_set_ctx(ctx, _ffi.NULL, _ffi.NULL, _ffi.NULL, _ffi.NULL, 0) # We have no configuration database - but perhaps we should (some # extensions may require it). _lib.X509V3_set_ctx_nodb(ctx) # Initialize the subject and issuer, if appropriate. ctx is a local, # and as far as I can tell none of the X509V3_* APIs invoked here steal # any references, so no need to mess with reference counts or # duplicates. if issuer is not None: if not isinstance(issuer, X509): raise TypeError("issuer must be an X509 instance") ctx.issuer_cert = issuer._x509 if subject is not None: if not isinstance(subject, X509): raise TypeError("subject must be an X509 instance") ctx.subject_cert = subject._x509 if critical: # There are other OpenSSL APIs which would let us pass in critical # separately, but they're harder to use, and since value is already # a pile of crappy junk smuggling a ton of utterly important # structured data, what's the point of trying to avoid nasty stuff # with strings? (However, X509V3_EXT_i2d in particular seems like # it would be a better API to invoke. I do not know where to get # the ext_struc it desires for its last parameter, though.) value = b"critical," + value extension = _lib.X509V3_EXT_nconf(_ffi.NULL, ctx, type_name, value) if extension == _ffi.NULL: _raise_current_error() self._extension = _ffi.gc(extension, _lib.X509_EXTENSION_free) @property def _nid(self): return _lib.OBJ_obj2nid( _lib.X509_EXTENSION_get_object(self._extension) ) _prefixes = { _lib.GEN_EMAIL: "email", _lib.GEN_DNS: "DNS", _lib.GEN_URI: "URI", } def _subjectAltNameString(self): names = _ffi.cast( "GENERAL_NAMES*", _lib.X509V3_EXT_d2i(self._extension) ) names = _ffi.gc(names, _lib.GENERAL_NAMES_free) parts = [] for i in range(_lib.sk_GENERAL_NAME_num(names)): name = _lib.sk_GENERAL_NAME_value(names, i) try: label = self._prefixes[name.type] except KeyError: bio = _new_mem_buf() _lib.GENERAL_NAME_print(bio, name) parts.append(_native(_bio_to_string(bio))) else: value = _native( _ffi.buffer(name.d.ia5.data, name.d.ia5.length)[:] ) parts.append(label + ":" + value) return ", ".join(parts) def __str__(self): """ :return: a nice text representation of the extension """ if _lib.NID_subject_alt_name == self._nid: return self._subjectAltNameString() bio = _new_mem_buf() print_result = _lib.X509V3_EXT_print(bio, self._extension, 0, 0) _openssl_assert(print_result != 0) return _native(_bio_to_string(bio)) def get_critical(self): """ Returns the critical field of this X.509 extension. :return: The critical field. """ return _lib.X509_EXTENSION_get_critical(self._extension) def get_short_name(self): """ Returns the short type name of this X.509 extension. The result is a byte string such as :py:const:`b"basicConstraints"`. :return: The short type name. :rtype: :py:data:`bytes` .. versionadded:: 0.12 """ obj = _lib.X509_EXTENSION_get_object(self._extension) nid = _lib.OBJ_obj2nid(obj) return _ffi.string(_lib.OBJ_nid2sn(nid)) def get_data(self): """ Returns the data of the X509 extension, encoded as ASN.1. :return: The ASN.1 encoded data of this X509 extension. :rtype: :py:data:`bytes` .. versionadded:: 0.12 """ octet_result = _lib.X509_EXTENSION_get_data(self._extension) string_result = _ffi.cast("ASN1_STRING*", octet_result) char_result = _lib.ASN1_STRING_data(string_result) result_length = _lib.ASN1_STRING_length(string_result) return _ffi.buffer(char_result, result_length)[:] class X509Req(object): """ An X.509 certificate signing requests. """ def __init__(self): req = _lib.X509_REQ_new() self._req = _ffi.gc(req, _lib.X509_REQ_free) # Default to version 0. self.set_version(0) def to_cryptography(self): """ Export as a ``cryptography`` certificate signing request. :rtype: ``cryptography.x509.CertificateSigningRequest`` .. versionadded:: 17.1.0 """ from cryptography.x509 import load_der_x509_csr der = dump_certificate_request(FILETYPE_ASN1, self) backend = _get_backend() return load_der_x509_csr(der, backend) @classmethod def from_cryptography(cls, crypto_req): """ Construct based on a ``cryptography`` *crypto_req*. :param crypto_req: A ``cryptography`` X.509 certificate signing request :type crypto_req: ``cryptography.x509.CertificateSigningRequest`` :rtype: X509Req .. versionadded:: 17.1.0 """ if not isinstance(crypto_req, x509.CertificateSigningRequest): raise TypeError("Must be a certificate signing request") from cryptography.hazmat.primitives.serialization import Encoding der = crypto_req.public_bytes(Encoding.DER) return load_certificate_request(FILETYPE_ASN1, der) def set_pubkey(self, pkey): """ Set the public key of the certificate signing request. :param pkey: The public key to use. :type pkey: :py:class:`PKey` :return: ``None`` """ set_result = _lib.X509_REQ_set_pubkey(self._req, pkey._pkey) _openssl_assert(set_result == 1) def get_pubkey(self): """ Get the public key of the certificate signing request. :return: The public key. :rtype: :py:class:`PKey` """ pkey = PKey.__new__(PKey) pkey._pkey = _lib.X509_REQ_get_pubkey(self._req) _openssl_assert(pkey._pkey != _ffi.NULL) pkey._pkey = _ffi.gc(pkey._pkey, _lib.EVP_PKEY_free) pkey._only_public = True return pkey def set_version(self, version): """ Set the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :param int version: The version number. :return: ``None`` """ set_result = _lib.X509_REQ_set_version(self._req, version) _openssl_assert(set_result == 1) def get_version(self): """ Get the version subfield (RFC 2459, section 4.1.2.1) of the certificate request. :return: The value of the version subfield. :rtype: :py:class:`int` """ return _lib.X509_REQ_get_version(self._req) def get_subject(self): """ Return the subject of this certificate signing request. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate signing request. Modifying it will modify the underlying signing request, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate signing request. :rtype: :class:`X509Name` """ name = X509Name.__new__(X509Name) name._name = _lib.X509_REQ_get_subject_name(self._req) _openssl_assert(name._name != _ffi.NULL) # The name is owned by the X509Req structure. As long as the X509Name # Python object is alive, keep the X509Req Python object alive. name._owner = self return name def add_extensions(self, extensions): """ Add extensions to the certificate signing request. :param extensions: The X.509 extensions to add. :type extensions: iterable of :py:class:`X509Extension` :return: ``None`` """ stack = _lib.sk_X509_EXTENSION_new_null() _openssl_assert(stack != _ffi.NULL) stack = _ffi.gc(stack, _lib.sk_X509_EXTENSION_free) for ext in extensions: if not isinstance(ext, X509Extension): raise ValueError("One of the elements is not an X509Extension") # TODO push can fail (here and elsewhere) _lib.sk_X509_EXTENSION_push(stack, ext._extension) add_result = _lib.X509_REQ_add_extensions(self._req, stack) _openssl_assert(add_result == 1) def get_extensions(self): """ Get X.509 extensions in the certificate signing request. :return: The X.509 extensions in this request. :rtype: :py:class:`list` of :py:class:`X509Extension` objects. .. versionadded:: 0.15 """ exts = [] native_exts_obj = _lib.X509_REQ_get_extensions(self._req) native_exts_obj = _ffi.gc( native_exts_obj, lambda x: _lib.sk_X509_EXTENSION_pop_free( x, _ffi.addressof(_lib._original_lib, "X509_EXTENSION_free"), ), ) for i in range(_lib.sk_X509_EXTENSION_num(native_exts_obj)): ext = X509Extension.__new__(X509Extension) extension = _lib.X509_EXTENSION_dup( _lib.sk_X509_EXTENSION_value(native_exts_obj, i) ) ext._extension = _ffi.gc(extension, _lib.X509_EXTENSION_free) exts.append(ext) return exts def sign(self, pkey, digest): """ Sign the certificate signing request with this key and digest type. :param pkey: The key pair to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use for the signature, e.g. :py:data:`b"sha256"`. :type digest: :py:class:`bytes` :return: ``None`` """ if pkey._only_public: raise ValueError("Key has only public part") if not pkey._initialized: raise ValueError("Key is uninitialized") digest_obj = _lib.EVP_get_digestbyname(_byte_string(digest)) if digest_obj == _ffi.NULL: raise ValueError("No such digest method") sign_result = _lib.X509_REQ_sign(self._req, pkey._pkey, digest_obj) _openssl_assert(sign_result > 0) def verify(self, pkey): """ Verifies the signature on this certificate signing request. :param PKey key: A public key. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid or there is a problem verifying the signature. """ if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey instance") result = _lib.X509_REQ_verify(self._req, pkey._pkey) if result <= 0: _raise_current_error() return result class X509(object): """ An X.509 certificate. """ def __init__(self): x509 = _lib.X509_new() _openssl_assert(x509 != _ffi.NULL) self._x509 = _ffi.gc(x509, _lib.X509_free) self._issuer_invalidator = _X509NameInvalidator() self._subject_invalidator = _X509NameInvalidator() @classmethod def _from_raw_x509_ptr(cls, x509): cert = cls.__new__(cls) cert._x509 = _ffi.gc(x509, _lib.X509_free) cert._issuer_invalidator = _X509NameInvalidator() cert._subject_invalidator = _X509NameInvalidator() return cert def to_cryptography(self): """ Export as a ``cryptography`` certificate. :rtype: ``cryptography.x509.Certificate`` .. versionadded:: 17.1.0 """ from cryptography.x509 import load_der_x509_certificate der = dump_certificate(FILETYPE_ASN1, self) backend = _get_backend() return load_der_x509_certificate(der, backend) @classmethod def from_cryptography(cls, crypto_cert): """ Construct based on a ``cryptography`` *crypto_cert*. :param crypto_key: A ``cryptography`` X.509 certificate. :type crypto_key: ``cryptography.x509.Certificate`` :rtype: X509 .. versionadded:: 17.1.0 """ if not isinstance(crypto_cert, x509.Certificate): raise TypeError("Must be a certificate") from cryptography.hazmat.primitives.serialization import Encoding der = crypto_cert.public_bytes(Encoding.DER) return load_certificate(FILETYPE_ASN1, der) def set_version(self, version): """ Set the version number of the certificate. Note that the version value is zero-based, eg. a value of 0 is V1. :param version: The version number of the certificate. :type version: :py:class:`int` :return: ``None`` """ if not isinstance(version, int): raise TypeError("version must be an integer") _lib.X509_set_version(self._x509, version) def get_version(self): """ Return the version number of the certificate. :return: The version number of the certificate. :rtype: :py:class:`int` """ return _lib.X509_get_version(self._x509) def get_pubkey(self): """ Get the public key of the certificate. :return: The public key. :rtype: :py:class:`PKey` """ pkey = PKey.__new__(PKey) pkey._pkey = _lib.X509_get_pubkey(self._x509) if pkey._pkey == _ffi.NULL: _raise_current_error() pkey._pkey = _ffi.gc(pkey._pkey, _lib.EVP_PKEY_free) pkey._only_public = True return pkey def set_pubkey(self, pkey): """ Set the public key of the certificate. :param pkey: The public key. :type pkey: :py:class:`PKey` :return: :py:data:`None` """ if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey instance") set_result = _lib.X509_set_pubkey(self._x509, pkey._pkey) _openssl_assert(set_result == 1) def sign(self, pkey, digest): """ Sign the certificate with this key and digest type. :param pkey: The key to sign with. :type pkey: :py:class:`PKey` :param digest: The name of the message digest to use. :type digest: :py:class:`bytes` :return: :py:data:`None` """ if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey instance") if pkey._only_public: raise ValueError("Key only has public part") if not pkey._initialized: raise ValueError("Key is uninitialized") evp_md = _lib.EVP_get_digestbyname(_byte_string(digest)) if evp_md == _ffi.NULL: raise ValueError("No such digest method") sign_result = _lib.X509_sign(self._x509, pkey._pkey, evp_md) _openssl_assert(sign_result > 0) def get_signature_algorithm(self): """ Return the signature algorithm used in the certificate. :return: The name of the algorithm. :rtype: :py:class:`bytes` :raises ValueError: If the signature algorithm is undefined. .. versionadded:: 0.13 """ algor = _lib.X509_get0_tbs_sigalg(self._x509) nid = _lib.OBJ_obj2nid(algor.algorithm) if nid == _lib.NID_undef: raise ValueError("Undefined signature algorithm") return _ffi.string(_lib.OBJ_nid2ln(nid)) def digest(self, digest_name): """ Return the digest of the X509 object. :param digest_name: The name of the digest algorithm to use. :type digest_name: :py:class:`bytes` :return: The digest of the object, formatted as :py:const:`b":"`-delimited hex pairs. :rtype: :py:class:`bytes` """ digest = _lib.EVP_get_digestbyname(_byte_string(digest_name)) if digest == _ffi.NULL: raise ValueError("No such digest method") result_buffer = _ffi.new("unsigned char[]", _lib.EVP_MAX_MD_SIZE) result_length = _ffi.new("unsigned int[]", 1) result_length[0] = len(result_buffer) digest_result = _lib.X509_digest( self._x509, digest, result_buffer, result_length ) _openssl_assert(digest_result == 1) return b":".join( [ b16encode(ch).upper() for ch in _ffi.buffer(result_buffer, result_length[0]) ] ) def subject_name_hash(self): """ Return the hash of the X509 subject. :return: The hash of the subject. :rtype: :py:class:`bytes` """ return _lib.X509_subject_name_hash(self._x509) def set_serial_number(self, serial): """ Set the serial number of the certificate. :param serial: The new serial number. :type serial: :py:class:`int` :return: :py:data`None` """ if not isinstance(serial, _integer_types): raise TypeError("serial must be an integer") hex_serial = hex(serial)[2:] if not isinstance(hex_serial, bytes): hex_serial = hex_serial.encode("ascii") bignum_serial = _ffi.new("BIGNUM**") # BN_hex2bn stores the result in &bignum. Unless it doesn't feel like # it. If bignum is still NULL after this call, then the return value # is actually the result. I hope. -exarkun small_serial = _lib.BN_hex2bn(bignum_serial, hex_serial) if bignum_serial[0] == _ffi.NULL: set_result = _lib.ASN1_INTEGER_set( _lib.X509_get_serialNumber(self._x509), small_serial ) if set_result: # TODO Not tested _raise_current_error() else: asn1_serial = _lib.BN_to_ASN1_INTEGER(bignum_serial[0], _ffi.NULL) _lib.BN_free(bignum_serial[0]) if asn1_serial == _ffi.NULL: # TODO Not tested _raise_current_error() asn1_serial = _ffi.gc(asn1_serial, _lib.ASN1_INTEGER_free) set_result = _lib.X509_set_serialNumber(self._x509, asn1_serial) _openssl_assert(set_result == 1) def get_serial_number(self): """ Return the serial number of this certificate. :return: The serial number. :rtype: int """ asn1_serial = _lib.X509_get_serialNumber(self._x509) bignum_serial = _lib.ASN1_INTEGER_to_BN(asn1_serial, _ffi.NULL) try: hex_serial = _lib.BN_bn2hex(bignum_serial) try: hexstring_serial = _ffi.string(hex_serial) serial = int(hexstring_serial, 16) return serial finally: _lib.OPENSSL_free(hex_serial) finally: _lib.BN_free(bignum_serial) def gmtime_adj_notAfter(self, amount): """ Adjust the time stamp on which the certificate stops being valid. :param int amount: The number of seconds by which to adjust the timestamp. :return: ``None`` """ if not isinstance(amount, int): raise TypeError("amount must be an integer") notAfter = _lib.X509_getm_notAfter(self._x509) _lib.X509_gmtime_adj(notAfter, amount) def gmtime_adj_notBefore(self, amount): """ Adjust the timestamp on which the certificate starts being valid. :param amount: The number of seconds by which to adjust the timestamp. :return: ``None`` """ if not isinstance(amount, int): raise TypeError("amount must be an integer") notBefore = _lib.X509_getm_notBefore(self._x509) _lib.X509_gmtime_adj(notBefore, amount) def has_expired(self): """ Check whether the certificate has expired. :return: ``True`` if the certificate has expired, ``False`` otherwise. :rtype: bool """ time_string = _native(self.get_notAfter()) not_after = datetime.datetime.strptime(time_string, "%Y%m%d%H%M%SZ") return not_after < datetime.datetime.utcnow() def _get_boundary_time(self, which): return _get_asn1_time(which(self._x509)) def get_notBefore(self): """ Get the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType """ return self._get_boundary_time(_lib.X509_getm_notBefore) def _set_boundary_time(self, which, when): return _set_asn1_time(which(self._x509), when) def set_notBefore(self, when): """ Set the timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` """ return self._set_boundary_time(_lib.X509_getm_notBefore, when) def get_notAfter(self): """ Get the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :return: A timestamp string, or ``None`` if there is none. :rtype: bytes or NoneType """ return self._get_boundary_time(_lib.X509_getm_notAfter) def set_notAfter(self, when): """ Set the timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ :param bytes when: A timestamp string. :return: ``None`` """ return self._set_boundary_time(_lib.X509_getm_notAfter, when) def _get_name(self, which): name = X509Name.__new__(X509Name) name._name = which(self._x509) _openssl_assert(name._name != _ffi.NULL) # The name is owned by the X509 structure. As long as the X509Name # Python object is alive, keep the X509 Python object alive. name._owner = self return name def _set_name(self, which, name): if not isinstance(name, X509Name): raise TypeError("name must be an X509Name") set_result = which(self._x509, name._name) _openssl_assert(set_result == 1) def get_issuer(self): """ Return the issuer of this certificate. This creates a new :class:`X509Name` that wraps the underlying issuer name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this issuer. :return: The issuer of this certificate. :rtype: :class:`X509Name` """ name = self._get_name(_lib.X509_get_issuer_name) self._issuer_invalidator.add(name) return name def set_issuer(self, issuer): """ Set the issuer of this certificate. :param issuer: The issuer. :type issuer: :py:class:`X509Name` :return: ``None`` """ self._set_name(_lib.X509_set_issuer_name, issuer) self._issuer_invalidator.clear() def get_subject(self): """ Return the subject of this certificate. This creates a new :class:`X509Name` that wraps the underlying subject name field on the certificate. Modifying it will modify the underlying certificate, and will have the effect of modifying any other :class:`X509Name` that refers to this subject. :return: The subject of this certificate. :rtype: :class:`X509Name` """ name = self._get_name(_lib.X509_get_subject_name) self._subject_invalidator.add(name) return name def set_subject(self, subject): """ Set the subject of this certificate. :param subject: The subject. :type subject: :py:class:`X509Name` :return: ``None`` """ self._set_name(_lib.X509_set_subject_name, subject) self._subject_invalidator.clear() def get_extension_count(self): """ Get the number of extensions on this certificate. :return: The number of extensions. :rtype: :py:class:`int` .. versionadded:: 0.12 """ return _lib.X509_get_ext_count(self._x509) def add_extensions(self, extensions): """ Add extensions to the certificate. :param extensions: The extensions to add. :type extensions: An iterable of :py:class:`X509Extension` objects. :return: ``None`` """ for ext in extensions: if not isinstance(ext, X509Extension): raise ValueError("One of the elements is not an X509Extension") add_result = _lib.X509_add_ext(self._x509, ext._extension, -1) if not add_result: _raise_current_error() def get_extension(self, index): """ Get a specific extension of the certificate by index. Extensions on a certificate are kept in order. The index parameter selects which extension will be returned. :param int index: The index of the extension to retrieve. :return: The extension at the specified index. :rtype: :py:class:`X509Extension` :raises IndexError: If the extension index was out of bounds. .. versionadded:: 0.12 """ ext = X509Extension.__new__(X509Extension) ext._extension = _lib.X509_get_ext(self._x509, index) if ext._extension == _ffi.NULL: raise IndexError("extension index out of bounds") extension = _lib.X509_EXTENSION_dup(ext._extension) ext._extension = _ffi.gc(extension, _lib.X509_EXTENSION_free) return ext class X509StoreFlags(object): """ Flags for X509 verification, used to change the behavior of :class:`X509Store`. See `OpenSSL Verification Flags`_ for details. .. _OpenSSL Verification Flags: https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_flags.html """ CRL_CHECK = _lib.X509_V_FLAG_CRL_CHECK CRL_CHECK_ALL = _lib.X509_V_FLAG_CRL_CHECK_ALL IGNORE_CRITICAL = _lib.X509_V_FLAG_IGNORE_CRITICAL X509_STRICT = _lib.X509_V_FLAG_X509_STRICT ALLOW_PROXY_CERTS = _lib.X509_V_FLAG_ALLOW_PROXY_CERTS POLICY_CHECK = _lib.X509_V_FLAG_POLICY_CHECK EXPLICIT_POLICY = _lib.X509_V_FLAG_EXPLICIT_POLICY INHIBIT_MAP = _lib.X509_V_FLAG_INHIBIT_MAP NOTIFY_POLICY = _lib.X509_V_FLAG_NOTIFY_POLICY CHECK_SS_SIGNATURE = _lib.X509_V_FLAG_CHECK_SS_SIGNATURE class X509Store(object): """ An X.509 store. An X.509 store is used to describe a context in which to verify a certificate. A description of a context may include a set of certificates to trust, a set of certificate revocation lists, verification flags and more. An X.509 store, being only a description, cannot be used by itself to verify a certificate. To carry out the actual verification process, see :class:`X509StoreContext`. """ def __init__(self): store = _lib.X509_STORE_new() self._store = _ffi.gc(store, _lib.X509_STORE_free) def add_cert(self, cert): """ Adds a trusted certificate to this store. Adding a certificate with this method adds this certificate as a *trusted* certificate. :param X509 cert: The certificate to add to this store. :raises TypeError: If the certificate is not an :class:`X509`. :raises OpenSSL.crypto.Error: If OpenSSL was unhappy with your certificate. :return: ``None`` if the certificate was added successfully. """ if not isinstance(cert, X509): raise TypeError() res = _lib.X509_STORE_add_cert(self._store, cert._x509) _openssl_assert(res == 1) def add_crl(self, crl): """ Add a certificate revocation list to this store. The certificate revocation lists added to a store will only be used if the associated flags are configured to check certificate revocation lists. .. versionadded:: 16.1.0 :param CRL crl: The certificate revocation list to add to this store. :return: ``None`` if the certificate revocation list was added successfully. """ _openssl_assert(_lib.X509_STORE_add_crl(self._store, crl._crl) != 0) def set_flags(self, flags): """ Set verification flags to this store. Verification flags can be combined by oring them together. .. note:: Setting a verification flag sometimes requires clients to add additional information to the store, otherwise a suitable error will be raised. For example, in setting flags to enable CRL checking a suitable CRL must be added to the store otherwise an error will be raised. .. versionadded:: 16.1.0 :param int flags: The verification flags to set on this store. See :class:`X509StoreFlags` for available constants. :return: ``None`` if the verification flags were successfully set. """ _openssl_assert(_lib.X509_STORE_set_flags(self._store, flags) != 0) def set_time(self, vfy_time): """ Set the time against which the certificates are verified. Normally the current time is used. .. note:: For example, you can determine if a certificate was valid at a given time. .. versionadded:: 17.0.0 :param datetime vfy_time: The verification time to set on this store. :return: ``None`` if the verification time was successfully set. """ param = _lib.X509_VERIFY_PARAM_new() param = _ffi.gc(param, _lib.X509_VERIFY_PARAM_free) _lib.X509_VERIFY_PARAM_set_time( param, calendar.timegm(vfy_time.timetuple()) ) _openssl_assert(_lib.X509_STORE_set1_param(self._store, param) != 0) def load_locations(self, cafile, capath=None): """ Let X509Store 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 *cafile* or *capath* may be ``None``. .. note:: Both *cafile* and *capath* may be set simultaneously. Call this method multiple times to add more than one location. For example, CA certificates, and certificate revocation list bundles may be passed in *cafile* in subsequent calls to this method. .. versionadded:: 20.0 :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`` if the locations were set successfully. :raises OpenSSL.crypto.Error: If both *cafile* and *capath* is ``None`` or the locations could not be set for any reason. """ if cafile is None: cafile = _ffi.NULL else: cafile = _path_string(cafile) if capath is None: capath = _ffi.NULL else: capath = _path_string(capath) load_result = _lib.X509_STORE_load_locations( self._store, cafile, capath ) if not load_result: _raise_current_error() class X509StoreContextError(Exception): """ An exception raised when an error occurred while verifying a certificate using `OpenSSL.X509StoreContext.verify_certificate`. :ivar certificate: The certificate which caused verificate failure. :type certificate: :class:`X509` """ def __init__(self, message, certificate): super(X509StoreContextError, self).__init__(message) self.certificate = certificate class X509StoreContext(object): """ An X.509 store context. An X.509 store context is used to carry out the actual verification process of a certificate in a described context. For describing such a context, see :class:`X509Store`. :ivar _store_ctx: The underlying X509_STORE_CTX structure used by this instance. It is dynamically allocated and automatically garbage collected. :ivar _store: See the ``store`` ``__init__`` parameter. :ivar _cert: See the ``certificate`` ``__init__`` parameter. :ivar _chain: See the ``chain`` ``__init__`` parameter. :param X509Store store: The certificates which will be trusted for the purposes of any verifications. :param X509 certificate: The certificate to be verified. :param chain: List of untrusted certificates that may be used for building the certificate chain. May be ``None``. :type chain: :class:`list` of :class:`X509` """ def __init__(self, store, certificate, chain=None): store_ctx = _lib.X509_STORE_CTX_new() self._store_ctx = _ffi.gc(store_ctx, _lib.X509_STORE_CTX_free) self._store = store self._cert = certificate self._chain = self._build_certificate_stack(chain) # Make the store context available for use after instantiating this # class by initializing it now. Per testing, subsequent calls to # :meth:`_init` have no adverse affect. self._init() @staticmethod def _build_certificate_stack(certificates): def cleanup(s): # Equivalent to sk_X509_pop_free, but we don't # currently have a CFFI binding for that available for i in range(_lib.sk_X509_num(s)): x = _lib.sk_X509_value(s, i) _lib.X509_free(x) _lib.sk_X509_free(s) if certificates is None or len(certificates) == 0: return _ffi.NULL stack = _lib.sk_X509_new_null() _openssl_assert(stack != _ffi.NULL) stack = _ffi.gc(stack, cleanup) for cert in certificates: if not isinstance(cert, X509): raise TypeError("One of the elements is not an X509 instance") _openssl_assert(_lib.X509_up_ref(cert._x509) > 0) if _lib.sk_X509_push(stack, cert._x509) <= 0: _lib.X509_free(cert._x509) _raise_current_error() return stack def _init(self): """ Set up the store context for a subsequent verification operation. Calling this method more than once without first calling :meth:`_cleanup` will leak memory. """ ret = _lib.X509_STORE_CTX_init( self._store_ctx, self._store._store, self._cert._x509, self._chain ) if ret <= 0: _raise_current_error() def _cleanup(self): """ Internally cleans up the store context. The store context can then be reused with a new call to :meth:`_init`. """ _lib.X509_STORE_CTX_cleanup(self._store_ctx) def _exception_from_context(self): """ Convert an OpenSSL native context error failure into a Python exception. When a call to native OpenSSL X509_verify_cert fails, additional information about the failure can be obtained from the store context. """ errors = [ _lib.X509_STORE_CTX_get_error(self._store_ctx), _lib.X509_STORE_CTX_get_error_depth(self._store_ctx), _native( _ffi.string( _lib.X509_verify_cert_error_string( _lib.X509_STORE_CTX_get_error(self._store_ctx) ) ) ), ] # A context error should always be associated with a certificate, so we # expect this call to never return :class:`None`. _x509 = _lib.X509_STORE_CTX_get_current_cert(self._store_ctx) _cert = _lib.X509_dup(_x509) pycert = X509._from_raw_x509_ptr(_cert) return X509StoreContextError(errors, pycert) def set_store(self, store): """ Set the context's X.509 store. .. versionadded:: 0.15 :param X509Store store: The store description which will be used for the purposes of any *future* verifications. """ self._store = store def verify_certificate(self): """ Verify a certificate in a context. .. versionadded:: 0.15 :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. """ # Always re-initialize the store context in case # :meth:`verify_certificate` is called multiple times. # # :meth:`_init` is called in :meth:`__init__` so _cleanup is called # before _init to ensure memory is not leaked. self._cleanup() self._init() ret = _lib.X509_verify_cert(self._store_ctx) self._cleanup() if ret <= 0: raise self._exception_from_context() def get_verified_chain(self): """ Verify a certificate in a context and return the complete validated chain. :raises X509StoreContextError: If an error occurred when validating a certificate in the context. Sets ``certificate`` attribute to indicate which certificate caused the error. .. versionadded:: 20.0 """ # Always re-initialize the store context in case # :meth:`verify_certificate` is called multiple times. # # :meth:`_init` is called in :meth:`__init__` so _cleanup is called # before _init to ensure memory is not leaked. self._cleanup() self._init() ret = _lib.X509_verify_cert(self._store_ctx) if ret <= 0: self._cleanup() raise self._exception_from_context() # Note: X509_STORE_CTX_get1_chain returns a deep copy of the chain. cert_stack = _lib.X509_STORE_CTX_get1_chain(self._store_ctx) _openssl_assert(cert_stack != _ffi.NULL) result = [] for i in range(_lib.sk_X509_num(cert_stack)): cert = _lib.sk_X509_value(cert_stack, i) _openssl_assert(cert != _ffi.NULL) pycert = X509._from_raw_x509_ptr(cert) result.append(pycert) # Free the stack but not the members which are freed by the X509 class. _lib.sk_X509_free(cert_stack) self._cleanup() return result def load_certificate(type, buffer): """ Load a certificate (X509) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param bytes buffer: The buffer the certificate is stored in :return: The X509 object """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) if type == FILETYPE_PEM: x509 = _lib.PEM_read_bio_X509(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) elif type == FILETYPE_ASN1: x509 = _lib.d2i_X509_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") if x509 == _ffi.NULL: _raise_current_error() return X509._from_raw_x509_ptr(x509) def dump_certificate(type, cert): """ Dump the certificate *cert* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1, or FILETYPE_TEXT) :param cert: The certificate to dump :return: The buffer with the dumped certificate in """ bio = _new_mem_buf() if type == FILETYPE_PEM: result_code = _lib.PEM_write_bio_X509(bio, cert._x509) elif type == FILETYPE_ASN1: result_code = _lib.i2d_X509_bio(bio, cert._x509) elif type == FILETYPE_TEXT: result_code = _lib.X509_print_ex(bio, cert._x509, 0, 0) else: raise ValueError( "type argument must be FILETYPE_PEM, FILETYPE_ASN1, or " "FILETYPE_TEXT" ) _openssl_assert(result_code == 1) return _bio_to_string(bio) def dump_publickey(type, pkey): """ Dump a public key to a buffer. :param type: The file type (one of :data:`FILETYPE_PEM` or :data:`FILETYPE_ASN1`). :param PKey pkey: The public key to dump :return: The buffer with the dumped key in it. :rtype: bytes """ bio = _new_mem_buf() if type == FILETYPE_PEM: write_bio = _lib.PEM_write_bio_PUBKEY elif type == FILETYPE_ASN1: write_bio = _lib.i2d_PUBKEY_bio else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") result_code = write_bio(bio, pkey._pkey) if result_code != 1: # pragma: no cover _raise_current_error() return _bio_to_string(bio) def dump_privatekey(type, pkey, cipher=None, passphrase=None): """ Dump the private key *pkey* into a buffer string encoded with the type *type*. Optionally (if *type* is :const:`FILETYPE_PEM`) encrypting it using *cipher* and *passphrase*. :param type: The file type (one of :const:`FILETYPE_PEM`, :const:`FILETYPE_ASN1`, or :const:`FILETYPE_TEXT`) :param PKey pkey: The PKey to dump :param cipher: (optional) if encrypted PEM format, the cipher to use :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The buffer with the dumped key in :rtype: bytes """ bio = _new_mem_buf() if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey") if cipher is not None: if passphrase is None: raise TypeError( "if a value is given for cipher " "one must also be given for passphrase" ) cipher_obj = _lib.EVP_get_cipherbyname(_byte_string(cipher)) if cipher_obj == _ffi.NULL: raise ValueError("Invalid cipher name") else: cipher_obj = _ffi.NULL helper = _PassphraseHelper(type, passphrase) if type == FILETYPE_PEM: result_code = _lib.PEM_write_bio_PrivateKey( bio, pkey._pkey, cipher_obj, _ffi.NULL, 0, helper.callback, helper.callback_args, ) helper.raise_if_problem() elif type == FILETYPE_ASN1: result_code = _lib.i2d_PrivateKey_bio(bio, pkey._pkey) elif type == FILETYPE_TEXT: if _lib.EVP_PKEY_id(pkey._pkey) != _lib.EVP_PKEY_RSA: raise TypeError("Only RSA keys are supported for FILETYPE_TEXT") rsa = _ffi.gc(_lib.EVP_PKEY_get1_RSA(pkey._pkey), _lib.RSA_free) result_code = _lib.RSA_print(bio, rsa, 0) else: raise ValueError( "type argument must be FILETYPE_PEM, FILETYPE_ASN1, or " "FILETYPE_TEXT" ) _openssl_assert(result_code != 0) return _bio_to_string(bio) class Revoked(object): """ A certificate revocation. """ # https://www.openssl.org/docs/manmaster/man5/x509v3_config.html#CRL-distribution-points # which differs from crl_reasons of crypto/x509v3/v3_enum.c that matches # OCSP_crl_reason_str. We use the latter, just like the command line # program. _crl_reasons = [ b"unspecified", b"keyCompromise", b"CACompromise", b"affiliationChanged", b"superseded", b"cessationOfOperation", b"certificateHold", # b"removeFromCRL", ] def __init__(self): revoked = _lib.X509_REVOKED_new() self._revoked = _ffi.gc(revoked, _lib.X509_REVOKED_free) def set_serial(self, hex_str): """ Set the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :param bytes hex_str: The new serial number. :return: ``None`` """ bignum_serial = _ffi.gc(_lib.BN_new(), _lib.BN_free) bignum_ptr = _ffi.new("BIGNUM**") bignum_ptr[0] = bignum_serial bn_result = _lib.BN_hex2bn(bignum_ptr, hex_str) if not bn_result: raise ValueError("bad hex string") asn1_serial = _ffi.gc( _lib.BN_to_ASN1_INTEGER(bignum_serial, _ffi.NULL), _lib.ASN1_INTEGER_free, ) _lib.X509_REVOKED_set_serialNumber(self._revoked, asn1_serial) def get_serial(self): """ Get the serial number. The serial number is formatted as a hexadecimal number encoded in ASCII. :return: The serial number. :rtype: bytes """ bio = _new_mem_buf() asn1_int = _lib.X509_REVOKED_get0_serialNumber(self._revoked) _openssl_assert(asn1_int != _ffi.NULL) result = _lib.i2a_ASN1_INTEGER(bio, asn1_int) _openssl_assert(result >= 0) return _bio_to_string(bio) def _delete_reason(self): for i in range(_lib.X509_REVOKED_get_ext_count(self._revoked)): ext = _lib.X509_REVOKED_get_ext(self._revoked, i) obj = _lib.X509_EXTENSION_get_object(ext) if _lib.OBJ_obj2nid(obj) == _lib.NID_crl_reason: _lib.X509_EXTENSION_free(ext) _lib.X509_REVOKED_delete_ext(self._revoked, i) break def set_reason(self, reason): """ Set the reason of this revocation. If :data:`reason` is ``None``, delete the reason instead. :param reason: The reason string. :type reason: :class:`bytes` or :class:`NoneType` :return: ``None`` .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons which you might pass to this method. """ if reason is None: self._delete_reason() elif not isinstance(reason, bytes): raise TypeError("reason must be None or a byte string") else: reason = reason.lower().replace(b" ", b"") reason_code = [r.lower() for r in self._crl_reasons].index(reason) new_reason_ext = _lib.ASN1_ENUMERATED_new() _openssl_assert(new_reason_ext != _ffi.NULL) new_reason_ext = _ffi.gc(new_reason_ext, _lib.ASN1_ENUMERATED_free) set_result = _lib.ASN1_ENUMERATED_set(new_reason_ext, reason_code) _openssl_assert(set_result != _ffi.NULL) self._delete_reason() add_result = _lib.X509_REVOKED_add1_ext_i2d( self._revoked, _lib.NID_crl_reason, new_reason_ext, 0, 0 ) _openssl_assert(add_result == 1) def get_reason(self): """ Get the reason of this revocation. :return: The reason, or ``None`` if there is none. :rtype: bytes or NoneType .. seealso:: :meth:`all_reasons`, which gives you a list of all supported reasons this method might return. """ for i in range(_lib.X509_REVOKED_get_ext_count(self._revoked)): ext = _lib.X509_REVOKED_get_ext(self._revoked, i) obj = _lib.X509_EXTENSION_get_object(ext) if _lib.OBJ_obj2nid(obj) == _lib.NID_crl_reason: bio = _new_mem_buf() print_result = _lib.X509V3_EXT_print(bio, ext, 0, 0) if not print_result: print_result = _lib.M_ASN1_OCTET_STRING_print( bio, _lib.X509_EXTENSION_get_data(ext) ) _openssl_assert(print_result != 0) return _bio_to_string(bio) def all_reasons(self): """ Return a list of all the supported reason strings. This list is a copy; modifying it does not change the supported reason strings. :return: A list of reason strings. :rtype: :class:`list` of :class:`bytes` """ return self._crl_reasons[:] def set_rev_date(self, when): """ Set the revocation timestamp. :param bytes when: The timestamp of the revocation, as ASN.1 TIME. :return: ``None`` """ dt = _lib.X509_REVOKED_get0_revocationDate(self._revoked) return _set_asn1_time(dt, when) def get_rev_date(self): """ Get the revocation timestamp. :return: The timestamp of the revocation, as ASN.1 TIME. :rtype: bytes """ dt = _lib.X509_REVOKED_get0_revocationDate(self._revoked) return _get_asn1_time(dt) class CRL(object): """ A certificate revocation list. """ def __init__(self): crl = _lib.X509_CRL_new() self._crl = _ffi.gc(crl, _lib.X509_CRL_free) def to_cryptography(self): """ Export as a ``cryptography`` CRL. :rtype: ``cryptography.x509.CertificateRevocationList`` .. versionadded:: 17.1.0 """ from cryptography.x509 import load_der_x509_crl der = dump_crl(FILETYPE_ASN1, self) backend = _get_backend() return load_der_x509_crl(der, backend) @classmethod def from_cryptography(cls, crypto_crl): """ Construct based on a ``cryptography`` *crypto_crl*. :param crypto_crl: A ``cryptography`` certificate revocation list :type crypto_crl: ``cryptography.x509.CertificateRevocationList`` :rtype: CRL .. versionadded:: 17.1.0 """ if not isinstance(crypto_crl, x509.CertificateRevocationList): raise TypeError("Must be a certificate revocation list") from cryptography.hazmat.primitives.serialization import Encoding der = crypto_crl.public_bytes(Encoding.DER) return load_crl(FILETYPE_ASN1, der) def get_revoked(self): """ Return the revocations in this certificate revocation list. These revocations will be provided by value, not by reference. That means it's okay to mutate them: it won't affect this CRL. :return: The revocations in this CRL. :rtype: :class:`tuple` of :class:`Revocation` """ results = [] revoked_stack = _lib.X509_CRL_get_REVOKED(self._crl) for i in range(_lib.sk_X509_REVOKED_num(revoked_stack)): revoked = _lib.sk_X509_REVOKED_value(revoked_stack, i) revoked_copy = _lib.Cryptography_X509_REVOKED_dup(revoked) pyrev = Revoked.__new__(Revoked) pyrev._revoked = _ffi.gc(revoked_copy, _lib.X509_REVOKED_free) results.append(pyrev) if results: return tuple(results) def add_revoked(self, revoked): """ Add a revoked (by value not reference) to the CRL structure This revocation will be added by value, not by reference. That means it's okay to mutate it after adding: it won't affect this CRL. :param Revoked revoked: The new revocation. :return: ``None`` """ copy = _lib.Cryptography_X509_REVOKED_dup(revoked._revoked) _openssl_assert(copy != _ffi.NULL) add_result = _lib.X509_CRL_add0_revoked(self._crl, copy) _openssl_assert(add_result != 0) def get_issuer(self): """ Get the CRL's issuer. .. versionadded:: 16.1.0 :rtype: X509Name """ _issuer = _lib.X509_NAME_dup(_lib.X509_CRL_get_issuer(self._crl)) _openssl_assert(_issuer != _ffi.NULL) _issuer = _ffi.gc(_issuer, _lib.X509_NAME_free) issuer = X509Name.__new__(X509Name) issuer._name = _issuer return issuer def set_version(self, version): """ Set the CRL version. .. versionadded:: 16.1.0 :param int version: The version of the CRL. :return: ``None`` """ _openssl_assert(_lib.X509_CRL_set_version(self._crl, version) != 0) def _set_boundary_time(self, which, when): return _set_asn1_time(which(self._crl), when) def set_lastUpdate(self, when): """ Set when the CRL was last updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` """ return self._set_boundary_time(_lib.X509_CRL_get_lastUpdate, when) def set_nextUpdate(self, when): """ Set when the CRL will next be updated. The timestamp is formatted as an ASN.1 TIME:: YYYYMMDDhhmmssZ .. versionadded:: 16.1.0 :param bytes when: A timestamp string. :return: ``None`` """ return self._set_boundary_time(_lib.X509_CRL_get_nextUpdate, when) def sign(self, issuer_cert, issuer_key, digest): """ Sign the CRL. Signing a CRL enables clients to associate the CRL itself with an issuer. Before a CRL is meaningful to other OpenSSL functions, it must be signed by an issuer. This method implicitly sets the issuer's name based on the issuer certificate and private key used to sign the CRL. .. versionadded:: 16.1.0 :param X509 issuer_cert: The issuer's certificate. :param PKey issuer_key: The issuer's private key. :param bytes digest: The digest method to sign the CRL with. """ digest_obj = _lib.EVP_get_digestbyname(digest) _openssl_assert(digest_obj != _ffi.NULL) _lib.X509_CRL_set_issuer_name( self._crl, _lib.X509_get_subject_name(issuer_cert._x509) ) _lib.X509_CRL_sort(self._crl) result = _lib.X509_CRL_sign(self._crl, issuer_key._pkey, digest_obj) _openssl_assert(result != 0) def export( self, cert, key, type=FILETYPE_PEM, days=100, digest=_UNSPECIFIED ): """ Export the CRL as a string. :param X509 cert: The certificate used to sign the CRL. :param PKey key: The key used to sign the CRL. :param int type: The export format, either :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`, or :data:`FILETYPE_TEXT`. :param int days: The number of days until the next update of this CRL. :param bytes digest: The name of the message digest to use (eg ``b"sha256"``). :rtype: bytes """ if not isinstance(cert, X509): raise TypeError("cert must be an X509 instance") if not isinstance(key, PKey): raise TypeError("key must be a PKey instance") if not isinstance(type, int): raise TypeError("type must be an integer") if digest is _UNSPECIFIED: raise TypeError("digest must be provided") digest_obj = _lib.EVP_get_digestbyname(digest) if digest_obj == _ffi.NULL: raise ValueError("No such digest method") bio = _lib.BIO_new(_lib.BIO_s_mem()) _openssl_assert(bio != _ffi.NULL) # A scratch time object to give different values to different CRL # fields sometime = _lib.ASN1_TIME_new() _openssl_assert(sometime != _ffi.NULL) _lib.X509_gmtime_adj(sometime, 0) _lib.X509_CRL_set_lastUpdate(self._crl, sometime) _lib.X509_gmtime_adj(sometime, days * 24 * 60 * 60) _lib.X509_CRL_set_nextUpdate(self._crl, sometime) _lib.X509_CRL_set_issuer_name( self._crl, _lib.X509_get_subject_name(cert._x509) ) sign_result = _lib.X509_CRL_sign(self._crl, key._pkey, digest_obj) if not sign_result: _raise_current_error() return dump_crl(type, self) class PKCS7(object): def type_is_signed(self): """ Check if this NID_pkcs7_signed object :return: True if the PKCS7 is of type signed """ return bool(_lib.PKCS7_type_is_signed(self._pkcs7)) def type_is_enveloped(self): """ Check if this NID_pkcs7_enveloped object :returns: True if the PKCS7 is of type enveloped """ return bool(_lib.PKCS7_type_is_enveloped(self._pkcs7)) def type_is_signedAndEnveloped(self): """ Check if this NID_pkcs7_signedAndEnveloped object :returns: True if the PKCS7 is of type signedAndEnveloped """ return bool(_lib.PKCS7_type_is_signedAndEnveloped(self._pkcs7)) def type_is_data(self): """ Check if this NID_pkcs7_data object :return: True if the PKCS7 is of type data """ return bool(_lib.PKCS7_type_is_data(self._pkcs7)) def get_type_name(self): """ Returns the type name of the PKCS7 structure :return: A string with the typename """ nid = _lib.OBJ_obj2nid(self._pkcs7.type) string_type = _lib.OBJ_nid2sn(nid) return _ffi.string(string_type) class PKCS12(object): """ A PKCS #12 archive. """ def __init__(self): self._pkey = None self._cert = None self._cacerts = None self._friendlyname = None def get_certificate(self): """ Get the certificate in the PKCS #12 structure. :return: The certificate, or :py:const:`None` if there is none. :rtype: :py:class:`X509` or :py:const:`None` """ return self._cert def set_certificate(self, cert): """ Set the certificate in the PKCS #12 structure. :param cert: The new certificate, or :py:const:`None` to unset it. :type cert: :py:class:`X509` or :py:const:`None` :return: ``None`` """ if not isinstance(cert, X509): raise TypeError("cert must be an X509 instance") self._cert = cert def get_privatekey(self): """ Get the private key in the PKCS #12 structure. :return: The private key, or :py:const:`None` if there is none. :rtype: :py:class:`PKey` """ return self._pkey def set_privatekey(self, pkey): """ Set the certificate portion of the PKCS #12 structure. :param pkey: The new private key, or :py:const:`None` to unset it. :type pkey: :py:class:`PKey` or :py:const:`None` :return: ``None`` """ if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey instance") self._pkey = pkey def get_ca_certificates(self): """ Get the CA certificates in the PKCS #12 structure. :return: A tuple with the CA certificates in the chain, or :py:const:`None` if there are none. :rtype: :py:class:`tuple` of :py:class:`X509` or :py:const:`None` """ if self._cacerts is not None: return tuple(self._cacerts) def set_ca_certificates(self, cacerts): """ Replace or set the CA certificates within the PKCS12 object. :param cacerts: The new CA certificates, or :py:const:`None` to unset them. :type cacerts: An iterable of :py:class:`X509` or :py:const:`None` :return: ``None`` """ if cacerts is None: self._cacerts = None else: cacerts = list(cacerts) for cert in cacerts: if not isinstance(cert, X509): raise TypeError( "iterable must only contain X509 instances" ) self._cacerts = cacerts def set_friendlyname(self, name): """ Set the friendly name in the PKCS #12 structure. :param name: The new friendly name, or :py:const:`None` to unset. :type name: :py:class:`bytes` or :py:const:`None` :return: ``None`` """ if name is None: self._friendlyname = None elif not isinstance(name, bytes): raise TypeError( "name must be a byte string or None (not %r)" % (name,) ) self._friendlyname = name def get_friendlyname(self): """ Get the friendly name in the PKCS# 12 structure. :returns: The friendly name, or :py:const:`None` if there is none. :rtype: :py:class:`bytes` or :py:const:`None` """ return self._friendlyname def export(self, passphrase=None, iter=2048, maciter=1): """ Dump a PKCS12 object as a string. For more information, see the :c:func:`PKCS12_create` man page. :param passphrase: The passphrase used to encrypt the structure. Unlike some other passphrase arguments, this *must* be a string, not a callback. :type passphrase: :py:data:`bytes` :param iter: Number of times to repeat the encryption step. :type iter: :py:data:`int` :param maciter: Number of times to repeat the MAC step. :type maciter: :py:data:`int` :return: The string representation of the PKCS #12 structure. :rtype: """ passphrase = _text_to_bytes_and_warn("passphrase", passphrase) if self._cacerts is None: cacerts = _ffi.NULL else: cacerts = _lib.sk_X509_new_null() cacerts = _ffi.gc(cacerts, _lib.sk_X509_free) for cert in self._cacerts: _lib.sk_X509_push(cacerts, cert._x509) if passphrase is None: passphrase = _ffi.NULL friendlyname = self._friendlyname if friendlyname is None: friendlyname = _ffi.NULL if self._pkey is None: pkey = _ffi.NULL else: pkey = self._pkey._pkey if self._cert is None: cert = _ffi.NULL else: cert = self._cert._x509 pkcs12 = _lib.PKCS12_create( passphrase, friendlyname, pkey, cert, cacerts, _lib.NID_pbe_WithSHA1And3_Key_TripleDES_CBC, _lib.NID_pbe_WithSHA1And3_Key_TripleDES_CBC, iter, maciter, 0, ) if pkcs12 == _ffi.NULL: _raise_current_error() pkcs12 = _ffi.gc(pkcs12, _lib.PKCS12_free) bio = _new_mem_buf() _lib.i2d_PKCS12_bio(bio, pkcs12) return _bio_to_string(bio) class NetscapeSPKI(object): """ A Netscape SPKI object. """ def __init__(self): spki = _lib.NETSCAPE_SPKI_new() self._spki = _ffi.gc(spki, _lib.NETSCAPE_SPKI_free) def sign(self, pkey, digest): """ Sign the certificate request with this key and digest type. :param pkey: The private key to sign with. :type pkey: :py:class:`PKey` :param digest: The message digest to use. :type digest: :py:class:`bytes` :return: ``None`` """ if pkey._only_public: raise ValueError("Key has only public part") if not pkey._initialized: raise ValueError("Key is uninitialized") digest_obj = _lib.EVP_get_digestbyname(_byte_string(digest)) if digest_obj == _ffi.NULL: raise ValueError("No such digest method") sign_result = _lib.NETSCAPE_SPKI_sign( self._spki, pkey._pkey, digest_obj ) _openssl_assert(sign_result > 0) def verify(self, key): """ Verifies a signature on a certificate request. :param PKey key: The public key that signature is supposedly from. :return: ``True`` if the signature is correct. :rtype: bool :raises OpenSSL.crypto.Error: If the signature is invalid, or there was a problem verifying the signature. """ answer = _lib.NETSCAPE_SPKI_verify(self._spki, key._pkey) if answer <= 0: _raise_current_error() return True def b64_encode(self): """ Generate a base64 encoded representation of this SPKI object. :return: The base64 encoded string. :rtype: :py:class:`bytes` """ encoded = _lib.NETSCAPE_SPKI_b64_encode(self._spki) result = _ffi.string(encoded) _lib.OPENSSL_free(encoded) return result def get_pubkey(self): """ Get the public key of this certificate. :return: The public key. :rtype: :py:class:`PKey` """ pkey = PKey.__new__(PKey) pkey._pkey = _lib.NETSCAPE_SPKI_get_pubkey(self._spki) _openssl_assert(pkey._pkey != _ffi.NULL) pkey._pkey = _ffi.gc(pkey._pkey, _lib.EVP_PKEY_free) pkey._only_public = True return pkey def set_pubkey(self, pkey): """ Set the public key of the certificate :param pkey: The public key :return: ``None`` """ set_result = _lib.NETSCAPE_SPKI_set_pubkey(self._spki, pkey._pkey) _openssl_assert(set_result == 1) class _PassphraseHelper(object): def __init__(self, type, passphrase, more_args=False, truncate=False): if type != FILETYPE_PEM and passphrase is not None: raise ValueError( "only FILETYPE_PEM key format supports encryption" ) self._passphrase = passphrase self._more_args = more_args self._truncate = truncate self._problems = [] @property def callback(self): if self._passphrase is None: return _ffi.NULL elif isinstance(self._passphrase, bytes) or callable(self._passphrase): return _ffi.callback("pem_password_cb", self._read_passphrase) else: raise TypeError( "Last argument must be a byte string or a callable." ) @property def callback_args(self): if self._passphrase is None: return _ffi.NULL elif isinstance(self._passphrase, bytes) or callable(self._passphrase): return _ffi.NULL else: raise TypeError( "Last argument must be a byte string or a callable." ) def raise_if_problem(self, exceptionType=Error): if self._problems: # Flush the OpenSSL error queue try: _exception_from_error_queue(exceptionType) except exceptionType: pass raise self._problems.pop(0) def _read_passphrase(self, buf, size, rwflag, userdata): try: if callable(self._passphrase): if self._more_args: result = self._passphrase(size, rwflag, userdata) else: result = self._passphrase(rwflag) else: result = self._passphrase if not isinstance(result, bytes): raise ValueError("Bytes expected") if len(result) > size: if self._truncate: result = result[:size] else: raise ValueError( "passphrase returned by callback is too long" ) for i in range(len(result)): buf[i] = result[i : i + 1] return len(result) except Exception as e: self._problems.append(e) return 0 def load_publickey(type, buffer): """ Load a public key from a buffer. :param type: The file type (one of :data:`FILETYPE_PEM`, :data:`FILETYPE_ASN1`). :param buffer: The buffer the key is stored in. :type buffer: A Python string object, either unicode or bytestring. :return: The PKey object. :rtype: :class:`PKey` """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) if type == FILETYPE_PEM: evp_pkey = _lib.PEM_read_bio_PUBKEY( bio, _ffi.NULL, _ffi.NULL, _ffi.NULL ) elif type == FILETYPE_ASN1: evp_pkey = _lib.d2i_PUBKEY_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") if evp_pkey == _ffi.NULL: _raise_current_error() pkey = PKey.__new__(PKey) pkey._pkey = _ffi.gc(evp_pkey, _lib.EVP_PKEY_free) pkey._only_public = True return pkey def load_privatekey(type, buffer, passphrase=None): """ Load a private key (PKey) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the key is stored in :param passphrase: (optional) if encrypted PEM format, this can be either the passphrase to use, or a callback for providing the passphrase. :return: The PKey object """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) helper = _PassphraseHelper(type, passphrase) if type == FILETYPE_PEM: evp_pkey = _lib.PEM_read_bio_PrivateKey( bio, _ffi.NULL, helper.callback, helper.callback_args ) helper.raise_if_problem() elif type == FILETYPE_ASN1: evp_pkey = _lib.d2i_PrivateKey_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") if evp_pkey == _ffi.NULL: _raise_current_error() pkey = PKey.__new__(PKey) pkey._pkey = _ffi.gc(evp_pkey, _lib.EVP_PKEY_free) return pkey def dump_certificate_request(type, req): """ Dump the certificate request *req* into a buffer string encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param req: The certificate request to dump :return: The buffer with the dumped certificate request in """ bio = _new_mem_buf() if type == FILETYPE_PEM: result_code = _lib.PEM_write_bio_X509_REQ(bio, req._req) elif type == FILETYPE_ASN1: result_code = _lib.i2d_X509_REQ_bio(bio, req._req) elif type == FILETYPE_TEXT: result_code = _lib.X509_REQ_print_ex(bio, req._req, 0, 0) else: raise ValueError( "type argument must be FILETYPE_PEM, FILETYPE_ASN1, or " "FILETYPE_TEXT" ) _openssl_assert(result_code != 0) return _bio_to_string(bio) def load_certificate_request(type, buffer): """ Load a certificate request (X509Req) from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the certificate request is stored in :return: The X509Req object """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) if type == FILETYPE_PEM: req = _lib.PEM_read_bio_X509_REQ(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) elif type == FILETYPE_ASN1: req = _lib.d2i_X509_REQ_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") _openssl_assert(req != _ffi.NULL) x509req = X509Req.__new__(X509Req) x509req._req = _ffi.gc(req, _lib.X509_REQ_free) return x509req def sign(pkey, data, digest): """ Sign a data string using the given key and message digest. :param pkey: PKey to sign with :param data: data to be signed :param digest: message digest to use :return: signature .. versionadded:: 0.11 """ data = _text_to_bytes_and_warn("data", data) digest_obj = _lib.EVP_get_digestbyname(_byte_string(digest)) if digest_obj == _ffi.NULL: raise ValueError("No such digest method") md_ctx = _lib.Cryptography_EVP_MD_CTX_new() md_ctx = _ffi.gc(md_ctx, _lib.Cryptography_EVP_MD_CTX_free) _lib.EVP_SignInit(md_ctx, digest_obj) _lib.EVP_SignUpdate(md_ctx, data, len(data)) length = _lib.EVP_PKEY_size(pkey._pkey) _openssl_assert(length > 0) signature_buffer = _ffi.new("unsigned char[]", length) signature_length = _ffi.new("unsigned int *") final_result = _lib.EVP_SignFinal( md_ctx, signature_buffer, signature_length, pkey._pkey ) _openssl_assert(final_result == 1) return _ffi.buffer(signature_buffer, signature_length[0])[:] def verify(cert, signature, data, digest): """ Verify the signature for a data string. :param cert: signing certificate (X509 object) corresponding to the private key which generated the signature. :param signature: signature returned by sign function :param data: data to be verified :param digest: message digest to use :return: ``None`` if the signature is correct, raise exception otherwise. .. versionadded:: 0.11 """ data = _text_to_bytes_and_warn("data", data) digest_obj = _lib.EVP_get_digestbyname(_byte_string(digest)) if digest_obj == _ffi.NULL: raise ValueError("No such digest method") pkey = _lib.X509_get_pubkey(cert._x509) _openssl_assert(pkey != _ffi.NULL) pkey = _ffi.gc(pkey, _lib.EVP_PKEY_free) md_ctx = _lib.Cryptography_EVP_MD_CTX_new() md_ctx = _ffi.gc(md_ctx, _lib.Cryptography_EVP_MD_CTX_free) _lib.EVP_VerifyInit(md_ctx, digest_obj) _lib.EVP_VerifyUpdate(md_ctx, data, len(data)) verify_result = _lib.EVP_VerifyFinal( md_ctx, signature, len(signature), pkey ) if verify_result != 1: _raise_current_error() def dump_crl(type, crl): """ Dump a certificate revocation list to a buffer. :param type: The file type (one of ``FILETYPE_PEM``, ``FILETYPE_ASN1``, or ``FILETYPE_TEXT``). :param CRL crl: The CRL to dump. :return: The buffer with the CRL. :rtype: bytes """ bio = _new_mem_buf() if type == FILETYPE_PEM: ret = _lib.PEM_write_bio_X509_CRL(bio, crl._crl) elif type == FILETYPE_ASN1: ret = _lib.i2d_X509_CRL_bio(bio, crl._crl) elif type == FILETYPE_TEXT: ret = _lib.X509_CRL_print(bio, crl._crl) else: raise ValueError( "type argument must be FILETYPE_PEM, FILETYPE_ASN1, or " "FILETYPE_TEXT" ) _openssl_assert(ret == 1) return _bio_to_string(bio) def load_crl(type, buffer): """ Load Certificate Revocation List (CRL) data from a string *buffer*. *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1) :param buffer: The buffer the CRL is stored in :return: The PKey object """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) if type == FILETYPE_PEM: crl = _lib.PEM_read_bio_X509_CRL(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) elif type == FILETYPE_ASN1: crl = _lib.d2i_X509_CRL_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") if crl == _ffi.NULL: _raise_current_error() result = CRL.__new__(CRL) result._crl = _ffi.gc(crl, _lib.X509_CRL_free) return result def load_pkcs7_data(type, buffer): """ Load pkcs7 data from the string *buffer* encoded with the type *type*. :param type: The file type (one of FILETYPE_PEM or FILETYPE_ASN1) :param buffer: The buffer with the pkcs7 data. :return: The PKCS7 object """ if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) if type == FILETYPE_PEM: pkcs7 = _lib.PEM_read_bio_PKCS7(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) elif type == FILETYPE_ASN1: pkcs7 = _lib.d2i_PKCS7_bio(bio, _ffi.NULL) else: raise ValueError("type argument must be FILETYPE_PEM or FILETYPE_ASN1") if pkcs7 == _ffi.NULL: _raise_current_error() pypkcs7 = PKCS7.__new__(PKCS7) pypkcs7._pkcs7 = _ffi.gc(pkcs7, _lib.PKCS7_free) return pypkcs7 load_pkcs7_data = utils.deprecated( load_pkcs7_data, __name__, ( "PKCS#7 support in pyOpenSSL is deprecated. You should use the APIs " "in cryptography." ), DeprecationWarning, ) def load_pkcs12(buffer, passphrase=None): """ Load pkcs12 data from the string *buffer*. If the pkcs12 structure is encrypted, a *passphrase* must be included. The MAC is always checked and thus required. See also the man page for the C function :py:func:`PKCS12_parse`. :param buffer: The buffer the certificate is stored in :param passphrase: (Optional) The password to decrypt the PKCS12 lump :returns: The PKCS12 object """ passphrase = _text_to_bytes_and_warn("passphrase", passphrase) if isinstance(buffer, _text_type): buffer = buffer.encode("ascii") bio = _new_mem_buf(buffer) # Use null passphrase if passphrase is None or empty string. With PKCS#12 # password based encryption no password and a zero length password are two # different things, but OpenSSL implementation will try both to figure out # which one works. if not passphrase: passphrase = _ffi.NULL p12 = _lib.d2i_PKCS12_bio(bio, _ffi.NULL) if p12 == _ffi.NULL: _raise_current_error() p12 = _ffi.gc(p12, _lib.PKCS12_free) pkey = _ffi.new("EVP_PKEY**") cert = _ffi.new("X509**") cacerts = _ffi.new("Cryptography_STACK_OF_X509**") parse_result = _lib.PKCS12_parse(p12, passphrase, pkey, cert, cacerts) if not parse_result: _raise_current_error() cacerts = _ffi.gc(cacerts[0], _lib.sk_X509_free) # openssl 1.0.0 sometimes leaves an X509_check_private_key error in the # queue for no particular reason. This error isn't interesting to anyone # outside this function. It's not even interesting to us. Get rid of it. try: _raise_current_error() except Error: pass if pkey[0] == _ffi.NULL: pykey = None else: pykey = PKey.__new__(PKey) pykey._pkey = _ffi.gc(pkey[0], _lib.EVP_PKEY_free) if cert[0] == _ffi.NULL: pycert = None friendlyname = None else: pycert = X509._from_raw_x509_ptr(cert[0]) friendlyname_length = _ffi.new("int*") friendlyname_buffer = _lib.X509_alias_get0( cert[0], friendlyname_length ) friendlyname = _ffi.buffer( friendlyname_buffer, friendlyname_length[0] )[:] if friendlyname_buffer == _ffi.NULL: friendlyname = None pycacerts = [] for i in range(_lib.sk_X509_num(cacerts)): x509 = _lib.sk_X509_value(cacerts, i) pycacert = X509._from_raw_x509_ptr(x509) pycacerts.append(pycacert) if not pycacerts: pycacerts = None pkcs12 = PKCS12.__new__(PKCS12) pkcs12._pkey = pykey pkcs12._cert = pycert pkcs12._cacerts = pycacerts pkcs12._friendlyname = friendlyname return pkcs12 load_pkcs12 = utils.deprecated( load_pkcs12, __name__, ( "PKCS#12 support in pyOpenSSL is deprecated. You should use the APIs " "in cryptography." ), DeprecationWarning, ) # There are no direct unit tests for this initialization. It is tested # indirectly since it is necessary for functions like dump_privatekey when # using encryption. # # Thus OpenSSL.test.test_crypto.FunctionTests.test_dump_privatekey_passphrase # and some other similar tests may fail without this (though they may not if # the Python runtime has already done some initialization of the underlying # OpenSSL library (and is linked against the same one that cryptography is # using)). _lib.OpenSSL_add_all_algorithms() # This is similar but exercised mainly by exception_from_error_queue. It calls # both ERR_load_crypto_strings() and ERR_load_SSL_strings(). _lib.SSL_load_error_strings() # Set the default string mask to match OpenSSL upstream (since 2005) and # RFC5280 recommendations. _lib.ASN1_STRING_set_default_mask_asc(b"utf8only") version.py 0000644 00000001212 15025013455 0006577 0 ustar 00 # Copyright (C) AB Strakt # Copyright (C) Jean-Paul Calderone # See LICENSE for details. """ pyOpenSSL - A simple wrapper around the OpenSSL library """ __all__ = [ "__author__", "__copyright__", "__email__", "__license__", "__summary__", "__title__", "__uri__", "__version__", ] __version__ = "21.0.0" __title__ = "pyOpenSSL" __uri__ = "https://pyopenssl.org/" __summary__ = "Python wrapper module around the OpenSSL library" __author__ = "The pyOpenSSL developers" __email__ = "cryptography-dev@python.org" __license__ = "Apache License, Version 2.0" __copyright__ = "Copyright 2001-2020 {0}".format(__author__) SSL.py 0000644 00000253340 15025013455 0005566 0 ustar 00 import os import socket from sys import platform from functools import wraps, partial from itertools import count, chain from weakref import WeakValueDictionary from errno import errorcode from six import integer_types, int2byte, indexbytes from OpenSSL._util import ( UNSPECIFIED as _UNSPECIFIED, exception_from_error_queue as _exception_from_error_queue, ffi as _ffi, lib as _lib, make_assert as _make_assert, native as _native, path_string as _path_string, text_to_bytes_and_warn as _text_to_bytes_and_warn, no_zero_allocator as _no_zero_allocator, ) from OpenSSL.crypto import ( FILETYPE_PEM, _PassphraseHelper, PKey, X509Name, X509, X509Store, ) __all__ = [ "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", "TLS_METHOD", "TLS_SERVER_METHOD", "TLS_CLIENT_METHOD", "SSL3_VERSION", "TLS1_VERSION", "TLS1_1_VERSION", "TLS1_2_VERSION", "TLS1_3_VERSION", "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", "NO_OVERLAPPING_PROTOCOLS", "SSLeay_version", "Session", "Context", "Connection", ] try: _buffer = buffer except NameError: class _buffer(object): pass OPENSSL_VERSION_NUMBER = _lib.OPENSSL_VERSION_NUMBER SSLEAY_VERSION = _lib.SSLEAY_VERSION SSLEAY_CFLAGS = _lib.SSLEAY_CFLAGS SSLEAY_PLATFORM = _lib.SSLEAY_PLATFORM SSLEAY_DIR = _lib.SSLEAY_DIR SSLEAY_BUILT_ON = _lib.SSLEAY_BUILT_ON SENT_SHUTDOWN = _lib.SSL_SENT_SHUTDOWN RECEIVED_SHUTDOWN = _lib.SSL_RECEIVED_SHUTDOWN SSLv2_METHOD = 1 SSLv3_METHOD = 2 SSLv23_METHOD = 3 TLSv1_METHOD = 4 TLSv1_1_METHOD = 5 TLSv1_2_METHOD = 6 TLS_METHOD = 7 TLS_SERVER_METHOD = 8 TLS_CLIENT_METHOD = 9 try: SSL3_VERSION = _lib.SSL3_VERSION TLS1_VERSION = _lib.TLS1_VERSION TLS1_1_VERSION = _lib.TLS1_1_VERSION TLS1_2_VERSION = _lib.TLS1_2_VERSION TLS1_3_VERSION = _lib.TLS1_3_VERSION except AttributeError: # Hardcode constants for cryptography < 3.4, see # https://github.com/pyca/pyopenssl/pull/985#issuecomment-775186682 SSL3_VERSION = 768 TLS1_VERSION = 769 TLS1_1_VERSION = 770 TLS1_2_VERSION = 771 TLS1_3_VERSION = 772 OP_NO_SSLv2 = _lib.SSL_OP_NO_SSLv2 OP_NO_SSLv3 = _lib.SSL_OP_NO_SSLv3 OP_NO_TLSv1 = _lib.SSL_OP_NO_TLSv1 OP_NO_TLSv1_1 = _lib.SSL_OP_NO_TLSv1_1 OP_NO_TLSv1_2 = _lib.SSL_OP_NO_TLSv1_2 try: OP_NO_TLSv1_3 = _lib.SSL_OP_NO_TLSv1_3 except AttributeError: pass MODE_RELEASE_BUFFERS = _lib.SSL_MODE_RELEASE_BUFFERS OP_SINGLE_DH_USE = _lib.SSL_OP_SINGLE_DH_USE OP_SINGLE_ECDH_USE = _lib.SSL_OP_SINGLE_ECDH_USE OP_EPHEMERAL_RSA = _lib.SSL_OP_EPHEMERAL_RSA OP_MICROSOFT_SESS_ID_BUG = _lib.SSL_OP_MICROSOFT_SESS_ID_BUG OP_NETSCAPE_CHALLENGE_BUG = _lib.SSL_OP_NETSCAPE_CHALLENGE_BUG OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG = ( _lib.SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG ) OP_SSLREF2_REUSE_CERT_TYPE_BUG = _lib.SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG OP_MICROSOFT_BIG_SSLV3_BUFFER = _lib.SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER OP_MSIE_SSLV2_RSA_PADDING = _lib.SSL_OP_MSIE_SSLV2_RSA_PADDING OP_SSLEAY_080_CLIENT_DH_BUG = _lib.SSL_OP_SSLEAY_080_CLIENT_DH_BUG OP_TLS_D5_BUG = _lib.SSL_OP_TLS_D5_BUG OP_TLS_BLOCK_PADDING_BUG = _lib.SSL_OP_TLS_BLOCK_PADDING_BUG OP_DONT_INSERT_EMPTY_FRAGMENTS = _lib.SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS OP_CIPHER_SERVER_PREFERENCE = _lib.SSL_OP_CIPHER_SERVER_PREFERENCE OP_TLS_ROLLBACK_BUG = _lib.SSL_OP_TLS_ROLLBACK_BUG OP_PKCS1_CHECK_1 = _lib.SSL_OP_PKCS1_CHECK_1 OP_PKCS1_CHECK_2 = _lib.SSL_OP_PKCS1_CHECK_2 OP_NETSCAPE_CA_DN_BUG = _lib.SSL_OP_NETSCAPE_CA_DN_BUG OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG = ( _lib.SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG ) OP_NO_COMPRESSION = _lib.SSL_OP_NO_COMPRESSION OP_NO_QUERY_MTU = _lib.SSL_OP_NO_QUERY_MTU OP_COOKIE_EXCHANGE = _lib.SSL_OP_COOKIE_EXCHANGE OP_NO_TICKET = _lib.SSL_OP_NO_TICKET OP_ALL = _lib.SSL_OP_ALL VERIFY_PEER = _lib.SSL_VERIFY_PEER VERIFY_FAIL_IF_NO_PEER_CERT = _lib.SSL_VERIFY_FAIL_IF_NO_PEER_CERT VERIFY_CLIENT_ONCE = _lib.SSL_VERIFY_CLIENT_ONCE VERIFY_NONE = _lib.SSL_VERIFY_NONE SESS_CACHE_OFF = _lib.SSL_SESS_CACHE_OFF SESS_CACHE_CLIENT = _lib.SSL_SESS_CACHE_CLIENT SESS_CACHE_SERVER = _lib.SSL_SESS_CACHE_SERVER SESS_CACHE_BOTH = _lib.SSL_SESS_CACHE_BOTH SESS_CACHE_NO_AUTO_CLEAR = _lib.SSL_SESS_CACHE_NO_AUTO_CLEAR SESS_CACHE_NO_INTERNAL_LOOKUP = _lib.SSL_SESS_CACHE_NO_INTERNAL_LOOKUP SESS_CACHE_NO_INTERNAL_STORE = _lib.SSL_SESS_CACHE_NO_INTERNAL_STORE SESS_CACHE_NO_INTERNAL = _lib.SSL_SESS_CACHE_NO_INTERNAL SSL_ST_CONNECT = _lib.SSL_ST_CONNECT SSL_ST_ACCEPT = _lib.SSL_ST_ACCEPT SSL_ST_MASK = _lib.SSL_ST_MASK SSL_CB_LOOP = _lib.SSL_CB_LOOP SSL_CB_EXIT = _lib.SSL_CB_EXIT SSL_CB_READ = _lib.SSL_CB_READ SSL_CB_WRITE = _lib.SSL_CB_WRITE SSL_CB_ALERT = _lib.SSL_CB_ALERT SSL_CB_READ_ALERT = _lib.SSL_CB_READ_ALERT SSL_CB_WRITE_ALERT = _lib.SSL_CB_WRITE_ALERT SSL_CB_ACCEPT_LOOP = _lib.SSL_CB_ACCEPT_LOOP SSL_CB_ACCEPT_EXIT = _lib.SSL_CB_ACCEPT_EXIT SSL_CB_CONNECT_LOOP = _lib.SSL_CB_CONNECT_LOOP SSL_CB_CONNECT_EXIT = _lib.SSL_CB_CONNECT_EXIT SSL_CB_HANDSHAKE_START = _lib.SSL_CB_HANDSHAKE_START SSL_CB_HANDSHAKE_DONE = _lib.SSL_CB_HANDSHAKE_DONE # Taken from https://golang.org/src/crypto/x509/root_linux.go _CERTIFICATE_FILE_LOCATIONS = [ "/etc/ssl/certs/ca-certificates.crt", # Debian/Ubuntu/Gentoo etc. "/etc/pki/tls/certs/ca-bundle.crt", # Fedora/RHEL 6 "/etc/ssl/ca-bundle.pem", # OpenSUSE "/etc/pki/tls/cacert.pem", # OpenELEC "/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem", # CentOS/RHEL 7 ] _CERTIFICATE_PATH_LOCATIONS = [ "/etc/ssl/certs", # SLES10/SLES11 ] # These values are compared to output from cffi's ffi.string so they must be # byte strings. _CRYPTOGRAPHY_MANYLINUX1_CA_DIR = b"/opt/pyca/cryptography/openssl/certs" _CRYPTOGRAPHY_MANYLINUX1_CA_FILE = b"/opt/pyca/cryptography/openssl/cert.pem" class Error(Exception): """ An error occurred in an `OpenSSL.SSL` API. """ _raise_current_error = partial(_exception_from_error_queue, Error) _openssl_assert = _make_assert(Error) class WantReadError(Error): pass class WantWriteError(Error): pass class WantX509LookupError(Error): pass class ZeroReturnError(Error): pass class SysCallError(Error): pass class _CallbackExceptionHelper(object): """ 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. """ def __init__(self): self._problems = [] def raise_if_problem(self): """ Raise an exception from the OpenSSL error queue or that was previously captured whe running a callback. """ if self._problems: try: _raise_current_error() except Error: pass raise self._problems.pop(0) class _VerifyHelper(_CallbackExceptionHelper): """ Wrap a callback such that it can be used as a certificate verification callback. """ def __init__(self, callback): _CallbackExceptionHelper.__init__(self) @wraps(callback) def wrapper(ok, store_ctx): x509 = _lib.X509_STORE_CTX_get_current_cert(store_ctx) _lib.X509_up_ref(x509) cert = X509._from_raw_x509_ptr(x509) error_number = _lib.X509_STORE_CTX_get_error(store_ctx) error_depth = _lib.X509_STORE_CTX_get_error_depth(store_ctx) index = _lib.SSL_get_ex_data_X509_STORE_CTX_idx() ssl = _lib.X509_STORE_CTX_get_ex_data(store_ctx, index) connection = Connection._reverse_mapping[ssl] try: result = callback( connection, cert, error_number, error_depth, ok ) except Exception as e: self._problems.append(e) return 0 else: if result: _lib.X509_STORE_CTX_set_error(store_ctx, _lib.X509_V_OK) return 1 else: return 0 self.callback = _ffi.callback( "int (*)(int, X509_STORE_CTX *)", wrapper ) NO_OVERLAPPING_PROTOCOLS = object() class _ALPNSelectHelper(_CallbackExceptionHelper): """ Wrap a callback such that it can be used as an ALPN selection callback. """ def __init__(self, callback): _CallbackExceptionHelper.__init__(self) @wraps(callback) def wrapper(ssl, out, outlen, in_, inlen, arg): try: conn = Connection._reverse_mapping[ssl] # The string passed to us is made up of multiple # length-prefixed bytestrings. We need to split that into a # list. instr = _ffi.buffer(in_, inlen)[:] protolist = [] while instr: encoded_len = indexbytes(instr, 0) proto = instr[1 : encoded_len + 1] protolist.append(proto) instr = instr[encoded_len + 1 :] # Call the callback outbytes = callback(conn, protolist) any_accepted = True if outbytes is NO_OVERLAPPING_PROTOCOLS: outbytes = b"" any_accepted = False elif not isinstance(outbytes, bytes): raise TypeError( "ALPN callback must return a bytestring or the " "special NO_OVERLAPPING_PROTOCOLS sentinel value." ) # Save our callback arguments on the connection object to make # sure that they don't get freed before OpenSSL can use them. # Then, return them in the appropriate output parameters. conn._alpn_select_callback_args = [ _ffi.new("unsigned char *", len(outbytes)), _ffi.new("unsigned char[]", outbytes), ] outlen[0] = conn._alpn_select_callback_args[0][0] out[0] = conn._alpn_select_callback_args[1] if not any_accepted: return _lib.SSL_TLSEXT_ERR_NOACK return _lib.SSL_TLSEXT_ERR_OK except Exception as e: self._problems.append(e) return _lib.SSL_TLSEXT_ERR_ALERT_FATAL self.callback = _ffi.callback( ( "int (*)(SSL *, unsigned char **, unsigned char *, " "const unsigned char *, unsigned int, void *)" ), wrapper, ) class _OCSPServerCallbackHelper(_CallbackExceptionHelper): """ 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. """ def __init__(self, callback): _CallbackExceptionHelper.__init__(self) @wraps(callback) def wrapper(ssl, cdata): try: conn = Connection._reverse_mapping[ssl] # Extract the data if any was provided. if cdata != _ffi.NULL: data = _ffi.from_handle(cdata) else: data = None # Call the callback. ocsp_data = callback(conn, data) if not isinstance(ocsp_data, bytes): raise TypeError("OCSP callback must return a bytestring.") # If the OCSP data was provided, we will pass it to OpenSSL. # However, we have an early exit here: if no OCSP data was # provided we will just exit out and tell OpenSSL that there # is nothing to do. if not ocsp_data: return 3 # SSL_TLSEXT_ERR_NOACK # OpenSSL takes ownership of this data and expects it to have # been allocated by OPENSSL_malloc. ocsp_data_length = len(ocsp_data) data_ptr = _lib.OPENSSL_malloc(ocsp_data_length) _ffi.buffer(data_ptr, ocsp_data_length)[:] = ocsp_data _lib.SSL_set_tlsext_status_ocsp_resp( ssl, data_ptr, ocsp_data_length ) return 0 except Exception as e: self._problems.append(e) return 2 # SSL_TLSEXT_ERR_ALERT_FATAL self.callback = _ffi.callback("int (*)(SSL *, void *)", wrapper) class _OCSPClientCallbackHelper(_CallbackExceptionHelper): """ 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. """ def __init__(self, callback): _CallbackExceptionHelper.__init__(self) @wraps(callback) def wrapper(ssl, cdata): try: conn = Connection._reverse_mapping[ssl] # Extract the data if any was provided. if cdata != _ffi.NULL: data = _ffi.from_handle(cdata) else: data = None # Get the OCSP data. ocsp_ptr = _ffi.new("unsigned char **") ocsp_len = _lib.SSL_get_tlsext_status_ocsp_resp(ssl, ocsp_ptr) if ocsp_len < 0: # No OCSP data. ocsp_data = b"" else: # Copy the OCSP data, then pass it to the callback. ocsp_data = _ffi.buffer(ocsp_ptr[0], ocsp_len)[:] valid = callback(conn, ocsp_data, data) # Return 1 on success or 0 on error. return int(bool(valid)) except Exception as e: self._problems.append(e) # Return negative value if an exception is hit. return -1 self.callback = _ffi.callback("int (*)(SSL *, void *)", wrapper) def _asFileDescriptor(obj): fd = None if not isinstance(obj, integer_types): meth = getattr(obj, "fileno", None) if meth is not None: obj = meth() if isinstance(obj, integer_types): fd = obj if not isinstance(fd, integer_types): raise TypeError("argument must be an int, or have a fileno() method.") elif fd < 0: raise ValueError( "file descriptor cannot be a negative integer (%i)" % (fd,) ) return fd def SSLeay_version(type): """ Return a string describing the version of OpenSSL in use. :param type: One of the :const:`SSLEAY_` constants defined in this module. """ return _ffi.string(_lib.SSLeay_version(type)) def _make_requires(flag, error): """ 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. """ def _requires_decorator(func): if not flag: @wraps(func) def explode(*args, **kwargs): raise NotImplementedError(error) return explode else: return func return _requires_decorator _requires_alpn = _make_requires( _lib.Cryptography_HAS_ALPN, "ALPN not available" ) _requires_keylog = _make_requires( getattr(_lib, "Cryptography_HAS_KEYLOG", None), "Key logging not available" ) class Session(object): """ 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 """ pass class Context(object): """ :class:`OpenSSL.SSL.Context` instances define the parameters for setting up new SSL connections. :param method: One of TLS_METHOD, TLS_CLIENT_METHOD, or TLS_SERVER_METHOD. SSLv23_METHOD, TLSv1_METHOD, etc. are deprecated and should not be used. """ _methods = { SSLv2_METHOD: "SSLv2_method", SSLv3_METHOD: "SSLv3_method", SSLv23_METHOD: "SSLv23_method", TLSv1_METHOD: "TLSv1_method", TLSv1_1_METHOD: "TLSv1_1_method", TLSv1_2_METHOD: "TLSv1_2_method", TLS_METHOD: "TLS_method", TLS_SERVER_METHOD: "TLS_server_method", TLS_CLIENT_METHOD: "TLS_client_method", } _methods = dict( (identifier, getattr(_lib, name)) for (identifier, name) in _methods.items() if getattr(_lib, name, None) is not None ) def __init__(self, method): if not isinstance(method, integer_types): raise TypeError("method must be an integer") try: method_func = self._methods[method] except KeyError: raise ValueError("No such protocol") method_obj = method_func() _openssl_assert(method_obj != _ffi.NULL) context = _lib.SSL_CTX_new(method_obj) _openssl_assert(context != _ffi.NULL) context = _ffi.gc(context, _lib.SSL_CTX_free) # Set SSL_CTX_set_ecdh_auto so that the ECDH curve will be # auto-selected. This function was added in 1.0.2 and made a noop in # 1.1.0+ (where it is set automatically). res = _lib.SSL_CTX_set_ecdh_auto(context, 1) _openssl_assert(res == 1) self._context = context self._passphrase_helper = None self._passphrase_callback = None self._passphrase_userdata = None self._verify_helper = None self._verify_callback = None self._info_callback = None self._keylog_callback = None self._tlsext_servername_callback = None self._app_data = None self._alpn_select_helper = None self._alpn_select_callback = None self._ocsp_helper = None self._ocsp_callback = None self._ocsp_data = None self.set_mode(_lib.SSL_MODE_ENABLE_PARTIAL_WRITE) def set_min_proto_version(self, version): """ Set the minimum supported protocol version. Setting the minimum version to 0 will enable protocol versions down to the lowest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. """ _openssl_assert( _lib.SSL_CTX_set_min_proto_version(self._context, version) == 1 ) def set_max_proto_version(self, version): """ Set the maximum supported protocol version. Setting the maximum version to 0 will enable protocol versions up to the highest version supported by the library. If the underlying OpenSSL build is missing support for the selected version, this method will raise an exception. """ _openssl_assert( _lib.SSL_CTX_set_max_proto_version(self._context, version) == 1 ) def load_verify_locations(self, cafile, capath=None): """ 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 """ if cafile is None: cafile = _ffi.NULL else: cafile = _path_string(cafile) if capath is None: capath = _ffi.NULL else: capath = _path_string(capath) load_result = _lib.SSL_CTX_load_verify_locations( self._context, cafile, capath ) if not load_result: _raise_current_error() def _wrap_callback(self, callback): @wraps(callback) def wrapper(size, verify, userdata): return callback(size, verify, self._passphrase_userdata) return _PassphraseHelper( FILETYPE_PEM, wrapper, more_args=True, truncate=True ) def set_passwd_cb(self, callback, userdata=None): """ 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 """ if not callable(callback): raise TypeError("callback must be callable") self._passphrase_helper = self._wrap_callback(callback) self._passphrase_callback = self._passphrase_helper.callback _lib.SSL_CTX_set_default_passwd_cb( self._context, self._passphrase_callback ) self._passphrase_userdata = userdata def set_default_verify_paths(self): """ 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 """ # SSL_CTX_set_default_verify_paths will attempt to load certs from # both a cafile and capath that are set at compile time. However, # it will first check environment variables and, if present, load # those paths instead set_result = _lib.SSL_CTX_set_default_verify_paths(self._context) _openssl_assert(set_result == 1) # After attempting to set default_verify_paths we need to know whether # to go down the fallback path. # First we'll check to see if any env vars have been set. If so, # we won't try to do anything else because the user has set the path # themselves. dir_env_var = _ffi.string(_lib.X509_get_default_cert_dir_env()).decode( "ascii" ) file_env_var = _ffi.string( _lib.X509_get_default_cert_file_env() ).decode("ascii") if not self._check_env_vars_set(dir_env_var, file_env_var): default_dir = _ffi.string(_lib.X509_get_default_cert_dir()) default_file = _ffi.string(_lib.X509_get_default_cert_file()) # Now we check to see if the default_dir and default_file are set # to the exact values we use in our manylinux1 builds. If they are # then we know to load the fallbacks if ( default_dir == _CRYPTOGRAPHY_MANYLINUX1_CA_DIR and default_file == _CRYPTOGRAPHY_MANYLINUX1_CA_FILE ): # This is manylinux1, let's load our fallback paths self._fallback_default_verify_paths( _CERTIFICATE_FILE_LOCATIONS, _CERTIFICATE_PATH_LOCATIONS ) def _check_env_vars_set(self, dir_env_var, file_env_var): """ Check to see if the default cert dir/file environment vars are present. :return: bool """ return ( os.environ.get(file_env_var) is not None or os.environ.get(dir_env_var) is not None ) def _fallback_default_verify_paths(self, file_path, dir_path): """ 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 """ for cafile in file_path: if os.path.isfile(cafile): self.load_verify_locations(cafile) break for capath in dir_path: if os.path.isdir(capath): self.load_verify_locations(None, capath) break def use_certificate_chain_file(self, certfile): """ 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 """ certfile = _path_string(certfile) result = _lib.SSL_CTX_use_certificate_chain_file( self._context, certfile ) if not result: _raise_current_error() def use_certificate_file(self, certfile, filetype=FILETYPE_PEM): """ 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 """ certfile = _path_string(certfile) if not isinstance(filetype, integer_types): raise TypeError("filetype must be an integer") use_result = _lib.SSL_CTX_use_certificate_file( self._context, certfile, filetype ) if not use_result: _raise_current_error() def use_certificate(self, cert): """ Load a certificate from a X509 object :param cert: The X509 object :return: None """ if not isinstance(cert, X509): raise TypeError("cert must be an X509 instance") use_result = _lib.SSL_CTX_use_certificate(self._context, cert._x509) if not use_result: _raise_current_error() def add_extra_chain_cert(self, certobj): """ Add certificate to chain :param certobj: The X509 certificate object to add to the chain :return: None """ if not isinstance(certobj, X509): raise TypeError("certobj must be an X509 instance") copy = _lib.X509_dup(certobj._x509) add_result = _lib.SSL_CTX_add_extra_chain_cert(self._context, copy) if not add_result: # TODO: This is untested. _lib.X509_free(copy) _raise_current_error() def _raise_passphrase_exception(self): if self._passphrase_helper is not None: self._passphrase_helper.raise_if_problem(Error) _raise_current_error() def use_privatekey_file(self, keyfile, filetype=_UNSPECIFIED): """ 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 """ keyfile = _path_string(keyfile) if filetype is _UNSPECIFIED: filetype = FILETYPE_PEM elif not isinstance(filetype, integer_types): raise TypeError("filetype must be an integer") use_result = _lib.SSL_CTX_use_PrivateKey_file( self._context, keyfile, filetype ) if not use_result: self._raise_passphrase_exception() def use_privatekey(self, pkey): """ Load a private key from a PKey object :param pkey: The PKey object :return: None """ if not isinstance(pkey, PKey): raise TypeError("pkey must be a PKey instance") use_result = _lib.SSL_CTX_use_PrivateKey(self._context, pkey._pkey) if not use_result: self._raise_passphrase_exception() def check_privatekey(self): """ 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) """ if not _lib.SSL_CTX_check_private_key(self._context): _raise_current_error() def load_client_ca(self, cafile): """ 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 """ ca_list = _lib.SSL_load_client_CA_file( _text_to_bytes_and_warn("cafile", cafile) ) _openssl_assert(ca_list != _ffi.NULL) _lib.SSL_CTX_set_client_CA_list(self._context, ca_list) def set_session_id(self, buf): """ 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 """ buf = _text_to_bytes_and_warn("buf", buf) _openssl_assert( _lib.SSL_CTX_set_session_id_context(self._context, buf, len(buf)) == 1 ) def set_session_cache_mode(self, mode): """ 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 """ if not isinstance(mode, integer_types): raise TypeError("mode must be an integer") return _lib.SSL_CTX_set_session_cache_mode(self._context, mode) def get_session_cache_mode(self): """ Get the current session cache mode. :returns: The currently used cache mode. .. versionadded:: 0.14 """ return _lib.SSL_CTX_get_session_cache_mode(self._context) def set_verify(self, mode, callback=None): """ 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. """ if not isinstance(mode, integer_types): raise TypeError("mode must be an integer") if callback is None: self._verify_helper = None self._verify_callback = None _lib.SSL_CTX_set_verify(self._context, mode, _ffi.NULL) else: if not callable(callback): raise TypeError("callback must be callable") self._verify_helper = _VerifyHelper(callback) self._verify_callback = self._verify_helper.callback _lib.SSL_CTX_set_verify(self._context, mode, self._verify_callback) def set_verify_depth(self, depth): """ 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 """ if not isinstance(depth, integer_types): raise TypeError("depth must be an integer") _lib.SSL_CTX_set_verify_depth(self._context, depth) def get_verify_mode(self): """ Retrieve the Context object's verify mode, as set by :meth:`set_verify`. :return: The verify mode """ return _lib.SSL_CTX_get_verify_mode(self._context) def get_verify_depth(self): """ Retrieve the Context object's verify depth, as set by :meth:`set_verify_depth`. :return: The verify depth """ return _lib.SSL_CTX_get_verify_depth(self._context) def load_tmp_dh(self, dhfile): """ Load parameters for Ephemeral Diffie-Hellman :param dhfile: The file to load EDH parameters from (``bytes`` or ``unicode``). :return: None """ dhfile = _path_string(dhfile) bio = _lib.BIO_new_file(dhfile, b"r") if bio == _ffi.NULL: _raise_current_error() bio = _ffi.gc(bio, _lib.BIO_free) dh = _lib.PEM_read_bio_DHparams(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) dh = _ffi.gc(dh, _lib.DH_free) res = _lib.SSL_CTX_set_tmp_dh(self._context, dh) _openssl_assert(res == 1) def set_tmp_ecdh(self, curve): """ 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 """ _lib.SSL_CTX_set_tmp_ecdh(self._context, curve._to_EC_KEY()) def set_cipher_list(self, cipher_list): """ 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_list = _text_to_bytes_and_warn("cipher_list", cipher_list) if not isinstance(cipher_list, bytes): raise TypeError("cipher_list must be a byte string.") _openssl_assert( _lib.SSL_CTX_set_cipher_list(self._context, cipher_list) == 1 ) # In OpenSSL 1.1.1 setting the cipher list will always return TLS 1.3 # ciphers even if you pass an invalid cipher. Applications (like # Twisted) have tests that depend on an error being raised if an # invalid cipher string is passed, but without the following check # for the TLS 1.3 specific cipher suites it would never error. tmpconn = Connection(self, None) if tmpconn.get_cipher_list() == [ "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_GCM_SHA256", ]: raise Error( [ ( "SSL routines", "SSL_CTX_set_cipher_list", "no cipher match", ), ], ) def set_client_ca_list(self, certificate_authorities): """ 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 """ name_stack = _lib.sk_X509_NAME_new_null() _openssl_assert(name_stack != _ffi.NULL) try: for ca_name in certificate_authorities: if not isinstance(ca_name, X509Name): raise TypeError( "client CAs must be X509Name objects, not %s " "objects" % (type(ca_name).__name__,) ) copy = _lib.X509_NAME_dup(ca_name._name) _openssl_assert(copy != _ffi.NULL) push_result = _lib.sk_X509_NAME_push(name_stack, copy) if not push_result: _lib.X509_NAME_free(copy) _raise_current_error() except Exception: _lib.sk_X509_NAME_free(name_stack) raise _lib.SSL_CTX_set_client_CA_list(self._context, name_stack) def add_client_ca(self, certificate_authority): """ 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 """ if not isinstance(certificate_authority, X509): raise TypeError("certificate_authority must be an X509 instance") add_result = _lib.SSL_CTX_add_client_CA( self._context, certificate_authority._x509 ) _openssl_assert(add_result == 1) def set_timeout(self, timeout): """ 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 """ if not isinstance(timeout, integer_types): raise TypeError("timeout must be an integer") return _lib.SSL_CTX_set_timeout(self._context, timeout) def get_timeout(self): """ Retrieve session timeout, as set by :meth:`set_timeout`. The default is 300 seconds. :return: The session timeout """ return _lib.SSL_CTX_get_timeout(self._context) def set_info_callback(self, callback): """ 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 """ @wraps(callback) def wrapper(ssl, where, return_code): callback(Connection._reverse_mapping[ssl], where, return_code) self._info_callback = _ffi.callback( "void (*)(const SSL *, int, int)", wrapper ) _lib.SSL_CTX_set_info_callback(self._context, self._info_callback) @_requires_keylog def set_keylog_callback(self, callback): """ 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 """ @wraps(callback) def wrapper(ssl, line): line = _ffi.string(line) callback(Connection._reverse_mapping[ssl], line) self._keylog_callback = _ffi.callback( "void (*)(const SSL *, const char *)", wrapper ) _lib.SSL_CTX_set_keylog_callback(self._context, self._keylog_callback) def get_app_data(self): """ Get the application data (supplied via :meth:`set_app_data()`) :return: The application data """ return self._app_data def set_app_data(self, data): """ Set the application data (will be returned from get_app_data()) :param data: Any Python object :return: None """ self._app_data = data def get_cert_store(self): """ 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. """ store = _lib.SSL_CTX_get_cert_store(self._context) if store == _ffi.NULL: # TODO: This is untested. return None pystore = X509Store.__new__(X509Store) pystore._store = store return pystore def set_options(self, options): """ 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. """ if not isinstance(options, integer_types): raise TypeError("options must be an integer") return _lib.SSL_CTX_set_options(self._context, options) def set_mode(self, mode): """ 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. """ if not isinstance(mode, integer_types): raise TypeError("mode must be an integer") return _lib.SSL_CTX_set_mode(self._context, mode) def set_tlsext_servername_callback(self, callback): """ 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 """ @wraps(callback) def wrapper(ssl, alert, arg): callback(Connection._reverse_mapping[ssl]) return 0 self._tlsext_servername_callback = _ffi.callback( "int (*)(SSL *, int *, void *)", wrapper ) _lib.SSL_CTX_set_tlsext_servername_callback( self._context, self._tlsext_servername_callback ) def set_tlsext_use_srtp(self, profiles): """ 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 """ if not isinstance(profiles, bytes): raise TypeError("profiles must be a byte string.") _openssl_assert( _lib.SSL_CTX_set_tlsext_use_srtp(self._context, profiles) == 0 ) @_requires_alpn def set_alpn_protos(self, protos): """ 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']``. """ # Take the list of protocols and join them together, prefixing them # with their lengths. protostr = b"".join( chain.from_iterable((int2byte(len(p)), p) for p in protos) ) # Build a C string from the list. We don't need to save this off # because OpenSSL immediately copies the data out. input_str = _ffi.new("unsigned char[]", protostr) # https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set_alpn_protos.html: # SSL_CTX_set_alpn_protos() and SSL_set_alpn_protos() # return 0 on success, and non-0 on failure. # WARNING: these functions reverse the return value convention. _openssl_assert( _lib.SSL_CTX_set_alpn_protos( self._context, input_str, len(protostr) ) == 0 ) @_requires_alpn def set_alpn_select_callback(self, callback): """ 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. """ self._alpn_select_helper = _ALPNSelectHelper(callback) self._alpn_select_callback = self._alpn_select_helper.callback _lib.SSL_CTX_set_alpn_select_cb( self._context, self._alpn_select_callback, _ffi.NULL ) def _set_ocsp_callback(self, helper, data): """ This internal helper does the common work for ``set_ocsp_server_callback`` and ``set_ocsp_client_callback``, which is almost all of it. """ self._ocsp_helper = helper self._ocsp_callback = helper.callback if data is None: self._ocsp_data = _ffi.NULL else: self._ocsp_data = _ffi.new_handle(data) rc = _lib.SSL_CTX_set_tlsext_status_cb( self._context, self._ocsp_callback ) _openssl_assert(rc == 1) rc = _lib.SSL_CTX_set_tlsext_status_arg(self._context, self._ocsp_data) _openssl_assert(rc == 1) def set_ocsp_server_callback(self, callback, data=None): """ 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. """ helper = _OCSPServerCallbackHelper(callback) self._set_ocsp_callback(helper, data) def set_ocsp_client_callback(self, callback, data=None): """ 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. """ helper = _OCSPClientCallbackHelper(callback) self._set_ocsp_callback(helper, data) class Connection(object): _reverse_mapping = WeakValueDictionary() def __init__(self, context, socket=None): """ 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 """ if not isinstance(context, Context): raise TypeError("context must be a Context instance") ssl = _lib.SSL_new(context._context) self._ssl = _ffi.gc(ssl, _lib.SSL_free) # We set SSL_MODE_AUTO_RETRY to handle situations where OpenSSL returns # an SSL_ERROR_WANT_READ when processing a non-application data packet # even though there is still data on the underlying transport. # See https://github.com/openssl/openssl/issues/6234 for more details. _lib.SSL_set_mode(self._ssl, _lib.SSL_MODE_AUTO_RETRY) self._context = context self._app_data = None # References to strings used for Application Layer Protocol # Negotiation. These strings get copied at some point but it's well # after the callback returns, so we have to hang them somewhere to # avoid them getting freed. self._alpn_select_callback_args = None # Reference the verify_callback of the Context. This ensures that if # set_verify is called again after the SSL object has been created we # do not point to a dangling reference self._verify_helper = context._verify_helper self._verify_callback = context._verify_callback self._reverse_mapping[self._ssl] = self if socket is None: self._socket = None # Don't set up any gc for these, SSL_free will take care of them. self._into_ssl = _lib.BIO_new(_lib.BIO_s_mem()) _openssl_assert(self._into_ssl != _ffi.NULL) self._from_ssl = _lib.BIO_new(_lib.BIO_s_mem()) _openssl_assert(self._from_ssl != _ffi.NULL) _lib.SSL_set_bio(self._ssl, self._into_ssl, self._from_ssl) else: self._into_ssl = None self._from_ssl = None self._socket = socket set_result = _lib.SSL_set_fd( self._ssl, _asFileDescriptor(self._socket) ) _openssl_assert(set_result == 1) def __getattr__(self, name): """ Look up attributes on the wrapped socket object if they are not found on the Connection object. """ if self._socket is None: raise AttributeError( "'%s' object has no attribute '%s'" % (self.__class__.__name__, name) ) else: return getattr(self._socket, name) def _raise_ssl_error(self, ssl, result): if self._context._verify_helper is not None: self._context._verify_helper.raise_if_problem() if self._context._alpn_select_helper is not None: self._context._alpn_select_helper.raise_if_problem() if self._context._ocsp_helper is not None: self._context._ocsp_helper.raise_if_problem() error = _lib.SSL_get_error(ssl, result) if error == _lib.SSL_ERROR_WANT_READ: raise WantReadError() elif error == _lib.SSL_ERROR_WANT_WRITE: raise WantWriteError() elif error == _lib.SSL_ERROR_ZERO_RETURN: raise ZeroReturnError() elif error == _lib.SSL_ERROR_WANT_X509_LOOKUP: # TODO: This is untested. raise WantX509LookupError() elif error == _lib.SSL_ERROR_SYSCALL: if _lib.ERR_peek_error() == 0: if result < 0: if platform == "win32": errno = _ffi.getwinerror()[0] else: errno = _ffi.errno if errno != 0: raise SysCallError(errno, errorcode.get(errno)) raise SysCallError(-1, "Unexpected EOF") else: # TODO: This is untested. _raise_current_error() elif error == _lib.SSL_ERROR_NONE: pass else: _raise_current_error() def get_context(self): """ Retrieve the :class:`Context` object associated with this :class:`Connection`. """ return self._context def set_context(self, context): """ Switch this connection to a new session context. :param context: A :class:`Context` instance giving the new session context to use. """ if not isinstance(context, Context): raise TypeError("context must be a Context instance") _lib.SSL_set_SSL_CTX(self._ssl, context._context) self._context = context def get_servername(self): """ 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 """ name = _lib.SSL_get_servername( self._ssl, _lib.TLSEXT_NAMETYPE_host_name ) if name == _ffi.NULL: return None return _ffi.string(name) def set_tlsext_host_name(self, name): """ Set the value of the servername extension to send in the client hello. :param name: A byte string giving the name. .. versionadded:: 0.13 """ if not isinstance(name, bytes): raise TypeError("name must be a byte string") elif b"\0" in name: raise TypeError("name must not contain NUL byte") # XXX I guess this can fail sometimes? _lib.SSL_set_tlsext_host_name(self._ssl, name) def pending(self): """ 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. """ return _lib.SSL_pending(self._ssl) def send(self, buf, flags=0): """ 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 """ # Backward compatibility buf = _text_to_bytes_and_warn("buf", buf) with _ffi.from_buffer(buf) as data: # check len(buf) instead of len(data) for testability if len(buf) > 2147483647: raise ValueError( "Cannot send more than 2**31-1 bytes at once." ) result = _lib.SSL_write(self._ssl, data, len(data)) self._raise_ssl_error(self._ssl, result) return result write = send def sendall(self, buf, flags=0): """ 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 """ buf = _text_to_bytes_and_warn("buf", buf) with _ffi.from_buffer(buf) as data: left_to_send = len(buf) total_sent = 0 while left_to_send: # SSL_write's num arg is an int, # so we cannot send more than 2**31-1 bytes at once. result = _lib.SSL_write( self._ssl, data + total_sent, min(left_to_send, 2147483647) ) self._raise_ssl_error(self._ssl, result) total_sent += result left_to_send -= result return total_sent def recv(self, bufsiz, flags=None): """ 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 """ buf = _no_zero_allocator("char[]", bufsiz) if flags is not None and flags & socket.MSG_PEEK: result = _lib.SSL_peek(self._ssl, buf, bufsiz) else: result = _lib.SSL_read(self._ssl, buf, bufsiz) self._raise_ssl_error(self._ssl, result) return _ffi.buffer(buf, result)[:] read = recv def recv_into(self, buffer, nbytes=None, flags=None): """ 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. """ if nbytes is None: nbytes = len(buffer) else: nbytes = min(nbytes, len(buffer)) # We need to create a temporary buffer. This is annoying, it would be # better if we could pass memoryviews straight into the SSL_read call, # but right now we can't. Revisit this if CFFI gets that ability. buf = _no_zero_allocator("char[]", nbytes) if flags is not None and flags & socket.MSG_PEEK: result = _lib.SSL_peek(self._ssl, buf, nbytes) else: result = _lib.SSL_read(self._ssl, buf, nbytes) self._raise_ssl_error(self._ssl, result) # This strange line is all to avoid a memory copy. The buffer protocol # should allow us to assign a CFFI buffer to the LHS of this line, but # on CPython 3.3+ that segfaults. As a workaround, we can temporarily # wrap it in a memoryview. buffer[:result] = memoryview(_ffi.buffer(buf, result)) return result def _handle_bio_errors(self, bio, result): if _lib.BIO_should_retry(bio): if _lib.BIO_should_read(bio): raise WantReadError() elif _lib.BIO_should_write(bio): # TODO: This is untested. raise WantWriteError() elif _lib.BIO_should_io_special(bio): # TODO: This is untested. I think io_special means the socket # BIO has a not-yet connected socket. raise ValueError("BIO_should_io_special") else: # TODO: This is untested. raise ValueError("unknown bio failure") else: # TODO: This is untested. _raise_current_error() def bio_read(self, bufsiz): """ 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. """ if self._from_ssl is None: raise TypeError("Connection sock was not None") if not isinstance(bufsiz, integer_types): raise TypeError("bufsiz must be an integer") buf = _no_zero_allocator("char[]", bufsiz) result = _lib.BIO_read(self._from_ssl, buf, bufsiz) if result <= 0: self._handle_bio_errors(self._from_ssl, result) return _ffi.buffer(buf, result)[:] def bio_write(self, buf): """ 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 """ buf = _text_to_bytes_and_warn("buf", buf) if self._into_ssl is None: raise TypeError("Connection sock was not None") with _ffi.from_buffer(buf) as data: result = _lib.BIO_write(self._into_ssl, data, len(data)) if result <= 0: self._handle_bio_errors(self._into_ssl, result) return result def renegotiate(self): """ Renegotiate the session. :return: True if the renegotiation can be started, False otherwise :rtype: bool """ if not self.renegotiate_pending(): _openssl_assert(_lib.SSL_renegotiate(self._ssl) == 1) return True return False def do_handshake(self): """ 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. """ result = _lib.SSL_do_handshake(self._ssl) self._raise_ssl_error(self._ssl, result) def renegotiate_pending(self): """ 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 """ return _lib.SSL_renegotiate_pending(self._ssl) == 1 def total_renegotiations(self): """ Find out the total number of renegotiations. :return: The number of renegotiations. :rtype: int """ return _lib.SSL_total_renegotiations(self._ssl) def connect(self, addr): """ 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 """ _lib.SSL_set_connect_state(self._ssl) return self._socket.connect(addr) def connect_ex(self, addr): """ 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 """ connect_ex = self._socket.connect_ex self.set_connect_state() return connect_ex(addr) def accept(self): """ 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`. """ client, addr = self._socket.accept() conn = Connection(self._context, client) conn.set_accept_state() return (conn, addr) def bio_shutdown(self): """ 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 """ if self._from_ssl is None: raise TypeError("Connection sock was not None") _lib.BIO_set_mem_eof_return(self._into_ssl, 0) def shutdown(self): """ 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). """ result = _lib.SSL_shutdown(self._ssl) if result < 0: self._raise_ssl_error(self._ssl, result) elif result > 0: return True else: return False def get_cipher_list(self): """ Retrieve the list of ciphers used by the Connection object. :return: A list of native cipher strings. """ ciphers = [] for i in count(): result = _lib.SSL_get_cipher_list(self._ssl, i) if result == _ffi.NULL: break ciphers.append(_native(_ffi.string(result))) return ciphers def get_client_ca_list(self): """ 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 """ ca_names = _lib.SSL_get_client_CA_list(self._ssl) if ca_names == _ffi.NULL: # TODO: This is untested. return [] result = [] for i in range(_lib.sk_X509_NAME_num(ca_names)): name = _lib.sk_X509_NAME_value(ca_names, i) copy = _lib.X509_NAME_dup(name) _openssl_assert(copy != _ffi.NULL) pyname = X509Name.__new__(X509Name) pyname._name = _ffi.gc(copy, _lib.X509_NAME_free) result.append(pyname) return result def makefile(self, *args, **kwargs): """ The makefile() method is not implemented, since there is no dup semantics for SSL connections :raise: NotImplementedError """ raise NotImplementedError( "Cannot make file object of OpenSSL.SSL.Connection" ) def get_app_data(self): """ Retrieve application data as set by :meth:`set_app_data`. :return: The application data """ return self._app_data def set_app_data(self, data): """ Set application data :param data: The application data :return: None """ self._app_data = data def get_shutdown(self): """ Get the shutdown state of the Connection. :return: The shutdown state, a bitvector of SENT_SHUTDOWN, RECEIVED_SHUTDOWN. """ return _lib.SSL_get_shutdown(self._ssl) def set_shutdown(self, state): """ Set the shutdown state of the Connection. :param state: bitvector of SENT_SHUTDOWN, RECEIVED_SHUTDOWN. :return: None """ if not isinstance(state, integer_types): raise TypeError("state must be an integer") _lib.SSL_set_shutdown(self._ssl, state) def get_state_string(self): """ Retrieve a verbose string detailing the state of the Connection. :return: A string representing the state :rtype: bytes """ return _ffi.string(_lib.SSL_state_string_long(self._ssl)) def server_random(self): """ Retrieve the random value used with the server hello message. :return: A string representing the state """ session = _lib.SSL_get_session(self._ssl) if session == _ffi.NULL: return None length = _lib.SSL_get_server_random(self._ssl, _ffi.NULL, 0) _openssl_assert(length > 0) outp = _no_zero_allocator("unsigned char[]", length) _lib.SSL_get_server_random(self._ssl, outp, length) return _ffi.buffer(outp, length)[:] def client_random(self): """ Retrieve the random value used with the client hello message. :return: A string representing the state """ session = _lib.SSL_get_session(self._ssl) if session == _ffi.NULL: return None length = _lib.SSL_get_client_random(self._ssl, _ffi.NULL, 0) _openssl_assert(length > 0) outp = _no_zero_allocator("unsigned char[]", length) _lib.SSL_get_client_random(self._ssl, outp, length) return _ffi.buffer(outp, length)[:] def master_key(self): """ Retrieve the value of the master key for this session. :return: A string representing the state """ session = _lib.SSL_get_session(self._ssl) if session == _ffi.NULL: return None length = _lib.SSL_SESSION_get_master_key(session, _ffi.NULL, 0) _openssl_assert(length > 0) outp = _no_zero_allocator("unsigned char[]", length) _lib.SSL_SESSION_get_master_key(session, outp, length) return _ffi.buffer(outp, length)[:] def export_keying_material(self, label, olen, context=None): """ 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 """ outp = _no_zero_allocator("unsigned char[]", olen) context_buf = _ffi.NULL context_len = 0 use_context = 0 if context is not None: context_buf = context context_len = len(context) use_context = 1 success = _lib.SSL_export_keying_material( self._ssl, outp, olen, label, len(label), context_buf, context_len, use_context, ) _openssl_assert(success == 1) return _ffi.buffer(outp, olen)[:] def sock_shutdown(self, *args, **kwargs): """ Call the :meth:`shutdown` method of the underlying socket. See :manpage:`shutdown(2)`. :return: What the socket's shutdown() method returns """ return self._socket.shutdown(*args, **kwargs) def get_certificate(self): """ Retrieve the local certificate (if any) :return: The local certificate """ cert = _lib.SSL_get_certificate(self._ssl) if cert != _ffi.NULL: _lib.X509_up_ref(cert) return X509._from_raw_x509_ptr(cert) return None def get_peer_certificate(self): """ Retrieve the other side's certificate (if any) :return: The peer's certificate """ cert = _lib.SSL_get_peer_certificate(self._ssl) if cert != _ffi.NULL: return X509._from_raw_x509_ptr(cert) return None @staticmethod def _cert_stack_to_list(cert_stack): """ Internal helper to convert a STACK_OF(X509) to a list of X509 instances. """ result = [] for i in range(_lib.sk_X509_num(cert_stack)): cert = _lib.sk_X509_value(cert_stack, i) _openssl_assert(cert != _ffi.NULL) res = _lib.X509_up_ref(cert) _openssl_assert(res >= 1) pycert = X509._from_raw_x509_ptr(cert) result.append(pycert) return result def get_peer_cert_chain(self): """ 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. """ cert_stack = _lib.SSL_get_peer_cert_chain(self._ssl) if cert_stack == _ffi.NULL: return None return self._cert_stack_to_list(cert_stack) def get_verified_chain(self): """ 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 """ # OpenSSL 1.1+ cert_stack = _lib.SSL_get0_verified_chain(self._ssl) if cert_stack == _ffi.NULL: return None return self._cert_stack_to_list(cert_stack) def want_read(self): """ 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 """ return _lib.SSL_want_read(self._ssl) def want_write(self): """ Checks if there is data to write to the transport layer to complete an operation. :return: True iff there is data to write """ return _lib.SSL_want_write(self._ssl) def set_accept_state(self): """ Set the connection to work in server mode. The handshake will be handled automatically by read/write. :return: None """ _lib.SSL_set_accept_state(self._ssl) def set_connect_state(self): """ Set the connection to work in client mode. The handshake will be handled automatically by read/write. :return: None """ _lib.SSL_set_connect_state(self._ssl) def get_session(self): """ Returns the Session currently used. :return: An instance of :class:`OpenSSL.SSL.Session` or :obj:`None` if no session exists. .. versionadded:: 0.14 """ session = _lib.SSL_get1_session(self._ssl) if session == _ffi.NULL: return None pysession = Session.__new__(Session) pysession._session = _ffi.gc(session, _lib.SSL_SESSION_free) return pysession def set_session(self, session): """ 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 """ if not isinstance(session, Session): raise TypeError("session must be a Session instance") result = _lib.SSL_set_session(self._ssl, session._session) _openssl_assert(result == 1) def _get_finished_message(self, function): """ 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` """ # The OpenSSL documentation says nothing about what might happen if the # count argument given is zero. Specifically, it doesn't say whether # the output buffer may be NULL in that case or not. Inspection of the # implementation reveals that it calls memcpy() unconditionally. # Section 7.1.4, paragraph 1 of the C standard suggests that # memcpy(NULL, source, 0) is not guaranteed to produce defined (let # alone desirable) behavior (though it probably does on just about # every implementation...) # # Allocate a tiny buffer to pass in (instead of just passing NULL as # one might expect) for the initial call so as to be safe against this # potentially undefined behavior. empty = _ffi.new("char[]", 0) size = function(self._ssl, empty, 0) if size == 0: # No Finished message so far. return None buf = _no_zero_allocator("char[]", size) function(self._ssl, buf, size) return _ffi.buffer(buf, size)[:] def get_finished(self): """ 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 """ return self._get_finished_message(_lib.SSL_get_finished) def get_peer_finished(self): """ 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 """ return self._get_finished_message(_lib.SSL_get_peer_finished) def get_cipher_name(self): """ 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 """ cipher = _lib.SSL_get_current_cipher(self._ssl) if cipher == _ffi.NULL: return None else: name = _ffi.string(_lib.SSL_CIPHER_get_name(cipher)) return name.decode("utf-8") def get_cipher_bits(self): """ 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 """ cipher = _lib.SSL_get_current_cipher(self._ssl) if cipher == _ffi.NULL: return None else: return _lib.SSL_CIPHER_get_bits(cipher, _ffi.NULL) def get_cipher_version(self): """ 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 """ cipher = _lib.SSL_get_current_cipher(self._ssl) if cipher == _ffi.NULL: return None else: version = _ffi.string(_lib.SSL_CIPHER_get_version(cipher)) return version.decode("utf-8") def get_protocol_version_name(self): """ 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` """ version = _ffi.string(_lib.SSL_get_version(self._ssl)) return version.decode("utf-8") def get_protocol_version(self): """ 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` """ version = _lib.SSL_version(self._ssl) return version @_requires_alpn def set_alpn_protos(self, protos): """ 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']``. """ # Take the list of protocols and join them together, prefixing them # with their lengths. protostr = b"".join( chain.from_iterable((int2byte(len(p)), p) for p in protos) ) # Build a C string from the list. We don't need to save this off # because OpenSSL immediately copies the data out. input_str = _ffi.new("unsigned char[]", protostr) # https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set_alpn_protos.html: # SSL_CTX_set_alpn_protos() and SSL_set_alpn_protos() # return 0 on success, and non-0 on failure. # WARNING: these functions reverse the return value convention. _openssl_assert( _lib.SSL_set_alpn_protos(self._ssl, input_str, len(protostr)) == 0 ) @_requires_alpn def get_alpn_proto_negotiated(self): """ 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. """ data = _ffi.new("unsigned char **") data_len = _ffi.new("unsigned int *") _lib.SSL_get0_alpn_selected(self._ssl, data, data_len) if not data_len: return b"" return _ffi.buffer(data[0], data_len[0])[:] def request_ocsp(self): """ 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`. """ rc = _lib.SSL_set_tlsext_status_type( self._ssl, _lib.TLSEXT_STATUSTYPE_ocsp ) _openssl_assert(rc == 1) # This is similar to the initialization calls at the end of OpenSSL/crypto.py # but is exercised mostly by the Context initializer. _lib.SSL_library_init() debug.py 0000644 00000002030 15025013455 0006177 0 ustar 00 from __future__ import print_function import ssl import sys import OpenSSL.SSL import cffi import cryptography from . import version _env_info = u"""\ pyOpenSSL: {pyopenssl} cryptography: {cryptography} cffi: {cffi} cryptography's compiled against OpenSSL: {crypto_openssl_compile} cryptography's linked OpenSSL: {crypto_openssl_link} Python's OpenSSL: {python_openssl} Python executable: {python} Python version: {python_version} Platform: {platform} sys.path: {sys_path}""".format( pyopenssl=version.__version__, crypto_openssl_compile=OpenSSL._util.ffi.string( OpenSSL._util.lib.OPENSSL_VERSION_TEXT, ).decode("ascii"), crypto_openssl_link=OpenSSL.SSL.SSLeay_version( OpenSSL.SSL.SSLEAY_VERSION ).decode("ascii"), python_openssl=getattr(ssl, "OPENSSL_VERSION", "n/a"), cryptography=cryptography.__version__, cffi=cffi.__version__, python=sys.executable, python_version=sys.version, platform=sys.platform, sys_path=sys.path, ) if __name__ == "__main__": print(_env_info) rand.py 0000644 00000002022 15025013455 0006036 0 ustar 00 """ PRNG management routines, thin wrappers. """ from OpenSSL._util import lib as _lib def add(buffer, entropy): """ Mix bytes from *string* into the PRNG state. The *entropy* argument is (the lower bound of) an estimate of how much randomness is contained in *string*, measured in bytes. For more information, see e.g. :rfc:`1750`. This function is only relevant if you are forking Python processes and need to reseed the CSPRNG after fork. :param buffer: Buffer with random data. :param entropy: The entropy (in bytes) measurement of the buffer. :return: :obj:`None` """ if not isinstance(buffer, bytes): raise TypeError("buffer must be a byte string") if not isinstance(entropy, int): raise TypeError("entropy must be an integer") _lib.RAND_add(buffer, len(buffer), entropy) def status(): """ Check whether the PRNG has been seeded with enough data. :return: 1 if the PRNG is seeded enough, 0 otherwise. """ return _lib.RAND_status() __init__.py 0000644 00000000762 15025013455 0006662 0 ustar 00 # Copyright (C) AB Strakt # See LICENSE for details. """ pyOpenSSL - A simple wrapper around the OpenSSL library """ from OpenSSL import crypto, SSL from OpenSSL.version import ( __author__, __copyright__, __email__, __license__, __summary__, __title__, __uri__, __version__, ) __all__ = [ "SSL", "crypto", "__author__", "__copyright__", "__email__", "__license__", "__summary__", "__title__", "__uri__", "__version__", ]
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.02 |
proxy
|
phpinfo
|
Settings