*j
` S r SSKrSSKrSSKJr SSKJrJr J
r SSKJ r SSK
r
SSK
JrJrJr SSK
JrJrJr SSK
JrJrJrJrJrJrJr SS K
Jr J r SS
K
J r J r J!r! SS K
J"r" SS K
J$r$J%r%J&r&J'r'J(r(J)r)J*r*J+r+J,r,J-r-J.r. SS
K
J/r/J0r0 \ Rb " S\2S \
S9 \ Rb " S\2S \
S9 \ Rb " S\2S \
S9 \ Rb " S\2S \
S9 \ Rb " S\2S \
S9 \ Rb " S\2S \
S9 \3Rh =r5\3l5 \3Rl Ro 5 V Vs0 s H u pX_M snn r8\9" \3SS5 r:\ " \ 5 " S S 5 5 r;\ " \ 5 " S S 5 5 r<\ " \ 5 " S S!5 5 r=\ " \ 5 " S" S#5 5 r>\R~ S$:X a SS%K
J@r@JArA SS&KBJBrBJCrCJDrD SS'KBJErEJFrFJGrG SSKBrHSSKIrISSKJrJSSKKrK\LrMS(/rN\O" \
S)5 rP\/rQ\rRS* rSS+ rTS, rU\" S-S.5 rVS/ rW " S0 S1\" S1S25 5 rX " S3 S4\X\5 rY " S5 S6\5 rZ\YR 4SSSS7.S8 jjr\SH\]S9\YR SSSSSS:.S; jjr^\\r_\^r` " S< S=5 raS> rb " S? S@\B5 rc\c\Zld \a\Zle SA rfSBrgSCrhSD riSE rj\kS\G4SF jrlSG rmg! \# a GNBf = fs snn f )Ia
This module provides some more Pythonic support for SSL.
Object types:
SSLSocket -- subtype of socket.socket which does SSL over the socket
Exceptions:
SSLError -- exception raised for I/O errors
Functions:
cert_time_to_seconds -- convert time string used for certificate
notBefore and notAfter functions to integer
seconds past the Epoch (the time values
returned from time.time())
get_server_certificate (addr, ssl_version, ca_certs, timeout) -- Retrieve the
certificate from the server at the specified
address and return it as a PEM-encoded string
Integer constants:
SSL_ERROR_ZERO_RETURN
SSL_ERROR_WANT_READ
SSL_ERROR_WANT_WRITE
SSL_ERROR_WANT_X509_LOOKUP
SSL_ERROR_SYSCALL
SSL_ERROR_SSL
SSL_ERROR_WANT_CONNECT
SSL_ERROR_EOF
SSL_ERROR_INVALID_ERROR_CODE
The following group define certificate requirements that one side is
allowing/requiring from the other side:
CERT_NONE - no certificates from the other side are required (or will
be looked at if provided)
CERT_OPTIONAL - certificates are not required, but if provided will be
validated, and if validation fails, the connection will
also fail
CERT_REQUIRED - certificates are required, and will be validated, and
if validation fails, the connection will also fail
The following constants identify various SSL protocol variants:
PROTOCOL_SSLv2
PROTOCOL_SSLv3
PROTOCOL_SSLv23
PROTOCOL_TLS
PROTOCOL_TLS_CLIENT
PROTOCOL_TLS_SERVER
PROTOCOL_TLSv1
PROTOCOL_TLSv1_1
PROTOCOL_TLSv1_2
The following constants identify various SSL alert message descriptions as per
http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6
ALERT_DESCRIPTION_CLOSE_NOTIFY
ALERT_DESCRIPTION_UNEXPECTED_MESSAGE
ALERT_DESCRIPTION_BAD_RECORD_MAC
ALERT_DESCRIPTION_RECORD_OVERFLOW
ALERT_DESCRIPTION_DECOMPRESSION_FAILURE
ALERT_DESCRIPTION_HANDSHAKE_FAILURE
ALERT_DESCRIPTION_BAD_CERTIFICATE
ALERT_DESCRIPTION_UNSUPPORTED_CERTIFICATE
ALERT_DESCRIPTION_CERTIFICATE_REVOKED
ALERT_DESCRIPTION_CERTIFICATE_EXPIRED
ALERT_DESCRIPTION_CERTIFICATE_UNKNOWN
ALERT_DESCRIPTION_ILLEGAL_PARAMETER
ALERT_DESCRIPTION_UNKNOWN_CA
ALERT_DESCRIPTION_ACCESS_DENIED
ALERT_DESCRIPTION_DECODE_ERROR
ALERT_DESCRIPTION_DECRYPT_ERROR
ALERT_DESCRIPTION_PROTOCOL_VERSION
ALERT_DESCRIPTION_INSUFFICIENT_SECURITY
ALERT_DESCRIPTION_INTERNAL_ERROR
ALERT_DESCRIPTION_USER_CANCELLED
ALERT_DESCRIPTION_NO_RENEGOTIATION
ALERT_DESCRIPTION_UNSUPPORTED_EXTENSION
ALERT_DESCRIPTION_CERTIFICATE_UNOBTAINABLE
ALERT_DESCRIPTION_UNRECOGNIZED_NAME
ALERT_DESCRIPTION_BAD_CERTIFICATE_STATUS_RESPONSE
ALERT_DESCRIPTION_BAD_CERTIFICATE_HASH_VALUE
ALERT_DESCRIPTION_UNKNOWN_PSK_IDENTITY
N)
namedtuple)EnumIntEnumIntFlag) _simple_enum)OPENSSL_VERSION_NUMBEROPENSSL_VERSION_INFOOPENSSL_VERSION) _SSLContext MemoryBIO
SSLSession)SSLErrorSSLZeroReturnErrorSSLWantReadErrorSSLWantWriteErrorSSLSyscallError SSLEOFErrorSSLCertVerificationError)txt2objnid2obj) RAND_statusRAND_add
RAND_bytes)RAND_egd) HAS_SNIHAS_ECDHHAS_NPNHAS_ALPN HAS_SSLv2 HAS_SSLv3 HAS_TLSv1 HAS_TLSv1_1 HAS_TLSv1_2 HAS_TLSv1_3HAS_PSK)_DEFAULT_CIPHERS_OPENSSL_API_VERSION
_SSLMethodc < U R S5 =( a U S:g $ )N PROTOCOL_PROTOCOL_SSLv23
startswithnames */opt/alt/python313/lib64/python3.13/ssl.pyr1 } s -K$:K2KK )sourceOptionsc $ U R S5 $ )NOP_r, r. s r0 r1 r1 s
'r2 AlertDescriptionc $ U R S5 $ )NALERT_DESCRIPTION_r, r. s r0 r1 r1 s !56r2 SSLErrorNumberc $ U R S5 $ )N
SSL_ERROR_r, r. s r0 r1 r1 s
.r2 VerifyFlagsc $ U R S5 $ )NVERIFY_r, r. s r0 r1 r1 s
+r2
VerifyModec $ U R S5 $ )NCERT_r, r. s r0 r1 r1 s
)r2 PROTOCOL_SSLv2c \ rS rSr\R
r\R r\R r
\R r \R r\R r\R" rSrg)
TLSVersion N)__name__
__module__ __qualname____firstlineno___sslPROTO_MINIMUM_SUPPORTEDMINIMUM_SUPPORTED PROTO_SSLv3SSLv3 PROTO_TLSv1TLSv1
PROTO_TLSv1_1TLSv1_1
PROTO_TLSv1_2TLSv1_2
PROTO_TLSv1_3TLSv1_3PROTO_MAXIMUM_SUPPORTEDMAXIMUM_SUPPORTED__static_attributes__rG r2 r0 rE rE sQ 44 E E G G G 44r2 rE c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) _TLSContentType z8Content types (record layer)
See RFC 8446, section B.1
rG N) rH rI rJ rK __doc__CHANGE_CIPHER_SPECALERT HANDSHAKEAPPLICATION_DATAHEADERINNER_CONTENT_TYPEr[ rG r2 r0 r] r] s* EI
F r2 r] c \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrSrSrSrSrSr Sr S r S r S r S r!S r"S!r#S"r$S#r%S$r&S%r'g&)'
_TLSAlertType zIAlert types for TLSContentType.ALERT messages
See RFC 8446, section B.2
r
r_ r` ra ( ) * + , - . / 0 1 2 3 < F G P V Z d m n o p q r s t x rG N)(rH rI rJ rK re CLOSE_NOTIFYUNEXPECTED_MESSAGEBAD_RECORD_MACDECRYPTION_FAILEDRECORD_OVERFLOWDECOMPRESSION_FAILUREHANDSHAKE_FAILURENO_CERTIFICATEBAD_CERTIFICATEUNSUPPORTED_CERTIFICATECERTIFICATE_REVOKEDCERTIFICATE_EXPIREDCERTIFICATE_UNKNOWNILLEGAL_PARAMETER
UNKNOWN_CA
ACCESS_DENIED DECODE_ERROR
DECRYPT_ERROREXPORT_RESTRICTIONPROTOCOL_VERSIONINSUFFICIENT_SECURITYINTERNAL_ERRORINAPPROPRIATE_FALLBACK
USER_CANCELEDNO_RENEGOTIATIONMISSING_EXTENSIONUNSUPPORTED_EXTENSIONCERTIFICATE_UNOBTAINABLEUNRECOGNIZED_NAME BAD_CERTIFICATE_STATUS_RESPONSEBAD_CERTIFICATE_HASH_VALUEUNKNOWN_PSK_IDENTITYCERTIFICATE_REQUIREDNO_APPLICATION_PROTOCOLr[ rG r2 r0 rm rm s LNO NO JMLM N M " &)#!$ !r2 rm c p \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrSrSrSrSrg)_TLSMessageType z>Message types (handshake protocol)
See RFC 8446, section B.3
r
r_ r` ra rb C rd rG N) rH rI rJ rK re
HELLO_REQUEST CLIENT_HELLO SERVER_HELLOHELLO_VERIFY_REQUESTNEWSESSION_TICKETEND_OF_EARLY_DATAHELLO_RETRY_REQUESTENCRYPTED_EXTENSIONS CERTIFICATESERVER_KEY_EXCHANGECERTIFICATE_REQUEST SERVER_DONECERTIFICATE_VERIFYCLIENT_KEY_EXCHANGEFINISHEDCERTIFICATE_URLCERTIFICATE_STATUSSUPPLEMENTAL_DATA
KEY_UPDATE
NEXT_PROTO MESSAGE_HASHrf r[ rG r2 r0 r r s MLL K K HOJJL r2 r win32)enum_certificates enum_crls)socket SOCK_STREAMcreate_connection)
SOL_SOCKETSO_TYPE_GLOBAL_DEFAULT_TIMEOUT
tls-unique HOSTFLAG_NEVER_CHECK_SUBJECTc 6 U ( d gU R S5 nU( d! U R 5 UR 5 :H $ US: a [ SR U 5 5 eU R S5 u p4nSU; a [ SR U 5 5 eU( d [ SR U 5 5 eUS:w a [ SR U 5 5 eUR S5 u pdnU( a U( d gUR 5 UR 5 :H $ ) a Matching according to RFC 6125, section 6.4.3
- Hostnames are compared lower-case.
- For IDNA, both dn and hostname must be encoded as IDN A-label (ACE).
- Partial wildcards like 'www*.example.org', multiple wildcards, sole
wildcard or wildcards in labels other then the left-most label are not
supported and a CertificateError is raised.
- A wildcard must match at least one character.
F*r z1too many wildcards in certificate DNS name: {!r}..z9wildcard can only be present in the leftmost label: {!r}.z>sole wildcard without additional labels are not support: {!r}.z(>fD(*
f(=(=f4 & $ & &r2 c \ ^ \ rS rSrSrSrU 4S jr\U 4S j5 r\U 4S j5 r Sr
U =r $ ) _ASN1Objecti z#ASN.1 object identifier lookup
rG c 6 > [ TU ] " U /[ USS9Q76 $ )NFr. super__new___txt2obj)clsoid __class__s r0 r _ASN1Object.__new__ s ws?Xc%>??r2 c 8 > [ TU ] " U /[ U5 Q76 $ )z3Create _ASN1Object from OpenSSL numeric ID
)r r _nid2obj)r nidr s r0 fromnid_ASN1Object.fromnid s ws3Xc]33r2 c 6 > [ TU ] " U /[ USS9Q76 $ )z=Create _ASN1Object from short name, long name or OID
Tr. r )r r/ r s r0 fromname_ASN1Object.fromname s ws?Xd%>??r2 ) rH rI rJ rK re __slots__r classmethodr r" r[
__classcell__r s @r0 r r s= I@ 4 4
@ @r2 r znid shortname longname oidc \ rS rSrSrSrSrSrg)Purposei zDSSLContext purpose flags with X509v3 Extended Key Usage objects
z1.3.6.1.5.5.7.3.1z1.3.6.1.5.5.7.3.2rG N)rH rI rJ rK re SERVER_AUTH CLIENT_AUTHr[ rG r2 r0 r) r) s %K%Kr2 r) c ^ \ rS rSrSrSrSrSrS!S jrS r S"S jr
S#S jr S r S
r
S rS r\R" 4S
jr\" \S5 ( a@ \U 4S j5 r\R. U 4S j5 r\U 4S j5 r\R. U 4S j5 r\U 4S j5 r\R. U 4S j5 r\" \S5 ( a \S 5 r\R. S 5 rO\S 5 r\U 4S j5 r \ R. U 4S j5 r \U 4S j5 r \U 4S j5 r \ R. U 4S j5 r \U 4S j5 r \ R. U 4S j5 r S r U =r!$ )$
SSLContexti zxAn SSLContext holds various SSL-related configuration options and
data, such as certificates and possibly a private key.)CAROOTNc x Uc [ R " S[ SS9 [ n[ R
" X5 nU$ )Nz9ssl.SSLContext() without protocol argument is deprecated.r )category
stacklevel)warningswarnDeprecationWarning PROTOCOL_TLSr r )r protocolargskwargsselfs r0 r SSLContext.__new__ s9 MMK+
$H""31 r2 c Uc g [ U[ 5 ( a UR S5 R S5 $ UR S5 $ )Nidnaascii)
isinstancestrencodedecode)r: r s r0 _encode_hostnameSSLContext._encode_hostname sA
#
&
&??6*11': :??7+ +r2 c
@ U R R UUUUUU US9$ )N)sock server_sidedo_handshake_on_connectsuppress_ragged_eofsserver_hostnamecontextsession)sslsocket_class_create)r: rF rG rH rI rJ rL s r0 wrap_socketSSLContext.wrap_socket s7 ##++#$;!5 + ,
r2 c X U R R XUU R U5 XPS9$ )N)rG rJ rL rK )sslobject_classrN rC )r: incomingoutgoingrG rJ rL s r0 wrap_bioSSLContext.wrap_bio s8 ##++ K 1 1/ B ,
r2 c @ [ R " S[ SS9 [ 5 nU Hc n[ US5 n[ U5 S:X d [ U5 S: a [
S5 eUR [ U5 5 UR U5 Me U R U5 g )N'ssl NPN is deprecated, use ALPN insteadr r2 r> r z(NPN protocols must be 1 to 255 in length)
r3 r4 r5 bytearraybyteslenr appendextend_set_npn_protocols)r:
npn_protocolsprotosr7 bs r0 set_npn_protocols SSLContext.set_npn_protocols s
5
%Hh(A1v{c!fsl IJJ MM#a& ! MM! &
'r2 c p ^ ^ Tc S T l g [ T5 ( d [ S5 eU U4S jnUT l g )Nznot a callable objectc 8 > TR U5 nT" XU5 $ N)rC )sslobj
servernamesslctxr: server_name_callbacks r0 shim_cb3SSLContext.set_servername_callback..shim_cb s ! 2 2: >
+FGGr2 ) sni_callbackcallable TypeError)r: rl rm s `` r0 set_servername_callback"SSLContext.set_servername_callback s9 ' $D 011 788
H !(D r2 c [ 5 nU Hc n[ US5 n[ U5 S:X d [ U5 S: a [ S5 eUR [ U5 5 UR U5 Me U R
U5 g )Nr> r rZ z)ALPN protocols must be 1 to 255 in length)r[ r\ r] r r^ r_ _set_alpn_protocols)r: alpn_protocolsrb r7 rc s r0 set_alpn_protocols SSLContext.set_alpn_protocols sl &Hh(A1v{c!fsl JKK MM#a& ! MM! '
(r2 c > [ U5 H5 u p4nUS:X d M USL d UR U; d M% U R US9 M7 g ! [ a% n[ R
" SU< 35 S nAMd S nAff = f! [ a [ R
" S5 g f = f)Nx509_asnT)cadataz.Bad certificate in Windows certificate store: z-unable to enumerate Windows certificate store)r r load_verify_locationsr r3 r4 PermissionError)r: storenamepurposecertencodingtrustexcs r0 _load_windows_store_certs$SSLContext._load_windows_store_certs s
K):9)E%z) } u(<d 6 6d 6 C *F ( d $MM,Z[^Za*b c cd K MMI J Ks? A9 A9 AA9
A6A1+A9 1A66A9 9 B B c [ U[ 5 ( d [ U5 e[ R S:X a$ U R
H nU R
X!5 M U R 5 g )Nr )r? r rq sysplatform_windows_cert_storesr set_default_verify_paths)r: r r~ s r0 load_default_certs SSLContext.load_default_certs sP ';//G$ $ <<7 " ! 6 6 ..yB 7 %%'r2 minimum_versionc * > [ [ TU ] 5 $ rh )rE r r r: r s r0 r SSLContext.minimum_version eg 56 6r2 c > U[ R :X a$ U =R [ R ) - sl [
[ [ ] R X5 g rh ) rE rP optionsr4 OP_NO_SSLv3r r- r __set__r: valuer s r0 r r s=
((( !4!4 44 *j 9 A A$ Nr2 c * > [ [ TU ] 5 $ rh )rE r maximum_versionr s r0 r SSLContext.maximum_version# r r2 c H > [ [ [ ]
R X5 g rh )r r- r r r s r0 r r ' s *j 9 A A$ Nr2 c * > [ [ TU ] 5 $ rh )r4 r r r s r0 r SSLContext.options+ s uw''r2 c H > [ [ [ ]
R X5 g rh )r r- r r r s r0 r r / s
j*-55dBr2 r c b U R [ R - nU[ R :g $ rh _host_flagsrL r )r: ncss r0 hostname_checks_common_name&SSLContext.hostname_checks_common_name4 s) ""T%F%FFC$;;; ;r2 c U( a% U =R [ R ) - sl g U =R [ R - sl g rh r )r: r s r0 r r 9 s6 T%F%F$FF D$E$EE r2 c g)NTrG r: s r0 r r @ s r2 c 8 > [ TU ] nUb UR $ g)aa TLS message callback
The message callback provides a debugging hook to analyze TLS
connections. The callback is called for any TLS protocol message
(header, handshake, alert, and more), but not for application data.
Due to technical limitations, the callback can't be used to filter
traffic or to abort a connection. Any exception raised in the
callback is delayed until the handshake, read, or write operation
has been performed.
def msg_cb(conn, direction, version, content_type, msg_type, data):
pass
conn
:class:`SSLSocket` or :class:`SSLObject` instance
direction
``read`` or ``write``
version
:class:`TLSVersion` enum member or int for unknown version. For a
frame header, it's the header version.
content_type
:class:`_TLSContentType` enum member or int for unsupported
content type.
msg_type
Either a :class:`_TLSContentType` enum number for a header
message, a :class:`_TLSAlertType` enum member for an alert
message, a :class:`_TLSMessageType` enum member for other
messages, or int for unsupported message types.
data
Raw, decrypted message content as bytes
N)r
_msg_callback
user_function)r: innerr s r0 r SSLContext._msg_callbackD s% B % && &r2 c >^ Tc# [ [ [ ]
R U S 5 g [ TS5 ( d [ T S35 eU4S jnTUl [ [ [ ]
R X5 g )N__call__z is not callable.c 4 > [ U5 n [ U5 nU[ R :X a [ nO!U[ R :X a [
nO[ n U" U5 nT" XUX4U5 $ ! [ a Nhf = f! [ a Nlf = f! [ a N7f = frh )rE r r] rj rg rm r )conn directionversion content_typemsg_typedatamsg_enumcallbacks r0 r 'SSLContext._msg_callback..innert s
$W-
.| < 5 55* !6!66(*
#H- DW (D:
:'
s4 A* A: B
*
A76A7:
BB
BB)r r- r r hasattrrq r )r: r r r s ` r0 r r k sg *j 7 ? ?d K x,,xj(9 :; ; :2 '
j*3;;DHr2 c * > [ [ TU ] 5 $ rh )r( r r7 r s r0 r7 SSLContext.protocol s %'*++r2 c * > [ [ TU ] 5 $ rh )r= r verify_flagsr s r0 r SSLContext.verify_flags s 57/00r2 c H > [ [ [ ]
R X5 g rh )r r- r r r s r0 r r s
j*2::4Gr2 c T > [ TU ] n [ U5 $ ! [ a Us $ f = frh )r verify_moder@ r r s r0 r SSLContext.verify_mode s1 # e$ $ L s
''c H > [ [ [ ]
R X5 g rh )r r- r r r s r0 r r s
j*199$Fr2 )ro rh )FTTNN)FNN)"rH rI rJ rK re r rM rR r rC rO rU rd rr rw r r) r* r r r propertyr setterr r rL r r r7 r r r[ r& r' s @r0 r- r- s >)OO , -2,0)-26
8=/3
( ( ) K *1)<)< ( { -.. 7
7
O
O
7
7
O
O ( (
^^C C t344 <
<
% + + F
, F
$ $L #I #IJ , , 1 1 H H G Gr2 r- )r r r{ c [ U [ 5 ( d [ U 5 eU [ R :X a" [ [ 5 n[ Ul SUl O/U [ R :X a [ [ 5 nO [ U 5 eU=R [ R [ R - - sl
U( d U( d U( a UR# XU5 O%UR [$ :w a UR' U 5 [) US5 ( aK [* R, R/ S5 nU( a% [0 R2 R4 ( d XTl U$ )zCreate a SSLContext object with default settings.
NOTE: The protocol and settings may change anytime without prior
deprecation. The values represent a fair balance between maximum
compatibility and security.
Tkeylog_filename
SSLKEYLOGFILE) r? r rq r) r* r- PROTOCOL_TLS_CLIENT
CERT_REQUIREDr check_hostnamer+ PROTOCOL_TLS_SERVERr r rL VERIFY_X509_PARTIAL_CHAINVERIFY_X509_STRICTr| CERT_NONEr r r r r
r flagsignore_environmentr )r r r r{ rK
keylogfiles r0 create_default_contextr s g{ + +
'%%% 01 +!% G'' ' 01!! T ; ; ! 4 4 5 6 6%%ff= ) ""7+w)**ZZ^^O4
cii : :&0 # Nr2 F) cert_reqsr r certfilekeyfiler r r{ c [ U[ 5 ( d [ U5 eU[ R :X a
U c [
n O)U[ R :X a
U c [ n O [ U5 e[ U 5 n X)l
Ub Xl U( a SU l
U( a U( d [ S5 eU( d U( a U R XE5 U( d U( d U( a U R XgU5 O%U R [ :w a U R U5 [! U S5 ( aK [" R$ R' S5 n
U
( a% [( R* R, ( d Xl U $ )a Create a SSLContext object for Python stdlib modules
All Python stdlib modules shall use this function to create SSLContext
objects in order to keep common settings in one place. The configuration
is less restrict than create_default_context()'s to increase backward
compatibility.
Tzcertfile must be specifiedr r )r? r rq r) r* r r+ r r r- r r load_cert_chainr| r r r r r r
r r r r ) r7 r r r r r r r r{ rK r s r0 _create_unverified_contextr s g{ + +
'%%% *H G'' ' *H!!"G + '!% x5667 2 6%%ff= ) ""7+w)**ZZ^^O4
cii : :&0 # Nr2 c : \ rS rSrSrS r\ S S j5 r\S 5 r \ R S 5 r \S 5 r \ R S 5 r \S
5 r \S 5 r
\S 5 rS S
jrS rS S jrS rS rS rS rS rS rS rS rS rS rS!S jr S r S r S r g)" SSLObjecti a This class implements an interface on top of a low-level SSL object as
implemented by OpenSSL. This object captures the state of an SSL connection
but does not provide any network IO itself. IO needs to be performed
through separate "BIO" objects which are OpenSSL's IO abstraction layer.
This class does not have a public constructor. Instances are returned by
``SSLContext.wrap_bio``. This class is typically used by framework authors
that want to implement asynchronous IO for SSL through memory buffers.
When compared to ``SSLSocket``, this object lacks the following features:
* Any form of network IO, including methods such as ``recv`` and ``send``.
* The ``do_handshake_on_connect`` and ``suppress_ragged_eofs`` machinery.
c F [ U R R S35 e)NzU does not have a public constructor. Instances are returned by SSLContext.wrap_bio().rq r rH r: r8 r9 s r0 __init__SSLObject.__init__' s+ ~~&&' (L
M
r2 Nc X U R U 5 nUR XUUXuS9nXl U$ )N)rG rJ ownerrL )r _wrap_bio_sslobj) r rS rT rG rJ rL rK r: ri s r0 rN SSLObject._create- s> {{3 "" K + #
r2 c . U R R $ )z(The SSLContext that is currently in use.r rK r s r0 rK SSLObject.context9 ||###r2 c $ XR l g rh r r: ctxs r0 rK r > s " r2 c . U R R $ )z!The SSLSession for client socket.r rL r s r0 rL SSLObject.sessionB r r2 c $ XR l g rh r r: rL s r0 rL r G s & r2 c . U R R $ )z.Was the client session reused during handshaker session_reusedr s r0 r SSLObject.session_reusedK s ||***r2 c . U R R $ )z%Whether this is a server-side socket.)r rG r s r0 rG SSLObject.server_sideP s ||'''r2 c . U R R $ )zVThe currently set server hostname (for SNI), or ``None`` if no
server hostname is set.)r rJ r s r0 rJ SSLObject.server_hostnameU s ||+++r2 c | Ub U R R X5 nU$ U R R U5 nU$ )zRead up to 'len' bytes from the SSL object and return them.
If 'buffer' is provided, read into this buffer and return the number of
bytes read.
)r read)r: r] buffervs r0 r SSLObject.read[ s@ !!#.A !!#&Ar2 c 8 U R R U5 $ )zWrite 'data' to the SSL object and return the number of bytes
written.
The 'data' argument must support the buffer interface.
)r writer: r s r0 r SSLObject.writeg s ||!!$''r2 c 8 U R R U5 $ )zReturns a formatted version of the data in the certificate provided
by the other end of the SSL channel.
Return None if no certificate was provided, {} if a certificate was
provided, but not validated.
)r getpeercertr: binary_forms r0 r SSLObject.getpeercerto s ||'' 44r2 c U R R 5 nUc / $ U Vs/ s H! o"R [ R 5 PM# sn$ s snf )zReturns verified certificate chain provided by the other
end of the SSL channel as a list of DER-encoded bytes.
If certificate verification was disabled method acts the same as
``SSLSocket.get_unverified_chain``.
r get_verified_chain public_bytesrL ENCODING_DERr: chainr s r0 r
SSLObject.get_verified_chainx sG //1 =IAFG!!$"3"34GGG (Ac U R R 5 nUc / $ U Vs/ s H! o"R [ R 5 PM# sn$ s snf )zkReturns raw certificate chain provided by the other
end of the SSL channel as a list of DER-encoded bytes.
r get_unverified_chainr rL r r
s r0 r SSLObject.get_unverified_chain sG 113 =IAFG!!$"3"34GGGr c 8 [ R " S[ SS9 g)zReturn the currently selected NPN protocol as a string, or ``None``
if a next protocol was not negotiated or if NPN is not supported by one
of the peers.rX r rY N)r3 r4 r5 r s r0 selected_npn_protocol SSLObject.selected_npn_protocol s
5
r2 c 6 U R R 5 $ )zReturn the currently selected ALPN protocol as a string, or ``None``
if a next protocol was not negotiated or if ALPN is not supported by one
of the peers.)r selected_alpn_protocolr s r0 r SSLObject.selected_alpn_protocol s ||2244r2 c 6 U R R 5 $ )zWReturn the currently selected cipher as a 3-tuple ``(name,
ssl_version, secret_bits)``.)r cipherr s r0 r SSLObject.cipher s ||""$$r2 c 6 U R R 5 $ )zuReturn a list of ciphers shared by the client during the handshake or
None if this is not a valid server connection.
)r shared_ciphersr s r0 r SSLObject.shared_ciphers s ||**,,r2 c 6 U R R 5 $ )zReturn the current compression algorithm in use, or ``None`` if
compression was not negotiated or not supported by one of the peers.)r compressionr s r0 r" SSLObject.compression s ||''))r2 c 6 U R R 5 $ )z8Return the number of bytes that can be read immediately.)r pendingr s r0 r% SSLObject.pending s ||##%%r2 c 8 U R R 5 g)z Start the SSL/TLS handshake.N)r do_handshaker s r0 r( SSLObject.do_handshake s !!#r2 c 6 U R R 5 $ )z!Start the SSL shutdown handshake.)r shutdownr s r0 unwrapSSLObject.unwrap s ||$$&&r2 c 8 U R R U5 $ )zGet channel binding data for current connection. Raise ValueError
if the requested `cb_type` is not supported. Return bytes of the data
or None if the data is not available (e.g. before the handshake).)r get_channel_bindingr: cb_types r0 r/ SSLObject.get_channel_binding s ||//88r2 c 6 U R R 5 $ )zRReturn a string identifying the protocol version used by the
current SSL channel. r r r s r0 r SSLObject.version s ||##%%r2 c 6 U R R 5 $ rh )r verify_client_post_handshaker s r0 r7 &SSLObject.verify_client_post_handshake s ||88::r2 )r )FNNN NFr ) rH rI rJ rK re r r% rN r rK r rL r rG rJ r r r r
r r r r r r" r% r( r, r/ r r7 r[ rG r2 r0 r r s
5:=A $ $
^^# # $ $
^^' ' + + ( ( , ,
(5 H H
5 %
- *
&$'9 &
;r2 r c X [ [ U R 5 R U l U $ )z*Copy docstring from SSLObject to SSLSocket)getattrr rH re )funcs r0 _sslcopydocr@ s 9dmm4< UR [ [ 5 [ :w a [ S5 eU( a U( a [ S5 eUb [ S5 eUR ( a U( d [ S5 eUR 5 n[ UR UR UR UR 5 S9n U R " U 40 U D6n
[ [ U
]B " S0 U D6 UR# 5 Xjl Xzl SU
l S U
l X*l UR/ U5 U
l X:l XJl U
R7 5 Sn U
RM U5 Xl' U ( al U
R$ RQ XU
R0 XR& S 9U
l U( a1 U
R 5 nUS :X a [ S
5 eU
RS 5 U
$ ! [8 a n U R: [: R< :w a e Sn U
R? 5 n
U
RA S5 U
RC S5 nOH! [8 a; n U R: [: R< [: RD 4; a e S n S n A OS n A ff = fU
RA U
5 U( a0 S
n[G W R: U5 nUUl$ S Ul% Ue! S nf = f S n A GNS n A ff = f! U
RU 5 e ! [8 a e f = f= f)Nz!only stream sockets are supportedz4server_hostname can only be specified in client modez,session can only be specified in client modez'check_hostname requires server_hostname)familytypeprotofilenoFTr r2 z5Closed before TLS handshake with data in recv buffer.r rL zHdo_handshake_on_connect should not be specified for non-blocking socketsrG )+
getsockoptr r r NotImplementedErrorr r
gettimeoutdictrF rG rH rI r r rB r detach_context_session_closedr rG rC rJ rH rI getpeernamer errnoENOTCONN getblocking setblockingrecvEINVALr reasonlibrary
settimeout
_connected _wrap_socketr( close)r rF rG rH rI rJ rK rL sock_timeoutr9 r: connectedeblockingnotconn_pre_handshake_datar[ notconn_pre_handshake_data_errortimeoutr s r0 rN SSLSocket._create s ??:w /; >%&IJ J "2 3 3" "/ 0 0 ! !/ FG G( ;;TYYdjj;;=
{{3)&)
i'1&1
C #M #M DL DL * #*#;#;O#LD +B ((< %#
! "D ! OOL ) 'O #}} 9 9t';';
: + "oo /G #~ ()s tt%%' o
@77enn, ! ++- '
5
261 . 5wwu~~u||&DD 14. 5
*- UF7?7P4>D4;?C4<@ >> <@8 .%
@b
s 9AK <G B K
K$AK'H98K9
I>1I94K9I>>AK KKK K KK K;K+*K;+
K85K;7K88K;c U R $ rh )rQ r s r0 rK SSLSocket.context= s }} r2 c 0 Xl XR l g rh )rQ r rK r s r0 rK rj B s
" r2 c J U R b U R R $ g rh r r s r0 rL SSLSocket.sessionG s# << #<<'' ' $r2 c L Xl U R b XR l g g rh )rR r rL r s r0 rL rm M s
<< ##*LL $r2 c J U R b U R R $ g rh r r s r0 r SSLSocket.session_reusedS s# << #<<.. . $r2 c F [ SU R R - 5 e)NzCan't dup() %s instances)rM r rH r s r0 dup
SSLSocket.dupY s$ !"<"&.."9"9#: ; ;r2 c g rh rG )r: msgs r0 _checkClosedSSLSocket._checkClosed] s r2 c H U R ( d U R 5 g g rh )r^ rT r s r0 _check_connectedSSLSocket._check_connecteda s
r2 c V U R 5 U R c [ S5 e Ub U R R X5 $ U R R U5 $ ! [ a; nUR
S [ :X a U R ( a
Ub SnAg SnAge SnAff = f)zGRead up to LEN bytes and return them.
Return zero-length string on EOF.Nz'Read on closed or unwrapped SSL socket.r r2 )rv r r r r r8
SSL_ERROR_EOFrI )r: r] r xs r0 r SSLSocket.readi s
<< FG G !||((55||((-- vvayM)d.G.G% s# A# A# #
B(-+B#"B##B(c U R 5 U R c [ S5 eU R R U5 $ )z`Write DATA to the underlying SSL channel. Returns
number of bytes of DATA actually transmitted.z(Write on closed or unwrapped SSL socket.)rv r r r r s r0 r SSLSocket.write~ s;
<< GH H||!!$''r2 c x U R 5 U R 5 U R R U5 $ rh )rv ry r r r s r0 r SSLSocket.getpeercert s/ ||'' 44r2 c U R R 5 nUc / $ U Vs/ s H! o"R [ R 5 PM# sn$ s snf rh r r
s r0 r
SSLSocket.get_verified_chain sE //1 =IAFG!!$"3"34GGGr c U R R 5 nUc / $ U Vs/ s H! o"R [ R 5 PM# sn$ s snf rh r r
s r0 r SSLSocket.get_unverified_chain sE 113 =IAFG!!$"3"34GGGr c X U R 5 [ R " S[ SS9 g )NrX r rY )rv r3 r4 r5 r s r0 r SSLSocket.selected_npn_protocol s(
5
r2 c U R 5 U R b [ R ( d g U R R 5 $ rh )rv r rL r r r s r0 r SSLSocket.selected_alpn_protocol s4 << t}}<<668 8r2 c r U R 5 U R c g U R R 5 $ rh )rv r r r s r0 r SSLSocket.cipher s. << <<&&( (r2 c r U R 5 U R c g U R R 5 $ rh )rv r r r s r0 r SSLSocket.shared_ciphers s. << <<..0 0r2 c r U R 5 U R c g U R R 5 $ rh )rv r r" r s r0 r" SSLSocket.compression s. << <<++- -r2 c > U R 5 U R b9 US:w a [ SU R - 5 eU R R U5 $ [
TU ] X5 $ )Nr z3non-zero flags not allowed in calls to send() on %s)rv r r r r r send)r: r r r s r0 r SSLSocket.send sb << #z INN#$ $ <<%%d+ +7<, ,r2 c > U R 5 U R b [ SU R - 5 eUc [ TU ] X5 $ [ TU ] XU5 $ )Nz%sendto not allowed on instances of %s)rv r r r r sendto)r: r
flags_or_addrr r s r0 r SSLSocket.sendto sZ << # D !^^ , -
-
\7>$6 67>$t< U R 5 U R b| US:w a [ SU R - 5 eSn[ U5 oDR S5 n[
U5 nX6: a U R XSS 5 nX7-
nX6: a M S S S 5 S S S 5 g [ TU ]% X5 $ ! , ( d f N&= f! , ( d f g = f)Nr z6non-zero flags not allowed in calls to sendall() on %sB)
rv r r r
memoryviewcastr] r r sendall) r: r r r view byte_viewamountr r s r0 r SSLSocket.sendall s << #z LNN#$ $ ED!T99S>Y Y n )F"34AJE n ,:!! 7?4/ /
,:>!!s$
B;-B*
B;*
B8 4B;;
C c b > U R b U R XU5 $ [ TU ]
XU5 $ )zuSend a file, possibly by using os.sendfile() if this is a
clear-text socket. Return the total number of bytes sent.
)r _sendfile_use_sendr sendfile)r: fileoffsetr r s r0 r SSLSocket.sendfile s6 << #**4? ? 7#D%8 8r2 c > U R 5 U R b/ US:w a [ SU R - 5 eU R U5 $ [
TU ] X5 $ )Nr z3non-zero flags not allowed in calls to recv() on %s)rv r r r r r rY r: buflenr r s r0 rY SSLSocket.recv s\ << #z INN#$ $ 99V$ $7<. .r2 c B > U R 5 Uc/ Ub* [ U5 nUR nS S S 5 U( d SnOSnU R b/ US:w a [ SU R
- 5 eU R
X!5 $ [ TU ]! XU5 $ ! , ( d f Nf= f)Nr: r z8non-zero flags not allowed in calls to recv_into() on %s) rv r nbytesr r r r r recv_into)r: r r r r r s r0 r SSLSocket.recv_into s >! '4 ![[F ( !F << #z L..!" " 99V, ,7$VU; ; ('s
B
B c > U R 5 U R b [ SU R - 5 e[ TU ] X5 $ )Nz'recvfrom not allowed on instances of %s)rv r r r r recvfromr s r0 r SSLSocket.recvfrom sG << # F !^^ , -
- 7#F2 2r2 c > U R 5 U R b [ SU R - 5 e[ TU ] XU5 $ )Nz,recvfrom_into not allowed on instances of %s)rv r r r r
recvfrom_into)r: r r r r s r0 r SSLSocket.recvfrom_into$ sI << # K !^^ , -
- 7(? ?r2 c 2 [ SU R - 5 e)Nz&recvmsg not allowed on instances of %sr r s r0 recvmsgSSLSocket.recvmsg, s !"J"&..#1 2 2r2 c 2 [ SU R - 5 e)Nz+recvmsg_into not allowed on instances of %sr r s r0 recvmsg_intoSSLSocket.recvmsg_into0 s ! #')- #8 9 9r2 c r U R 5 U R b U R R 5 $ gNr )rv r r% r s r0 r% SSLSocket.pending4 s. << #<<'') )r2 c R > U R 5 S U l [ TU ]
U5 g rh )rv r r r+ )r: howr s r0 r+ SSLSocket.shutdown< s#
r2 c U R ( a# U R R 5 nS U l U$ [ S[ U 5 - 5 eNzNo SSL wrapper around )r r+ r r@ )r: ss r0 r, SSLSocket.unwrapA s< << %%'A DLH 5D AB Br2 c U R ( a U R R 5 $ [ S[ U 5 - 5 er )r r7 r r@ r s r0 r7 &SSLSocket.verify_client_post_handshakeJ s1 <<<<<<> > 5D AB Br2 c 0 > S U l [ TU ] 5 g rh )r r _real_closer s r0 r SSLSocket._real_closeQ s
r2 c U R 5 U R 5 n US:X a U( a U R S 5 U R R 5 U R U5 g ! U R U5 f = f)NrK )ry rN r] r r( )r: blockrg s r0 r( SSLSocket.do_handshakeU s] //# %#~%% LL % % ' OOG $DOOG $s 8A, ,A?c > U R ( a [ S5 eU R ( d
U R b [ S5 eU R R U SU R X R S9U l U( a [ TU ]% U5 nOS n[ TU ]) U5 U( d( SU l U R ( a U R 5 U$ ! [ [ 4 a S U l e f = f)Nz!can't connect in server-side modez/attempt to connect already-connected SSLSocket!FrJ T)rG r r^ r rK r_ rJ rR r
connect_exconnectrH r( r )r: r r rcr s r0
_real_connectSSLSocket._real_connect` s @A A ??dll 6 NO O||00 %--
1
W'-%"&//%%'I$ DL s
=AC C/c ( U R US5 g)IConnects to remote ADDR, and then wraps the connection in
an SSL channel.FNr r: r s r0 r SSLSocket.connectz s
4'r2 c & U R US5 $ )r Tr r s r0 r SSLSocket.connect_ex s !!$--r2 c > [ TU ] 5 u pU R R UU R U R
SS9nX4$ )zAccepts a new connection from a remote client, and returns
a tuple containing that new connection wrapped with a server-side
SSL channel, and the address of the remote client.T)rH rI rG )r acceptrK rO rH rI )r: newsockr r s r0 r SSLSocket.accept sM
(
,,**7,0,H,H)-)B)B $ + & } r2 c U R b U R R U5 $ U[ ; a [ SR U5 5 eg )Nz({0} channel binding type not implemented)r r/ CHANNEL_BINDING_TYPESr r r0 s r0 r/ SSLSocket.get_channel_binding sJ << #<<33G< < 33 >EEgN r2 c R U R b U R R 5 $ g rh r4 r s r0 r SSLSocket.version s" << #<<'') )r2 ) rS r^ rQ rR r rH rJ rG rI )FTTNNNrh r9 r; )r )r N)r: r r r< )4rH rI rJ rK re r r% rN r r@ rK r rL r rr rv ry r r r r
r r r r r r" r r r r r rY r r r r r r% r+ r, r7 r r( r r r r r/ r r[ r& r' s @r0 rB rB s@ ;
FJ;?&*\ \|
^^# # ( (
^^+ +
/ /;
*( 5 5
H H H H 9 9 ) ) 1 1 . . -=2 0 9 /<&3@29
C C C C % %4(
.
r2 rB c SSK Jn SSKJn SnSn UR U SS R 5 5 S- nU" U SS U5 nU" US U4US S
- 5 $ ! [ a [
S U < S U< S
35 ef = f)aq Return the time in seconds since the Epoch, given the timestring
representing the "notBefore" or "notAfter" date from a certificate
in ``"%b %d %H:%M:%S %Y %Z"`` strptime format (C locale).
"notBefore" or "notAfter" dates must use UTC (RFC 5280).
Month is one of: Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
UTC should be specified as GMT (see ASN1_TIME_print())
r )strptime)timegm) JanFebMarAprMayJunJulAugSepOctNovDecz %d %H:%M:%S %Y GMTNr r r r z
time data z does not match format "%b")timer calendarr indextitler ) cert_timer r months time_format month_numbertts r0 cert_time_to_secondsr s F (K
7 ||IbqM$7$7$9:Q> im[
1 r!ul+b1g566 F-6 E F FFs %A A5z-----BEGIN CERTIFICATE-----z-----END CERTIFICATE-----c
[ [ R " U 5 SS5 n[ /nU[ S[ U5 S5 Vs/ s H o1X3S- PM sn-
nUR
[ S- 5 SR U5 $ s snf )zWTakes a certificate in binary DER format and returns the
PEM version of it as a string.ASCIIstrictr @
) r@ base64standard_b64encode
PEM_HEADERranger] r^
PEM_FOOTERjoin)der_cert_bytesfssis r0 DER_cert_to_PEM_certr sv F % %n 5wIA
BeAs1vr 2
3 2Qt9 2
33BIIj4 99R= 4s B c v U R [ 5 ( d [ S[ - 5 eU R 5 R [
5 ( d [ S[
- 5 eU R 5 [
[ 5 [
[
5 * n[ R " UR SS5 5 $ )zdTakes a certificate in ASCII PEM format and returns the
DER-encoded version of it as a byte sequencez(Invalid PEM encoding; must start with %sz&Invalid PEM encoding; must end with %sr r )
r- r r stripendswithr
r] r decodebytesrA )pem_cert_stringds r0 PEM_cert_to_DER_certr s % %j 1 1C%& ' ' " + +J 7 7A%& ' ' JZ 0@AA ahhw 9 ::r2 c U u pEUb [ nO[ n[ UUUS9n[ XS9 nUR XS9 n U R S5 n
SSS5 SSS5 [
W
5 $ ! , ( d f N!= f! , ( d f N*= f)a) Retrieve the certificate from the server at the specified address,
and return it as a PEM-encoded string.
If 'ca_certs' is specified, validate the server cert against it.
If 'ssl_version' is specified, use it in the connection attempt.
If 'timeout' is specified, use it in the connection attempt.
N)r r )rg )rJ T)r r _create_stdlib_contextr rO r r ) r ssl_versionca_certsrg hostportr rK rF sslsockdercerts r0 get_server_certificater s JD! $[/8,46G
4 1T
< ))$/G =
2 (( =
<
2 1s" A7A& A7&
A4 0A77
Bc . [ R U S5 $ )Nz )_PROTOCOL_NAMESr
)
protocol_codes r0 get_protocol_namer$ s }k ::r2 rh )nre r r collectionsr enumr _Enumr _IntEnumr _IntFlagr rL r r r
r r r
r r r r r r r r r r r r r r r ImportErrorr r r r r r r! r" r# r$ r% r& r' _convert_rH r( r6 r+ __members__itemsr" r> _SSLv2_IF_EXISTSrE r] rm r r r r r r r r r r r r rU r3 r socket_errorr r HAS_NEVER_CHECK_COMMON_NAME_RESTRICTED_SERVER_CIPHERSr r r r r r r r) r- r* r r r _create_default_https_contextr r r@ rB rM rR r r r
r r r r r$ )r/ r s 00r0 r3 sV Xt " H H N N 3 3 : 2 2 8 (K
x'
6
h.
8+
()
0:/F/F F*,2<2H2H2N2N2PQ2P;45;2PQ:'7> h5 5 5 h h&" &" &"R h : <<71 9 9 ? ?
% %d,J K . + .>b DF 4 & @*],HI @*&k5 &AG AGH $+#6#6 .$"&t.`49*/9L9L$($"&tD4n !7 4 q; q;h N Nd '
&
7< +
(
; .A$(2I),;Q, T Rs J .J* J'&J'