subterranean.h File Reference

Subterranean authenticated encryption algorithm. More...

#include "aead-common.h"

Go to the source code of this file.

Data Structures
union	subterranean_hash_state_t
	State information for the Subterreaan incremental hash mode. More...

Macros
#define	SUBTERRANEAN_KEY_SIZE   16
	Size of the key for Subterranean.
#define	SUBTERRANEAN_TAG_SIZE   16
	Size of the authentication tag for Subterranean.
#define	SUBTERRANEAN_NONCE_SIZE   16
	Size of the nonce for Subterranean.
#define	SUBTERRANEAN_HASH_SIZE   32
	Size of the hash output for Subterranean-Hash.

Functions
int	subterranean_aead_encrypt (unsigned char *c, unsigned long long *clen, const unsigned char *m, unsigned long long mlen, const unsigned char *ad, unsigned long long adlen, const unsigned char *nsec, const unsigned char *npub, const unsigned char *k)
	Encrypts and authenticates a packet with Subterranean. More...
int	subterranean_aead_decrypt (unsigned char *m, unsigned long long *mlen, unsigned char *nsec, const unsigned char *c, unsigned long long clen, const unsigned char *ad, unsigned long long adlen, const unsigned char *npub, const unsigned char *k)
	Decrypts and authenticates a packet with Subterranean. More...
int	subterranean_hash (unsigned char *out, const unsigned char *in, unsigned long long inlen)
	Hashes a block of input data with Subterranean. More...
void	subterranean_hash_init (subterranean_hash_state_t *state)
	Initializes the state for a Subterranean hashing operation. More...
void	subterranean_hash_update (subterranean_hash_state_t *state, const unsigned char *in, unsigned long long inlen)
	Updates a Subterranean state with more input data. More...
void	subterranean_hash_finalize (subterranean_hash_state_t *state, unsigned char *out)
	Returns the final hash value from a Subterranean hashing operation. More...

Variables
aead_cipher_t const	subterranean_cipher
	Meta-information block for the Subterranean cipher.
aead_hash_algorithm_t const	subterranean_hash_algorithm
	Meta-information block for the SUBTERRANEAN hash algorithm.

Detailed Description

Subterranean authenticated encryption algorithm.

Subterranean (technically "Subterranean 2.0") is a family of algorithms built around the 257-bit Subterranean permutation:

• Subterranean is an authenticated encryption algorithm with a 128-bit key, a 128-bit nonce, and a 128-bit tag.
• Subterranean-Hash is a hash algorithm with a 256-bit output.

The Subterranean permutation is intended for hardware implementation. It is not structured for efficient software implementation.

References: https://cs.ru.nl/~joan/subterranean.html

Function Documentation

int subterranean_aead_decrypt	(	unsigned char *	m,
		unsigned long long *	mlen,
		unsigned char *	nsec,
		const unsigned char *	c,
		unsigned long long	clen,
		const unsigned char *	ad,
		unsigned long long	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Decrypts and authenticates a packet with Subterranean.

Parameters

m	Buffer to receive the plaintext message on output.
mlen	Receives the length of the plaintext message on output.
nsec	Secret nonce - not used by this algorithm.
c	Buffer that contains the ciphertext and authentication tag to decrypt.
clen	Length of the input data in bytes, which includes the ciphertext and the 16 byte authentication tag.
ad	Buffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlen	Length of the associated data in bytes.
npub	Points to the public nonce for the packet which must be 16 bytes in length.
k	Points to the 16 bytes of the key to use to decrypt the packet.

Returns

0 on success, -1 if the authentication tag was incorrect, or some other negative number if there was an error in the parameters.

See Also

subterranean_aead_encrypt()

int subterranean_aead_encrypt	(	unsigned char *	c,
		unsigned long long *	clen,
		const unsigned char *	m,
		unsigned long long	mlen,
		const unsigned char *	ad,
		unsigned long long	adlen,
		const unsigned char *	nsec,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Encrypts and authenticates a packet with Subterranean.

Parameters

c	Buffer to receive the output.
clen	On exit, set to the length of the output which includes the ciphertext and the 16 byte authentication tag.
m	Buffer that contains the plaintext message to encrypt.
mlen	Length of the plaintext message in bytes.
ad	Buffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlen	Length of the associated data in bytes.
nsec	Secret nonce - not used by this algorithm.
npub	Points to the public nonce for the packet which must be 16 bytes in length.
k	Points to the 16 bytes of the key to use to encrypt the packet.

Returns

0 on success, or a negative value if there was an error in the parameters.

See Also

subterranean_aead_decrypt()

int subterranean_hash	(	unsigned char *	out,
		const unsigned char *	in,
		unsigned long long	inlen
	)

Hashes a block of input data with Subterranean.

Parameters

out	Buffer to receive the hash output which must be at least SUBTERRANEAN_HASH_SIZE bytes in length.
in	Points to the input data to be hashed.
inlen	Length of the input data in bytes.

Returns

Returns zero on success or -1 if there was an error in the parameters.

See Also

subterranean_hash_init()

void subterranean_hash_finalize	(	subterranean_hash_state_t *	state,
		unsigned char *	out
	)

Returns the final hash value from a Subterranean hashing operation.

Parameters

state	Hash state to be finalized.
out	Points to the output buffer to receive the 32-byte hash value.

See Also

subterranean_hash_init(), subterranean_hash_update()

void subterranean_hash_init

(

subterranean_hash_state_t *

state

)

Initializes the state for a Subterranean hashing operation.

Parameters

state

Hash state to be initialized.

See Also

subterranean_hash_update(), subterranean_hash_finalize(), subterranean_hash()

void subterranean_hash_update	(	subterranean_hash_state_t *	state,
		const unsigned char *	in,
		unsigned long long	inlen
	)

Updates a Subterranean state with more input data.

Parameters

state	Hash state to be updated.
in	Points to the input data to be incorporated into the state.
inlen	Length of the input data to be incorporated into the state.

See Also

subterranean_hash_init(), subterranean_hash_finalize()