Package io.netty.handler.ssl
Class OpenSslSessionCache.NativeSslSession
- java.lang.Object
-
- io.netty.handler.ssl.OpenSslSessionCache.NativeSslSession
-
- All Implemented Interfaces:
OpenSslInternalSession,OpenSslSession,javax.net.ssl.SSLSession
- Enclosing class:
- OpenSslSessionCache
static final class OpenSslSessionCache.NativeSslSession extends java.lang.Object implements OpenSslInternalSession
OpenSslInternalSessionimplementation which wraps the native SSL_SESSION* while in cache.
-
-
Field Summary
Fields Modifier and Type Field Description private longcreationTimeprivate booleanfreedprivate OpenSslSessionIdid(package private) java.util.Map<java.lang.String,java.lang.Object>keyValueStorageprivate longlastAccessedTime(package private) static ResourceLeakDetector<OpenSslSessionCache.NativeSslSession>LEAK_DETECTORprivate ResourceLeakTracker<OpenSslSessionCache.NativeSslSession>leakTrackerprivate java.lang.StringpeerHostprivate intpeerPortprivate longsessionprivate longtimeoutprivate booleanvalid
-
Constructor Summary
Constructors Constructor Description NativeSslSession(long session, java.lang.String peerHost, int peerPort, long timeout, java.util.Map<java.lang.String,java.lang.Object> keyValueStorage)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) voidclose()booleanequals(java.lang.Object o)(package private) voidfree()intgetApplicationBufferSize()java.lang.StringgetCipherSuite()longgetCreationTime()byte[]getId()longgetLastAccessedTime()java.security.cert.Certificate[]getLocalCertificates()java.security.PrincipalgetLocalPrincipal()intgetPacketBufferSize()javax.security.cert.X509Certificate[]getPeerCertificateChain()java.security.cert.Certificate[]getPeerCertificates()java.lang.StringgetPeerHost()intgetPeerPort()java.security.PrincipalgetPeerPrincipal()java.lang.StringgetProtocol()OpenSslSessionContextgetSessionContext()java.lang.ObjectgetValue(java.lang.String name)java.lang.String[]getValueNames()voidhandshakeFinished(byte[] id, java.lang.String cipher, java.lang.String protocol, byte[] peerCertificate, byte[][] peerCertificateChain, long creationTime, long timeout)Called once the handshake has completed.inthashCode()booleanhasPeerCertificates()Returns true if the peer has provided certificates during the handshake.voidinvalidate()booleanisValid()(package private) booleanisValid(long now)java.util.Map<java.lang.String,java.lang.Object>keyValueStorage()Return the underlyingMapthat is used by the following methods:SSLSession.putValue(String, Object)SSLSession.removeValue(String)SSLSession.getValue(String)SSLSession.getValueNames()TheMapmust be thread-safe!voidprepareHandshake()Called on a handshake session before being exposed to aTrustManager.voidputValue(java.lang.String name, java.lang.Object value)voidremoveValue(java.lang.String name)(package private) longsession()OpenSslSessionIdsessionId()Return theOpenSslSessionIdthat can be used to identify this session.voidsetLastAccessedTime(long time)Set the last access time which will be returned bySSLSession.getLastAccessedTime().voidsetLocalCertificate(java.security.cert.Certificate[] localCertificate)Set the local certificate chain that is used.voidsetSessionDetails(long creationTime, long lastAccessedTime, OpenSslSessionId id, java.util.Map<java.lang.String,java.lang.Object> keyValueStorage)Set the details for the session which might come from a cache.(package private) booleanshouldBeSingleUse()voidtryExpandApplicationBufferSize(int packetLengthDataOnly)Expand (or increase) the value returned bySSLSession.getApplicationBufferSize()if necessary.(package private) booleanupRef()
-
-
-
Field Detail
-
LEAK_DETECTOR
static final ResourceLeakDetector<OpenSslSessionCache.NativeSslSession> LEAK_DETECTOR
-
leakTracker
private final ResourceLeakTracker<OpenSslSessionCache.NativeSslSession> leakTracker
-
keyValueStorage
final java.util.Map<java.lang.String,java.lang.Object> keyValueStorage
-
session
private final long session
-
peerHost
private final java.lang.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
-
-
Method Detail
-
keyValueStorage
public java.util.Map<java.lang.String,java.lang.Object> keyValueStorage()
Description copied from interface:OpenSslInternalSessionReturn the underlyingMapthat is used by the following methods:SSLSession.putValue(String, Object)SSLSession.removeValue(String)SSLSession.getValue(String)-
SSLSession.getValueNames()
Mapmust be thread-safe!- Specified by:
keyValueStoragein interfaceOpenSslInternalSession- Returns:
- storage
-
prepareHandshake
public void prepareHandshake()
Description copied from interface:OpenSslInternalSessionCalled on a handshake session before being exposed to aTrustManager. Session data must be cleared by this call.- Specified by:
prepareHandshakein interfaceOpenSslInternalSession
-
setSessionDetails
public void setSessionDetails(long creationTime, long lastAccessedTime, OpenSslSessionId id, java.util.Map<java.lang.String,java.lang.Object> keyValueStorage)Description copied from interface:OpenSslInternalSessionSet the details for the session which might come from a cache.- Specified by:
setSessionDetailsin interfaceOpenSslInternalSession- 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- theOpenSslSessionIdkeyValueStorage- the key value store. SeeOpenSslInternalSession.keyValueStorage().
-
shouldBeSingleUse
boolean shouldBeSingleUse()
-
session
long session()
-
upRef
boolean upRef()
-
free
void free()
-
close
void close()
-
sessionId
public OpenSslSessionId sessionId()
Description copied from interface:OpenSslInternalSessionReturn theOpenSslSessionIdthat can be used to identify this session.- Specified by:
sessionIdin interfaceOpenSslInternalSession
-
isValid
boolean isValid(long now)
-
setLocalCertificate
public void setLocalCertificate(java.security.cert.Certificate[] localCertificate)
Description copied from interface:OpenSslInternalSessionSet 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:
setLocalCertificatein interfaceOpenSslInternalSession
-
getSessionContext
public OpenSslSessionContext getSessionContext()
- Specified by:
getSessionContextin interfaceOpenSslSession- Specified by:
getSessionContextin interfacejavax.net.ssl.SSLSession
-
tryExpandApplicationBufferSize
public void tryExpandApplicationBufferSize(int packetLengthDataOnly)
Description copied from interface:OpenSslInternalSessionExpand (or increase) the value returned bySSLSession.getApplicationBufferSize()if necessary.This is only called in a synchronized block, so no need to use atomic operations.
- Specified by:
tryExpandApplicationBufferSizein interfaceOpenSslInternalSession- Parameters:
packetLengthDataOnly- The packet size which exceeds the currentSSLSession.getApplicationBufferSize().
-
handshakeFinished
public void handshakeFinished(byte[] id, java.lang.String cipher, java.lang.String protocol, byte[] peerCertificate, byte[][] peerCertificateChain, long creationTime, long timeout)Description copied from interface:OpenSslInternalSessionCalled once the handshake has completed.- Specified by:
handshakeFinishedin interfaceOpenSslInternalSession
-
getId
public byte[] getId()
- Specified by:
getIdin interfacejavax.net.ssl.SSLSession
-
getCreationTime
public long getCreationTime()
- Specified by:
getCreationTimein interfacejavax.net.ssl.SSLSession
-
setLastAccessedTime
public void setLastAccessedTime(long time)
Description copied from interface:OpenSslInternalSessionSet the last access time which will be returned bySSLSession.getLastAccessedTime().- Specified by:
setLastAccessedTimein interfaceOpenSslInternalSession- Parameters:
time- the time
-
getLastAccessedTime
public long getLastAccessedTime()
- Specified by:
getLastAccessedTimein interfacejavax.net.ssl.SSLSession
-
invalidate
public void invalidate()
- Specified by:
invalidatein interfacejavax.net.ssl.SSLSession
-
isValid
public boolean isValid()
- Specified by:
isValidin interfacejavax.net.ssl.SSLSession
-
putValue
public void putValue(java.lang.String name, java.lang.Object value)- Specified by:
putValuein interfacejavax.net.ssl.SSLSession
-
getValue
public java.lang.Object getValue(java.lang.String name)
- Specified by:
getValuein interfacejavax.net.ssl.SSLSession
-
removeValue
public void removeValue(java.lang.String name)
- Specified by:
removeValuein interfacejavax.net.ssl.SSLSession
-
getValueNames
public java.lang.String[] getValueNames()
- Specified by:
getValueNamesin interfacejavax.net.ssl.SSLSession
-
getPeerCertificates
public java.security.cert.Certificate[] getPeerCertificates()
- Specified by:
getPeerCertificatesin interfacejavax.net.ssl.SSLSession
-
hasPeerCertificates
public boolean hasPeerCertificates()
Description copied from interface:OpenSslSessionReturns true if the peer has provided certificates during the handshake.This method is similar to
SSLSession.getPeerCertificates()but it does not throw aSSLPeerUnverifiedExceptionif no certs are provided, making it more efficient to check if a mTLS connection is used.- Specified by:
hasPeerCertificatesin interfaceOpenSslSession- Returns:
- true if peer certificates are available.
-
getLocalCertificates
public java.security.cert.Certificate[] getLocalCertificates()
- Specified by:
getLocalCertificatesin interfacejavax.net.ssl.SSLSession
-
getPeerCertificateChain
public javax.security.cert.X509Certificate[] getPeerCertificateChain()
- Specified by:
getPeerCertificateChainin interfacejavax.net.ssl.SSLSession
-
getPeerPrincipal
public java.security.Principal getPeerPrincipal()
- Specified by:
getPeerPrincipalin interfacejavax.net.ssl.SSLSession
-
getLocalPrincipal
public java.security.Principal getLocalPrincipal()
- Specified by:
getLocalPrincipalin interfacejavax.net.ssl.SSLSession
-
getCipherSuite
public java.lang.String getCipherSuite()
- Specified by:
getCipherSuitein interfacejavax.net.ssl.SSLSession
-
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocolin interfacejavax.net.ssl.SSLSession
-
getPeerHost
public java.lang.String getPeerHost()
- Specified by:
getPeerHostin interfacejavax.net.ssl.SSLSession
-
getPeerPort
public int getPeerPort()
- Specified by:
getPeerPortin interfacejavax.net.ssl.SSLSession
-
getPacketBufferSize
public int getPacketBufferSize()
- Specified by:
getPacketBufferSizein interfacejavax.net.ssl.SSLSession
-
getApplicationBufferSize
public int getApplicationBufferSize()
- Specified by:
getApplicationBufferSizein interfacejavax.net.ssl.SSLSession
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
-