Class ExtendedOpenSslSession

java.lang.Object

javax.net.ssl.ExtendedSSLSession

io.netty.handler.ssl.ExtendedOpenSslSession

All Implemented Interfaces:

OpenSslInternalSession, OpenSslSession, SSLSession

abstract class ExtendedOpenSslSession
extends ExtendedSSLSession
implements OpenSslInternalSession

Delegates all operations to a wrapped OpenSslInternalSession except the methods defined by ExtendedSSLSession itself.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	ExtendedOpenSslSession.SSLSessionBindingListenerDecorator

Field Summary

Fields

Modifier and Type	Field	Description
private static final String[]	LOCAL_SUPPORTED_SIGNATURE_ALGORITHMS
private final OpenSslInternalSession	wrapped

Constructor Summary

Constructors

Constructor	Description
ExtendedOpenSslSession(OpenSslInternalSession wrapped)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
final int	getApplicationBufferSize()
final String	getCipherSuite()
final long	getCreationTime()
final byte[]	getId()
final long	getLastAccessedTime()
final Certificate[]	getLocalCertificates()
final Principal	getLocalPrincipal()
final String[]	getLocalSupportedSignatureAlgorithms()
final int	getPacketBufferSize()
final X509Certificate[]	getPeerCertificateChain()
final Certificate[]	getPeerCertificates()
final String	getPeerHost()
final int	getPeerPort()
final Principal	getPeerPrincipal()
String[]	getPeerSupportedSignatureAlgorithms()
String	getProtocol()
abstract List	getRequestedServerNames()
final OpenSslSessionContext	getSessionContext()
List<byte[]>	getStatusResponses()
final Object	getValue(String s)
final String[]	getValueNames()
void	handshakeFinished(byte[] id, String cipher, String protocol, byte[] peerCertificate, byte[][] peerCertificateChain, long creationTime, long timeout)	Called once the handshake has completed.
int	hashCode()
boolean	hasPeerCertificates()	Returns true if the peer has provided certificates during the handshake.
final void	invalidate()
final boolean	isValid()
Map<String,Object>	keyValueStorage()	Return the underlying Map that is used by the following methods: SSLSession.putValue(String, Object) SSLSession.removeValue(String) SSLSession.getValue(String) SSLSession.getValueNames() The Map must be thread-safe!
void	prepareHandshake()	Called on a handshake session before being exposed to a TrustManager.
final void	putValue(String name, Object value)
final void	removeValue(String s)
OpenSslSessionId	sessionId()	Return the OpenSslSessionId that can be used to identify this session.
void	setLastAccessedTime(long time)	Set the last access time which will be returned by SSLSession.getLastAccessedTime().
final void	setLocalCertificate(Certificate[] localCertificate)	Set the local certificate chain that is used.
void	setSessionDetails(long creationTime, long lastAccessedTime, OpenSslSessionId id, Map<String,Object> keyValueStorage)	Set the details for the session which might come from a cache.
String	toString()
final void	tryExpandApplicationBufferSize(int packetLengthDataOnly)	Expand (or increase) the value returned by SSLSession.getApplicationBufferSize() if necessary.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOCAL_SUPPORTED_SIGNATURE_ALGORITHMS

private static final String[] LOCAL_SUPPORTED_SIGNATURE_ALGORITHMS

wrapped

private final OpenSslInternalSession wrapped

Constructor Details

ExtendedOpenSslSession

ExtendedOpenSslSession(OpenSslInternalSession wrapped)

Method Details

getRequestedServerNames

public abstract List getRequestedServerNames()

Overrides:

getRequestedServerNames in class ExtendedSSLSession

getStatusResponses

public List<byte[]> getStatusResponses()

prepareHandshake

public void prepareHandshake()

Description copied from interface: OpenSslInternalSession

Called on a handshake session before being exposed to a TrustManager. Session data must be cleared by this call.

Specified by:

prepareHandshake in interface OpenSslInternalSession

keyValueStorage

public Map<String,Object> keyValueStorage()

Description copied from interface: OpenSslInternalSession

Return the underlying Map that is used by the following methods:

• SSLSession.putValue(String, Object)
• SSLSession.removeValue(String)
• SSLSession.getValue(String)
• SSLSession.getValueNames()

The Map must be thread-safe!

Specified by:

keyValueStorage in interface OpenSslInternalSession

Returns:

storage

sessionId

public OpenSslSessionId sessionId()

Description copied from interface: OpenSslInternalSession

Return the OpenSslSessionId that can be used to identify this session.

Specified by:

sessionId in interface OpenSslInternalSession

setSessionDetails

public void setSessionDetails(long creationTime,
 long lastAccessedTime,
 OpenSslSessionId id,
 Map<String,Object> keyValueStorage)

Description copied from interface: OpenSslInternalSession

Set the details for the session which might come from a cache.

Specified by:

setSessionDetails in interface OpenSslInternalSession

Parameters:

creationTime - the time at which the session was created.

lastAccessedTime - the time at which the session was last accessed via the session infrastructure (cache).

id - the OpenSslSessionId

keyValueStorage - the key value store. See OpenSslInternalSession.keyValueStorage().

setLocalCertificate

public final void setLocalCertificate(Certificate[] localCertificate)

Description copied from interface: OpenSslInternalSession

Set the local certificate chain that is used. It is not expected that this array will be changed at all and so its ok to not copy the array.

Specified by:

setLocalCertificate in interface OpenSslInternalSession

getPeerSupportedSignatureAlgorithms

public String[] getPeerSupportedSignatureAlgorithms()

Specified by:

getPeerSupportedSignatureAlgorithms in class ExtendedSSLSession

tryExpandApplicationBufferSize

public final void tryExpandApplicationBufferSize(int packetLengthDataOnly)

Description copied from interface: OpenSslInternalSession

Expand (or increase) the value returned by SSLSession.getApplicationBufferSize() if necessary.

This is only called in a synchronized block, so no need to use atomic operations.

Specified by:

tryExpandApplicationBufferSize in interface OpenSslInternalSession

Parameters:

packetLengthDataOnly - The packet size which exceeds the current SSLSession.getApplicationBufferSize().

getLocalSupportedSignatureAlgorithms

public final String[] getLocalSupportedSignatureAlgorithms()

Specified by:

getLocalSupportedSignatureAlgorithms in class ExtendedSSLSession

getId

public final byte[] getId()

Specified by:

getId in interface SSLSession

getSessionContext

public final OpenSslSessionContext getSessionContext()

Specified by:

getSessionContext in interface OpenSslSession

Specified by:

getSessionContext in interface SSLSession

getCreationTime

public final long getCreationTime()

Specified by:

getCreationTime in interface SSLSession

getLastAccessedTime

public final long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface SSLSession

setLastAccessedTime

public void setLastAccessedTime(long time)

Description copied from interface: OpenSslInternalSession

Set the last access time which will be returned by SSLSession.getLastAccessedTime().

Specified by:

setLastAccessedTime in interface OpenSslInternalSession

Parameters:

time - the time

invalidate

public final void invalidate()

Specified by:

invalidate in interface SSLSession

isValid

public final boolean isValid()

Specified by:

isValid in interface SSLSession

putValue

public final void putValue(String name,
 Object value)

Specified by:

putValue in interface SSLSession

getValue

public final Object getValue(String s)

Specified by:

getValue in interface SSLSession

removeValue

public final void removeValue(String s)

Specified by:

removeValue in interface SSLSession

getValueNames

public final String[] getValueNames()

Specified by:

getValueNames in interface SSLSession

getPeerCertificates

public final Certificate[] getPeerCertificates()
                                        throws SSLPeerUnverifiedException

Specified by:

getPeerCertificates in interface SSLSession

Throws:

SSLPeerUnverifiedException

hasPeerCertificates

public boolean hasPeerCertificates()

Description copied from interface: OpenSslSession

Returns true if the peer has provided certificates during the handshake.

This method is similar to SSLSession.getPeerCertificates() but it does not throw a SSLPeerUnverifiedException if no certs are provided, making it more efficient to check if a mTLS connection is used.

Specified by:

hasPeerCertificates in interface OpenSslSession

Returns:

true if peer certificates are available.

getLocalCertificates

public final Certificate[] getLocalCertificates()

Specified by:

getLocalCertificates in interface SSLSession

getPeerCertificateChain

public final X509Certificate[] getPeerCertificateChain()
                                                throws SSLPeerUnverifiedException

Specified by:

getPeerCertificateChain in interface SSLSession

Throws:

SSLPeerUnverifiedException

getPeerPrincipal

public final Principal getPeerPrincipal()
                                 throws SSLPeerUnverifiedException

Specified by:

getPeerPrincipal in interface SSLSession

Throws:

SSLPeerUnverifiedException

getLocalPrincipal

public final Principal getLocalPrincipal()

Specified by:

getLocalPrincipal in interface SSLSession

getCipherSuite

public final String getCipherSuite()

Specified by:

getCipherSuite in interface SSLSession

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface SSLSession

getPeerHost

public final String getPeerHost()

Specified by:

getPeerHost in interface SSLSession

getPeerPort

public final int getPeerPort()

Specified by:

getPeerPort in interface SSLSession

getPacketBufferSize

public final int getPacketBufferSize()

Specified by:

getPacketBufferSize in interface SSLSession

getApplicationBufferSize

public final int getApplicationBufferSize()

Specified by:

getApplicationBufferSize in interface SSLSession

handshakeFinished

public void handshakeFinished(byte[] id,
 String cipher,
 String protocol,
 byte[] peerCertificate,
 byte[][] peerCertificateChain,
 long creationTime,
 long timeout)
                       throws SSLException

Description copied from interface: OpenSslInternalSession

Called once the handshake has completed.

Specified by:

handshakeFinished in interface OpenSslInternalSession

Throws:

SSLException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object