Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
ccmLIB.h File Reference
CCM Library API. More...
Go to the source code of this file.
Data Structures | |
struct | ccm_globals_t |
CCM global structure. The structure is used for configuring NONCE, adata and data before calling ccm_process_run(). More... | |
Functions | |
void | arm_ccm_mutex_lock (void) |
A function for locking CCM mutex if the OS is multi thread. | |
void | arm_ccm_mutex_unlock (void) |
A function for unlocking CCM mutex if the OS is multi thread. | |
ccm_globals_t * | ccm_sec_init (uint8_t sec_level, const uint8_t *ccm_key, uint8_t mode, uint8_t ccm_l) |
A function to initialize the CCM library. | |
int8_t | ccm_process_run (ccm_globals_t *ccm_params) |
A function to run the configured CCM process. |
Detailed Description
CCM Library API.
CCM Library API:
- ccm_sec_init(), A function to init CCM library.
- ccm_process_run(), A function to run configured CCM process.
CCM process sequence:
1. Init CCM library by, ccm key, ccm_sec_init()
- security level
- 128-bit CCM key
- mode: AES_CCM_ENCRYPT or AES_CCM_DECRYPT
- CCM L parameter: 2 or 3 depending on the nonce length (802.15.4 use 2 and TLS security use 3) 2. Define ADATA pointer and length, if returned global structure mic_len field is > 0 3. Set data pointer and length 4. Do configured CCM process ccm_process_run() 5. Check return value: -If 0 Process ok -< 0 MIC fail or parameter fail
CCM Mutex for Multi Thread System
If you are running a multi thread system and the CCM library will be used for multiple thread, do the following: 1. Add compiler flag to library build process CCM_USE_MUTEX. 2. Define OS-specific mutex at the application. 3. Implement arm_ccm_mutex_lock() arm_ccm_mutex_unlock() function for using the generated and initialized mutex.
Definition in file ccmLIB.h.
Function Documentation
void arm_ccm_mutex_lock | ( | void | ) |
A function for locking CCM mutex if the OS is multi thread.
If you are using single thread create an empty function.
void arm_ccm_mutex_unlock | ( | void | ) |
A function for unlocking CCM mutex if the OS is multi thread.
If you are using single thread create an empty function
int8_t ccm_process_run | ( | ccm_globals_t * | ccm_params ) |
A function to run the configured CCM process.
When AES_CCM_ENCRYPT mode is selected and MIC is needed, the library saves MIC right after the encrypted data.
- Parameters:
-
ccm_params CCM parameters
- Returns:
- 0 CCM process OK and when AES_CCM_DECRYPT mode was selected also MIC was correct.
- -1 Init not called or data or adata pointers or lengths are zero.
- -2 Null pointer given to function.
A function to run the configured CCM process.
- Parameters:
-
sec_level Used CCM security level (0-7). ccm_key pointer to 128-key. mode AES_CCM_ENCRYPT or AES_CCM_DECRYPT ccm_l cuold be 2 or 3. 2 when NONCE length is 13 and 3 when length is 12. (NONCE Len= (15-ccm_l))
- Returns:
- 0 CCM process OK and when AES_CCM_DECRYPT mode was selectected also MIC was correct.
- -1 Init have not called or data or adata pointers or lengths are zero.
- -2 Null pointer given to function
Definition at line 107 of file ccm_security.c.
ccm_globals_t* ccm_sec_init | ( | uint8_t | sec_level, |
const uint8_t * | ccm_key, | ||
uint8_t | mode, | ||
uint8_t | ccm_l | ||
) |
A function to initialize the CCM library.
- Parameters:
-
sec_level Used CCM security level (0-7). ccm_key Pointer to 128-key. mode AES_CCM_ENCRYPT or AES_CCM_DECRYPT. ccm_l Can be 2 or 3. 2 when NONCE length is 13 and 3 when 12. (NONCE length = (15-ccm_l))
- Returns:
- Pointer to Global CCM parameter buffer.
- 0 When parameter fails or CCM is busy.
A function to initialize the CCM library.
- Parameters:
-
sec_level Used CCM security level (0-7). ccm_key pointer to 128-key. mode AES_CCM_ENCRYPT or AES_CCM_DECRYPT ccm_l cuold be 2 or 3. 2 when NONCE length is 13 and 3 when length is 12. (NONCE Len= (15-ccm_l))
- Returns:
- Pointer to Global CCM paramameter buffer.
- 0 When parameter fail or CCM is Busy.
Definition at line 76 of file ccm_security.c.
Generated on Tue Jul 12 2022 18:18:56 by
