Data Fields
AESCCM_Operation Struct Reference

Struct containing the parameters required for encrypting/decrypting and authenticating/verifying a message. More...

#include <AESCCM.h>

Collaboration diagram for AESCCM_Operation:
Collaboration graph
[legend]

Data Fields

CryptoKeykey
 
uint8_t * aad
 
uint8_t * input
 
uint8_t * output
 
uint8_t * nonce
 
uint8_t * mac
 
size_t aadLength
 
size_t inputLength
 
uint8_t nonceLength
 
uint8_t macLength
 
bool nonceInternallyGenerated
 

Detailed Description

Struct containing the parameters required for encrypting/decrypting and authenticating/verifying a message.

Field Documentation

§ key

CryptoKey* AESCCM_Operation::key

A previously initialized CryptoKey

§ aad

uint8_t* AESCCM_Operation::aad

A buffer of length aadLength containing additional authentication data to be authenticated/verified but not encrypted/decrypted.

§ input

uint8_t* AESCCM_Operation::input
  • Encryption: The plaintext buffer to be encrypted and authenticated in the CCM operation.
  • Decryption: The ciphertext to be decrypted and verified.

§ output

uint8_t* AESCCM_Operation::output
  • Encryption: The output ciphertext buffer that the encrypted plaintext is copied to.
  • Decryption: The plaintext derived from the decrypted and verified ciphertext is copied here.

§ nonce

uint8_t* AESCCM_Operation::nonce

A buffer containing a nonce. Nonces must be unique to each CCM operation and may not be reused. If nonceInternallyGenerated is set the nonce will be generated by this function call and copied to this buffer.

§ mac

uint8_t* AESCCM_Operation::mac
  • Encryption: The buffer where the message authentication code is copied.
  • Decryption: The buffer containing the received message authentication code.

§ aadLength

size_t AESCCM_Operation::aadLength

Length of aad in bytes. Either aadLength or plaintextLength must benon-zero. encrypted.

§ inputLength

size_t AESCCM_Operation::inputLength

Length of the input and output in bytes. Either aadLength or inputLength must be non-zero.

§ nonceLength

uint8_t AESCCM_Operation::nonceLength

Length of nonce in bytes. Valid nonce lengths are [7, 8, ... 13].

§ macLength

uint8_t AESCCM_Operation::macLength

Length of mac in bytes. Valid MAC lengths are [0, 4, 6, 8, 10, 12, 14, 16]. A length of 0 disables authentication and verification. This is only permitted when using CCM*.

§ nonceInternallyGenerated

bool AESCCM_Operation::nonceInternallyGenerated

When true, the nonce buffer passed into the AESCCM_setupEncrypt() and AESCCM_oneStepEncrypt() functions will be overwritten with a randomly generated nonce. Not supported by all implementations.


The documentation for this struct was generated from the following file:
© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale