OpenJDK 27 · sun.security.ssl.QuicTLSEngineImpl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final long	BASE_CRYPTO_ERROR
private final TransportContext	conContext
private static final VarHandle	HANDSHAKE_STATE_HANDLE
private final QuicKeyManager.HandshakeKeyManager	handshakeKeyManager
private volatile QuicTLSEngine.HandshakeState	handshakeState
private volatile ByteBuffer	incomingCryptoBuffer
private volatile QuicTLSEngine.KeySpace	incomingCryptoSpace
private final QuicKeyManager.InitialKeyManager	initialKeyManager
private volatile ByteBuffer	localQuicTransportParameters
private static final Map<Byte, QuicTLSEngine.KeySpace>	messageTypeMap
private volatile QuicVersion	negotiatedVersion
private final QuicKeyManager.OneRttKeyManager	oneRttKeyManager
private final String	peerHost
private final int	peerPort
private volatile QuicTransportParametersConsumer	remoteQuicTransportParametersConsumer
private volatile QuicTLSEngine.KeySpace	sendKeySpace
private static final Set<QuicVersion>	SUPPORTED_QUIC_VERSIONS

Access	Constructor and Description
public	QuicTLSEngineImpl(SSLContextImpl sslContextImpl)
public	QuicTLSEngineImpl(SSLContextImpl sslContextImpl, final String peerHost, final int peerPort)

Method Summary

