core/crypto/aead

aead

Types

Algorithm :: enum int {
	Invalid           = 0,
	AES_GCM_128       = 1,
	AES_GCM_192       = 2,
	AES_GCM_256       = 3,
	CHACHA20POLY1305  = 4,
	XCHACHA20POLY1305 = 5,
	AEGIS_128L        = 6,
	AEGIS_128L_256    = 7, // AEGIS-128L (256-bit tag)
	AEGIS_256         = 8,
	AEGIS_256_256     = 9, // AEGIS-256 (256-bit tag)
	DEOXYS_II_256     = 10,
}

Source

Algorithm is the algorithm identifier associated with a given Context.

Context :: struct {
	_algo: Algorithm,
	_impl: union {
		aes.Context_GCM,
		chacha20poly1305.Context,
		aegis.Context,
		deoxysii.Context,
	},
}

Source

Context is a concrete instantiation of a specific AEAD algorithm.

Implementation :: union {
	aes.Implementation,
	chacha20.Implementation,
}

Source

Implementation is an AEAD implementation. Most callers will not need to use this as the package will automatically select the most performant implementation available.

Constants

MAX_TAG_SIZE :: 32Source

MAX_TAG_SIZE is the maximum size tag that can be returned by any of the Algorithms supported via this package.

Variables

ALGORITHM_NAMES :: [11]string = [Algorithm]string {
	.Invalid           = "Invalid",
	.AES_GCM_128       = "AES-GCM-128",
	.AES_GCM_192       = "AES-GCM-192",
	.AES_GCM_256       = "AES-GCM-256",
	.CHACHA20POLY1305  = "chacha20poly1305",
	.XCHACHA20POLY1305 = "xchacha20poly1305",
	.AEGIS

Source

ALGORITM_NAMES is the Algorithm to algorithm name string.

IV_SIZES :: [11]int = [Algorithm]int {
	.Invalid           = 0,
	.AES_GCM_128       = aes.GCM_IV_SIZE,
	.AES_GCM_192       = aes.GCM_IV_SIZE,
	.AES_GCM_256       = aes.GCM_IV_SIZE,
	.CHACHA20POLY1305  = chacha20poly1305.IV_SIZE,
	.XCHACHA20POLY1305 = chacha20poly1305.XIV_SIZE,

Source

IV_SIZES is the Algorithm to initialization vector size in bytes.

Note: Some algorithms (such as AES-GCM) support variable IV sizes.

KEY_SIZES :: [11]int = [Algorithm]int {
	.Invalid           = 0,
	.AES_GCM_128       = aes.KEY_SIZE_128,
	.AES_GCM_192       = aes.KEY_SIZE_192,
	.AES_GCM_256       = aes.KEY_SIZE_256,
	.CHACHA20POLY1305  = chacha20poly1305.KEY_SIZE,
	.XCHACHA20POLY1305 = chacha20poly1305.KEY_SI

Source

KEY_SIZES is the Algorithm to key size in bytes.

TAG_SIZES :: [11]int = [Algorithm]int {
	.Invalid           = 0,
	.AES_GCM_128       = aes.GCM_TAG_SIZE,
	.AES_GCM_192       = aes.GCM_TAG_SIZE,
	.AES_GCM_256       = aes.GCM_TAG_SIZE,
	.CHACHA20POLY1305  = chacha20poly1305.TAG_SIZE,
	.XCHACHA20POLY1305 = chacha20poly1305.TAG_SI

Source

TAG_SIZES is the Algorithm to tag size in bytes.

open_ctx authenticates the aad and ciphertext, and decrypts the ciphertext, with the provided Context, iv, and tag, and stores the output in dst, returning true if and only if (⟺) the authentication was successful. If authentication fails, the destination buffer will be zeroed.

dst and plaintext MUST alias exactly or not at all.

open_oneshot :: proc(
	algo:       Algorithm,
	dst:        []u8,
	key:        []u8,
	iv:         []u8,
	aad:        []u8,
	ciphertext: []u8,
	tag:        []u8,
	impl:       Implementation,
) -> (bool)

Source

open authenticates the aad and ciphertext, and decrypts the ciphertext, with the provided algorithm, key, iv, and tag, and stores the output in dst, returning true if and only if (⟺) the authentication was successful. If authentication fails, the destination buffer will be zeroed.

dst and ciphertext MUST alias exactly or not at all.

reset :: proc(ctx: ^Context)Source

reset sanitizes the Context. The Context must be re-initialized to be used again.

seal_ctx :: proc(
	ctx:       ^Context,
	dst:       []u8,
	tag:       []u8,
	iv:        []u8,
	aad:       []u8,
	plaintext: []u8,
)

Source

seal_ctx encrypts the plaintext and authenticates the aad and ciphertext, with the provided Context and iv, stores the output in dst and tag.

dst and plaintext MUST alias exactly or not at all.

seal_oneshot :: proc(
	algo:      Algorithm,
	dst:       []u8,
	tag:       []u8,
	key:       []u8,
	iv:        []u8,
	aad:       []u8,
	plaintext: []u8,
	impl:      Implementation,
)

Source

seal_oneshot encrypts the plaintext and authenticates the aad and ciphertext, with the provided algorithm, key, and iv, stores the output in dst and tag.

dst and plaintext MUST alias exactly or not at all.

tag_size :: proc(ctx: ^Context) -> (int)Source

tag_size returns the tag size of a Context instance in bytes.

Procedure Groups

open :: proc{open_ctx, open_oneshot}Source

seal :: proc{seal_ctx, seal_oneshot}Source

aead

Types

Constants

Variables

Procedures

Procedure Groups

Find anything

Settings