Implement client api to generate and cache a random key#437
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new keystore operation and client API for server-side generation of random key material directly into the keystore cache, returning only the assigned keyId to the client. This fits into wolfHSM’s key-management workflow by enabling “generate-on-server then use-by-ID” flows without uploading key bytes from the client.
Changes:
- Introduces
wh_Client_KeyCacheRandom*request/response/blocking APIs and corresponding wire message + translation. - Adds server keystore handling for
WH_KEY_CACHE_RANDOM, generating random bytes into a cache slot via the server RNG. - Adds a crypto client test for key generation + basic validation, and documents the new API in the manual/API reference.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| wolfhsm/wh_message.h | Adds WH_KEY_CACHE_RANDOM action ID. |
| wolfhsm/wh_message_keystore.h | Defines CacheRandom request message + translator prototype. |
| wolfhsm/wh_client.h | Declares new wh_Client_KeyCacheRandom* public APIs with docstrings. |
| src/wh_client.c | Implements the new client request/response/blocking helpers. |
| src/wh_server_keystore.c | Adds _KeystoreCacheRandomKey() and server handler for the new action. |
| src/wh_message_keystore.c | Implements request translation for CacheRandom. |
| test/wh_test_crypto.c | Adds whTest_KeyCacheRandom and wires it into the crypto client test flow. |
| docs/src/chapter05.md | Adds a user-facing example and conceptual documentation for server RNG key caching. |
| docs/src/appendix01.md | Adds API reference documentation for the new functions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
AlexLanzano
marked this pull request as draft
July 8, 2026 20:07
AlexLanzano
force-pushed
the
gen-rng-key
branch
2 times, most recently
from
July 8, 2026 20:46
8c0dc0e to
8bb2ab6
Compare
bigbrett
requested changes
Jul 9, 2026
bigbrett
left a comment
bigbrett
left a comment
Contributor
There was a problem hiding this comment.
overall looks good, just a few tweaks
bigbrett
approved these changes
Jul 10, 2026
bigbrett
reviewed
Jul 10, 2026
wolfSSL-Fenrir-bot
left a comment
wolfSSL-Fenrir-bot
left a comment
There was a problem hiding this comment.
Fenrir Automated Review — PR #437
Scan targets checked: wolfhsm-core-bugs, wolfhsm-crypto-bugs, wolfhsm-src
No new issues found in the changed files. ✅
bigbrett
previously approved these changes
Jul 13, 2026
bigbrett
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add wh_Client_KeyCacheRandom client API to have the server generate a key from its RNG, cache it, and return only the keyId
Add the client request/response/blocking triplet: wh_Client_KeyCacheRandomRequest_ex, wh_Client_KeyCacheRandomRequest, wh_Client_KeyCacheRandomResponse, and the blocking wh_Client_KeyCacheRandom
Add WH_KEY_CACHE_RANDOM keystore action and whMessageKeystore_CacheRandomRequest message (reusing CacheResponse) with its wh_MessageKeystore_TranslateCacheRandomRequest translation function
Add server handler for WH_KEY_CACHE_RANDOM plus the _KeystoreCacheRandomKey helper, generating random bytes directly into a cache slot via wc_RNG_GenerateBlock
Add whTest_KeyCacheRandom test (generate → export-verify size/label/non-zero → uniqueness → evict) wired into the crypto client test suite
Document the new API in docs/