Class OpenSslSessionCache.NativeSslSession

java.lang.Object

io.netty.handler.ssl.OpenSslSessionCache.NativeSslSession

All Implemented Interfaces:

OpenSslInternalSession, OpenSslSession, SSLSession

Enclosing class:

OpenSslSessionCache

static final class OpenSslSessionCache.NativeSslSession
extends Object
implements OpenSslInternalSession

OpenSslInternalSession implementation which wraps the native SSL_SESSION* while in cache.

Field Summary

Fields

Modifier and Type	Field	Description
private final long	creationTime
private boolean	freed
private final OpenSslSessionId	id
(package private) final Map<String,Object>	keyValueStorage
private long	lastAccessedTime
(package private) static final ResourceLeakDetector<OpenSslSessionCache.NativeSslSession>	LEAK_DETECTOR
private final ResourceLeakTracker<OpenSslSessionCache.NativeSslSession>	leakTracker
private final String	peerHost
private final int	peerPort
private final long	session
private final long	timeout
private boolean	valid

Constructor Summary

Constructors

Constructor	Description
NativeSslSession(long session, String peerHost, int peerPort, long timeout, Map<String,Object> keyValueStorage)

Method Summary

Modifier and Type	Method	Description
(package private) void	close()
boolean	equals(Object o)
(package private) void	free()
int	getApplicationBufferSize()
String	getCipherSuite()
long	getCreationTime()
byte[]	getId()
long	getLastAccessedTime()
Certificate[]	getLocalCertificates()
Principal	getLocalPrincipal()
int	getPacketBufferSize()
X509Certificate[]	getPeerCertificateChain()
Certificate[]	getPeerCertificates()
String	getPeerHost()
int	getPeerPort()
Principal	getPeerPrincipal()
String	getProtocol()
OpenSslSessionContext	getSessionContext()
Object	getValue(String name)
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.
void	invalidate()
boolean	isValid()
(package private) boolean	isValid(long now)
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.
void	putValue(String name, Object value)
void	removeValue(String name)
(package private) long	session()
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().
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.
(package private) boolean	shouldBeSingleUse()
void	tryExpandApplicationBufferSize(int packetLengthDataOnly)	Expand (or increase) the value returned by SSLSession.getApplicationBufferSize() if necessary.
(package private) boolean	upRef()

Methods inherited from class Object

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

Field Details

LEAK_DETECTOR

static final ResourceLeakDetector<OpenSslSessionCache.NativeSslSession> LEAK_DETECTOR

leakTracker

private final ResourceLeakTracker<OpenSslSessionCache.NativeSslSession> leakTracker

keyValueStorage

final Map<String,Object> keyValueStorage

session

private final long session

peerHost

private final String peerHost

peerPort

private final int peerPort

id

private final OpenSslSessionId id

timeout

private final long timeout

creationTime

private final long creationTime

lastAccessedTime

private volatile long lastAccessedTime

valid

private volatile boolean valid

freed

private boolean freed

Constructor Details

NativeSslSession

NativeSslSession(long session,
 String peerHost,
 int peerPort,
 long timeout,
 Map<String,Object> keyValueStorage)

Method Details

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

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

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().

shouldBeSingleUse

boolean shouldBeSingleUse()

session

long session()

upRef

boolean upRef()

free

void free()

close

void close()

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

isValid

boolean isValid(long now)

setLocalCertificate

public 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

getSessionContext

public OpenSslSessionContext getSessionContext()

Specified by:

getSessionContext in interface OpenSslSession

Specified by:

getSessionContext in interface SSLSession

tryExpandApplicationBufferSize

public 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().

handshakeFinished

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

Description copied from interface: OpenSslInternalSession

Called once the handshake has completed.

Specified by:

handshakeFinished in interface OpenSslInternalSession

getId

public byte[] getId()

Specified by:

getId in interface SSLSession

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime 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

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface SSLSession

invalidate

public void invalidate()

Specified by:

invalidate in interface SSLSession

isValid

public boolean isValid()

Specified by:

isValid in interface SSLSession

putValue

public void putValue(String name,
 Object value)

Specified by:

putValue in interface SSLSession

getValue

public Object getValue(String name)

Specified by:

getValue in interface SSLSession

removeValue

public void removeValue(String name)

Specified by:

removeValue in interface SSLSession

getValueNames

public String[] getValueNames()

Specified by:

getValueNames in interface SSLSession

getPeerCertificates

public Certificate[] getPeerCertificates()

Specified by:

getPeerCertificates in interface SSLSession

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 Certificate[] getLocalCertificates()

Specified by:

getLocalCertificates in interface SSLSession

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()

Specified by:

getPeerCertificateChain in interface SSLSession

getPeerPrincipal

public Principal getPeerPrincipal()

Specified by:

getPeerPrincipal in interface SSLSession

getLocalPrincipal

public Principal getLocalPrincipal()

Specified by:

getLocalPrincipal in interface SSLSession

getCipherSuite

public String getCipherSuite()

Specified by:

getCipherSuite in interface SSLSession

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface SSLSession

getPeerHost

public String getPeerHost()

Specified by:

getPeerHost in interface SSLSession

getPeerPort

public int getPeerPort()

Specified by:

getPeerPort in interface SSLSession

getPacketBufferSize

public int getPacketBufferSize()

Specified by:

getPacketBufferSize in interface SSLSession

getApplicationBufferSize

public int getApplicationBufferSize()

Specified by:

getApplicationBufferSize in interface SSLSession

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object