U


W[l�
@s|
dZd
dl
mZmZ
d
dlmZmZmZ
d
dlmZm	Z	m
Z

ze
e	e�
d�
Wn8ek
r�
Z
ze
e�
dkrn�ed�
�
W5dZ[XYnXd
dlmZmZmZ
d
d	lmZ
d
d
lmZ
d
dlmZmZmZmZmZmZmZmZ
d
dl m!Z!
d
d
l"m#Z#
d
dl$m%Z%
d
dl&m'Z'
d
dl(m)Z)m*Z*
ee�
Gdd�de+��
Z,eee�Gdd�de)��
Z-eee�Gdd�de+��
Z.Gdd�de*�Z/dS)a�
Implementation of a TLS transport (L{ISSLTransport}) as an
L{IProtocol<twisted.internet.interfaces.IProtocol>} layered on top of any
L{ITransport<twisted.internet.interfaces.ITransport>} implementation, based on
U{OpenSSL<http://www.openssl.org>}'s memory BIO features.

L{TLSMemoryBIOFactory} is a L{WrappingFactory} which wraps protocols created by
the factory it wraps with L{TLSMemoryBIOProtocol}.  L{TLSMemoryBIOProtocol}
intercedes between the underlying transport and the wrapped protocol to
implement SSL and TLS.  Typical usage of this module looks like this::

    from twisted.protocols.tls import TLSMemoryBIOFactory
    from twisted.internet.protocol import ServerFactory
    from twisted.internet.ssl import PrivateCertificate
    from twisted.internet import reactor

    from someapplication import ApplicationProtocol

    serverFactory = ServerFactory()
    serverFactory.protocol = ApplicationProtocol
    certificate = PrivateCertificate.loadPEM(certPEMData)
    contextFactory = certificate.options()
    tlsFactory = TLSMemoryBIOFactory(contextFactory, False, serverFactory)
    reactor.listenTCP(12345, tlsFactory)
    reactor.run()

This API offers somewhat more flexibility than
L{twisted.internet.interfaces.IReactorSSL}; for example, a
L{TLSMemoryBIOProtocol} instance can use another instance of
L{TLSMemoryBIOProtocol} as its transport, yielding TLS over TLS - useful to
implement onion routing.  It can also be used to run TLS over unusual
transports, such as UNIX sockets and stdio.
�)�division�absolute_import)�Error�ZeroReturnError�
WantReadError)�TLSv1_METHOD�Context�
ConnectionNz3argument must be an int, or have a fileno() method.z7twisted.protocols.tls requires pyOpenSSL 0.10 or newer.)�implementer�
providedBy�directlyProvides)
�unicode)
�Failure)�
ISystemHandle�INegotiated�
IPushProducer�ILoggingContext�IOpenSSLServerConnectionCreator�IOpenSSLClientConnectionCreator�IProtocolNegotiationFactory�IHandshakeListener)
�CONNECTION_LOST)
�_PullToPush)
�Protocol)
�_setAcceptableProtocols)�ProtocolWrapper�WrappingFactoryc@s4eZ
dZd
ZdZdd�Zdd�Zdd�Zd	d
�ZdS)�_ProducerMembranea

    Stand-in for producer registered with a L{TLSMemoryBIOProtocol} transport.

    Ensures that producer pause/resume events from the undelying transport are
    coordinated with pause/resume events from the TLS layer.

    @ivar _producer: The application-layer producer.
    FcCs
|
|_dS�
N)
�	_producer)�self�producer�r"�7/usr/lib/python3/dist-packages/twisted/protocols/tls.py�__init__Ps
z_ProducerMembrane.__init__c

Cs|jr
d
Sd|_|j
��
d
S)zP
        C{pauseProducing} the underlying producer, if it's not paused.
        NT)�_producerPausedr�pauseProducing�
r r"r"r#r&Ts


z _ProducerMembrane.pauseProducingc

Cs|js
d
Sd|_|j
��
d
S)zM
        C{resumeProducing} the underlying producer, if it's paused.
        NF)r%r�resumeProducingr'r"r"r#r(^s


z!_ProducerMembrane.resumeProducingc

