Skip to content

Commit ef4fdf4

Browse files
authored
Merge pull request #263 from night1rider/SHE-Docs
Add docs to talk about enabling SHE code
2 parents a3c87ca + 2e9a57d commit ef4fdf4

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

wolfSSL/mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ nav:
7777
- "Algorithms - RIPEMD": group__RIPEMD.md
7878
- "Algorithms - RSA": group__RSA.md
7979
- "Algorithms - SHA 128/224/256/384/512": group__SHA.md
80+
- "Algorithms - SHE": group__SHE.md
8081
- "Algorithms - SipHash": group__SipHash.md
8182
- "Algorithms - SrtpKdf": group__SrtpKdf.md
8283
- "Algorithms - SRP": group__SRP.md
@@ -137,6 +138,7 @@ nav:
137138
- siphash_8h.md
138139
- srp_8h.md
139140
- ssl_8h.md
141+
- wc__she_8h.md
140142
- tfm_8h.md
141143
- types_8h.md
142144
- wc__encrypt_8h.md

wolfSSL/src/chapter02.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4198,6 +4198,26 @@ Enabled by default on x86\_64.
41984198
41994199
Enable wolfSSL SHA-512 support
42004200
4201+
### `--enable-she`
4202+
4203+
Enable SHE (Secure Hardware Extension) key update message generation support. SHE is an automotive security standard for secure key management in ECUs. This module provides software-based generation and verification of SHE key update messages (M1-M5) with optional hardware offload via crypto callbacks.
4204+
4205+
Two modes are available:
4206+
4207+
- `--enable-she=standard` - Standard SHE support (defines `WOLFSSL_SHE`)
4208+
- `--enable-she=extended` - Standard plus extended overrides for custom KDF constants and message headers (defines `WOLFSSL_SHE` and `WOLFSSL_SHE_EXTENDED`)
4209+
4210+
SHE automatically enables its dependencies: AES, AES-CBC, AES-direct, and CMAC.
4211+
4212+
The following defines can be used to compile out optional features:
4213+
4214+
- `NO_WC_SHE_GETUID` - Compile out `wc_SHE_GetUID` callback
4215+
- `NO_WC_SHE_GETCOUNTER` - Compile out `wc_SHE_GetCounter` callback
4216+
- `NO_WC_SHE_IMPORT_M123` - Compile out `wc_SHE_ImportM1M2M3`
4217+
- `NO_WC_SHE_EXPORTKEY` - Compile out `wc_SHE_ExportKey` callback
4218+
- `NO_WC_SHE_LOADKEY` - Compile out all `wc_SHE_LoadKey` / `wc_SHE_LoadKey_Verify` convenience wrappers
4219+
- `WC_SHE_SW_DEFAULT` - Enable software-only default UID and counter for testing without hardware
4220+
42014221
### `--enable-sessioncerts`
42024222
42034223
Enable session cert storing

0 commit comments

Comments
 (0)