Data Structures
struct	SHA256_memory_t
	A SHA256_memory_t variable of this type must be allocated before running any SHA256 functions. More...

Functions
void	AES_ECB_EncryptData (uint8_t text, uint16_t textLen, uint8_t aesKey)
	Use a random 128 bit key to encrypt data with the AES. More...

void	AES_ECB_DecryptData (uint8_t text, uint16_t textLen, uint8_t aesKey)
	Use a random 128 bit key to decrypt data with the AES. More...

int8_t	AES_CCM_EncryptData (uint8_t encryptFlag, uint8_t MACLen, uint8_t nonce, uint8_t plainText, uint16_t textLen, uint8_t addDataBuf, uint16_t addBufLen, uint8_t aesKey, uint8_t *MAC, uint8_t ccmLVal)
	Authenticate and optionally encrypt message plainText. More...

int8_t	AES_CCM_DecryptData (uint8_t decryptFlag, uint8_t MACLen, uint8_t nonce, uint8_t cipherText, uint16_t textLen, uint8_t addDataBuf, uint16_t addBufLen, uint8_t aesKey, uint8_t *MAC, uint8_t ccmLVal)
	Authenticate and optionally decrypt message cipherText. More...

uint8_t	AES_CTR_EncryptData (uint8_t plainText, uint16_t textLen, uint8_t aesKey, uint8_t nonce, uint8_t initVector)
	Encrypt plaintext using the AES key, nonce and initialization vector. More...

uint8_t	AES_CTR_DecryptData (uint8_t cipherText, uint16_t textLen, uint8_t aesKey, uint8_t nonce, uint8_t initVector)
	Decrypt ciphertext using the AES key, nonce and initialization vector. More...

void	ECC_initialize (uint32_t *pWorkzone)
	Pass pointer to ECC memory allocation to ECC engine. More...

uint8_t	ECC_generateKey (uint32_t randString, uint32_t privateKey, uint32_t publicKey_x, uint32_t publicKey_y)
	Generate a key. More...

uint8_t	ECC_ECDSA_sign (uint32_t secretKey, uint32_t text, uint32_t randString, uint32_t sign1, uint32_t *sign2)
	Sign data. More...

uint8_t	ECC_ECDSA_verify (uint32_t publicKey_x, uint32_t publicKey_y, uint32_t text, uint32_t sign1, uint32_t *sign2)
	Verify signature. More...

uint8_t	ECC_ECDH_computeSharedSecret (uint32_t privateKey, uint32_t publicKey_x, uint32_t publicKey_y, uint32_t sharedSecret_x, uint32_t *sharedSecret_y)
	Compute the shared secret. More...

uint8_t	SHA256_runFullAlgorithm (SHA256_memory_t memory, uint8_t pBufIn, uint32_t bufLen, uint8_t *pBufOut)
	Perform SHA256 on the input data. More...

uint8_t	SHA256_initialize (SHA256_memory_t *workZone)
	Intializes the SHA256 engine. More...

uint8_t	SHA256_execute (SHA256_memory_t config, uint8_t pBufIn, uint32_t bufLen)
	Perform SHA256. More...

uint8_t	SHA256_output (SHA256_memory_t memory, uint8_t pBufOut)
	Complete the process by passing the modified data back. More...

Detailed Description

Function Documentation

int8_t AES_CCM_DecryptData	(	uint8_t	decryptFlag,
		uint8_t	MACLen,
		uint8_t *	nonce,
		uint8_t *	cipherText,
		uint16_t	textLen,
		uint8_t *	addDataBuf,
		uint16_t	addBufLen,
		uint8_t *	aesKey,
		uint8_t *	MAC,
		uint8_t	ccmLVal
	)

Authenticate and optionally decrypt message cipherText.

Parameters

decryptFlag	Decryption flag. `true` for authentication with decryption. `false` for authentication only.
MACLen	Length of MAC in bytes.
nonce	Pointer to random nonce. Nonce length = 15 - ccmLVal.
cipherText	Pointer to text to decrypt, input and output.
textLen	Length of text to decrypt.
addDataBuf	Pointer to additional data for authentication
addBufLen	Additional authentication buffer length.
aesKey	Pointer to the AES key or key expansion buffer.
MAC	Pointer to 16 byte Message Authentication Code output buffer.
ccmLVal	CCM L value to be used. Values {2,3}.

