Skip to content

Nvm ids per client - #460

Draft
bigbrett wants to merge 19 commits into
wolfSSL:mainfrom
bigbrett:nvm-ids-per-client
Draft

Nvm ids per client#460
bigbrett wants to merge 19 commits into
wolfSSL:mainfrom
bigbrett:nvm-ids-per-client

Conversation

@bigbrett

Copy link
Copy Markdown
Contributor

No description provided.

Copilot AI review requested due to automatic review settings July 20, 2026 20:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR hardens and clarifies client-facing NVM object identifiers by translating client-supplied NVM ids into the server’s internal TYPE/USER/ID encoding (per-client namespaces + optional shared global namespace), while adding test/provisioning-only SHE key preprogram/destroy messages that remain compatible with the new NVM id translation.

Changes:

  • Add per-client NVM id translation in the server NVM message handlers, with an opt-out legacy mode (WOLFHSM_CFG_LEGACY_CLIENT_NVM).
  • Introduce gated, test/provisioning-only SHE key management messages/APIs (PreProgramKey, DestroyKey) and update tests/CI to use them.
  • Expand multiclient/stress tests and documentation to validate and explain the new NVM namespace semantics (including global/local/mixed variants).

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
wolfhsm/wh_settings.h Documents the new WOLFHSM_CFG_LEGACY_CLIENT_NVM compatibility switch.
wolfhsm/wh_message.h Adds new SHE actions for test key management.
wolfhsm/wh_message_she.h Defines new SHE request/response structs and translate APIs (gated).
wolfhsm/wh_client.h Documents client-facing NVM id encoding/namespace semantics.
wolfhsm/wh_client_she.h Declares gated test/provisioning-only SHE key management APIs.
test/wh_test_she.c Switches SHE key destruction helper to the new SHE destroy API.
test/wh_test_posix_threadsafe_stress.c Extends stress suite to run global/local/mixed namespace variants and validates data isolation.
test/wh_test_multiclient.c Adds a new NVM id-translation/isolation test suite (gated off in legacy mode).
test/wh_test_clientserver.c Updates test NVM id to remain valid under client-facing id constraints (1–255).
test/config/wolfhsm_cfg.h Increases NVM object count for tests; enables gated SHE test key management.
test-refactor/misc/wh_test_multiclient.c Mirrors the new NVM id-translation test suite in refactor tests.
test-refactor/config/wolfhsm_cfg.h Increases NVM object count; enables gated SHE test key management in refactor config.
test-refactor/client-server/wh_test_she.c Switches SHE key destruction helper to the new SHE destroy API.
src/wh_server_she.c Implements gated server handlers for SHE preprogram/destroy key messages; updates state validation.
src/wh_server_nvm.c Implements client NVM id translation + legacy passthrough and list namespace filtering logic.
src/wh_message_she.c Implements translation helpers for the new SHE test key management messages (gated).
src/wh_client_she.c Implements gated client APIs for SHE preprogram/destroy via SHE message group (with response validation).
examples/posix/wh_posix_server/wolfhsm_cfg.h Increases example server’s NVM object count to align with heavier tests.
docs/src/9-Configuration.md Documents WOLFHSM_CFG_SHE_ENABLE_TEST_KEY_MGMT and WOLFHSM_CFG_LEGACY_CLIENT_NVM.
docs/src/6-Utilities.md Clarifies that whnvmtool ids are server-internal and how that interacts with client NVM namespaces.
docs/src/5-Features.md Adds a new section documenting client NVM namespaces + updates SHE helper documentation.
.github/workflows/build-and-test-stress.yml Increases stress CI timeout to account for more variants.
.github/workflows/build-and-test-clientonly.yml Builds CI server with gated SHE test key management so client SHE tests work.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/wh_server_nvm.c
Comment thread src/wh_server_nvm.c
Comment thread src/wh_server_nvm.c
@bigbrett
bigbrett force-pushed the nvm-ids-per-client branch from 8f07038 to 693e3e9 Compare July 20, 2026 21:58
@bigbrett
bigbrett force-pushed the nvm-ids-per-client branch from e600900 to 80e57ce Compare August 5, 2026 20:25

@wolfSSL-Fenrir-bot wolfSSL-Fenrir-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fenrir Automated Review — PR #460

Scan targets checked: wolfhsm-core-bugs, wolfhsm-crypto-bugs, wolfhsm-src

Findings: 2
2 finding(s) posted as inline comments (see file-level comments below)

This review was generated automatically by Fenrir. Reported findings require changes before merge.

Comment thread src/wh_server_cert.c
* unaffected. */
static whNvmId _CertTranslateFromClient(whServerContext* server, whNvmId reqId)
{
return wh_KeyId_TranslateObjectFromClient(WH_KEYTYPE_CERT,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cert handler translation lacks the unbound-client (client_id 0) guard added elsewhere in this PR · Logic errors

server->comm->client_id is 0 until COMM INIT binds it, so every cert verb from a pre-INIT connection resolves to WH_KEYUSER_GLOBAL. wh_Server_HandleNvmRequest, _GetId, _PreProgramKey and _DestroyKey all reject client_id == WH_KEYUSER_GLOBAL for this exact reason; the cert path added the same translation without the guard, so READTRUSTED/ERASETRUSTED reach USER=0 provisioned roots with a plain id.

Fix: Reject cert requests when server->comm->client_id == WH_KEYUSER_GLOBAL, mirroring the gate at the top of wh_Server_HandleNvmRequest.

Comment thread src/wh_server_counter.c
meta->id = WH_MAKE_KEYID(WH_KEYTYPE_COUNTER,
(uint16_t)server->comm->client_id,
(uint16_t)req.counterId);
meta->id = wh_KeyId_TranslateObjectFromClient(

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Counter handler translation lacks the unbound-client (client_id 0) guard added elsewhere in this PR · Logic errors

server->comm->client_id is 0 before COMM INIT, so wh_KeyId_TranslateObjectFromClient maps every counter verb from a pre-INIT connection into the WH_KEYUSER_GLOBAL namespace without the client setting WH_KEYID_CLIENT_GLOBAL_FLAG. The NVM and SHE handlers changed in this PR explicitly refuse that state.

Related known finding #4222 (similar but distinct): Both use server->comm->client_id to determine counter ownership in wh_Server_HandleCounter, but this candidate faults use before COMM INIT because client_id remains 0; #4222 faults COMM INIT accepting a spoofed nonzero client_id without identity binding. The triggering states, root causes, and required guards are distinct.

Fix: Reject counter requests when server->comm->client_id == WH_KEYUSER_GLOBAL, mirroring the gate in wh_Server_HandleNvmRequest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants