Skip to content

Client API Reference

This chapter is the complete reference for the wolfHSM client API. It is generated directly from the documentation comments in the public client headers (wolfhsm/wh_client.h, wolfhsm/wh_client_crypto.h, and wolfhsm/wh_client_she.h), so it always tracks the source. For a conceptual, feature-oriented walkthrough of what these functions are for, see Features; this chapter documents the precise signatures, parameters, and return values.

  • Client API — client context lifecycle, communication, NVM, keystore, certificate, image-manager, and counter operations (wolfhsm/wh_client.h).
  • Client Crypto API — split-transaction, non-blocking crypto request/response calls (wolfhsm/wh_client_crypto.h).
  • Client SHE API — AUTOSAR SHE (Secure Hardware Extension) client interface: key update protocol (M1–M5), encrypted message handling, secure boot, deterministic PRNG, and status register access (wolfhsm/wh_client_she.h).