Skip to content

Commit 43882bd

Browse files
committed
Better instructions
1 parent a1938fd commit 43882bd

File tree

1 file changed

+26
-7
lines changed

1 file changed

+26
-7
lines changed

pq/stm32/README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,36 @@ $ make
2929

3030
## Configuring the STM32CubeIDE Project
3131

32-
Please see the following video for highlights on how the project was configured
33-
and how to configure wolfSSL to enable our PQM4 integration.
32+
Please see the following video for highlights on how to configure wolfSSL to
33+
enable our PQM4 integration.
3434

3535
https://www.youtube.com/watch?v=OK6MKXYiVBY
3636

37-
To setup the required PQM4 source files, please run the `setup_kyber.sh` script
38-
in this directory. It will clone releveant git repos from github and generate
39-
the directories and files you need.
37+
Detailed instructions on how to build a project with wolfssl can be found at:
38+
39+
https://github.com/wolfSSL/wolfssl/tree/master/IDE/STM32Cube
40+
41+
1. Follow instructions at the link above and make sure you can perform "Example
42+
for TLS v1.3 over UART".
43+
2. Run the `setup_kyber.sh` script in this directory. It will clone relevant
44+
git repos from github and generate the directories and files you need.
45+
3. Drag and drop the include files into `Inc` and the `pqm4_kyber512` directory
46+
into `Core`.
47+
4. Turn on the PQM4 integration.
48+
- Open the .ioc file
49+
- Click "Software Packs"
50+
- Click on the wolfSSL.I-CUBE-wolfSSL.<version> that appears.
51+
- In the Configuration box that appears, set "PQM4 Post-Quantum Integration
52+
Support" to "True"
53+
- Close the .ioc file and generate code.
54+
- Build your project.
55+
56+
For your reference, `wolfssl_stm32_pq` is a minimal starting project that has
57+
many things already configured. If you have a NUCLEO-F446ZE evaluation board
58+
Then you can skip step 1 and 4 and just use that.
4059

4160
Once you have successfully built and flashed the project, the STM32 terminal
42-
should should display the following menu:
61+
should should display the following menu:
4362

4463
```
4564
MENU
@@ -92,7 +111,7 @@ ECDSA [ SECP256R1] 256 sign 78 ops took 1.019 sec, avg 13.064 m
92111
ECDSA [ SECP256R1] 256 verify 38 ops took 1.012 sec, avg 26.632 ms, 37.549 ops/sec
93112
kyber_level1-kg 62 ops took 1.004 sec, avg 16.194 ms, 61.753 ops/sec
94113
kyber_level1-ed 28 ops took 1.043 sec, avg 37.250 ms, 26.846 ops/sec
95-
Benchmark complete
114+
Benchmark complete
96115
```
97116

98117
## Quantum safe TLS 1.3 Connection Over UART (Linux server, STM32 client)

0 commit comments

Comments
 (0)