Class SslConnection

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Connection, Connection.UpgradeTo

    public class SslConnection
    extends AbstractConnection
    implements Connection.UpgradeTo
    A Connection that acts as an interceptor between an EndPoint providing SSL encrypted data and another consumer of an EndPoint (typically an Connection like HttpConnection) that wants unencrypted data.

    The connector uses an EndPoint (typically SocketChannelEndPoint) as it's source/sink of encrypted data. It then provides an endpoint via getDecryptedEndPoint() to expose a source/sink of unencrypted data to another connection (eg HttpConnection).

    The design of this class is based on a clear separation between the passive methods, which do not block nor schedule any asynchronous callbacks, and active methods that do schedule asynchronous callbacks.

    The passive methods are SslConnection.DecryptedEndPoint.fill(ByteBuffer) and SslConnection.DecryptedEndPoint.flush(ByteBuffer...). They make best effort attempts to progress the connection using only calls to the encrypted EndPoint.fill(ByteBuffer) and EndPoint.flush(ByteBuffer...) methods. They will never block nor schedule any readInterest or write callbacks. If a fill/flush cannot progress either because of network congestion or waiting for an SSL handshake message, then the fill/flush will simply return with zero bytes filled/flushed. Specifically, if a flush cannot proceed because it needs to receive a handshake message, then the flush will attempt to fill bytes from the encrypted endpoint, but if insufficient bytes are read it will NOT call EndPoint.fillInterested(Callback).

    It is only the active methods : AbstractEndPoint.fillInterested(Callback) and AbstractEndPoint.write(Callback, ByteBuffer...) that may schedule callbacks by calling the encrypted EndPoint.fillInterested(Callback) and EndPoint.write(Callback, ByteBuffer...) methods. For normal data handling, the decrypted fillInterest method will result in an encrypted fillInterest and a decrypted write will result in an encrypted write. However, due to SSL handshaking requirements, it is also possible for a decrypted fill to call the encrypted write and for the decrypted flush to call the encrypted fillInterested methods.

    MOST IMPORTANTLY, the encrypted callbacks from the active methods (#onFillable() and WriteFlusher#completeWrite()) do no filling or flushing themselves. Instead they simple make the callbacks to the decrypted callbacks, so that the passive encrypted fill/flush will be called again and make another best effort attempt to progress the connection.

    • Constructor Detail

      • SslConnection

        public SslConnection​(ByteBufferPool byteBufferPool,
                             java.util.concurrent.Executor executor,
                             EndPoint endPoint,
                             javax.net.ssl.SSLEngine sslEngine)
      • SslConnection

        public SslConnection​(ByteBufferPool byteBufferPool,
                             java.util.concurrent.Executor executor,
                             EndPoint endPoint,
                             javax.net.ssl.SSLEngine sslEngine,
                             boolean useDirectBuffersForEncryption,
                             boolean useDirectBuffersForDecryption)
    • Method Detail

      • removeHandshakeListener

        public boolean removeHandshakeListener​(SslHandshakeListener listener)
      • getSSLEngine

        public javax.net.ssl.SSLEngine getSSLEngine()
      • isRenegotiationAllowed

        public boolean isRenegotiationAllowed()
      • setRenegotiationAllowed

        public void setRenegotiationAllowed​(boolean renegotiationAllowed)
      • getRenegotiationLimit

        public int getRenegotiationLimit()
        Returns:
        The number of renegotiations allowed for this connection. When the limit is 0 renegotiation will be denied. If the limit is less than 0 then no limit is applied.
      • setRenegotiationLimit

        public void setRenegotiationLimit​(int renegotiationLimit)
        Parameters:
        renegotiationLimit - The number of renegotiations allowed for this connection. When the limit is 0 renegotiation will be denied. If the limit is less than 0 then no limit is applied. Default -1.
      • isAllowMissingCloseMessage

        @Deprecated
        public boolean isAllowMissingCloseMessage()
        Deprecated.
        use inverted isRequireCloseMessage() instead
        Returns:
        whether is not required that peers send the TLS close_notify message
      • setAllowMissingCloseMessage

        @Deprecated
        public void setAllowMissingCloseMessage​(boolean allowMissingCloseMessage)
        Deprecated.
        use inverted setRequireCloseMessage(boolean) instead
        Parameters:
        allowMissingCloseMessage - whether is not required that peers send the TLS close_notify message
      • isRequireCloseMessage

        public boolean isRequireCloseMessage()
        Returns:
        whether peers must send the TLS close_notify message
      • setRequireCloseMessage

        public void setRequireCloseMessage​(boolean requireCloseMessage)

        Sets whether it is required that a peer send the TLS close_notify message to indicate the will to close the connection, otherwise it may be interpreted as a truncation attack.

        This option is only useful on clients, since typically servers cannot accept connection-delimited content that may be truncated.

        Parameters:
        requireCloseMessage - whether peers must send the TLS close_notify message
      • onUpgradeTo

        public void onUpgradeTo​(java.nio.ByteBuffer buffer)
        Description copied from interface: Connection.UpgradeTo

        Callback method invoked when this connection is upgraded.

        This must be called before Connection.onOpen().

        Specified by:
        onUpgradeTo in interface Connection.UpgradeTo
        Parameters:
        buffer - An optional buffer that can contain prefilled data. Typically this results from an upgrade of one protocol to the other where the old connection has buffered data destined for the new connection. The new connection must take ownership of the buffer and is responsible for returning it to the buffer pool
      • onOpen

        public void onOpen()
        Description copied from interface: Connection

        Callback method invoked when this connection is opened.

        Creators of the connection implementation are responsible for calling this method.

        Specified by:
        onOpen in interface Connection
        Overrides:
        onOpen in class AbstractConnection
      • onClose

        public void onClose()
        Description copied from interface: Connection

        Callback method invoked when this connection is closed.

        Creators of the connection implementation are responsible for calling this method.

        Specified by:
        onClose in interface Connection
        Overrides:
        onClose in class AbstractConnection
      • close

        public void close()
        Description copied from interface: Connection

        Performs a logical close of this connection.

        For simple connections, this may just mean to delegate the close to the associated EndPoint but, for example, SSL connections should write the SSL close message before closing the associated EndPoint.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface Connection
        Overrides:
        close in class AbstractConnection
      • onIdleExpired

        public boolean onIdleExpired()
        Description copied from interface: Connection

        Callback method invoked upon an idle timeout event.

        Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.

        When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.

        Specified by:
        onIdleExpired in interface Connection
        Overrides:
        onIdleExpired in class AbstractConnection
        Returns:
        true to let the EndPoint handle the idle timeout, false to tell the EndPoint to halt the handling of the idle timeout.
      • onFillInterestedFailed

        public void onFillInterestedFailed​(java.lang.Throwable cause)
        Description copied from class: AbstractConnection

        Callback method invoked when the endpoint failed to be ready to be read.

        Overrides:
        onFillInterestedFailed in class AbstractConnection
        Parameters:
        cause - the exception that caused the failure
      • wrap

        protected javax.net.ssl.SSLEngineResult wrap​(javax.net.ssl.SSLEngine sslEngine,
                                                     java.nio.ByteBuffer[] input,
                                                     java.nio.ByteBuffer output)
                                              throws javax.net.ssl.SSLException
        Throws:
        javax.net.ssl.SSLException
      • unwrap

        protected javax.net.ssl.SSLEngineResult unwrap​(javax.net.ssl.SSLEngine sslEngine,
                                                       java.nio.ByteBuffer input,
                                                       java.nio.ByteBuffer output)
                                                throws javax.net.ssl.SSLException
        Throws:
        javax.net.ssl.SSLException
      • releaseDecryptedInputBuffer

        protected void releaseDecryptedInputBuffer()
      • networkFill

        protected int networkFill​(java.nio.ByteBuffer input)
                           throws java.io.IOException
        Throws:
        java.io.IOException
      • networkFlush

        protected boolean networkFlush​(java.nio.ByteBuffer output)
                                throws java.io.IOException
        Throws:
        java.io.IOException