U 5oKaq@sdZddlmZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlmZddlmZddlmZmZmZdd lmZmZmZmZmZmZzdd l mZWn$ek rdZdd l m!Z!YnXd d gZ"dZ#ej#Z$ej%j&Z'e (Z)e *Z+dZ,ej-ej.ej/ej0ej1ej2ej3ej4ej5ej6ej7ej8ej9ej:ej;ejej?ej@ejAejBejCejDejEejFejGejHejIejJgZKejLejMejNfeejMejNfiZOePe drejQejQfeOe jR<ePe drejSejSfeOe jT<ePe dr ejMejMfeOe jU<ePe dr*ejVejVfeOe jW<ePe drHejNejNfeOe jX<dd ZYdd ZZddZ[ddZ\e]e[Z^e_e\Z`GdddeaZberd$ddZcn d%d!dZceceb_cGd"d#d#eaZddS)&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)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_2cCs.tt_ttj_tt_ttj_dt_dtj_dS)zG Monkey-patch urllib3 with SecureTransport-backed SSL-support. TN)SecureTransportContextr SSLContextssl_HAS_SNIIS_SECURETRANSPORTrrI/usr/local/lib/python3.8/site-packages/urllib3/contrib/securetransport.pyrs cCs.tt_ttj_tt_ttj_dt_dtj_dS)z> Undo monkey-patching by :func:`inject_into_urllib3`. FN)orig_util_SSLContextrrrorig_util_HAS_SNIrrrrrr rs c Csd}zJt|}|dkr"tjWS|j}|d}|}d}d}z|||kr|dksZ|dkrtt||sttt j d||} t j |  ||} || | } || 7}| sB|stjWWSqqBWnttjk r0} zR| j }|dk r |t j kr ||d<|t jks|t jkrtjWY WSW5d} ~ XYnX||d<||krLtjWSWdStk r} z|dk rt| |_tjWYSd} ~ XYnXdS)zs SecureTransport read callback. This is called by ST to request that data be returned from the socket. Nr timed out)_connection_refsgetr errSSLInternalsocket gettimeoutrZ wait_for_readerrorerrnoEAGAINctypesc_char from_address recv_intoerrSSLClosedGraceful ECONNRESETEPIPEerrSSLClosedAborterrSSLWouldBlock Exception _exception) connection_id data_bufferdata_length_pointerwrapped_socket base_socketZrequested_lengthtimeoutr)Z read_count remainingbuffer chunk_sizeerrr _read_callbacksP       rAc Csrd}z(t|}|dkr"tjWS|j}|d}t||}|}d}d} zV| |kr|dksf|dkrt ||st t j d| |} | | 7} || d}qNWnltj k r} zJ| j }|dk r|t j kr| |d<|t jks|t jkrtjWY WSW5d} ~ XYnX| |d<| |kr*tjWSWdStk rl} z|dk rR| |_tjWYSd} ~ XYnXdS)zx SecureTransport write callback. This is called by ST to request that data actually be sent on the network. Nrr#)r$r%r r&r'r, string_atr(rZwait_for_writer)r*r+sendr1r2r3r4r5r6) r7r8r9r:r;Zbytes_to_writedatar<r)sentZ chunk_sentr@rrr _write_callback sD      rFc@seZdZdZddZejddZddZdd Z d d Z d d Z ddZ ddZ ddZddZd.ddZddZddZddZdd 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. cCsL||_d|_d|_d|_d|_d|_d|_d|_|j|_ |j ddSNrF) r'context_makefile_refs_closedr6 _keychain _keychain_dir_client_cert_chainr(_timeout settimeout)selfr'rrr __init__Ns zWrappedSocket.__init__ccs4d|_dV|jdk r0|jd}|_||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)r6close)rQ exceptionrrr _raise_on_error`s  zWrappedSocket._raise_on_errorcCs2tjttt}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)rZSSLCipherSuitelen CIPHER_SUITESZSSLSetEnabledCiphersrIr )rQciphersresultrrr _set_ciphersuszWrappedSocket._set_ciphersc Cs<|sdSt|}zt|j|}t|W5t|XdS)z< Sets up the ALPN protocols on the context. N)r r CFReleaserSSLSetALPNProtocolsrIr )rQ protocolsZ protocols_arrrYrrr _set_alpn_protocolss z!WrappedSocket._set_alpn_protocolsc Cs|sdStjtjf}z&||}||kr.WdSd|f}Wn,tk rf}zd|f}W5d}~XYnXt|}|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: %riirrzcertificate verify failed, %s)r ZkSecTrustResultUnspecifiedZkSecTrustResultProceed_evaluate_trustr5r versionr'sendallstructpack setsockopt SOL_SOCKET SO_LINGERrSsslSSLError) rQverify trust_bundleZ successes trust_resultreasonr@Zrecoptsrrr _custom_validates$   zWrappedSocket._custom_validatec Cstj|r*t|d}|}W5QRXd}t}zt |}t |j t |}t||sjtdt||}t|t|d}t|t}t|t |}t|W5|rt||dk rt|X|jS)NrbzFailed to copy trust referenceT)ospathisfileopenreadr SecTrustRefrr[r SSLCopyPeerTrustrIr,byrefr rhriZSecTrustSetAnchorCertificatesZ!SecTrustSetAnchorCertificatesOnlyZSecTrustResultTypeZSecTrustEvaluatevalue)rQrkfZ cert_arraytrustrYrlrrr r`s.        zWrappedSocket._evaluate_trustc Cstdtjtj|_t|jtt} t | t 0t |d} | t krT| dd} q>|t | <W5QRXt |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 | |ht |j} | tj!krt"#dn>| tj$kr|%||W5QRqRnt | W5QRqW5QRXqRdS)z Actually performs the TLS handshake. This is run automatically by wrapped socket, and shouldn't be needed in user code. Nirzutf-8Tzhandshake timed out)&rZSSLCreateContextr ZkSSLClientSideZkSSLStreamTyperIZ SSLSetIOFuncs_read_callback_pointer_write_callback_pointerr _connection_ref_lockidr$ZSSLSetConnection isinstancebytesencodeZSSLSetPeerDomainNamerVrZr^ZSSLSetProtocolVersionMinZSSLSetProtocolVersionMaxZSSLSetSessionOptionZ"kSSLSessionOptionBreakOnServerAuthrrLrMrrNZSSLSetCertificaterUZ SSLHandshaker4r'r<ZerrSSLServerAuthCompletedro) rQserver_hostnamerjrk min_versionZ max_versionZ client_certZ client_keyZclient_key_passphraseZalpn_protocolsrYhandlerrr handshakest          zWrappedSocket.handshakecCs |jSN)r'filenorQrrr r7szWrappedSocket.filenocCs*|jdkr|jd8_|jr&|dS)Nrr)rJrKrSrrrr _decref_socketios;s zWrappedSocket._decref_socketioscCs&t|}|||}|d|}|Sr)r,create_string_bufferr/)rQZbufsizr>Z bytes_readrDrrr recvAs   zWrappedSocket.recvNc Cs|jr dS|dkrt|}tj||}td}|t|j ||t |}W5QRX|t j kr|j dkrtdn"|t jt jfkr|nt||j S)Nrzrecv timed out)rKrVr,r- from_bufferc_size_trUrZSSLReadrIrxr r4ryr'r<r0ZerrSSLClosedNoNotifyrSr )rQr>nbytesprocessed_bytesrYrrr r/Gs.      zWrappedSocket.recv_intocCs ||_dSrrO)rQr<rrr rPrszWrappedSocket.settimeoutcCs|jSrrrrrr r(uszWrappedSocket.gettimeoutc Cshtd}|"t|j|t|t|}W5QRX|tj krZ|j dkrZt dnt ||j S)Nrzsend timed out)r,rrUrZSSLWriterIrVrxr r4ryr'r<r )rQrDrrYrrr rCxs   zWrappedSocket.sendcCs4d}|t|kr0||||t}||7}qdSNr)rVrCSSL_WRITE_BLOCKSIZE)rQrD total_sentrErrr rbs zWrappedSocket.sendallc Cs$|t|jW5QRXdSr)rUrZSSLCloserIrrrr shutdowns zWrappedSocket.shutdowncCs|jdkrd|_|jr(t|jd|_|jr@t|jd|_|jrvt|jt|jt |j d|_|_ |j S|jd8_dS)NrT)rJrKrIrr[rNrLrZSecKeychainDeleteshutilrmtreerMr'rSrrrr rSs        zWrappedSocket.closeFc Cs|s tdt}d}d}zt|jt|}t ||sFWddSt |}|s\WNdSt |d}|spt t |}|st t|}t|} t| |}W5|rt||rt|X|S)Nz2SecureTransport only supports dumping binary certsr) ValueErrorrrvrr[rwrIr,rxr ZSecTrustGetCertificateCountZSecTrustGetCertificateAtIndexAssertionErrorZSecCertificateCopyDataZCFDataGetLengthZCFDataGetBytePtrrB) rQZ binary_formr{ZcertdataZ der_bytesrYZ cert_countleafZ data_lengthr8rrr getpeercerts2       zWrappedSocket.getpeercertcCst}t|jt|}t||jtj krt|\|_|_d|_d|_d|_d|_d|_d|_d|_ dSrH) _protocol_to_min_max _min_version _max_version_options_verify _trust_bundle _client_cert _client_key_client_key_passphrase_alpn_protocols)rQrrrr rRszSecureTransportContext.__init__cCsdS) SecureTransport cannot have its hostname checking disabled. For more, see the comment on getpeercert() in this file. Trrrrr check_hostname#sz%SecureTransportContext.check_hostnamecCsdS)rNrrQryrrr r+scCs|jSrrrrrr options3szSecureTransportContext.optionscCs ||_dSrrrrrr r=scCs|jr tjStjSr)rrh CERT_REQUIREDZ CERT_NONErrrr verify_modeBsz"SecureTransportContext.verify_modecCs|tjkrdnd|_dS)NTF)rhrrrrrr rFscCsdSrrrrrr set_default_verify_pathsJs z/SecureTransportContext.set_default_verify_pathscCs|Sr)rrrrr load_default_certsVsz)SecureTransportContext.load_default_certscCs|tjjkrtddS)Nz5SecureTransport doesn't support custom cipher strings)rrZDEFAULT_CIPHERSr)rQrXrrr set_ciphersYs z"SecureTransportContext.set_ciphersNc Cs:|dk rtd|dk r,t|W5QRX|p2||_dS)Nz1SecureTransport does not support cert directories)rrtr)rQZcafileZcapathZcadatarrr load_verify_locations^s   z,SecureTransportContext.load_verify_locationscCs||_||_||_dSr)rrZ_client_cert_passphrase)rQZcertfileZkeyfilepasswordrrr load_cert_chainjsz&SecureTransportContext.load_cert_chaincCs&ttdstddd|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+cSsg|]}t|qSr)sixZ ensure_binary).0prrr ysz=SecureTransportContext.set_alpn_protocols..N)hasattrrNotImplementedErrorr)rQr]rrr set_alpn_protocolsos  z)SecureTransportContext.set_alpn_protocolsFTc CsN|rt|st|stt|}|||j|j|j|j|j|j|j |j |Sr) rrGrrrrrrrrr)rQsockZ server_sideZdo_handshake_on_connectZsuppress_ragged_eofsrr:rrr wrap_socket{s  z"SecureTransportContext.wrap_socket)NNN)NN)FTTN)rrrrrRpropertyrsetterrrrrrrrrrrrrr rs2         r)r)rN)er __future__rrr,r*os.pathrqrr'rhrc threadingweakrefrrZ util.ssl_rZ_securetransport.bindingsrrr Z_securetransport.low_levelr r r r rrr ImportErrorZpackages.backports.makefiler__all__rr"rrr!WeakValueDictionaryr$Lockr~rZ'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_SHA256ZTLS_RSA_WITH_AES_256_GCM_SHA384ZTLS_RSA_WITH_AES_128_GCM_SHA256ZTLS_AES_128_CCM_8_SHA256ZTLS_AES_128_CCM_SHA256ZTLS_RSA_WITH_AES_256_CBC_SHA256ZTLS_RSA_WITH_AES_128_CBC_SHA256ZTLS_RSA_WITH_AES_256_CBC_SHAZTLS_RSA_WITH_AES_128_CBC_SHArWZ PROTOCOL_TLSrrrrrrrrrrrrrrrArFZ SSLReadFuncr|Z SSLWriteFuncr}objectrGrrrrrr s5    %              76  <