Class InsecureQuicTokenHandler

java.lang.Object

io.netty.handler.codec.quic.InsecureQuicTokenHandler

All Implemented Interfaces:

QuicTokenHandler

public final class InsecureQuicTokenHandler
extends Object
implements QuicTokenHandler

Insecure QuicTokenHandler which only does basic token generation / validation without any crypto. This shouldn't be used in production.

Nested Class Summary

Nested classes/interfaces inherited from interface QuicTokenHandler

QuicTokenHandler.TokenValidationResult

Modifier and Type	Interface	Description
static final class	QuicTokenHandler.TokenValidationResult	The result of a token validation.

Field Summary

Fields

Modifier and Type	Field	Description
static final InsecureQuicTokenHandler	INSTANCE

Method Summary

Modifier and Type	Method	Description
int	maxTokenLength()	Return the maximal token length.
int	validateToken(ByteBuf token, InetSocketAddress address)	Validate the token and return the offset, -1 is returned if the token is not valid.
boolean	writeToken(ByteBuf out, ByteBuf dcid, InetSocketAddress address)	Generate a new token for the given destination connection id and address.

Methods inherited from class Object

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

Methods inherited from interface QuicTokenHandler

validateToken

Modifier and Type	Method	Description
default QuicTokenHandler.TokenValidationResult	validateToken(ByteBuf token, InetSocketAddress address, ByteBuf dcid)	Validate the token and return a structured result that determines how the ODCID should be derived.

Field Details

INSTANCE

public static final InsecureQuicTokenHandler INSTANCE

Method Details

writeToken

public boolean writeToken(ByteBuf out,
 ByteBuf dcid,
 InetSocketAddress address)

Description copied from interface: QuicTokenHandler

Generate a new token for the given destination connection id and address. This token is written to out. If no token should be generated and so no token validation should take place at all this method should return false.

Specified by:

writeToken in interface QuicTokenHandler

Parameters:

out - ByteBuf into which the token will be written.

dcid - the destination connection id. The ByteBuf.readableBytes() will be at most Quic.MAX_CONN_ID_LEN.

address - the InetSocketAddress of the sender.

Returns:

true if a token was written and so validation should happen, false otherwise.

validateToken

public int validateToken(ByteBuf token,
 InetSocketAddress address)

Description copied from interface: QuicTokenHandler

Validate the token and return the offset, -1 is returned if the token is not valid. The returned offset identifies where the ODCID starts in the token. Implementations that support tokens from NEW_TOKEN frames should override QuicTokenHandler.validateToken(ByteBuf, InetSocketAddress, ByteBuf).

Specified by:

validateToken in interface QuicTokenHandler

Parameters:

token - the ByteBuf that contains the token. The caller retains ownership of the buffer: implementations must not release it and must retain, duplicate or copy it before using it after this method returns.

address - the InetSocketAddress of the sender.

Returns:

the start index after the token or -1 if the token was not valid.

maxTokenLength

public int maxTokenLength()

Description copied from interface: QuicTokenHandler

Return the maximal token length.

Specified by:

maxTokenLength in interface QuicTokenHandler

Returns:

the maximal supported token length.