ESP32-S3 cipher hardware accelerator. More...

#include "esp_crypto_lock.h"
#include "soc/hwcrypto_reg.h"
#include "esp_private/periph_ctrl.h"
#include "core/crypto.h"
#include "hardware/esp32_s3/esp32_s3_crypto.h"
#include "hardware/esp32_s3/esp32_s3_crypto_cipher.h"
#include "cipher/cipher_algorithms.h"
#include "cipher_modes/cipher_modes.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL CRYPTO_TRACE_LEVEL

Functions
void	esp32s3AesInit (void)
	AES module initialization. More...

void	aesLoadKey (AesContext *context, uint32_t mode)
	Load AES key. More...

void	aesProcessDataBlock (const uint8_t input, uint8_t output)
	Encrypt/decrypt a 16-byte block using AES algorithm. More...

error_t	aesInit (AesContext context, const uint8_t key, size_t keyLen)
	Key expansion. More...

void	aesEncryptBlock (AesContext context, const uint8_t input, uint8_t *output)
	Encrypt a 16-byte block using AES algorithm. More...

void	aesDecryptBlock (AesContext context, const uint8_t input, uint8_t *output)
	Decrypt a 16-byte block using AES algorithm. More...

error_t	ecbEncrypt (const CipherAlgo cipher, void context, const uint8_t p, uint8_t c, size_t length)
	ECB encryption. More...

error_t	ecbDecrypt (const CipherAlgo cipher, void context, const uint8_t c, uint8_t p, size_t length)
	ECB decryption. More...

error_t	cbcEncrypt (const CipherAlgo cipher, void context, uint8_t iv, const uint8_t p, uint8_t *c, size_t length)
	CBC encryption. More...

error_t	cbcDecrypt (const CipherAlgo cipher, void context, uint8_t iv, const uint8_t c, uint8_t *p, size_t length)
	CBC decryption. More...

error_t	cfbEncrypt (const CipherAlgo cipher, void context, uint_t s, uint8_t iv, const uint8_t p, uint8_t *c, size_t length)
	CFB encryption. More...

error_t	cfbDecrypt (const CipherAlgo cipher, void context, uint_t s, uint8_t iv, const uint8_t c, uint8_t *p, size_t length)
	CFB decryption. More...

error_t	ofbEncrypt (const CipherAlgo cipher, void context, uint_t s, uint8_t iv, const uint8_t p, uint8_t *c, size_t length)
	OFB encryption. More...

error_t	ctrEncrypt (const CipherAlgo cipher, void context, uint_t m, uint8_t t, const uint8_t p, uint8_t *c, size_t length)
	CTR encryption. More...

Detailed Description

ESP32-S3 cipher hardware accelerator.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.4.4

Definition in file esp32_s3_crypto_cipher.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL CRYPTO_TRACE_LEVEL

Definition at line 32 of file esp32_s3_crypto_cipher.c.

Function Documentation

◆ aesDecryptBlock()

void aesDecryptBlock	(	AesContext *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Decrypt a 16-byte block using AES algorithm.

Parameters

[in]	context	Pointer to the AES context
[in]	input	Ciphertext block to decrypt
[out]	output	Plaintext block resulting from decryption

Definition at line 207 of file esp32_s3_crypto_cipher.c.

◆ aesEncryptBlock()

void aesEncryptBlock	(	AesContext *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Encrypt a 16-byte block using AES algorithm.

Parameters

[in]	context	Pointer to the AES context
[in]	input	Plaintext block to encrypt
[out]	output	Ciphertext block resulting from encryption

Definition at line 181 of file esp32_s3_crypto_cipher.c.

◆ aesInit()

error_t aesInit	(	AesContext *	context,
		const uint8_t *	key,
		size_t	keyLen
	)

Key expansion.

Parameters

[in]	context	Pointer to the AES context to initialize
[in]	key	Pointer to the key
[in]	keyLen	Length of the key

Returns: Error code

Definition at line 143 of file esp32_s3_crypto_cipher.c.

◆ aesLoadKey()

void aesLoadKey	(	AesContext *	context,
		uint32_t	mode
	)

Load AES key.

Parameters

[in]	context	AES algorithm context
[in]	mode	Operation mode

Definition at line 64 of file esp32_s3_crypto_cipher.c.

◆ aesProcessDataBlock()

void aesProcessDataBlock	(	const uint8_t *	input,
		uint8_t *	output
	)

Encrypt/decrypt a 16-byte block using AES algorithm.

Parameters

[in]	input	Input block to be encrypted/decrypted
[out]	output	Resulting block

Definition at line 107 of file esp32_s3_crypto_cipher.c.

◆ cbcDecrypt()

error_t cbcDecrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint8_t *	iv,
		const uint8_t *	c,
		uint8_t *	p,
		size_t	length
	)

CBC decryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in,out]	iv	Initialization vector
[in]	c	Ciphertext to be decrypted
[out]	p	Plaintext resulting from the decryption
[in]	length	Total number of data bytes to be decrypted

