Skip to content

Add docs to talk about enabling SHE code #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
night1rider wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs to talk about enabling SHE code #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions wolfSSL/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ nav:
- "Algorithms - RIPEMD": group__RIPEMD.md
- "Algorithms - RSA": group__RSA.md
- "Algorithms - SHA 128/224/256/384/512": group__SHA.md
- "Algorithms - SHE": group__SHE.md
- "Algorithms - SipHash": group__SipHash.md
- "Algorithms - SrtpKdf": group__SrtpKdf.md
- "Algorithms - SRP": group__SRP.md
Expand Down Expand Up @@ -137,6 +138,7 @@ nav:
- siphash_8h.md
- srp_8h.md
- ssl_8h.md
- wc__she_8h.md
- tfm_8h.md
- types_8h.md
- wc__encrypt_8h.md
Expand Down
20 changes: 20 additions & 0 deletions wolfSSL/src/chapter02.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4198,6 +4198,26 @@ Enabled by default on x86\_64.

Enable wolfSSL SHA-512 support

### `--enable-she`

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.

Two modes are available:

- `--enable-she=standard` - Standard SHE support (defines `WOLFSSL_SHE`)
- `--enable-she=extended` - Standard plus extended overrides for custom KDF constants and message headers (defines `WOLFSSL_SHE` and `WOLFSSL_SHE_EXTENDED`)

SHE automatically enables its dependencies: AES, AES-CBC, AES-direct, and CMAC.

The following defines can be used to compile out optional features:

- `NO_WC_SHE_GETUID` - Compile out `wc_SHE_GetUID` callback
- `NO_WC_SHE_GETCOUNTER` - Compile out `wc_SHE_GetCounter` callback
- `NO_WC_SHE_IMPORT_M123` - Compile out `wc_SHE_ImportM1M2M3`
- `NO_WC_SHE_EXPORTKEY` - Compile out `wc_SHE_ExportKey` callback
- `NO_WC_SHE_LOADKEY` - Compile out all `wc_SHE_LoadKey` / `wc_SHE_LoadKey_Verify` convenience wrappers
- `WC_SHE_SW_DEFAULT` - Enable software-only default UID and counter for testing without hardware

### `--enable-sessioncerts`

Enable session cert storing
Expand Down
Loading