a
t~®`q† ã @ sÀ d Z ddlmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlmZ ddlmZ ddlmZmZmZ dd lmZmZmZmZm Z m Z zdd
l m Z W n" e yæ dZ dd l m!Z! Y n0 d d
gZ"dZ#ej#Z$ej%j&Z'e
(¡ Z)e *¡ Z+dZ,ej-ej.ej/ej0ej1ej2ej3ej4ej5ej6ej7ej8ej9ej:ej;ejej?ej@ejAejBejCejDejEejFejGejHejIejJg ZKejLejMejNfeejMejNfiZOePe
dƒrÎejQejQfeOe
jR< ePe
dƒrìejSejSfeOe
jT< ePe
dƒr
ejMejMfeOe
jU< ePe
dƒr(ejVejVfeOe
jW< ePe
dƒrFejNejNfeOe
jX< dd „ ZYdd
„ ZZdd„ Z[dd„ Z\e ]e[¡Z^e _e\¡Z`G dd „ d eaƒZbe rœd$d d „Zcn
d%d!d „Zceceb_cG d"d#„ d#eaƒZddS )&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:
.. 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é )Úutil)ÚPROTOCOL_TLS_CLIENTé )ÚCoreFoundationÚSecurityÚ
SecurityConst)Ú_assert_no_errorÚ_build_tls_unknown_ca_alertÚ_cert_array_from_pemÚ_create_cfstring_arrayÚ_load_client_cert_chainÚ_temporary_keychain)Ú _fileobject©Úbackport_makefileÚinject_into_urllib3Úextract_from_urllib3Ti @ ÚPROTOCOL_SSLv2ÚPROTOCOL_SSLv3ÚPROTOCOL_TLSv1ÚPROTOCOL_TLSv1_1ÚPROTOCOL_TLSv1_2c C s. t t_t tj_tt_ttj_dt_dtj_dS )zG
Monkey-patch urllib3 with SecureTransport-backed SSL-support.
TN)ÚSecureTransportContextr Ú
SSLContextÚssl_ÚHAS_SNIÚIS_SECURETRANSPORT© r r úC/usr/lib/python3.9/site-packages/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}zPt | ¡}|du r"tjW S |j}|d }| ¡ }d}d}z|||k rº|du sZ|dkrtt ||¡stt t j
d¡‚|| } t j |
|| ¡}
| |
| ¡} || 7 }| sB|sºtjW W S qºqBW nz tjy6 } z^| j }|dur"|t j
kr"||d< |t jks |t jkr tjW Y d} ~ W S ‚ W Y d} ~ n
d} ~ 0 0 ||d< ||krRtjW S W dS ty’ } z"|durx| |_tjW Y d} ~ S d} ~ 0 0 dS )zs
SecureTransport read callback. This is called by ST to request that data
be returned from the socket.
Nr ú timed out)Ú_connection_refsÚgetr ÚerrSSLInternalÚsocketÚ
gettimeoutr Z
wait_for_readÚerrorÚerrnoÚEAGAINÚctypesÚc_charZ from_addressÚ recv_intoÚerrSSLClosedGracefulÚ
ECONNRESETÚEPIPEÚerrSSLClosedAbortÚerrSSLWouldBlockÚ ExceptionÚ
_exception)
Ú
connection_idÚ data_bufferÚdata_length_pointerÚwrapped_socketÚ base_socketZrequested_lengthÚtimeoutr) Z
read_countZ remainingÚbufferZ
chunk_sizeÚer r r Ú_read_callbackÕ sP
ÿ
r> c
C s| d}z4t | ¡}|du r"tjW S |j}|d }t ||¡}| ¡ }d}d} zV| |k r |du sf|dkr€t ||¡s€t
t j d¡‚|
|¡}
| |
7 } ||
d… }qNW nx tj
y } z\| j }|dur|t j kr| |d< |t jksð|t jkrtjW Y d} ~ W S ‚ W Y d} ~ n
d} ~ 0 0 | |d< | |kr6tjW S W dS tyv } z"|dur\| |_tjW Y d} ~ S d} ~ 0 0 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+ Úsendr0 r1 r2 r3 r4 r5 ) r6 r7 r8 r9 r: Zbytes_to_writeÚdatar; r) ÚsentZ
chunk_sentr= r r r Ú_write_callback sD
rC c @ s e Zd ZdZdd„ Zejdd„ ƒZdd„ Zdd „ Z d
d „ Z
d d
„ Z dd„ Z dd„ Z
dd„ Zdd„ Zd.dd„Zdd„ 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Ú_closedr5 Ú _keychainÚ
_keychain_dirÚ_client_cert_chainr( Ú_timeoutÚ
settimeout)Úselfr' r r r Ú__init__N s zWrappedSocket.__init__c c s4 d| _ dV | j dur0| 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)r5 Úclose)rN Ú 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 ZSSLCipherSuiteÚlenÚ
CIPHER_SUITESZSSLSetEnabledCiphersrF r
)rN ÚciphersÚresultr r r Ú _set_ciphersu s
ÿzWrappedSocket._set_ciphersc C sF |sdS t |ƒ}z$t | j|¡}t|ƒ W t |¡ n t |¡ 0 dS )z<
Sets up the ALPN protocols on the context.
N)r
r ÚSSLSetALPNProtocolsrF r
r Ú CFRelease)rN Ú protocolsZ
protocols_arrrV r r r Ú_set_alpn_protocols‚ s
z!WrappedSocket._set_alpn_protocolsc
C s¾ |sdS t jt jf}z&| |¡}||v r.W dS d|f }W n. tyh } zd|f }W Y d}~n
d}~0 0 t| ¡ ƒ}| j |¡ t
ddd¡}| j tj tj
|¡ | ¡ t d| ¡‚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: %rÚiir r z certificate verify failed, %s)r ZkSecTrustResultUnspecifiedZkSecTrustResultProceedÚ_evaluate_trustr4 r Úversionr' ÚsendallÚstructÚpackZ
setsockoptZ
SOL_SOCKETZ SO_LINGERrP ÚsslÚSSLError) rN ÚverifyÚ trust_bundleZ successesÚ trust_resultÚreasonr= ZrecZoptsr r r Ú_custom_validate s$ þ
z WrappedSocket._custom_validatec C s t j |¡r>t|dƒ}| ¡ }W d ƒ n1 s40 Y d }t ¡ }z t|ƒ}t | j t
|¡¡}t |ƒ |s~t
d¡‚t ||¡}t |ƒ t |d¡}t |ƒ t ¡ }t |t
|¡¡}t |ƒ W |rØt |¡ |d urêt |¡ n$|rút |¡ |d urt |¡ 0 |jS )NÚrbz Failed to copy trust referenceT)ÚosÚpathÚisfileÚopenÚreadr Ú SecTrustRefr ÚSSLCopyPeerTrustrF r, Úbyrefr
rb rc Z SecTrustSetAnchorCertificatesZ!SecTrustSetAnchorCertificatesOnlyZSecTrustResultTypeZSecTrustEvaluater rY Úvalue)rN re ÚfZ
cert_arrayÚtrustrV rf r r r r] ² s6 &
ü
z WrappedSocket._evaluate_trustc
C s t dtjtj¡| _t | jtt¡}
t |
ƒ t
: t | ƒd } | t v rT| d d } q>| t | < W d ƒ n1 sp0 Y t
| j| ¡}
t |
ƒ |rÄt|tƒs¨| d¡}t | j|t|ƒ¡}
t |
ƒ | ¡ | | ¡ t | j|¡}
t |
ƒ t | j|¡}
t |
ƒ |r|dur,t | jtjd¡}
t |
ƒ |rhtƒ \| _| _t | j||ƒ| _ t | j| j ¡}
t |
ƒ | ¡ v t | j¡}
|
tj!kr–t" #d¡‚nB|
tj$krÀ| %||¡ W d ƒ qhnt |
ƒ W d ƒ qüW d ƒ n1 sî0 Y qhdS )z‘
Actually performs the TLS handshake. This is run automatically by
wrapped socket, and shouldn't be needed in user code.
Niÿÿÿr zutf-8Tzhandshake timed out)&r ZSSLCreateContextr ZkSSLClientSideZkSSLStreamTyperF Z
SSLSetIOFuncsÚ_read_callback_pointerÚ_write_callback_pointerr
Ú_connection_ref_lockÚidr$ ZSSLSetConnectionÚ
isinstanceÚbytesÚencodeZSSLSetPeerDomainNamerS rW r[ ZSSLSetProtocolVersionMinZSSLSetProtocolVersionMaxZSSLSetSessionOptionZ"kSSLSessionOptionBreakOnServerAuthr rI rJ r rK ZSSLSetCertificaterR Z SSLHandshaker3 r' r; ZerrSSLServerAuthCompletedrh ) rN Úserver_hostnamerd re Z min_versionZ max_versionZ client_certZ
client_keyZclient_key_passphraseZalpn_protocolsrV Zhandler r r Ú handshakeÚ s`
ÿÿ &
ÿ
ÿÿ
zWrappedSocket.handshakec C s
| j ¡ S ©N)r' Úfileno©rN r r r r 7 s zWrappedSocket.filenoc C s* | j dkr| j d8 _ | jr&| ¡ d S )Nr r )rG rH rP r€ r r r Ú_decref_socketios; s
z WrappedSocket._decref_socketiosc C s& t |¡}| ||¡}|d |… }|S r~ )r, Zcreate_string_bufferr. )rN Zbufsizr< Z
bytes_readrA r r r ÚrecvA s
zWrappedSocket.recvNc C s¼ | j r
dS |d u rt|ƒ}tj| |¡}t d¡}| ¡ ( t | j ||t
|¡¡}W d ƒ n1 sj0 Y |t j kr”|j
dkr¶t d¡‚n"|t jt jfv r®| ¡ nt|ƒ |j
S )Nr zrecv timed out)rH rS r, r- Z from_bufferÚc_size_trR r ZSSLReadrF rq r r3 rr r' r; r/ ZerrSSLClosedNoNotifyrP r
)rN r< ÚnbytesÚprocessed_bytesrV r r r r. G s(
ÿ"
þ
zWrappedSocket.recv_intoc C s
|| _ d S r~ ©rL )rN r; r r r rM r s zWrappedSocket.settimeoutc C s | j S r~ r† r€ r r r r( u s zWrappedSocket.gettimeoutc C s| t d¡}| ¡ , t | j|t|ƒt |¡¡}W d ƒ n1 sD0 Y |tj krn|j
dkrnt d¡‚nt
|ƒ |j
S )Nr zsend timed out)r, rƒ rR r ZSSLWriterF rS rq r r3 rr r' r; r
)rN rA r… rV r r r r@ x s
ÿ" zWrappedSocket.sendc C s4 d}|t |ƒk r0| |||t … ¡}||7 }qd S ©Nr )rS r@ ÚSSL_WRITE_BLOCKSIZE)rN rA Z
total_sentrB r r r r_ ‰ s zWrappedSocket.sendallc C s8 | ¡ t | j¡ W d ƒ n1 s*0 Y d S r~ )rR r ZSSLCloserF r€ r r r Úshutdown s
zWrappedSocket.shutdownc C s’ | j dk r€d| _| jr(t | j¡ d | _| jr@t | j¡ d | _| jrvt | j¡ t | j¡ t
| j ¡ d | _| _ | j
¡ S | j d8 _ d S )Nr T)rG rH rF r rY rK rI r ZSecKeychainDeleteÚshutilÚrmtreerJ r' rP r€ r r r rP “ s
zWrappedSocket.closeFc
C s |s t dƒ‚t ¡ }d }d }zØt | jt |¡¡}t|ƒ |s`W |rNt |¡ |r\t |¡ d S t
|¡}|sW |r~t |¡ |rŒt |¡ d S t |d¡}|s¤J ‚t |¡}|s¶J ‚t
|¡}t |¡} t | |¡}W |ræt |¡ |rôt |¡ n"|rt |¡ |rt |¡ 0 |S )Nz2SecureTransport only supports dumping binary certsr )Ú
ValueErrorr ro rp rF r, rq r
r rY ZSecTrustGetCertificateCountZ SecTrustGetCertificateAtIndexZSecCertificateCopyDataZCFDataGetLengthZCFDataGetBytePtrr? )
rN Z binary_formrt ZcertdataZ der_bytesrV Z
cert_countZleafZ data_lengthr7 r r r Ú getpeercert¦ sN
ê
ð
ý
zWrappedSocket.getpeercertc C sž t ¡ }t | jt |¡¡}t|ƒ |jtj kr t | \| _| _d| _d| _d | _d | _d | _d | _d | _ d S rE )
Ú_protocol_to_min_maxÚ _min_versionÚ _max_versionÚ_optionsÚ_verifyÚ
_trust_bundleÚ _client_certÚ _client_keyÚ_client_key_passphraseÚ_alpn_protocols)rN r“ r r r rO 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 ©rN rr r r r r° + s c C s | j S r~ ©r¨ r€ r r r Úoptions3 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© rb Ú
CERT_REQUIREDZ CERT_NONEr€ r r r Ú verify_modeB s z"SecureTransportContext.verify_modec C s |t jkrdnd| _d S )NTF)rb r´ r© r± r r r rµ F s c C s d S r~ r r€ r r r Úset_default_verify_pathsJ s
z/SecureTransportContext.set_default_verify_pathsc C s | ¡ S r~ )r¶ r€ r r r Úload_default_certsV s z)SecureTransportContext.load_default_certsc C s |t jjkrtdƒ‚d S )Nz5SecureTransport doesn't support custom cipher strings)r r ZDEFAULT_CIPHERSrŒ )rN rU r r r Ú set_ciphersY s z"SecureTransportContext.set_ciphersNc C sN |d urt dƒ‚|d ur@t|ƒ W d ƒ n1 s60 Y |pF|| _d S )Nz1SecureTransport does not support cert directories)rŒ rm rª )rN ZcafileZcapathZcadatar r r Úload_verify_locations^ s
z,SecureTransportContext.load_verify_locationsc C s || _ || _|| _d S r~ )r« r¬ Z_client_cert_passphrase)rN ZcertfileZkeyfileÚpasswordr r r Úload_cert_chainj s z&SecureTransportContext.load_cert_chainc C s& t tdƒstdƒ‚dd„ |D ƒ| _dS )z
Sets the ALPN protocols that will later be set on the context.
Raises a NotImplementedError if ALPN is not supported.
rX z2SecureTransport supports ALPN only in macOS 10.12+c S s g | ]}t |¡‘qS r )ÚsixZ
ensure_binary)Ú.0Úpr r r Ú
y ó z=SecureTransportContext.set_alpn_protocols..N)Úhasattrr ÚNotImplementedErrorr® )rN rZ r r r Úset_alpn_protocolso s
ÿz)SecureTransportContext.set_alpn_protocolsFTc C sN |rJ ‚|sJ ‚|sJ ‚t |ƒ}| || j| j| j| j| j| j| j| j ¡ |S r~ )
rD r} r© rª r¦ r§ r« r¬ r r® )rN ZsockZ server_sideZdo_handshake_on_connectZsuppress_ragged_eofsr| r9 r r r Ú wrap_socket{ s ÷ z"SecureTransportContext.wrap_socket)NNN)NN)FTTN)r— r˜ r™ rš rO Úpropertyr° Úsetterr³ rµ r¶ r· r¸ r¹ r» rà rÄ r r r r r s2
úr )r )r¡ N)erš Z
__future__r r› r, r* Zos.pathrj rŠ r' rb r` Ú threadingÚweakrefr¼ Ú 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$ ÚLockrw 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_SHArT Z PROTOCOL_TLSr rŽ r¥ rÁ r’ r r‘ r r r r r r r r> rC Z SSLReadFuncru Z SSLWriteFuncrv ÚobjectrD r r r r r r Ú s 5 â% þ þ
þ
þ
þ
þ
76
<