Projects/NUCLEO-WB15CC/Examples/PKA/PKA_ECDSA_Verify_IT/readme.txt


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

/**
  @page PKA_ECDSA_Verify_IT ECDSA verification example
  
  @verbatim
  ******************************************************************************
  * @file    PKA/PKA_ECDSA_Verify_IT/readme.txt 
  * @author  MCD Application Team
  * @brief   Description of the ECDSA verification example
  ******************************************************************************
  *
  * Copyright (c) 2019-2021 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 determine if a given signature is valid regarding the Elliptic curve digital signature algorithm
(ECDSA) in interrupt mode.

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 (ZIP SigGen.rsp)"

This test vector has been chosen to demonstrate the behavior in a case where the input signature
is valid. A second input is provided where one element of the hash message has been modified to 
demonstrate the behavior in a case where the signature is invalid. Their definitions are included 
in SigVer.c. You can refer to this file for more information.

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 this example, the PKA interrupt is triggered at the end of the operation. The interrupt handler then
call the pka callback where a global variable is used to notify the main function.

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

Security, PKA, NIST, CAVP, ECDSA verification

@par Directory contents 
  
  - PKA/PKA_ECDSA_Verify_IT/Inc/stm32wbxx_hal_conf.h    HAL configuration file
  - PKA/PKA_ECDSA_Verify_IT/Inc/stm32wbxx_it.h          Interrupt handlers header file
  - PKA/PKA_ECDSA_Verify_IT/Inc/main.h                  Header for main.c module
  - PKA/PKA_ECDSA_Verify_IT/Src/stm32wbxx_it.c          Interrupt handlers
  - PKA/PKA_ECDSA_Verify_IT/Src/main.c                  Main program
  - PKA/PKA_ECDSA_Verify_IT/Src/stm32wbxx_hal_msp.c     HAL MSP module 
  - PKA/PKA_ECDSA_Verify_IT/Src/system_stm32wbxx.c      STM32WBxx system source file
  - PKA/PKA_ECDSA_Verify_IT/Src/prime256v1.c            Description of P-256 (ECDSA-256)
  - PKA/PKA_ECDSA_Verify_IT/Inc/prime256v1.h            Header for prime256v1.c
  - PKA/PKA_ECDSA_Verify_IT/Src/SigVer.c                Reflect the content of the test vector from SigVer.rsp
  - PKA/PKA_ECDSA_Verify_IT/Src/SigVer.rsp              Extract from NIST CAVP
  - PKA/PKA_ECDSA_Verify_IT/Inc/SigVer.h                Header of SigVer.c

@par Hardware and Software environment

  - This example runs on STM32WB15CCUx devices.
  
  - This example has been tested with an STMicroelectronics NUCLEO-WB15CC
    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>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */