Arduino Cryptography Library: ChaChaPoly Class Reference (2024)

Authenticated cipher based on ChaCha and Poly1305. More...

#include <ChaChaPoly.h>

Inheritance diagram for ChaChaPoly:

Public Member Functions
	ChaChaPoly ()
	Constructs a new ChaChaPoly authenticated cipher.

virtual	~ChaChaPoly ()
	Destroys this ChaChaPoly authenticated cipher.

size_t	keySize () const
	Default size of the key for this cipher, in bytes. More...

size_t	ivSize () const
	Size of the initialization vector for this cipher, in bytes. More...

size_t	tagSize () const
	Returns the size of the authentication tag. More...

bool	setKey (const uint8_t *key, size_t len)
	Sets the key to use for future encryption and decryption operations. More...

bool	setIV (const uint8_t *iv, size_t len)
	Sets the initialization vector to use for future encryption and decryption operations. More...

void	encrypt (uint8_t output, const uint8_t input, size_t len)
	Encrypts an input buffer and writes the ciphertext to an output buffer. More...

void	decrypt (uint8_t output, const uint8_t input, size_t len)
	Decrypts an input buffer and writes the plaintext to an output buffer. More...

void	addAuthData (const void *data, size_t len)
	Adds extra data that will be authenticated but not encrypted. More...

void	computeTag (void *tag, size_t len)
	Finalizes the encryption process and computes the authentication tag. More...

bool	checkTag (const void *tag, size_t len)
	Finalizes the decryption process and checks the authentication tag. More...

void	clear ()
	Clears all security-sensitive state from this cipher. More...

Public Member Functions inherited from AuthenticatedCipher
	AuthenticatedCipher ()
	Constructs a new authenticated cipher.

virtual	~AuthenticatedCipher ()
	Destroys this authenticated cipher.

Public Member Functions inherited from Cipher
	Cipher ()
	Constructs a new cipher object.

virtual	~Cipher ()
	Destroys this cipher object. More...

Detailed Description

Authenticated cipher based on ChaCha and Poly1305.

ChaChaPoly is an authenticated cipher based on a combination of ChaCha with 20 rounds for encryption and Poly1305 for authentication. The resulting cipher has a 256-bit key, a 64-bit or 96-bit initialization vector, and a 128-bit authentication tag.

Reference: https://tools.ietf.org/html/draft-irtf-cfrg-chacha20-poly1305-10

See also: ChaCha, Poly1305, AuthenticatedCipher

Definition at line 30 of file ChaChaPoly.h.

Member Function Documentation

◆addAuthData()

void ChaChaPoly::addAuthData	(	const void *	data,
		size_t	len
	)

virtual

Adds extra data that will be authenticated but not encrypted.

Parameters

data	The extra data to be authenticated.
len	The number of bytes of extra data to be authenticated.

This function must be called before the first call to encrypt() or decrypt(). That is, it is assumed that all extra data for authentication is available before the first payload data block and that it will be prepended to the payload for authentication. If the subclass needs to process the extra data after the payload, then it is responsible for saving data away until it is needed during computeTag() or checkTag().

This function can be called multiple times with separate extra data blocks for authentication. All such data will be concatenated into a single block for authentication purposes.

Implements AuthenticatedCipher.

Definition at line 127 of file ChaChaPoly.cpp.

◆checkTag()

bool ChaChaPoly::checkTag	(	const void *	tag,
		size_t	len
	)

virtual

Finalizes the decryption process and checks the authentication tag.

Parameters

tag	The tag value from the incoming ciphertext to be checked.
len	The length of the tag value in bytes, which may be less than tagSize().

Returns: Returns true if the tag is identical to the first len bytes of the authentication tag that was calculated during the decryption process. Returns false otherwise.

This function must be called after the final block of ciphertext is passed to decrypt() to determine if the data could be authenticated.

Note: Authenticated cipher modes usually require that if the tag could not be verified, then all of the data that was previously decrypted must be discarded. It is unwise to use the decrypted data for any purpose before it can be verified. Callers are responsible for ensuring that any data returned via previous calls to decrypt() is discarded if checkTag() returns false.

See also: computeTag()

Implements AuthenticatedCipher.

Definition at line 150 of file ChaChaPoly.cpp.

◆clear()

void ChaChaPoly::clear

(

)

virtual

Clears all security-sensitive state from this cipher.

Security-sensitive information includes key schedules, initialization vectors, and any temporary state that is used by encrypt() or decrypt() which is stored in the cipher itself.