Modifier and Type	Method and Description
public ByteBuffer	computeHeaderProtectionMask(QuicTLSEngine.KeySpace keySpace, boolean incoming, ByteBuffer sample) Implements jdk.internal.net.quic.QuicTLSEngine.computeHeaderProtectionMask. Compute the header protection mask for the given sample, packet key space and direction (incoming/outgoing).
public void	consumeHandshakeBytes(QuicTLSEngine.KeySpace keySpace, ByteBuffer payload) Implements jdk.internal.net.quic.QuicTLSEngine.consumeHandshakeBytes. This method consumes crypto stream.
public void	decryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final int keyPhase, final ByteBuffer packet, final int headerLength, final ByteBuffer output) Implements jdk.internal.net.quic.QuicTLSEngine.decryptPacket. Decrypt the given packet bytes using keys for the given packet key space.
public void	deriveHandshakeKeys()
public void	deriveInitialKeys(final QuicVersion quicVersion, final ByteBuffer connectionId) Implements jdk.internal.net.quic.QuicTLSEngine.deriveInitialKeys. Derive initial keys for the given QUIC version and connection ID
public void	deriveOneRTTKeys()
pack-priv void	deriveOneRTTKeys(final QuicVersion version, final SecretKey client_application_traffic_secret_0, final SecretKey server_application_traffic_secret_0, final CipherSuite negotiatedCipherSuite, final boolean clientMode)
public void	discardKeys(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.discardKeys. Discard the keys used by the `keySpace`.
public void	encryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final IntFunction<ByteBuffer> headerGenerator, final ByteBuffer packetPayload, final ByteBuffer output) Implements jdk.internal.net.quic.QuicTLSEngine.encryptPacket. Encrypt into `output`, the given `packetPayload` bytes using the keys for the given `keySpace`.
pack-priv AlgorithmConstraints	Returns: the `AlgorithmConstraints` that are applicable for this engine, or null if none are applicable getAlgorithmConstraints() Returns the `AlgorithmConstraints` that are applicable for this engine, or null if none are applicable.
public String	getApplicationProtocol() Implements jdk.internal.net.quic.QuicTLSEngine.getApplicationProtocol. Returns the most recent application protocol value negotiated by the engine.
public int	getAuthTagSize() Implements jdk.internal.net.quic.QuicTLSEngine.getAuthTagSize. Get the authentication tag size.
public QuicTLSEngine.KeySpace	Returns: the current sending key space getCurrentSendKeySpace() Implements jdk.internal.net.quic.QuicTLSEngine.getCurrentSendKeySpace. Returns the current sending key space (encryption level)
public Runnable	getDelegatedTask() Implements jdk.internal.net.quic.QuicTLSEngine.getDelegatedTask. Returns a delegated `Runnable` task for this `QuicTLSEngine`.
public ByteBuffer	getHandshakeBytes(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeBytes. If the current handshake state is `HandshakeState#NEED_SEND_CRYPTO` meaning that a CRYPTO frame needs to be sent then this method is called to obtain the contents of the frame.
public SSLSession	getHandshakeSession() Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeSession. Returns the SSLSession being constructed during a QUIC handshake.
public QuicTLSEngine.HandshakeState	Returns: the HandshakeState getHandshakeState() Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeState. Returns the current handshake state of the connection.
public int	getHeaderProtectionSampleSize(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.getHeaderProtectionSampleSize. Get the sample size for header protection algorithm
public byte[]	getLocalQuicTransportParameters()
private QuicVersion	getNegotiatedVersion()
public int	Returns: the key phase being used when decrypting incoming 1-RTT packets getOneRttKeyPhase() Returns the key phase being used when decrypting incoming 1-RTT packets.
public String	getPeerHost() Implements sun.security.ssl.SSLTransport.getPeerHost. Returns the host name of the peer.
public int	getPeerPort() Implements sun.security.ssl.SSLTransport.getPeerPort. Returns the port number of the peer.
public SSLSession	getSession() Implements jdk.internal.net.quic.QuicTLSEngine.getSession. Returns the SSLSession.
public SSLParameters	getSSLParameters() Implements jdk.internal.net.quic.QuicTLSEngine.getSSLParameters. Returns the SSLParameters in effect for this engine.
public Set<QuicVersion>	getSupportedQuicVersions() Implements jdk.internal.net.quic.QuicTLSEngine.getSupportedQuicVersions. Returns the QUIC versions supported by this engine.
public boolean	getUseClientMode() Implements jdk.internal.net.quic.QuicTLSEngine.getUseClientMode. Returns true if this QuicTLSEngine is operating in client mode, false otherwise.
private void	handleHandshakeMessage(QuicTLSEngine.KeySpace keySpace, ByteBuffer message)
private boolean	isEnabled(final QuicVersion quicVersion)
public boolean	isTLSHandshakeComplete() Implements jdk.internal.net.quic.QuicTLSEngine.isTLSHandshakeComplete. Returns true if the TLS handshake is considered complete.
private QuicKeyManager	keyManager(final QuicTLSEngine.KeySpace keySpace)
public boolean	keysAvailable(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.keysAvailable. Checks whether the keys for the given key space are available.
pack-priv void	processRemoteQuicTransportParameters(ByteBuffer buffer)
private byte[]	produceNextHandshakeMessage()
public void	restartHandshake() Implements jdk.internal.net.quic.QuicTLSEngine.restartHandshake. Reset the handshake state and produce a new ClientHello message.
public void	setLocalQuicTransportParameters(ByteBuffer params) Implements jdk.internal.net.quic.QuicTLSEngine.setLocalQuicTransportParameters. Provide quic_transport_parameters for inclusion in handshake message.
public void	setOneRttContext(final QuicOneRttContext ctx) Implements jdk.internal.net.quic.QuicTLSEngine.setOneRttContext. Sets the `QuicOneRttContext` on the `QuicTLSEngine`.
public void	setRemoteQuicTransportParametersConsumer(QuicTransportParametersConsumer consumer) Implements jdk.internal.net.quic.QuicTLSEngine.setRemoteQuicTransportParametersConsumer. Set consumer for quic_transport_parameters sent by the remote side.
public void	setSSLParameters(final SSLParameters params) Implements jdk.internal.net.quic.QuicTLSEngine.setSSLParameters. Sets the `SSLParameters` to be used by this engine
public void	setUseClientMode(boolean mode) Implements jdk.internal.net.quic.QuicTLSEngine.setUseClientMode. If `mode` is `true` then configures this QuicTLSEngine to operate in client mode.
public void	signRetryPacket(final QuicVersion quicVersion, final ByteBuffer originalConnectionId, final ByteBuffer packet, final ByteBuffer output) Implements jdk.internal.net.quic.QuicTLSEngine.signRetryPacket. Sign the provided retry packet.
public boolean	tryMarkHandshakeDone() Implements jdk.internal.net.quic.QuicTLSEngine.tryMarkHandshakeDone. Called to check if a `HANDSHAKE_DONE` frame needs to be sent by the server.
public boolean	tryReceiveHandshakeDone() Implements jdk.internal.net.quic.QuicTLSEngine.tryReceiveHandshakeDone. Called when HANDSHAKE_DONE message is received from the server.
public boolean	useDelegatedTask() Implements sun.security.ssl.SSLTransport.useDelegatedTask. Return true if delegated tasks used for handshaking operations.
public void	verifyRetryPacket(final QuicVersion quicVersion, final ByteBuffer originalConnectionId, final ByteBuffer packet) Implements jdk.internal.net.quic.QuicTLSEngine.verifyRetryPacket. Verify the provided retry packet.
public void	versionNegotiated(final QuicVersion quicVersion) Implements jdk.internal.net.quic.QuicTLSEngine.versionNegotiated. Called when the client and the server, during the connection creation handshake, have settled on a Quic version to use for the connection.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

BASE_CRYPTO_ERROR	back to summary
pack-priv static final long BASE_CRYPTO_ERROR

conContext	back to summary
private final TransportContext conContext

HANDSHAKE_STATE_HANDLE	back to summary
private static final VarHandle HANDSHAKE_STATE_HANDLE

handshakeKeyManager	back to summary
private final QuicKeyManager.HandshakeKeyManager handshakeKeyManager

handshakeState	back to summary
private volatile QuicTLSEngine.HandshakeState handshakeState

incomingCryptoBuffer	back to summary
private volatile ByteBuffer incomingCryptoBuffer

incomingCryptoSpace	back to summary
private volatile QuicTLSEngine.KeySpace incomingCryptoSpace

initialKeyManager	back to summary
private final QuicKeyManager.InitialKeyManager initialKeyManager

localQuicTransportParameters	back to summary
private volatile ByteBuffer localQuicTransportParameters

messageTypeMap	back to summary
private static final Map<Byte, QuicTLSEngine.KeySpace> messageTypeMap

negotiatedVersion	back to summary
private volatile QuicVersion negotiatedVersion

oneRttKeyManager	back to summary
private final QuicKeyManager.OneRttKeyManager oneRttKeyManager

peerHost	back to summary
private final String peerHost

peerPort	back to summary
private final int peerPort

remoteQuicTransportParametersConsumer	back to summary
private volatile QuicTransportParametersConsumer remoteQuicTransportParametersConsumer

sendKeySpace	back to summary
private volatile QuicTLSEngine.KeySpace sendKeySpace

SUPPORTED_QUIC_VERSIONS	back to summary
private static final Set<QuicVersion> SUPPORTED_QUIC_VERSIONS

QuicTLSEngineImpl	back to summary
public QuicTLSEngineImpl(SSLContextImpl sslContextImpl)

QuicTLSEngineImpl	back to summary
public QuicTLSEngineImpl(SSLContextImpl sslContextImpl, final String peerHost, final int peerPort)

Method Detail

computeHeaderProtectionMask	back to summary
public ByteBuffer computeHeaderProtectionMask(QuicTLSEngine.KeySpace keySpace, boolean incoming, ByteBuffer sample) throws QuicKeyUnavailableException, QuicTransportException Implements jdk.internal.net.quic.QuicTLSEngine.computeHeaderProtectionMask. Doc from jdk.internal.net.quic.QuicTLSEngine.computeHeaderProtectionMask. Compute the header protection mask for the given sample, packet key space and direction (incoming/outgoing). Annotations @Override

computeHeaderProtectionMask

back to summary

public ByteBuffer computeHeaderProtectionMask(QuicTLSEngine.KeySpace keySpace, boolean incoming, ByteBuffer sample) throws QuicKeyUnavailableException, QuicTransportException

Implements jdk.internal.net.quic.QuicTLSEngine.computeHeaderProtectionMask.

Doc from jdk.internal.net.quic.QuicTLSEngine.computeHeaderProtectionMask.

Compute the header protection mask for the given sample, packet key space and direction (incoming/outgoing).

Annotations

@Override

consumeHandshakeBytes	back to summary
public void consumeHandshakeBytes(QuicTLSEngine.KeySpace keySpace, ByteBuffer payload) throws QuicTransportException Implements jdk.internal.net.quic.QuicTLSEngine.consumeHandshakeBytes. Doc from jdk.internal.net.quic.QuicTLSEngine.consumeHandshakeBytes. This method consumes crypto stream. Annotations @Override Exceptions QuicTransportException: if the handshake failed

consumeHandshakeBytes

back to summary

public void consumeHandshakeBytes(QuicTLSEngine.KeySpace keySpace, ByteBuffer payload) throws QuicTransportException

Implements jdk.internal.net.quic.QuicTLSEngine.consumeHandshakeBytes.

Doc from jdk.internal.net.quic.QuicTLSEngine.consumeHandshakeBytes.

This method consumes crypto stream.

Annotations

@Override

Exceptions

QuicTransportException:: if the handshake failed

decryptPacket back to summary

decryptPacket	back to summary
public void decryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final int keyPhase, final ByteBuffer packet, final int headerLength, final ByteBuffer output) throws QuicKeyUnavailableException, AEADBadTagException, QuicTransportException, ShortBufferException Implements jdk.internal.net.quic.QuicTLSEngine.decryptPacket. Doc from jdk.internal.net.quic.QuicTLSEngine.decryptPacket. Decrypt the given packet bytes using keys for the given packet key space. Header protection must be removed before calling this method. The input buffer contains the packet header and the encrypted packet payload. The packet header (first `headerLength` bytes of the input buffer) is consumed by this method, but is not decrypted. The packet payload (bytes following the packet header) is decrypted by this method. This method consumes the entire input buffer. The decrypted payload bytes are written to the output buffer. It is recommended to do the decryption in place by using slices of a bigger buffer as the input and output buffer: +--------+-------------------+----------+ input: \| header \| encrypted payload \| AEAD tag \| +--------+-------------------+----------+ output: \| decrypted payload \| +-------------------+ Annotations @Override Exceptions QuicKeyUnavailableException: if keys are not available AEADBadTagException: if the provided packet's authentication tag is incorrect QuicTransportException: if decrypting the invalid packet resulted in exceeding the AEAD cipher integrity limit

public void decryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final int keyPhase, final ByteBuffer packet, final int headerLength, final ByteBuffer output) throws QuicKeyUnavailableException, AEADBadTagException, QuicTransportException, ShortBufferException

Implements jdk.internal.net.quic.QuicTLSEngine.decryptPacket.

Doc from jdk.internal.net.quic.QuicTLSEngine.decryptPacket.

Decrypt the given packet bytes using keys for the given packet key space. Header protection must be removed before calling this method.

The input buffer contains the packet header and the encrypted packet payload. The packet header (first headerLength bytes of the input buffer) is consumed by this method, but is not decrypted. The packet payload (bytes following the packet header) is decrypted by this method. This method consumes the entire input buffer.

The decrypted payload bytes are written to the output buffer.

It is recommended to do the decryption in place by using slices of a bigger buffer as the input and output buffer:

         +--------+-------------------+----------+
input:   | header | encrypted payload | AEAD tag |
         +--------+-------------------+----------+
output:           | decrypted payload |
                  +-------------------+

Annotations

@Override

Exceptions

QuicKeyUnavailableException:: if keys are not available
AEADBadTagException:: if the provided packet's authentication tag is incorrect
QuicTransportException:: if decrypting the invalid packet resulted in exceeding the AEAD cipher integrity limit

deriveHandshakeKeys	back to summary
public void deriveHandshakeKeys() throws IOException

deriveInitialKeys	back to summary
public void deriveInitialKeys(final QuicVersion quicVersion, final ByteBuffer connectionId) throws IOException Implements jdk.internal.net.quic.QuicTLSEngine.deriveInitialKeys. Doc from jdk.internal.net.quic.QuicTLSEngine.deriveInitialKeys. Derive initial keys for the given QUIC version and connection ID Annotations @Override

deriveInitialKeys

back to summary

public void deriveInitialKeys(final QuicVersion quicVersion, final ByteBuffer connectionId) throws IOException

Implements jdk.internal.net.quic.QuicTLSEngine.deriveInitialKeys.

Doc from jdk.internal.net.quic.QuicTLSEngine.deriveInitialKeys.

Derive initial keys for the given QUIC version and connection ID

Annotations

@Override

deriveOneRTTKeys	back to summary
public void deriveOneRTTKeys() throws IOException

deriveOneRTTKeys	back to summary
pack-priv void deriveOneRTTKeys(final QuicVersion version, final SecretKey client_application_traffic_secret_0, final SecretKey server_application_traffic_secret_0, final CipherSuite negotiatedCipherSuite, final boolean clientMode) throws IOException, GeneralSecurityException

discardKeys back to summary

discardKeys	back to summary
public void discardKeys(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.discardKeys. Doc from jdk.internal.net.quic.QuicTLSEngine.discardKeys. Discard the keys used by the `keySpace`. Once the keys for a particular `keySpace` have been discarded, the keySpace will no longer be able to encrypt or decrypt packets. Annotations @Override

public void discardKeys(QuicTLSEngine.KeySpace keySpace)

Implements jdk.internal.net.quic.QuicTLSEngine.discardKeys.

Doc from jdk.internal.net.quic.QuicTLSEngine.discardKeys.

Discard the keys used by the keySpace.

Once the keys for a particular keySpace have been discarded, the keySpace will no longer be able to encrypt or decrypt packets.

Annotations

@Override

encryptPacket back to summary

encryptPacket	back to summary
public void encryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final IntFunction<ByteBuffer> headerGenerator, final ByteBuffer packetPayload, final ByteBuffer output) throws QuicKeyUnavailableException, QuicTransportException, ShortBufferException Implements jdk.internal.net.quic.QuicTLSEngine.encryptPacket. Doc from jdk.internal.net.quic.QuicTLSEngine.encryptPacket. Encrypt into `output`, the given `packetPayload` bytes using the keys for the given `keySpace`. Before encrypting the `packetPayload`, this method invokes the `headerGenerator` passing it the key phase corresponding to the encryption key that's in use. For `KeySpace`s where key phase isn't applicable, the `headerGenerator` will be invoked with a value of `0` for the key phase. The `headerGenerator` is expected to return a `ByteBuffer` representing the packet header and where applicable, the returned header must contain the key phase that was passed to the `headerGenerator`. The packet header will be used as the Additional Authentication Data (AAD) for encrypting the `packetPayload`. Upon return, the `output` will contain the encrypted packet payload bytes and the authentication tag. The `packetPayload` and the packet header, returned by the `headerGenerator`, will have their `position` equal to their `limit`. The limit of either of those buffers will not have changed. It is recommended to do the encryption in place by using slices of a bigger buffer as the input and output buffer: +--------+-------------------+ input: \| header \| plaintext payload \| +--------+-------------------+----------+ output: \| encrypted payload \| AEAD tag \| +-------------------+----------+ Annotations @Override Exceptions QuicKeyUnavailableException: if keys are not available QuicTransportException: if encrypting the packet would result in exceeding the AEAD cipher confidentiality limit

public void encryptPacket(final QuicTLSEngine.KeySpace keySpace, final long packetNumber, final IntFunction<ByteBuffer> headerGenerator, final ByteBuffer packetPayload, final ByteBuffer output) throws QuicKeyUnavailableException, QuicTransportException, ShortBufferException

Implements jdk.internal.net.quic.QuicTLSEngine.encryptPacket.

Doc from jdk.internal.net.quic.QuicTLSEngine.encryptPacket.

Encrypt into output, the given packetPayload bytes using the keys for the given keySpace.

Before encrypting the packetPayload, this method invokes the headerGenerator passing it the key phase corresponding to the encryption key that's in use. For KeySpaces where key phase isn't applicable, the headerGenerator will be invoked with a value of 0 for the key phase.

The headerGenerator is expected to return a ByteBuffer representing the packet header and where applicable, the returned header must contain the key phase that was passed to the headerGenerator. The packet header will be used as the Additional Authentication Data (AAD) for encrypting the packetPayload.

Upon return, the output will contain the encrypted packet payload bytes and the authentication tag. The packetPayload and the packet header, returned by the headerGenerator, will have their position equal to their limit. The limit of either of those buffers will not have changed.

It is recommended to do the encryption in place by using slices of a bigger buffer as the input and output buffer:

         +--------+-------------------+
input:   | header | plaintext payload |
         +--------+-------------------+----------+
output:           | encrypted payload | AEAD tag |
                  +-------------------+----------+

Annotations

@Override

Exceptions

QuicKeyUnavailableException:: if keys are not available
QuicTransportException:: if encrypting the packet would result in exceeding the AEAD cipher confidentiality limit

getAlgorithmConstraints back to summary

getAlgorithmConstraints	back to summary
pack-priv AlgorithmConstraints getAlgorithmConstraints() Returns the `AlgorithmConstraints` that are applicable for this engine, or null if none are applicable. Returns:AlgorithmConstraints the `AlgorithmConstraints` that are applicable for this engine, or null if none are applicable

pack-priv AlgorithmConstraints getAlgorithmConstraints()

Returns the AlgorithmConstraints that are applicable for this engine, or null if none are applicable.

Returns:AlgorithmConstraints: the AlgorithmConstraints that are applicable for this engine, or null if none are applicable

getApplicationProtocol	back to summary
public String getApplicationProtocol() Implements jdk.internal.net.quic.QuicTLSEngine.getApplicationProtocol. Doc from jdk.internal.net.quic.QuicTLSEngine.getApplicationProtocol. Returns the most recent application protocol value negotiated by the engine. Returns null if no application protocol has yet been negotiated by the engine. Annotations @Override

getApplicationProtocol

back to summary

public String getApplicationProtocol()

Implements jdk.internal.net.quic.QuicTLSEngine.getApplicationProtocol.

Doc from jdk.internal.net.quic.QuicTLSEngine.getApplicationProtocol.

Returns the most recent application protocol value negotiated by the engine. Returns null if no application protocol has yet been negotiated by the engine.

Annotations

@Override

getAuthTagSize	back to summary
public int getAuthTagSize() Implements jdk.internal.net.quic.QuicTLSEngine.getAuthTagSize. Doc from jdk.internal.net.quic.QuicTLSEngine.getAuthTagSize. Get the authentication tag size. Encryption adds this number of bytes. Annotations @Override

getAuthTagSize

back to summary

public int getAuthTagSize()

Implements jdk.internal.net.quic.QuicTLSEngine.getAuthTagSize.

Doc from jdk.internal.net.quic.QuicTLSEngine.getAuthTagSize.

Get the authentication tag size. Encryption adds this number of bytes.

Annotations

@Override

getCurrentSendKeySpace	back to summary
public QuicTLSEngine.KeySpace getCurrentSendKeySpace() Implements jdk.internal.net.quic.QuicTLSEngine.getCurrentSendKeySpace. Returns the current sending key space (encryption level) Returns:QuicTLSEngine.KeySpace the current sending key space Annotations @Override

getCurrentSendKeySpace

back to summary

public QuicTLSEngine.KeySpace getCurrentSendKeySpace()

Implements jdk.internal.net.quic.QuicTLSEngine.getCurrentSendKeySpace.

Returns the current sending key space (encryption level)

Returns:QuicTLSEngine.KeySpace

the current sending key space

Annotations

@Override

getDelegatedTask back to summary

getDelegatedTask	back to summary
public Runnable getDelegatedTask() Implements jdk.internal.net.quic.QuicTLSEngine.getDelegatedTask. Doc from jdk.internal.net.quic.QuicTLSEngine.getDelegatedTask. Returns a delegated `Runnable` task for this `QuicTLSEngine`. `QuicTLSEngine` operations may require the results of operations that block, or may take an extended period of time to complete. This method is used to obtain an outstanding `java.lang.Runnable` operation (task). Each task must be assigned a thread (possibly the current) to perform the `run` operation. Once the `run` method returns, the `Runnable` object is no longer needed and may be discarded. A call to this method will return each outstanding task exactly once. Multiple delegated tasks can be run in parallel. Annotations @Override

public Runnable getDelegatedTask()

Implements jdk.internal.net.quic.QuicTLSEngine.getDelegatedTask.

Doc from jdk.internal.net.quic.QuicTLSEngine.getDelegatedTask.

Returns a delegated Runnable task for this QuicTLSEngine.

QuicTLSEngine operations may require the results of operations that block, or may take an extended period of time to complete. This method is used to obtain an outstanding java.lang.Runnable operation (task). Each task must be assigned a thread (possibly the current) to perform the run operation. Once the run method returns, the Runnable object is no longer needed and may be discarded.

A call to this method will return each outstanding task exactly once.

Multiple delegated tasks can be run in parallel.

Annotations

@Override

getHandshakeBytes back to summary

getHandshakeBytes	back to summary
public ByteBuffer getHandshakeBytes(QuicTLSEngine.KeySpace keySpace) throws IOException Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeBytes. Doc from jdk.internal.net.quic.QuicTLSEngine.getHandshakeBytes. If the current handshake state is `HandshakeState#NEED_SEND_CRYPTO` meaning that a CRYPTO frame needs to be sent then this method is called to obtain the contents of the frame. Current handshake state can be obtained from `getHandshakeState()`, and the current key space can be obtained with `getCurrentSendKeySpace()` The bytes returned by this call are used to build a CRYPTO frame. Annotations @Override

public ByteBuffer getHandshakeBytes(QuicTLSEngine.KeySpace keySpace) throws IOException

Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeBytes.

Doc from jdk.internal.net.quic.QuicTLSEngine.getHandshakeBytes.

If the current handshake state is HandshakeState#NEED_SEND_CRYPTO meaning that a CRYPTO frame needs to be sent then this method is called to obtain the contents of the frame. Current handshake state can be obtained from getHandshakeState(), and the current key space can be obtained with getCurrentSendKeySpace() The bytes returned by this call are used to build a CRYPTO frame.

Annotations

@Override

getHandshakeSession	back to summary
public SSLSession getHandshakeSession() Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeSession. Doc from jdk.internal.net.quic.QuicTLSEngine.getHandshakeSession. Returns the SSLSession being constructed during a QUIC handshake. Annotations @Override

getHandshakeSession

back to summary

public SSLSession getHandshakeSession()

Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeSession.

Doc from jdk.internal.net.quic.QuicTLSEngine.getHandshakeSession.

Returns the SSLSession being constructed during a QUIC handshake.

Annotations

@Override

getHandshakeState	back to summary
public QuicTLSEngine.HandshakeState getHandshakeState() Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeState. Returns the current handshake state of the connection. Sometimes packets that could be decrypted can be received before the handshake has completed, but should not be decrypted until it is complete Returns:QuicTLSEngine.HandshakeState the HandshakeState Annotations @Override

getHandshakeState

back to summary

public QuicTLSEngine.HandshakeState getHandshakeState()

Implements jdk.internal.net.quic.QuicTLSEngine.getHandshakeState.

Returns the current handshake state of the connection. Sometimes packets that could be decrypted can be received before the handshake has completed, but should not be decrypted until it is complete

Returns:QuicTLSEngine.HandshakeState

the HandshakeState

Annotations

@Override

getHeaderProtectionSampleSize	back to summary
public int getHeaderProtectionSampleSize(QuicTLSEngine.KeySpace keySpace) Implements jdk.internal.net.quic.QuicTLSEngine.getHeaderProtectionSampleSize. Doc from jdk.internal.net.quic.QuicTLSEngine.getHeaderProtectionSampleSize. Get the sample size for header protection algorithm Annotations @Override

getHeaderProtectionSampleSize

back to summary

public int getHeaderProtectionSampleSize(QuicTLSEngine.KeySpace keySpace)

Implements jdk.internal.net.quic.QuicTLSEngine.getHeaderProtectionSampleSize.

Doc from jdk.internal.net.quic.QuicTLSEngine.getHeaderProtectionSampleSize.

Get the sample size for header protection algorithm

Annotations

@Override

getLocalQuicTransportParameters	back to summary
public byte[] getLocalQuicTransportParameters()

getNegotiatedVersion	back to summary
private QuicVersion getNegotiatedVersion()

getOneRttKeyPhase	back to summary
public int getOneRttKeyPhase() throws QuicKeyUnavailableException Returns the key phase being used when decrypting incoming 1-RTT packets. Returns:int the key phase being used when decrypting incoming 1-RTT packets

getOneRttKeyPhase

back to summary

public int getOneRttKeyPhase() throws QuicKeyUnavailableException

Returns the key phase being used when decrypting incoming 1-RTT packets.

Returns:int: the key phase being used when decrypting incoming 1-RTT packets

getPeerHost	back to summary
public String getPeerHost() Implements sun.security.ssl.SSLTransport.getPeerHost. Doc from sun.security.ssl.SSLTransport.getPeerHost. Returns the host name of the peer. Annotations @Override

getPeerHost

back to summary

public String getPeerHost()

Implements sun.security.ssl.SSLTransport.getPeerHost.

Doc from sun.security.ssl.SSLTransport.getPeerHost.

Returns the host name of the peer.

Annotations

@Override

getPeerPort	back to summary
public int getPeerPort() Implements sun.security.ssl.SSLTransport.getPeerPort. Doc from sun.security.ssl.SSLTransport.getPeerPort. Returns the port number of the peer. Annotations @Override

getPeerPort

back to summary

public int getPeerPort()

Implements sun.security.ssl.SSLTransport.getPeerPort.

Doc from sun.security.ssl.SSLTransport.getPeerPort.

Returns the port number of the peer.

Annotations

@Override

getSession	back to summary
public SSLSession getSession() Implements jdk.internal.net.quic.QuicTLSEngine.getSession. Doc from jdk.internal.net.quic.QuicTLSEngine.getSession. Returns the SSLSession. Annotations @Override

getSession

back to summary

public SSLSession getSession()

Implements jdk.internal.net.quic.QuicTLSEngine.getSession.

Doc from jdk.internal.net.quic.QuicTLSEngine.getSession.

Returns the SSLSession.

Annotations

@Override

getSSLParameters	back to summary
public SSLParameters getSSLParameters() Implements jdk.internal.net.quic.QuicTLSEngine.getSSLParameters. Doc from jdk.internal.net.quic.QuicTLSEngine.getSSLParameters. Returns the SSLParameters in effect for this engine. Annotations @Override

getSSLParameters

back to summary

public SSLParameters getSSLParameters()

Implements jdk.internal.net.quic.QuicTLSEngine.getSSLParameters.

Doc from jdk.internal.net.quic.QuicTLSEngine.getSSLParameters.

Returns the SSLParameters in effect for this engine.

Annotations

@Override

getSupportedQuicVersions	back to summary
public Set<QuicVersion> getSupportedQuicVersions() Implements jdk.internal.net.quic.QuicTLSEngine.getSupportedQuicVersions. Doc from jdk.internal.net.quic.QuicTLSEngine.getSupportedQuicVersions. Returns the QUIC versions supported by this engine. Annotations @Override

getSupportedQuicVersions

back to summary

public Set<QuicVersion> getSupportedQuicVersions()

Implements jdk.internal.net.quic.QuicTLSEngine.getSupportedQuicVersions.

Doc from jdk.internal.net.quic.QuicTLSEngine.getSupportedQuicVersions.

Returns the QUIC versions supported by this engine.

Annotations

@Override

getUseClientMode	back to summary
public boolean getUseClientMode() Implements jdk.internal.net.quic.QuicTLSEngine.getUseClientMode. Doc from jdk.internal.net.quic.QuicTLSEngine.getUseClientMode. Returns true if this QuicTLSEngine is operating in client mode, false otherwise. Annotations @Override

getUseClientMode

back to summary

public boolean getUseClientMode()

Implements jdk.internal.net.quic.QuicTLSEngine.getUseClientMode.

Doc from jdk.internal.net.quic.QuicTLSEngine.getUseClientMode.

Returns true if this QuicTLSEngine is operating in client mode, false otherwise.

Annotations

@Override

handleHandshakeMessage	back to summary
private void handleHandshakeMessage(QuicTLSEngine.KeySpace keySpace, ByteBuffer message) throws QuicTransportException

isEnabled	back to summary
private boolean isEnabled(final QuicVersion quicVersion)

isTLSHandshakeComplete back to summary

public boolean isTLSHandshakeComplete()

Implements jdk.internal.net.quic.QuicTLSEngine.isTLSHandshakeComplete.

Doc from jdk.internal.net.quic.QuicTLSEngine.isTLSHandshakeComplete.

Returns true if the TLS handshake is considered complete.

The TLS handshake is considered complete when the TLS stack has reported that the handshake is complete. This happens when the TLS stack has both sent a Finished message and verified the peer's Finished message.

Annotations

@Override

keyManager	back to summary
private QuicKeyManager keyManager(final QuicTLSEngine.KeySpace keySpace)

keysAvailable

back to summary

public boolean keysAvailable(QuicTLSEngine.KeySpace keySpace)

Implements jdk.internal.net.quic.QuicTLSEngine.keysAvailable.

Doc from jdk.internal.net.quic.QuicTLSEngine.keysAvailable.

Checks whether the keys for the given key space are available.

Keys are available when they are already computed and not discarded yet.

Annotations

@Override

processRemoteQuicTransportParameters	back to summary
pack-priv void processRemoteQuicTransportParameters(ByteBuffer buffer) throws QuicTransportException

produceNextHandshakeMessage	back to summary
private byte[] produceNextHandshakeMessage() throws IOException

restartHandshake

back to summary

public void restartHandshake() throws IOException

Implements jdk.internal.net.quic.QuicTLSEngine.restartHandshake.

Doc from jdk.internal.net.quic.QuicTLSEngine.restartHandshake.

Reset the handshake state and produce a new ClientHello message. When a Quic client receives a Version Negotiation packet, it restarts the handshake by calling this method after updating the transport parameters with the new version information.

Annotations

@Override

setLocalQuicTransportParameters

back to summary

public void setLocalQuicTransportParameters(ByteBuffer params)

Implements jdk.internal.net.quic.QuicTLSEngine.setLocalQuicTransportParameters.

Doc from jdk.internal.net.quic.QuicTLSEngine.setLocalQuicTransportParameters.

Provide quic_transport_parameters for inclusion in handshake message.

Annotations

@Override

setOneRttContext back to summary

public void setOneRttContext(final QuicOneRttContext ctx)

Implements jdk.internal.net.quic.QuicTLSEngine.setOneRttContext.

Doc from jdk.internal.net.quic.QuicTLSEngine.setOneRttContext.

Sets the QuicOneRttContext on the QuicTLSEngine.

The ctx will be used by the QuicTLSEngine to access contextual 1-RTT data that might be required for the TLS operations.

Annotations

@Override

setRemoteQuicTransportParametersConsumer

back to summary

public void setRemoteQuicTransportParametersConsumer(QuicTransportParametersConsumer consumer)

Implements jdk.internal.net.quic.QuicTLSEngine.setRemoteQuicTransportParametersConsumer.

Doc from jdk.internal.net.quic.QuicTLSEngine.setRemoteQuicTransportParametersConsumer.

Set consumer for quic_transport_parameters sent by the remote side. Consumer will receive a byte buffer containing the value of quic_transport_parameters extension sent by the remote endpoint.

Annotations

@Override

setSSLParameters back to summary

public void setSSLParameters(final SSLParameters params)

Implements jdk.internal.net.quic.QuicTLSEngine.setSSLParameters.

Doc from jdk.internal.net.quic.QuicTLSEngine.setSSLParameters.

Sets the SSLParameters to be used by this engine

Annotations

@Override

setUseClientMode back to summary

public void setUseClientMode(boolean mode)

Implements jdk.internal.net.quic.QuicTLSEngine.setUseClientMode.

Doc from jdk.internal.net.quic.QuicTLSEngine.setUseClientMode.

If mode is true then configures this QuicTLSEngine to operate in client mode. If false, then this QuicTLSEngine operates in server mode.

Annotations

@Override

signRetryPacket

back to summary

public void signRetryPacket(final QuicVersion quicVersion, final ByteBuffer originalConnectionId, final ByteBuffer packet, final ByteBuffer output) throws ShortBufferException, QuicTransportException

Implements jdk.internal.net.quic.QuicTLSEngine.signRetryPacket.

Doc from jdk.internal.net.quic.QuicTLSEngine.signRetryPacket.

Sign the provided retry packet. Input buffer contains the retry packet payload. Integrity tag is stored in the output buffer.

Annotations

@Override

Exceptions

ShortBufferException:: if output buffer is too short to hold the tag

tryMarkHandshakeDone back to summary

public boolean tryMarkHandshakeDone()

Implements jdk.internal.net.quic.QuicTLSEngine.tryMarkHandshakeDone.

Doc from jdk.internal.net.quic.QuicTLSEngine.tryMarkHandshakeDone.

Called to check if a HANDSHAKE_DONE frame needs to be sent by the server. This method will only be called for a QuicTLSEngine which is in server mode. If the current TLS handshake state is NEED_SEND_HANDSHAKE_DONE then this method returns true and advances the TLS handshake state to HANDSHAKE_CONFIRMED. Else returns false.

Annotations

@Override

tryReceiveHandshakeDone back to summary

public boolean tryReceiveHandshakeDone()

Implements jdk.internal.net.quic.QuicTLSEngine.tryReceiveHandshakeDone.

Doc from jdk.internal.net.quic.QuicTLSEngine.tryReceiveHandshakeDone.

Called when HANDSHAKE_DONE message is received from the server. This method will only be called for a QuicTLSEngine which is in client mode. If the current TLS handshake state is NEED_RECV_HANDSHAKE_DONE then this method returns true and advances the TLS handshake state to HANDSHAKE_CONFIRMED. Else returns false.

Annotations

@Override

useDelegatedTask

back to summary

public boolean useDelegatedTask()

Implements sun.security.ssl.SSLTransport.useDelegatedTask.

Doc from sun.security.ssl.SSLTransport.useDelegatedTask.

Return true if delegated tasks used for handshaking operations.

Annotations

@Override

verifyRetryPacket

back to summary

public void verifyRetryPacket(final QuicVersion quicVersion, final ByteBuffer originalConnectionId, final ByteBuffer packet) throws AEADBadTagException, QuicTransportException

Implements jdk.internal.net.quic.QuicTLSEngine.verifyRetryPacket.

Doc from jdk.internal.net.quic.QuicTLSEngine.verifyRetryPacket.

Verify the provided retry packet.

Annotations

@Override

Exceptions

AEADBadTagException:: if integrity tag is invalid

versionNegotiated

back to summary

public void versionNegotiated(final QuicVersion quicVersion)

Implements jdk.internal.net.quic.QuicTLSEngine.versionNegotiated.

Doc from jdk.internal.net.quic.QuicTLSEngine.versionNegotiated.

Called when the client and the server, during the connection creation handshake, have settled on a Quic version to use for the connection. This can happen either due to an explicit version negotiation (as outlined in Quic RFC) or the server accepting the Quic version that the client chose in its first INITIAL packet. In either of those cases, this method will be called.

Annotations

@Override

public final Class QuicTLSEngineImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail