VTO
U d Z ddlmZ ddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlZddl m Z ddlmZ ddlmZmZ dd lmZmZmZmZmZm Z m Z ej d
e d e
j rdd l!m"Z" d
dgZ#ej$ j% Z& ej' Z(de)d< e j* Z+dZ,ej$ j- ej. ej/ fej$ j0 ej. ej/ fiZ1 e2e
d rej3 ej3 fe1e
j4 < e2e
d rej5 ej5 fe1e
j6 < e2e
d rej. ej. fe1e
j7 < e2e
d rej8 ej8 fe1e
j9 < e2e
d rej/ ej/ fe1e
j: < e
j; j< ej. e
j; j= ej. e
j; j> ej8 e
j; j? ej/ e
j; j@ ej/ iZAde)d< d4dZBd4d ZCd5d"ZDd5d#ZE ejF eD ZG ejH eE ZI G d$ d% ZJ d6d7d1ZKeKeJ_K G d2 d3 ZLdS )8a
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.
) annotationsN)socket )util )CoreFoundationSecurity)
SecurityConst_assert_no_error_build_tls_unknown_ca_alert_cert_array_from_pem_create_cfstring_array_load_client_cert_chain_temporary_keychainz'urllib3.contrib.securetransport' module is deprecated and will be removed in urllib3 v2.1.0. Read more in this issue: https://github.com/urllib3/urllib3/issues/2681)category
stacklevel)Literalinject_into_urllib3extract_from_urllib3z/weakref.WeakValueDictionary[int, WrappedSocket]_connection_refsi @ PROTOCOL_SSLv2PROTOCOL_SSLv3PROTOCOL_TLSv1PROTOCOL_TLSv1_1PROTOCOL_TLSv1_2zdict[int, int]_tls_version_to_streturnNonec t t _ t t j _ dt _ dt j _ dS )zG
Monkey-patch urllib3 with SecureTransport-backed SSL-support.
TN)SecureTransportContextr
SSLContextssl_IS_SECURETRANSPORT q/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/urllib3/contrib/securetransport.pyr r s- -DO1DI "D#'DI r% c t t _ t t j _ dt _ dt j _ dS )z>
Undo monkey-patching by :func:`inject_into_urllib3`.
FN)orig_util_SSLContextr r! r" r# r$ r% r& r r s- +DO/DI #D#(DI r%
connection_idint data_bufferdata_length_pointer bytearrayc 4 d} t | }| t j S |j }|d }| }d}d} ||k r||dk r/t
j || st t j
d ||z
} t j | z
||z }
| |
| } || z
}| s|s t j S n||k ng# t $ rZ} | j }|G|t j
k r7||d< |t j k s|t j k rt j cY d} ~ S Y d} ~ nd} ~ ww xY w||d< ||k r t j S dS # t( $ r } || |_ t j cY d} ~ S d} ~ ww xY w)zs
SecureTransport read callback. This is called by ST to request that data
be returned from the socket.
Nr timed out)r getr
errSSLInternalr
gettimeoutr
wait_for_readOSErrorerrnoEAGAINctypesc_char from_address recv_intoerrSSLClosedGraceful
ECONNRESETEPIPEerrSSLClosedAborterrSSLWouldBlock Exception
_exception)
r) r+ r, wrapped_socket base_socketrequested_lengthtimeouterror
read_count remainingbuffer
chunk_sizees
r& _read_callbackrL s
N.,)--m<< ! / /$+ .q1 ++--
///?gll -k7CC A %elK @ @@ ,z 9 -)3AA *, ) 2 269 E E
j(
! % B , AA /// GE Uel%:%:)3#A&E ,,,0D0D(::::::: ",A ) ) ) 1 1q , , , %()N % +++++++,sf 'E. 'E. BC. &C. -E. .
E8A E
EE. E
E.
EE. .
F8F FFc d} t | }| t j S |j }|d }t j || }| }d}d} | |k ra||dk r/t j || st t j d |
| }
| |
z
} ||
d }| |k ang# t $ rZ} | j }|G|t j k r7| |d< |t j k s|t j k rt j cY d} ~ S Y d} ~ nd} ~ ww xY w| |d< | |k r t j S dS # t$ $ r } || |_ t j cY d} ~ S d} ~ ww xY w)zx
SecureTransport write callback. This is called by ST to request that data
actually be sent on the network.
Nr r/ )r r0 r
r1 r r7 string_atr2 r wait_for_writer4 r5 r6 sendr< r= r> r? r@ rA ) r) r+ r, rB rC bytes_to_writedatarE rF sent
chunk_sentrK s r& _write_callbackrU s N*,)--m<< ! / /$+ ,Q/ ^<< ++-- ''?gll .{GDD A %elK @ @@ ( - -d 3 3
" JKK( '' GE Uel%:%:)-#A&E ,,,0D0D(::::::: "&A > ! ! 1 1q , , , %()N % +++++++,s` 'E d Z d?d Z d@d Z
dAd"Z dBdCd(ZdDd+ZdEd-ZdFd/ZdGd0Zd@d1Zd@d2Zd@d3ZdHdId6ZdJd8Zd#S )K
WrappedSocketzO
API-compatibility wrapper for Python's OpenSSL wrapped socket object.
r
socket_clsr r c || _ d | _ d| _ d| _ d| _ d | _ d | _ d | _ d | _ | j | _
| j d d S Nr F) r context_io_refs_closed _real_closedrA _keychain
_keychain_dir_client_cert_chainr2 _timeout
settimeout)selfr s r& __init__zWrappedSocket.__init__; sw
!,0 )-"& ..00
q!!!!!r% "typing.Generator[None, None, None]c # x K d| _ dV | j %| j dc}| _ | |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)rA _real_close)rd exceptions r& _raise_on_errorz WrappedSocket._raise_on_errorN sQ
? &)- $ &It O ' &r% protocolslist[bytes] | Nonec |sdS t | } t j | j | }t | t j | dS # t j | w xY w)z<
Sets up the ALPN protocols on the context.
N)r r SSLSetALPNProtocolsr[ r r CFRelease)rd rk
protocols_arrresults r& _set_alpn_protocolsz!WrappedSocket._set_alpn_protocolsc ss F.y99
4 1$,
NNF V $ $ $ $] 3 3 3 3 3N $] 3 3 3 3s )A A*verifybool trust_bundle bytes | Nonec 6 |r|dS t j t j f} | | }||v rdS dt | }d}n # t
$ r}d|}|}Y d}~nd}~ww xY wt
| }| j | t j ddd } | j t j
t j | | t! j d| |)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.
Nz error code: z exception: iir r zcertificate verify failed, )r
kSecTrustResultUnspecifiedkSecTrustResultProceed_evaluate_trustr* r@ r versionr sendallstructpack
setsockopt
SOL_SOCKET SO_LINGERrh sslSSLError)
rd rs ru successes trust_resultreasonexcrK recoptss
r& _custom_validatez WrappedSocket._custom_validatep s9 - F
4 0
// ==Ly((7C $5$577FCC (1((FCCCCCC *$,,..99 C {4A&& v 0&2BDIII lAAABBKs A A
A+A&&A+bytesr* c t j | r>, ' ' (lD))
(Q vvxx
(
(
(
(
(
(
(
(
(
(
(
(
(
(
(
$&& 5-l;;J .t|V\%=P=PQQF V $ $ $
El#CDDD ;E:NNF V $ $ $ ?tLLF V $ $ $#688L .ufl<6P6PQQF V $ $ $
0 (///% (444
0 (///% (4444 & !!s AAA2C1F /F?server_hostnamebytes | str | None min_version max_version client_cert
str | None
client_keyclient_key_passphrase
typing.Anyalpn_protocolsc
t j dt j t j | _ t j | j t t }
t |
t 5 t | dz } | t v r| dz dz } | t v | t | < ddd n # 1 swxY w Y t j
| j | }
t |
|rat |t s| d }t j | j |t% | }
t |
| | t j | j | }
t |
t j | j | }
t |
|r|4t j | j t j d }
t |
|rdt1 \ | _ | _ t7 | j || | _ t j | j | j }
t |
| 5 t j | j }
|
t j k rtC j" d |
t j# k r#| $ || ddd t |
ddd dS # 1 swxY w Y )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 SSLCreateContextr
kSSLClientSidekSSLStreamTyper[
SSLSetIOFuncs_read_callback_pointer_write_callback_pointerr _connection_ref_lockidr SSLSetConnection
isinstancer encodeSSLSetPeerDomainNamelenrr SSLSetProtocolVersionMinSSLSetProtocolVersionMaxSSLSetSessionOption"kSSLSessionOptionBreakOnServerAuthr r_ r` r ra SSLSetCertificaterj SSLHandshaker? r rE errSSLServerAuthCompletedr ) rd r rs ru r r r r r r rq handles r& handshakezWrappedSocket.handshake sz $ 0 -.
0L
' L02I
" , ,XX
*F ,,, 1*
2 ,,,'+ V $ , , , , , , , , , , , , , , , *4<@@
% ou55
B"1"8"8"A"A 2 os?/C/C F
V $ $ $
000 24<MM 24<MM % 1 1 m NPT F
V $ $ $ %1D1F1F .DND .&= Z' 'D # / d>UVVF V $ $ $ %%''
!.t|<<] ;;; .)>???} FFF))&,???
%V,,,
s+ +7B..B25B2 A%K-K--K14K1c 4 | j S N)r filenord s r& r zWrappedSocket.fileno s {!!###r% c v | j dk r| xj dz c_ | j r| d S d S )Nr r )r\ r] closer s r& _decref_socketiosz WrappedSocket._decref_socketios sD =1 MMQ MM < JJLLLLL r% bufsizc t j | }| || }|d | }t j t
| S r )r7 create_string_bufferr: typingcastr )rd r rI
bytes_readrR s r& recvzWrappedSocket.recv# sE ,V44^^FF33
kzk"{5$'''r% NrI ctypes.Array[ctypes.c_char]nbytes
int | Nonec @ | j rdS |t | }t j |z | }t j d }| 5 t j | j ||t j
| }d d d n # 1 swxY w Y |t j k r |j
dk rt j d n>|t j t j fv r| nt' | |j
S )Nr zrecv timed out)r^ r r7 r8 from_bufferc_size_trj r SSLReadr[ r r
r? r r rE r; errSSLClosedNoNotifyrh r )rd rI r processed_bytesrq s r& r: zWrappedSocket.recv_into) sa 1 >[[F-&(55f== /!,,
!
!
#
# % fffl?.K.K F ]3 3 3
$)) n%5666 * . .
V $ $ $ $$s %/B B$'B$rE floatc || _ d S r rb )rd rE s r& rc zWrappedSocket.settimeoutV s
r% float | Nonec | j S r r r s r& r2 zWrappedSocket.gettimeoutY s
} r% rR c t j d }| 5 t j | j |t
| t j | }d d d n # 1 swxY w Y |t j k r |j
dk rt j d t | |j
S )Nr zsend timed out)r7 r rj r SSLWriter[ r r r
r? r r rE r )rd rR r rq s r& rP zWrappedSocket.send\ s /!,,
!
!
#
# & dCIIv|O/L/L F
]3 3 38MQR8R8R.!122 2 V $ $ $ $$s 7 &t~ 6 6 6 $T^ 4 4 4 M$, - - -26 6DNT /{ """r% F binary_formc \ |st d t j }d }d } t j | j t j | }t | |s1 |rt j | |rt j | d S d S t j
| }|s1 |rt j | |rt j | d S d S t j |d }|sJ t j | }|sJ t j
| }t j | } t j | | }|rt j | |rt j | n2# |rt j | |rt j | w w xY w|S )Nz2SecureTransport only supports dumping binary certsr )
ValueErrorr r r r[ r7 r r r ro SecTrustGetCertificateCount SecTrustGetCertificateAtIndexSecCertificateCopyDataCFDataGetLengthCFDataGetBytePtrrN )
rd r r certdata der_bytesrq
cert_countleaf data_lengthr+ s
r& getpeercertzWrappedSocket.getpeercert s ( S QRR R$&& 0 .t|V\%=P=PQQF V $ $ $
&
3 (222
0 (/////
0
0' "=eDDJ
3 (222
0 (/////
0
0 9%CCDKK4 6t<] 9 9 9, IJJ J
^} ;
;
; 9
^} ;
;
; 9
^} :
:
:7
^} :
:
:7
^} :
:
:7, Cx C CDD Dr% )r rX r r )r rf )rk rl r r )rs rt ru rv r r )ru r r r* )r r rs rt ru rv r r* r r* r r r r r r r rl r r r r* r r )r r* r r r )rI r r r r r* )rE r r r )r r )rR r r r* )rR r r r )F)r rt r rv )r r )__name__
__module__ __qualname____doc__re
contextlibcontextmanagerrj rr r r{ r r r r r: rc r2 rP r} r r rh r r| r$ r% r& rW rW 6 s " " " "& ( 4 4 4 4#L #L #L #LJ&" &" &" &"PZ Z Z Zx$ $ $ $ ( ( ( ( IM+% +% +% +% +%Z % % % %" , , , ,
#
#
#
# 8 8 8 8 8tE E E E E Er% rW rrd rX modeILiteral['r'] | Literal['w'] | Literal['rw'] | Literal['wr'] | Literal[''] bufferingr argsr kwargs typing.BinaryIO | typing.TextIOc 4 d}t j | ||g|R i |S r )rX makefile)rd r r r r s r& r r s. I tT9 Ft F F Fv F FFr% c e Zd ZdZd5dZed6d Zej d7d Zed8d Zej d9d
Zed8d Z e j d9d Z d:dZ
d:dZ d;dZ dd?d Zd@d"Z dAdBd.Zed8d/ Zej dCd1 Zed8d2 Zej dDd4 ZdS )Er z
I am a wrapper class for the SecureTransport library, to translate the
interface of the standard library ``SSLContext`` object to calls into
SecureTransport.
r r* r r c * t j j | _ t j j | _ |d t j t j fvrt | \ | _ | _
d| _ d| _ d | _
d | _ d | _ d | _ d | _ d S rZ )r
TLSVersionMINIMUM_SUPPORTED_minimum_versionMAXIMUM_SUPPORTED_maximum_version PROTOCOL_TLSPROTOCOL_TLS_CLIENT_protocol_to_min_max _min_version _max_version_options_verify
_trust_bundle _client_cert _client_key_client_key_passphrase_alpn_protocols)rd r s r& re z SecureTransportContext.__init__ s %(^%E %(^%E D#"2C4KL L L3G3Q 0D t 0
+/(,'+&*#37 r%
Literal[True]c dS )
SecureTransport cannot have its hostname checking disabled. For more,
see the comment on getpeercert() in this file.
Tr$ r s r& check_hostnamez%SecureTransportContext.check_hostname s tr% r r c dS )r, Nr$ rd r s r& r- z%SecureTransportContext.check_hostname s r% c | j S r r# r s r& optionsz SecureTransportContext.options s } r% c || _ d S r r1 r/ s r& r2 z SecureTransportContext.options s
r% c @ | j r t j n t j S r )r$ r
CERT_REQUIRED CERT_NONEr s r& verify_modez"SecureTransportContext.verify_mode! s $(LCs cmCr% c 0 |t j k | _ d S r )r r5 r$ r/ s r& r7 z"SecureTransportContext.verify_mode% s 11 r% c d S r r$ r s r& set_default_verify_pathsz/SecureTransportContext.set_default_verify_paths) s
r% c * | S r )r: r s r& load_default_certsz)SecureTransportContext.load_default_certs5 s ,,...r% ciphersc t d )Nz5SecureTransport doesn't support custom cipher strings)r )rd r= s r& set_ciphersz"SecureTransportContext.set_ciphers8 s PQQQr% Ncafiler capathcadatarv c |t d |(t | 5 d d d n # 1 swxY w Y |p|| _ d S )Nz1SecureTransport does not support cert directories)r r r% )rd r@ rA rB s r& load_verify_locationsz,SecureTransportContext.load_verify_locations; s PQQ Q f
$ -vs 155certfiler keyfilepasswordc 0 || _ || _ || _ d S r )r& r' _client_cert_passphrase)rd rE rF rG s r& load_cert_chainz&SecureTransportContext.load_cert_chainL s" %"'/$$$r% rk list[str | bytes]c p t t d st d d |D | _ dS )z
Sets the ALPN protocols that will later be set on the context.
Raises a NotImplementedError if ALPN is not supported.
rn z2SecureTransport supports ALPN only in macOS 10.12+c N g | ]"}t j |d #S )ascii)r to_bytes).0ps r&
z=SecureTransportContext.set_alpn_protocols..` s* R R R1 2 21g > > R R Rr% N)hasattrr NotImplementedErrorr) )rd rk s r& set_alpn_protocolsz)SecureTransportContext.set_alpn_protocolsV sK x!677 %D
S R R R R r% FTsockrX server_sidert do_handshake_on_connectsuppress_ragged_eofsr r rW c |rJ |sJ |sJ t | }| || j | j t | j t | j | j | j | j | j
|S r ) rW r r$ r% r r r r& r' r( r) )rd rV rW rX rY r rB s r& wrap_socketz"SecureTransportContext.wrap_socketb s &&&&#### 't,, L t 4 5 t 4 5 '
r% c | j S r r r s r& minimum_versionz&SecureTransportContext.minimum_version $$r% r^ c || _ d S r r] )rd r^ s r& r^ z&SecureTransportContext.minimum_version / r% c | j S r r r s r& maximum_versionz&SecureTransportContext.maximum_version r_ r% rd c || _ d S r rc )rd rd s r& rd z&SecureTransportContext.maximum_version ra r% )r r* r r )r r* )r r r r r )r r* r r r )r= r r r )NNN)r@ r rA r rB rv r r )NN)rE r rF r rG r r r )rk rK r r )FTTN) rV rX rW rt rX rt rY rt r r r rW )r^ r* r r )rd r* r r )r r r
r re propertyr- setterr2 r7 r: r< r? rD rJ rU r[ r^ rd r$ r% r& r r sM 8 8 8 8 X X
^ ^ D D D XD 2 2 2 2
/ / / /R R R R
" ! # . . . . .( # # 0 0 0 0 0
S
S
S
S "(,%).2
B % % % X% 0 0 0 0 % % % X% 0 0 0 0 0 0r% r r )r) r* r+ r* r, r- r r* )r N) rd rX r r r r r r r r r r )Mr
__future__r r r7 r5 os.pathr r r r r~ threadingr warningsweakrefrX r _securetransport.bindingsr r _securetransport.low_levelr
r r r
r r r warnDeprecationWarning
TYPE_CHECKINGtyping_extensionsr __all__r" r! r( WeakValueDictionaryr __annotations__Lockr r r r r r r rS r r r r r r r r r r r TLSv1_1TLSv1_2r r r r rL rU SSLReadFuncr SSLWriteFuncr rW r r r$ r% r& r| s 4 4 4l # " " " " "
' ' ' ' ' '
5
*)))))) "8
9y+ ( G !! " " " " &y~'' I] 8-:V WI!#$$ 73 !! ##0+, 73 !! ##0+, 73 !! ##0+, 73"## $$2-. 73"## $$2-. N$m&AN-5NM 8NM 8N$m&B & ( ( ( () ) ) )6, 6, 6, 6,r2, 2, 2, 2,p .-n== /(/@@ cE cE cE cE cE cE cE cET
G G G G G "
c0 c0 c0 c0 c0 c0 c0 c0 c0 c0r%