Returns: Zero when Successful.

 {
   return aes_ccm_decrypt(decryptFlag, MACLen, nonce, cipherText, textLen,
                          addDataBuf, addBufLen, aesKey, MAC, ccmLVal);
 
 }

int8_t AES_CCM_EncryptData	(	uint8_t	encryptFlag,
		uint8_t	MACLen,
		uint8_t *	nonce,
		uint8_t *	plainText,
		uint16_t	textLen,
		uint8_t *	addDataBuf,
		uint16_t	addBufLen,
		uint8_t *	aesKey,
		uint8_t *	MAC,
		uint8_t	ccmLVal
	)

Authenticate and optionally encrypt message plainText.

Parameters

encryptFlag	Encryption flag. set to `true` for authentication with encryption. set to `false` for authentication only.
MACLen	Length of MAC in bytes.
nonce	Pointer to random nonce. Nonce length = 15 - ccmLVal.
plainText	Pointer to text to encrypt, input and output.
textLen	Length of text to encrypt.
addDataBuf	Pointer to additional data for authentication
addBufLen	Additional authentication buffer length.
aesKey	Pointer to the AES key or key expansion buffer.
MAC	Pointer to 16 byte Message Authentication Code output buffer.
ccmLVal	CCM L value to be used. Values {2,3}.

Returns: Zero when successful.

 {
   return aes_ccm_encrypt(encryptFlag, MACLen, nonce, plainText, textLen,
                          addDataBuf, addBufLen, aesKey, MAC, ccmLVal);
 }

uint8_t AES_CTR_DecryptData	(	uint8_t *	cipherText,
		uint16_t	textLen,
		uint8_t *	aesKey,
		uint8_t *	nonce,
		uint8_t *	initVector
	)

Decrypt ciphertext using the AES key, nonce and initialization vector.

Parameters

cipherText	Pointer to text to decrypt
textLen	Length of text.
aesKey	Pointer to 128 bit key used to encrypt text.
nonce	Pointer to 4 byte nonce.
initVector	Pointer to 8 byte random initialization vector.

Returns: None

 {
   return aes_ctr_decrypt(cipherText, textLen, aesKey, nonce, initVector);
 }

uint8_t AES_CTR_EncryptData	(	uint8_t *	plainText,
		uint16_t	textLen,
		uint8_t *	aesKey,
		uint8_t *	nonce,
		uint8_t *	initVector
	)

Encrypt plaintext using the AES key, nonce and initialization vector.

Parameters

plainText	Pointer to text to encrypt.
textLen	Length of text.
aesKey	Pointer to 128 bit key used to encrypt text.
nonce	Pointer to 4 byte nonce.
initVector	Pointer to 8 byte random initialization vector.

Returns: None

 {
   return aes_ctr_encrypt(plainText, textLen, aesKey, nonce, initVector);
 }

void AES_ECB_DecryptData	(	uint8_t *	text,
		uint16_t	textLen,
		uint8_t *	aesKey
	)

Use a random 128 bit key to decrypt data with the AES.

Parameters

text	Pointer to data to decrypt.
textLen	Length of text.
aesKey	Pointer to 128 bit key used to decrypt. This is the same key that was used to originally encrypt this data.

Returns: None

 {
   aes_ecb_decrypt(text, textLen, aesKey);
 }

void AES_ECB_EncryptData	(	uint8_t *	text,
		uint16_t	textLen,
		uint8_t *	aesKey
	)

Use a random 128 bit key to encrypt data with the AES.

Parameters

text	Pointer to data to encrypt.
textLen	Length of text.
aesKey	Pointer to 128 bit key used to encrypt text.

Returns: None

 {
   aes_ecb_encrypt(text, textLen, aesKey);
 }

uint8_t ECC_ECDH_computeSharedSecret	(	uint32_t *	privateKey,
		uint32_t *	publicKey_x,
		uint32_t *	publicKey_y,
		uint32_t *	sharedSecret_x,
		uint32_t *	sharedSecret_y
	)

Compute the shared secret.

Parameters

privateKey	Pointer to private key, input.
publicKey_x	Pointer to public key X-coordinate, input.
publicKey_y	Pointer to public key Y-coordinate, input.
sharedSecret_x	Pointer to shared secret X-coordinate, output.
sharedSecret_y	Pointer to shared secret Y-coordinate, output.