Implements Cipher.

Definition at line 164 of file ChaChaPoly.cpp.

◆computeTag()

void ChaChaPoly::computeTag	(	void *	tag,
		size_t	len
	)

virtual

Finalizes the encryption process and computes the authentication tag.

Parameters

tag	Points to the buffer to write the tag to.
len	The length of the tag, which may be less than tagSize() to truncate the tag to the first len bytes.

See also: checkTag()

Implements AuthenticatedCipher.

Definition at line 135 of file ChaChaPoly.cpp.

◆decrypt()

void ChaChaPoly::decrypt	(	uint8_t *	output,
		const uint8_t *	input,
		size_t	len
	)

virtual

Decrypts an input buffer and writes the plaintext to an output buffer.

Parameters

output	The output buffer to write to, which may be the same buffer as input. The output buffer must have at least as many bytes as the input buffer.
input	The input buffer to read from.
len	The number of bytes to decrypt.

The decrypt() function can be called multiple times with different regions of the ciphertext data.

See also: encrypt()

Implements Cipher.

Definition at line 116 of file ChaChaPoly.cpp.

◆encrypt()

void ChaChaPoly::encrypt	(	uint8_t *	output,
		const uint8_t *	input,
		size_t	len
	)

virtual

Encrypts an input buffer and writes the ciphertext to an output buffer.

Parameters

output	The output buffer to write to, which may be the same buffer as input. The output buffer must have at least as many bytes as the input buffer.
input	The input buffer to read from.
len	The number of bytes to encrypt.

The encrypt() function can be called multiple times with different regions of the plaintext data.

See also: decrypt()

Implements Cipher.

Definition at line 105 of file ChaChaPoly.cpp.

◆ivSize()

size_t ChaChaPoly::ivSize

(

)

const

virtual

Size of the initialization vector for this cipher, in bytes.

If the cipher does not need an initialization vector, this function will return zero.

Implements Cipher.

◆keySize()

size_t ChaChaPoly::keySize

(

)

const

virtual

Default size of the key for this cipher, in bytes.

If the cipher supports variable-sized keys, keySize() indicates the default or recommended key size. The cipher may support other key sizes.

See also: setKey(), ivSize()

Implements Cipher.

Definition at line 61 of file ChaChaPoly.cpp.

◆setIV()

bool ChaChaPoly::setIV	(	const uint8_t *	iv,
		size_t	len
	)

virtual

Sets the initialization vector to use for future encryption and decryption operations.

Parameters

iv	The initialization vector to use.
len	The length of the initialization vector in bytes.

Returns: Returns false if the length is not supported.

Initialization vectors should be set before the first call to encrypt() or decrypt() after a setKey() call. If the initialization vector is changed after encryption or decryption begins, then the behaviour is undefined.

Note: The IV is not encoded into the output stream by encrypt(). The caller is responsible for communicating the IV to the other party.

See also: ivSize()

Implements Cipher.

Definition at line 84 of file ChaChaPoly.cpp.

◆setKey()

bool ChaChaPoly::setKey	(	const uint8_t *	key,
		size_t	len
	)

virtual

Sets the key to use for future encryption and decryption operations.

Parameters

key	The key to use.
len	The length of the key in bytes.

Returns: Returns false if the key length is not supported, or the key is somehow "weak" and unusable by this cipher.

Use clear() or the destructor to remove the key and any other sensitive data from the object once encryption or decryption is complete.

Calling setKey() resets the cipher. Any temporary data that was being retained for encrypting partial blocks will be abandoned.

See also: keySize(), clear()

Implements Cipher.

Definition at line 79 of file ChaChaPoly.cpp.

◆tagSize()

size_t ChaChaPoly::tagSize

(

)

const

virtual

Returns the size of the authentication tag.

Returns: The size of the authentication tag in bytes.

By default this function should return the largest tag size supported by the authenticated cipher.

See also: computeTag()

Implements AuthenticatedCipher.

Definition at line 73 of file ChaChaPoly.cpp.

The documentation for this class was generated from the following files:

ChaChaPoly.h
ChaChaPoly.cpp

Arduino Cryptography Library: ChaChaPoly Class Reference (2024)

Public Member Functions

Detailed Description

Member Function Documentation

◆addAuthData()

◆checkTag()

◆clear()

◆computeTag()

◆decrypt()

◆encrypt()

◆ivSize()

◆keySize()

◆setIV()

◆setKey()

◆tagSize()