Top Description Methods
io.undertow.server

public Interface SSLSessionInfo

Known Direct Implementers
io.undertow.server.protocol.http2.Http2SslSessionInfo, io.undertow.server.BasicSSLSessionInfo, io.undertow.server.ConnectionSSLSessionInfo
Imports
org.xnio.SslClientAuthMode, javax.net.ssl.SSLSession, java.io.IOException

SSL session information.
Author
Stuart Douglas

Method Summary

Modifier and TypeMethod and Description
public static int

Returns:

int indicating the effective key entropy bit-length.
calculateKeySize
(String
String name of the TLS cipher suite.
cipherSuite
)

Given the name of a TLS/SSL cipher suite, return an int representing it effective stream cipher key strength.

public String
public default int
public X509Certificate[]
getPeerCertificateChain()
Deprecated since 2.2.3. in favor of getPeerCertificates() because SSLSession#getPeerCertificateChain() throws java 15.

This method is no longer supported on java 15 and should be avoided.

public Certificate[]

Returns:

The peer certificates
getPeerCertificates
()

Gets the peer certificates.

public byte[]

Returns:

The SSL session ID, or null if this could not be determined.
getSessionId
()

public SSLSession

Returns:

The SSL session, or null if it is not applicable
getSSLSession
()

public void
renegotiate(HttpServerExchange
The exchange
exchange
,
SslClientAuthMode
The client cert mode to use when renegotiating
sslClientAuthMode
)

Renegotiate in a blocking manner.

Method Detail

calculateKeySizeback to summary
public static int calculateKeySize(String cipherSuite)

Given the name of a TLS/SSL cipher suite, return an int representing it effective stream cipher key strength. i.e. How much entropy material is in the key material being fed into the encryption routines.

TLS 1.3 https://wiki.openssl.org/index.php/TLS1.3

https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4

Parameters
cipherSuite:String

String name of the TLS cipher suite.

Returns:int

int indicating the effective key entropy bit-length.

getCipherSuiteback to summary
public String getCipherSuite()
getKeySizeback to summary
public default int getKeySize()
getPeerCertificateChainback to summary
public X509Certificate[] getPeerCertificateChain() throws SSLPeerUnverifiedException, RenegotiationRequiredException

Deprecated

since 2.2.3.

in favor of getPeerCertificates() because SSLSession#getPeerCertificateChain() throws java 15.

This method is no longer supported on java 15 and should be avoided.

Annotations
@Deprecated
since:2.2.3
forRemoval:false
See Also
SSLSession#getPeerCertificateChain()
getPeerCertificatesback to summary
public Certificate[] getPeerCertificates() throws SSLPeerUnverifiedException, RenegotiationRequiredException

Gets the peer certificates. This may force SSL renegotiation.

Returns:Certificate[]

The peer certificates

Exceptions
RenegotiationRequiredException:
If the session
getSessionIdback to summary
public byte[] getSessionId()
Returns:byte[]

The SSL session ID, or null if this could not be determined.

getSSLSessionback to summary
public SSLSession getSSLSession()
Returns:SSLSession

The SSL session, or null if it is not applicable

renegotiateback to summary
public void renegotiate(HttpServerExchange exchange, SslClientAuthMode sslClientAuthMode) throws IOException

Renegotiate in a blocking manner. This will set the client aut

Todo

we also need a non-blocking version

Parameters
exchange:HttpServerExchange

The exchange

sslClientAuthMode:SslClientAuthMode

The client cert mode to use when renegotiating