PIC32MZ cipher hardware accelerator. More...

#include <p32xxxx.h>
#include <sys/kmem.h>
#include "core/crypto.h"
#include "hardware/pic32mz/pic32mz_crypto.h"
#include "hardware/pic32mz/pic32mz_crypto_cipher.h"
#include "cipher/cipher_algorithms.h"
#include "cipher_modes/cipher_modes.h"
#include "aead/aead_algorithms.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL CRYPTO_TRACE_LEVEL

Functions
volatile Pic32mzCryptoBufferDesc cipherBufferDesc	__attribute__ ((coherent, aligned(8)))

uint8_t cipherInput[PIC32MZ_CRYPTO_BUFFER_SIZE]	__attribute__ ((coherent, aligned(4)))

void	desProcessData (DesContext context, uint8_t iv, const uint8_t input, uint8_t output, size_t length, uint32_t mode)
	Perform DES encryption or decryption. More...

error_t	desInit (DesContext context, const uint8_t key, size_t keyLen)
	Initialize a DES context using the supplied key. More...

void	desEncryptBlock (DesContext context, const uint8_t input, uint8_t *output)
	Encrypt a 8-byte block using DES algorithm. More...

void	desDecryptBlock (DesContext context, const uint8_t input, uint8_t *output)
	Decrypt a 8-byte block using DES algorithm. More...

void	des3ProcessData (Des3Context context, uint8_t iv, const uint8_t input, uint8_t output, size_t length, uint32_t mode)
	Perform Triple DES encryption or decryption. More...

error_t	des3Init (Des3Context context, const uint8_t key, size_t keyLen)
	Initialize a Triple DES context using the supplied key. More...

void	des3EncryptBlock (Des3Context context, const uint8_t input, uint8_t *output)
	Encrypt a 8-byte block using Triple DES algorithm. More...

void	des3DecryptBlock (Des3Context context, const uint8_t input, uint8_t *output)
	Decrypt a 8-byte block using Triple DES algorithm. More...

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

void	aesProcessData (AesContext context, uint8_t iv, const uint8_t input, uint8_t output, size_t length, uint32_t mode)
	Perform AES encryption or decryption. 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...

void	gcmProcessData (AesContext context, const uint8_t iv, const uint8_t a, size_t aLen, const uint8_t input, uint8_t output, size_t length, uint8_t t, uint32_t mode)
	Perform AES-GCM encryption or decryption. More...

error_t	gcmInit (GcmContext context, const CipherAlgo cipherAlgo, void *cipherContext)
	Initialize GCM context. More...

error_t	gcmEncrypt (GcmContext context, const uint8_t iv, size_t ivLen, const uint8_t a, size_t aLen, const uint8_t p, uint8_t c, size_t length, uint8_t t, size_t tLen)
	Authenticated encryption using GCM. More...

error_t	gcmDecrypt (GcmContext context, const uint8_t iv, size_t ivLen, const uint8_t a, size_t aLen, const uint8_t c, uint8_t p, size_t length, const uint8_t t, size_t tLen)
	Authenticated decryption using GCM. More...

Detailed Description

PIC32MZ 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 pic32mz_crypto_cipher.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL CRYPTO_TRACE_LEVEL

Definition at line 32 of file pic32mz_crypto_cipher.c.

Function Documentation

◆ attribute() [1/2]

uint8_t cipherInput [PIC32MZ_CRYPTO_BUFFER_SIZE] __attribute__ ( (coherent, aligned(4)) )

◆ attribute() [2/2]

volatile Pic32mzCryptoSecurityAssoc hashSecurityAssoc __attribute__ ( (coherent, aligned(8)) )

◆ 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 673 of file pic32mz_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 658 of file pic32mz_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 615 of file pic32mz_crypto_cipher.c.

◆ aesLoadKey()

void aesLoadKey ( AesContext * context )

Load AES key.

Parameters

