ascon128.h File Reference

ASCON-128 encryption algorithm and related family members. More...

#include "aead-common.h"

Go to the source code of this file.

Data Structures
union	ascon_hash_state_t
	State information for ASCON-HASH and ASCON-XOF incremental modes. More...

Macros
#define	ASCON128_KEY_SIZE   16
	Size of the key for ASCON-128 and ASCON-128a.
#define	ASCON128_NONCE_SIZE   16
	Size of the nonce for ASCON-128 and ASCON-128a.
#define	ASCON128_TAG_SIZE   16
	Size of the authentication tag for ASCON-128 and ASCON-128a.
#define	ASCON80PQ_KEY_SIZE   20
	Size of the key for ASCON-80pq.
#define	ASCON80PQ_NONCE_SIZE   16
	Size of the nonce for ASCON-80pq.
#define	ASCON80PQ_TAG_SIZE   16
	Size of the authentication tag for ASCON-80pq.
#define	ASCON_HASH_SIZE   32
	Size of the hash output for ASCON-HASH.

Functions
int	ascon128_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 ASCON-128. More...
int	ascon128_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 ASCON-128. More...
int	ascon128a_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 ASCON-128a. More...
int	ascon128a_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 ASCON-128a. More...
int	ascon80pq_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 ASCON-80pq. More...
int	ascon80pq_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 ASCON-80pq. More...
int	ascon_hash (unsigned char *out, const unsigned char *in, unsigned long long inlen)
	Hashes a block of input data with ASCON-HASH. More...
void	ascon_hash_init (ascon_hash_state_t *state)
	Initializes the state for an ASCON-HASH hashing operation. More...
void	ascon_hash_update (ascon_hash_state_t *state, const unsigned char *in, unsigned long long inlen)
	Updates an ASCON-HASH state with more input data. More...
void	ascon_hash_finalize (ascon_hash_state_t *state, unsigned char *out)
	Returns the final hash value from an ASCON-HASH hashing operation. More...
int	ascon_xof (unsigned char *out, const unsigned char *in, unsigned long long inlen)
	Hashes a block of input data with ASCON-XOF and generates a fixed-length 32 byte output. More...
void	ascon_xof_init (ascon_hash_state_t *state)
	Initializes the state for an ASCON-XOF hashing operation. More...
void	ascon_xof_absorb (ascon_hash_state_t *state, const unsigned char *in, unsigned long long inlen)
	Aborbs more input data into an ASCON-XOF state. More...
void	ascon_xof_squeeze (ascon_hash_state_t *state, unsigned char *out, unsigned long long outlen)
	Squeezes output data from an ASCON-XOF state. More...

Variables
aead_cipher_t const	ascon128_cipher
	Meta-information block for the ASCON-128 cipher.
aead_cipher_t const	ascon128a_cipher
	Meta-information block for the ASCON-128a cipher.
aead_cipher_t const	ascon80pq_cipher
	Meta-information block for the ASCON-80pq cipher.
aead_hash_algorithm_t const	ascon_hash_algorithm
	Meta-information block for the ASCON-HASH algorithm.
aead_hash_algorithm_t const	ascon_xof_algorithm
	Meta-information block for the ASCON-XOF algorithm.

Detailed Description

ASCON-128 encryption algorithm and related family members.

The ASCON family consists of several related algorithms:

• ASCON-128 with a 128-bit key, a 128-bit nonce, a 128-bit authentication tag, and a block rate of 64 bits.
• ASCON-128a with a 128-bit key, a 128-bit nonce, a 128-bit authentication tag, and a block rate of 128 bits. This is faster than ASCON-128 but may not be as secure.
• ASCON-80pq with a 160-bit key, a 128-bit nonce, a 128-bit authentication tag, and a block rate of 64 bits. This is similar to ASCON-128 but has a 160-bit key instead which may be more resistant against quantum computers.
• ASCON-HASH with a 256-bit hash output.

References: https://ascon.iaik.tugraz.at/

Function Documentation

int ascon128_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 ASCON-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

ascon128_aead_encrypt()

int ascon128_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 ASCON-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

ascon128_aead_decrypt()

int ascon128a_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 ASCON-128a.

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

ascon128a_aead_encrypt()

int ascon128a_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 ASCON-128a.

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

ascon128a_aead_decrypt()

int ascon80pq_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 ASCON-80pq.

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

ascon80pq_aead_encrypt()

int ascon80pq_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 ASCON-80pq.

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

ascon80pq_aead_decrypt()

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

Hashes a block of input data with ASCON-HASH.

Parameters

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

ascon_hash_init(), ascon_hash_absorb(), ascon_hash_squeeze()

void ascon_hash_finalize	(	ascon_hash_state_t *	state,
		unsigned char *	out
	)

Returns the final hash value from an ASCON-HASH hashing operation.

Parameters

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

See Also

ascon_hash_init(), ascon_hash_update()

void ascon_hash_init

(

ascon_hash_state_t *

state

)

Initializes the state for an ASCON-HASH hashing operation.

Parameters

state

Hash state to be initialized.

See Also

ascon_hash_update(), ascon_hash_finalize(), ascon_hash()

void ascon_hash_update	(	ascon_hash_state_t *	state,
		const unsigned char *	in,
		unsigned long long	inlen
	)

Updates an ASCON-HASH 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

ascon_hash_init(), ascon_hash_finalize()

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

Hashes a block of input data with ASCON-XOF and generates a fixed-length 32 byte output.

Parameters

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

Use ascon_xof_squeeze() instead if you need variable-length XOF ouutput.

See Also

ascon_xof_init(), ascon_xof_absorb(), ascon_xof_squeeze()

void ascon_xof_absorb	(	ascon_hash_state_t *	state,
		const unsigned char *	in,
		unsigned long long	inlen
	)

Aborbs more input data into an ASCON-XOF state.

Parameters

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

See Also

ascon_xof_init(), ascon_xof_squeeze()

void ascon_xof_init

(

ascon_hash_state_t *

state

)

Initializes the state for an ASCON-XOF hashing operation.

Parameters

state

Hash state to be initialized.

See Also

ascon_xof_absorb(), ascon_xof_squeeze(), ascon_xof()

void ascon_xof_squeeze	(	ascon_hash_state_t *	state,
		unsigned char *	out,
		unsigned long long	outlen
	)

Squeezes output data from an ASCON-XOF state.

Parameters

state	Hash state to squeeze the output data from.
out	Points to the output buffer to receive the squeezed data.
outlen	Number of bytes of data to squeeze out of the state.

See Also

ascon_xof_init(), ascon_xof_update()