photon-beetle.h File Reference

PHOTON-Beetle authenticated encryption algorithm. More...

#include "aead-common.h"

Go to the source code of this file.

Macros
#define	PHOTON_BEETLE_KEY_SIZE   16
	Size of the key for PHOTON-Beetle.
#define	PHOTON_BEETLE_TAG_SIZE   16
	Size of the authentication tag for PHOTON-Beetle.
#define	PHOTON_BEETLE_NONCE_SIZE   16
	Size of the nonce for PHOTON-Beetle.
#define	PHOTON_BEETLE_HASH_SIZE   32
	Size of the hash output for PHOTON-Beetle-HASH.

Functions
int	photon_beetle_128_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 PHOTON-Beetle-AEAD-ENC-128. More...
int	photon_beetle_128_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 PHOTON-Beetle-AEAD-ENC-128. More...
int	photon_beetle_32_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 PHOTON-Beetle-AEAD-ENC-32. More...
int	photon_beetle_32_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 PHOTON-Beetle-AEAD-ENC-32. More...
int	photon_beetle_hash (unsigned char *out, const unsigned char *in, unsigned long long inlen)
	Hashes a block of input data with PHOTON-Beetle-HASH to generate a hash value. More...

Variables
aead_cipher_t const	photon_beetle_128_cipher
	Meta-information block for the PHOTON-Beetle-AEAD-ENC-128 cipher.
aead_cipher_t const	photon_beetle_32_cipher
	Meta-information block for the PHOTON-Beetle-AEAD-ENC-32 cipher.
aead_hash_algorithm_t const	photon_beetle_hash_algorithm
	Meta-information block for the PHOTON-Beetle-HASH algorithm.

Detailed Description

PHOTON-Beetle authenticated encryption algorithm.

PHOTON-Beetle is a family of authenticated encryption algorithms based on the PHOTON-256 permutation and using the Beetle sponge mode. There are three algorithms in the family:

• PHOTON-Beetle-AEAD-ENC-128 with a 128-bit key, a 128-bit nonce, and a 128-bit tag. Data is handled in 16 byte blocks. This is the primary member of the family for encryption.
• PHOTON-Beetle-AEAD-ENC-32 with a 128-bit key, a 128-bit nonce, and a 128-bit tag. Data is handled in 4 byte blocks.
• PHOTON-Beetle-Hash with a 256-bit hash output. The initial data is handled as a 16 byte block, and then the remaining bytes are processed in 4 byte blocks.

References: https://www.isical.ac.in/~lightweight/beetle/

Function Documentation

int photon_beetle_128_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 PHOTON-Beetle-AEAD-ENC-128.

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

photon_beetle_128_aead_encrypt()

int photon_beetle_128_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 PHOTON-Beetle-AEAD-ENC-128.

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

photon_beetle_128_aead_decrypt()

int photon_beetle_32_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 PHOTON-Beetle-AEAD-ENC-32.

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

photon_beetle_32_aead_encrypt()

int photon_beetle_32_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 PHOTON-Beetle-AEAD-ENC-32.

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

photon_beetle_32_aead_decrypt()

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

Hashes a block of input data with PHOTON-Beetle-HASH to generate a hash value.

Parameters

out	Buffer to receive the hash output which must be at least PHOTON_BEETLE_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.