[in] context AES algorithm context

Definition at line 444 of file pic32mz_crypto_cipher.c.

◆ aesProcessData()

void aesProcessData	(	AesContext *	context,
		uint8_t *	iv,
		const uint8_t *	input,
		uint8_t *	output,
		size_t	length,
		uint32_t	mode
	)

Perform AES encryption or decryption.

Parameters

[in]	context	AES algorithm context
[in]	iv	Initialization vector
[in]	input	Data to be encrypted/decrypted
[out]	output	Data resulting from the encryption/decryption process
[in]	length	Total number of data bytes to be processed
[in]	mode	Operation mode

Definition at line 504 of file pic32mz_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 1054 of file pic32mz_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 919 of file pic32mz_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 1357 of file pic32mz_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 1207 of file pic32mz_crypto_cipher.c.

◆ des3DecryptBlock()

void des3DecryptBlock	(	Des3Context *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Decrypt a 8-byte block using Triple DES algorithm.

Parameters

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

Definition at line 429 of file pic32mz_crypto_cipher.c.

◆ des3EncryptBlock()

void des3EncryptBlock	(	Des3Context *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Encrypt a 8-byte block using Triple DES algorithm.

Parameters

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

Definition at line 414 of file pic32mz_crypto_cipher.c.

◆ des3Init()

error_t des3Init	(	Des3Context *	context,
		const uint8_t *	key,
		size_t	keyLen
	)

Initialize a Triple DES context using the supplied key.

Parameters

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

Returns: Error code

Definition at line 364 of file pic32mz_crypto_cipher.c.

◆ des3ProcessData()

void des3ProcessData	(	Des3Context *	context,
		uint8_t *	iv,
		const uint8_t *	input,
		uint8_t *	output,
		size_t	length,
		uint32_t	mode
	)

Perform Triple DES encryption or decryption.

Parameters

[in]	context	Triple DES algorithm context
[in,out]	iv	Initialization vector
[in]	input	Data to be encrypted/decrypted
[out]	output	Data resulting from the encryption/decryption process
[in]	length	Total number of data bytes to be processed
[in]	mode	Operation mode

Definition at line 250 of file pic32mz_crypto_cipher.c.

◆ desDecryptBlock()

void desDecryptBlock	(	DesContext *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Decrypt a 8-byte block using DES algorithm.

Parameters

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

Definition at line 230 of file pic32mz_crypto_cipher.c.

◆ desEncryptBlock()

void desEncryptBlock	(	DesContext *	context,
		const uint8_t *	input,
		uint8_t *	output
	)

Encrypt a 8-byte block using DES algorithm.

Parameters

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

Definition at line 215 of file pic32mz_crypto_cipher.c.

◆ desInit()

error_t desInit	(	DesContext *	context,
		const uint8_t *	key,
		size_t	keyLen
	)

Initialize a DES context using the supplied key.

Parameters

[in]	context	Pointer to the DES context to initialize
[in]	key	Pointer to the key
[in]	keyLen	Length of the key (must be set to 8)

Returns: Error code

Definition at line 190 of file pic32mz_crypto_cipher.c.

◆ desProcessData()

void desProcessData	(	DesContext *	context,
		uint8_t *	iv,
		const uint8_t *	input,
		uint8_t *	output,
		size_t	length,
		uint32_t	mode
	)

Perform DES encryption or decryption.

Parameters

[in]	context	DES algorithm context
[in,out]	iv	Initialization vector
[in]	input	Data to be encrypted/decrypted
[out]	output	Data resulting from the encryption/decryption process
[in]	length	Total number of data bytes to be processed
[in]	mode	Operation mode

Definition at line 80 of file pic32mz_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 806 of file pic32mz_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 693 of file pic32mz_crypto_cipher.c.

◆ gcmDecrypt()

error_t gcmDecrypt	(	GcmContext *	context,
		const uint8_t *	iv,
		size_t	ivLen,
		const uint8_t *	a,
		size_t	aLen,
		const uint8_t *	c,
		uint8_t *	p,
		size_t	length,
		const uint8_t *	t,
		size_t	tLen
	)

Authenticated decryption using GCM.

Parameters

[in]	context	Pointer to the GCM context
[in]	iv	Initialization vector
[in]	ivLen	Length of the initialization vector
[in]	a	Additional authenticated data
[in]	aLen	Length of the additional data
[in]	c	Ciphertext to be decrypted
[out]	p	Plaintext resulting from the decryption
[in]	length	Total number of data bytes to be decrypted
[in]	t	Authentication tag
[in]	tLen	Length of the authentication tag

Returns: Error code

Definition at line 1938 of file pic32mz_crypto_cipher.c.

◆ gcmEncrypt()

error_t gcmEncrypt	(	GcmContext *	context,
		const uint8_t *	iv,
		size_t	ivLen,
		const uint8_t *	a,
		size_t	aLen,
		const uint8_t *	p,
		uint8_t *	c,
		size_t	length,
		uint8_t *	t,
		size_t	tLen
	)

Authenticated encryption using GCM.

Parameters

[in]	context	Pointer to the GCM context
[in]	iv	Initialization vector
[in]	ivLen	Length of the initialization vector
[in]	a	Additional authenticated data
[in]	aLen	Length of the additional data
[in]	p	Plaintext to be encrypted
[out]	c	Ciphertext resulting from the encryption
[in]	length	Total number of data bytes to be encrypted
[out]	t	Authentication tag
[in]	tLen	Length of the authentication tag

Returns: Error code

Definition at line 1893 of file pic32mz_crypto_cipher.c.

◆ gcmInit()

error_t gcmInit	(	GcmContext *	context,
		const CipherAlgo *	cipherAlgo,
		void *	cipherContext
	)

Initialize GCM context.

Parameters

[in]	context	Pointer to the GCM context
[in]	cipherAlgo	Cipher algorithm
[in]	cipherContext	Pointer to the cipher algorithm context

Returns: Error code

Definition at line 1858 of file pic32mz_crypto_cipher.c.

◆ gcmProcessData()

void gcmProcessData	(	AesContext *	context,
		const uint8_t *	iv,
		const uint8_t *	a,
		size_t	aLen,
		const uint8_t *	input,
		uint8_t *	output,
		size_t	length,
		uint8_t *	t,
		uint32_t	mode
	)

Perform AES-GCM encryption or decryption.

Parameters

[in]	context	AES algorithm context
[in]	iv	Initialization vector
[in]	a	Additional authenticated data
[in]	aLen	Length of the additional data
[in]	input	Data to be encrypted/decrypted
[out]	output	Data resulting from the encryption/decryption process
[in]	length	Total number of data bytes to be processed
[out]	t	Authentication tag
[in]	mode	Operation mode

Definition at line 1659 of file pic32mz_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 1506 of file pic32mz_crypto_cipher.c.

Macros

Functions

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ __attribute__() [1/2]

◆ __attribute__() [2/2]

◆ aesDecryptBlock()

◆ aesEncryptBlock()

◆ aesInit()

◆ aesLoadKey()

◆ aesProcessData()

◆ cbcDecrypt()

◆ cbcEncrypt()

◆ cfbDecrypt()

◆ cfbEncrypt()

◆ des3DecryptBlock()

◆ des3EncryptBlock()

◆ des3Init()

◆ des3ProcessData()

◆ desDecryptBlock()

◆ desEncryptBlock()

◆ desInit()

◆ desProcessData()

◆ ecbDecrypt()

◆ ecbEncrypt()

◆ gcmDecrypt()

◆ gcmEncrypt()

◆ gcmInit()

◆ gcmProcessData()

◆ ofbEncrypt()

◆ attribute() [1/2]

◆ attribute() [2/2]