sparkle-aead.h File Reference

Encryption algorithms based on the SPARKLE permutation. More...

#include <stddef.h>

Go to the source code of this file.

Macros
#define	SCHWAEMM_256_128_KEY_SIZE   16
	Size of the key for Schwaemm256-128.
#define	SCHWAEMM_256_128_TAG_SIZE   16
	Size of the authentication tag for Schwaemm256-128.
#define	SCHWAEMM_256_128_NONCE_SIZE   32
	Size of the nonce for Schwaemm256-128.
#define	SCHWAEMM_192_192_KEY_SIZE   24
	Size of the key for Schwaemm192-192.
#define	SCHWAEMM_192_192_TAG_SIZE   24
	Size of the authentication tag for Schwaemm192-192.
#define	SCHWAEMM_192_192_NONCE_SIZE   24
	Size of the nonce for Schwaemm192-192.
#define	SCHWAEMM_128_128_KEY_SIZE   16
	Size of the key for Schwaemm128-128.
#define	SCHWAEMM_128_128_TAG_SIZE   16
	Size of the authentication tag for Schwaemm128-128.
#define	SCHWAEMM_128_128_NONCE_SIZE   16
	Size of the nonce for Schwaemm128-128.
#define	SCHWAEMM_256_256_KEY_SIZE   32
	Size of the key for Schwaemm256-256.
#define	SCHWAEMM_256_256_TAG_SIZE   32
	Size of the authentication tag for Schwaemm256-256.
#define	SCHWAEMM_256_256_NONCE_SIZE   32
	Size of the nonce for Schwaemm256-256.

Functions
int	schwaemm_256_128_aead_encrypt (unsigned char *c, size_t *clen, const unsigned char *m, size_t mlen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Encrypts and authenticates a packet with Schwaemm256-128. More...
int	schwaemm_256_128_aead_decrypt (unsigned char *m, size_t *mlen, const unsigned char *c, size_t clen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Decrypts and authenticates a packet with Schwaemm256-128. More...
int	schwaemm_192_192_aead_encrypt (unsigned char *c, size_t *clen, const unsigned char *m, size_t mlen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Encrypts and authenticates a packet with Schwaemm192-192. More...
int	schwaemm_192_192_aead_decrypt (unsigned char *m, size_t *mlen, const unsigned char *c, size_t clen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Decrypts and authenticates a packet with Schwaemm192-192. More...
int	schwaemm_128_128_aead_encrypt (unsigned char *c, size_t *clen, const unsigned char *m, size_t mlen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Encrypts and authenticates a packet with Schwaemm128-128. More...
int	schwaemm_128_128_aead_decrypt (unsigned char *m, size_t *mlen, const unsigned char *c, size_t clen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Decrypts and authenticates a packet with Schwaemm128-128. More...
int	schwaemm_256_256_aead_encrypt (unsigned char *c, size_t *clen, const unsigned char *m, size_t mlen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Encrypts and authenticates a packet with Schwaemm256-256. More...
int	schwaemm_256_256_aead_decrypt (unsigned char *m, size_t *mlen, const unsigned char *c, size_t clen, const unsigned char *ad, size_t adlen, const unsigned char *npub, const unsigned char *k)
	Decrypts and authenticates a packet with Schwaemm256-256. More...

Detailed Description

Encryption algorithms based on the SPARKLE permutation.

SPARKLE is a family of encryption and hash algorithms that are based around the SPARKLE permutation. There are three versions of the permutation with 256-bit, 384-bit, and 512-bit state sizes. The encryption algorithms in the family are:

• Schwaemm256-128 with a 128-bit key, a 256-bit nonce, and a 128-bit tag. This is the primary encryption algorithm in the family.
• Schwaemm192-192 with a 192-bit key, a 192-bit nonce, and a 192-bit tag.
• Schwaemm128-128 with a 128-bit key, a 128-bit nonce, and a 128-bit tag.
• Schwaemm256-256 with a 256-bit key, a 256-bit nonce, and a 256-bit tag.

References: https://www.cryptolux.org/index.php/Sparkle

Function Documentation

int schwaemm_128_128_aead_decrypt	(	unsigned char *	m,
		size_t *	mlen,
		const unsigned char *	c,
		size_t	clen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Decrypts and authenticates a packet with Schwaemm128-128.

Parameters

m	Buffer to receive the plaintext message on output.
mlen	Receives the length of the plaintext message on output.
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

schwaemm_128_128_aead_encrypt()

int schwaemm_128_128_aead_encrypt	(	unsigned char *	c,
		size_t *	clen,
		const unsigned char *	m,
		size_t	mlen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Encrypts and authenticates a packet with Schwaemm128-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.
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

schwaemm_128_128_aead_decrypt()

int schwaemm_192_192_aead_decrypt	(	unsigned char *	m,
		size_t *	mlen,
		const unsigned char *	c,
		size_t	clen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Decrypts and authenticates a packet with Schwaemm192-192.

Parameters

m	Buffer to receive the plaintext message on output.
mlen	Receives the length of the plaintext message on output.
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 24 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 24 bytes in length.
k	Points to the 24 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

schwaemm_192_192_aead_encrypt()

int schwaemm_192_192_aead_encrypt	(	unsigned char *	c,
		size_t *	clen,
		const unsigned char *	m,
		size_t	mlen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Encrypts and authenticates a packet with Schwaemm192-192.

Parameters

c	Buffer to receive the output.
clen	On exit, set to the length of the output which includes the ciphertext and the 24 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.
npub	Points to the public nonce for the packet which must be 24 bytes in length.
k	Points to the 24 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

schwaemm_192_192_aead_decrypt()

int schwaemm_256_128_aead_decrypt	(	unsigned char *	m,
		size_t *	mlen,
		const unsigned char *	c,
		size_t	clen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Decrypts and authenticates a packet with Schwaemm256-128.

Parameters

m	Buffer to receive the plaintext message on output.
mlen	Receives the length of the plaintext message on output.
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 32 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

schwaemm_256_128_aead_encrypt()

int schwaemm_256_128_aead_encrypt	(	unsigned char *	c,
		size_t *	clen,
		const unsigned char *	m,
		size_t	mlen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Encrypts and authenticates a packet with Schwaemm256-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.
npub	Points to the public nonce for the packet which must be 32 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

schwaemm_256_128_aead_decrypt()

int schwaemm_256_256_aead_decrypt	(	unsigned char *	m,
		size_t *	mlen,
		const unsigned char *	c,
		size_t	clen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Decrypts and authenticates a packet with Schwaemm256-256.

Parameters

m	Buffer to receive the plaintext message on output.
mlen	Receives the length of the plaintext message on output.
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

schwaemm_256_256_aead_encrypt()

int schwaemm_256_256_aead_encrypt	(	unsigned char *	c,
		size_t *	clen,
		const unsigned char *	m,
		size_t	mlen,
		const unsigned char *	ad,
		size_t	adlen,
		const unsigned char *	npub,
		const unsigned char *	k
	)

Encrypts and authenticates a packet with Schwaemm256-256.

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

schwaemm_256_256_aead_decrypt()