Class ReferenceCountedOpenSslEngine.DefaultOpenSslSession

java.lang.Object

io.netty.handler.ssl.ReferenceCountedOpenSslEngine.DefaultOpenSslSession

All Implemented Interfaces:

OpenSslInternalSession, OpenSslSession, SSLSession

Enclosing class:

ReferenceCountedOpenSslEngine

private final class ReferenceCountedOpenSslEngine.DefaultOpenSslSession
extends Object
implements OpenSslInternalSession

Field Summary

Fields

Modifier and Type	Field	Description
private int	applicationBufferSize
private String	cipher
private long	creationTime
private OpenSslSessionId	id
private Map<String,Object>	keyValueStorage
private long	lastAccessed
private Certificate[]	localCertificateChain
private Certificate[]	peerCerts
private String	protocol
private final OpenSslSessionContext	sessionContext
private boolean	valid
private X509Certificate[]	x509PeerCerts

Constructor Summary

Constructors

Constructor	Description
DefaultOpenSslSession(OpenSslSessionContext sessionContext)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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)	Finish the handshake and so init everything in the OpenSslInternalSession that should be accessible by the user.
int	hashCode()
boolean	hasPeerCertificates()	Returns true if the peer has provided certificates during the handshake.
private void	initCerts(byte[][] chain, int startPos)
void	invalidate()
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!
private SSLSessionBindingEvent	newSSLSessionBindingEvent(String name)
private void	notifyUnbound(Object value, String name)
void	prepareHandshake()	Called on a handshake session before being exposed to a TrustManager.
void	putValue(String name, Object value)
void	removeValue(String name)
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 sessionId, Map<String,Object> keyValueStorage)	Set the details for the session which might come from a cache.
String	toString()
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

sessionContext

private final OpenSslSessionContext sessionContext

x509PeerCerts

private X509Certificate[] x509PeerCerts

peerCerts

private Certificate[] peerCerts

valid

private boolean valid

protocol

private String protocol

cipher

private String cipher

id

private OpenSslSessionId id

creationTime

private long creationTime

lastAccessed

private long lastAccessed

applicationBufferSize

private volatile int applicationBufferSize

localCertificateChain

private volatile Certificate[] localCertificateChain

keyValueStorage

private volatile Map<String,Object> keyValueStorage

Constructor Details

DefaultOpenSslSession

DefaultOpenSslSession(OpenSslSessionContext sessionContext)

Method Details

newSSLSessionBindingEvent

private SSLSessionBindingEvent newSSLSessionBindingEvent(String name)

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 sessionId,
 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).

sessionId - the OpenSslSessionId

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

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

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

getId

public byte[] getId()

Specified by:

getId in interface SSLSession

getSessionContext

public OpenSslSessionContext getSessionContext()

Specified by:

getSessionContext in interface OpenSslSession

Specified by:

getSessionContext 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

notifyUnbound

private void notifyUnbound(Object value,
 String name)

handshakeFinished

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

Finish the handshake and so init everything in the OpenSslInternalSession that should be accessible by the user.

Specified by:

handshakeFinished in interface OpenSslInternalSession

Throws:

SSLException

initCerts

private void initCerts(byte[][] chain,
 int startPos)

getPeerCertificates

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

Specified by:

getLocalCertificates in interface SSLSession

getPeerCertificateChain

public X509Certificate[] getPeerCertificateChain()
                                          throws SSLPeerUnverifiedException

Specified by:

getPeerCertificateChain in interface SSLSession

Throws:

SSLPeerUnverifiedException

getPeerPrincipal

public Principal getPeerPrincipal()
                           throws SSLPeerUnverifiedException

Specified by:

getPeerPrincipal in interface SSLSession

Throws:

SSLPeerUnverifiedException

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

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

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object