diff options
Diffstat (limited to 'Projects/NUCLEO-WB35CE/Examples/PKA/PKA_ECDSA_Sign/readme.txt')
| -rw-r--r-- | Projects/NUCLEO-WB35CE/Examples/PKA/PKA_ECDSA_Sign/readme.txt | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB35CE/Examples/PKA/PKA_ECDSA_Sign/readme.txt b/Projects/NUCLEO-WB35CE/Examples/PKA/PKA_ECDSA_Sign/readme.txt new file mode 100644 index 000000000..c9e7d43c2 --- /dev/null +++ b/Projects/NUCLEO-WB35CE/Examples/PKA/PKA_ECDSA_Sign/readme.txt @@ -0,0 +1,86 @@ +/** + @page PKA_ECDSA_Sign ECDSA signature example + + @verbatim + ****************************************************************************** + * @file PKA/PKA_ECDSA_Sign/readme.txt + * @author MCD Application Team + * @brief Description of the ECDSA signature example + ****************************************************************************** + * + * Copyright (c) 2019 STMicroelectronics. All rights reserved. + * + * This software component is licensed by ST under BSD 3-Clause license, + * the "License"; You may not use this file except in compliance with the + * License. You may obtain a copy of the License at: + * opensource.org/licenses/BSD-3-Clause + * + ****************************************************************************** + @endverbatim + +@par Example Description + +How to compute a signed message regarding the Elliptic curve digital signature algorithm +(ECDSA). + +For this example, a test vector have been extracted from National Institute of Standards and Technology (NIST) + - Cryptographic Algorithm Validation Program (CAVP) in order to demonstrate the usage of the hal. +This reference files can be found under: +"http://csrc.nist.gov/groups/STM/cavp/documents/dss/186-3ecdsatestvectors.zip (SigGen.txt)" + +This test vector has been choosen to demonstrate how to sign a message. The inputs and outputs definitions are included +in SigGen.c. The output signature is composed of two parts called "R" and "S". You can refer to this file for more informations. + +The selected curve for this example is P-256 (ECDSA-256) published by NIST in +Federal Information Processing Standards Publication FIPS PUB 186-4. The description +of this curve is present in file Src/prime256v1.c. + +In case of success, the LED2 (GREEN) is ON. +In case of any error, the LED2 (GREEN) is toggling slowly. + +@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 + +PKA, PKA_ECDSA_Sign, Security, NIST, CAVP, ECDSA verification + +@par Directory contents + + - PKA/PKA_ECDSA_Sign/Inc/stm32wbxx_hal_conf.h HAL configuration file + - PKA/PKA_ECDSA_Sign/Inc/stm32wbxx_it.h Interrupt handlers header file + - PKA/PKA_ECDSA_Sign/Inc/main.h Header for main.c module + - PKA/PKA_ECDSA_Sign/Src/stm32wbxx_it.c Interrupt handlers + - PKA/PKA_ECDSA_Sign/Src/main.c Main program + - PKA/PKA_ECDSA_Sign/Src/stm32wbxx_hal_msp.c HAL MSP module + - PKA/PKA_ECDSA_Sign/Src/system_stm32wbxx.c STM32WBxx system source file + - PKA/PKA_ECDSA_Sign/Src/prime256v1.c Description of P-256 (ECDSA-256) + - PKA/PKA_ECDSA_Sign/Inc/prime256v1.h Header for prime256v1.c + - PKA/PKA_ECDSA_Sign/Src/SigGen.c Reflect the content of the test vector from SigGen.txt + - PKA/PKA_ECDSA_Sign/Src/SigGen.txt Extract from NIST CAVP + - PKA/PKA_ECDSA_Sign/Inc/SigGen.h Header of SigGen.c + +@par Hardware and Software environment + + - This example runs on STM32WB35xx devices. + + - This example has been tested with an STMicroelectronics NUCLEO-WB35CE + 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 + + * <h3><center>© COPYRIGHT STMicroelectronics</center></h3> + */ +
\ No newline at end of file |