STM32CubeF7/Projects/STM32F769I_EVAL/Examples/CRYP/CRYP_AESCCM_IT
Tasnim 767d083e20 Release v1.17.2 2024-06-06 15:48:41 +01:00
..
EWARM Release v1.16.2 2021-12-14 09:57:38 +01:00
Inc Release v1.17.0 2022-07-04 11:37:52 +01:00
MDK-ARM Release v1.16.2 2021-12-14 09:57:38 +01:00
SW4STM32 Release v1.17.2 2024-06-06 15:48:41 +01:00
Src Release v1.16.2 2021-12-14 09:57:38 +01:00
readme.txt Release v1.16.2 2021-12-14 09:57:38 +01:00

readme.txt

/**
  @page CRYP_AESCCM_IT  AES CCM  Example using IT
  
  @verbatim
  ******************************************************************************
  * @file    CRYP/CRYP_AES_CCM_IT/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the CRYP AES CCM encryption/decryption and TAG 
  *          generation.
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2016 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  @endverbatim

@par Example Description 


How to use the CRYPTO peripheral to encrypt/decrypt data(Plaintext/Ciphertext) in
interrupt mode using AES with Combined Cipher Machine (CCM) then generate the authentication TAG .

At the beginning of the main program the HAL_Init() function is called to reset 
all the peripherals, initialize the Flash interface and the systick.
The SystemClock_Config() function is used to configure the system clock for STM32F777xx/STM32F779xx Devices :
The CPU at 216MHz 


The AES-CCM mode requires:
1. Plaintext/Ciphertext: which will be authenticated and encrypted/decrypted. 
   It's size must be a multiple of 4 words. if it's not it must be padded.
    
2. B1 block or Header ( also named associated data): that will be authenticated 
   but not encrypted.

3. B0 block : first block B0 is formatted by Flags, Nonce and the octet length
   of Plaintext.

4. Key: is the parameter which determines the cipher text. In this example the key
   size is 192 bits = 6 words.

CRYP peripheral must be initialized once from the beginning, then for each operation of 
encryption/decryption, only configuration(HAL_CRYP_SetConfig) should be made if needed.
 
The AES-CCM encryption and TAG generation provides :
1. Encryptedtext: which is the encryption result of Plaintext, it is compared to Ciphertext.
2. TAG: the Message Authentication Code generated after the encryption and it's compared
   to ExpectedTAG.

The AES-CCM decryption and TAG generation provides :
1. Decryptedtext: which is the Decryption result of Ciphertext, it is compared to Plaintext.
2. TAG: the Message Authentication Code generated after the encryption and it's compared
   to ExpectedTAG.

 The encryption/decryption is performed in non-blocking mode using the HAL function
 "HAL_CRYP_Encrypt_IT" and "HAL_CRYP_Decrypt_IT". when compute is complete the
 output FIFO transfer completed callbacks set variable  "CrypCompleteDetected" 
 to 1 then result is compared to the expected buffer. 
   
STM32F779I_EVAL LEDs are used to monitor the encryption/decryption and TAG generation  status:
 - LED1(GREEN) is ON when encryption/decryption and TAG generation is right.
 - LED3(RED) is ON when encryption or decryption or TAG generation is wrong.
 
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
      based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
      a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
      than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
      To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
      
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Keywords

Security, CRYP, CCM , NIST Special Publication 800-38C, hardware CRYP, 

@Note<74>If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
 <20><><A0><A0><A0>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
<0A><><A0><A0><A0><A0>The address and the size of cacheable buffers (shared between CPU and other masters)  must be properly updated to be aligned to cache line size (32 bytes).

@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
<0A><><A0><A0><A0> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
<0A><><A0><A0><A0><A0><A0><A0><A0><A0><A0> <20> In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
<0A><><A0><A0><A0><A0><A0><A0><A0><A0><A0> <20> Even though the user must manage the cache coherence for read accesses.
<0A><><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
<0A><><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0><A0>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>

@par Directory contents 
  
  - CRYP/CRYP_AESCCM_IT/Inc/stm32f7xx_hal_conf.h    HAL configuration file
  - CRYP/CRYP_AESCCM_IT/Inc/stm32f7xx_it.h          Interrupt handlers header file
  - CRYP/CRYP_AESCCM_IT/Inc/main.h                  Header for main.c module
  - CRYP/CRYP_AESCCM_IT/Src/stm32f7xx_it.c          Interrupt handlers
  - CRYP/CRYP_AESCCM_IT/Src/main.c                  Main program
  - CRYP/CRYP_AESCCM_IT/Src/stm32f7xx_hal_msp.c     HAL MSP module 
  - CRYP/CRYP_AESCCM_IT/Src/system_stm32f7xx.c      STM32F7xx system source file

     
@par Hardware and Software environment

  - This example runs on STM32F777xx/STM32F779xx devices.
  
  - This example has been tested with an STMicroelectronics STM32F779I_EVAL board
    board and can be easily tailored to any other supported device 
    and development board.

@par How to use it ? 

In order to make the program work, you must do the following:
 - Open your preferred toolchain 
 - Rebuild all files and load your image into target memory
 - Run the example
 

 */