U
.e @ s d Z ddlmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
mZ ddlmZmZmZ ddlmZmZmZmZ zdd l mZ W n$ ek
r dZdd
lmZ Y nX d d gZ d
Z ej Z ej j Z!e " Z#e $ Z%dZ&ej'ej(ej)ej*ej+ej,ej-ej.ej/ej0ej1ej2ej3ej4ej5ej6ej7ej8ej9ej:ej;ejej?ej@ejAejBejCejDg ZEejFejGejHfiZIeJe
drejKejKfeIe
jL< eJe
drejMejMfeIe
jN< eJe
drejGejGfeIe
jO< eJe
drejPejPfeIe
jQ< eJe
drejRejRfeIe
jS< dd ZTdd ZUdd ZVdd ZWeXeVZYeZeWZ[G dd de\Z]ernd#d d Z^n
d$d d Z^e^e]_^G d!d" d"e\Z_dS )%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 urllib3.contrib.securetransport
urllib3.contrib.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:
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 )util )Security
SecurityConstCoreFoundation)_assert_no_error_cert_array_from_pem_temporary_keychain_load_client_cert_chain) _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 O/usr/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 Z
wait_for_readerrorerrnoEAGAINctypesc_charZ from_address recv_intoerrSSLClosedGraceful
ECONNRESETEPIPEerrSSLClosedAborterrSSLWouldBlock Exception
_exception)
connection_id data_bufferdata_length_pointerwrapped_socket base_socketZrequested_lengthtimeoutr& Z
read_countZ remainingbufferZ
chunk_sizeer r r _read_callback sP
r; 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 Zwait_for_writer& r' r( sendr- r. r/ r0 r1 r2 ) r3 r4 r5 r6 r7 Zbytes_to_writedatar8 r& sentZ
chunk_sentr: r r r _write_callback sD
r@ c @ s e Zd ZdZdd Zejdd Zdd Zdd Z d
d Z
d d
Z dd Z dd Z
d*ddZdd Zdd Zdd Zdd Zd d Zd d Zd+d"d#Zd$d% Zd&d' Zd(d) ZdS ),
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_closedr2 _keychain
_keychain_dir_client_cert_chainr% _timeout
settimeout)selfr$ r r r __init__H 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)r2 close)rK Z exceptionr r r _raise_on_errorZ 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_SUITESZSSLSetEnabledCiphersrC r )rK ciphersresultr r r _set_cipherso s zWrappedSocket._set_ciphersc C s |sdS t j|r2t|d}| }W 5 Q R X d}t }zt |}t
| j t
|}t| |srtdt||}t| t|d}t| t }t|t
|}t| W 5 |rt| |dk rt| X tjtjf}|j|kr
td|j 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.
Nrbz Failed to copy trust referenceTz)certificate verify failed, error code: %d)ospathisfileopenreadr SecTrustRefr CFReleaser
SSLCopyPeerTrustrC r) byrefr sslSSLErrorZ SecTrustSetAnchorCertificatesZ!SecTrustSetAnchorCertificatesOnlyZSecTrustResultTypeZSecTrustEvaluater ZkSecTrustResultUnspecifiedZkSecTrustResultProceedvalue) rK verify trust_bundlefZ
cert_arraytrustrR Z trust_resultZ successesr r r _custom_validate| s>
z WrappedSocket._custom_validatec 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|} | dkr|tjkrt | jtj} t | |r|dk r0t | jtjd} t | |rlt \| _| _ t | j||| _ t | j| j } t | | h t !| j} | tj"krt#$dn>| tj%kr| &|| W 5 Q R qlnt | W 5 Q R qW 5 Q R X qldS )z
Actually performs the TLS handshake. This is run automatically by
wrapped socket, and shouldn't be needed in user code.
Nir zutf-8r Tzhandshake timed out)'r ZSSLCreateContextr ZkSSLClientSideZkSSLStreamTyperC Z
SSLSetIOFuncs_read_callback_pointer_write_callback_pointerr _connection_ref_lockidr! ZSSLSetConnection
isinstancebytesencodeZSSLSetPeerDomainNamerO rS ZSSLSetProtocolVersionMinZSSLSetProtocolVersionMaxkTLSProtocolMaxSupportedkTLSProtocol12ZSSLSetSessionOptionZ"kSSLSessionOptionBreakOnServerAuthr rF rG r rH ZSSLSetCertificaterN Z SSLHandshaker0 r$ r8 ZerrSSLServerAuthCompletedre ) rK server_hostnamera rb Z min_versionZ max_versionZ client_certZ
client_keyZclient_key_passphraserR Zhandler r r handshake s|
zWrappedSocket.handshakec C s
| j S N)r$ filenorK r r r rr s zWrappedSocket.filenoc C s* | j dkr| j d8 _ | jr&| d S )Nr r )rD rE rM rs r r r _decref_socketios s
z WrappedSocket._decref_socketiosc C s& t |}| ||}|d | }|S rq )r) Zcreate_string_bufferr+ )rK Zbufsizr9 Z
bytes_readr> r r r recv 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)rE rO r) r* Z from_bufferc_size_trN r ZSSLReadrC r] r r0 r` r$ r8 r, ZerrSSLClosedNoNotifyrM r )rK r9 nbytesprocessed_bytesrR r r r r+ & s.
zWrappedSocket.recv_intoc C s
|| _ d S rq rI )rK r8 r r r rJ Q s zWrappedSocket.settimeoutc C s | j S rq ry rs r r r r% T 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) rv rN r ZSSLWriterC rO r] r r0 r` r$ r8 r )rK r> rx rR r r r r= W s
zWrappedSocket.sendc C s4 d}|t |k r0| |||t }||7 }qd S Nr )rO r= SSL_WRITE_BLOCKSIZE)rK r> Z
total_sentr? r r r sendallh s zWrappedSocket.sendallc C s$ | t| j W 5 Q R X d S rq )rN r ZSSLCloserC rs r r r shutdownn 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)rD rE rC r r[ rH rF r ZSecKeychainDeleteshutilZrmtreerG r$ rM rs r r r rM r 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 rZ r r[ r\ rC r) r] r ZSecTrustGetCertificateCountZ SecTrustGetCertificateAtIndexAssertionErrorZSecCertificateCopyDataZCFDataGetLengthZCFDataGetBytePtrr< )
rK Z binary_formrd ZcertdataZ der_bytesrR Z
cert_countZleafZ data_lengthr4 r r r getpeercert s2
zWrappedSocket.getpeercertc C s t }t | jt|}t| |jtj kr4dS |jtj
krDdS |jtj krTdS |jtj krddS |jtj
krtdS |jtjkrdS td| d S )NzTLSv1.3zTLSv1.2zTLSv1.1ZTLSv1ZSSLv3ZSSLv2zUnknown TLS version: %r)r Z SSLProtocolZ SSLGetNegotiatedProtocolVersionrC r) r] r r` r ZkTLSProtocol13rn kTLSProtocol11
kTLSProtocol1
kSSLProtocol3
kSSLProtocol2r^ r_ )rK protocolrR r r r version s& zWrappedSocket.versionc C s | j d7 _ d S Nr )rD rs r r r _reuse s zWrappedSocket._reusec C s& | j dk r| n| j d8 _ d S r )rD rM rs r r r _drop s
zWrappedSocket._drop)N)F)__name__
__module__ __qualname____doc__rL
contextlibcontextmanagerrN rS re rp rr rt ru r+ rJ r% r= r| r} rM r r r r r r r r rA @ s*
9a
+
:rA c C s | j d7 _ t| ||ddS )Nr T)rM )rD r
)rK modebufsizer r r makefile s r rc O s d}t | ||f||S rz r )rK r bufferingargskwargsr r r r s c @ s e Zd ZdZdd Zedd Zejdd Zedd Zejd d Zed
d Z e jd d Z d
d Z
dd Z dd Z d ddZ
d ddZd ddZdS ) r z
I am a wrapper class for the SecureTransport library, to translate the
interface of the standard library ``SSLContext`` object to calls into
SecureTransport.
c C s8 t | \| _| _d| _d| _d | _d | _d | _d | _d S rB ) _protocol_to_min_max _min_version _max_version_options_verify
_trust_bundle _client_cert _client_key_client_key_passphrase)rK r r r r rL 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 rs r r r check_hostname s z%SecureTransportContext.check_hostnamec C s dS )r Nr rK r` r r r r s c C s | j S rq r rs r r r options s z SecureTransportContext.optionsc C s
|| _ d S rq r r r r r r s c C s | j r tjS tjS rq )r r^
CERT_REQUIREDZ CERT_NONErs r r r verify_mode s z"SecureTransportContext.verify_modec C s |t jkrdnd| _d S )NTF)r^ r r r r r r r $ s c C s d S rq r rs r r r set_default_verify_paths( s
z/SecureTransportContext.set_default_verify_pathsc C s | S rq )r rs r r r load_default_certs4 s z)SecureTransportContext.load_default_certsc C s |t jjkrtdd S )Nz5SecureTransport doesn't support custom cipher strings)r r ZDEFAULT_CIPHERSr )rK rQ r r r set_ciphers7 s z"SecureTransportContext.set_ciphersNc C s |d k rt d|p|| _d S )Nz1SecureTransport does not support cert directories)r r )rK ZcafileZcapathZcadatar r r load_verify_locations< s z,SecureTransportContext.load_verify_locationsc C s || _ || _|| _d S rq )r r Z_client_cert_passphrase)rK ZcertfileZkeyfileZpasswordr r r load_cert_chainC s z&SecureTransportContext.load_cert_chainFTc
C sJ |rt |st |st t|}||| j| j| j| j| j| j| j |S rq )
r rA rp r r r r r r r )rK ZsockZ server_sideZdo_handshake_on_connectZsuppress_ragged_eofsro r6 r r r wrap_socketH s
z"SecureTransportContext.wrap_socket)NNN)NN)FTTN)r r r r rL propertyr setterr r r r r r r r r r r r r s0
r )r )r N)`r Z
__future__r r r) r' Zos.pathrU r~ r$ r^ Z threadingweakref r Z_securetransport.bindingsr r r Z_securetransport.low_levelr r
r r r
ImportErrorZpackages.backports.makefiler __all__r r r r r ZWeakValueDictionaryr! ZLockrh 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_SHArP Z PROTOCOL_TLSr rm r hasattrr r r r r r r rn r r r r; r@ Z SSLReadFuncrf Z SSLWriteFuncrg objectrA r r r r r r s 3 %
76
!