elephant.h File Reference

Elephant authenticated encryption algorithm family. More...

#include "aead-common.h"

Go to the source code of this file.

Macros
#define	DUMBO_KEY_SIZE   16
	Size of the key for Dumbo.
#define	DUMBO_TAG_SIZE   8
	Size of the authentication tag for Dumbo.
#define	DUMBO_NONCE_SIZE   12
	Size of the nonce for Dumbo.
#define	JUMBO_KEY_SIZE   16
	Size of the key for Jumbo.
#define	JUMBO_TAG_SIZE   8
	Size of the authentication tag for Jumbo.
#define	JUMBO_NONCE_SIZE   12
	Size of the nonce for Jumbo.
#define	DELIRIUM_KEY_SIZE   16
	Size of the key for Delirium.
#define	DELIRIUM_TAG_SIZE   16
	Size of the authentication tag for Delirium.
#define	DELIRIUM_NONCE_SIZE   12
	Size of the nonce for Delirium.

Functions
int	dumbo_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 Dumbo. More...
int	dumbo_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 Dumbo. More...
int	jumbo_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 Jumbo. More...
int	jumbo_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 Jumbo. More...
int	delirium_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 Delirium. More...
int	delirium_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 Delirium. More...

Variables
aead_cipher_t const	dumbo_cipher
	Meta-information block for the Dumbo cipher.
aead_cipher_t const	jumbo_cipher
	Meta-information block for the Jumbo cipher.
aead_cipher_t const	delirium_cipher
	Meta-information block for the Delirium cipher.

Detailed Description

Elephant authenticated encryption algorithm family.

Elephant is a family of authenticated encryption algorithms based around the Spongent-pi and Keccak permutations.

• Dumbo has a 128-bit key, a 96-bit nonce, and a 64-bit authentication tag. It is based around the Spongent-pi[160] permutation. This is the primary member of the family.
• Jumbo has a 128-bit key, a 96-bit nonce, and a 64-bit authentication tag. It is based around the Spongent-pi[176] permutation.
• Delirium has a 128-bit key, a 96-bit nonce, and a 128-bit authentication tag. It is based around the Keccak[200] permutation.

References: https://www.esat.kuleuven.be/cosic/elephant/

Function Documentation

int delirium_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 Delirium.

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 12 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

delirium_aead_encrypt()

int delirium_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 Delirium.

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 12 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

delirium_aead_decrypt()

int dumbo_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 Dumbo.

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 8 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 12 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

dumbo_aead_encrypt()

int dumbo_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 Dumbo.

Parameters

c	Buffer to receive the output.
clen	On exit, set to the length of the output which includes the ciphertext and the 8 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 12 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

dumbo_aead_decrypt()

int jumbo_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 Jumbo.

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 8 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 12 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

jumbo_aead_encrypt()

int jumbo_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 Jumbo.

Parameters

c	Buffer to receive the output.
clen	On exit, set to the length of the output which includes the ciphertext and the 8 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 12 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

jumbo_aead_decrypt()