Returns: Status

 {
   return (uint8_t)ecdh_computeSharedSecret((uint32_t*)privateKey, (uint32_t*)publicKey_x,
                                  (uint32_t*)publicKey_y, (uint32_t*)sharedSecret_x,
                                  (uint32_t*)sharedSecret_y);
 }

uint8_t ECC_ECDSA_sign	(	uint32_t *	secretKey,
		uint32_t *	text,
		uint32_t *	randString,
		uint32_t *	sign1,
		uint32_t *	sign2
	)

Sign data.

Parameters

secretKey	Pointer to the secret key, input.
text	Pointer to the message, input.
randString	Pointer to random string, input.
sign1	Pointer to signature part 1, output.
sign2	Pointer to signature part 2, output.

Returns: Status

 {
   return (uint8_t)ecc_ecdsa_sign((uint32_t*)secretKey, (uint32_t*)text, (uint32_t*)randString,
                              (uint32_t*)sign1, (uint32_t*)sign2);
 }

uint8_t ECC_ECDSA_verify	(	uint32_t *	publicKey_x,
		uint32_t *	publicKey_y,
		uint32_t *	text,
		uint32_t *	sign1,
		uint32_t *	sign2
	)

Verify signature.

Parameters

publicKey_x	Pointer to public key X-coordinate, input.
publicKey_y	Pointer to public key Y-coordinate, input.
text	Pointer to message data, input.
sign1	Pointer to signature part 1, input.
sign2	Pointer to signature part 2, input.

Returns: Status

 {
   return (uint8_t)ecc_ecdsa_verify((uint32_t*)publicKey_x, (uint32_t*)publicKey_y, (uint32_t*)text,
                               (uint32_t*)sign1, (uint32_t*)sign2);
 }

uint8_t ECC_generateKey	(	uint32_t *	randString,
		uint32_t *	privateKey,
		uint32_t *	publicKey_x,
		uint32_t *	publicKey_y
	)

Generate a key.

This is used for both ECDH and ECDSA.

Parameters

randString	Pointer to random string, input.
privateKey	Pointer to the private key, output.
publicKey_x	Pointer to public key X-coordinate, output.
publicKey_y	Pointer to public key Y-coordinate, output.

Returns: Status

 {
   return (uint8_t)ecc_generatekey((uint32_t*)randString, (uint32_t*)privateKey,
                                   (uint32_t*)publicKey_x, (uint32_t*)publicKey_y);
 
 }

void ECC_initialize ( uint32_t * pWorkzone )

Pass pointer to ECC memory allocation to ECC engine.

This function can be called again to point the ECC workzone at a different memory buffer.

Parameters

pWorkzone Pointer to memory allocated for computations, input. See description at beginning of ECC section for memory requirements.

Returns: None

 {
   // Initialize curve parameters
   //data_p  = (uint32_t *)PARAM_P;
   *((uint32_t **)0x20004f48) = (uint32_t *)PARAM_P;
 
   //data_r  = (uint32_t *)PARAM_R;
   *((uint32_t **)0x20004f4c) = (uint32_t *)PARAM_R;
 
   //data_a  = (uint32_t *)PARAM_A;
   *((uint32_t **)0x20004f50) = (uint32_t *)PARAM_A;
 
   //data_b  = (uint32_t *)PARAM_B;
   *((uint32_t **)0x20004fa8) = (uint32_t *)PARAM_B;
 
   //data_Gx = (uint32_t *)PARAM_GX;
   *((uint32_t **)0x20004fa0) = (uint32_t *)PARAM_GX;
 
   //data_Gy = (uint32_t *)PARAM_GY;
   *((uint32_t **)0x20004fa4) = (uint32_t *)PARAM_GY;
 
   // Initialize window size
   //win = (uint8_t) ECC_WINDOW_SIZE;
   *((uint8_t *)0x20004f40) = (uint8_t) ECC_WINDOW_SIZE;
 
   // Initialize work zone
   //workzone = (uint32_t *) pWorkzone;
   *((uint32_t **)0x20004f44) = (uint32_t *) pWorkzone;
 }

uint8_t SHA256_execute	(	SHA256_memory_t *	config,
		uint8_t *	pBufIn,
		uint32_t	bufLen
	)