Cs|j�
�
d
S)z�
        C{stopProducing} the underlying producer.

        There is only a single source for this event, so it's simply passed
        on.
        N)r�
stopProducingr'r"r"r#r)hsz_ProducerMembrane.stopProducingN)	�__name__�
__module__�__qualname__�__doc__r%r$r&r(r)r"r"r"r#rCs	

rc@s�eZ
dZd
ZdZdZdZdZdZd1dd�
Z	dd�Z
d	d
�Zdd�Zd
d�Z
dd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd#d$�Zd%d&�Zd'd(�Zd)d*�Zed+d,��
Zd-d.�Zd/d0�ZdS)2�TLSMemoryBIOProtocola
    L{TLSMemoryBIOProtocol} is a protocol wrapper which uses OpenSSL via a
    memory BIO to encrypt bytes written to it before sending them on to the
    underlying transport and decrypts bytes received from the underlying
    transport before delivering them to the wrapped protocol.

    In addition to producer events from the underlying transport, the need to
    wait for reads before a write can proceed means the L{TLSMemoryBIOProtocol}
    may also want to pause a producer.  Pause/resume events are therefore
    merged using the L{_ProducerMembrane} wrapper.  Non-streaming (pull)
    producers are supported by wrapping them with L{_PullToPush}.

    @ivar _tlsConnection: The L{OpenSSL.SSL.Connection} instance which is
        encrypted and decrypting this connection.

    @ivar _lostTLSConnection: A flag indicating whether connection loss has
        already been dealt with (C{True}) or not (C{False}).  TLS disconnection
        is distinct from the underlying connection being lost.

    @ivar _appSendBuffer: application-level (cleartext) data that is waiting to
        be transferred to the TLS buffer, but can't be because the TLS
        connection is handshaking.
    @type _appSendBuffer: L{list} of L{bytes}

    @ivar _connectWrapped: A flag indicating whether or not to call
        C{makeConnection} on the wrapped protocol.  This is for the reactor's
        L{twisted.internet.interfaces.ITLSTransport.startTLS} implementation,
        since it has a protocol which it has already called C{makeConnection}
        on, and which has no interest in a new transport.  See #3821.

    @ivar _handshakeDone: A flag indicating whether or not the handshake is
        known to have completed successfully (C{True}) or not (C{False}).  This
        is used to control error reporting behavior.  If the handshake has not
        completed, the underlying L{OpenSSL.SSL.Error} will be passed to the
        application's C{connectionLost} method.  If it has completed, any
        unexpected L{OpenSSL.SSL.Error} will be turned into a
        L{ConnectionLost}.  This is weird; however, it is simply an attempt at
        a faithful re-implementation of the behavior provided by
        L{twisted.internet.ssl}.

    @ivar _reason: If an unexpected L{OpenSSL.SSL.Error} occurs which causes
        the connection to be lost, it is saved here.  If appropriate, this may
        be used as the reason passed to the application protocol's
        C{connectionLost} method.

    @ivar _producer: The current producer registered via C{registerProducer},
        or L{None} if no producer has been registered or a previous one was
        unregistered.

    @ivar _aborted: C{abortConnection} has been called.  No further data will
        be received to the wrapped protocol's C{dataReceived}.
    @type _aborted: L{bool}
    NFTcCst�
||
|�
||_dSr)rr$�_connectWrapped)r �factory�wrappedProtocolr/r"r"r#r$�s

zTLSMemoryBIOProtocol.__init__c


Cs|jS)
ai

        Return the L{OpenSSL.SSL.Connection} object being used to encrypt and
        decrypt this connection.

        This is done for the benefit of L{twisted.internet.ssl.Certificate}'s
        C{peerFromTransport} and C{hostFromTransport} methods only.  A
        different system handle may be returned by future versions of this
        method.
        )
�_tlsConnectionr'r"r"r#�	getHandle�s
zTLSMemoryBIOProtocol.getHandlecCsb|j�
|�
|_g|_t|
�
D]}t||�
qt�||
�
|j�|�

|j	rVt
�||
�
|��
d
S)z�
        Connect this wrapper to the given transport and initialize the
        necessary L{OpenSSL.SSL.Connection} with a memory BIO.
        N)r0�_createConnectionr2�_appSendBufferrrr�makeConnectionZregisterProtocolr/r�_checkHandshakeStatus)r �	transportZ	interfacer"r"r#r6�s