Returns: Error code

Definition at line 497 of file esp32_s3_crypto_cipher.c.

◆ cbcEncrypt()

error_t cbcEncrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint8_t *	iv,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length
	)

CBC encryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in,out]	iv	Initialization vector
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted

Returns: Error code

Definition at line 397 of file esp32_s3_crypto_cipher.c.

◆ cfbDecrypt()

error_t cfbDecrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint_t	s,
		uint8_t *	iv,
		const uint8_t *	c,
		uint8_t *	p,
		size_t	length
	)

CFB decryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	s	Size of the plaintext and ciphertext segments
[in,out]	iv	Initialization vector
[in]	c	Ciphertext to be decrypted
[out]	p	Plaintext resulting from the decryption
[in]	length	Total number of data bytes to be decrypted

Returns: Error code

Definition at line 731 of file esp32_s3_crypto_cipher.c.

◆ cfbEncrypt()

error_t cfbEncrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint_t	s,
		uint8_t *	iv,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length
	)

CFB encryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	s	Size of the plaintext and ciphertext segments
[in,out]	iv	Initialization vector
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted

Returns: Error code

Definition at line 605 of file esp32_s3_crypto_cipher.c.

◆ ctrEncrypt()

error_t ctrEncrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint_t	m,
		uint8_t *	t,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length
	)

CTR encryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	m	Size in bits of the specific part of the block to be incremented
[in,out]	t	Initial counter block
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted

Returns: Error code

Definition at line 987 of file esp32_s3_crypto_cipher.c.

◆ ecbDecrypt()

error_t ecbDecrypt	(	const CipherAlgo *	cipher,
		void *	context,
		const uint8_t *	c,
		uint8_t *	p,
		size_t	length
	)

ECB decryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	c	Ciphertext to be decrypted
[out]	p	Plaintext resulting from the decryption
[in]	length	Total number of data bytes to be decrypted

Returns: Error code

Definition at line 316 of file esp32_s3_crypto_cipher.c.

◆ ecbEncrypt()

error_t ecbEncrypt	(	const CipherAlgo *	cipher,
		void *	context,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length
	)

ECB encryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted

Returns: Error code

Definition at line 238 of file esp32_s3_crypto_cipher.c.

◆ esp32s3AesInit()

void esp32s3AesInit ( void )

AES module initialization.

Definition at line 53 of file esp32_s3_crypto_cipher.c.

◆ ofbEncrypt()

error_t ofbEncrypt	(	const CipherAlgo *	cipher,
		void *	context,
		uint_t	s,
		uint8_t *	iv,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length
	)

OFB encryption.

Parameters

[in]	cipher	Cipher algorithm
[in]	context	Cipher algorithm context
[in]	s	Size of the plaintext and ciphertext segments
[in,out]	iv	Initialization vector
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted

Returns: Error code

Definition at line 859 of file esp32_s3_crypto_cipher.c.

Macros

Functions

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ aesDecryptBlock()

◆ aesEncryptBlock()

◆ aesInit()

◆ aesLoadKey()

◆ aesProcessDataBlock()

◆ cbcDecrypt()

◆ cbcEncrypt()

◆ cfbDecrypt()

◆ cfbEncrypt()

◆ ctrEncrypt()

◆ ecbDecrypt()

◆ ecbEncrypt()

◆ esp32s3AesInit()

◆ ofbEncrypt()