Perform SHA256.

Must call SHA256_output() to receive output from this operation.

Parameters

config	Pointer to memory for operations, input.
pBufIn	Pointer to input text, input.
bufLen	Length of input, input.

Returns: Status

 {
   return (uint8_t)sha256_execute(memory,pBufIn, bufLen);
 }

uint8_t SHA256_initialize ( SHA256_memory_t * workZone )

Intializes the SHA256 engine.

This function must be called once before all other SHA256 functions other than SHA256_runFullAlgorithm().

Parameters

workZone Pointer to memory for operations, input.

Returns: Status

 {
   return (uint8_t)sha256_initialize(memory);
 }

uint8_t SHA256_output	(	SHA256_memory_t *	memory,
		uint8_t *	pBufOut
	)

Complete the process by passing the modified data back.

Parameters

memory	Pointer to memory for operations, input.
pBufOut	Pointer to output buffer, output. Buffer must be at least 32 bytes long.

Returns: Status

 {
   return (uint8_t)sha256_output(memory, pBufOut);
 }

uint8_t SHA256_runFullAlgorithm	(	SHA256_memory_t *	memory,
		uint8_t *	pBufIn,
		uint32_t	bufLen,
		uint8_t *	pBufOut
	)

Perform SHA256 on the input data.

The input and output buffer can point to the same memory. This is the equivalent of calling SHA256_initialize(), SHA256_execute() and SHA256_output() sequentially.

Parameters

memory	Pointer to memory for operations, input.
pBufIn	Pointer to input buffer, input.
bufLen	Length of input.
pBufOut	Pointer to output buffer, output.

Returns: Status

 {
   return (uint8_t)sha256_runfullalg(memory, pBufOut, pBufIn, bufLen);
 }

Macro Definition Documentation

#define ECC_A_COEF_LENGTH_ZERO 0xC5

#define ECC_A_COEF_TOO_LONG 0x5C

#define ECC_BAD_WINDOW_SIZE 0x66

#define ECC_DIGEST_LENGTH_ZERO 0x72

#define ECC_DIGEST_TOO_LONG 0x27

#define ECC_ECC_KEY_LENGTH_ZERO 0x52

#define ECC_ECC_KEY_TOO_LONG 0x25

#define ECC_ECDH_COMMON_KEY_OK ECC_SCALAR_MUL_OK

#define ECC_ECDH_KEYGEN_OK ECC_SCALAR_MUL_OK

#define ECC_ECDSA_INVALID_SIGNATURE 0x5A

#define ECC_ECDSA_KEYGEN_OK ECC_SCALAR_MUL_OK

#define ECC_ECDSA_SIGN_OK 0x32

#define ECC_ECDSA_VALID_SIGNATURE 0xA5

#define ECC_MODULUS_EVEN 0xDC

#define ECC_MODULUS_LARGER_THAN_255_WORDS 0xD2

#define ECC_MODULUS_LENGTH_ZERO 0x08

#define ECC_MODULUS_MSW_IS_ZERO 0x30

#define ECC_ORDER_EVEN 0x82

#define ECC_ORDER_LARGER_THAN_255_WORDS 0x28

#define ECC_ORDER_LENGTH_ZERO 0x6C

#define ECC_ORDER_MSW_IS_ZERO 0x23

#define ECC_ORDER_TOO_LONG 0xC6

#define ECC_PRIME_NIST256_CURVE

#define ECC_SCALAR_LENGTH_ZERO 0x53

#define ECC_SCALAR_MUL_OK 0x99

#define ECC_SCALAR_TOO_LONG 0x35

#define ECC_SIG_P1_LENGTH_ZERO 0x12

#define ECC_SIG_P1_TOO_LONG 0x11

#define ECC_SIG_P2_LENGTH_ZERO 0x21

#define ECC_SIG_P2_TOO_LONG 0x22

#define ECC_WINDOW_SIZE 3

Referenced by ECC_initialize().

#define ECC_X_COORD_LENGTH_ZERO 0xC3

#define ECC_X_COORD_TOO_LONG 0x3C

#define ECC_Y_COORD_LENGTH_ZERO 0x56

#define ECC_Y_COORD_TOO_LONG 0x65

Data Structures

Functions

Detailed Description

Function Documentation

Macro Definition Documentation