z#TLSMemoryBIOProtocol.makeConnectionc

Cst|jr
d
Sz|j
��
Wn:tk
r4


|��
Yn<tk
rR


|�t��

YnXd|_t	�
|j�
rp|j��
d
S)a(

        Ask OpenSSL to proceed with a handshake in progress.

        Initially, this just sends the ClientHello; after some bytes have been
        stuffed in to the C{Connection} object by C{dataReceived}, it will then
        respond to any C{Certificate} or C{KeyExchange} messages.
        NT)
�_abortedr2Zdo_handshaker�
_flushSendBIOr�_tlsShutdownFinishedr�_handshakeDonerrr1ZhandshakeCompletedr'r"r"r#r7�s








z*TLSMemoryBIOProtocol._checkHandshakeStatusc
Cs6z|j�
d
�
}
Wntk
r$


YnX|j�|
�

dS)zh
        Read any bytes out of the send BIO and write them to the underlying
        transport.
        ��N)r2Zbio_readrr8�write�r �bytesr"r"r#r:�s


z"TLSMemoryBIOProtocol._flushSendBIOc
Cs�|js�z|j
�d
�
}
Wn^tk
r.


Yq�Yqtk
rR


|��
|�d�

Yqtk
rt


t�}|�|�

YqX|j	st
�||
�
q|��
dS)ae

        Try to receive any application-level bytes which are now available
        because of a previous write into the receive BIO.  This will take
        care of delivering any application-level bytes which are received to
        the protocol, as well as handling of the various exceptions which
        can come from trying to get such bytes.
        r=N)
�_lostTLSConnectionr2Zrecvrr�_shutdownTLSr;rrr9r�dataReceivedr:)r r@Zfailurer"r"r#�_flushReceiveBIO
s






z%TLSMemoryBIOProtocol._flushReceiveBIOcCs>|j�
|
�

|js$|��
|js$d
S|jr2|��
|��
d
S)z�
        Deliver any received bytes to the receive BIO and then read and deliver
        to the application any application-level data which becomes available
        as a result of this.
        N)r2Z	bio_writer<r7r5�_unbufferPendingWritesrDr?r"r"r#rC/
s


z!TLSMemoryBIOProtocol.dataReceivedc
CsBz|j�
�}
Wntk
r&


d
}
YnX|��
|
r>|j��
dS)zQ
        Initiate, or reply to, the shutdown handshake of the TLS layer.
        FN)r2Zshutdownrr:r8�loseConnection)r ZshutdownSuccessr"r"r#rBM
s




z!TLSMemoryBIOProtocol._shutdownTLScCsT|
d
k	r(t|
j
jd
d��
dkr(tt�
}
|jd
kr8|
|_d|_|��
|j�	�
d
S)a�

        Called when TLS connection has gone away; tell underlying transport to
        disconnect.

        @param reason: a L{Failure} whose value is an L{Exception} if we want to
            report that failure through to the wrapped protocol's
            C{connectionLost}, or L{None} if the C{reason} that
            C{connectionLost} should receive should be coming from the
            underlying transport.
        @type reason: L{Failure} or L{None}
        N�)���zUnexpected EOFT)
�tuple�value�argsrr�_reasonrAr:r8rF�r �reasonr"r"r#r;b
s




z)TLSMemoryBIOProtocol._tlsShutdownFinishedcCsJ|js|j
��
|��
d
|_|jp&|
}
d|_d|_t�||
�
d|_
dS)z�
        Handle the possible repetition of calls to this method (due to either
        the underlying transport going away or due to an error at the TLS
        layer) and make sure the base implementation only gets invoked once.
        TNF)rAr2Zbio_shutdownrDrL�	connectedr�connectionLostrMr"r"r#rP�
s







z#TLSMemoryBIOProtocol.connectionLostc

CsF|js|j
sd
S|js$|js$|��
d|_|jsB|jd
krB|��
d
S)zM
        Send a TLS close alert and close the underlying connection.
        NT)�
disconnectingrOr<r5�abortConnectionrrBr'r"r"r#rF�
s




