h f + @ s d Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l m Z d d l
Z
d d l
m Z m Z m
Z
d d l
m Z d d l
m Z m Z m Z m Z m Z m Z d d l
m Z m Z m Z d d l
m Z m Z d d
l
m Z m Z m Z m Z y d d l
m Z Wn e! k
r8Yn Xd d
Z" e" d e" d e" d e" d e" d d d l
m# Z# m$ Z$ m% Z% d d l
m& Z& e' e
d e( d d$ Z? Gd% d& d& e@ ZA d' d( d) ZB d* d+ ZC e d, d- ZD d. d/ ZE Gd0 d1 d1 e d1 d2 ZF Gd3 d4 d4 eF e ZG Gd5 d6 d6 e ZH eG jI d7 d d8 d d9 d d: d; ZJ eK d< d d= d> d? eG jI d@ d dA d d7 d d8 d d9 d dB dC ZL eJ ZM eL ZN GdD dE dE e2 ZO d d d> e eK d dF dF d dG dH ZP dI dJ ZQ dK ZR dL ZS dM dN ZT dO dP ZU eK d dQ dR ZV dS dT ZW d S)Ua
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())
fetch_server_certificate (HOST, PORT) -- fetch the certificate provided
by the server running on HOST at port PORT. No
validation of the certificate is performed.
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_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)Enum)OPENSSL_VERSION_NUMBEROPENSSL_VERSION_INFOOPENSSL_VERSION) _SSLContext)SSLErrorSSLZeroReturnErrorSSLWantReadErrorSSLWantWriteErrorSSLSyscallError SSLEOFError) CERT_NONE
CERT_OPTIONAL
CERT_REQUIRED)txt2objnid2obj) RAND_statusRAND_add
RAND_bytesRAND_pseudo_bytes)RAND_egdc C sC x< t t D]. } | j | r
t t | t | s r+ )PROTOCOL_SSLv2ZSSLv2)PROTOCOL_TLSv1_1PROTOCOL_TLSv1_2zTLSv1.1zTLSv1.2win32)enum_certificates enum_crls)socketAF_INET SOCK_STREAMcreate_connection)
SOL_SOCKETSO_TYPEz
tls-uniquezECDH+AESGCM:ECDH+CHACHA20:DH+AESGCM:DH+CHACHA20:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+HIGH:DH+HIGH:RSA+AESGCM:RSA+AES:RSA+HIGH:!aNULL:!eNULL:!MD5:!3DESzECDH+AESGCM:ECDH+CHACHA20:DH+AESGCM:DH+CHACHA20:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+HIGH:DH+HIGH:RSA+AESGCM:RSA+AES:RSA+HIGH:!aNULL:!eNULL:!MD5:!DSS:!RC4:!3DESc @ s e Z d Z d S)CertificateErrorN)__name__
__module__ __qualname__r r r r r8 s r8 c C sD g } | s d S| j d ^ } } | j d } | | k rY t d t | n | su | j | j k S| d k r | j d nY | j d s | j d r | j t j | n" | j t j | j d d x$ | D] } | j t j | q Wt j
d d
j | d t j } | j
| S) zhMatching according to RFC 6125, section 6.4.3
http://tools.ietf.org/html/rfc6125#section-6.4.3
F.*z,too many wildcards in certificate DNS name: z[^.]+zxn--z\*z[^.]*z\Az\.z\Z)splitcountr8 reprlowerappendr reescapereplacecompilejoin
IGNORECASEmatch) ZdnhostnameZ
max_wildcardsZpatsZleftmostZ remainderZ wildcardsZfragZpatr r r _dnsname_match s& "
&rL c C s[ | s t d n g } | j d f } xC | D]; \ } } | d k r4 t | | r_ d S| j | q4 q4 W| s xc | j d f D]L } xC | D]; \ } } | d k r t | | r d S| j | q q Wq Wn t | d k r t d | d j t t | f n; t | d k rKt d
| | d f n t d d S)
a) Verify that *cert* (in decoded format as returned by
SSLSocket.getpeercert()) matches the *hostname*. RFC 2818 and RFC 6125
rules are followed, but IP addresses are not accepted for *hostname*.
CertificateError is raised on failure. On success, the function
returns nothing.
ztempty or no certificate, match_hostname needs a SSL socket or SSL context with either CERT_OPTIONAL or CERT_REQUIREDZsubjectAltNameZDNSNZsubjectZ
commonNamer< z&hostname %r doesn't match either of %sz, z hostname %r doesn't match %rr z=no appropriate commonName or subjectAltName fields were found)
ValueErrorgetrL rC lenr8 rH maprA )certrK ZdnsnamesZsankeyr* subr r r match_hostname s. %rT DefaultVerifyPathszQcafile capath openssl_cafile_env openssl_cafile openssl_capath_env openssl_capathc C s t j } t j j | d | d } t j j | d | d } t t j j | ra | n d t j j | r| | n d | S)z/Return paths to default cafile and capath.
r r< N) r get_default_verify_pathsosenvironrN rU pathisfileisdir)partscafilecapathr r r rX 0 s rX c s^ e Z d Z d Z f Z f d d Z e f d d Z e f d d Z S) _ASN1Objectz#ASN.1 object identifier lookup
c s t j | t | d d S)Nr) F)super__new___txt2obj)clsoid) __class__r r rc C s z_ASN1Object.__new__c s t j | t | S)z3Create _ASN1Object from OpenSSL numeric ID
)rb rc _nid2obj)re Znid)rg r r fromnidF s z_ASN1Object.fromnidc s t j | t | d d S)z=Create _ASN1Object from short name, long name or OID
r) T)rb rc rd )re r) )rg r r fromnameL s z_ASN1Object.fromname) r9 r: r; __doc__ __slots__rc classmethodri rj r r )rg r ra > s
ra znid shortname longname oidc @ s" e Z d Z d Z d Z d Z d S)PurposezDSSLContext purpose flags with X509v3 Extended Key Usage objects
z1.3.6.1.5.5.7.3.1z1.3.6.1.5.5.7.3.2N)r9 r: r; rk SERVER_AUTH CLIENT_AUTHr r r r rn S s rn c @ s e Z d Z d Z d Z d Z e d d Z e d d Z d
d d d d
d Z d d Z
d d Z e j
d d Z d S)
SSLContextz|An SSLContext holds various SSL-related configuration options and
data, such as certificates and possibly a private key.protocol __weakref__CAROOTc O s2 t j | | } | t k r. | j t n | S)N)r rc _SSLv2_IF_EXISTS set_ciphers_DEFAULT_CIPHERS)re rr argskwargsselfr r r rc a s zSSLContext.__new__c C s
| | _ d S)N)rr )r{ rr r r r __init__g s zSSLContext.__init__FTNc
C s+ t d | d | d | d | d | d | S)Nsock server_sidedo_handshake_on_connectsuppress_ragged_eofsserver_hostname_context) SSLSocket)r{ r} r~ r r r r r r wrap_socketj s
zSSLContext.wrap_socketc C s t } xp | D]h } t | d } t | d k sI t | d k rX t d n | j t | | j | q W| j | d S)Nasciir z(NPN protocols must be 1 to 255 in length) bytearraybytesrO r rC extendZ_set_npn_protocols)r{
npn_protocolsZprotosrr br r r set_npn_protocolst s
$z SSLContext.set_npn_protocolsc C sw t } xW t | D]I \ } } } | d k r | d k sL | j | k r_ | j | q_ q q W| j d | | S)NZx509_asnTcadata)r r0 rf r load_verify_locations)r{ storenamepurposeZcertsrQ encodingZtrustr r r _load_windows_store_certs s z$SSLContext._load_windows_store_certsc C sb t | t s t | n t j d k rT x$ | j D] } | j | | q7 Wn | j d S)Nr/ )
isinstancera TypeErrorsysplatform_windows_cert_storesr Zset_default_verify_paths)r{ r r r r r load_default_certs s z SSLContext.load_default_certs)zprotocolz __weakref__)rt ru )r9 r: r; rk rl r r' rc r| r r r rn ro r r r r r rq Z s
rq r_ r` r c C sB t | t s t | n t t } | j t O_ | j t O_ | j t t d d O_ | t
j k r t | _
d | _ np | t
j k r | j t t d d O_ | j t t d d O_ | j t t d d O_ | j t n | s | s | r | j | | | n | j
t k r>| j | n | S)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.
ZOP_NO_COMPRESSIONr TZOP_CIPHER_SERVER_PREFERENCEZOP_SINGLE_DH_USEZOP_SINGLE_ECDH_USE)r ra r rq r' options OP_NO_SSLv2 OP_NO_SSLv3r r rn ro r verify_modecheck_hostnamerp rw _RESTRICTED_SERVER_CIPHERSr r r )r r_ r` r contextr r r create_default_context s& r cert_reqsr Fr certfilekeyfilec
C s t | t s t | n t | } | j t O_ | j t O_ | d k r` | | _ n | | _ | r | r t d n | s | r | j
| | n | s | s | r | j | | | n | j t k r | j
| n | S)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.
Nzcertfile must be specified)r ra r rq r r r r r rM load_cert_chainr r r )
rr r r r r r r_ r` r r r r r _create_unverified_context s"
r c @ s e Z d Z d Z d d d d e e d d e e d d d d d d d d d Z e d d Z
e
j d
d Z
d d Z d d
d Z
d d Z d d d d Z d d Z d d d Z d d Z d d Z d d Z d d d Z d d d Z d! d" Z d d# d$ Z d% d d& d' Z d d d( d) Z d% d d* d+ Z d d d, d- Z d. d/ Z d0 d1 Z d2 d3 Z d4 d5 Z d6 d7 Z! d8 d9 Z" d d: d; Z# d< d= Z$ d> d? Z% d@ dA Z& dB dC Z' dD dE dF Z( d S)Gr zThis class implements a subtype of socket.socket that wraps
the underlying OS socket in an SSL context when necessary, and
provides read and write methods over that channel.NFTr c C sD | r | | _ n| r. | r. t d n | rJ | rJ t d n | r` | r` | } n t | | _ | | j _ | r | j j | n | r | j j | | n | r | j j | n | r | j j | n | | _ | | _ | | _
| | _ | | _ | | _
| j t t t k r?t d n | rZ| rZt d n | j j r|| r|t d n | | _ | | _ | | _ |
| _ | d k r t j | d | j d | j d | j d | j | j | j | j nA | d k r"t j | d | n t j | d | d |
d | y | j! WnC t" k
r} z# | j# t# j$ k r| n d
} WYd d } ~ Xn Xd } d
| _% d | _& | | _' | r@yY | j j( | | | | _& | r| j } | d k rt d
n | j) n Wq@t" t f k
r<| j* Yq@Xn d S)Nz5certfile must be specified for server-side operationszcertfile must be specifiedz!only stream sockets are supportedz4server_hostname can only be specified in client modez'check_hostname requires server_hostnamefamilytypeprotofilenoFTg zHdo_handshake_on_connect should not be specified for non-blocking sockets)+r rM rq r r r r rw r r r ssl_versionca_certsciphersZ
getsockoptr6 r7 r4 NotImplementedErrorr r~ r r r r2 r| r r r r
settimeout
gettimeoutdetach getpeernameOSErrorerrnoZENOTCONNZ_closed_sslobj
_connected _wrap_socket do_handshakeclose)r{ r} r r r~ r r r r r r r r r r r r r eZ connectedtimeoutr r r r| s
zSSLSocket.__init__c C s | j S)N)r )r{ r r r r R s zSSLSocket.contextc C s | | _ | | j _ d S)N)r r r )r{ Zctxr r r r V s c C s t d | j j d S)NzCan't dup() %s instances)NotImplementedrg r9 )r{ r r r dup[ s z
SSLSocket.dupc C s d S)Nr )r{ msgr r r _checkClosed_ s zSSLSocket._checkClosedc C s | j s | j n d S)N)r r )r{ r r r _check_connectedc s zSSLSocket._check_connectedc C s | j | j s" t d n yD | d k rI | j j | | } n | j j | p[ d } | SWn[ t k
r } z; | j d t k r | j r | d k r d Sd Sn WYd d } ~ Xn Xd S)zORead up to LEN bytes and return them.
Return zero-length string on EOF.z'Read on closed or unwrapped SSL socket.Ni r )r r rM readr ry Z
SSL_ERROR_EOFr )r{ rO buffervxr r r r k s
zSSLSocket.readc C s2 | j | j s" t d n | j j | S)zhWrite DATA to the underlying SSL channel. Returns
number of bytes of DATA actually transmitted.z(Write on closed or unwrapped SSL socket.)r r rM write)r{ datar r r r s
zSSLSocket.writec C s$ | j | j | j j | S)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 r r Zpeer_certificate)r{ Z binary_formr r r getpeercert s
zSSLSocket.getpeercertc C s3 | j | j s t j r" d S| j j Sd S)N)r r r r% selected_npn_protocol)r{ r r r r s
z SSLSocket.selected_npn_protocolc C s( | j | j s d S| j j Sd S)N)r r cipher)r{ r r r r s
zSSLSocket.cipherc C s( | j | j s d S| j j Sd S)N)r r compression)r{ r r r r s
zSSLSocket.compressionc C s | j | j r | d k r5 t d | j n y | j j | } WnV t k
r } z6 | j d t k rw d S| j d t k r d S WYd d } ~ Xq X| Sn t j
| | | Sd S)Nr z3non-zero flags not allowed in calls to send() on %s) r r rM rg r r ry ZSSL_ERROR_WANT_READZSSL_ERROR_WANT_WRITEr2 send)r{ r flagsr r r r r r s
zSSLSocket.sendc C sb | j | j r) t d | j n5 | d k rH t j | | | St j | | | | Sd S)Nz%sendto not allowed on instances of %s)r r rM rg r2 sendto)r{ r Z
flags_or_addraddrr r r r s
zSSLSocket.sendtoc O s t d | j d S)Nz&sendmsg not allowed on instances of %s)r rg )r{ ry rz r r r sendmsg s zSSLSocket.sendmsgc C s | j | j r | d k r5 t d | j n t | } d } x3 | | k r| | j | | d } | | 7} qJ W| St j | | | Sd S)Nr z6non-zero flags not allowed in calls to sendall() on %s)r r rM rg rO r r2 sendall)r{ r r Zamountr@ r r r r r s
zSSLSocket.sendalli c C sY | j | j rB | d k r5 t d | j n | j | St j | | | Sd S)Nr z3non-zero flags not allowed in calls to recv() on %s)r r rM rg r r2 recv)r{ buflenr r r r r s
zSSLSocket.recvc C s | j | r+ | d k r+ t | } n | d k r@ d } n | j r{ | d k rk t d | j n | j | | St j | | | | Sd S)Ni r z8non-zero flags not allowed in calls to recv_into() on %s)r rO r rM rg r r2 recv_into)r{ r nbytesr r r r r s
zSSLSocket.recv_intoc C s@ | j | j r) t d | j n t j | | | Sd S)Nz'recvfrom not allowed on instances of %s)r r rM rg r2 recvfrom)r{ r r r r r r s
zSSLSocket.recvfromc C sC | j | j r) t d | j n t j | | | | Sd S)Nz,recvfrom_into not allowed on instances of %s)r r rM rg r2
recvfrom_into)r{ r r r r r r r s
zSSLSocket.recvfrom_intoc O s t d | j d S)Nz&recvmsg not allowed on instances of %s)r rg )r{ ry rz r r r recvmsg s zSSLSocket.recvmsgc O s t d | j d S)Nz+recvmsg_into not allowed on instances of %s)r rg )r{ ry rz r r r recvmsg_into s zSSLSocket.recvmsg_intoc C s( | j | j r | j j Sd Sd S)Nr )r r pending)r{ r r r r s
zSSLSocket.pendingc C s' | j d | _ t j | | d S)N)r r r2 shutdown)r{ Zhowr r r r s
zSSLSocket.shutdownc C s? | j r% | j j } d | _ | St d t | d S)NzNo SSL wrapper around )r r rM str)r{ sr r r unwrap s
zSSLSocket.unwrapc C s d | _ t j | d S)N)r r2 _real_close)r{ r r r r $ s zSSLSocket._real_closec C s | j | j } z3 | d k r; | r; | j d n | j j Wd | j | X| j j r | j s~ t d n t | j
| j n d S)z Perform a TLS/SSL handshake.g Nz-check_hostname needs server_hostname argument) r r r r r r r r rM rT r )r{ blockr r r r r ( s
zSSLSocket.do_handshakec C s | j r t d n | j r0 t d n | j j | d | j | _ ya | rl t j | | } n d } t j | | | s d | _ | j
r | j q n | SWn$ t t f k
r d | _ Yn Xd S)Nz!can't connect in server-side modez/attempt to connect already-connected SSLSocket!FT)
r~ rM r r r r r r2
connect_exconnectr r r )r{ r r rcr r r
_real_connect9 s$ zSSLSocket._real_connectc C s | j | d d S)zQConnects to remote ADDR, and then wraps the connection in
an SSL channel.FN)r )r{ r r r r r P s zSSLSocket.connectc C s | j | d S)zQConnects to remote ADDR, and then wraps the connection in
an SSL channel.T)r )r{ r r r r r U s zSSLSocket.connect_exc C sI t j | \ } } | j j | d | j d | j d d } | | f S)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.r r r~ T)r2 acceptr r r r )r{ Znewsockr r r r r Z s zSSLSocket.acceptz
tls-uniquec C s_ | t k r t d n | d k r? t d j | n | j d k rR d S| j j S)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).
z Unsupported channel binding typez
tls-uniquez({0} channel binding type not implementedN)CHANNEL_BINDING_TYPESrM r formatr Z
tls_unique_cb)r{ Zcb_typer r r get_channel_bindingf s z SSLSocket.get_channel_binding))r9 r: r; rk r r' r3 r4 r| propertyr setterr r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r sP S
r Tc
C sC t d | d | d | d | d | d | d | d | d | d
|
S) Nr} r r r~ r r r r r r )r )
r} r r r~ r r r r r r r r r r v s r c C s% d d l } | j | j | d S)zTakes a date-time string in standard ASN1_print form
("MON DAY 24HOUR:MINUTE:SEC YEAR TIMEZONE") and return
a Python time value in seconds past the epoch.r Nz%b %d %H:%M:%S %Y GMT)timeZmktimeZstrptime)Z cert_timer r r r cert_time_to_seconds s r z-----BEGIN CERTIFICATE-----z-----END CERTIFICATE-----c C s? t t j | d d } t d t j | d d t d S)z[Takes a certificate in binary DER format and returns the
PEM version of it as a string.ASCIIstrict
@ )r base64Zstandard_b64encode
PEM_HEADERtextwrapZfill
PEM_FOOTER)Zder_cert_bytesfr r r DER_cert_to_PEM_cert s r c C s | j t s" t d t n | j j t sJ t d t n | j t t t t } t j | j d d S)zhTakes 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 rM stripendswithr rO r Z decodebytesencode)Zpem_cert_stringdr r r PEM_cert_to_DER_cert s
#r c
C s | \ } } | d k r! t } n t } t | d | d | } t | . } | j | } | j d } Wd QXWd QXt | S)zRetrieve 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.Nr r_ T)r r _create_stdlib_contextr5 r r r )
r r r hostZportr r r} ZsslsockZdercertr r r get_server_certificate s r c C s t j | d S)Nz )_PROTOCOL_NAMESrN )Z
protocol_coder r r get_protocol_name s r )Xrk r rD r rY collectionsr Zenumr Z_Enumr r r r r r r r
r r r
r r r r rd r rh r r r r r ImportErrorr! r# r$ r% r& r r itemsr r, rv r- r. r r0 r1 r2 r3 r4 r5 r6 r7 r r r Z socket_errorZHAS_TLS_UNIQUEr rx r rM r8 rL rT rU rX ra rn rq ro r r' r Z _create_default_https_contextr r r r r r r r r r r r r r Y s . "
" 1 + 8/ '