Skip to content

Commit 60f442b

Browse files
committed
Fix formatting inconsistencies in README.md
1 parent bab7677 commit 60f442b

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

wolfcrypt/src/port/tropicsquare/README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# wolfSSL TROPIC01 Secure Element Integration Guide
22

3-
![wolfSSL+TROPIC01](https://img.shields.io/badge/wolfSSL-TROPIC01-blue)
3+
![wolfSSL+TROPIC01](https://img.shields.io/badge/wolfSSL-TROPIC01-blue)
44

55

66
Integration guide for using Tropic Square's TROPIC01 secure element with wolfSSL/wolfCrypt cryptography library.
@@ -40,16 +40,16 @@ The TROPIC01 datasheet is available via [this link](https://www.nxp.com/docs/en/
4040
- Electromagnetic pulse detector
4141
- Laser detector
4242
- Active shield
43-
- **Interface to Host MCU/MPU**:
43+
- **Interface to Host MCU/MPU**:
4444
- SPI
45-
- Encrypted channel with forward secrecy
45+
- Encrypted channel with forward secrecy
4646
- **Entropy Source**:
4747
- Physically Unclonable Function (PUF)
4848
- True Random Number Generator (TRNG)
4949

50-
### Available Evaluation and Development Kits
50+
### Available Evaluation and Development Kits
5151
- USB Stick with TROPIC01 ([here](https://github.com/tropicsquare/tropic01?tab=readme-ov-file#usb-stick-with-tropic01))
52-
- Raspberry PI shield ([here](https://github.com/tropicsquare/tropic01?tab=readme-ov-file#rpi-shield-ts1501))
52+
- Raspberry PI shield ([here](https://github.com/tropicsquare/tropic01?tab=readme-ov-file#rpi-shield-ts1501))
5353
- Arduino shield ([here](https://github.com/tropicsquare/tropic01?tab=readme-ov-file#arduino-shield-ts14))
5454

5555
### Get samples
@@ -59,9 +59,9 @@ To get samples and DevKits, please fill in [this form](https://tropicsquare.com/
5959

6060
### Pre-requirements
6161
1. Get one of the targeted hardware platforms. For example, Linux PC + TROPIC01 USB stick or Raspberry PI 3/4/5 + TROPIC01 RPI shield
62-
2. Install toolchain (incl. compiler or cross-compiler). For example, GNU Toolchain (gcc) or ARM cross-compiling toolchain (armv8-rpi3-linux-gnueabihf)
63-
3. Install CMake and Autotools
64-
4. Install Git
62+
2. Install toolchain (incl. compiler or cross-compiler). For example, GNU Toolchain (gcc) or ARM cross-compiling toolchain (armv8-rpi3-linux-gnueabihf)
63+
3. Install CMake and Autotools
64+
4. Install Git
6565

6666
Some guidelines for RPi are available [here](https://earthly.dev/blog/cross-compiling-raspberry-pi/)
6767

@@ -79,8 +79,8 @@ $ sudo apt install wiringpi
7979

8080
For the integration with wolfSSL, there are a few pre-defined slots for the secure keys storage (the slots mapping might be changed in tropic01.h):
8181
```sh
82-
TROPIC01_AES_RMEM_SLOT_DEFAULT 1 // slot in R-memory for AES key
83-
TROPIC01_ED25519_PUB_RMEM_SLOT_DEFAULT 2 // slot in R-memory for ED25519 Public key
82+
TROPIC01_AES_RMEM_SLOT_DEFAULT 1 // slot in R-memory for AES key
83+
TROPIC01_ED25519_PUB_RMEM_SLOT_DEFAULT 2 // slot in R-memory for ED25519 Public key
8484
TROPIC01_ED25519_PRIV_RMEM_SLOT_DEFAULT 3 //slot in R-memory for ED25519 Private key
8585
TROPIC01_ED25519_ECC_SLOT_DEFAULT 1 // slot in ECC keys storage for both public and private keys
8686
PAIRING_KEY_SLOT_INDEX_0 0 //pairing keys slot
@@ -105,22 +105,22 @@ Or run the following commands:
105105
### Build wolfSSL
106106
1. Clone wolfSSL from the wolfSSL GitHub (https://github.com/wolfSSL/wolfssl)
107107

108-
2. Make sure that the version of wolfSSL supports TROPIC01 - check if the folder wolfssl/wolfcrypt/src/port/tropicsquare exists
108+
2. Make sure that the version of wolfSSL supports TROPIC01 - check if the folder wolfssl/wolfcrypt/src/port/tropicsquare exists
109109

110110
3. To compile wolfSSL with TROPIC01 support using Autoconf/configure:
111-
111+
112112
```sh
113113
$ cd wolfssl
114114
$ ./autogen.sh
115115
$ ./configure --with-tropic01=PATH --enable-cryptocb --enable-static --disable-crypttests --disable-examples --disable-shared --enable-ed25519
116116
$ make
117117
$ sudo make install
118118
```
119-
where PATH is an absolute path to the libtropic folder, for example
119+
where PATH is an absolute path to the libtropic folder, for example
120120

121121
--with-tropic01=/home/pi/git/libtropic
122-
123-
For the debugging output, add
122+
123+
For the debugging output, add
124124

125125
--enable-debug
126126

@@ -138,7 +138,7 @@ If necessary, open and edit the Makefile in this folder
138138

139139
Set correct values for CC and LIBTROPIC_DIR variables, for example:
140140

141-
CC = gcc
141+
CC = gcc
142142

143143
LIBTROPIC_DIR = /home/pi/git/libtropic
144144

@@ -181,13 +181,13 @@ Generated 32 random bytes:
181181
RNG test completed successfully
182182

183183
AES test starting:
184-
TROPIC01: CryptoCB: AES request
184+
TROPIC01: CryptoCB: AES request
185185
TROPIC01: Get AES Key: Retrieving key from slot 1
186186
TROPIC01: Get AES Key: Key retrieved successfully
187187
Plain message:
188-
01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F 10
188+
01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F 10
189189
Encrypted message:
190-
89 44 11 3E 2E 07 52 9C CB 5F B1 70 7E 9C 42 D6
190+
89 44 11 3E 2E 07 52 9C CB 5F B1 70 7E 9C 42 D6
191191
AES test completed successfully
192192

193193
ED25519 COMPREHENSIVE TESTING SUITE
@@ -227,5 +227,5 @@ A73A562B 3D03F429 8706309D 63E2120B
227227
wolfSSL Entering wolfCrypt_Cleanup
228228
```
229229

230-
231-
230+
231+

0 commit comments

Comments
 (0)