U
ʗRe @ s d Z ddlmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlmZ ddlmZ ddlmZ dd lmZmZmZ dd
lmZmZmZm Z m Z m Z zdd l m Z W n$ e k
r dZ dd l!m"Z" Y nX d
dgZ#dZ$ej$Z%ej&j'Z(e
) Z*e + Z,dZ-ej.ej/ej0ej1ej2ej3ej4ej5ej6ej7ej8ej9ej:ej;ejej?ej@ejAejBejCejDejEejFejGejHejIejJejKg ZLejMejNejOfeejNejOfiZPeQe
drejRejRfePe
jS< eQe
drejTejTfePe
jU< eQe
drejNejNfePe
jV< eQe
dr.ejWejWfePe
jX< eQe
drLejOejOfePe
jY< dd
ZZdd Z[dd Z\dd Z]e^e\Z_e`e]ZaG d d d ebZce rd%d d Zdn
d&d"d Zdedec_dG d#d$ d$ebZedS )'a
SecureTranport support for urllib3 via ctypes.
This makes platform-native TLS available to urllib3 users on macOS without the
use of a compiler. This is an important feature because the Python Package
Index is moving to become a TLSv1.2-or-higher server, and the default OpenSSL
that ships with macOS is not capable of doing TLSv1.2. The only way to resolve
this is to give macOS users an alternative solution to the problem, and that
solution is to use SecureTransport.
We use ctypes here because this solution must not require a compiler. That's
because pip is not allowed to require a compiler either.
This is not intended to be a seriously long-term solution to this problem.
The hope is that PEP 543 will eventually solve this issue for us, at which
point we can retire this contrib module. But in the short term, we need to
solve the impending tire fire that is Python on Mac without this kind of
contrib module. So...here we are.
To use this module, simply import and inject it::
import pip._vendor.urllib3.contrib.securetransport as securetransport
securetransport.inject_into_urllib3()
Happy TLSing!
This code is a bastardised version of the code found in Will Bond's oscrypto
library. An enormous debt is owed to him for blazing this trail for us. For
that reason, this code should be considered to be covered both by urllib3's
license and by oscrypto's:
.. code-block::
Copyright (c) 2015-2016 Will Bond
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
)absolute_importN)six )util)PROTOCOL_TLS_CLIENT )CoreFoundationSecurity
SecurityConst)_assert_no_error_build_tls_unknown_ca_alert_cert_array_from_pem_create_cfstring_array_load_client_cert_chain_temporary_keychain) _fileobjectbackport_makefileinject_into_urllib3extract_from_urllib3Ti @ PROTOCOL_SSLv2PROTOCOL_SSLv3PROTOCOL_TLSv1PROTOCOL_TLSv1_1PROTOCOL_TLSv1_2c C s. t t_t tj_tt_ttj_dt_dtj_dS )zG
Monkey-patch urllib3 with SecureTransport-backed SSL-support.
TN)SecureTransportContextr
SSLContextssl_HAS_SNIIS_SECURETRANSPORT r r /builddir/build/BUILDROOT/alt-python38-pip-22.2.1-2.el8.x86_64/opt/alt/python38/lib/python3.8/site-packages/pip/_vendor/urllib3/contrib/securetransport.pyr s c C s. t t_t tj_tt_ttj_dt_dtj_dS )z>
Undo monkey-patching by :func:`inject_into_urllib3`.
FN)orig_util_SSLContextr r r orig_util_HAS_SNIr r r r r r! r s c
C s d}zJt | }|dkr"tjW S |j}|d }| }d}d}z|||k r|dksZ|dkrtt||sttt j
d|| } t j |
|| }
||
| } || 7 }| sB|stjW W S qqBW nt tjk
r0 } zR| j }|dk r |t j
kr ||d< |t jks|t jkr tj W Y
W S W 5 d} ~ X Y nX ||d< ||krLtjW S W dS tk
r } z |dk rt| |_tj W Y S d} ~ X Y nX dS )zs
SecureTransport read callback. This is called by ST to request that data
be returned from the socket.
Nr timed out)_connection_refsgetr
errSSLInternalsocket
gettimeoutr
wait_for_readerrorerrnoEAGAINctypesc_charZ from_address recv_intoerrSSLClosedGraceful
ECONNRESETEPIPEerrSSLClosedAborterrSSLWouldBlock Exception
_exception)
connection_id data_bufferdata_length_pointerwrapped_socket base_socketZrequested_lengthtimeoutr+ Z
read_count remainingbuffer
chunk_sizeer r r! _read_callback sP
rB c
C sr d}z(t | }|dkr"tjW S |j}|d }t||}| }d}d} zV| |k r|dksf|dkrt ||st
t j d|
|}
| |
7 } ||
d }qNW nl tj
k
r } zJ| j }|dk r|t j kr| |d< |t jks|t jkrtj W Y
W S W 5 d} ~ X Y nX | |d< | |kr*tjW S W dS tk
rl } z |dk rR| |_tj W Y S d} ~ X Y nX dS )zx
SecureTransport write callback. This is called by ST to request that data
actually be sent on the network.
Nr r$ )r% r& r
r' r( r. string_atr) r wait_for_writer+ r, r- sendr2 r3 r4 r5 r6 r7 ) r8 r9 r: r; r< Zbytes_to_writedatar= r+ sentZ
chunk_sentrA r r r! _write_callback sD
rH c @ s e Zd ZdZdd Zejdd Zdd Zdd Z d
d Z
d d
Z dd Z dd Z
dd Zdd Zd.ddZdd Zdd Zd d Zd d Zd!d" Zd#d$ Zd/d&d'Zd(d) Zd*d+ Zd,d- ZdS )0
WrappedSocketz
API-compatibility wrapper for Python's OpenSSL wrapped socket object.
Note: _makefile_refs, _drop(), and _reuse() are needed for the garbage
collector of PyPy.
c C sL || _ d | _d| _d| _d | _d | _d | _d | _| j | _ | j
d d S Nr F) r( context_makefile_refs_closedr7 _keychain
_keychain_dir_client_cert_chainr) _timeout
settimeout)selfr( r r r! __init__N s zWrappedSocket.__init__c c s4 d| _ dV | j dk r0| j d }| _ | |dS )a]
A context manager that can be used to wrap calls that do I/O from
SecureTransport. If any of the I/O callbacks hit an exception, this
context manager will correctly propagate the exception after the fact.
This avoids silently swallowing those exceptions.
It also correctly forces the socket closed.
N)r7 close)rS exceptionr r r! _raise_on_error` s
z WrappedSocket._raise_on_errorc C s2 t jtt t }t | j|tt}t| dS )a4
Sets up the allowed ciphers. By default this matches the set in
util.ssl_.DEFAULT_CIPHERS, at least as supported by macOS. This is done
custom and doesn't allow changing at this time, mostly because parsing
OpenSSL cipher strings is going to be a freaking nightmare.
N)r ZSSLCipherSuitelen
CIPHER_SUITESZSSLSetEnabledCiphersrK r )rS ciphersresultr r r! _set_ciphersu s zWrappedSocket._set_ciphersc C s< |sdS t |}zt| j|}t| W 5 t| X dS )z<
Sets up the ALPN protocols on the context.
N)r r CFReleaser SSLSetALPNProtocolsrK r )rS protocolsZ
protocols_arrr[ r r r! _set_alpn_protocols s z!WrappedSocket._set_alpn_protocolsc
C s |sdS t jt jf}z&| |}||kr.W dS d|f }W n, tk
rf } zd|f }W 5 d}~X Y nX t| }| j| t
ddd}| j tj tj
| | td| dS )z
Called when we have set custom validation. We do this in two cases:
first, when cert validation is entirely disabled; and second, when
using a custom trust DB.
Raises an SSLError if the connection is not trusted.
Nzerror code: %dz
exception: %riir r z certificate verify failed, %s)r
ZkSecTrustResultUnspecifiedZkSecTrustResultProceed_evaluate_trustr6 r versionr( sendallstructpack
setsockopt
SOL_SOCKET SO_LINGERrU sslSSLError) rS verify trust_bundleZ successes trust_resultreasonrA Zrecoptsr r r! _custom_validate s$
z WrappedSocket._custom_validatec C s t j|r*t|d}| }W 5 Q R X d }t }zt |}t
| j t
|}t| |sjtdt||}t| t|d}t| t }t|t
|}t| W 5 |rt| |d k rt| X |jS )Nrbz Failed to copy trust referenceT)ospathisfileopenreadr SecTrustRefr r] r
SSLCopyPeerTrustrK r. byrefr rj rk Z SecTrustSetAnchorCertificatesZ!SecTrustSetAnchorCertificatesOnlyZSecTrustResultTypeZSecTrustEvaluatevalue)rS rm fZ
cert_arraytrustr[ rn r r r! rb s.
z WrappedSocket._evaluate_trustc
C s t dtjtj| _t | jtt}
t |
t
0 t | d } | t krT| d d } q>| t | < W 5 Q R X t
| j| }
t |
|rt|ts|d}t | j|t|}
t |
| | | t | j|}
t |
t | j|}
t |
|r|dk rt | jtjd}
t |
|rRt \| _| _t | j||| _ t | j| j }
t |
| h t | j}
|
tj!krt"#dn>|
tj$kr| %|| W 5 Q R qRnt |
W 5 Q R qW 5 Q R X qRdS )z
Actually performs the TLS handshake. This is run automatically by
wrapped socket, and shouldn't be needed in user code.
Nir zutf-8Tzhandshake timed out)&r ZSSLCreateContextr
ZkSSLClientSideZkSSLStreamTyperK Z
SSLSetIOFuncs_read_callback_pointer_write_callback_pointerr _connection_ref_lockidr% ZSSLSetConnection
isinstancebytesencodeZSSLSetPeerDomainNamerX r\ r` ZSSLSetProtocolVersionMinZSSLSetProtocolVersionMaxZSSLSetSessionOptionZ"kSSLSessionOptionBreakOnServerAuthr rN rO r rP ZSSLSetCertificaterW Z SSLHandshaker5 r( r= ZerrSSLServerAuthCompletedrq ) rS server_hostnamerl rm min_versionZ max_version client_certZ
client_keyZclient_key_passphrasealpn_protocolsr[ handler r r! handshake st
zWrappedSocket.handshakec C s
| j S N)r( filenorS r r r! r 7 s zWrappedSocket.filenoc C s* | j dkr| j d8 _ | jr&| d S )Nr r )rL rM rU r r r r! _decref_socketios; s
z WrappedSocket._decref_socketiosc C s& t |}| ||}|d | }|S r )r. create_string_bufferr0 )rS Zbufsizr? Z
bytes_readrF r r r! recvA s
zWrappedSocket.recvNc C s | j r
dS |d krt|}tj| |}td}| t| j ||t
|}W 5 Q R X |t j kr|j
dkrtdn"|t jt jfkr| nt| |j
S )Nr zrecv timed out)rM rX r. r/ Z from_bufferc_size_trW r ZSSLReadrK rz r
r5 r{ r( r= r1 ZerrSSLClosedNoNotifyrU r )rS r? nbytesprocessed_bytesr[ r r r! r0 G s.
zWrappedSocket.recv_intoc C s
|| _ d S r rQ )rS r= r r r! rR r s zWrappedSocket.settimeoutc C s | j S r r r r r r! r) u s zWrappedSocket.gettimeoutc C sh t d}| " t| j|t|t |}W 5 Q R X |tj krZ|j
dkrZt dnt
| |j
S )Nr zsend timed out)r. r rW r ZSSLWriterK rX rz r
r5 r{ r( r= r )rS rF r r[ r r r! rE x s
zWrappedSocket.sendc C s4 d}|t |k r0| |||t }||7 }qd S Nr )rX rE SSL_WRITE_BLOCKSIZE)rS rF
total_sentrG r r r! rd s zWrappedSocket.sendallc C s$ | t| j W 5 Q R X d S r )rW r ZSSLCloserK r r r r! shutdown s
zWrappedSocket.shutdownc C s | j dk rd| _| jr(t| j d | _| jr@t| j d | _| jrvt| j t| j t
| j d | _| _ | j
S | j d8 _ d S )Nr T)rL rM rK r r] rP rN r ZSecKeychainDeleteshutilrmtreerO r( rU r r r r! rU s
zWrappedSocket.closeFc
C s |s t dt }d }d }zt| jt|}t | |sFW dd S t
|}|s\W Nd S t |d}|spt t
|}|st t|}t|} t| |}W 5 |rt| |rt| X |S )Nz2SecureTransport only supports dumping binary certsr )
ValueErrorr rx r r] ry rK r. rz r ZSecTrustGetCertificateCountZ SecTrustGetCertificateAtIndexAssertionErrorZSecCertificateCopyDataZCFDataGetLengthZCFDataGetBytePtrrC )
rS binary_formr} ZcertdataZ der_bytesr[ Z
cert_countleafZ data_lengthr9 r r r! getpeercert s2
zWrappedSocket.getpeercertc C s t }t | jt|}t| |jtj kr t | \| _| _d| _d| _d | _d | _d | _d | _d | _ d S rJ )
_protocol_to_min_max _min_version _max_version_options_verify
_trust_bundle _client_cert _client_key_client_key_passphrase_alpn_protocols)rS r r r r! rT s z SecureTransportContext.__init__c C s dS )
SecureTransport cannot have its hostname checking disabled. For more,
see the comment on getpeercert() in this file.
Tr r r r r! check_hostname" s z%SecureTransportContext.check_hostnamec C s dS )r Nr rS r{ r r r! r * s c C s | j S r r r r r r! options2 s z SecureTransportContext.optionsc C s
|| _ d S r r r r r r! r < s c C s | j r tjS tjS r )r rj
CERT_REQUIRED CERT_NONEr r r r! verify_modeA s z"SecureTransportContext.verify_modec C s |t jkrdnd| _d S )NTF)rj r r r r r r! r E s c C s d S r r r r r r! set_default_verify_pathsI s
z/SecureTransportContext.set_default_verify_pathsc C s | S r )r r r r r! load_default_certsU s z)SecureTransportContext.load_default_certsc C s |t jjkrtdd S )Nz5SecureTransport doesn't support custom cipher strings)r r DEFAULT_CIPHERSr )rS rZ r r r! set_ciphersX s z"SecureTransportContext.set_ciphersNc C s: |d k rt d|d k r,t| W 5 Q R X |p2|| _d S )Nz1SecureTransport does not support cert directories)r rv r )rS cafilecapathcadatar r r! load_verify_locations] s
z,SecureTransportContext.load_verify_locationsc C s || _ || _|| _d S r )r r Z_client_cert_passphrase)rS certfilekeyfilepasswordr r r! load_cert_chaini s z&SecureTransportContext.load_cert_chainc C s& t tdstddd |D | _dS )z
Sets the ALPN protocols that will later be set on the context.
Raises a NotImplementedError if ALPN is not supported.
r^ z2SecureTransport supports ALPN only in macOS 10.12+c S s g | ]}t |qS r )r
ensure_binary).0pr r r!
x s z=SecureTransportContext.set_alpn_protocols..N)hasattrr NotImplementedErrorr )rS r_ r r r! set_alpn_protocolsn s
z)SecureTransportContext.set_alpn_protocolsFTc C sN |rt |st |st t|}||| j| j| j| j| j| j| j | j
|S r ) r rI r r r r r r r r r )rS sock server_sidedo_handshake_on_connectsuppress_ragged_eofsr r; r r r! wrap_socketz s z"SecureTransportContext.wrap_socket)NNN)NN)FTTN)r r r r rT propertyr setterr r r r r r r r r r r r r! r s2
r )r )r N)fr
__future__r r r. r, os.pathrs r r( rj re threadingweakref pip._vendorr r Z util.ssl_r Z_securetransport.bindingsr r r
Z_securetransport.low_levelr r r
r r r r ImportErrorZpackages.backports.makefiler __all__r r# r r r" WeakValueDictionaryr% Lockr r Z'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384Z'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256Z%TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384Z%TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256Z-TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256Z+TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256Z#TLS_DHE_RSA_WITH_AES_256_GCM_SHA384Z#TLS_DHE_RSA_WITH_AES_128_GCM_SHA256Z'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384Z$TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHAZ'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256Z$TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHAZ%TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384Z"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHAZ%TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256Z"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHAZ#TLS_DHE_RSA_WITH_AES_256_CBC_SHA256Z TLS_DHE_RSA_WITH_AES_256_CBC_SHAZ#TLS_DHE_RSA_WITH_AES_128_CBC_SHA256Z TLS_DHE_RSA_WITH_AES_128_CBC_SHAZTLS_AES_256_GCM_SHA384ZTLS_AES_128_GCM_SHA256Z TLS_RSA_WITH_AES_256_GCM_SHA384Z TLS_RSA_WITH_AES_128_GCM_SHA256ZTLS_AES_128_CCM_8_SHA256ZTLS_AES_128_CCM_SHA256Z TLS_RSA_WITH_AES_256_CBC_SHA256Z TLS_RSA_WITH_AES_128_CBC_SHA256Z TLS_RSA_WITH_AES_256_CBC_SHAZ TLS_RSA_WITH_AES_128_CBC_SHArY PROTOCOL_TLSr r r r r r r r r r r r r r rB rH Z SSLReadFuncr~ Z SSLWriteFuncr objectrI r r r r r r! s 5 %
76
<