TLSProtocol

Type Members

1. case class NegotiateNewSession(enabledCipherSuites: Option[Seq[String]], enabledProtocols: Option[Seq[String]], clientAuth: Option[TLSClientAuth], sslParameters: Option[SSLParameters]) extends SslTlsOutbound with Product with Serializable

   

   Initiate a new session negotiation.

   Initiate a new session negotiation. Any SendBytes commands following this one will be held back (i.e. back-pressured) until the new handshake is completed, meaning that the bytes following this message will be encrypted according to the requirements outlined here.

   Each of the values in this message is optional and will have the following effect if provided:

   - enabledCipherSuites will be passed to SSLEngine::setEnabledCipherSuites() - enabledProtocols will be passed to SSLEngine::setEnabledProtocols() - clientAuth will be passed to SSLEngine::setWantClientAuth() or SSLEngine.setNeedClientAuth(), respectively - sslParameters will be passed to SSLEngine::setSSLParameters()

   Please note that passing clientAuth = None means that no change is done on client authentication requirements while clientAuth = Some(ClientAuth.None) switches off client authentication.

2. final case class SendBytes(bytes: ByteString) extends SslTlsOutbound with Product with Serializable

   

   Send the given akka.util.ByteString across the encrypted session to the peer.

3. final case class SessionBytes(session: SSLSession, bytes: ByteString) extends SslTlsInbound with ScalaSessionAPI with Product with Serializable

   

   Plaintext bytes emitted by the SSLEngine are received over one specific encryption session and this class bundles the bytes with the SSLSession object.

   Plaintext bytes emitted by the SSLEngine are received over one specific encryption session and this class bundles the bytes with the SSLSession object. When the session changes due to renegotiation (which can be initiated by either party) the new session value will not compare equal to the previous one.

   The Java API for getting session information is given by the SSLSession object, the Scala API adapters are offered below.

4. sealed abstract class SessionTruncated extends SslTlsInbound

   

   If the underlying transport is closed before the final TLS closure command is received from the peer then the SSLEngine will throw an SSLException that warns about possible truncation attacks.

   If the underlying transport is closed before the final TLS closure command is received from the peer then the SSLEngine will throw an SSLException that warns about possible truncation attacks. This exception is caught and translated into this message when encountered. Most of the time this occurs not because of a malicious attacker but due to a connection abort or a misbehaving communication peer.

5. sealed trait SslTlsInbound extends AnyRef

   

   This is the supertype of all messages that the SslTls stage emits on the plaintext side.

6. sealed trait SslTlsOutbound extends AnyRef

   

   This is the supertype of all messages that the SslTls stage accepts on its plaintext side.