Package moe.kyokobot.koe.internal.crypto

Interface EncryptionMode

All Known Implementing Classes:

AEADAES256GCMEncryptionMode, AEADAES256GCMRTPSizeEncryptionMode, AEADXChaCha20Poly1305RTPSizeEncryptionMode, PlainEncryptionMode, XSalsa20Poly1305EncryptionMode, XSalsa20Poly1305LiteEncryptionMode, XSalsa20Poly1305LiteRTPSizeEncryptionMode, XSalsa20Poly1305SuffixEncryptionMode

public interface EncryptionMode

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SECRET_KEY_LENGTH
static final SecureRandom	SECURE_RANDOM
static final int	TAG_BYTES_LENGTH

Method Summary

Modifier and Type	Method	Description
boolean	box(io.netty.buffer.ByteBuf plain, int len, io.netty.buffer.ByteBuf output, byte[] secretKey)	Encrypts len bytes of plain into output, which already holds the unencrypted part of the RTP header.
static EncryptionMode	get(String mode)
String	getName()
default boolean	isRtpSize()
static String	select(List<String> offered, CipherPreferencePolicy policy)
static Set<String>	supportedModes()
default void	validateKey(byte[] secretKey)	Checks the key once per session, box(io.netty.buffer.ByteBuf, int, io.netty.buffer.ByteBuf, byte[]) assumes it was validated.

Field Details

SECURE_RANDOM

static final SecureRandom SECURE_RANDOM

TAG_BYTES_LENGTH

static final int TAG_BYTES_LENGTH

See Also:

• Constant Field Values

SECRET_KEY_LENGTH

static final int SECRET_KEY_LENGTH

See Also:

• Constant Field Values

Method Details

validateKey

default void validateKey(byte[] secretKey)

Checks the key once per session, box(io.netty.buffer.ByteBuf, int, io.netty.buffer.ByteBuf, byte[]) assumes it was validated.

Throws:

IllegalArgumentException - if the key can't be used with this mode

box

boolean box(io.netty.buffer.ByteBuf plain,
 int len,
 io.netty.buffer.ByteBuf output,
 byte[] secretKey)

Encrypts len bytes of plain into output, which already holds the unencrypted part of the RTP header.

isRtpSize

default boolean isRtpSize()

Returns:

true if the header extension preamble is part of the unencrypted RTP header, false if it is encrypted along with the payload

getName

String getName()

select

static String select(List<String> offered,
 CipherPreferencePolicy policy)
              throws UnsupportedEncryptionModeException

Parameters:

offered - modes offered by the voice server

Returns:

the mode picked by the policy

Throws:

UnsupportedEncryptionModeException - if the policy picked nothing, or a mode that isn't both offered and supported

supportedModes

static Set<String> supportedModes()

get

static EncryptionMode get(String mode)