z#TLSMemoryBIOProtocol.loseConnectionc

Cs"d
|_d
|_
|��
|j��
dS)z�
        Tear down TLS state so that if the connection is aborted mid-handshake
        we don't deliver any further data from the application.
        TN)r9rQrBr8rRr'r"r"r#rR�
s


z$TLSMemoryBIOProtocol.abortConnectioncCs|
|_|�
�
d
S)a,

        Abort the connection during connection setup, giving a reason that
        certificate verification failed.

        @param reason: The reason that the verification failed; reported to the
            application protocol's C{connectionLost} method.
        @type reason: L{Failure}
        N)rLrRrMr"r"r#�failVerification�
s	
z%TLSMemoryBIOProtocol.failVerificationcCs4t|
t
�rtd
�
�
|jr&|jdkr&dS|�|
�

dS)z�
        Process the given application bytes and send any resulting TLS traffic
        which arrives in the send BIO.

        If C{loseConnection} was called, subsequent calls to C{write} will
        drop the bytes on the floor.
        z1Must write bytes to a TLS transport, not unicode.N)�
isinstancer
�	TypeErrorrQr�_writer?r"r"r#r>�
s




zTLSMemoryBIOProtocol.writecCs$|j�
|
�

|jd
k	r |j��
d
S)z�
        Put the given octets into L{TLSMemoryBIOProtocol._appSendBuffer}, and
        tell any listening producer that it should pause because we are now
        buffering.
        N)r5�appendrr&)r Zoctetsr"r"r#�_bufferedWrite�
s


z#TLSMemoryBIOProtocol._bufferedWritec
CsV|jg}
|_|
D]}|�
|�

q|jr,d
S|jd
k	rD|j��
d
S|jrR|��
d
S)zY
        Un-buffer all waiting writes in L{TLSMemoryBIOProtocol._appSendBuffer}.
        N)r5rVrr(rQrB)r Z
pendingWritesZ	eachWriter"r"r#rE�
s




z+TLSMemoryBIOProtocol._unbufferPendingWritescCs�|jr
d
Sd}d}|t
|
�
kr�|
|||�}z|j�|�
}WnLtk
rh


|�|
|d
��

Yq�Yqtk
r�


|�t��

Yq�YqX||7}|�	�
qd
S)a^

        Process the given application bytes and send any resulting TLS traffic
        which arrives in the send BIO.

        This may be called by C{dataReceived} with bytes that were buffered
        before C{loseConnection} was called, which is why this function
        doesn't check for disconnection but accepts the bytes regardless.
        Ni@r
)
rA�lenr2�sendrrXrr;rr:)r r@Z
bufferSizeZalreadySentZtoSendZsentr"r"r#rV�
s 	









zTLSMemoryBIOProtocol._writecCs|�d
�
|
�
�

dS)z}
        Write a sequence of application bytes by joining them into one string
        and passing them to L{write}.
        �N)r>�join)r Ziovecr"r"r#�
writeSequence&sz"TLSMemoryBIOProtocol.writeSequencec

Cs
|j�
�Sr)r2Zget_peer_certificater'r"r"r#�getPeerCertificate.s
z'TLSMemoryBIOProtocol.getPeerCertificatec
	Cspd
}
z|j�
�}
Wnttfk
r*


YnX|
dkr8|
Sz|j��}
Wnttfk
r^


YnX|
dkrl|
Sd
S)z9
        @see: L{INegotiated.negotiatedProtocol}
        N)r[Nr[)r2Zget_alpn_proto_negotiated�NotImplementedError�AttributeErrorZget_next_proto_negotiated)r ZprotocolNamer"r"r#�negotiatedProtocol2s





z'TLSMemoryBIOProtocol.negotiatedProtocolcCsP|jr|
�
�
dS|s$t|
|�}
}t|
�
}
|j�|
d
�
|
|_|sL|��
dS)NT)rAr)rrr8�registerProducerrZstartStreaming)r r!Z	streamingZstreamingProducerr"r"r#rbNs





z%TLSMemoryBIOProtocol.registerProducerc

CsV|jdkrdSt
|jjt�r(|jj��
d|_d
|_|j��
|jrR|jsR|�	�
dS)NF)
rrTrZ
stopStreamingr%r8�unregisterProducerrQr5rBr'r"r"r#rcbs








z'TLSMemoryBIOProtocol.unregisterProducer)
T) r*r+r,r-rLr<rArr9r$r3r6r7r:rDrCrBr;rPrFrRrSr>rXrErVr]r^�propertyrarbrcr"r"r"r#r.rs:6





+"
*

r.c@s0eZ
dZd
Zdd�Zdd�Zdd�Zdd	�Zd
S)�"_ContextFactoryToConnectionFactorya

    Adapter wrapping a L{twisted.internet.interfaces.IOpenSSLContextFactory}
    into a L{IOpenSSLClientConnectionCreator} or
    L{IOpenSSLServerConnectionCreator}.

    See U{https://twistedmatrix.com/trac/ticket/7215} for work that should make
    this unnecessary.
    cCs|
��
|
|_
d
S)a(
        Construct a L{_ContextFactoryToConnectionFactory} with a
        L{twisted.internet.interfaces.IOpenSSLContextFactory}.

        Immediately call C{getContext} on C{oldStyleContextFactory} in order to
        force advance parameter checking, since old-style context factories
        don't actually check that their arguments to L{OpenSSL} are correct.

        @param oldStyleContextFactory: A factory that can produce contexts.
        @type oldStyleContextFactory:
            L{twisted.internet.interfaces.IOpenSSLContextFactory}
        N)�
getContext�_oldStyleContextFactory)r ZoldStyleContextFactoryr"r"r#r$~s

z+_ContextFactoryToConnectionFactory.__init__cCs|j�
�}t|d
�S)z�
        Create an L{OpenSSL.SSL.Connection} object.

        @param protocol: The protocol initiating a TLS connection.
        @type protocol: L{TLSMemoryBIOProtocol}

        @return: a connection
        @rtype: L{OpenSSL.SSL.Connection}
        N)rgrfr	)r �protocol�contextr"r"r#�_connectionForTLS�s


z4_ContextFactoryToConnectionFactory._connectionForTLScCs
|�|
�
S)
a�

        Construct an OpenSSL server connection from the wrapped old-style
        context factory.

        @note: Since old-style context factories don't distinguish between
            clients and servers, this is exactly the same as
            L{_ContextFactoryToConnectionFactory.clientConnectionForTLS}.

        @param protocol: The protocol initiating a TLS connection.
        @type protocol: L{TLSMemoryBIOProtocol}

        @return: a connection
        @rtype: L{OpenSSL.SSL.Connection}
        �
rj�r rhr"r"r#�serverConnectionForTLS�sz9_ContextFactoryToConnectionFactory.serverConnectionForTLScCs
|�|
�
S)
a�

        Construct an OpenSSL server connection from the wrapped old-style
        context factory.

        @note: Since old-style context factories don't distinguish between
            clients and servers, this is exactly the same as
            L{_ContextFactoryToConnectionFactory.serverConnectionForTLS}.

        @param protocol: The protocol initiating a TLS connection.
        @type protocol: L{TLSMemoryBIOProtocol}

        @return: a connection
        @rtype: L{OpenSSL.SSL.Connection}
        rkrlr"r"r#�clientConnectionForTLS�sz9_ContextFactoryToConnectionFactory.clientConnectionForTLSN)r*r+r,r-r$rjrmrnr"r"r"r#ress
	rec@s8eZ
dZd
ZeZdZdd�Zdd�Zdd�Z	d	d
�Z
dS)�TLSMemoryBIOFactorya�

    L{TLSMemoryBIOFactory} adds TLS to connections.

    @ivar _creatorInterface: the interface which L{_connectionCreator} is
        expected to implement.
    @type _creatorInterface: L{zope.interface.interfaces.IInterface}

    @ivar _connectionCreator: a callable which creates an OpenSSL Connection
        object.
    @type _connectionCreator: 1-argument callable taking
        L{TLSMemoryBIOProtocol} and returning L{OpenSSL.SSL.Connection}.
    FcCs<t�
||�
|rt}nt}||_|�|
�
s2t|
�
}
|
|_d
S)a2
        Create a L{TLSMemoryBIOFactory}.

        @param contextFactory: Configuration parameters used to create an
            OpenSSL connection.  In order of preference, what you should pass
            here should be:

                1. L{twisted.internet.ssl.CertificateOptions} (if you're
                   writing a server) or the result of
                   L{twisted.internet.ssl.optionsForClientTLS} (if you're
                   writing a client).  If you want security you should really
                   use one of these.

                2. If you really want to implement something yourself, supply a
                   provider of L{IOpenSSLClientConnectionCreator} or
                   L{IOpenSSLServerConnectionCreator}.

                3. If you really have to, supply a
                   L{twisted.internet.ssl.ContextFactory}.  This will likely be
                   deprecated at some point so please upgrade to the new
                   interfaces.

        @type contextFactory: L{IOpenSSLClientConnectionCreator} or
            L{IOpenSSLServerConnectionCreator}, or, for compatibility with
            older code, anything implementing
            L{twisted.internet.interfaces.IOpenSSLContextFactory}.  See
            U{https://twistedmatrix.com/trac/ticket/7215} for information on
            the upcoming deprecation of passing a
            L{twisted.internet.ssl.ContextFactory} here.

        @param isClient: Is this a factory for TLS client connections; in other
            words, those that will send a C{ClientHello} greeting?  L{True} if
            so, L{False} otherwise.  This flag determines what interface is
            expected of C{contextFactory}.  If L{True}, C{contextFactory}
            should provide L{IOpenSSLClientConnectionCreator}; otherwise it
            should provide L{IOpenSSLServerConnectionCreator}.
        @type isClient: L{bool}

        @param wrappedFactory: A factory which will create the
            application-level protocol.
        @type wrappedFactory: L{twisted.internet.interfaces.IProtocolFactory}
        N)rr$rr�_creatorInterfacerre�_connectionCreator)r ZcontextFactoryZisClient�wrappedFactoryZcreatorInterfacer"r"r#r$�s+






zTLSMemoryBIOFactory.__init__c
Cs,t�
|j�
r|j��}
n
|jjj}
d
|
f
S)z�
        Annotate the wrapped factory's log prefix with some text indicating TLS
        is in use.

        @rtype: C{str}
        z%s (TLS))rrrr�	logPrefix�	__class__r*)r rsr"r"r#rs	s


zTLSMemoryBIOFactory.logPrefixcCs,t�
|j�
r(|j��}|
��}t||�
d
S)a8

        Applies ALPN/NPN protocol neogitation to the connection, if the factory
        supports it.

        @param connection: The OpenSSL connection object to have ALPN/NPN added
            to it.
        @type connection: L{OpenSSL.SSL.Connection}

        @return: Nothing
        @rtype: L{None}
        N)rrrrZacceptableProtocolsZget_contextr)r �
connectionZ	protocolsrir"r"r#�_applyProtocolNegotiations





z-TLSMemoryBIOFactory._applyProtocolNegotiationcCsN|j}|j
tkr.|�|
�
}|�|�

|��
n|�|
�
}|�|�

|��
|S)
a8

        Create an OpenSSL connection and set it up good.

        @param tlsProtocol: The protocol which is establishing the connection.
        @type tlsProtocol: L{TLSMemoryBIOProtocol}

        @return: an OpenSSL connection object for C{tlsProtocol} to use
        @rtype: L{OpenSSL.SSL.Connection}
        )rqrprrnrvZset_connect_statermZset_accept_state)r ZtlsProtocolZconnectionCreatorrur"r"r#r4+s













z%TLSMemoryBIOFactory._createConnectionN)r*r+r,r-r.rhZnoisyr$rsrvr4r"r"r"r#ro�s
6ro)0r-Z
__future__rrZOpenSSL.SSLrrrrrr	rU�
e�str�ImportErrorZzope.interfacer
rrZtwisted.python.compatr
Ztwisted.python.failurerZtwisted.internet.interfacesrrrrrrrrZtwisted.internet.mainrZ"twisted.internet._producer_helpersrZtwisted.internet.protocolrZtwisted.internet._sslverifyrZtwisted.protocols.policiesrr�objectrr.reror"r"r"r#�<module>s:"







(




.

N