From c27594212f2f89f5fc2e94faa8748215e993712d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Fri, 13 Nov 2026 09:28:22 +0100 Subject: [PATCH 01/17] Make wolfcert_buffer_free_secure public The test server is about to hand out its CA private key in a WolfCertBuffer, and freeing that with wolfcert_buffer_free() leaves the key bytes in freed heap. Export the wiping variant the library already uses internally. wolfcert_buffer_free() stays a plain free, so certificate and response buffers pay no wiping cost. --- src/internal.h | 2 -- wolfcert/types.h | 2 ++ 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/internal.h b/src/internal.h index 65d9f74..2e9a4a1 100644 --- a/src/internal.h +++ b/src/internal.h @@ -107,8 +107,6 @@ WOLFCERT_TEST_VIS int wolfcert_ca_load(WolfCertCa* ca, WolfCertStoreOps* store, void* heap); int wolfcert_ca_save(const WolfCertCa* ca, WolfCertStoreOps* store); WOLFCERT_TEST_VIS void wolfcert_ca_free(WolfCertCa* ca); -/* wolfcert_buffer_free() after wiping: for a buffer that held key material. */ -void wolfcert_buffer_free_secure(WolfCertBuffer* buf); /* Rebuild an issued certificate's subject from a decoded CSR. */ WOLFCERT_TEST_VIS int wolfcert_copy_csr_subject(const DecodedCert* dc, Cert* nc); diff --git a/wolfcert/types.h b/wolfcert/types.h index 9cad4e4..f2d3b1a 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -244,6 +244,8 @@ typedef struct { } WolfCertBuffer; WOLFCERT_API void wolfcert_buffer_free(WolfCertBuffer* buf); +/* wolfcert_buffer_free() after wiping data, for a buffer holding a key. */ +WOLFCERT_API void wolfcert_buffer_free_secure(WolfCertBuffer* buf); #ifdef __cplusplus } From da1d30f68d1ba24f9ebbebbb9ab518b73d3e88fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Fri, 13 Nov 2026 09:28:22 +0100 Subject: [PATCH 02/17] Remove the store; give the test server its CA as buffers Drop WolfCertStoreOps, wolfcert/store.h, src/store.c with its POSIX and in-memory backends, the WOLFCERT_ENABLE_POSIX_STORE / --enable-posix-store option and the WOLFCERT_HAVE_POSIX_STORE / WOLFCERT_NO_POSIX_STORE check in check_config.h. Nothing on the client side used the store: enroll, the CLI client, the examples and the Zephyr sample all handle their own files. The key and cert helpers were wolfcert_key_to_pem / wolfcert_key_from_pem plus one vtable call, which applications can already make. The vtable could not help where persistence is hard on a device either: a renewal has to replace the certificate and key together, which per-object writes cannot guarantee across a power cut, and a key held in a CryptoCb backend cannot be exported into it. Once in 1.0 it would have been frozen ABI; a store can still be added later without breaking anyone. The test server was the only user, for CA persistence. Its config loses ca_store and gains ca_cert / ca_key (PEM or DER, copied at start; both NULL generates a CA, one without the other is WOLFCERT_ERR_BAD_ARG), and wolfcert_server_get_ca() copies out the CA a server issues from, so a caller can keep a generated one for the next start. wolfcert_ca_load() now takes the two buffers and wolfcert_ca_save() is gone. The key is decoded and re-encoded, so a PKCS#8 RSA or ECC key comes back out under the PEM label that matches its body; a DER certificate or key with trailing bytes is refused rather than half-read. Removing ca_store from the middle of WolfCertServerCfgSrv breaks the ABI; the SOVERSION bump planned for 1.0 covers it. test_server_ca_store becomes test_server_ca and covers the DER and PEM round trip, a half or empty pair, the get_ca arguments, every algorithm reloading from both encodings, a PKCS#8 key, an ECC key without its public point, a padded certificate or key, mixed encodings, get_ca on a split-RA SCEP server, and the OOM sweep on the load path. The integration tests share one CA per process, minted with mint_self_id() and set through TEST_CA_CFG in tls_test_util.h, instead of a memory store. test_store and the Zephyr wolfcert.unit.store suite are removed. --- .github/workflows/nightly.yml | 4 +- .github/workflows/pr.yml | 3 +- .github/workflows/sanitizers.yml | 2 +- .github/workflows/zephyr.yml | 2 +- AGENTS.md | 8 +- CMakeLists.txt | 6 +- Makefile.am | 14 +- README.md | 5 +- configure.ac | 9 - docs/ARCHITECTURE.md | 46 +- docs/EMBEDDED.md | 12 +- docs/MIGRATING-FROM-WOLFSCEP.md | 1 - examples/user_settings.h.example | 5 +- scripts/ci/compile-freestanding.sh | 6 +- scripts/ci/freestanding-user_settings.h | 3 +- scripts/ci/wolfcert-only-user_settings.h | 1 - src/ca_issue.c | 212 +++-- src/internal.h | 7 +- src/server.c | 42 +- src/store.c | 463 ---------- tests/CMakeLists.txt | 12 +- tests/integration/test_est_async_roundtrip.c | 6 +- .../integration/test_est_chunked_robustness.c | 6 +- .../test_est_csr_attrs_apply_roundtrip.c | 4 +- .../integration/test_est_csr_attrs_enforce.c | 10 +- .../test_est_csr_attrs_roundtrip.c | 6 +- tests/integration/test_est_mldsa_roundtrip.c | 4 +- tests/integration/test_est_mtls_roundtrip.c | 33 +- .../integration/test_est_pending_roundtrip.c | 4 +- tests/integration/test_est_pha_roundtrip.c | 6 +- tests/integration/test_est_roundtrip.c | 6 +- tests/integration/test_est_tls_roundtrip.c | 31 +- tests/integration/test_scep_async_roundtrip.c | 24 +- tests/integration/test_scep_get_cert.c | 6 +- tests/integration/test_scep_poll_roundtrip.c | 8 +- tests/integration/test_scep_roundtrip.c | 14 +- tests/integration/test_server_stop_idle.c | 45 +- tests/integration/tls_test_util.h | 79 +- ...est_server_ca_store.c => test_server_ca.c} | 797 ++++++++---------- tests/unit/test_store.c | 122 --- wolfcert/check_config.h | 3 - wolfcert/options.h.in | 1 - wolfcert/server.h | 25 +- wolfcert/store.h | 81 -- wolfcert/wolfcert.h | 1 - zephyr/CMakeLists.txt | 3 - zephyr/README.md | 3 +- zephyr/include.am | 3 - .../tests/wolfcert_unit_store/CMakeLists.txt | 12 - zephyr/tests/wolfcert_unit_store/prj.conf | 4 - .../tests/wolfcert_unit_store/testcase.yaml | 14 - 51 files changed, 739 insertions(+), 1485 deletions(-) delete mode 100644 src/store.c rename tests/unit/{test_server_ca_store.c => test_server_ca.c} (53%) delete mode 100644 tests/unit/test_store.c delete mode 100644 wolfcert/store.h delete mode 100644 zephyr/tests/wolfcert_unit_store/CMakeLists.txt delete mode 100644 zephyr/tests/wolfcert_unit_store/prj.conf delete mode 100644 zephyr/tests/wolfcert_unit_store/testcase.yaml diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 337de17..d6d462c 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -44,8 +44,8 @@ jobs: - { name: cmake-mldsa-44off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-44off } - { name: cmake-mldsa-65off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-65off } - { name: cmake-mldsa-87off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-87off } - # Platform pieces compiled out (transport/store gates) - - { name: cmake-no-builtin-transport, os: ubuntu-latest, build: cmake, wolfssl: full, cmake_extra: "-DWOLFCERT_ENABLE_BUILTIN_TRANSPORT=OFF -DWOLFCERT_ENABLE_POSIX_STORE=OFF -DWOLFCERT_ENABLE_CLI=OFF -DWOLFCERT_ENABLE_SERVER=OFF" } + # Platform pieces compiled out (transport gate) + - { name: cmake-no-builtin-transport, os: ubuntu-latest, build: cmake, wolfssl: full, cmake_extra: "-DWOLFCERT_ENABLE_BUILTIN_TRANSPORT=OFF -DWOLFCERT_ENABLE_CLI=OFF -DWOLFCERT_ENABLE_SERVER=OFF" } # Constrained builds (unit tests only: single-thread / no-malloc) - { name: cmake-static-mem, os: ubuntu-latest, build: cmake, wolfssl: static-mem, cmake_extra: -DWOLFCERT_ENABLE_SERVER=OFF, ctest_exclude: "http|tls|roundtrip" } # No TLS and no test server over a static pool; stop_idle and get_cert diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 0212ae8..0113197 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -115,7 +115,7 @@ jobs: os: ubuntu-latest build: cmake wolfssl: mldsa-87off - # Platform pieces compiled out (the transport/store gates) + # Platform pieces compiled out (the transport gate) - name: cmake-no-builtin-transport os: ubuntu-latest build: cmake @@ -124,7 +124,6 @@ jobs: # skip themselves. cmake_extra: >- -DWOLFCERT_ENABLE_BUILTIN_TRANSPORT=OFF - -DWOLFCERT_ENABLE_POSIX_STORE=OFF -DWOLFCERT_ENABLE_CLI=OFF -DWOLFCERT_ENABLE_SERVER=OFF # Constrained builds (unit tests only: single-thread / no-malloc) diff --git a/.github/workflows/sanitizers.yml b/.github/workflows/sanitizers.yml index 08e9b55..b05d381 100644 --- a/.github/workflows/sanitizers.yml +++ b/.github/workflows/sanitizers.yml @@ -117,7 +117,7 @@ jobs: # No roundtrips: wolfSSL's asm crypto gives false Memcheck reports # without a suppression file. rc=0 - for bin in test_smoke test_keygen test_csr test_store test_parse_negative \ + for bin in test_smoke test_keygen test_csr test_parse_negative \ test_scep_msg; do path="build/tests/$bin" [ -x "$path" ] || { echo "skip (not built): $bin"; continue; } diff --git a/.github/workflows/zephyr.yml b/.github/workflows/zephyr.yml index 69a04ad..10e9945 100644 --- a/.github/workflows/zephyr.yml +++ b/.github/workflows/zephyr.yml @@ -74,7 +74,7 @@ jobs: "${{ github.workspace }}/scripts/ci/twister-assert-ran.py" \ "$HOME/twister-unit/twister.json" \ wolfcert.unit.smoke wolfcert.unit.keygen wolfcert.unit.csr \ - wolfcert.unit.csr_attrs wolfcert.unit.store \ + wolfcert.unit.csr_attrs \ wolfcert.unit.parse_negative wolfcert.unit.scep_msg - name: Start the host EST server diff --git a/AGENTS.md b/AGENTS.md index db1f622..5b12f6d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -91,12 +91,11 @@ install provides the library, the public headers, a generated | `WOLFCERT_ENABLE_SERVER` | `--enable-server` | on | Minimal EST/SCEP test server | | `WOLFCERT_ENABLE_CLI` | `--enable-cli` | on | `wolfcert-client`, `wolfcert-server` | | `WOLFCERT_ENABLE_BUILTIN_TRANSPORT` | `--enable-builtin-transport` | on | POSIX socket transport; turn off on targets with no sockets | -| `WOLFCERT_ENABLE_POSIX_STORE` | `--enable-posix-store` | on | File-based cert/key store | | `WOLFCERT_BUILD_SHARED` | (libtool `--enable-shared`) | on | Shared vs static library | | `WOLFCERT_USER_SETTINGS` | `--enable-user-settings` | off | Read features from `user_settings.h` instead of the generated `options.h` | A device build usually turns off the server and CLI, and the built-in -transport and POSIX store where the target has no sockets or filesystem. +transport where the target has no sockets. ## Configuration model @@ -185,9 +184,8 @@ wolfcert_cleanup(); | `wolfcert/wolfcert.h` | Umbrella header, `wolfcert_init` / `wolfcert_cleanup` | | `wolfcert/client.h` | High-level `wolfcert_client_*` API | | `wolfcert/est.h`, `wolfcert/scep.h` | Protocol one-shots, sessions, non-blocking `_nb` sessions | -| `wolfcert/types.h` | `WolfCertServerCfg`, `WolfCertKeyCfg`, `WolfCertCertMeta`, `WolfCertEncoding` (PEM or DER output), `WolfCertTransport`, `wolfcert_buffer_free` | +| `wolfcert/types.h` | `WolfCertServerCfg`, `WolfCertKeyCfg`, `WolfCertCertMeta`, `WolfCertEncoding` (PEM or DER output), `WolfCertTransport`, `wolfcert_buffer_free` / `_secure` | | `wolfcert/keygen.h`, `wolfcert/csr.h` | Key generation, import / export, CSR building | -| `wolfcert/store.h` | `WolfCertStoreOps` storage vtable, POSIX and in-memory backends | | `wolfcert/errors.h`, `wolfcert/status.h`, `wolfcert/log.h` | Error codes, last-error detail, log callback | | `wolfcert/memory.h` | Default heap hint, allocation macros | | `examples/` | `enroll_est.c`, `enroll_scep.c`, `enroll_cryptocb.c`, `user_settings.h.example` | @@ -204,7 +202,7 @@ contract, alone or in a group comment. |---|---|---| | Static memory / custom heap | `wolfcert_init(heap)` sets the default heap hint; per-call `heap` fields override it, and the hint reaches every wolfSSL call | `wolfcert/memory.h`, README "Integrating with a wolfSSL static-memory pool" | | Network stack without BSD sockets (lwIP, NetX, FreeRTOS+TCP, wolfIP) | Fill `WolfCertServerCfg.transport` (`WolfCertTransport`); TLS records go through it too | `wolfcert/types.h`, `docs/EMBEDDED.md` section 7 | -| Persistence in flash / NVM | Implement `WolfCertStoreOps` (`read` / `write` / `remove`) | `wolfcert/store.h` | +| Persistence in flash / NVM | Store the buffers from `wolfcert_key_to_pem` / `_to_der` and the enroll result; wolfCert does no storage | `wolfcert/keygen.h` | | Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id` | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | | Event loop / no blocking | `wolfcert_est_session_open` / `wolfcert_scep_session_open`, then the `_nb` calls until they stop returning `WOLFCERT_ERR_WANT_READ` / `_WANT_WRITE`; `*_session_fd` gives the descriptor to poll | `wolfcert/est.h`, `wolfcert/scep.h` | | Logging | `wolfcert_set_log_cb` (e.g. to a UART) | `wolfcert/log.h` | diff --git a/CMakeLists.txt b/CMakeLists.txt index 34a2c92..ebe9a56 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,7 +32,6 @@ option(WOLFCERT_ENABLE_SERVER "Build the minimal EST/SCEP test server" ON) option(WOLFCERT_ENABLE_CLI "Build wolfcert-client / wolfcert-server" ON) option(WOLFCERT_ENABLE_TESTS "Build unit and integration tests" OFF) option(WOLFCERT_ENABLE_EXAMPLES "Build example programs" OFF) -option(WOLFCERT_ENABLE_POSIX_STORE "Build the POSIX file storage backend" ON) option(WOLFCERT_ENABLE_BUILTIN_TRANSPORT "Build the built-in POSIX socket transport" ON) option(WOLFCERT_WERROR "Treat warnings as errors" OFF) @@ -312,8 +311,6 @@ if(NOT WOLFCERT_USER_SETTINGS) _wc_opt(WOLFCERT_OPT_EST "${WOLFCERT_ENABLE_EST}" WOLFCERT_HAVE_EST) _wc_opt(WOLFCERT_OPT_SCEP "${WOLFCERT_ENABLE_SCEP}" WOLFCERT_HAVE_SCEP) _wc_opt(WOLFCERT_OPT_SERVER "${WOLFCERT_ENABLE_SERVER}" WOLFCERT_HAVE_SERVER) - _wc_plat(WOLFCERT_OPT_POSIX_STORE "${WOLFCERT_ENABLE_POSIX_STORE}" - WOLFCERT_HAVE_POSIX_STORE WOLFCERT_NO_POSIX_STORE) _wc_plat(WOLFCERT_OPT_BUILTIN_TRANSPORT "${WOLFCERT_ENABLE_BUILTIN_TRANSPORT}" WOLFCERT_HAVE_BUILTIN_TRANSPORT WOLFCERT_NO_BUILTIN_TRANSPORT) @@ -335,7 +332,6 @@ set(WOLFCERT_SOURCES src/key_algs.c src/keygen.c src/csr.c - src/store.c src/http.c src/client.c) @@ -641,6 +637,6 @@ endif() message(STATUS "wolfCert ${PROJECT_VERSION}: EST=${WOLFCERT_ENABLE_EST}, " "SCEP=${WOLFCERT_ENABLE_SCEP}, server=${WOLFCERT_ENABLE_SERVER}, " - "cli=${WOLFCERT_ENABLE_CLI}, posix_store=${WOLFCERT_ENABLE_POSIX_STORE}, " + "cli=${WOLFCERT_ENABLE_CLI}, " "builtin_transport=${WOLFCERT_ENABLE_BUILTIN_TRANSPORT}, " "user_settings=${WOLFCERT_USER_SETTINGS}") diff --git a/Makefile.am b/Makefile.am index 5b5ae96..1562a98 100644 --- a/Makefile.am +++ b/Makefile.am @@ -19,7 +19,6 @@ libwolfcert_la_SOURCES = \ src/key_algs.h \ src/keygen.c \ src/csr.c \ - src/store.c \ src/http.c \ src/client.c @@ -68,7 +67,6 @@ wolfcertinclude_HEADERS = \ wolfcert/types.h \ wolfcert/keygen.h \ wolfcert/csr.h \ - wolfcert/store.h \ wolfcert/http.h \ wolfcert/est.h \ wolfcert/scep.h \ @@ -106,7 +104,7 @@ endif if WOLFCERT_BUILD_TESTS check_PROGRAMS = \ - test_smoke test_keygen test_csr test_store test_http test_transport \ + test_smoke test_keygen test_csr test_http test_transport \ test_parse_negative test_tls_http if WOLFCERT_HAVE_BUILTIN_TRANSPORT check_PROGRAMS += test_net @@ -119,8 +117,6 @@ test_keygen_LDADD = libwolfcert.la $(WOLFSSL_LIBS) test_csr_SOURCES = tests/unit/test_csr.c test_csr_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src test_csr_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -test_store_SOURCES = tests/unit/test_store.c -test_store_LDADD = libwolfcert.la $(WOLFSSL_LIBS) test_transport_SOURCES = tests/unit/test_transport.c test_transport_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src test_transport_LDADD = libwolfcert.la $(WOLFSSL_LIBS) @@ -201,13 +197,13 @@ endif # Protocol-agnostic server tests. if WOLFCERT_HAVE_SERVER -check_PROGRAMS += test_server_stop_idle test_server_ca_store +check_PROGRAMS += test_server_stop_idle test_server_ca test_server_stop_idle_SOURCES = tests/integration/test_server_stop_idle.c test_server_stop_idle_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src test_server_stop_idle_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread -test_server_ca_store_SOURCES = tests/unit/test_server_ca_store.c -test_server_ca_store_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src -test_server_ca_store_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread +test_server_ca_SOURCES = tests/unit/test_server_ca.c +test_server_ca_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src +test_server_ca_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread endif TESTS = $(check_PROGRAMS) diff --git a/README.md b/README.md index 1ba93fe..7387c88 100644 --- a/README.md +++ b/README.md @@ -219,8 +219,9 @@ All `WolfCertBuffer` outputs remember which heap they came from, so the same included, so a non-BSD-sockets stack (FreeRTOS+TCP, NetX, lwIP, wolfIP) needs one small glue file and no wolfCert change; the POSIX transport is the default instance and can be compiled out. -- **Storage:** file-based cert/key store with atomic writes and 0600 key-file - mode; pluggable via the `WolfCertStoreOps` vtable. +- **Storage is the application's:** keys export as PEM or DER + (`wolfcert_key_to_pem` / `_to_der`) and certificates come back as buffers, + to keep in a file, flash slot or secure element as the device requires. - **Test servers + CLIs** for Linux/macOS (`wolfcert-server`, `wolfcert-client`). The servers are for development and interop testing, not production CA use. diff --git a/configure.ac b/configure.ac index d1b9895..2aa8e6f 100644 --- a/configure.ac +++ b/configure.ac @@ -79,12 +79,6 @@ cannot supply a custom one])]) round-trip tests drive the client over real sockets])]) ]) -# Only the POSIX backend inside store.c is gated, so no AM_CONDITIONAL. -AC_ARG_ENABLE([posix-store], - [AS_HELP_STRING([--disable-posix-store], - [do not build the POSIX file storage backend])], - [enable_posix_store=$enableval], [enable_posix_store=yes]) - AC_ARG_ENABLE([tests], [AS_HELP_STRING([--enable-tests], [build unit and integration tests])], [enable_tests=$enableval], [enable_tests=no]) @@ -307,8 +301,6 @@ AS_IF([test "x$have_rsa" = "xno" && test "x$have_ecc" = "xno" \ WOLFCERT_OPT([WOLFCERT_OPT_EST], [$enable_est], [WOLFCERT_HAVE_EST]) WOLFCERT_OPT([WOLFCERT_OPT_SCEP], [$enable_scep], [WOLFCERT_HAVE_SCEP]) WOLFCERT_OPT([WOLFCERT_OPT_SERVER], [$enable_server], [WOLFCERT_HAVE_SERVER]) -WOLFCERT_PLAT([WOLFCERT_OPT_POSIX_STORE], [$enable_posix_store], - [WOLFCERT_HAVE_POSIX_STORE], [WOLFCERT_NO_POSIX_STORE]) WOLFCERT_PLAT([WOLFCERT_OPT_BUILTIN_TRANSPORT], [$enable_builtin_transport], [WOLFCERT_HAVE_BUILTIN_TRANSPORT], [WOLFCERT_NO_BUILTIN_TRANSPORT]) WOLFCERT_OPT([WOLFCERT_OPT_RSA], [$have_rsa], [WOLFCERT_HAVE_RSA]) @@ -363,7 +355,6 @@ AC_MSG_NOTICE([ Ed448=$have_ed448 ML-DSA=$have_mldsa TLS 1.2/1.3 : $have_tls12 / $have_tls13 Test server : $enable_server - POSIX store : $enable_posix_store Builtin transp: $enable_builtin_transport User settings : $enable_user_settings CLI tools : $enable_cli diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index f70d7db..f48530c 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -44,7 +44,7 @@ A few constraints shape the whole library: CryptoCb itself. The application registers its own (TPM, HSM, PKCS#11, custom) and passes the resulting `devId` through `WolfCertKeyCfg.dev_id`; wolfCert threads that into every wolfSSL crypto call on the key. -4. **Pluggable storage and protocol handling via vtables** (see +4. **Pluggable algorithms, transport and protocol handling via vtables** (see [section 5](#5-extension-points)). 5. **Event-loop-friendly I/O.** Every keep-alive session (HTTP, EST, SCEP) takes non-blocking `_nb` calls that surface `WOLFCERT_ERR_WANT_READ` / @@ -80,7 +80,7 @@ wolfCert is organised in four layers, top to bottom: +----------------------------------------------------------------------+ | public API headers (wolfcert/*.h) | | wolfcert.h (umbrella) client.h est.h scep.h http.h | - | keygen.h csr.h store.h server.h memory.h errors.h status.h | + | keygen.h csr.h server.h memory.h errors.h status.h | +----------------------------------------------------------------------+ | +----------------------------------------------------------------------+ @@ -91,7 +91,7 @@ wolfCert is organised in four layers, top to bottom: +----------------------------------------------------------------------+ | subsystem layer | | keygen / key_algs csr http (TLS + keep-alive + async) | - | store pkcs7_util server + ca_issue memory / errors / logging | + | pkcs7_util server + ca_issue memory / errors / logging | +----------------------------------------------------------------------+ | +----------------------------------------------------------------------+ @@ -432,27 +432,16 @@ Key points: its in-flight state; don't mutate the request/response between calls. - **One in-flight request per session** — pipelining is not supported. -### 4.4 Pluggable storage for flash / NVM +### 4.4 Persisting keys and certificates -Populate a `WolfCertStoreOps` with your backend and hand it to the store -helpers: - -```c -WolfCertStoreOps flash_ops = { - .read = flash_read, - .write = flash_write, - .remove = flash_remove, - .heap = my_heap, - .ctx = &my_flash_state, -}; -wolfcert_store_write_cert(&flash_ops, "device.crt", cert.data, cert.len); -``` - -Keys are opaque strings — map them to flash slots, handles, or paths however -your storage layer prefers. `sensitive = 1` on a write tells you the blob is -private-key material; enforce whatever access-control or encryption policy the -device needs. `wolfcert_store_write_key` / `_read_key` round-trip a -`WolfCertKey` via PEM and always mark the write sensitive. +wolfCert does not store anything. An enroll returns the certificate in a +`WolfCertBuffer`, `wolfcert_key_to_pem` / `_to_der` export a software key, and +`wolfcert_key_from_pem` reads one back. Write them wherever the device keeps +credentials. A renewal replaces the certificate and, on a rekey, the key, so +keep the old pair until both new halves are written. Keep exported keys +readable only by the device's own process, and free their buffers with +`wolfcert_buffer_free_secure()`. A key that stays in a CryptoCb backend is not +exported; keep the reference the backend needs. ### 4.5 Logging & errors on targets without stdio @@ -613,9 +602,8 @@ wolfcert_est_session_open(&srv, &s); run_nb_loop(s); /* pattern from section 4.3 */ wolfcert_est_session_close(s); -/* 5. Persist to flash through our storage backend */ -wolfcert_store_write_cert(&flash_ops, "device.crt", cert.data, cert.len); -/* key stays behind the CryptoCb; persist its label instead */ +/* 5. Persist the certificate; the key stays behind the CryptoCb */ +flash_write("device.crt", cert.data, cert.len); /* 6. Shutdown */ wolfcert_key_free(key); @@ -626,7 +614,7 @@ wolfcert_cleanup(); ## 5. Extension points -Four small vtables carry all of wolfCert's pluggability. Each is a "fill in a +Three small vtables carry all of wolfCert's pluggability. Each is a "fill in a struct, no library changes" extension: - **`WolfCertKeyAlg`** (`src/key_algs.c`) — algorithm dispatch. Adding a key @@ -634,10 +622,6 @@ struct, no library changes" extension: wolfSSL constants and `alloc_init` / `make` / `priv_decode` / `priv_to_der` / `free_` callbacks, plus an optional `WOLFCERT_HAVE_` compile guard. No edits to `keygen.c`, `csr.c`, or `ca_issue.c`. -- **`WolfCertStoreOps`** (`wolfcert/store.h`) — storage backend. Supply - `read` / `write` / `remove` callbacks and a private `ctx`; keys are opaque - strings. Shipped backends: POSIX files (atomic write, 0600 key mode) and - in-memory. See [section 4.4](#44-pluggable-storage-for-flash--nvm). - **`WolfCertTransport`** (`wolfcert/types.h`) — the bytes on the wire. Supply `connect` / `read` / `write` / `disconnect` and a private `ctx` to run wolfCert on a non-BSD-sockets stack; TLS rides the same callbacks through an diff --git a/docs/EMBEDDED.md b/docs/EMBEDDED.md index 24f2e88..b39bf24 100644 --- a/docs/EMBEDDED.md +++ b/docs/EMBEDDED.md @@ -303,17 +303,17 @@ with ECC or a PQC algorithm, disabling SCEP avoids pulling in RSA. ## 7. Targets without BSD sockets or a filesystem -Two platform pieces can be compiled out entirely, so a target that has -neither a socket API nor a filesystem links neither. +The one platform piece, the socket transport, can be compiled out entirely, +so a target without a socket API does not link it. wolfCert never touches a +filesystem. | Macro | Off means | Build flags | `user_settings.h` | |---|---|---|---| | `WOLFCERT_HAVE_BUILTIN_TRANSPORT` | `src/net_posix.c` is not compiled | `-DWOLFCERT_ENABLE_BUILTIN_TRANSPORT=OFF` / `--disable-builtin-transport` | `#define WOLFCERT_NO_BUILTIN_TRANSPORT` | -| `WOLFCERT_HAVE_POSIX_STORE` | the POSIX file store backend is stubbed out | `-DWOLFCERT_ENABLE_POSIX_STORE=OFF` / `--disable-posix-store` | `#define WOLFCERT_NO_POSIX_STORE` | -Each pair is mandatory-one-of: `check_config.h` fails the build when a +The pair is mandatory-one-of: `check_config.h` fails the build when a config defines neither the `WOLFCERT_HAVE_*` nor the `WOLFCERT_NO_*` form, -so compiling a backend out is always an explicit decision. The configure +so compiling the transport out is always an explicit decision. The configure builds emit the right macro automatically; only a `user_settings.h` build writes it by hand. @@ -322,8 +322,6 @@ leaving it NULL is `WOLFCERT_ERR_BAD_ARG`. Writing one is a small glue file in your own tree - `connect` / `read` / `write` / `disconnect` over your stack, no TLS code - described in [`ARCHITECTURE.md` section 4.6](ARCHITECTURE.md#46-pluggable-transport). -With the store off, `wolfcert_store_posix_open()` returns NULL and the -in-memory backend or your own `WolfCertStoreOps` carries persistence. The CLI tools and the built-in test server both need real sockets, so both build systems reject enabling them alongside `--disable-builtin-transport`. diff --git a/docs/MIGRATING-FROM-WOLFSCEP.md b/docs/MIGRATING-FROM-WOLFSCEP.md index 09c96c9..8d5fcc5 100644 --- a/docs/MIGRATING-FROM-WOLFSCEP.md +++ b/docs/MIGRATING-FROM-WOLFSCEP.md @@ -191,7 +191,6 @@ Link against `libwolfcert` and include ``, which pulls in t - **EST (RFC 7030)** for the same lifecycle over TLS, with ECC, Ed25519, Ed448 and ML-DSA keys, none of which SCEP permits. - **Keep-alive sessions with `_nb` calls**, so several operations share one connection and an event loop can drive them through `WOLFCERT_ERR_WANT_READ` and `WOLFCERT_ERR_WANT_WRITE`. - **CryptoCb offload.** Register your TPM, HSM or PKCS#11 backend with wolfSSL and pass the resulting `dev_id` in `WolfCertKeyCfg`; the private key never has to be in memory. -- **Pluggable storage** through `WolfCertStoreOps` for flash and NVM targets. - **Static memory.** Every allocation carries a heap hint, so wolfCert runs on a wolfSSL built `WOLFSSL_NO_MALLOC` with a static pool. - **A tested interop matrix**, described in `INTEROP.md`. diff --git a/examples/user_settings.h.example b/examples/user_settings.h.example index abbf035..63394fb 100644 --- a/examples/user_settings.h.example +++ b/examples/user_settings.h.example @@ -38,9 +38,8 @@ #define WOLFCERT_HAVE_SCEP 1 /* SCEP (RFC 8894) - requires WOLFCERT_HAVE_RSA */ #define WOLFCERT_HAVE_SERVER 1 /* built-in EST/SCEP test server */ -/* Platform: each needs its HAVE or WOLFCERT_NO_* form; NO_* compiles the - * backend out and the application supplies its own transport / store ops. */ -#define WOLFCERT_HAVE_POSIX_STORE 1 +/* Platform: needs its HAVE or WOLFCERT_NO_* form; NO_* compiles the + * transport out and the application supplies its own. */ #define WOLFCERT_HAVE_BUILTIN_TRANSPORT 1 /* Key algorithms (at least one) */ diff --git a/scripts/ci/compile-freestanding.sh b/scripts/ci/compile-freestanding.sh index 5e87917..8f54a80 100755 --- a/scripts/ci/compile-freestanding.sh +++ b/scripts/ci/compile-freestanding.sh @@ -2,9 +2,9 @@ # SPDX-License-Identifier: GPL-3.0-or-later # # Compile every portable wolfCert source for a bare-metal ARM target: no POSIX -# headers, no built-in transport, no POSIX store, no test server. This keeps -# src/http.c, src/csr.c and src/store.c free of syscalls, so wolfCert can run on -# a non-BSD-sockets stack through a caller-supplied WolfCertTransport. +# headers, no built-in transport, no test server. This keeps src/http.c and +# src/csr.c free of syscalls, so wolfCert can run on a non-BSD-sockets stack +# through a caller-supplied WolfCertTransport. # # Compile-only, so it wants a wolfSSL checkout for headers rather than a build, # and finishes in seconds. Feature set: freestanding-user_settings.h alongside. diff --git a/scripts/ci/freestanding-user_settings.h b/scripts/ci/freestanding-user_settings.h index 7e423a7..33d6e5e 100644 --- a/scripts/ci/freestanding-user_settings.h +++ b/scripts/ci/freestanding-user_settings.h @@ -18,7 +18,7 @@ */ /* Combined wolfSSL + wolfCert config for compile-freestanding.sh. The - * built-in transport, POSIX store, server and HAVE_SNI stay out on purpose. */ + * built-in transport, server and HAVE_SNI stay out on purpose. */ #ifndef WOLFSSL_USER_SETTINGS_H #define WOLFSSL_USER_SETTINGS_H @@ -67,7 +67,6 @@ /* wolfCert: no sockets, no filesystem */ #define WOLFCERT_NO_SNI #define WOLFCERT_NO_BUILTIN_TRANSPORT -#define WOLFCERT_NO_POSIX_STORE #define WOLFCERT_HAVE_EST 1 /* EST (RFC 7030) */ #define WOLFCERT_HAVE_SCEP 1 /* SCEP (RFC 8894) - requires WOLFCERT_HAVE_RSA */ #define WOLFCERT_HAVE_RSA 1 diff --git a/scripts/ci/wolfcert-only-user_settings.h b/scripts/ci/wolfcert-only-user_settings.h index 2d022d8..d25f596 100644 --- a/scripts/ci/wolfcert-only-user_settings.h +++ b/scripts/ci/wolfcert-only-user_settings.h @@ -30,7 +30,6 @@ #define WOLFCERT_HAVE_SCEP 1 #define WOLFCERT_HAVE_SERVER 1 -#define WOLFCERT_HAVE_POSIX_STORE 1 #define WOLFCERT_HAVE_BUILTIN_TRANSPORT 1 #define WOLFCERT_HAVE_RSA 1 diff --git a/src/ca_issue.c b/src/ca_issue.c index f9da5cd..62e9274 100644 --- a/src/ca_issue.c +++ b/src/ca_issue.c @@ -17,7 +17,7 @@ * along with wolfCert. If not, see . */ -/* Test-server CA: generation, persistence and issuance from a CSR. */ +/* Test-server CA: generation, loading and issuance from a CSR. */ #define _POSIX_C_SOURCE 200809L #define _DEFAULT_SOURCE @@ -183,7 +183,7 @@ int wolfcert_ca_generate(WolfCertCa* ca, WolfCertKeyType type, int param, void* return rc; } - /* Kept as DER for wolfcert_ca_save and the SCEP server's PKCS#7 calls. */ + /* Kept as DER for wolfcert_ca_export and the SCEP server's PKCS#7 calls. */ size_t kcap = alg->der_cap_hint + 2048; ca->key_der = (uint8_t*)WOLFCERT_XMALLOC(kcap, heap); if (ca->key_der == NULL) { @@ -210,10 +210,9 @@ int wolfcert_ca_generate(WolfCertCa* ca, WolfCertKeyType type, int param, void* return WOLFCERT_OK; } -/* Check the stored cert is a CA holding the public half of the stored key. */ -static int ca_check_stored_pair(const WolfCertKeyAlg* alg, WolfCertKey* key, - const uint8_t* cert_der, size_t cert_len, - void* heap) +/* Check the cert is a CA holding the public half of the key. */ +static int ca_check_pair(const WolfCertKeyAlg* alg, WolfCertKey* key, + const uint8_t* cert_der, size_t cert_len, void* heap) { DecodedCert* dc = (DecodedCert*)WOLFCERT_XMALLOC(sizeof(*dc), heap); if (dc == NULL) @@ -222,25 +221,28 @@ static int ca_check_stored_pair(const WolfCertKeyAlg* alg, WolfCertKey* key, wc_InitDecodedCert(dc, cert_der, (word32)cert_len, heap); int rc = wc_ParseCert(dc, CERT_TYPE, NO_VERIFY, NULL); - if (rc != 0) { + if (rc == MEMORY_E) { + rc = WOLFCERT_ERR_MEMORY; + } + else if (rc != 0) { rc = WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "ca", - "stored CA certificate does not parse"); + "CA certificate does not parse"); } else if (!dc->isCA || (dc->extKeyUsageSet && (dc->extKeyUsage & KEYUSE_KEY_CERT_SIGN) == 0)) { rc = WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "ca", - "stored CA certificate is not a CA " + "CA certificate is not a CA " "(basicConstraints/keyUsage)"); } else if (dc->keyOID != (word32)alg->key_oid || dc->publicKey == NULL) { rc = WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "ca", - "stored CA certificate and key use different algorithms"); + "CA certificate and key use different algorithms"); } else { rc = alg->pub_check(key, dc->publicKey, dc->pubKeySize); - if (rc != WOLFCERT_OK) + if (rc != WOLFCERT_OK && rc != WOLFCERT_ERR_MEMORY) rc = WOLFCERT_ERR(rc, "ca", - "stored CA certificate does not match the stored key"); + "CA certificate does not match the CA key"); } wc_FreeDecodedCert(dc); @@ -248,103 +250,143 @@ static int ca_check_stored_pair(const WolfCertKeyAlg* alg, WolfCertKey* key, return rc; } -int wolfcert_ca_load(WolfCertCa* ca, WolfCertStoreOps* store, void* heap) +static int ca_copy(const uint8_t* in, size_t in_len, WolfCertBuffer* out, + void* heap) +{ + out->data = (uint8_t*)WOLFCERT_XMALLOC(in_len, heap); + if (out->data == NULL) + return WOLFCERT_ERR_MEMORY; + + memcpy(out->data, in, in_len); + out->len = in_len; + out->heap = heap; + return WOLFCERT_OK; +} + +/* 1 when in is exactly one DER element. */ +static int ca_der_single(const uint8_t* in, size_t in_len) +{ + word32 idx = 1; + int len = 0; + + return (size_t)(word32)in_len == in_len && + GetLength(in, &idx, &len, (word32)in_len) >= 0 && + (size_t)idx + (size_t)len == in_len; +} + +static int ca_cert_der(const uint8_t* in, size_t in_len, WolfCertBuffer* out, + void* heap) +{ + if (!wolfcert_buffer_is_der(in, in_len)) + return wolfcert_pem_cert_to_der(in, in_len, out, heap); + + if (!ca_der_single(in, in_len)) + return WOLFCERT_ERR_PARSE; + + return ca_copy(in, in_len, out, heap); +} + +int wolfcert_ca_load(WolfCertCa* ca, const uint8_t* cert, size_t cert_len, + const uint8_t* key, size_t key_len, void* heap) { - if (ca == NULL || store == NULL) + if (ca == NULL || cert == NULL || cert_len == 0 || key == NULL || + key_len == 0) return WOLFCERT_ERR_BAD_ARG; + if (heap == NULL) + heap = wolfcert_default_heap(); + memset(ca, 0, sizeof(*ca)); ca->heap = heap; WolfCertBuffer cert_buf = { .heap = heap }; WolfCertBuffer key_buf = { .heap = heap }; + WolfCertKey* k = NULL; + const WolfCertKeyAlg* alg = NULL; - int cert_rc = store->read(store->ctx, "ca.cert.der", &cert_buf); - int key_rc = store->read(store->ctx, "ca.key.der", &key_buf); - int rc; - - if (cert_rc != WOLFCERT_OK || key_rc != WOLFCERT_OK) { - wolfcert_buffer_free(&cert_buf); - wolfcert_buffer_free_secure(&key_buf); + int rc = ca_cert_der(cert, cert_len, &cert_buf, heap); + if (rc != WOLFCERT_OK && rc != WOLFCERT_ERR_MEMORY) + rc = WOLFCERT_ERR(rc, "ca", "ca_cert is not a PEM or DER certificate"); - if (cert_rc == WOLFCERT_ERR_NOT_FOUND && key_rc == WOLFCERT_ERR_NOT_FOUND) - return WOLFCERT_ERR_NOT_FOUND; - - /* An absent half is only damage once the other half read back. */ - if (cert_rc != WOLFCERT_OK && cert_rc != WOLFCERT_ERR_NOT_FOUND) - return WOLFCERT_ERR(cert_rc, "ca", "CA store read failed"); - if (key_rc != WOLFCERT_OK && key_rc != WOLFCERT_ERR_NOT_FOUND) - return WOLFCERT_ERR(key_rc, "ca", "CA store read failed"); - - /* Reporting NOT_FOUND for half a pair would let the caller mint a - * new CA over the survivor. */ - return WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "ca", - "CA store is incomplete: %s is missing", - cert_rc == WOLFCERT_ERR_NOT_FOUND ? "ca.cert.der" : "ca.key.der"); + if (rc == WOLFCERT_OK) { + if (wolfcert_buffer_is_der(key, key_len) && + !ca_der_single(key, key_len)) + rc = WOLFCERT_ERR_PARSE; + else + rc = wolfcert_key_from_pem(key, key_len, heap, &k); + if (rc != WOLFCERT_OK && rc != WOLFCERT_ERR_MEMORY) + rc = WOLFCERT_ERR(rc, "ca", "ca_key is not a supported PEM or " + "DER private key"); } - /* Find the algorithm whose private-key decoder accepts the stored key. */ - const WolfCertKeyAlg* const* list = wolfcert_key_algs_all(); + /* The pair check restores an ECC public point that the re-encode needs. */ + if (rc == WOLFCERT_OK) { + alg = wolfcert_key_alg(k->type); + rc = (alg == NULL) ? WOLFCERT_ERR_UNSUPPORTED + : ca_check_pair(alg, k, cert_buf.data, cert_buf.len, + heap); + } - for (; *list != NULL; ++list) { - const WolfCertKeyAlg* a = *list; - WolfCertKey shim; + /* Re-encode so a PKCS#8 key matches alg->pem_type. */ + if (rc == WOLFCERT_OK) + rc = wolfcert_key_to_der(k, &key_buf); - memset(&shim, 0, sizeof(shim)); - shim.type = a->type; - shim.heap = heap; - shim.dev_id = WOLFCERT_DEVID_SOFTWARE; - - if (a->alloc_init(&shim) != WOLFCERT_OK) - continue; - - if (a->priv_decode(&shim, key_buf.data, (word32)key_buf.len) == WOLFCERT_OK) { - rc = ca_check_stored_pair(a, &shim, cert_buf.data, cert_buf.len, heap); - if (rc != WOLFCERT_OK) { - a->free_(&shim); - wolfcert_buffer_free(&cert_buf); - wolfcert_buffer_free_secure(&key_buf); - return rc; - } - - ca->type = a->type; - ca->impl = shim.impl; - ca->cert_der = cert_buf.data; - ca->cert_der_len = cert_buf.len; - ca->key_der = key_buf.data; - ca->key_der_len = key_buf.len; - cert_buf.data = NULL; - key_buf.data = NULL; - return WOLFCERT_OK; - } - a->free_(&shim); + if (rc == WOLFCERT_OK) { + ca->type = k->type; + ca->impl = k->impl; + ca->cert_der = cert_buf.data; + ca->cert_der_len = cert_buf.len; + ca->key_der = key_buf.data; + ca->key_der_len = key_buf.len; + k->impl = NULL; + cert_buf.data = NULL; + key_buf.data = NULL; } + wolfcert_key_free(k); wolfcert_buffer_free(&cert_buf); wolfcert_buffer_free_secure(&key_buf); - return WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "ca", - "stored CA key does not decode as any supported algorithm"); + return rc; } -int wolfcert_ca_save(const WolfCertCa* ca, WolfCertStoreOps* store) +static int ca_encode(const uint8_t* der, size_t der_len, WolfCertEncoding enc, + int pem_type, WolfCertBuffer* out, void* heap) { - if (ca == NULL || store == NULL) - return WOLFCERT_ERR_BAD_ARG; + if (enc == WOLFCERT_ENCODING_DER) + return ca_copy(der, der_len, out, heap); - int rc = store->write(store->ctx, "ca.cert.der", ca->cert_der, ca->cert_der_len, 0); - if (rc != WOLFCERT_OK) - return rc; + size_t cap = der_len * 2 + 256; + uint8_t* pem = (uint8_t*)WOLFCERT_XMALLOC(cap, heap); + if (pem == NULL) + return WOLFCERT_ERR_MEMORY; - rc = store->write(store->ctx, "ca.key.der", ca->key_der, ca->key_der_len, 1); - if (rc == WOLFCERT_OK) - return rc; + int n = wc_DerToPem(der, (word32)der_len, pem, (word32)cap, pem_type); + if (n <= 0) { + wc_ForceZero(pem, (word32)cap); + WOLFCERT_XFREE(pem, heap); + return WOLFCERT_ERR_RC_WC(WOLFCERT_ERR_CRYPTO, n, "ca", "DerToPem"); + } + + out->data = pem; + out->len = (size_t)n; + out->heap = heap; + return WOLFCERT_OK; +} - /* A certificate without its key is a store every later load rejects. */ - if (store->remove == NULL || - store->remove(store->ctx, "ca.cert.der") != WOLFCERT_OK) - return WOLFCERT_ERR(rc, "ca", - "CA key write failed and ca.cert.der could not be rolled back: " - "the store is left incomplete and must be cleared before restart"); +int wolfcert_ca_export(const WolfCertCa* ca, WolfCertEncoding enc, + WolfCertBuffer* out_cert, WolfCertBuffer* out_key) +{ + const WolfCertKeyAlg* alg = wolfcert_key_alg(ca->type); + int rc; + + rc = ca_encode(ca->cert_der, ca->cert_der_len, enc, CERT_TYPE, out_cert, + ca->heap); + if (rc == WOLFCERT_OK && out_key != NULL) { + rc = ca_encode(ca->key_der, ca->key_der_len, enc, alg->pem_type, + out_key, ca->heap); + if (rc != WOLFCERT_OK) + wolfcert_buffer_free(out_cert); + } return rc; } diff --git a/src/internal.h b/src/internal.h index 2e9a4a1..d63d1a5 100644 --- a/src/internal.h +++ b/src/internal.h @@ -103,9 +103,12 @@ typedef struct { } WolfCertCa; int wolfcert_ca_generate(WolfCertCa* ca, WolfCertKeyType type, int param, void* heap); -WOLFCERT_TEST_VIS int wolfcert_ca_load(WolfCertCa* ca, WolfCertStoreOps* store, +WOLFCERT_TEST_VIS int wolfcert_ca_load(WolfCertCa* ca, + const uint8_t* cert, size_t cert_len, + const uint8_t* key, size_t key_len, void* heap); -int wolfcert_ca_save(const WolfCertCa* ca, WolfCertStoreOps* store); +int wolfcert_ca_export(const WolfCertCa* ca, WolfCertEncoding enc, + WolfCertBuffer* out_cert, WolfCertBuffer* out_key); WOLFCERT_TEST_VIS void wolfcert_ca_free(WolfCertCa* ca); /* Rebuild an issued certificate's subject from a decoded CSR. */ diff --git a/src/server.c b/src/server.c index 1c4563f..a358426 100644 --- a/src/server.c +++ b/src/server.c @@ -445,6 +445,12 @@ int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", "post-handshake auth is supported only for EST"); + if ((cfg->ca_cert == NULL) != (cfg->ca_key == NULL) || + (cfg->ca_cert == NULL) != (cfg->ca_cert_len == 0) || + (cfg->ca_key == NULL) != (cfg->ca_key_len == 0)) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", + "ca_cert and ca_key must both be set, or both NULL"); + struct in_addr bind_addr = { .s_addr = htonl(INADDR_ANY) }; if (cfg->bind_host != NULL && inet_pton(AF_INET, cfg->bind_host, &bind_addr) != 1) @@ -490,19 +496,14 @@ int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) } int rc; - int have_ca = 0; - - if (cfg->ca_store != NULL) { - rc = wolfcert_ca_load(&s->ca, cfg->ca_store, heap); - if (rc == WOLFCERT_OK) - have_ca = 1; - /* Only an empty store means no CA yet; any other failure must not - * replace the stored CA. */ - else if (rc != WOLFCERT_ERR_NOT_FOUND) + + if (cfg->ca_cert != NULL) { + rc = wolfcert_ca_load(&s->ca, cfg->ca_cert, cfg->ca_cert_len, + cfg->ca_key, cfg->ca_key_len, heap); + if (rc != WOLFCERT_OK) goto fail; } - - if (!have_ca) { + else { WolfCertKeyType kt = cfg->ca_key_type ? cfg->ca_key_type : WOLFCERT_DEFAULT_KEY_TYPE; int kp = cfg->ca_key_param; @@ -510,13 +511,6 @@ int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) rc = wolfcert_ca_generate(&s->ca, kt, kp, heap); if (rc != WOLFCERT_OK) goto fail; - - if (cfg->ca_store != NULL) { - /* Not re-wrapped: it would lose ca_save's rollback diagnostic. */ - rc = wolfcert_ca_save(&s->ca, cfg->ca_store); - if (rc != WOLFCERT_OK) - goto fail; - } } rc = ops->start(cfg, s); @@ -722,6 +716,18 @@ uint16_t wolfcert_server_port(const WolfCertServer* srv) return srv ? srv->cfg.bind_port : 0; } +int wolfcert_server_get_ca(const WolfCertServer* srv, WolfCertEncoding enc, + WolfCertBuffer* out_cert, WolfCertBuffer* out_key) +{ + if (srv == NULL || out_cert == NULL) + return WOLFCERT_ERR_BAD_ARG; + if (enc != WOLFCERT_ENCODING_PEM && enc != WOLFCERT_ENCODING_DER) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", "bad encoding %d", + (int)enc); + + return wolfcert_ca_export(&srv->ca, enc, out_cert, out_key); +} + #if defined(WOLFCERT_BUILD_TESTING) WOLFCERT_TEST_VIS void wolfcert_server_set_request_timeout(WolfCertServer* srv, int ms) diff --git a/src/store.c b/src/store.c deleted file mode 100644 index 25cc2ce..0000000 --- a/src/store.c +++ /dev/null @@ -1,463 +0,0 @@ -/* - * Copyright (C) 2026 wolfSSL Inc. - * - * This file is part of wolfCert. - * - * wolfCert is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * wolfCert is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with wolfCert. If not, see . - */ - -/* Precedes every system header, so not gated on WOLFCERT_HAVE_POSIX_STORE. */ -#define _POSIX_C_SOURCE 200809L -#define _DEFAULT_SOURCE - -#include -#include -#include "internal.h" - -#include - -#include - -#ifdef WOLFCERT_HAVE_POSIX_STORE -#include -#include -#include -#include -#endif - -#ifdef WOLFCERT_HAVE_POSIX_STORE - -typedef struct { - char* root; -} PosixCtx; - -static int posix_join(const char* root, const char* key, char** out, void* heap) -{ - size_t rl = strlen(root); - size_t kl = strlen(key); - - char* p = (char*)WOLFCERT_XMALLOC(rl + 1 + kl + 1, heap); - if (p == NULL) - return WOLFCERT_ERR_MEMORY; - - memcpy(p, root, rl); - p[rl] = '/'; - memcpy(p + rl + 1, key, kl + 1); - *out = p; - - return WOLFCERT_OK; -} - -static int posix_read(void* ctx_, const char* key, WolfCertBuffer* out) -{ - PosixCtx* ctx = (PosixCtx*)ctx_; - char* path = NULL; - FILE* f = NULL; - uint8_t* buf = NULL; - long len = 0; - size_t n = 0; - int rc = posix_join(ctx->root, key, &path, out->heap); - if (rc != WOLFCERT_OK) - return rc; - - f = fopen(path, "rb"); - if (f == NULL) - rc = (errno == ENOENT) ? WOLFCERT_ERR_NOT_FOUND : WOLFCERT_ERR_IO; - - if (rc == WOLFCERT_OK && fseek(f, 0, SEEK_END) != 0) - rc = WOLFCERT_ERR_IO; - - if (rc == WOLFCERT_OK) { - len = ftell(f); - rewind(f); - if (len < 0) - rc = WOLFCERT_ERR_IO; - } - - if (rc == WOLFCERT_OK) { - buf = (uint8_t*)WOLFCERT_XMALLOC((size_t)len, out->heap); - if (buf == NULL) - rc = WOLFCERT_ERR_MEMORY; - } - - if (rc == WOLFCERT_OK) { - n = fread(buf, 1, (size_t)len, f); - if (n != (size_t)len) - rc = WOLFCERT_ERR_IO; - } - - if (rc == WOLFCERT_OK) { - out->data = buf; - out->len = (size_t)len; - buf = NULL; /* ownership moves to out */ - } - - if (f != NULL) - fclose(f); - WOLFCERT_XFREE(path, out->heap); - WOLFCERT_XFREE(buf, out->heap); - return rc; -} - -static int posix_write(void* ctx_, const char* key, - const uint8_t* data, size_t len, int sensitive) -{ - PosixCtx* ctx = (PosixCtx*)ctx_; - char* path = NULL; - int rc = posix_join(ctx->root, key, &path, NULL); - if (rc != WOLFCERT_OK) - return rc; - - size_t plen = strlen(path); - char* tmp = (char*)WOLFCERT_XMALLOC(plen + 8, NULL); - if (tmp == NULL) { - WOLFCERT_XFREE(path, NULL); - return WOLFCERT_ERR_MEMORY; - } - - memcpy(tmp, path, plen); - memcpy(tmp + plen, ".XXXXXX", 8); - - int fd = mkstemp(tmp); - if (fd < 0) { - WOLFCERT_XFREE(tmp, NULL); - WOLFCERT_XFREE(path, NULL); - return WOLFCERT_ERR_IO; - } - - if (fchmod(fd, sensitive ? 0600 : 0644) != 0) - goto fail; - - size_t off = 0; - while (off < len) { - ssize_t w = write(fd, data + off, len - off); - if (w < 0) { - if (errno == EINTR) - continue; - goto fail; - } - off += (size_t)w; - } - - if (fsync(fd) != 0) - goto fail; - - if (close(fd) != 0) { - unlink(tmp); - goto fail_free; - } - - if (rename(tmp, path) != 0) { - unlink(tmp); - goto fail_free; - } - - WOLFCERT_XFREE(tmp, NULL); - WOLFCERT_XFREE(path, NULL); - - return WOLFCERT_OK; - -fail: - close(fd); - unlink(tmp); - -fail_free: - WOLFCERT_XFREE(tmp, NULL); - WOLFCERT_XFREE(path, NULL); - - return WOLFCERT_ERR_IO; -} - -static int posix_remove(void* ctx_, const char* key) -{ - PosixCtx* ctx = (PosixCtx*)ctx_; - char* path = NULL; - - int rc = posix_join(ctx->root, key, &path, NULL); - if (rc != WOLFCERT_OK) - return rc; - - if (unlink(path) != 0 && errno != ENOENT) - rc = WOLFCERT_ERR_IO; - - WOLFCERT_XFREE(path, NULL); - return rc; -} - -WolfCertStoreOps* wolfcert_store_posix_open(const char* root_dir, void* heap) -{ - if (root_dir == NULL) - return NULL; - - if (heap == NULL) - heap = wolfcert_default_heap(); - - WolfCertStoreOps* ops = (WolfCertStoreOps*)WOLFCERT_XMALLOC(sizeof(*ops), heap); - if (ops == NULL) - return NULL; - - PosixCtx* ctx = (PosixCtx*)WOLFCERT_XMALLOC(sizeof(*ctx), heap); - if (ctx == NULL) { - WOLFCERT_XFREE(ops, heap); - return NULL; - } - - ctx->root = wolfcert_strdup(root_dir, heap); - if (ctx->root == NULL) { - WOLFCERT_XFREE(ctx, heap); - WOLFCERT_XFREE(ops, heap); - return NULL; - } - - ops->read = posix_read; - ops->write = posix_write; - ops->remove = posix_remove; - ops->heap = heap; - ops->ctx = ctx; - - return ops; -} - -void wolfcert_store_posix_close(WolfCertStoreOps* ops) -{ - if (ops == NULL) - return; - - PosixCtx* ctx = (PosixCtx*)ops->ctx; - if (ctx) { - WOLFCERT_XFREE(ctx->root, ops->heap); - WOLFCERT_XFREE(ctx, ops->heap); - } - - WOLFCERT_XFREE(ops, ops->heap); -} - -#else /* !WOLFCERT_HAVE_POSIX_STORE */ - -WolfCertStoreOps* wolfcert_store_posix_open(const char* root_dir, void* heap) -{ - (void)root_dir; - (void)heap; - - WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "store", - "wolfCert was built without the POSIX file backend"); - return NULL; -} - -void wolfcert_store_posix_close(WolfCertStoreOps* ops) -{ - (void)ops; -} - -#endif /* WOLFCERT_HAVE_POSIX_STORE */ - -typedef struct MemEntry { - char* key; - uint8_t* data; - size_t len; - struct MemEntry* next; -} MemEntry; - -typedef struct { - MemEntry* head; -} MemCtx; - -static MemEntry** find_slot(MemCtx* ctx, const char* key) -{ - MemEntry** p = &ctx->head; - while (*p) { - if (strcmp((*p)->key, key) == 0) - return p; - p = &(*p)->next; - } - return p; -} - -static int mem_read(void* ctx_, const char* key, WolfCertBuffer* out) -{ - MemCtx* ctx = (MemCtx*)ctx_; - MemEntry** slot = find_slot(ctx, key); - if (*slot == NULL) - return WOLFCERT_ERR_NOT_FOUND; - - uint8_t* buf = (uint8_t*)WOLFCERT_XMALLOC((*slot)->len, out->heap); - if (buf == NULL) - return WOLFCERT_ERR_MEMORY; - - memcpy(buf, (*slot)->data, (*slot)->len); - out->data = buf; - out->len = (*slot)->len; - - return WOLFCERT_OK; -} - -static int mem_write(void* ctx_, const char* key, - const uint8_t* data, size_t len, int sensitive) -{ - (void)sensitive; - MemCtx* ctx = (MemCtx*)ctx_; - MemEntry** slot = find_slot(ctx, key); - void* heap = NULL; /* memory backend uses default heap */ - - if (*slot != NULL) { - WOLFCERT_XFREE((*slot)->data, heap); - (*slot)->data = (uint8_t*)WOLFCERT_XMALLOC(len, heap); - if ((*slot)->data == NULL) { - (*slot)->len = 0; - return WOLFCERT_ERR_MEMORY; - } - - memcpy((*slot)->data, data, len); - (*slot)->len = len; - - return WOLFCERT_OK; - } - - MemEntry* e = (MemEntry*)WOLFCERT_XMALLOC(sizeof(*e), heap); - if (e == NULL) - return WOLFCERT_ERR_MEMORY; - - memset(e, 0, sizeof(*e)); - e->key = wolfcert_strdup(key, heap); - e->data = (uint8_t*)WOLFCERT_XMALLOC(len, heap); - if (e->key == NULL || e->data == NULL) { - WOLFCERT_XFREE(e->key, heap); - WOLFCERT_XFREE(e->data, heap); - WOLFCERT_XFREE(e, heap); - return WOLFCERT_ERR_MEMORY; - } - - memcpy(e->data, data, len); - e->len = len; - e->next = ctx->head; - ctx->head = e; - - return WOLFCERT_OK; -} - -static int mem_remove(void* ctx_, const char* key) -{ - MemCtx* ctx = (MemCtx*)ctx_; - MemEntry** slot = find_slot(ctx, key); - if (*slot == NULL) - return WOLFCERT_OK; - - MemEntry* e = *slot; - *slot = e->next; - WOLFCERT_XFREE(e->key, NULL); - WOLFCERT_XFREE(e->data, NULL); - WOLFCERT_XFREE(e, NULL); - - return WOLFCERT_OK; -} - -WolfCertStoreOps* wolfcert_store_memory_open(void* heap) -{ - if (heap == NULL) - heap = wolfcert_default_heap(); - - WolfCertStoreOps* ops = (WolfCertStoreOps*)WOLFCERT_XMALLOC(sizeof(*ops), heap); - if (ops == NULL) - return NULL; - - MemCtx* ctx = (MemCtx*)WOLFCERT_XMALLOC(sizeof(*ctx), heap); - if (ctx == NULL) { - WOLFCERT_XFREE(ops, heap); - return NULL; - } - - memset(ctx, 0, sizeof(*ctx)); - ops->read = mem_read; - ops->write = mem_write; - ops->remove = mem_remove; - ops->heap = heap; - ops->ctx = ctx; - - return ops; -} - -void wolfcert_store_memory_close(WolfCertStoreOps* ops) -{ - if (ops == NULL) - return; - - MemCtx* ctx = (MemCtx*)ops->ctx; - while (ctx->head) { - MemEntry* e = ctx->head; - ctx->head = e->next; - WOLFCERT_XFREE(e->key, NULL); - WOLFCERT_XFREE(e->data, NULL); - WOLFCERT_XFREE(e, NULL); - } - - WOLFCERT_XFREE(ctx, ops->heap); - WOLFCERT_XFREE(ops, ops->heap); -} - -int wolfcert_store_write_cert(WolfCertStoreOps* store, const char* key, - const uint8_t* cert, size_t len) -{ - if (store == NULL || key == NULL) - return WOLFCERT_ERR_BAD_ARG; - - return store->write(store->ctx, key, cert, len, 0); -} - -int wolfcert_store_read_cert(WolfCertStoreOps* store, const char* key, - WolfCertBuffer* out) -{ - if (store == NULL || key == NULL || out == NULL) - return WOLFCERT_ERR_BAD_ARG; - - memset(out, 0, sizeof(*out)); - out->heap = store->heap; - - return store->read(store->ctx, key, out); -} - -int wolfcert_store_write_key(WolfCertStoreOps* store, const char* key_name, - const WolfCertKey* key) -{ - if (store == NULL || key_name == NULL || key == NULL) - return WOLFCERT_ERR_BAD_ARG; - - WolfCertBuffer pem = { 0 }; - int rc = wolfcert_key_to_pem(key, &pem); - if (rc != WOLFCERT_OK) - return rc; - - rc = store->write(store->ctx, key_name, pem.data, pem.len, 1); - wolfcert_buffer_free_secure(&pem); - - return rc; -} - -int wolfcert_store_read_key(WolfCertStoreOps* store, const char* key_name, - WolfCertKey** out_key) -{ - if (store == NULL || key_name == NULL || out_key == NULL) - return WOLFCERT_ERR_BAD_ARG; - - WolfCertBuffer pem = { 0 }; - pem.heap = store->heap; - - int rc = store->read(store->ctx, key_name, &pem); - if (rc != WOLFCERT_OK) - return rc; - - rc = wolfcert_key_from_pem(pem.data, pem.len, store->heap, out_key); - wolfcert_buffer_free_secure(&pem); - - return rc; -} diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 3c8da4b..65fb8fe 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -14,10 +14,6 @@ target_include_directories(test_csr PRIVATE ${CMAKE_SOURCE_DIR}/src) target_link_libraries(test_csr PRIVATE wolfcert) add_test(NAME csr COMMAND test_csr) -add_executable(test_store unit/test_store.c) -target_link_libraries(test_store PRIVATE wolfcert) -add_test(NAME store COMMAND test_store) - if(WOLFCERT_ENABLE_BUILTIN_TRANSPORT) add_executable(test_net unit/test_net.c) target_include_directories(test_net PRIVATE ${CMAKE_SOURCE_DIR}/src) @@ -119,10 +115,10 @@ if(WOLFCERT_ENABLE_SERVER) # A stop that cannot interrupt an idle peer hangs the serving thread. set_tests_properties(server_stop_idle PROPERTIES TIMEOUT 90) - add_executable(test_server_ca_store unit/test_server_ca_store.c) - target_include_directories(test_server_ca_store PRIVATE ${CMAKE_SOURCE_DIR}/src) - target_link_libraries(test_server_ca_store PRIVATE wolfcert Threads::Threads) - add_test(NAME server_ca_store COMMAND test_server_ca_store) + add_executable(test_server_ca unit/test_server_ca.c) + target_include_directories(test_server_ca PRIVATE ${CMAKE_SOURCE_DIR}/src) + target_link_libraries(test_server_ca PRIVATE wolfcert Threads::Threads) + add_test(NAME server_ca COMMAND test_server_ca) endif() if(WOLFCERT_ENABLE_SCEP) diff --git a/tests/integration/test_est_async_roundtrip.c b/tests/integration/test_est_async_roundtrip.c index bff4f22..06fe883 100644 --- a/tests/integration/test_est_async_roundtrip.c +++ b/tests/integration/test_est_async_roundtrip.c @@ -123,7 +123,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .tls_client_ca_pem = cli_cert, .tls_client_ca_pem_len = cli_cert_len, @@ -185,7 +185,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .http_basic_user = "alice", .http_basic_pass = "hunter2", .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -255,7 +255,7 @@ int main(void) free(tls_key); free(cli_cert); free(cli_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); if (pha_skipped) return 77; diff --git a/tests/integration/test_est_chunked_robustness.c b/tests/integration/test_est_chunked_robustness.c index 2688e51..56530c0 100644 --- a/tests/integration/test_est_chunked_robustness.c +++ b/tests/integration/test_est_chunked_robustness.c @@ -551,7 +551,7 @@ static int no_sigpipe_on_response(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .est_allow_anonymous_enroll = 1, }; WolfCertServer* srv = NULL; @@ -613,7 +613,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = g_tls_cert, .tls_cert_pem_len = g_tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .est_allow_anonymous_enroll = 1, @@ -659,7 +659,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_csr_attrs_apply_roundtrip.c b/tests/integration/test_est_csr_attrs_apply_roundtrip.c index 7fee0fc..650aed8 100644 --- a/tests/integration/test_est_csr_attrs_apply_roundtrip.c +++ b/tests/integration/test_est_csr_attrs_apply_roundtrip.c @@ -260,7 +260,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .csr_attributes_der = policy.data, .csr_attributes_len = policy.len, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -293,7 +293,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_csr_attrs_enforce.c b/tests/integration/test_est_csr_attrs_enforce.c index 28376ff..8de562e 100644 --- a/tests/integration/test_est_csr_attrs_enforce.c +++ b/tests/integration/test_est_csr_attrs_enforce.c @@ -367,7 +367,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .csr_attributes_der = policy.data, .csr_attributes_len = policy.len, .est_require_csr_attributes = 1, @@ -396,7 +396,7 @@ int main(void) WolfCertServerCfgSrv cfg2 = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .csr_attributes_der = policy2.data, .csr_attributes_len = policy2.len, .est_require_csr_attributes = 1, @@ -424,7 +424,7 @@ int main(void) WolfCertServerCfgSrv cfg_raw = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .csr_attributes_der = policy_raw.data, .csr_attributes_len = policy_raw.len, .est_require_csr_attributes = 1, @@ -452,7 +452,7 @@ int main(void) WolfCertServerCfgSrv cfg_bare = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .http_basic_user = "alice", .http_basic_pass = "secret", .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, @@ -472,7 +472,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_csr_attrs_roundtrip.c b/tests/integration/test_est_csr_attrs_roundtrip.c index 596604f..a2daf99 100644 --- a/tests/integration/test_est_csr_attrs_roundtrip.c +++ b/tests/integration/test_est_csr_attrs_roundtrip.c @@ -102,7 +102,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .csr_attributes_der = blob.data, .csr_attributes_len = blob.len, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -178,7 +178,7 @@ int main(void) WolfCertServerCfgSrv cfg2 = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .est_allow_anonymous_enroll = 1, @@ -232,7 +232,7 @@ int main(void) wolfcert_buffer_free(&blob); free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_mldsa_roundtrip.c b/tests/integration/test_est_mldsa_roundtrip.c index 6ded64b..9dfb238 100644 --- a/tests/integration/test_est_mldsa_roundtrip.c +++ b/tests/integration/test_est_mldsa_roundtrip.c @@ -114,7 +114,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .http_basic_user = "alice", .http_basic_pass = "hunter2", .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -158,7 +158,7 @@ int main(void) wolfcert_buffer_free(&ca_pem); free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); if (rc == 0) diff --git a/tests/integration/test_est_mtls_roundtrip.c b/tests/integration/test_est_mtls_roundtrip.c index 9d12b02..dbcda5e 100644 --- a/tests/integration/test_est_mtls_roundtrip.c +++ b/tests/integration/test_est_mtls_roundtrip.c @@ -319,10 +319,10 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .tls_client_ca_pem = cli_cert, .tls_client_ca_pem_len = cli_cert_len, + TEST_CA_CFG, }; - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); WolfCertServer* srv = NULL; - WolfCertBuffer ca_der = { 0 }; + const TestCa* ca = test_ca(); WolfCertBuffer csr = { 0 }; WolfCertEstResult issued = { 0 }; WolfCertEstResult renewed = { 0 }; @@ -330,10 +330,9 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ WolfCertKey* k1 = NULL; WolfCertKey* k2 = NULL; uint8_t* bundle = NULL; - size_t bundle_cap; + size_t bundle_len; pthread_t tid; char url[128]; - int pem_len; int rc; #ifdef HAVE_ECC uint8_t crit_csr[4096]; @@ -341,23 +340,13 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ int crit_len; #endif - /* The first start mints the CA into the store; the second adopts it. */ - REQUIRE(store != NULL); - cfg.ca_store = store; - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); - wolfcert_server_free(srv); - srv = NULL; - REQUIRE(store->read(store->ctx, "ca.cert.der", &ca_der) == WOLFCERT_OK); - - bundle_cap = cli_cert_len + ca_der.len * 2 + 256; - bundle = (uint8_t*)malloc(bundle_cap); + bundle_len = cli_cert_len + ca->cert_len; + bundle = (uint8_t*)malloc(bundle_len); REQUIRE(bundle != NULL); memcpy(bundle, cli_cert, cli_cert_len); - pem_len = wc_DerToPem(ca_der.data, (word32)ca_der.len, bundle + cli_cert_len, - (word32)(bundle_cap - cli_cert_len), CERT_TYPE); - REQUIRE(pem_len > 0); + memcpy(bundle + cli_cert_len, ca->cert, ca->cert_len); cfg.tls_client_ca_pem = bundle; - cfg.tls_client_ca_pem_len = cli_cert_len + (size_t)pem_len; + cfg.tls_client_ca_pem_len = bundle_len; REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); @@ -415,11 +404,9 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ wolfcert_server_stop(srv); pthread_join(tid, NULL); wolfcert_server_free(srv); - wolfcert_store_memory_close(store); wolfcert_est_result_free(&renewed); wolfcert_est_result_free(&issued); wolfcert_buffer_free(&csr); - wolfcert_buffer_free(&ca_der); wolfcert_key_free(k2); wolfcert_key_free(k1); free(bundle); @@ -443,7 +430,7 @@ static int test_reenroll_under_approval(const uint8_t* tls_cert, size_t tls_cert .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .tls_client_ca_pem = cli_cert, .tls_client_ca_pem_len = cli_cert_len, @@ -581,7 +568,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .tls_client_ca_pem = cli_cert, .tls_client_ca_pem_len = cli_cert_len, @@ -695,7 +682,7 @@ int main(void) free(tls_key); free(cli_cert); free(cli_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_pending_roundtrip.c b/tests/integration/test_est_pending_roundtrip.c index 7ac1a73..e9c70dc 100644 --- a/tests/integration/test_est_pending_roundtrip.c +++ b/tests/integration/test_est_pending_roundtrip.c @@ -461,7 +461,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .est_require_approval = 1, .est_retry_after_sec = 1, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -479,7 +479,7 @@ int main(void) free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); if (rc != 0) return rc; diff --git a/tests/integration/test_est_pha_roundtrip.c b/tests/integration/test_est_pha_roundtrip.c index e55f4f6..b96605e 100644 --- a/tests/integration/test_est_pha_roundtrip.c +++ b/tests/integration/test_est_pha_roundtrip.c @@ -114,7 +114,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, @@ -145,7 +145,7 @@ int main(void) free(tls_key); free(cli_cert); free(cli_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); return 77; } @@ -342,7 +342,7 @@ int main(void) free(tls_key); free(cli_cert); free(cli_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_est_roundtrip.c b/tests/integration/test_est_roundtrip.c index 9cef800..e38fcb7 100644 --- a/tests/integration/test_est_roundtrip.c +++ b/tests/integration/test_est_roundtrip.c @@ -238,7 +238,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .http_basic_user = "alice", .http_basic_pass = "hunter2", .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, @@ -363,7 +363,7 @@ int main(void) WolfCertServerCfgSrv acfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .http_basic_user = "alice", .http_basic_pass = "hunter", .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, @@ -416,7 +416,7 @@ int main(void) wolfcert_buffer_free(&ca_pem); free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK (%d transport connects)\n", g_connect_calls); return 0; diff --git a/tests/integration/test_est_tls_roundtrip.c b/tests/integration/test_est_tls_roundtrip.c index 9809257..4706d93 100644 --- a/tests/integration/test_est_tls_roundtrip.c +++ b/tests/integration/test_est_tls_roundtrip.c @@ -162,7 +162,7 @@ static int test_client_reenroll_keeps_identity(const uint8_t* tls_cert, .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, }; @@ -297,33 +297,26 @@ int main(void) size_t tls_key_len = 0; REQUIRE(gen_server_identity(&tls_cert, &tls_cert_len, &tls_key, &tls_key_len) == 0); - /* An EST listener without a TLS identity is refused at start. */ - WolfCertStoreOps* plain_store = wolfcert_store_memory_open(NULL); - REQUIRE(plain_store != NULL); + /* An EST listener without a TLS identity is refused at start, before the + * CA is loaded: this one does not parse. */ + static const uint8_t junk_ca[] = "not a CA"; WolfCertServerCfgSrv plain = { - .protocol = WOLFCERT_PROTO_EST, - .bind_host = "127.0.0.1", - .bind_port = 0, - .ca_store = plain_store, + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .bind_port = 0, + .ca_cert = junk_ca, .ca_cert_len = sizeof(junk_ca) - 1, + .ca_key = junk_ca, .ca_key_len = sizeof(junk_ca) - 1, }; WolfCertServer* plain_srv = NULL; REQUIRE(wolfcert_server_start(&plain, &plain_srv) == WOLFCERT_ERR_TLS); REQUIRE(plain_srv == NULL); - /* The refusal comes before a CA is minted into the store. */ - WolfCertBuffer leftover = { 0 }; - REQUIRE(plain_store->read(plain_store->ctx, "ca.cert.der", &leftover) - == WOLFCERT_ERR_NOT_FOUND); - REQUIRE(plain_store->read(plain_store->ctx, "ca.key.der", &leftover) - == WOLFCERT_ERR_NOT_FOUND); - wolfcert_store_memory_close(plain_store); - /* An EST listener with no way to authenticate a client is refused too. */ WolfCertServerCfgSrv open_cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, }; @@ -361,7 +354,7 @@ int main(void) .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, .est_allow_anonymous_enroll = 1, @@ -457,7 +450,7 @@ int main(void) wolfcert_key_free(dk); free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_scep_async_roundtrip.c b/tests/integration/test_scep_async_roundtrip.c index a8da75d..2ad3593 100644 --- a/tests/integration/test_scep_async_roundtrip.c +++ b/tests/integration/test_scep_async_roundtrip.c @@ -1223,7 +1223,7 @@ int main(void) /* Scenario A: auto-approve server. */ WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s1 = NULL; REQUIRE(wolfcert_server_start(&cfg, &s1) == WOLFCERT_OK); pthread_t t1; @@ -1238,7 +1238,7 @@ int main(void) /* Scenario B: approval-required server (PENDING -> poll). */ WolfCertServerCfgSrv cfg_pending = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_require_approval = 1 }; WolfCertServer* s2 = NULL; REQUIRE(wolfcert_server_start(&cfg_pending, &s2) == WOLFCERT_OK); @@ -1254,7 +1254,7 @@ int main(void) /* Scenario C: auto-approve server, async enroll -> async RenewalReq. */ WolfCertServerCfgSrv cfg_renew = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s3 = NULL; REQUIRE(wolfcert_server_start(&cfg_renew, &s3) == WOLFCERT_OK); pthread_t t3; @@ -1269,7 +1269,7 @@ int main(void) /* Scenario D: auto-approve server, session misuse guards. */ WolfCertServerCfgSrv cfg_guard = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s4 = NULL; REQUIRE(wolfcert_server_start(&cfg_guard, &s4) == WOLFCERT_OK); pthread_t t4; @@ -1284,7 +1284,7 @@ int main(void) /* Scenario E: approval-required server, blocking PENDING -> poll. */ WolfCertServerCfgSrv cfg_bpoll = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_require_approval = 1 }; WolfCertServer* s5 = NULL; REQUIRE(wolfcert_server_start(&cfg_bpoll, &s5) == WOLFCERT_OK); @@ -1300,7 +1300,7 @@ int main(void) /* Scenario F: auto-approve server, session over base64 GET. */ WolfCertServerCfgSrv cfg_get = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s6 = NULL; REQUIRE(wolfcert_server_start(&cfg_get, &s6) == WOLFCERT_OK); pthread_t t6; @@ -1320,7 +1320,7 @@ int main(void) /* Scenario H: auto-approve server, non-RSA signer rejection. */ WolfCertServerCfgSrv cfg_nonrsa = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s7 = NULL; REQUIRE(wolfcert_server_start(&cfg_nonrsa, &s7) == WOLFCERT_OK); pthread_t t7; @@ -1336,7 +1336,7 @@ int main(void) /* Scenario I: approval-required server, renewal poll with signer_cert. */ WolfCertServerCfgSrv cfg_rpoll = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_require_approval = 1 }; WolfCertServer* s8 = NULL; REQUIRE(wolfcert_server_start(&cfg_rpoll, &s8) == WOLFCERT_OK); @@ -1352,7 +1352,7 @@ int main(void) /* Scenario J: auto-approve server for bootstrap, then the 500 stub. */ WolfCertServerCfgSrv cfg_500 = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s9 = NULL; REQUIRE(wolfcert_server_start(&cfg_500, &s9) == WOLFCERT_OK); pthread_t t9; @@ -1367,7 +1367,7 @@ int main(void) /* Scenario K: auto-approve server, argument-validation guards. */ WolfCertServerCfgSrv cfg_neg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s10 = NULL; REQUIRE(wolfcert_server_start(&cfg_neg, &s10) == WOLFCERT_OK); pthread_t t10; @@ -1383,7 +1383,7 @@ int main(void) * GetCert over a session. */ WolfCertServerCfgSrv cfg_get_ops = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_enable_next_ca = 1, .scep_enable_get_cert = 1 }; WolfCertServer* s11 = NULL; @@ -1397,7 +1397,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_scep_get_cert.c b/tests/integration/test_scep_get_cert.c index 88308fa..5a8fd5d 100644 --- a/tests/integration/test_scep_get_cert.c +++ b/tests/integration/test_scep_get_cert.c @@ -374,7 +374,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_enable_get_cert = 1, }; WolfCertServer* s = NULL; @@ -394,7 +394,7 @@ int main(void) WolfCertServerCfgSrv cfg_off = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, }; WolfCertServer* s_off = NULL; REQUIRE(wolfcert_server_start(&cfg_off, &s_off) == WOLFCERT_OK); @@ -409,7 +409,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_scep_poll_roundtrip.c b/tests/integration/test_scep_poll_roundtrip.c index 467afde..63b8bb6 100644 --- a/tests/integration/test_scep_poll_roundtrip.c +++ b/tests/integration/test_scep_poll_roundtrip.c @@ -630,7 +630,7 @@ static int next_ca_disabled_path(void) /* GetNextCACert is not advertised and answers WOLFCERT_ERR_NOT_FOUND. */ WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s = NULL; REQUIRE(wolfcert_server_start(&cfg, &s) == WOLFCERT_OK); pthread_t tid; @@ -672,7 +672,7 @@ int main(void) WolfCertServerCfgSrv cfg_pending = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_require_approval = 1, }; WolfCertServer* s1 = NULL; @@ -691,7 +691,7 @@ int main(void) WolfCertServerCfgSrv cfg_next = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_enable_next_ca = 1, }; WolfCertServer* s2 = NULL; @@ -709,7 +709,7 @@ int main(void) if (rc != 0) return rc; - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_scep_roundtrip.c b/tests/integration/test_scep_roundtrip.c index 9cc1386..efafb03 100644 --- a/tests/integration/test_scep_roundtrip.c +++ b/tests/integration/test_scep_roundtrip.c @@ -1821,7 +1821,7 @@ static int test_split_ra(void) { WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .scep_split_ra = 1 }; WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, .dev_id = WOLFCERT_DEVID_SOFTWARE }; @@ -1971,7 +1971,7 @@ int main(void) WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s = NULL; REQUIRE(wolfcert_server_start(&cfg, &s) == WOLFCERT_OK); REQUIRE(wolfcert_scep_server_set_bundle_fault(s, 2) @@ -2257,7 +2257,7 @@ int main(void) /* Challenge password (RFC 8894 section 2.9). */ WolfCertServerCfgSrv cfg2 = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store(), + TEST_CA_CFG, .challenge_password = "correct-horse" }; WolfCertServer* s2 = NULL; REQUIRE(wolfcert_server_start(&cfg2, &s2) == WOLFCERT_OK); @@ -2391,7 +2391,7 @@ int main(void) /* A CertRep with no recipientNonce is rejected (RFC 8894 3.2.1.2). */ WolfCertServerCfgSrv cfg3 = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s3 = NULL; REQUIRE(wolfcert_server_start(&cfg3, &s3) == WOLFCERT_OK); wolfcert_scep_server_set_faults(s3, 1 /* omit recipientNonce */, 0, 0); @@ -2434,7 +2434,7 @@ int main(void) /* A CertRep signed by a key other than the CA's is rejected. */ WolfCertServerCfgSrv cfg4 = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s4 = NULL; REQUIRE(wolfcert_server_start(&cfg4, &s4) == WOLFCERT_OK); wolfcert_scep_server_set_faults(s4, 0, 1 /* sign with wrong key */, 0); @@ -2477,7 +2477,7 @@ int main(void) /* A failed senderNonce RNG draw on the server answers HTTP 500. */ WolfCertServerCfgSrv cfg5 = { .protocol = WOLFCERT_PROTO_SCEP, .bind_host = "127.0.0.1", .bind_port = 0, - .ca_store = test_ca_store() }; + TEST_CA_CFG }; WolfCertServer* s5 = NULL; REQUIRE(wolfcert_server_start(&cfg5, &s5) == WOLFCERT_OK); wolfcert_scep_server_set_faults(s5, 0, 0, 1 /* RNG draw fails */); @@ -2523,7 +2523,7 @@ int main(void) wolfcert_buffer_free(&csr); wolfcert_scep_result_free(&issued); wolfcert_key_free(dk); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/tests/integration/test_server_stop_idle.c b/tests/integration/test_server_stop_idle.c index b5353c9..1bb2466 100644 --- a/tests/integration/test_server_stop_idle.c +++ b/tests/integration/test_server_stop_idle.c @@ -250,16 +250,17 @@ int main(void) REQUIRE(gen_server_identity(&tls_cert, &tls_cert_len, &tls_key, &tls_key_len) == 0); - memset(&cfg, 0, sizeof(cfg)); - cfg.protocol = TLS_LISTENER_PROTO; - cfg.bind_host = "127.0.0.1"; - cfg.bind_port = 0; - cfg.ca_store = test_ca_store(); - cfg.tls_cert_pem = tls_cert; - cfg.tls_cert_pem_len = tls_cert_len; - cfg.tls_key_pem = tls_key; - cfg.tls_key_pem_len = tls_key_len; - cfg.est_allow_anonymous_enroll = 1; + cfg = (WolfCertServerCfgSrv){ + .protocol = TLS_LISTENER_PROTO, + .bind_host = "127.0.0.1", + .bind_port = 0, + TEST_CA_CFG, + .tls_cert_pem = tls_cert, + .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, + .tls_key_pem_len = tls_key_len, + .est_allow_anonymous_enroll = 1, + }; /* 1. Parked in wolfSSL_accept() after answering the ClientHello. */ memset(&ctx, 0, sizeof(ctx)); @@ -298,11 +299,12 @@ int main(void) #ifdef WOLFCERT_HAVE_SCEP /* 3. Parked in recv() on a plaintext listener. */ - memset(&cfg, 0, sizeof(cfg)); - cfg.protocol = WOLFCERT_PROTO_SCEP; - cfg.bind_host = "127.0.0.1"; - cfg.bind_port = 0; - cfg.ca_store = test_ca_store(); + cfg = (WolfCertServerCfgSrv){ + .protocol = WOLFCERT_PROTO_SCEP, + .bind_host = "127.0.0.1", + .bind_port = 0, + TEST_CA_CFG, + }; memset(&ctx, 0, sizeof(ctx)); REQUIRE(wolfcert_server_start(&cfg, &ctx.srv) == WOLFCERT_OK); @@ -427,11 +429,12 @@ int main(void) #ifdef WOLFCERT_HAVE_SCEP /* 8. The next client is served behind a silent plaintext peer. */ - memset(&cfg, 0, sizeof(cfg)); - cfg.protocol = WOLFCERT_PROTO_SCEP; - cfg.bind_host = "127.0.0.1"; - cfg.bind_port = 0; - cfg.ca_store = test_ca_store(); + cfg = (WolfCertServerCfgSrv){ + .protocol = WOLFCERT_PROTO_SCEP, + .bind_host = "127.0.0.1", + .bind_port = 0, + TEST_CA_CFG, + }; memset(&ctx, 0, sizeof(ctx)); REQUIRE(wolfcert_server_start(&cfg, &ctx.srv) == WOLFCERT_OK); @@ -456,7 +459,7 @@ int main(void) free(tls_cert); free(tls_key); - test_ca_store_close(); + test_ca_close(); wolfcert_cleanup(); printf("server stop idle: OK\n"); diff --git a/tests/integration/tls_test_util.h b/tests/integration/tls_test_util.h index 098d803..d4cd810 100644 --- a/tests/integration/tls_test_util.h +++ b/tests/integration/tls_test_util.h @@ -23,6 +23,9 @@ #define WOLFCERT_TLS_TEST_UTIL_H #include +#ifdef WOLFCERT_HAVE_SERVER +#include +#endif #include /* pid_t, referenced by wolfssl/wolfcrypt/random.h */ @@ -101,10 +104,13 @@ static inline int black_hole_listener(uint16_t* out_port) typedef RsaKey test_signkey; #define TEST_CERT_SIGTYPE CTC_SHA256wRSA #define TEST_KEY_PEM_TYPE PRIVATEKEY_TYPE + #define TEST_CA_KEY_USAGE \ + "keyCertSign,cRLSign,digitalSignature,keyEncipherment" #elif defined(HAVE_ECC) typedef ecc_key test_signkey; #define TEST_CERT_SIGTYPE CTC_SHA256wECDSA #define TEST_KEY_PEM_TYPE ECC_PRIVATEKEY_TYPE + #define TEST_CA_KEY_USAGE "keyCertSign,cRLSign,digitalSignature" #else #error "tls_test_util: tests need RSA or ECC for a signing identity" #endif @@ -187,7 +193,7 @@ static inline int test_signkey_to_der(test_signkey* key, uint8_t* der, } /* Self-signed cert + key (PEM) for `cn`. A leaf gets an iPAddress SAN for - * 127.0.0.1, a CA none. The caller frees both with free(). */ + * 127.0.0.1, a CA keyUsage instead. The caller frees both with free(). */ static inline int mint_self_id(const char* cn, int is_ca, uint8_t** cert_pem, size_t* cert_pem_len, uint8_t** key_pem, size_t* key_pem_len) @@ -215,7 +221,11 @@ static inline int mint_self_id(const char* cn, int is_ca, cert.sigType = TEST_CERT_SIGTYPE; cert.daysValid = 1; cert.isCA = is_ca ? 1 : 0; - if (!is_ca) { + if (is_ca) { + if (wc_SetKeyUsage(&cert, TEST_CA_KEY_USAGE) != 0) + goto fail; + } + else { memcpy(cert.altNames, san_seq, sizeof(san_seq)); cert.altNamesSz = (int)sizeof(san_seq); } @@ -249,44 +259,57 @@ static inline int mint_self_id(const char* cn, int is_ca, return -1; } -static inline WolfCertStoreOps** test_ca_store_slot(void) +/* Self-signed TLS server identity (cert + key, PEM) for 127.0.0.1. */ +static inline int gen_server_identity(uint8_t** cert_pem, size_t* cert_pem_len, + uint8_t** key_pem, size_t* key_pem_len) { - static WolfCertStoreOps* store = NULL; - - return &store; + return mint_self_id("127.0.0.1", 0, cert_pem, cert_pem_len, + key_pem, key_pem_len); } -/* One CA store for every test server in the process, so only the first - * server start generates a CA. */ -static inline WolfCertStoreOps* test_ca_store(void) +#ifdef WOLFCERT_HAVE_SERVER +typedef struct { + uint8_t* cert; + size_t cert_len; + uint8_t* key; + size_t key_len; +} TestCa; + +static inline TestCa* test_ca_slot(void) { - WolfCertStoreOps** store = test_ca_store_slot(); - - if (*store == NULL) { - *store = wolfcert_store_memory_open(NULL); - if (*store == NULL) { - fprintf(stderr, "test_ca_store: cannot open the memory store\n"); - exit(1); - } - } - return *store; + static TestCa ca; + + return &ca; } -static inline void test_ca_store_close(void) +/* One CA per process, handed to every server the test starts. */ +static inline const TestCa* test_ca(void) { - WolfCertStoreOps** store = test_ca_store_slot(); + TestCa* ca = test_ca_slot(); - wolfcert_store_memory_close(*store); - *store = NULL; + if (ca->cert == NULL && + mint_self_id("wolfCert Test CA", 1, &ca->cert, &ca->cert_len, + &ca->key, &ca->key_len) != 0) { + fprintf(stderr, "test_ca: cannot generate the shared CA\n"); + exit(1); + } + return ca; } -/* Self-signed TLS server identity (cert + key, PEM) for 127.0.0.1. */ -static inline int gen_server_identity(uint8_t** cert_pem, size_t* cert_pem_len, - uint8_t** key_pem, size_t* key_pem_len) +/* Designated initializers that give a server config the shared CA. */ +#define TEST_CA_CFG \ + .ca_cert = test_ca()->cert, .ca_cert_len = test_ca()->cert_len, \ + .ca_key = test_ca()->key, .ca_key_len = test_ca()->key_len + +static inline void test_ca_close(void) { - return mint_self_id("127.0.0.1", 0, cert_pem, cert_pem_len, - key_pem, key_pem_len); + TestCa* ca = test_ca_slot(); + + free(ca->cert); + free(ca->key); + memset(ca, 0, sizeof(*ca)); } +#endif /* WOLFCERT_HAVE_SERVER */ /* Raw TLS client; each test_tls_write() is one TLS record, so one * wolfSSL_read() on the server, which the split-request tests need. */ diff --git a/tests/unit/test_server_ca_store.c b/tests/unit/test_server_ca.c similarity index 53% rename from tests/unit/test_server_ca_store.c rename to tests/unit/test_server_ca.c index 3a6bd8b..8f2b28c 100644 --- a/tests/unit/test_server_ca_store.c +++ b/tests/unit/test_server_ca.c @@ -49,25 +49,27 @@ /* SCEP is absent from NO_RSA builds, and EST needs a server identity. */ #if defined(WOLFCERT_HAVE_EST) - #define CA_STORE_PROTO WOLFCERT_PROTO_EST - #define CA_STORE_NEEDS_TLS 1 + #define CA_TEST_PROTO WOLFCERT_PROTO_EST + #define CA_TEST_NEEDS_TLS 1 #else - #define CA_STORE_PROTO WOLFCERT_PROTO_SCEP - #define CA_STORE_NEEDS_TLS 0 + #define CA_TEST_PROTO WOLFCERT_PROTO_SCEP + #define CA_TEST_NEEDS_TLS 0 #endif -#if CA_STORE_NEEDS_TLS +#if CA_TEST_NEEDS_TLS static uint8_t* srv_cert_pem; static size_t srv_cert_pem_len; static uint8_t* srv_key_pem; static size_t srv_key_pem_len; #endif -static void ca_store_cfg(WolfCertServerCfgSrv* cfg, WolfCertStoreOps* store) +/* A server config issuing from cert and key; both NULL generates a CA. */ +static void ca_cfg(WolfCertServerCfgSrv* cfg, const WolfCertBuffer* cert, + const WolfCertBuffer* key) { memset(cfg, 0, sizeof(*cfg)); - cfg->protocol = CA_STORE_PROTO; -#if CA_STORE_NEEDS_TLS + cfg->protocol = CA_TEST_PROTO; +#if CA_TEST_NEEDS_TLS cfg->tls_cert_pem = srv_cert_pem; cfg->tls_cert_pem_len = srv_cert_pem_len; cfg->tls_key_pem = srv_key_pem; @@ -75,336 +77,181 @@ static void ca_store_cfg(WolfCertServerCfgSrv* cfg, WolfCertStoreOps* store) cfg->est_allow_anonymous_enroll = 1; #endif cfg->bind_host = "127.0.0.1"; - cfg->ca_store = store; cfg->ca_key_type = CA_KEY_TYPE; cfg->ca_key_param = CA_KEY_PARAM; + if (cert != NULL) { + cfg->ca_cert = cert->data; + cfg->ca_cert_len = cert->len; + } + if (key != NULL) { + cfg->ca_key = key->data; + cfg->ca_key_len = key->len; + } } -/* Stub backend whose reads and writes all return the configured error. */ -typedef struct { - int read_rc; - int write_rc; -} StubCtx; - -static int stub_read(void* ctx_, const char* key, WolfCertBuffer* out) -{ - (void)key; - (void)out; - return ((StubCtx*)ctx_)->read_rc; -} - -static int stub_write(void* ctx_, const char* key, const uint8_t* data, - size_t len, int sensitive) -{ - (void)key; - (void)data; - (void)len; - (void)sensitive; - return ((StubCtx*)ctx_)->write_rc; -} - -static int stub_remove(void* ctx_, const char* key) -{ - (void)ctx_; - (void)key; - return WOLFCERT_OK; -} - -static void stub_store(WolfCertStoreOps* ops, StubCtx* ctx) -{ - memset(ops, 0, sizeof(*ops)); - ops->read = stub_read; - ops->write = stub_write; - ops->remove = stub_remove; - ops->ctx = ctx; -} - -static int test_corrupt_ca_rejected(void) +static int ca_key_param(WolfCertKeyType t) { - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); - REQUIRE(store != NULL); - - const uint8_t junk[] = { 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA }; - REQUIRE(store->write(store->ctx, "ca.cert.der", junk, sizeof(junk), 0) == WOLFCERT_OK); - REQUIRE(store->write(store->ctx, "ca.key.der", junk, sizeof(junk), 1) == WOLFCERT_OK); - - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; - - ca_store_cfg(&cfg, store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); - - wolfcert_store_memory_close(store); + if (t == WOLFCERT_KEY_RSA) + return 2048; + if (t == WOLFCERT_KEY_ECC) + return 256; return 0; } -static int test_load_io_error_rejected(void) +/* A server start generates a CA of type; the pair is copied out as enc. */ +static int generate_ca(WolfCertKeyType type, WolfCertEncoding enc, + WolfCertBuffer* cert, WolfCertBuffer* key) { - StubCtx ctx = { WOLFCERT_ERR_IO, WOLFCERT_OK }; - WolfCertStoreOps store; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; + int rc; - stub_store(&store, &ctx); - ca_store_cfg(&cfg, &store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_IO); - REQUIRE(srv == NULL); + ca_cfg(&cfg, NULL, NULL); + cfg.ca_key_type = type; + cfg.ca_key_param = ca_key_param(type); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, enc, cert, key); + wolfcert_server_free(srv); + REQUIRE(rc == WOLFCERT_OK); return 0; } -static int test_save_failure_rejected(void) +/* A server start with cert and key gets want and, on failure, no server. */ +static int start_gets(const WolfCertBuffer* cert, const WolfCertBuffer* key, + int want) { - StubCtx ctx = { WOLFCERT_ERR_NOT_FOUND, WOLFCERT_ERR_IO }; - WolfCertStoreOps store; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; - stub_store(&store, &ctx); - ca_store_cfg(&cfg, &store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_IO); - REQUIRE(srv == NULL); + ca_cfg(&cfg, cert, key); + REQUIRE(wolfcert_server_start(&cfg, &srv) == want); + if (want != WOLFCERT_OK) + REQUIRE(srv == NULL); + wolfcert_server_free(srv); return 0; } -/* Stub backend whose certificate and key reads fail differently. */ -typedef struct { - int cert_rc; - int key_rc; -} SplitCtx; - -static int split_read(void* ctx_, const char* key, WolfCertBuffer* out) +static int test_corrupt_ca_rejected(void) { - SplitCtx* ctx = (SplitCtx*)ctx_; + uint8_t junk[] = { 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA }; + WolfCertBuffer bad = { junk, sizeof(junk), NULL }; - (void)out; - return strcmp(key, "ca.cert.der") == 0 ? ctx->cert_rc : ctx->key_rc; + return start_gets(&bad, &bad, WOLFCERT_ERR_PARSE); } -/* wolfcert_server_start with cert and key reads returning cert_rc and key_rc - * gets want and no server. */ -static int mixed_read_failure(int cert_rc, int key_rc, int want) +/* One half of the pair, or an empty half, is refused before any work. */ +static int test_half_ca_rejected(void) { - SplitCtx ctx = { cert_rc, key_rc }; - WolfCertStoreOps store; + uint8_t der[] = { 0x30, 0x03, 0x02, 0x01, 0x01 }; + WolfCertBuffer half = { der, sizeof(der), NULL }; + WolfCertBuffer empty = { der, 0, NULL }; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; - memset(&store, 0, sizeof(store)); - store.read = split_read; - store.write = stub_write; - store.remove = stub_remove; - store.ctx = &ctx; - - ca_store_cfg(&cfg, &store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == want); - REQUIRE(srv == NULL); - return 0; -} - -static int test_mixed_read_failure(void) -{ - if (mixed_read_failure(WOLFCERT_ERR_NOT_FOUND, WOLFCERT_ERR_IO, - WOLFCERT_ERR_IO)) + if (start_gets(&half, NULL, WOLFCERT_ERR_BAD_ARG)) return 1; - if (mixed_read_failure(WOLFCERT_ERR_IO, WOLFCERT_ERR_NOT_FOUND, - WOLFCERT_ERR_IO)) + if (start_gets(NULL, &half, WOLFCERT_ERR_BAD_ARG)) return 1; - if (mixed_read_failure(WOLFCERT_ERR_NOT_FOUND, WOLFCERT_ERR_MEMORY, - WOLFCERT_ERR_MEMORY)) + if (start_gets(&half, &empty, WOLFCERT_ERR_BAD_ARG)) + return 1; + if (start_gets(&empty, &half, WOLFCERT_ERR_BAD_ARG)) return 1; - /* Cert NOT_FOUND beside a good key read: start gets PARSE. */ - return mixed_read_failure(WOLFCERT_ERR_NOT_FOUND, WOLFCERT_OK, - WOLFCERT_ERR_PARSE); -} - -/* Backend that forwards to a real store but fails the nth write. */ -typedef struct { - WolfCertStoreOps* inner; - int writes; - int fail_at; -} FlakyCtx; - -static int flaky_read(void* ctx_, const char* key, WolfCertBuffer* out) -{ - WolfCertStoreOps* in = ((FlakyCtx*)ctx_)->inner; - - return in->read(in->ctx, key, out); -} - -static int flaky_write(void* ctx_, const char* key, const uint8_t* data, - size_t len, int sensitive) -{ - FlakyCtx* ctx = (FlakyCtx*)ctx_; - - if (++ctx->writes == ctx->fail_at) - return WOLFCERT_ERR_IO; - - return ctx->inner->write(ctx->inner->ctx, key, data, len, sensitive); -} - -static int flaky_remove(void* ctx_, const char* key) -{ - WolfCertStoreOps* in = ((FlakyCtx*)ctx_)->inner; - - return in->remove(in->ctx, key); -} - -static int failing_remove(void* ctx_, const char* key) -{ - (void)ctx_; - (void)key; - return WOLFCERT_ERR_IO; + /* A length without its pointer is not a request to generate a CA. */ + ca_cfg(&cfg, NULL, NULL); + cfg.ca_cert_len = sizeof(der); + cfg.ca_key_len = sizeof(der); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(srv == NULL); + return 0; } -/* A failed key write removes the certificate already written. */ -static int test_save_rollback(void) +/* A generated CA handed back in, as DER or PEM, is the one the server uses. */ +static int test_ca_round_trip(void) { - WolfCertStoreOps* mem = wolfcert_store_memory_open(NULL); - FlakyCtx fctx; - WolfCertStoreOps store; + WolfCertBuffer der_cert = { 0 }; + WolfCertBuffer der_key = { 0 }; + WolfCertBuffer pem_cert = { 0 }; + WolfCertBuffer pem_key = { 0 }; + WolfCertBuffer again = { 0 }; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; - WolfCertBuffer left = { 0 }; - - REQUIRE(mem != NULL); - - memset(&fctx, 0, sizeof(fctx)); - fctx.inner = mem; - fctx.fail_at = 2; + int rc; - memset(&store, 0, sizeof(store)); - store.read = flaky_read; - store.write = flaky_write; - store.remove = flaky_remove; - store.ctx = &fctx; + ca_cfg(&cfg, NULL, NULL); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &der_cert, + &der_key) == WOLFCERT_OK); + REQUIRE(wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_PEM, &pem_cert, + &pem_key) == WOLFCERT_OK); + wolfcert_server_free(srv); + srv = NULL; + REQUIRE(der_cert.data[0] == 0x30 && der_key.data[0] == 0x30); + REQUIRE(memcmp(pem_cert.data, "-----BEGIN CERTIFICATE-----", 27) == 0); + REQUIRE(memcmp(pem_key.data, "-----BEGIN ", 11) == 0); - ca_store_cfg(&cfg, &store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_IO); - REQUIRE(srv == NULL); - REQUIRE(mem->read(mem->ctx, "ca.cert.der", &left) == WOLFCERT_ERR_NOT_FOUND); + ca_cfg(&cfg, &pem_cert, &pem_key); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &again, NULL); + wolfcert_server_free(srv); + srv = NULL; + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(again.len == der_cert.len); + REQUIRE(memcmp(again.data, der_cert.data, der_cert.len) == 0); + wolfcert_buffer_free(&again); - /* The store is still empty, so the next start bootstraps normally. */ - fctx.fail_at = 0; + ca_cfg(&cfg, &der_cert, &der_key); REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &again, NULL); wolfcert_server_free(srv); - REQUIRE(mem->read(mem->ctx, "ca.cert.der", &left) == WOLFCERT_OK); + srv = NULL; + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(again.len == der_cert.len); + REQUIRE(memcmp(again.data, der_cert.data, der_cert.len) == 0); + wolfcert_buffer_free(&again); - wolfcert_buffer_free(&left); - wolfcert_store_memory_close(mem); + /* Each half may use its own encoding. */ + ca_cfg(&cfg, &pem_cert, &der_key); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &again, NULL); + wolfcert_server_free(srv); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(again.len == der_cert.len); + REQUIRE(memcmp(again.data, der_cert.data, der_cert.len) == 0); + + wolfcert_buffer_free(&again); + wolfcert_buffer_free(&der_cert); + wolfcert_buffer_free_secure(&der_key); + wolfcert_buffer_free(&pem_cert); + wolfcert_buffer_free_secure(&pem_key); return 0; } -/* Key write fails with remove absent or failing: IO, a "rolled back" - * message, and the next start gets PARSE. */ -static int rollback_unavailable(int have_remove) +static int test_get_ca_args(void) { - WolfCertStoreOps* mem = wolfcert_store_memory_open(NULL); - FlakyCtx fctx; - WolfCertStoreOps store; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; - WolfCertBuffer left = { 0 }; - - REQUIRE(mem != NULL); - - memset(&fctx, 0, sizeof(fctx)); - fctx.inner = mem; - fctx.fail_at = 2; - - memset(&store, 0, sizeof(store)); - store.read = flaky_read; - store.write = flaky_write; - store.remove = have_remove ? failing_remove : NULL; - store.ctx = &fctx; - - ca_store_cfg(&cfg, &store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_IO); - REQUIRE(srv == NULL); - REQUIRE(strstr(wolfcert_last_error_message(), "rolled back") != NULL); - - /* The certificate really is still there, and the next start refuses it. */ - REQUIRE(mem->read(mem->ctx, "ca.cert.der", &left) == WOLFCERT_OK); - wolfcert_buffer_free(&left); - - fctx.fail_at = 0; - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); - - wolfcert_store_memory_close(mem); - return 0; -} - -static int test_rollback_unavailable(void) -{ - if (rollback_unavailable(0)) - return 1; + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; - return rollback_unavailable(1); -} + ca_cfg(&cfg, NULL, NULL); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); -/* A store holding one half of the pair fails to start. */ -static int partial_store_rejected(const char* present) -{ - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); - const uint8_t stored[] = { 0x30, 0x03, 0x02, 0x01, 0x01 }; - WolfCertBuffer left = { 0 }; - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; + REQUIRE(wolfcert_server_get_ca(NULL, WOLFCERT_ENCODING_DER, &cert, &key) + == WOLFCERT_ERR_BAD_ARG); + REQUIRE(wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, NULL, &key) + == WOLFCERT_ERR_BAD_ARG); + REQUIRE(wolfcert_server_get_ca(srv, (WolfCertEncoding)7, &cert, &key) + == WOLFCERT_ERR_BAD_ARG); + REQUIRE(strstr(wolfcert_last_error_message(), "encoding") != NULL); + REQUIRE(cert.data == NULL && key.data == NULL); - REQUIRE(store != NULL); - REQUIRE(store->write(store->ctx, present, stored, sizeof(stored), 0) + REQUIRE(wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_PEM, &cert, NULL) == WOLFCERT_OK); + REQUIRE(cert.data != NULL && cert.len > 0); - ca_store_cfg(&cfg, store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); - - /* The survivor is still exactly what was stored. */ - REQUIRE(store->read(store->ctx, present, &left) == WOLFCERT_OK); - REQUIRE(left.len == sizeof(stored)); - REQUIRE(memcmp(left.data, stored, left.len) == 0); - - wolfcert_buffer_free(&left); - wolfcert_store_memory_close(store); - return 0; -} - -static int test_partial_store_rejected(void) -{ - if (partial_store_rejected("ca.cert.der")) - return 1; - - return partial_store_rejected("ca.key.der"); -} - -static int test_ca_persists_across_starts(void) -{ - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); - REQUIRE(store != NULL); - - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; - WolfCertBuffer first = { 0 }; - WolfCertBuffer second = { 0 }; - - ca_store_cfg(&cfg, store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); - wolfcert_server_free(srv); - srv = NULL; - REQUIRE(store->read(store->ctx, "ca.cert.der", &first) == WOLFCERT_OK); - - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + wolfcert_buffer_free(&cert); wolfcert_server_free(srv); - REQUIRE(store->read(store->ctx, "ca.cert.der", &second) == WOLFCERT_OK); - - REQUIRE(first.len == second.len); - REQUIRE(memcmp(first.data, second.data, first.len) == 0); - - wolfcert_buffer_free(&first); - wolfcert_buffer_free(&second); - wolfcert_store_memory_close(store); return 0; } @@ -432,7 +279,8 @@ static void* fail_one_realloc(void* ptr, size_t sz) /* A start that survives any single failed allocation keeps every credential. */ static int test_start_oom_keeps_credentials(void) { - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; wolfSSL_Malloc_cb mf; @@ -441,25 +289,27 @@ static int test_start_oom_keeps_credentials(void) int fail_at; int rc; - REQUIRE(store != NULL); - ca_store_cfg(&cfg, store); + if (generate_ca(CA_KEY_TYPE, WOLFCERT_ENCODING_PEM, &cert, &key)) + return 1; + ca_cfg(&cfg, &cert, &key); cfg.http_basic_user = "alice"; cfg.http_basic_pass = "secret"; cfg.challenge_password = "otp"; - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); - wolfcert_server_free(srv); REQUIRE(wolfSSL_GetAllocators(&mf, &ff, &rf) == 0); for (fail_at = 0; ; fail_at++) { srv = NULL; g_fail_at = fail_at; g_allocs = 0; + wolfcert_clear_error(); REQUIRE(wolfSSL_SetAllocators(fail_one_malloc, fail_one_free, fail_one_realloc) == 0); rc = wolfcert_server_start(&cfg, &srv); REQUIRE(wolfSSL_SetAllocators(mf, ff, rf) == 0); if (rc != WOLFCERT_OK) { REQUIRE(srv == NULL); + REQUIRE(strstr(wolfcert_last_error_message(), "does not match") + == NULL); continue; } REQUIRE(srv->cfg_basic_user != NULL && @@ -475,7 +325,8 @@ static int test_start_oom_keeps_credentials(void) g_fail_at = -1; REQUIRE(fail_at > 4); - wolfcert_store_memory_close(store); + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); return 0; } #endif @@ -506,18 +357,8 @@ static const WolfCertKeyType CA_KEY_TYPES[] = { #endif }; -static int ca_key_param(WolfCertKeyType t) -{ - if (t == WOLFCERT_KEY_RSA) - return 2048; - if (t == WOLFCERT_KEY_ECC) - return 256; - return 0; -} - -/* The CA reloaded from store issues a leaf that verifies against it; the - * cert/key match on load alone passes a key with no public half. */ -static int reloaded_ca_signs(WolfCertStoreOps* store) +/* The loaded CA issues a leaf that verifies against it. */ +static int loaded_ca_signs(const WolfCertBuffer* cert, const WolfCertBuffer* key) { /* Any compiled algorithm serves as the leaf; the first entry always is. */ WolfCertKeyCfg kcfg = { .type = CA_KEY_TYPES[0], @@ -536,7 +377,8 @@ static int reloaded_ca_signs(WolfCertStoreOps* store) REQUIRE(wolfcert_csr_build(leaf_key, &meta, &csr) == WOLFCERT_OK); wolfcert_key_free(leaf_key); - REQUIRE(wolfcert_ca_load(&ca, store, NULL) == WOLFCERT_OK); + REQUIRE(wolfcert_ca_load(&ca, cert->data, cert->len, key->data, key->len, + NULL) == WOLFCERT_OK); rc = wolfcert_ca_issue(&ca, csr.data, csr.len, &issued, &issued_len); wolfcert_buffer_free(&csr); REQUIRE(rc == WOLFCERT_OK); @@ -556,78 +398,132 @@ static int reloaded_ca_signs(WolfCertStoreOps* store) return 0; } +/* Every algorithm's CA loads back from both encodings and still signs. */ static int test_every_alg_reloads(void) { size_t i; + int e; for (i = 0; i < sizeof(CA_KEY_TYPES) / sizeof(CA_KEY_TYPES[0]); ++i) { - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); + WolfCertBuffer cert[2] = { { 0 }, { 0 } }; + WolfCertBuffer key[2] = { { 0 }, { 0 } }; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; + int rc; - REQUIRE(store != NULL); - ca_store_cfg(&cfg, store); + ca_cfg(&cfg, NULL, NULL); cfg.ca_key_type = CA_KEY_TYPES[i]; cfg.ca_key_param = ca_key_param(CA_KEY_TYPES[i]); REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &cert[0], + &key[0]); + if (rc == WOLFCERT_OK) + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_PEM, &cert[1], + &key[1]); wolfcert_server_free(srv); - srv = NULL; + REQUIRE(rc == WOLFCERT_OK); + + for (e = 0; e < 2; ++e) { + if (start_gets(&cert[e], &key[e], WOLFCERT_OK)) + return 1; + if (loaded_ca_signs(&cert[e], &key[e])) + return 1; + wolfcert_buffer_free(&cert[e]); + wolfcert_buffer_free_secure(&key[e]); + } + } + return 0; +} - /* Second start reloads the saved pair and checks the cert/key match. */ - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); - wolfcert_server_free(srv); +#ifdef WOLFCERT_HAVE_ECC +/* A SEC1 CA key without its optional public point still loads. */ +static int test_ecc_key_without_public_point(void) +{ + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; + WolfCertBuffer bare = { 0 }; + ecc_key ek; + word32 idx = 0; + uint8_t der[256]; + int n; - if (reloaded_ca_signs(store)) - return 1; + if (generate_ca(WOLFCERT_KEY_ECC, WOLFCERT_ENCODING_DER, &cert, &key)) + return 1; + REQUIRE(wc_ecc_init(&ek) == 0); + REQUIRE(wc_EccPrivateKeyDecode(key.data, &idx, &ek, (word32)key.len) == 0); + n = wc_EccPrivateKeyToDer(&ek, der, sizeof(der)); + wc_ecc_free(&ek); + REQUIRE(n > 0 && (size_t)n < key.len); + + bare.data = der; + bare.len = (size_t)n; + if (start_gets(&cert, &bare, WOLFCERT_OK)) + return 1; - wolfcert_store_memory_close(store); - } + wc_ForceZero(der, sizeof(der)); + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); return 0; } +#endif -/* A server start generates a CA into `store`; the pair is copied out. */ -static int generate_ca_into(WolfCertStoreOps* store, WolfCertKeyType type, - WolfCertBuffer* cert, WolfCertBuffer* key) +#ifdef WOLFCERT_HAVE_SCEP +/* With a split RA, get_ca returns the CA, not the RA certificate. */ +static int test_split_ra_get_ca_is_ca(void) { WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; + WolfCertBuffer cert = { 0 }; + DecodedCert dc; + int rc; - ca_store_cfg(&cfg, store); - cfg.ca_key_type = type; - cfg.ca_key_param = ca_key_param(type); + ca_cfg(&cfg, NULL, NULL); + cfg.protocol = WOLFCERT_PROTO_SCEP; + cfg.ca_key_type = WOLFCERT_KEY_RSA; + cfg.ca_key_param = 2048; + cfg.scep_split_ra = 1; REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &cert, NULL); wolfcert_server_free(srv); + REQUIRE(rc == WOLFCERT_OK); - REQUIRE(store->read(store->ctx, "ca.cert.der", cert) == WOLFCERT_OK); - REQUIRE(store->read(store->ctx, "ca.key.der", key) == WOLFCERT_OK); + wc_InitDecodedCert(&dc, cert.data, (word32)cert.len, NULL); + rc = wc_ParseCert(&dc, CERT_TYPE, NO_VERIFY, NULL); + if (rc == 0 && !dc.isCA) + rc = -1; + wc_FreeDecodedCert(&dc); + wolfcert_buffer_free(&cert); + REQUIRE(rc == 0); return 0; } +#endif -/* Have the CA in store issue a CSR carrying san; *rc_out is the issue result. */ -static int issue_with_san(WolfCertStoreOps* store, const uint8_t* san, - size_t san_len, int* rc_out, uint8_t** issued, - size_t* issued_len) +/* Have the CA in cert/key issue a CSR carrying san; *rc_out is the result. */ +static int issue_with_san(const WolfCertBuffer* cert, const WolfCertBuffer* key, + const uint8_t* san, size_t san_len, int* rc_out, + uint8_t** issued, size_t* issued_len) { WolfCertCa ca; WC_RNG rng; - test_signkey key; + test_signkey skey; Cert req; uint8_t csr[CTC_MAX_ALT_SIZE + 4096]; int csr_len; REQUIRE(wc_InitRng(&rng) == 0); - REQUIRE(test_signkey_make(&key, &rng) == 0); + REQUIRE(test_signkey_make(&skey, &rng) == 0); REQUIRE(wc_InitCert(&req) == 0); strncpy(req.subject.commonName, "san-leaf", CTC_NAME_SIZE - 1); memcpy(req.altNames, san, san_len); req.altNamesSz = (int)san_len; req.sigType = TEST_CERT_SIGTYPE; - csr_len = test_sign_certreq(&req, csr, (int)sizeof(csr), &key, &rng); - test_signkey_free(&key); + csr_len = test_sign_certreq(&req, csr, (int)sizeof(csr), &skey, &rng); + test_signkey_free(&skey); wc_FreeRng(&rng); REQUIRE(csr_len > 0); - REQUIRE(wolfcert_ca_load(&ca, store, NULL) == WOLFCERT_OK); + REQUIRE(wolfcert_ca_load(&ca, cert->data, cert->len, key->data, key->len, + NULL) == WOLFCERT_OK); *rc_out = wolfcert_ca_issue(&ca, csr, (size_t)csr_len, issued, issued_len); wolfcert_ca_free(&ca); return 0; @@ -648,7 +544,6 @@ static int test_issued_san_verbatim(void) 0xa4, 0x10, 0x30, 0x0e, 0x31, 0x0c, 0x30, 0x0a, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x03, 'd', 'i', 'r' }; - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); WolfCertBuffer ca_cert = { 0 }; WolfCertBuffer ca_key = { 0 }; uint8_t* issued = NULL; @@ -660,13 +555,11 @@ static int test_issued_san_verbatim(void) size_t big_len = 4; int rc = -1; - REQUIRE(store != NULL); - REQUIRE(generate_ca_into(store, CA_KEY_TYPES[0], &ca_cert, &ca_key) == 0); - wolfcert_buffer_free(&ca_cert); - wolfcert_buffer_free(&ca_key); + if (generate_ca(CA_KEY_TYPES[0], WOLFCERT_ENCODING_DER, &ca_cert, &ca_key)) + return 1; - REQUIRE(issue_with_san(store, dir_san, sizeof(dir_san), &rc, &issued, - &issued_len) == 0); + REQUIRE(issue_with_san(&ca_cert, &ca_key, dir_san, sizeof(dir_san), &rc, + &issued, &issued_len) == 0); REQUIRE(rc == WOLFCERT_ERR_UNSUPPORTED); /* Over 8 KB of SAN in few entries, so a static-memory pool can parse it. */ @@ -684,14 +577,15 @@ static int test_issued_san_verbatim(void) big_san[1] = 0x82; big_san[2] = (uint8_t)((big_len - 4) >> 8); big_san[3] = (uint8_t)(big_len - 4); - REQUIRE(issue_with_san(store, big_san, big_len, &rc, &issued, + REQUIRE(issue_with_san(&ca_cert, &ca_key, big_san, big_len, &rc, &issued, &issued_len) == 0); REQUIRE(rc == WOLFCERT_OK); - WOLFCERT_XFREE(issued, NULL); + WOLFCERT_XFREE(issued, wolfcert_default_heap()); issued = NULL; - REQUIRE(issue_with_san(store, san, sizeof(san), &rc, &issued, + REQUIRE(issue_with_san(&ca_cert, &ca_key, san, sizeof(san), &rc, &issued, &issued_len) == 0); - wolfcert_store_memory_close(store); + wolfcert_buffer_free(&ca_cert); + wolfcert_buffer_free_secure(&ca_key); REQUIRE(rc == WOLFCERT_OK); wc_InitDecodedCert(&dc, issued, (word32)issued_len, NULL); @@ -702,51 +596,31 @@ static int test_issued_san_verbatim(void) memcmp(got, san, sizeof(san)) != 0)) rc = -1; wc_FreeDecodedCert(&dc); - WOLFCERT_XFREE(issued, NULL); + WOLFCERT_XFREE(issued, wolfcert_default_heap()); REQUIRE(rc == 0); return 0; } static int mismatched_ca_rejected(WolfCertKeyType type) { - WolfCertStoreOps* src_a = wolfcert_store_memory_open(NULL); - WolfCertStoreOps* src_b = wolfcert_store_memory_open(NULL); - WolfCertStoreOps* mixed = wolfcert_store_memory_open(NULL); WolfCertBuffer cert_a = { 0 }; WolfCertBuffer key_a = { 0 }; WolfCertBuffer cert_b = { 0 }; WolfCertBuffer key_b = { 0 }; - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; - - REQUIRE(src_a != NULL); - REQUIRE(src_b != NULL); - REQUIRE(mixed != NULL); - if (generate_ca_into(src_a, type, &cert_a, &key_a)) + if (generate_ca(type, WOLFCERT_ENCODING_DER, &cert_a, &key_a)) return 1; - if (generate_ca_into(src_b, type, &cert_b, &key_b)) + if (generate_ca(type, WOLFCERT_ENCODING_DER, &cert_b, &key_b)) return 1; REQUIRE(key_a.len != key_b.len || memcmp(key_a.data, key_b.data, key_a.len) != 0); - REQUIRE(mixed->write(mixed->ctx, "ca.cert.der", cert_a.data, cert_a.len, 0) - == WOLFCERT_OK); - REQUIRE(mixed->write(mixed->ctx, "ca.key.der", key_b.data, key_b.len, 1) - == WOLFCERT_OK); - - ca_store_cfg(&cfg, mixed); - cfg.ca_key_type = type; - cfg.ca_key_param = ca_key_param(type); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); + if (start_gets(&cert_a, &key_b, WOLFCERT_ERR_PARSE)) + return 1; wolfcert_buffer_free(&cert_a); - wolfcert_buffer_free(&key_a); + wolfcert_buffer_free_secure(&key_a); wolfcert_buffer_free(&cert_b); - wolfcert_buffer_free(&key_b); - wolfcert_store_memory_close(src_a); - wolfcert_store_memory_close(src_b); - wolfcert_store_memory_close(mixed); + wolfcert_buffer_free_secure(&key_b); return 0; } @@ -764,15 +638,12 @@ static int test_mismatched_ca_rejected(void) /* The generated CA's key usages and critical basicConstraints. */ static int ca_key_usage_set(WolfCertKeyType type) { - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); WolfCertBuffer cert = { 0 }; WolfCertBuffer key = { 0 }; DecodedCert dc; int rc = 0; - REQUIRE(store != NULL); - - if (generate_ca_into(store, type, &cert, &key)) + if (generate_ca(type, WOLFCERT_ENCODING_DER, &cert, &key)) return 1; wc_InitDecodedCert(&dc, cert.data, (word32)cert.len, NULL); @@ -795,8 +666,7 @@ static int ca_key_usage_set(WolfCertKeyType type) wc_FreeDecodedCert(&dc); wolfcert_buffer_free(&cert); - wolfcert_buffer_free(&key); - wolfcert_store_memory_close(store); + wolfcert_buffer_free_secure(&key); REQUIRE(rc == 0); return 0; @@ -815,35 +685,120 @@ static int test_ca_key_usage(void) static int test_corrupt_ca_cert_rejected(void) { - WolfCertStoreOps* src = wolfcert_store_memory_open(NULL); - WolfCertStoreOps* mixed = wolfcert_store_memory_open(NULL); + uint8_t junk[] = { 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA }; + WolfCertBuffer bad = { junk, sizeof(junk), NULL }; WolfCertBuffer cert = { 0 }; WolfCertBuffer key = { 0 }; - const uint8_t junk[] = { 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA }; - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; + WolfCertBuffer padded = { 0 }; - REQUIRE(src != NULL); - REQUIRE(mixed != NULL); + if (generate_ca(CA_KEY_TYPE, WOLFCERT_ENCODING_DER, &cert, &key)) + return 1; + if (start_gets(&bad, &key, WOLFCERT_ERR_PARSE)) + return 1; + REQUIRE(strstr(wolfcert_last_error_message(), "ca_cert") != NULL); + if (start_gets(&cert, &bad, WOLFCERT_ERR_PARSE)) + return 1; + REQUIRE(strstr(wolfcert_last_error_message(), "ca_key") != NULL); - if (generate_ca_into(src, CA_KEY_TYPE, &cert, &key)) + /* DER that is not a certificate fails the same way. */ + if (start_gets(&key, &key, WOLFCERT_ERR_PARSE)) return 1; - REQUIRE(mixed->write(mixed->ctx, "ca.cert.der", junk, sizeof(junk), 0) - == WOLFCERT_OK); - REQUIRE(mixed->write(mixed->ctx, "ca.key.der", key.data, key.len, 1) - == WOLFCERT_OK); + /* So does a certificate with bytes after it. */ + padded.data = (uint8_t*)malloc(cert.len + 1); + REQUIRE(padded.data != NULL); + memcpy(padded.data, cert.data, cert.len); + padded.data[cert.len] = 0; + padded.len = cert.len + 1; + if (start_gets(&padded, &key, WOLFCERT_ERR_PARSE)) + return 1; + free(padded.data); + + /* And a DER key with bytes after it. */ + padded.data = (uint8_t*)malloc(key.len + 1); + REQUIRE(padded.data != NULL); + memcpy(padded.data, key.data, key.len); + padded.data[key.len] = 0; + padded.len = key.len + 1; + if (start_gets(&cert, &padded, WOLFCERT_ERR_PARSE)) + return 1; + REQUIRE(strstr(wolfcert_last_error_message(), "ca_key") != NULL); + wc_ForceZero(padded.data, (word32)padded.len); + free(padded.data); - ca_store_cfg(&cfg, mixed); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); + return 0; +} + +#if !defined(NO_PKCS8) && \ + (defined(WOLFCERT_HAVE_RSA) || defined(WOLFCERT_HAVE_ECC)) +/* A PKCS#8 CA key comes back in the form its PEM label names. */ +static int test_pkcs8_ca_key_normalized(void) +{ +#ifdef WOLFCERT_HAVE_RSA + const WolfCertKeyType type = WOLFCERT_KEY_RSA; + const int algo = RSAk; + const byte* curve = NULL; + word32 curve_sz = 0; + const char* label = "-----BEGIN RSA PRIVATE KEY-----"; +#else + const WolfCertKeyType type = WOLFCERT_KEY_ECC; + const int algo = ECDSAk; + const byte* curve = NULL; + word32 curve_sz = 0; + const char* label = "-----BEGIN EC PRIVATE KEY-----"; +#endif + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; + WolfCertBuffer p8 = { 0 }; + WolfCertBuffer out_cert = { 0 }; + WolfCertBuffer out_key = { 0 }; + WolfCertServerCfgSrv cfg; + WolfCertServer* srv = NULL; + word32 p8_len = 0; + int rc; + + if (generate_ca(type, WOLFCERT_ENCODING_DER, &cert, &key)) + return 1; +#ifndef WOLFCERT_HAVE_RSA + REQUIRE(wc_ecc_get_oid(ECC_SECP256R1_OID, &curve, &curve_sz) > 0); +#endif + REQUIRE(wc_CreatePKCS8Key(NULL, &p8_len, key.data, (word32)key.len, algo, + curve, curve_sz) == LENGTH_ONLY_E); + p8.data = (uint8_t*)malloc(p8_len); + REQUIRE(p8.data != NULL); + rc = wc_CreatePKCS8Key(p8.data, &p8_len, key.data, (word32)key.len, algo, + curve, curve_sz); + REQUIRE(rc > 0); + p8.len = (size_t)rc; + REQUIRE(p8.len != key.len || memcmp(p8.data, key.data, key.len) != 0); + + ca_cfg(&cfg, &cert, &p8); + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &out_cert, + &out_key); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(out_key.len == key.len && + memcmp(out_key.data, key.data, key.len) == 0); + wolfcert_buffer_free(&out_cert); + wolfcert_buffer_free_secure(&out_key); + rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_PEM, &out_cert, + &out_key); + wolfcert_server_free(srv); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(out_key.len > strlen(label) && + memcmp(out_key.data, label, strlen(label)) == 0); + + wolfcert_buffer_free(&out_cert); + wolfcert_buffer_free_secure(&out_key); + free(p8.data); wolfcert_buffer_free(&cert); - wolfcert_buffer_free(&key); - wolfcert_store_memory_close(src); - wolfcert_store_memory_close(mixed); + wolfcert_buffer_free_secure(&key); return 0; } +#endif #ifdef WOLFCERT_HAVE_ECC /* A self-signed non-CA certificate and its key. */ @@ -893,28 +848,16 @@ static int make_leaf_pair(WolfCertBuffer* cert_out, WolfCertBuffer* key_out) static int test_leaf_ca_rejected(void) { - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); WolfCertBuffer cert = { 0 }; WolfCertBuffer key = { 0 }; - WolfCertServerCfgSrv cfg; - WolfCertServer* srv = NULL; - REQUIRE(store != NULL); if (make_leaf_pair(&cert, &key)) return 1; - - REQUIRE(store->write(store->ctx, "ca.cert.der", cert.data, cert.len, 0) - == WOLFCERT_OK); - REQUIRE(store->write(store->ctx, "ca.key.der", key.data, key.len, 1) - == WOLFCERT_OK); - - ca_store_cfg(&cfg, store); - REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_PARSE); - REQUIRE(srv == NULL); + if (start_gets(&cert, &key, WOLFCERT_ERR_PARSE)) + return 1; wolfcert_buffer_free(&cert); - wolfcert_buffer_free(&key); - wolfcert_store_memory_close(store); + wolfcert_buffer_free_secure(&key); return 0; } #endif /* WOLFCERT_HAVE_ECC */ @@ -926,26 +869,17 @@ static int test_bad_bind_host_rejected(void) }; WolfCertServerCfgSrv cfg; WolfCertServer* srv = NULL; - WolfCertBuffer left = { 0 }; size_t i; for (i = 0; i < sizeof(hosts) / sizeof(hosts[0]); i++) { - WolfCertStoreOps* mem = wolfcert_store_memory_open(NULL); - REQUIRE(mem != NULL); - - ca_store_cfg(&cfg, mem); + ca_cfg(&cfg, NULL, NULL); cfg.bind_host = hosts[i]; REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_BAD_ARG); REQUIRE(srv == NULL); - REQUIRE(mem->read(mem->ctx, "ca.cert.der", &left) == - WOLFCERT_ERR_NOT_FOUND); - REQUIRE(mem->read(mem->ctx, "ca.key.der", &left) == - WOLFCERT_ERR_NOT_FOUND); - wolfcert_store_memory_close(mem); } /* NULL binds every interface and must still start. */ - ca_store_cfg(&cfg, NULL); + ca_cfg(&cfg, NULL, NULL); cfg.bind_host = NULL; REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); REQUIRE(wolfcert_server_port(srv) != 0); @@ -959,26 +893,18 @@ int main(void) REQUIRE(test_static_mem_init() == 0); REQUIRE(wolfcert_init(test_heap_hint()) == WOLFCERT_OK); -#if CA_STORE_NEEDS_TLS +#if CA_TEST_NEEDS_TLS REQUIRE(gen_server_identity(&srv_cert_pem, &srv_cert_pem_len, &srv_key_pem, &srv_key_pem_len) == 0); #endif if (test_corrupt_ca_rejected()) return 1; - if (test_load_io_error_rejected()) - return 1; - if (test_save_failure_rejected()) - return 1; - if (test_save_rollback()) - return 1; - if (test_rollback_unavailable()) - return 1; - if (test_mixed_read_failure()) + if (test_half_ca_rejected()) return 1; - if (test_partial_store_rejected()) + if (test_ca_round_trip()) return 1; - if (test_ca_persists_across_starts()) + if (test_get_ca_args()) return 1; #if defined(USE_WOLFSSL_MEMORY) && !defined(WOLFSSL_STATIC_MEMORY) && \ !defined(WOLFSSL_DEBUG_MEMORY) @@ -987,10 +913,23 @@ int main(void) #endif if (test_every_alg_reloads()) return 1; +#ifdef WOLFCERT_HAVE_ECC + if (test_ecc_key_without_public_point()) + return 1; +#endif +#ifdef WOLFCERT_HAVE_SCEP + if (test_split_ra_get_ca_is_ca()) + return 1; +#endif if (test_mismatched_ca_rejected()) return 1; if (test_corrupt_ca_cert_rejected()) return 1; +#if !defined(NO_PKCS8) && \ + (defined(WOLFCERT_HAVE_RSA) || defined(WOLFCERT_HAVE_ECC)) + if (test_pkcs8_ca_key_normalized()) + return 1; +#endif if (test_issued_san_verbatim()) return 1; #ifdef WOLFCERT_HAVE_ECC @@ -1002,7 +941,7 @@ int main(void) if (test_bad_bind_host_rejected()) return 1; -#if CA_STORE_NEEDS_TLS +#if CA_TEST_NEEDS_TLS free(srv_cert_pem); free(srv_key_pem); #endif diff --git a/tests/unit/test_store.c b/tests/unit/test_store.c deleted file mode 100644 index 2b513a7..0000000 --- a/tests/unit/test_store.c +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Copyright (C) 2026 wolfSSL Inc. - * - * This file is part of wolfCert. - * - * wolfCert is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * wolfCert is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with wolfCert. If not, see . - */ - -#define _POSIX_C_SOURCE 200809L -#define _DEFAULT_SOURCE -#define _DARWIN_C_SOURCE /* expose memmem/strcasestr/INADDR_LOOPBACK on macOS */ - -#include -#include "../test_static_mem.h" - -#include "../integration/tls_test_util.h" - -#include -#include -#include -#include -#include - -#define REQUIRE(cond) \ - do { \ - if (!(cond)) { \ - fprintf(stderr, "FAIL %s:%d %s\n", __FILE__, __LINE__, #cond); \ - return 1; \ - } \ - } while (0) - -#ifdef WOLFCERT_HAVE_POSIX_STORE -static int test_posix(void) -{ - char dir[] = "/tmp/wolfcert_store_XXXXXX"; - REQUIRE(mkdtemp(dir) != NULL); - - WolfCertStoreOps* store = wolfcert_store_posix_open(dir, NULL); - REQUIRE(store != NULL); - - WolfCertKeyCfg cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; - WolfCertKey* k = NULL; - REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_OK); - REQUIRE(wolfcert_store_write_key(store, "device.key.pem", k) == WOLFCERT_OK); - - struct stat st; - char p[512]; - snprintf(p, sizeof(p), "%s/device.key.pem", dir); - REQUIRE(stat(p, &st) == 0); - REQUIRE((st.st_mode & 0777) == 0600); - - WolfCertKey* k2 = NULL; - REQUIRE(wolfcert_store_read_key(store, "device.key.pem", &k2) == WOLFCERT_OK); - REQUIRE(k2 != NULL); - - const uint8_t fake_cert[] = "-----BEGIN CERTIFICATE-----\nMIIB\n-----END CERTIFICATE-----\n"; - REQUIRE(wolfcert_store_write_cert(store, "device.crt", fake_cert, sizeof(fake_cert)-1) == WOLFCERT_OK); - WolfCertBuffer rb = { 0 }; - REQUIRE(wolfcert_store_read_cert(store, "device.crt", &rb) == WOLFCERT_OK); - REQUIRE(rb.len == sizeof(fake_cert)-1); - REQUIRE(memcmp(rb.data, fake_cert, rb.len) == 0); - - wolfcert_buffer_free(&rb); - wolfcert_key_free(k); - wolfcert_key_free(k2); - wolfcert_store_posix_close(store); - - char p2[512]; - snprintf(p2, sizeof(p2), "%s/device.crt", dir); - unlink(p); - unlink(p2); - rmdir(dir); - return 0; -} - -#endif /* WOLFCERT_HAVE_POSIX_STORE */ - -static int test_memory(void) -{ - WolfCertStoreOps* store = wolfcert_store_memory_open(NULL); - REQUIRE(store != NULL); - - const uint8_t d[] = "hello"; - REQUIRE(wolfcert_store_write_cert(store, "x", d, sizeof(d)-1) == WOLFCERT_OK); - WolfCertBuffer r = { 0 }; - REQUIRE(wolfcert_store_read_cert(store, "x", &r) == WOLFCERT_OK); - REQUIRE(r.len == sizeof(d)-1 && memcmp(r.data, d, r.len) == 0); - wolfcert_buffer_free(&r); - - REQUIRE(store->remove(store->ctx, "x") == WOLFCERT_OK); - REQUIRE(wolfcert_store_read_cert(store, "x", &r) == WOLFCERT_ERR_NOT_FOUND); - - wolfcert_store_memory_close(store); - return 0; -} - -int main(void) -{ - REQUIRE(test_static_mem_init() == 0); - REQUIRE(wolfcert_init(test_heap_hint()) == WOLFCERT_OK); -#ifdef WOLFCERT_HAVE_POSIX_STORE - if (test_posix()) - return 1; -#endif - if (test_memory()) - return 1; - wolfcert_cleanup(); - printf("OK\n"); - return 0; -} diff --git a/wolfcert/check_config.h b/wolfcert/check_config.h index b4699b7..71e9ebe 100644 --- a/wolfcert/check_config.h +++ b/wolfcert/check_config.h @@ -56,9 +56,6 @@ !defined(WOLFCERT_NO_BUILTIN_TRANSPORT) #error "Define WOLFCERT_HAVE_BUILTIN_TRANSPORT for the built-in POSIX socket transport, or WOLFCERT_NO_BUILTIN_TRANSPORT to confirm every config supplies its own WolfCertTransport." #endif -#if !defined(WOLFCERT_HAVE_POSIX_STORE) && !defined(WOLFCERT_NO_POSIX_STORE) -#error "Define WOLFCERT_HAVE_POSIX_STORE for the POSIX file store, or WOLFCERT_NO_POSIX_STORE to confirm you supply your own WolfCertStoreOps." -#endif /* Required wolfSSL feature set */ diff --git a/wolfcert/options.h.in b/wolfcert/options.h.in index fc3c51a..145990f 100644 --- a/wolfcert/options.h.in +++ b/wolfcert/options.h.in @@ -28,7 +28,6 @@ @WOLFCERT_OPT_SERVER@ /* Platform */ -@WOLFCERT_OPT_POSIX_STORE@ @WOLFCERT_OPT_BUILTIN_TRANSPORT@ /* Key algorithms */ diff --git a/wolfcert/server.h b/wolfcert/server.h index 9df2d6b..1063ce9 100644 --- a/wolfcert/server.h +++ b/wolfcert/server.h @@ -21,7 +21,6 @@ #define WOLFCERT_SERVER_H #include -#include #ifdef __cplusplus extern "C" { @@ -37,14 +36,12 @@ typedef struct { const char* bind_host; /* numeric IPv4, NULL = all * interfaces */ uint16_t bind_port; - WolfCertStoreOps* ca_store; /* optional CA persistence; NULL = - new CA on each start. A store - error fails the start. */ const char* challenge_password; /* SCEP challengePassword to accept; NULL disables */ const char* http_basic_user; /* EST HTTP Basic credentials to accept; NULL disables */ const char* http_basic_pass; /* must be non-empty when http_basic_user is set */ - /* CA configuration. NULL/zero values fall back to library defaults. */ + /* Key for each CA the server generates, including for GetNextCACert. + * NULL/zero values fall back to library defaults. */ WolfCertKeyType ca_key_type; /* WOLFCERT_KEY_RSA default */ int ca_key_param; /* 2048 default for RSA, 256 for ECC */ @@ -104,9 +101,16 @@ typedef struct { /* Lets EST start with neither Basic nor tls_client_ca_pem. */ int est_allow_anonymous_enroll; - /* SCEP split CA/RA: the CA issues a new RA certificate at every start and - * ca_store does not keep it; the RA decrypts and signs SCEP messages. */ + /* SCEP split CA/RA: the CA issues a new RA certificate at every start to + * decrypt and sign SCEP messages. */ int scep_split_ra; + + /* CA to issue from: one certificate and its key, PEM or DER, copied at + * start. Both NULL generates a CA; one alone is WOLFCERT_ERR_BAD_ARG. */ + const uint8_t* ca_cert; + size_t ca_cert_len; + const uint8_t* ca_key; + size_t ca_key_len; } WolfCertServerCfgSrv; WOLFCERT_API int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out); @@ -119,6 +123,13 @@ WOLFCERT_API void wolfcert_server_free(WolfCertServer* srv); /* Returns the port the server is bound to. Useful after binding on port 0. */ WOLFCERT_API uint16_t wolfcert_server_port(const WolfCertServer* srv); +/* Copies out the CA the server issues from, e.g. to keep a generated one. + * out_key may be NULL; free the key with wolfcert_buffer_free_secure(). */ +WOLFCERT_API int wolfcert_server_get_ca(const WolfCertServer* srv, + WolfCertEncoding enc, + WolfCertBuffer* out_cert, + WolfCertBuffer* out_key); + /* Service exactly one request on an already-accepted connection; the caller * closes fd. WOLFCERT_SERVER_REQUEST_TIMEOUT_MS does not apply. The fd carries * no TLS, so EST enrollment on it needs http_basic_user or diff --git a/wolfcert/store.h b/wolfcert/store.h deleted file mode 100644 index d4e3184..0000000 --- a/wolfcert/store.h +++ /dev/null @@ -1,81 +0,0 @@ -/* - * Copyright (C) 2026 wolfSSL Inc. - * - * This file is part of wolfCert. - * - * wolfCert is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * wolfCert is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with wolfCert. If not, see . - */ - -#ifndef WOLFCERT_STORE_H -#define WOLFCERT_STORE_H - -#include -#include - -#ifdef __cplusplus -extern "C" { -#endif - -/* Pluggable storage backend: a vtable plus an opaque context, with slots - * addressed by caller-defined string keys (e.g. "device.crt", "slot/3"). */ - -typedef struct { - /* Read key into a newly allocated buffer; WOLFCERT_ERR_NOT_FOUND if - * absent. */ - int (*read) (void* ctx, const char* key, WolfCertBuffer* out); - /* Write or replace key atomically; sensitive marks a secret value that - * needs tight access modes. */ - int (*write)(void* ctx, const char* key, - const uint8_t* data, size_t len, int sensitive); - /* Remove `key` if present; not-an-error if already absent. */ - int (*remove)(void* ctx, const char* key); - /* Heap hint forwarded into wolfcert allocations done by the backend. */ - void* heap; - /* Backend-private state. */ - void* ctx; -} WolfCertStoreOps; - -/* POSIX-file backend under an existing root_dir; a '/' in a key names a - * subdirectory, which must already exist. Returns NULL on failure or in a - * build without WOLFCERT_HAVE_POSIX_STORE. */ -WOLFCERT_API WolfCertStoreOps* wolfcert_store_posix_open(const char* root_dir, - void* heap); -WOLFCERT_API void wolfcert_store_posix_close(WolfCertStoreOps* ops); - -/* In-memory backend, for tests or an application that persists the output - * itself. */ -WOLFCERT_API WolfCertStoreOps* wolfcert_store_memory_open(void* heap); -WOLFCERT_API void wolfcert_store_memory_close(WolfCertStoreOps* ops); - -/* Cert and key helpers over a store. */ - -WOLFCERT_API int wolfcert_store_write_cert(WolfCertStoreOps* store, - const char* key, - const uint8_t* cert, size_t len); -WOLFCERT_API int wolfcert_store_read_cert(WolfCertStoreOps* store, - const char* key, - WolfCertBuffer* out); - -WOLFCERT_API int wolfcert_store_write_key(WolfCertStoreOps* store, - const char* key_name, - const WolfCertKey* key); -WOLFCERT_API int wolfcert_store_read_key(WolfCertStoreOps* store, - const char* key_name, - WolfCertKey** out_key); - -#ifdef __cplusplus -} -#endif - -#endif /* WOLFCERT_STORE_H */ diff --git a/wolfcert/wolfcert.h b/wolfcert/wolfcert.h index 42be200..b8e15c7 100644 --- a/wolfcert/wolfcert.h +++ b/wolfcert/wolfcert.h @@ -34,7 +34,6 @@ #include #include #include -#include #include #ifdef WOLFCERT_HAVE_EST # include diff --git a/zephyr/CMakeLists.txt b/zephyr/CMakeLists.txt index e8d914e..c9c6148 100644 --- a/zephyr/CMakeLists.txt +++ b/zephyr/CMakeLists.txt @@ -26,8 +26,6 @@ if(CONFIG_WOLFCERT) _wc_opt(WOLFCERT_OPT_SCEP "${CONFIG_WOLFCERT_SCEP}" WOLFCERT_HAVE_SCEP) # Host-only; zephyr/README.md says why. _wc_opt(WOLFCERT_OPT_SERVER "OFF" WOLFCERT_HAVE_SERVER) - _wc_plat(WOLFCERT_OPT_POSIX_STORE "OFF" - WOLFCERT_HAVE_POSIX_STORE WOLFCERT_NO_POSIX_STORE) _wc_plat(WOLFCERT_OPT_BUILTIN_TRANSPORT "${CONFIG_WOLFCERT_BUILTIN_TRANSPORT}" WOLFCERT_HAVE_BUILTIN_TRANSPORT WOLFCERT_NO_BUILTIN_TRANSPORT) _wc_opt(WOLFCERT_OPT_RSA "${CONFIG_WOLFCERT_RSA}" WOLFCERT_HAVE_RSA) @@ -55,7 +53,6 @@ if(CONFIG_WOLFCERT) ${WOLFCERT_DIR}/src/key_algs.c ${WOLFCERT_DIR}/src/keygen.c ${WOLFCERT_DIR}/src/csr.c - ${WOLFCERT_DIR}/src/store.c ${WOLFCERT_DIR}/src/http.c ${WOLFCERT_DIR}/src/client.c) diff --git a/zephyr/README.md b/zephyr/README.md index 1b58ad1..894fe55 100644 --- a/zephyr/README.md +++ b/zephyr/README.md @@ -227,8 +227,7 @@ needs changing. `prj.conf` leaves these to the board: clock — [`docs/EMBEDDED.md` section 8](../docs/EMBEDDED.md#8-zephyr) explains why. - **Keeping the key and certificate.** They are freed here. A real device - writes them through a `WolfCertStoreOps` — on Zephyr, one over NVS or the - settings subsystem. + writes them to NVS or the settings subsystem. ## Running the tests diff --git a/zephyr/include.am b/zephyr/include.am index bce8f8e..34d4a39 100644 --- a/zephyr/include.am +++ b/zephyr/include.am @@ -42,7 +42,4 @@ EXTRA_DIST += zephyr/tests/wolfcert_unit_scep_msg/testcase.yaml EXTRA_DIST += zephyr/tests/wolfcert_unit_smoke/CMakeLists.txt EXTRA_DIST += zephyr/tests/wolfcert_unit_smoke/prj.conf EXTRA_DIST += zephyr/tests/wolfcert_unit_smoke/testcase.yaml -EXTRA_DIST += zephyr/tests/wolfcert_unit_store/CMakeLists.txt -EXTRA_DIST += zephyr/tests/wolfcert_unit_store/prj.conf -EXTRA_DIST += zephyr/tests/wolfcert_unit_store/testcase.yaml EXTRA_DIST += zephyr/wolfssl_user_settings.h diff --git a/zephyr/tests/wolfcert_unit_store/CMakeLists.txt b/zephyr/tests/wolfcert_unit_store/CMakeLists.txt deleted file mode 100644 index c08f0e1..0000000 --- a/zephyr/tests/wolfcert_unit_store/CMakeLists.txt +++ /dev/null @@ -1,12 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later -cmake_minimum_required(VERSION 3.20.0) - -set(CONF_FILE - ${CMAKE_CURRENT_LIST_DIR}/../common/wolfcert.conf - ${CMAKE_CURRENT_LIST_DIR}/prj.conf) - -find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE}) -project(wolfcert_unit_store) - -include(${ZEPHYR_WOLFCERT_MODULE_DIR}/zephyr/tests/common/unit_test.cmake) -wolfcert_zephyr_unit_test(test_store) diff --git a/zephyr/tests/wolfcert_unit_store/prj.conf b/zephyr/tests/wolfcert_unit_store/prj.conf deleted file mode 100644 index b7e9b38..0000000 --- a/zephyr/tests/wolfcert_unit_store/prj.conf +++ /dev/null @@ -1,4 +0,0 @@ -CONFIG_WOLFCERT_EST=y -CONFIG_WOLFCERT_RSA=y -CONFIG_WOLFCERT_ECC=y -CONFIG_WOLFCERT_ED25519=y diff --git a/zephyr/tests/wolfcert_unit_store/testcase.yaml b/zephyr/tests/wolfcert_unit_store/testcase.yaml deleted file mode 100644 index 5be1f10..0000000 --- a/zephyr/tests/wolfcert_unit_store/testcase.yaml +++ /dev/null @@ -1,14 +0,0 @@ -common: - tags: - - wolfcert - harness: console - harness_config: - type: one_line - regex: - - "WOLFCERT TEST RESULT: 0" -tests: - wolfcert.unit.store: - timeout: 180 - platform_allow: qemu_x86 - integration_platforms: - - qemu_x86 From f7f82d63f32824345aaa2d5adec89f0a55759786 Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sat, 17 Oct 2026 17:33:20 +0000 Subject: [PATCH 03/17] Let cli_proto_scoping run alongside another copy of itself The script started its test servers on fixed ports (18086 to 18099) and moved 100 up when one was busy. Its readiness probe could reach another run's server on that port before its own server had failed to bind, so two build directories testing at once enrolled against each other's CAs and failed a dozen cases. wolfcert-server now accepts --listen ADDR:0 and prints the port the kernel picked, which the library already reports through wolfcert_server_port(). The script binds port 0 everywhere and reads the port from that line, so the retry loops go away. parse_listen also stops taking a port with trailing characters, such as 80x, as 80. Eight copies running concurrently pass all 86 cases, three rounds in a row; four copies of the old script fail 8 to 16 cases each. --- cli/wolfcert_server.c | 8 +- tests/integration/cli_proto_scoping.sh | 134 +++++++++++-------------- 2 files changed, 64 insertions(+), 78 deletions(-) diff --git a/cli/wolfcert_server.c b/cli/wolfcert_server.c index af68c09..e994ff2 100644 --- a/cli/wolfcert_server.c +++ b/cli/wolfcert_server.c @@ -83,7 +83,8 @@ static void print_usage(FILE* out) "\n" "Options:\n" " --proto est|scep Protocol to serve (required)\n" - " --listen ADDR:PORT Numeric IPv4 bind address (default 0.0.0.0:8080)\n" + " --listen ADDR:PORT Numeric IPv4 bind address (default 0.0.0.0:8080);\n" + " port 0 picks a free one\n" " --basic USER:PASS Require HTTP Basic auth (EST enroll); both non-empty\n" " --challenge PASS Require this SCEP challengePassword in the CSR\n" " --tls-cert PEMFILE Terminate TLS with this server certificate (PEM);\n" @@ -136,8 +137,9 @@ static int parse_listen(const char* arg, char** host, uint16_t* port) return 0; } - long p = strtol(colon + 1, NULL, 10); - if (p <= 0 || p > 65535) + char* end = NULL; + long p = strtol(colon + 1, &end, 10); + if (end == colon + 1 || *end != '\0' || p < 0 || p > 65535) return -1; *host = strndup(arg, (size_t)(colon - arg)); diff --git a/tests/integration/cli_proto_scoping.sh b/tests/integration/cli_proto_scoping.sh index 0200809..d797c26 100755 --- a/tests/integration/cli_proto_scoping.sh +++ b/tests/integration/cli_proto_scoping.sh @@ -278,7 +278,7 @@ if [ -x "$SERVER" ]; then --proto est --tls-cert "$0" --tls-key "$0" --basic "$b" done # $0 is no PEM, so start fails in TLS setup, before anything binds. - out="$("$SERVER" --proto est --listen 127.0.0.1:18099 --tls-cert "$0" \ + out="$("$SERVER" --proto est --listen 127.0.0.1:0 --tls-cert "$0" \ --tls-key "$0" --est-allow-anonymous 2>&1)" case "$out" in *"start failed"*) @@ -318,33 +318,43 @@ else poll_tries=10 fi - # start_scep_server : a busy port is an - # environment problem, so try four and poll GetCACert into $tmp/-*. + # start_server : start wolfcert-server on a free port + # and set started_pid, and port from its "listening on" line. + start_server() { + local log="$1" i=0 + shift + port="" + # The child's own truncation can land after the first read below. + : >"$log" + "$SERVER" --listen 127.0.0.1:0 "$@" >"$log" 2>&1 & + started_pid=$! + while [ "$i" -lt "$poll_tries" ] && + kill -0 "$started_pid" 2>/dev/null; do + port="$(sed -n 's/.* listening on [0-9.]*:\([0-9]*\)$/\1/p' "$log")" + [ -n "$port" ] && return 0 + sleep "$poll_delay" + i=$((i + 1)) + done + return 1 + } + + # start_scep_server : GetCACert into $tmp/-*. start_scep_server() { - local name="$1" port="$2" n i - shift 2 + local name="$1" + shift ready=0 - for n in 0 1 2 3; do - "$SERVER" --proto scep --listen "127.0.0.1:$port" "$@" \ - >"$tmp/$name-server.log" 2>&1 & - started_pid=$! + url="" + if start_server "$tmp/$name-server.log" --proto scep "$@"; then url="http://127.0.0.1:$port/scep" - i=0 - while [ "$i" -lt "$poll_tries" ] && - kill -0 "$started_pid" 2>/dev/null; do - if "$CLI" getcacerts --proto scep --url "$url" \ - --out-cert "$tmp/$name-ca.pem" \ - >"$tmp/$name-getca.log" 2>&1; then - ready=1 - return - fi - sleep "$poll_delay" - i=$((i + 1)) - done - kill "$started_pid" 2>/dev/null - wait "$started_pid" 2>/dev/null - port=$((port + 100)) - done + if "$CLI" getcacerts --proto scep --url "$url" \ + --out-cert "$tmp/$name-ca.pem" \ + >"$tmp/$name-getca.log" 2>&1; then + ready=1 + return + fi + fi + kill "$started_pid" 2>/dev/null + wait "$started_pid" 2>/dev/null } # cert_fp : the pin getcacerts printed for that certificate. @@ -352,7 +362,7 @@ else sed -n "s/.*certificate $2 is \(sha256:[0-9A-Fa-f:]*\).*/\1/p" "$1" } - start_scep_server pin 18088 --scep-enable-next-ca + start_scep_server pin --scep-enable-next-ca srv_pid=$started_pid PIN_URL="$url" @@ -451,33 +461,20 @@ else --subject "CN=localhost" --san-ip 127.0.0.1 \ --ca-fingerprint "$fp" --out-key "$tmp/tls.key" \ --out-cert "$tmp/tls.crt" >"$tmp/tls-enroll.log" 2>&1; then - port=18092 - for n in 0 1 2 3; do - "$SERVER" --proto est --listen "127.0.0.1:$port" \ - --tls-cert "$tmp/tls.crt" --tls-key "$tmp/tls.key" \ - --tls-client-ca "$tmp/pin-ca.pem" \ - >"$tmp/est-server.log" 2>&1 & - est_pid=$! - est_url="https://127.0.0.1:$port/.well-known/est" - i=0 - while [ "$i" -lt "$poll_tries" ] && - kill -0 "$est_pid" 2>/dev/null; do - if "$CLI" getcacerts --proto est --url "$est_url" \ - --trust "$tmp/pin-ca.pem" \ - --client-cert "$tmp/ok.crt" \ - --client-key "$tmp/ok.key" \ - --out-cert "$tmp/est-ca.pem" \ - >"$tmp/est-getca.log" 2>&1; then - est_ready=1 - break 2 - fi - sleep "$poll_delay" - i=$((i + 1)) - done - kill "$est_pid" 2>/dev/null - wait "$est_pid" 2>/dev/null - port=$((port + 100)) - done + start_server "$tmp/est-server.log" --proto est \ + --tls-cert "$tmp/tls.crt" --tls-key "$tmp/tls.key" \ + --tls-client-ca "$tmp/pin-ca.pem" + est_pid=$started_pid + est_url="https://127.0.0.1:$port/.well-known/est" + if [ -n "$port" ] && + "$CLI" getcacerts --proto est --url "$est_url" \ + --trust "$tmp/pin-ca.pem" \ + --client-cert "$tmp/ok.crt" \ + --client-key "$tmp/ok.key" \ + --out-cert "$tmp/est-ca.pem" \ + >"$tmp/est-getca.log" 2>&1; then + est_ready=1 + fi fi if [ "$est_ready" -ne 1 ]; then skip_group "EST reenroll --cert forms (no mTLS server would start)" @@ -521,7 +518,7 @@ else # Against a split CA/RA server that defers issuance, the RA counts only once # --ra-fingerprint names it; pinning the RA alone ignores the CA. poll="--poll-attempts 5 --poll-interval-ms 100" - start_scep_server ra 18087 --scep-split-ra --scep-require-approval \ + start_scep_server ra --scep-split-ra --scep-require-approval \ --scep-enable-next-ca --scep-enable-get-cert ra_pid=$started_pid RA_URL="$url" @@ -666,7 +663,7 @@ else case "$layout" in ras|tie|expired) split="--scep-split-ra" ;; esac - start_scep_server bundle 18091 $split --scep-ca-bundle "$layout" + start_scep_server bundle $split --scep-ca-bundle "$layout" bundle_pid=$started_pid BUNDLE_URL="$url" @@ -799,7 +796,7 @@ else # A non-200 GetCACaps warns and carries on; a dropped one stops enroll and # getcert with exit 2. AES is forced; NO_DES3 builds lack the 3DES default. for caps in 404 close; do - start_scep_server caps 18086 --scep-enable-get-cert \ + start_scep_server caps --scep-enable-get-cert \ --scep-caps-status "$caps" caps_pid=$started_pid CAPS_URL="$url" @@ -920,7 +917,7 @@ else done # A hostname --listen is refused, and the reason reaches stderr. - "$SERVER" --proto scep --listen localhost:18090 >"$tmp/listen.log" 2>&1 & + "$SERVER" --proto scep --listen localhost:0 >"$tmp/listen.log" 2>&1 & listen_pid=$! i=0 while [ "$i" -lt "$poll_tries" ] && kill -0 "$listen_pid" 2>/dev/null; do @@ -941,25 +938,12 @@ else # Secrets passed on the server command line must not stay visible to ps. listening=0 - for port in 18089 18189 18289 18389; do - "$SERVER" --proto scep --listen "127.0.0.1:$port" \ + if start_server "$tmp/argv.log" --proto scep \ --basic argvuser:argv-basic-secret \ - --challenge argv-challenge-secret >"$tmp/argv.log" 2>&1 & - argv_pid=$! - i=0 - while [ "$i" -lt "$poll_tries" ] && kill -0 "$argv_pid" 2>/dev/null; do - if grep -q "listening" "$tmp/argv.log"; then - listening=1 - break - fi - sleep "$poll_delay" - i=$((i + 1)) - done - if [ "$listening" -eq 1 ]; then - break - fi - kill "$argv_pid" 2>/dev/null - done + --challenge argv-challenge-secret; then + listening=1 + fi + argv_pid=$started_pid if [ "$listening" -ne 1 ]; then skip_group "server argv scrubbing (no test server would start)" From b3bb1a01f023c8125ff378dd0cfa75825733bc2e Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sat, 17 Oct 2026 12:11:27 +0000 Subject: [PATCH 04/17] Build without wolfSSL's CryptoCb wolfCert never registers a CryptoCb or calls one directly; it only passes the application's devId to wolfCrypt, which ignores it when wolfSSL lacks WOLF_CRYPTO_CB. Requiring the callback layer made every user pay for it, including software-only builds on small targets. Drop WOLF_CRYPTO_CB from check_config.h and from the CMake and autoconf feature probes. Without it wolfCert builds and every key runs in software. CMake probes the symbol separately to skip the CryptoCb example, which now fails with a clear #error if built anyway. CI gains a no-cryptocb wolfSSL profile and a -Werror job that builds against it with the examples on, in the PR matrix and in the nightly one that seeds the PR cache and tracks wolfSSL master. The canonical full -Werror job turns the examples on as well, so enroll_cryptocb.c compiles in CI. --- .github/workflows/nightly.yml | 1 + .github/workflows/pr.yml | 7 ++++++- AGENTS.md | 4 +++- CMakeLists.txt | 13 ++++++++++--- configure.ac | 9 ++++----- docs/ARCHITECTURE.md | 5 +++-- docs/CI.md | 4 ++-- docs/EMBEDDED.md | 7 ++++--- examples/CMakeLists.txt | 6 ++++-- examples/enroll_cryptocb.c | 3 +++ scripts/ci/build-wolfssl.sh | 6 +++++- wolfcert/check_config.h | 3 --- 12 files changed, 45 insertions(+), 23 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index d6d462c..105f672 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -44,6 +44,7 @@ jobs: - { name: cmake-mldsa-44off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-44off } - { name: cmake-mldsa-65off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-65off } - { name: cmake-mldsa-87off, os: ubuntu-latest, build: cmake, wolfssl: mldsa-87off } + - { name: cmake-no-cryptocb, os: ubuntu-latest, build: cmake, wolfssl: no-cryptocb, cmake_extra: "-DWOLFCERT_WERROR=ON -DWOLFCERT_ENABLE_EXAMPLES=ON" } # Platform pieces compiled out (transport gate) - { name: cmake-no-builtin-transport, os: ubuntu-latest, build: cmake, wolfssl: full, cmake_extra: "-DWOLFCERT_ENABLE_BUILTIN_TRANSPORT=OFF -DWOLFCERT_ENABLE_CLI=OFF -DWOLFCERT_ENABLE_SERVER=OFF" } # Constrained builds (unit tests only: single-thread / no-malloc) diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 0113197..fdf8960 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -34,7 +34,7 @@ jobs: os: ubuntu-latest build: cmake wolfssl: full - cmake_extra: -DWOLFCERT_WERROR=ON + cmake_extra: -DWOLFCERT_WERROR=ON -DWOLFCERT_ENABLE_EXAMPLES=ON - name: cmake-full-opensslextra os: ubuntu-latest build: cmake @@ -94,6 +94,11 @@ jobs: os: ubuntu-latest build: cmake wolfssl: rsa-min + - name: cmake-no-cryptocb + os: ubuntu-latest + build: cmake + wolfssl: no-cryptocb + cmake_extra: -DWOLFCERT_WERROR=ON -DWOLFCERT_ENABLE_EXAMPLES=ON - name: cmake-no-des3 os: ubuntu-latest build: cmake diff --git a/AGENTS.md b/AGENTS.md index 5b12f6d..6113650 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,7 +28,7 @@ file. Changes to wolfCert itself follow `CONTRIBUTING.md`. Most integration failures are a wolfSSL built without what wolfCert needs. wolfCert requires **wolfSSL >= 5.9.4** and **hard-fails at configure time** if the wolfSSL it finds lacks any of `HAVE_PKCS7`, `WOLFSSL_CERT_GEN`, -`WOLFSSL_CERT_REQ`, `WOLFSSL_CERT_EXT`, `WOLFSSL_KEY_GEN`, `WOLF_CRYPTO_CB`, +`WOLFSSL_CERT_REQ`, `WOLFSSL_CERT_EXT`, `WOLFSSL_KEY_GEN`, `WOLFSSL_BASE64_ENCODE`, `WOLFSSL_ALT_NAMES` or `WOLFSSL_CERT_NAME_ALL`, was built with `NO_AES` / `NO_SHA256`, or provides neither TLS 1.2 nor TLS 1.3. @@ -41,6 +41,8 @@ built with `NO_AES` / `NO_SHA256`, or provides neither TLS 1.2 nor TLS 1.3. `OPENSSL_EXTRA`, `OPENSSL_EXTRA_X509_SMALL` or `WOLFSSL_TEST_CERT`. A static libwolfssl links them regardless. The OpenSSL compatibility layer itself is not required. +- **Hardware keys** need `WOLF_CRYPTO_CB` (`--enable-cryptocb`). Without it + wolfCert builds, but keys always run in software. - **ML-DSA** additionally needs `WOLFSSL_MLDSA_CHECK_KEY`, which `--enable-mldsa` gives by default; it is lost with `WOLFSSL_DILITHIUM_NO_CHECK_KEY` or `WOLFSSL_MLDSA_VERIFY_ONLY`. diff --git a/CMakeLists.txt b/CMakeLists.txt index ebe9a56..1444a0d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -84,7 +84,7 @@ if(NOT wolfssl_FOUND) "wolfSSL >= 5.9.4 not found via CMake config or pkg-config. " "wolfCert requires wolfSSL 5.9.4 or newer, built with: HAVE_PKCS7, " "WOLFSSL_CERT_GEN, WOLFSSL_CERT_REQ, WOLFSSL_CERT_EXT, " - "WOLFSSL_KEY_GEN, HAVE_ECC, WOLF_CRYPTO_CB, WOLFSSL_BASE64_ENCODE, " + "WOLFSSL_KEY_GEN, HAVE_ECC, WOLFSSL_BASE64_ENCODE, " "WOLFSSL_ALT_NAMES, WOLFSSL_CERT_NAME_ALL; a shared wolfSSL also " "needs WOLFSSL_PUBLIC_ASN.") endif() @@ -119,7 +119,7 @@ if(NOT _have_wolfssl_floor) message(FATAL_ERROR "wolfCert requires wolfSSL 5.9.4 or newer.") endif() foreach(sym IN ITEMS HAVE_PKCS7 WOLFSSL_CERT_GEN WOLFSSL_CERT_REQ WOLFSSL_CERT_EXT - WOLFSSL_KEY_GEN WOLF_CRYPTO_CB WOLFSSL_BASE64_ENCODE + WOLFSSL_KEY_GEN WOLFSSL_BASE64_ENCODE WOLFSSL_ALT_NAMES WOLFSSL_CERT_NAME_ALL) unset(_have_${sym} CACHE) check_c_source_compiles("${_wc_wolfssl_prologue} @@ -133,11 +133,18 @@ foreach(sym IN ITEMS HAVE_PKCS7 WOLFSSL_CERT_GEN WOLFSSL_CERT_REQ WOLFSSL_CERT_E "wolfSSL was built without ${sym}. Rebuild with the appropriate " "wolfSSL configure flag. For all the symbols wolfCert requires: " "./configure --enable-pkcs7 --enable-certgen --enable-certreq " - "--enable-certext --enable-keygen --enable-ecc --enable-cryptocb " + "--enable-certext --enable-keygen --enable-ecc " "--enable-base64encode " "CPPFLAGS=\"-DWOLFSSL_ALT_NAMES -DWOLFSSL_CERT_NAME_ALL\"") endif() endforeach() +unset(_have_WOLF_CRYPTO_CB CACHE) +check_c_source_compiles("${_wc_wolfssl_prologue} + #ifndef WOLF_CRYPTO_CB + #error missing + #endif + int main(void) { return 0; } +" _have_WOLF_CRYPTO_CB) # Link the WOLFSSL_ASN_API helpers wolfCert calls, without wolfSSL's headers. if(TARGET PkgConfig::WOLFSSL) diff --git a/configure.ac b/configure.ac index 2aa8e6f..6295bcd 100644 --- a/configure.ac +++ b/configure.ac @@ -132,9 +132,8 @@ PKG_CHECK_MODULES([WOLFSSL], [wolfssl >= 5.9.4], [AC_MSG_ERROR([wolfssl >= 5.9.4 not found via pkg-config. wolfCert requires a wolfSSL build with HAVE_PKCS7, WOLFSSL_CERT_GEN, WOLFSSL_CERT_REQ, WOLFSSL_CERT_EXT, WOLFSSL_KEY_GEN, HAVE_ECC, - WOLF_CRYPTO_CB, WOLFSSL_BASE64_ENCODE, WOLFSSL_ALT_NAMES, - WOLFSSL_CERT_NAME_ALL; a shared wolfSSL also needs - WOLFSSL_PUBLIC_ASN.])]) + WOLFSSL_BASE64_ENCODE, WOLFSSL_ALT_NAMES, WOLFSSL_CERT_NAME_ALL; + a shared wolfSSL also needs WOLFSSL_PUBLIC_ASN.])]) AM_CONDITIONAL([HAVE_WOLFSSL], [test "x$have_wolfssl" = "xyes"]) # Probe wolfSSL's feature set the way wolfcert/check_config.h resolves it, so @@ -176,10 +175,10 @@ AC_DEFUN([WOLFCERT_PLAT], save_CPPFLAGS="$CPPFLAGS" CPPFLAGS="$CPPFLAGS $WOLFSSL_CFLAGS" AC_CHECK_DECLS([HAVE_PKCS7, WOLFSSL_CERT_GEN, WOLFSSL_CERT_REQ, WOLFSSL_CERT_EXT, - WOLFSSL_KEY_GEN, WOLF_CRYPTO_CB, WOLFSSL_BASE64_ENCODE, + WOLFSSL_KEY_GEN, WOLFSSL_BASE64_ENCODE, WOLFSSL_ALT_NAMES, WOLFSSL_CERT_NAME_ALL], [], [AC_MSG_ERROR([wolfSSL is missing a required feature (see above). - Rebuild wolfSSL with --enable-pkcs7 --enable-ecc --enable-cryptocb + Rebuild wolfSSL with --enable-pkcs7 --enable-ecc --enable-certgen --enable-certreq --enable-certext --enable-keygen --enable-base64encode CPPFLAGS="-DWOLFSSL_ALT_NAMES -DWOLFSSL_CERT_NAME_ALL".])], diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index f48530c..a5d1531 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -660,8 +660,9 @@ time `#error`s. See [`EMBEDDED.md`](EMBEDDED.md#configuring-wolfcert-without-its **Required wolfSSL features** (build hard-fails with a "rebuild wolfSSL with --enable-X" diagnostic if missing): `HAVE_PKCS7`, `WOLFSSL_CERT_GEN`, -`WOLFSSL_CERT_REQ`, `WOLFSSL_CERT_EXT`, `WOLFSSL_KEY_GEN`, `WOLF_CRYPTO_CB`, -`WOLFSSL_BASE64_ENCODE`, `WOLFSSL_ALT_NAMES`, `WOLFSSL_CERT_NAME_ALL`. A +`WOLFSSL_CERT_REQ`, `WOLFSSL_CERT_EXT`, `WOLFSSL_KEY_GEN`, +`WOLFSSL_BASE64_ENCODE`, `WOLFSSL_ALT_NAMES`, `WOLFSSL_CERT_NAME_ALL`. +`WOLF_CRYPTO_CB` is optional; without it keys run in software. A `NO_RSA` build hard-fails unless SCEP is disabled, and so does one without AES-128-CBC encrypt and decrypt (`NO_AES_128`, `NO_AES_CBC` or `NO_AES_DECRYPT`), which RFC 8894 makes mandatory. CMake and autoconf also diff --git a/docs/CI.md b/docs/CI.md index 4fe270b..68df898 100644 --- a/docs/CI.md +++ b/docs/CI.md @@ -37,8 +37,8 @@ Config names include `full` (all algorithms), `full-tsan`, `full-opensslextra` setups stay covered), `full-all` (`full` plus `--enable-all`, which brings `OPENSSL_ALL` and its compatible defaults), `est-only-nonrsa` (NO_RSA), `rsa-min`, `ecc-only-est`, `no-des3`, `tls13-only`, `mldsa-{44,65,87}off`, -`static-mem`, `no-malloc`, and the `neg-*` configs used by the negative-config -gate. +`static-mem`, `no-malloc`, `no-cryptocb` (no `WOLF_CRYPTO_CB`), and the `neg-*` +configs used by the negative-config gate. ## Reproducing a CI job locally diff --git a/docs/EMBEDDED.md b/docs/EMBEDDED.md index b39bf24..9e8a3ab 100644 --- a/docs/EMBEDDED.md +++ b/docs/EMBEDDED.md @@ -35,9 +35,10 @@ clear `#error` rather than a confusing downstream error. It enforces the same rules the configure step does: at least one key algorithm, SCEP requires RSA and AES-128-CBC (both RFC 8894, so `NO_AES_128`, `NO_AES_CBC` and `NO_AES_DECRYPT` rule SCEP out), and the wolfSSL feature set wolfCert depends -on (PKCS#7, cert gen/req/ext, key gen, CryptoCb, base64 encode, alt names, -`WOLFSSL_CERT_NAME_ALL`, AES, SHA-256, and TLS 1.2 or 1.3). The header you copy -documents the matching wolfSSL configure flags. +on (PKCS#7, cert gen/req/ext, key gen, base64 encode, alt names, +`WOLFSSL_CERT_NAME_ALL`, AES, SHA-256, and TLS 1.2 or 1.3). CryptoCb is +optional and only needed for hardware keys. The header you copy documents the +matching wolfSSL configure flags. A **shared** libwolfssl must also export the ASN helpers wolfCert calls, which takes `WOLFSSL_PUBLIC_ASN` (the lean choice) or the OpenSSL compatibility layer; diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 083244f..892613b 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -4,8 +4,10 @@ if(WOLFCERT_ENABLE_EST) add_executable(example_enroll_est enroll_est.c) target_link_libraries(example_enroll_est PRIVATE wolfcert) - add_executable(example_enroll_cryptocb enroll_cryptocb.c) - target_link_libraries(example_enroll_cryptocb PRIVATE wolfcert) + if(_have_WOLF_CRYPTO_CB) + add_executable(example_enroll_cryptocb enroll_cryptocb.c) + target_link_libraries(example_enroll_cryptocb PRIVATE wolfcert) + endif() endif() if(WOLFCERT_ENABLE_SCEP) diff --git a/examples/enroll_cryptocb.c b/examples/enroll_cryptocb.c index ed92f09..bbc2472 100644 --- a/examples/enroll_cryptocb.c +++ b/examples/enroll_cryptocb.c @@ -33,6 +33,9 @@ #include #include +#ifndef WOLF_CRYPTO_CB +# error "examples/enroll_cryptocb.c needs wolfSSL built with --enable-cryptocb" +#endif #include #include diff --git a/scripts/ci/build-wolfssl.sh b/scripts/ci/build-wolfssl.sh index 1072bd6..d24961c 100755 --- a/scripts/ci/build-wolfssl.sh +++ b/scripts/ci/build-wolfssl.sh @@ -39,7 +39,7 @@ KNOWN_CONFIGS=( est-only-nonrsa rsa-min ecc-only-est no-des3 tls13-only mldsa-44off mldsa-65off mldsa-87off - static-mem no-malloc + static-mem no-malloc no-cryptocb # Negative configs for assert-configure-fails.sh. neg-no-rsa neg-no-pkcs7 neg-no-public-asn neg-no-aes128 ) @@ -119,6 +119,10 @@ resolve_flags() { _base_flags printf '%s\n' --enable-staticmemory \ 'CPPFLAGS=-DWOLFSSL_ALT_NAMES -DWOLFSSL_CERT_NAME_ALL -DKEEP_PEER_CERT -DWOLFSSL_HAVE_TLS_UNIQUE -DWOLFSSL_PUBLIC_ASN -DWOLFSSL_NO_MALLOC -DMAX_SIGNED_ATTRIBS_SZ=9' ;; + no-cryptocb) + # No WOLF_CRYPTO_CB, so no WOLF_PRIVATE_KEY_ID either. + _base_flags + printf '%s\n' --disable-cryptocb ;; # Negative configs: buildable wolfSSL builds that wolfCert rejects neg-no-rsa) diff --git a/wolfcert/check_config.h b/wolfcert/check_config.h index 71e9ebe..91c9724 100644 --- a/wolfcert/check_config.h +++ b/wolfcert/check_config.h @@ -81,9 +81,6 @@ #ifndef WOLFSSL_KEY_GEN #error "wolfSSL is missing WOLFSSL_KEY_GEN; rebuild wolfSSL with --enable-keygen." #endif -#ifndef WOLF_CRYPTO_CB -#error "wolfSSL is missing WOLF_CRYPTO_CB; rebuild wolfSSL with --enable-cryptocb." -#endif #ifndef WOLFSSL_BASE64_ENCODE #error "wolfSSL is missing WOLFSSL_BASE64_ENCODE; rebuild wolfSSL with --enable-base64encode." #endif From 953db69e3f790411bc12c326bcb50e011f2bbfe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Tue, 6 Oct 2026 15:46:57 +0200 Subject: [PATCH 05/17] Name CryptoCb-resident keys by id instead of label WolfCertKeyCfg.key_label was copied into the key handle and never read, so a key generated with a dev_id had no way to name its storage in the backend. Every backend wolfSSL ships (wolfPKCS11, wolfHSM and the hardware ports) identifies a key by the byte id that the wc_*_init_id functions carry, not by a label. key_label is removed and key_id plus key_id_len are appended to WolfCertKeyCfg. This changes the struct layout, which is accepted since the field never worked. A key_id needs a CryptoCb dev_id and is at most WOLFCERT_KEY_ID_MAX_LEN (32) bytes, matching wolfSSL's ECC_MAX_ID_LEN. Key generation passes it to wc_ecc_init_id, wc_InitRsaKey_Id or wc_MlDsaKey_InitId, so the backend generates the key under that id. Ed25519 and Ed448 return WOLFCERT_ERR_UNSUPPORTED for now. Key ids need wolfSSL's WOLF_CRYPTO_CB and WOLF_PRIVATE_KEY_ID, which wolfSSL defines with the former unless NO_WOLF_PRIVATE_KEY_ID is set. Neither is required: without them a key_id returns WOLFCERT_ERR_UNSUPPORTED and the id-based init calls are compiled out, so builds that do not use the feature do not pay for it. When a device declines key generation, wolfCrypt generates the key in software instead and the call still succeeds. A new host_priv entry in the key algorithm table reports whether the private half sits in host memory, and key generation with a key_id fails with WOLFCERT_ERR_UNSUPPORTED in that case rather than return a handle that names a key the backend does not hold. The ELS port, for example, declines every curve but P-256. A key with an id is never exported: wolfcert_key_to_pem and wolfcert_key_to_der fail with WOLFCERT_ERR_UNSUPPORTED instead of serializing a key struct that holds no private scalar. wolfcert_key_from_id rebuilds a handle for a key that already lives in the backend, which re-enrollment after a reboot needs: the CSR carries the public key and is signed by the backend. A backend such as NXP EdgeLock cannot return the public key after generation, so it comes from the issued certificate, PEM or DER, read the same way as the certificate being renewed: the first certificate of a PEM chain, and DER may be followed by padding. The key must have a curve or RSA size key generation makes (P-256, P-384 or P-521; 2048, 3072 or 4096), or the call returns WOLFCERT_ERR_UNSUPPORTED as key generation does, and a non-zero param that names another one is WOLFCERT_ERR_BAD_ARG. A certificate whose key is not of cfg->type is WOLFCERT_ERR_PARSE. wolfcert_key_id returns the id of a key. The key algorithm table gains a pub_decode entry for from_id. test_keygen covers a declined key generation for ECC, RSA and each ML-DSA level, an empty key_id_len, the from_id argument and input checks, an RSA-1024 and a P-224 certificate, and the UNSUPPORTED results in a build without key ids. --- Makefile.am | 1 + examples/enroll_cryptocb.c | 6 +- src/internal.c | 62 ++++++++-- src/internal.h | 23 +++- src/key_algs.c | 123 ++++++++++++++++-- src/key_algs.h | 10 ++ src/keygen.c | 190 +++++++++++++++++++++++++--- tests/CMakeLists.txt | 1 + tests/unit/test_keygen.c | 247 +++++++++++++++++++++++++++++++++++++ wolfcert/keygen.h | 24 +++- wolfcert/types.h | 10 +- 11 files changed, 652 insertions(+), 45 deletions(-) diff --git a/Makefile.am b/Makefile.am index 1562a98..5f59a3f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -113,6 +113,7 @@ endif test_smoke_SOURCES = tests/unit/test_smoke.c test_smoke_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread test_keygen_SOURCES = tests/unit/test_keygen.c +test_keygen_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src test_keygen_LDADD = libwolfcert.la $(WOLFSSL_LIBS) test_csr_SOURCES = tests/unit/test_csr.c test_csr_CPPFLAGS = $(AM_CPPFLAGS) -I$(top_srcdir)/src diff --git a/examples/enroll_cryptocb.c b/examples/enroll_cryptocb.c index bbc2472..80e071f 100644 --- a/examples/enroll_cryptocb.c +++ b/examples/enroll_cryptocb.c @@ -66,10 +66,10 @@ int main(int argc, char** argv) return 1; } - /* Pass the device id; the rest matches the software path. */ + /* Pass the device id. A backend that stores keys also takes .key_id, + * which this pass-through one cannot serve. */ WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = MY_DEV_ID, - .key_label = "demo/device-key" }; + .dev_id = MY_DEV_ID }; WolfCertKey* key = NULL; if (wolfcert_key_generate(&kcfg, &key) != WOLFCERT_OK) { fprintf(stderr, "keygen failed\n"); diff --git a/src/internal.c b/src/internal.c index f266ae3..aac6ed0 100644 --- a/src/internal.c +++ b/src/internal.c @@ -348,6 +348,7 @@ int wolfcert_map_wc_err(int wc_rc) return WOLFCERT_ERR_PARSE; case NOT_COMPILED_IN: case ALGO_ID_E: + case NO_VALID_DEVID: return WOLFCERT_ERR_UNSUPPORTED; default: return WOLFCERT_ERR_CRYPTO; @@ -355,27 +356,62 @@ int wolfcert_map_wc_err(int wc_rc) } #ifdef WOLFCERT_HAVE_ECC +static const struct { + int param; + int curve_id; + int key_size; +} ecc_curves[] = { + { 256, ECC_SECP256R1, 32 }, + { 384, ECC_SECP384R1, 48 }, + { 521, ECC_SECP521R1, 66 }, +}; + int wolfcert_ecc_curve_from_param(int param, int* out_curve_id, int* out_key_size) { - switch (param) { - case 256: - *out_curve_id = ECC_SECP256R1; - *out_key_size = 32; - return WOLFCERT_OK; - case 384: - *out_curve_id = ECC_SECP384R1; - *out_key_size = 48; + size_t i; + + for (i = 0; i < sizeof(ecc_curves) / sizeof(ecc_curves[0]); i++) { + if (ecc_curves[i].param == param) { + *out_curve_id = ecc_curves[i].curve_id; + *out_key_size = ecc_curves[i].key_size; return WOLFCERT_OK; - case 521: - *out_curve_id = ECC_SECP521R1; - *out_key_size = 66; + } + } + return WOLFCERT_ERR_UNSUPPORTED; +} + +int wolfcert_ecc_param_from_curve(int curve_id, int* out_param) +{ + size_t i; + + for (i = 0; i < sizeof(ecc_curves) / sizeof(ecc_curves[0]); i++) { + if (ecc_curves[i].curve_id == curve_id) { + *out_param = ecc_curves[i].param; return WOLFCERT_OK; - default: - return WOLFCERT_ERR_UNSUPPORTED; + } } + return WOLFCERT_ERR_UNSUPPORTED; } #endif /* WOLFCERT_HAVE_ECC */ +int wolfcert_key_id_check(const uint8_t* id, size_t id_len, int dev_id, + const char* module) +{ + if (id == NULL || id_len == 0 || id_len > WOLFCERT_KEY_ID_MAX_LEN) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, module, + "key id must be 1..%d bytes", + WOLFCERT_KEY_ID_MAX_LEN); + if (!wolfcert_devid_is_cb(dev_id)) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, module, + "key id needs a CryptoCb device id"); +#ifndef WOLFCERT_USE_KEY_ID + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, module, + "wolfSSL lacks WOLF_CRYPTO_CB or WOLF_PRIVATE_KEY_ID"); +#else + return WOLFCERT_OK; +#endif +} + WOLFCERT_TEST_VIS int wolfcert_base64_encode(const uint8_t* in, size_t in_len, WolfCertBuffer* out, void* heap) { diff --git a/src/internal.h b/src/internal.h index d63d1a5..a4e3169 100644 --- a/src/internal.h +++ b/src/internal.h @@ -82,12 +82,27 @@ #error "WOLFCERT_SCEP_MAX_GET_URL exceeds WOLFCERT_HTTP_QUERY_SZ; raise WOLFCERT_HTTP_QUERY_SZ so the SCEP server can receive the largest GET the client will build." #endif +#if defined(WOLF_CRYPTO_CB) && defined(WOLF_PRIVATE_KEY_ID) +#define WOLFCERT_USE_KEY_ID +#endif + +static inline int wolfcert_devid_is_cb(int dev_id) +{ + return dev_id != WOLFCERT_DEVID_SOFTWARE && dev_id != INVALID_DEVID; +} + +/* BAD_ARG or UNSUPPORTED, with a message, unless id names a key a CryptoCb + * device can hold in this build. */ +int wolfcert_key_id_check(const uint8_t* id, size_t id_len, int dev_id, + const char* module); + struct WolfCertKey { WolfCertKeyType type; int dev_id; int curve_id; /* ECC only */ int rsa_bits; /* RSA only */ - char* label; + uint8_t id[WOLFCERT_KEY_ID_MAX_LEN]; + size_t id_len; void* heap; void* impl; /* RsaKey* / ecc_key* / ... */ }; @@ -257,6 +272,7 @@ void wolfcert_logv(WolfCertLogLevel lvl, const char* module, const char* fmt, .. int wolfcert_rng_new(WC_RNG* rng); #ifdef WOLFCERT_HAVE_ECC int wolfcert_ecc_curve_from_param(int param, int* out_curve_id, int* out_key_size); +int wolfcert_ecc_param_from_curve(int curve_id, int* out_param); #endif /* Returns WOLFCERT_ERR_BAD_ARG unless srv->protocol is want. */ @@ -342,6 +358,11 @@ WOLFCERT_TEST_VIS int wolfcert_find_san(const DecodedCert* dc, WOLFCERT_TEST_VIS int wolfcert_buffer_is_der(const uint8_t* buf, size_t len); +/* Private key DER of a software key; fails for a key with a key_id. The + * caller zeroizes and frees *out_der. */ +int wolfcert_key_export_der(const WolfCertKey* key, uint8_t** out_der, + int* out_len, void* heap); + /* Degenerate (certs-only) PKCS#7 helpers. */ WOLFCERT_TEST_VIS int wolfcert_pkcs7_certs_to_pem(const uint8_t* p7_der, size_t p7_der_len, WolfCertBuffer* out_pem, void* heap); diff --git a/src/key_algs.c b/src/key_algs.c index 5f3c160..9e33b91 100644 --- a/src/key_algs.c +++ b/src/key_algs.c @@ -44,16 +44,27 @@ #include #ifdef WOLFCERT_HAVE_RSA +int wolfcert_rsa_bits_ok(int bits) +{ + return bits == 2048 || bits == 3072 || bits == 4096; +} + static int rsa_alloc_init(struct WolfCertKey* k) { RsaKey* rk = (RsaKey*)WOLFCERT_XMALLOC(sizeof(*rk), k->heap); if (rk == NULL) return WOLFCERT_ERR_MEMORY; - int rc = wc_InitRsaKey_ex(rk, k->heap, k->dev_id); + int rc; +#ifdef WOLFCERT_USE_KEY_ID + if (k->id_len > 0) + rc = wc_InitRsaKey_Id(rk, k->id, (int)k->id_len, k->heap, k->dev_id); + else +#endif + rc = wc_InitRsaKey_ex(rk, k->heap, k->dev_id); if (rc != 0) { WOLFCERT_XFREE(rk, k->heap); - return WOLFCERT_ERR_WC(rc, "keygen", "InitRsaKey_ex"); + return WOLFCERT_ERR_WC(rc, "keygen", "InitRsaKey"); } k->impl = rk; @@ -63,7 +74,7 @@ static int rsa_alloc_init(struct WolfCertKey* k) static int rsa_make(struct WolfCertKey* k, const WolfCertKeyCfg* cfg, WC_RNG* rng) { int bits = cfg->param; - if (bits != 2048 && bits != 3072 && bits != 4096) + if (!wolfcert_rsa_bits_ok(bits)) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", "bad RSA size %d", bits); k->rsa_bits = bits; @@ -85,6 +96,45 @@ static int rsa_priv_to_der(const struct WolfCertKey* k, uint8_t* buf, word32 cap return wc_RsaKeyToDer((RsaKey*)k->impl, buf, cap); } +/* Modulus size in bits; wc_RsaEncryptSize rounds up to whole bytes. */ +static int rsa_der_modulus_bits(const uint8_t* der, word32 len) +{ + const byte* n = NULL; + word32 n_len = 0; + word32 idx = 0; + int bits; + byte top; + + if (wc_RsaPublicKeyDecode_ex(der, &idx, len, &n, &n_len, NULL, NULL) != 0) + return 0; + while (n_len > 0 && n[0] == 0) { + n++; + n_len--; + } + if (n_len == 0) + return 0; + bits = (int)n_len * 8; + for (top = n[0]; (top & 0x80) == 0; top <<= 1) + bits--; + return bits; +} + +static int rsa_pub_decode(struct WolfCertKey* k, const uint8_t* der, + word32 len) +{ + word32 idx = 0; + if (wc_RsaPublicKeyDecode(der, &idx, (RsaKey*)k->impl, len) != 0) + return WOLFCERT_ERR_PARSE; + + k->rsa_bits = rsa_der_modulus_bits(der, len); + return WOLFCERT_OK; +} + +static int rsa_host_priv(const struct WolfCertKey* k) +{ + return !mp_iszero(&((RsaKey*)k->impl)->d); +} + static int rsa_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) { @@ -163,10 +213,16 @@ static int ecc_alloc_init(struct WolfCertKey* k) if (ek == NULL) return WOLFCERT_ERR_MEMORY; - int rc = wc_ecc_init_ex(ek, k->heap, k->dev_id); + int rc; +#ifdef WOLFCERT_USE_KEY_ID + if (k->id_len > 0) + rc = wc_ecc_init_id(ek, k->id, (int)k->id_len, k->heap, k->dev_id); + else +#endif + rc = wc_ecc_init_ex(ek, k->heap, k->dev_id); if (rc != 0) { WOLFCERT_XFREE(ek, k->heap); - return WOLFCERT_ERR_WC(rc, "keygen", "ecc_init_ex"); + return WOLFCERT_ERR_WC(rc, "keygen", "ecc_init"); } k->impl = ek; @@ -203,6 +259,22 @@ static int ecc_priv_to_der(const struct WolfCertKey* k, uint8_t* buf, word32 cap return wc_EccKeyToDer((ecc_key*)k->impl, buf, cap); } +static int ecc_pub_decode(struct WolfCertKey* k, const uint8_t* der, + word32 len) +{ + word32 idx = 0; + if (wc_EccPublicKeyDecode(der, &idx, (ecc_key*)k->impl, len) != 0) + return WOLFCERT_ERR_PARSE; + + k->curve_id = wc_ecc_get_curve_id(((ecc_key*)k->impl)->idx); + return WOLFCERT_OK; +} + +static int ecc_host_priv(const struct WolfCertKey* k) +{ + return !mp_iszero(wc_ecc_key_get_priv((ecc_key*)k->impl)); +} + /* Uncompressed X9.63 point: the 0x04 marker plus two coordinates. */ #define ECC_X963_CAP (1 + 2 * MAX_ECC_BYTES) @@ -281,6 +353,10 @@ static void ecc_free(struct WolfCertKey* k) #ifdef WOLFCERT_HAVE_ED25519 static int ed25519_alloc_init(struct WolfCertKey* k) { + if (k->id_len > 0) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "wolfSSL has no key_id init for Ed25519"); + ed25519_key* ek = (ed25519_key*)WOLFCERT_XMALLOC(sizeof(*ek), k->heap); if (ek == NULL) return WOLFCERT_ERR_MEMORY; @@ -349,6 +425,10 @@ static void ed25519_free(struct WolfCertKey* k) #ifdef WOLFCERT_HAVE_ED448 static int ed448_alloc_init(struct WolfCertKey* k) { + if (k->id_len > 0) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "wolfSSL has no key_id init for Ed448"); + ed448_key* ek = (ed448_key*)WOLFCERT_XMALLOC(sizeof(*ek), k->heap); if (ek == NULL) return WOLFCERT_ERR_MEMORY; @@ -440,10 +520,16 @@ static int mldsa_alloc_init(struct WolfCertKey* k) if (dk == NULL) return WOLFCERT_ERR_MEMORY; - int rc = wc_MlDsaKey_Init(dk, k->heap, k->dev_id); + int rc; +#ifdef WOLFCERT_USE_KEY_ID + if (k->id_len > 0) + rc = wc_MlDsaKey_InitId(dk, k->id, (int)k->id_len, k->heap, k->dev_id); + else +#endif + rc = wc_MlDsaKey_Init(dk, k->heap, k->dev_id); if (rc != 0) { WOLFCERT_XFREE(dk, k->heap); - return WOLFCERT_ERR_WC(rc, "keygen", "MlDsaKey_Init"); + return WOLFCERT_ERR_WC(rc, "keygen", "mldsa_init"); } int lvl = mldsa_level_for(k->type); @@ -478,6 +564,19 @@ static int mldsa_priv_to_der(const struct WolfCertKey* k, uint8_t* buf, word32 c return wc_MlDsaKey_PrivateKeyToDer((MlDsaKey*)k->impl, buf, cap); } +static int mldsa_pub_decode(struct WolfCertKey* k, const uint8_t* der, + word32 len) +{ + word32 idx = 0; + int rc = wc_MlDsaKey_PublicKeyDecode((MlDsaKey*)k->impl, der, len, &idx); + return rc == 0 ? WOLFCERT_OK : WOLFCERT_ERR_PARSE; +} + +static int mldsa_host_priv(const struct WolfCertKey* k) +{ + return ((MlDsaKey*)k->impl)->prvKeySet; +} + /* Adopts the certificate's public half, which a PKCS#8 v1 key lacks. */ static int mldsa_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) @@ -513,6 +612,8 @@ static const WolfCertKeyAlg ALG_RSA = { .priv_decode = rsa_priv_decode, .priv_to_der = rsa_priv_to_der, .pub_check = rsa_pub_check, + .pub_decode = rsa_pub_decode, + .host_priv = rsa_host_priv, .free_ = rsa_free, }; #endif @@ -530,6 +631,8 @@ static const WolfCertKeyAlg ALG_ECC = { .priv_decode = ecc_priv_decode, .priv_to_der = ecc_priv_to_der, .pub_check = ecc_pub_check, + .pub_decode = ecc_pub_decode, + .host_priv = ecc_host_priv, .free_ = ecc_free, }; #endif @@ -582,6 +685,8 @@ static const WolfCertKeyAlg ALG_MLDSA44 = { .priv_decode = mldsa_priv_decode, .priv_to_der = mldsa_priv_to_der, .pub_check = mldsa_pub_check, + .pub_decode = mldsa_pub_decode, + .host_priv = mldsa_host_priv, .free_ = mldsa_free, }; #endif @@ -599,6 +704,8 @@ static const WolfCertKeyAlg ALG_MLDSA65 = { .priv_decode = mldsa_priv_decode, .priv_to_der = mldsa_priv_to_der, .pub_check = mldsa_pub_check, + .pub_decode = mldsa_pub_decode, + .host_priv = mldsa_host_priv, .free_ = mldsa_free, }; #endif @@ -616,6 +723,8 @@ static const WolfCertKeyAlg ALG_MLDSA87 = { .priv_decode = mldsa_priv_decode, .priv_to_der = mldsa_priv_to_der, .pub_check = mldsa_pub_check, + .pub_decode = mldsa_pub_decode, + .host_priv = mldsa_host_priv, .free_ = mldsa_free, }; #endif diff --git a/src/key_algs.h b/src/key_algs.h index 4ecea75..d9d7c7a 100644 --- a/src/key_algs.h +++ b/src/key_algs.h @@ -50,6 +50,13 @@ typedef struct WolfCertKeyAlg { * usable after a failure. */ int (*pub_check) (struct WolfCertKey* key, const uint8_t* pub, word32 pub_len); + /* Decode a SubjectPublicKeyInfo, for a key behind a key_id. NULL if the + * type cannot take one. */ + int (*pub_decode)(struct WolfCertKey* key, + const uint8_t* der, word32 len); + /* Non-zero if the private half sits in host memory. NULL if the type + * cannot take a key_id. */ + int (*host_priv) (const struct WolfCertKey* key); void (*free_) (struct WolfCertKey* key); } WolfCertKeyAlg; @@ -59,4 +66,7 @@ const WolfCertKeyAlg* wolfcert_key_alg(WolfCertKeyType t); /* NULL-terminated list of compiled-in algorithms. */ const WolfCertKeyAlg* const* wolfcert_key_algs_all(void); +/* Non-zero for an RSA modulus size wolfCert generates and accepts. */ +int wolfcert_rsa_bits_ok(int bits); + #endif /* WOLFCERT_KEY_ALGS_H */ diff --git a/src/keygen.c b/src/keygen.c index e1a95b4..857bf14 100644 --- a/src/keygen.c +++ b/src/keygen.c @@ -30,7 +30,7 @@ #include static WolfCertKey* alloc_shell(WolfCertKeyType type, int dev_id, - const char* label, void* heap) + const uint8_t* id, size_t id_len, void* heap) { WolfCertKey* k = (WolfCertKey*)WOLFCERT_XMALLOC(sizeof(*k), heap); if (k == NULL) @@ -41,17 +41,25 @@ static WolfCertKey* alloc_shell(WolfCertKeyType type, int dev_id, k->dev_id = dev_id; k->heap = heap; - if (label != NULL) { - k->label = wolfcert_strdup(label, heap); - if (k->label == NULL) { - WOLFCERT_XFREE(k, heap); - return NULL; - } + if (id_len > 0) { + memcpy(k->id, id, id_len); + k->id_len = id_len; } return k; } +static int check_key_id(const WolfCertKeyCfg* cfg) +{ + if (cfg->key_id_len == 0) + return cfg->key_id == NULL ? WOLFCERT_OK + : WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", + "key_id is set but key_id_len is 0"); + + return wolfcert_key_id_check(cfg->key_id, cfg->key_id_len, cfg->dev_id, + "keygen"); +} + static void free_shell(WolfCertKey* k) { if (k == NULL) @@ -61,7 +69,6 @@ static void free_shell(WolfCertKey* k) if (a && a->free_) a->free_(k); - WOLFCERT_XFREE(k->label, k->heap); WOLFCERT_XFREE(k, k->heap); } @@ -75,15 +82,20 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", "unknown or disabled key type %d", (int)cfg->type); + int rc = check_key_id(cfg); + if (rc != WOLFCERT_OK) + return rc; + void* heap = cfg->heap ? cfg->heap : wolfcert_default_heap(); - WolfCertKey* k = alloc_shell(cfg->type, cfg->dev_id, cfg->key_label, heap); + WolfCertKey* k = alloc_shell(cfg->type, cfg->dev_id, cfg->key_id, + cfg->key_id_len, heap); if (k == NULL) return WOLFCERT_ERR_MEMORY; /* The RNG is set up first; a DRBG alloc between the large ML-DSA * allocations tripped a glibc sysmalloc assertion. */ WC_RNG rng; - int rc = wc_InitRng_ex(&rng, heap, cfg->dev_id); + rc = wc_InitRng_ex(&rng, heap, cfg->dev_id); if (rc != 0) { free_shell(k); return WOLFCERT_ERR_WC(rc, "keygen", "InitRng"); @@ -103,6 +115,14 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) return rc; } + /* wolfSSL 5.9.4 falls back to software keygen when the device declines. */ + if (k->id_len > 0 && alg->host_priv != NULL && alg->host_priv(k)) { + free_shell(k); + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "CryptoCb device %d did not generate the key", + cfg->dev_id); + } + *out_key = k; return WOLFCERT_OK; } @@ -173,7 +193,8 @@ int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, const WolfCertKeyAlg* const* list = wolfcert_key_algs_all(); for (; *list != NULL; ++list) { const WolfCertKeyAlg* a = *list; - WolfCertKey* k = alloc_shell(a->type, WOLFCERT_DEVID_SOFTWARE, NULL, heap); + WolfCertKey* k = alloc_shell(a->type, WOLFCERT_DEVID_SOFTWARE, NULL, 0, + heap); if (k == NULL) { if (der != NULL) wc_FreeDer(&der); @@ -200,13 +221,142 @@ int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, return WOLFCERT_ERR_PARSE; } +/* SubjectPublicKeyInfo of a PEM or DER certificate, in a fresh buffer. */ +static int cert_spki(const uint8_t* cert, size_t cert_len, void* heap, + uint8_t** out, word32* out_len) +{ + WolfCertBuffer pem_der = { 0 }; + const uint8_t* der = cert; + size_t der_len = cert_len; + uint8_t* spki = NULL; + word32 spki_len = 0; + int rc = WOLFCERT_OK; + + if (!wolfcert_buffer_is_der(cert, cert_len)) { + rc = wolfcert_pem_cert_to_der(cert, cert_len, &pem_der, heap); + der = pem_der.data; + der_len = pem_der.len; + } + if (rc == WOLFCERT_OK && + (wc_GetSubjectPubKeyInfoDerFromCert(der, (word32)der_len, NULL, + &spki_len) < 0 || spki_len == 0)) + rc = WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "keygen", + "public key source is not a certificate"); + if (rc == WOLFCERT_OK) { + spki = (uint8_t*)WOLFCERT_XMALLOC(spki_len, heap); + if (spki == NULL) + rc = WOLFCERT_ERR_MEMORY; + } + if (rc == WOLFCERT_OK && + wc_GetSubjectPubKeyInfoDerFromCert(der, (word32)der_len, spki, + &spki_len) < 0) + rc = WOLFCERT_ERR_PARSE; + + wolfcert_buffer_free(&pem_der); + if (rc != WOLFCERT_OK) { + WOLFCERT_XFREE(spki, heap); + return rc; + } + + *out = spki; + *out_len = spki_len; + return WOLFCERT_OK; +} + +/* The key must have a curve or RSA size keygen makes, and a non-zero param + * must name that one. */ +static int check_param(const WolfCertKey* k, int param) +{ + int have = 0; + +#if !defined(WOLFCERT_HAVE_RSA) && !defined(WOLFCERT_HAVE_ECC) + (void)k; +#endif +#ifdef WOLFCERT_HAVE_RSA + if (k->type == WOLFCERT_KEY_RSA) { + if (!wolfcert_rsa_bits_ok(k->rsa_bits)) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "RSA-%d is not 2048, 3072 or 4096", + k->rsa_bits); + have = k->rsa_bits; + } +#endif +#ifdef WOLFCERT_HAVE_ECC + if (k->type == WOLFCERT_KEY_ECC && + wolfcert_ecc_param_from_curve(k->curve_id, &have) != WOLFCERT_OK) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "public key is not on P-256, P-384 or P-521"); +#endif + if (param != 0 && have != 0 && param != have) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", + "public key is %d bits, param is %d", have, param); + return WOLFCERT_OK; +} + +int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, + const uint8_t* cert, size_t cert_len, + WolfCertKey** out_key) +{ + if (out_key == NULL) + return WOLFCERT_ERR_BAD_ARG; + *out_key = NULL; + if (cfg == NULL || cfg->key_id_len == 0 || cert == NULL || cert_len == 0) + return WOLFCERT_ERR_BAD_ARG; + + int rc = check_key_id(cfg); + if (rc != WOLFCERT_OK) + return rc; + + const WolfCertKeyAlg* alg = wolfcert_key_alg(cfg->type); + if (alg == NULL || alg->pub_decode == NULL) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "key type %d cannot take a key_id", (int)cfg->type); + + void* heap = cfg->heap ? cfg->heap : wolfcert_default_heap(); + uint8_t* spki = NULL; + word32 spki_len = 0; + rc = cert_spki(cert, cert_len, heap, &spki, &spki_len); + if (rc != WOLFCERT_OK) + return rc; + + WolfCertKey* k = alloc_shell(cfg->type, cfg->dev_id, cfg->key_id, + cfg->key_id_len, heap); + if (k == NULL) { + WOLFCERT_XFREE(spki, heap); + return WOLFCERT_ERR_MEMORY; + } + + rc = alg->alloc_init(k); + if (rc == WOLFCERT_OK) { + rc = alg->pub_decode(k, spki, spki_len); + if (rc == WOLFCERT_ERR_PARSE) + rc = WOLFCERT_ERR(WOLFCERT_ERR_PARSE, "keygen", + "certificate key is not a type %d key", + (int)cfg->type); + } + WOLFCERT_XFREE(spki, heap); + if (rc == WOLFCERT_OK) + rc = check_param(k, cfg->param); + if (rc != WOLFCERT_OK) { + free_shell(k); + return rc; + } + + *out_key = k; + return WOLFCERT_OK; +} + /* Serialize a software key's private DER into a freshly allocated buffer. */ -static int key_export_der(const WolfCertKey* key, uint8_t** out_der, - int* out_len, void* heap) +int wolfcert_key_export_der(const WolfCertKey* key, uint8_t** out_der, + int* out_len, void* heap) { const WolfCertKeyAlg* alg = wolfcert_key_alg(key->type); if (alg == NULL) return WOLFCERT_ERR_UNSUPPORTED; + if (key->id_len > 0) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "the private key stays in CryptoCb device %d", + key->dev_id); size_t der_cap = alg->der_cap_hint; if (key->type == WOLFCERT_KEY_RSA) { @@ -238,7 +388,7 @@ int wolfcert_key_to_der(const WolfCertKey* key, WolfCertBuffer* out_der) uint8_t* der = NULL; int der_len = 0; - int rc = key_export_der(key, &der, &der_len, key->heap); + int rc = wolfcert_key_export_der(key, &der, &der_len, key->heap); if (rc != WOLFCERT_OK) return rc; @@ -261,7 +411,7 @@ int wolfcert_key_to_pem(const WolfCertKey* key, WolfCertBuffer* out_pem) void* heap = key->heap; uint8_t* der = NULL; int der_len = 0; - int rc = key_export_der(key, &der, &der_len, heap); + int rc = wolfcert_key_export_der(key, &der, &der_len, heap); if (rc != WOLFCERT_OK) return rc; @@ -306,3 +456,13 @@ int wolfcert_key_dev_id(const WolfCertKey* k) { return k ? k->dev_id : 0; } + +int wolfcert_key_id(const WolfCertKey* k, const uint8_t** id, size_t* id_len) +{ + if (k == NULL || id == NULL || id_len == NULL) + return WOLFCERT_ERR_BAD_ARG; + + *id = k->id_len > 0 ? k->id : NULL; + *id_len = k->id_len; + return WOLFCERT_OK; +} diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index 65fb8fe..d8a5d03 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -6,6 +6,7 @@ target_link_libraries(test_smoke PRIVATE wolfcert Threads::Threads) add_test(NAME smoke COMMAND test_smoke) add_executable(test_keygen unit/test_keygen.c) +target_include_directories(test_keygen PRIVATE ${CMAKE_SOURCE_DIR}/src) target_link_libraries(test_keygen PRIVATE wolfcert) add_test(NAME keygen COMMAND test_keygen) diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index 91bd68a..ad30cab 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -18,11 +18,26 @@ */ #include +#include "internal.h" #include "../test_static_mem.h" +#include +#include + #include #include +#if defined(WOLFCERT_HAVE_ECC) + #define TEST_KEY_TYPE WOLFCERT_KEY_ECC + #define TEST_KEY_PARAM 256 +#elif defined(WOLFCERT_HAVE_RSA) + #define TEST_KEY_TYPE WOLFCERT_KEY_RSA + #define TEST_KEY_PARAM 2048 +#elif defined(WOLFCERT_HAVE_MLDSA) && !defined(WOLFSSL_NO_ML_DSA_65) + #define TEST_KEY_TYPE WOLFCERT_KEY_MLDSA65 + #define TEST_KEY_PARAM 0 +#endif + #define REQUIRE(cond) \ do { \ if (!(cond)) { \ @@ -58,6 +73,11 @@ static int roundtrip(WolfCertKeyType type, int param) REQUIRE(wolfcert_key_from_pem(der.data, der.len, NULL, &k3) == WOLFCERT_OK); REQUIRE(k3 != NULL); + const uint8_t* id = (const uint8_t*)"x"; + size_t id_len = 1; + REQUIRE(wolfcert_key_id(k, &id, &id_len) == WOLFCERT_OK); + REQUIRE(id == NULL && id_len == 0); + wolfcert_buffer_free(&pem); wolfcert_buffer_free(&der); wolfcert_key_free(k); @@ -66,6 +86,228 @@ static int roundtrip(WolfCertKeyType type, int param) return 0; } +#ifdef TEST_KEY_TYPE +#define DECLINE_DEVID 0x6b69 + +#if defined(WOLF_CRYPTO_CB) && defined(WOLF_PRIVATE_KEY_ID) +static int decline_cb(int devId, wc_CryptoInfo* info, void* ctx) +{ + (void)devId; + (void)info; + (void)ctx; + return CRYPTOCB_UNAVAILABLE; +} + +/* A device that declines keygen leaves wolfCrypt to generate in software, + * which a key_id must refuse. */ +static int key_id_declined(WolfCertKeyType type, int param) +{ + static const uint8_t id[] = { 0x01, 0x02 }; + WolfCertKeyCfg cfg = { .type = type, .param = param, + .dev_id = DECLINE_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + WolfCertKey* k = NULL; + + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(k == NULL); + return 0; +} + +static int key_id_cases(void) +{ + static const uint8_t id[] = { 0x01, 0x02 }; + static const uint8_t junk[] = { 0x30, 0x03, 0x02, 0x01, 0x00 }; + WolfCertKey* k = NULL; + + REQUIRE(wc_CryptoCb_RegisterDevice(DECLINE_DEVID, decline_cb, NULL) == 0); + WolfCertKeyCfg cfg = { .type = TEST_KEY_TYPE, .param = TEST_KEY_PARAM, + .dev_id = INVALID_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); + cfg.dev_id = DECLINE_DEVID; + cfg.key_id_len = 0; + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(strstr(wolfcert_last_error_message(), "key_id_len") != NULL); + cfg.dev_id = INVALID_DEVID; + cfg.key_id_len = sizeof(id); + + if (key_id_declined(TEST_KEY_TYPE, TEST_KEY_PARAM)) + return 1; +#ifdef WOLFCERT_HAVE_RSA + if (key_id_declined(WOLFCERT_KEY_RSA, 2048)) + return 1; +#endif +#ifdef WOLFCERT_HAVE_MLDSA +#ifndef WOLFSSL_NO_ML_DSA_44 + if (key_id_declined(WOLFCERT_KEY_MLDSA44, 0)) + return 1; +#endif +#ifndef WOLFSSL_NO_ML_DSA_65 + if (key_id_declined(WOLFCERT_KEY_MLDSA65, 0)) + return 1; +#endif +#ifndef WOLFSSL_NO_ML_DSA_87 + if (key_id_declined(WOLFCERT_KEY_MLDSA87, 0)) + return 1; +#endif +#endif + + cfg.dev_id = DECLINE_DEVID; + cfg.key_id_len = 0; + REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == + WOLFCERT_ERR_BAD_ARG); + k = (WolfCertKey*)&cfg; + REQUIRE(wolfcert_key_from_id(&cfg, NULL, 0, &k) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(k == NULL); + cfg.key_id_len = sizeof(id); + REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == + WOLFCERT_ERR_PARSE); +#ifdef WOLFCERT_HAVE_RSA + /* Even with param 0, a reload refuses an RSA size keygen would not make. */ + { + static const uint8_t weak[] = { + 0x30, 0x82, 0x01, 0xf7, 0x30, 0x82, 0x01, 0x60, 0xa0, 0x03, 0x02, + 0x01, 0x02, 0x02, 0x14, 0x59, 0x46, 0x07, 0x05, 0xaa, 0x88, 0x4f, + 0xba, 0x81, 0x5e, 0xee, 0x36, 0x6e, 0xf3, 0x66, 0xd2, 0x9f, 0x0d, + 0x68, 0x8f, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, + 0x0d, 0x01, 0x01, 0x0b, 0x05, 0x00, 0x30, 0x0f, 0x31, 0x0d, 0x30, + 0x0b, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x04, 0x77, 0x65, 0x61, + 0x6b, 0x30, 0x1e, 0x17, 0x0d, 0x32, 0x36, 0x31, 0x30, 0x31, 0x37, + 0x31, 0x32, 0x31, 0x36, 0x31, 0x39, 0x5a, 0x17, 0x0d, 0x33, 0x36, + 0x31, 0x30, 0x31, 0x34, 0x31, 0x32, 0x31, 0x36, 0x31, 0x39, 0x5a, + 0x30, 0x0f, 0x31, 0x0d, 0x30, 0x0b, 0x06, 0x03, 0x55, 0x04, 0x03, + 0x0c, 0x04, 0x77, 0x65, 0x61, 0x6b, 0x30, 0x81, 0x9f, 0x30, 0x0d, + 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x01, + 0x05, 0x00, 0x03, 0x81, 0x8d, 0x00, 0x30, 0x81, 0x89, 0x02, 0x81, + 0x81, 0x00, 0xd6, 0x71, 0xd3, 0xa4, 0x94, 0x12, 0x9e, 0x33, 0x9c, + 0x3e, 0x4c, 0x0f, 0xd0, 0xe1, 0x90, 0xd0, 0x25, 0x95, 0x19, 0x34, + 0x96, 0x6e, 0x97, 0x0b, 0x48, 0x21, 0x0f, 0x26, 0xb4, 0x03, 0x92, + 0xb6, 0x99, 0xe7, 0xe7, 0x7a, 0xe5, 0x73, 0x8d, 0x37, 0x54, 0xf9, + 0x8c, 0xe0, 0x1d, 0x0e, 0xae, 0x63, 0x80, 0x72, 0x4a, 0xb9, 0x94, + 0xef, 0x82, 0x30, 0x70, 0xda, 0xce, 0x85, 0x52, 0x0b, 0x75, 0x18, + 0xb9, 0x4d, 0xcb, 0xc0, 0x30, 0x69, 0x06, 0xcb, 0x9d, 0x03, 0x5c, + 0xe0, 0x6c, 0xf9, 0xe8, 0x6d, 0x08, 0xe8, 0xb2, 0xb7, 0x60, 0x31, + 0xc3, 0xfc, 0x2c, 0x01, 0xb7, 0xaf, 0x10, 0xaa, 0xe2, 0x89, 0xcb, + 0xad, 0xa9, 0xa0, 0xcf, 0x68, 0x8e, 0xa6, 0x36, 0xcd, 0xdc, 0x16, + 0xc8, 0x59, 0xad, 0x38, 0x5e, 0xc1, 0x9f, 0xdb, 0xa4, 0x6a, 0xa6, + 0x43, 0x2d, 0x94, 0xe1, 0xcf, 0xd2, 0x71, 0x59, 0x93, 0x02, 0x03, + 0x01, 0x00, 0x01, 0xa3, 0x50, 0x30, 0x4e, 0x30, 0x1d, 0x06, 0x03, + 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0xa8, 0xc9, 0xf0, 0x7b, + 0x4e, 0x72, 0x2d, 0x7a, 0xb7, 0x51, 0x48, 0x2d, 0x6e, 0x34, 0x92, + 0xc9, 0x10, 0x74, 0x3c, 0x9b, 0x30, 0x1f, 0x06, 0x03, 0x55, 0x1d, + 0x23, 0x04, 0x18, 0x30, 0x16, 0x80, 0x14, 0xa8, 0xc9, 0xf0, 0x7b, + 0x4e, 0x72, 0x2d, 0x7a, 0xb7, 0x51, 0x48, 0x2d, 0x6e, 0x34, 0x92, + 0xc9, 0x10, 0x74, 0x3c, 0x9b, 0x30, 0x0c, 0x06, 0x03, 0x55, 0x1d, + 0x13, 0x01, 0x01, 0xff, 0x04, 0x02, 0x30, 0x00, 0x30, 0x0d, 0x06, + 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x0b, 0x05, + 0x00, 0x03, 0x81, 0x81, 0x00, 0x34, 0xaa, 0x11, 0x9e, 0x41, 0x4a, + 0x5e, 0x86, 0x2e, 0xae, 0x14, 0x37, 0xf8, 0xfa, 0x0b, 0x05, 0x5b, + 0x46, 0x31, 0x08, 0xef, 0xae, 0x6d, 0xd2, 0x23, 0xc0, 0xb6, 0xb8, + 0xb7, 0x63, 0x68, 0x26, 0x33, 0x04, 0x72, 0xab, 0x98, 0x4a, 0xb8, + 0xad, 0x86, 0xef, 0xc3, 0xdf, 0x5a, 0x7b, 0x00, 0x87, 0x8e, 0xf2, + 0x8f, 0x97, 0x19, 0x62, 0x4b, 0xda, 0x36, 0xdc, 0x31, 0x79, 0xf9, + 0x45, 0x1d, 0x7d, 0xbe, 0xc7, 0x51, 0xff, 0xd2, 0xd6, 0x73, 0xd3, + 0x88, 0x0b, 0x54, 0x6c, 0x2f, 0xb9, 0xe1, 0x08, 0xe9, 0x0e, 0x4e, + 0xe8, 0xba, 0x9c, 0x04, 0x74, 0x37, 0x6f, 0x49, 0x73, 0x1d, 0x21, + 0x02, 0xa7, 0x67, 0x11, 0x1a, 0x85, 0x01, 0x88, 0x2a, 0x40, 0x32, + 0x6f, 0x12, 0x3c, 0x68, 0xa9, 0xe6, 0x40, 0x4e, 0xa2, 0x4a, 0x8a, + 0x2f, 0xed, 0x8d, 0x8e, 0xac, 0xbc, 0xee, 0xf3, 0x1f, 0xe8, 0x54, + 0x97, + }; + WolfCertKeyCfg rcfg = { .type = WOLFCERT_KEY_RSA, + .dev_id = DECLINE_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + + REQUIRE(wolfcert_key_from_id(&rcfg, weak, sizeof(weak), &k) == + WOLFCERT_ERR_UNSUPPORTED); +#ifdef WOLFCERT_HAVE_ECC + rcfg.type = WOLFCERT_KEY_ECC; + REQUIRE(wolfcert_key_from_id(&rcfg, weak, sizeof(weak), &k) == + WOLFCERT_ERR_PARSE); + REQUIRE(strstr(wolfcert_last_error_message(), "not a type") != NULL); +#endif + } +#endif +#ifdef WOLFCERT_HAVE_ECC + /* Likewise a curve keygen does not make: a P-224 certificate. */ + { + static const uint8_t p224[] = { + 0x30, 0x82, 0x01, 0x5f, 0x30, 0x82, 0x01, 0x0e, 0xa0, 0x03, 0x02, + 0x01, 0x02, 0x02, 0x14, 0x3d, 0xf5, 0x24, 0x44, 0x39, 0x0d, 0xf6, + 0x77, 0xeb, 0xd4, 0x87, 0x95, 0x79, 0x98, 0xc5, 0xd2, 0x06, 0xb7, + 0xdb, 0x94, 0x30, 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, + 0x04, 0x03, 0x02, 0x30, 0x0f, 0x31, 0x0d, 0x30, 0x0b, 0x06, 0x03, + 0x55, 0x04, 0x03, 0x0c, 0x04, 0x70, 0x32, 0x32, 0x34, 0x30, 0x1e, + 0x17, 0x0d, 0x32, 0x36, 0x31, 0x30, 0x31, 0x37, 0x31, 0x34, 0x30, + 0x36, 0x33, 0x32, 0x5a, 0x17, 0x0d, 0x33, 0x36, 0x31, 0x30, 0x31, + 0x34, 0x31, 0x34, 0x30, 0x36, 0x33, 0x32, 0x5a, 0x30, 0x0f, 0x31, + 0x0d, 0x30, 0x0b, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x04, 0x70, + 0x32, 0x32, 0x34, 0x30, 0x4e, 0x30, 0x10, 0x06, 0x07, 0x2a, 0x86, + 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x05, 0x2b, 0x81, 0x04, 0x00, + 0x21, 0x03, 0x3a, 0x00, 0x04, 0xe8, 0x66, 0x0e, 0x19, 0x35, 0xc9, + 0x09, 0x98, 0xb2, 0x14, 0x18, 0x2a, 0xb8, 0x7b, 0x4e, 0x2b, 0x89, + 0xea, 0x78, 0x54, 0x01, 0xc4, 0x25, 0xb2, 0x10, 0x52, 0xed, 0x26, + 0x22, 0x4a, 0x23, 0x42, 0x6e, 0x2d, 0x9f, 0x50, 0x37, 0xfc, 0xf4, + 0x2a, 0x94, 0x43, 0xf1, 0x28, 0xee, 0x44, 0xff, 0x6f, 0x92, 0xa7, + 0xab, 0xb5, 0xdb, 0x52, 0x36, 0x26, 0xa3, 0x53, 0x30, 0x51, 0x30, + 0x1d, 0x06, 0x03, 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x03, + 0x45, 0x74, 0x20, 0xc9, 0xc6, 0xc6, 0xdd, 0x0f, 0xe5, 0x17, 0xbf, + 0x61, 0xe3, 0xbc, 0x21, 0xce, 0x0a, 0x31, 0xc8, 0x30, 0x1f, 0x06, + 0x03, 0x55, 0x1d, 0x23, 0x04, 0x18, 0x30, 0x16, 0x80, 0x14, 0x03, + 0x45, 0x74, 0x20, 0xc9, 0xc6, 0xc6, 0xdd, 0x0f, 0xe5, 0x17, 0xbf, + 0x61, 0xe3, 0xbc, 0x21, 0xce, 0x0a, 0x31, 0xc8, 0x30, 0x0f, 0x06, + 0x03, 0x55, 0x1d, 0x13, 0x01, 0x01, 0xff, 0x04, 0x05, 0x30, 0x03, + 0x01, 0x01, 0xff, 0x30, 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, + 0x3d, 0x04, 0x03, 0x02, 0x03, 0x3f, 0x00, 0x30, 0x3c, 0x02, 0x1c, + 0x51, 0xad, 0x29, 0x59, 0x0b, 0x12, 0x22, 0x51, 0x76, 0x60, 0x02, + 0x26, 0x53, 0xb6, 0xd8, 0x46, 0xa8, 0xda, 0x06, 0x60, 0x6e, 0x67, + 0x4e, 0x71, 0xbe, 0x1c, 0xb0, 0x36, 0x02, 0x1c, 0x0c, 0x7b, 0x06, + 0x77, 0xf6, 0x9a, 0xed, 0xc0, 0x31, 0x92, 0x8c, 0x5e, 0x84, 0xb3, + 0x6f, 0xb1, 0x65, 0x2a, 0xe4, 0x4a, 0x89, 0x65, 0x3e, 0x16, 0x3f, + 0xb8, 0x05, 0x99, + }; + WolfCertKeyCfg ecfg = { .type = WOLFCERT_KEY_ECC, + .dev_id = DECLINE_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + int erc = wolfcert_key_from_id(&ecfg, p224, sizeof(p224), &k); + +#if (defined(HAVE_ECC224) || defined(HAVE_ALL_CURVES)) && ECC_MIN_KEY_SZ <= 224 + REQUIRE(erc == WOLFCERT_ERR_UNSUPPORTED); +#else + REQUIRE(erc == WOLFCERT_ERR_PARSE); +#endif + } +#endif +#ifdef WOLFCERT_HAVE_ED25519 + cfg.type = WOLFCERT_KEY_ED25519; + cfg.param = 0; + REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == + WOLFCERT_ERR_UNSUPPORTED); +#endif + REQUIRE(k == NULL); + + wc_CryptoCb_UnRegisterDevice(DECLINE_DEVID); + return 0; +} +#else +static int key_id_cases(void) +{ + static const uint8_t id[] = { 0x01, 0x02 }; + static const uint8_t junk[] = { 0x30, 0x03, 0x02, 0x01, 0x00 }; + WolfCertKeyCfg cfg = { .type = TEST_KEY_TYPE, .param = TEST_KEY_PARAM, + .dev_id = DECLINE_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + WolfCertKey* k = NULL; + + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == + WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(k == NULL); + return 0; +} +#endif +#endif /* TEST_KEY_TYPE */ + int main(void) { REQUIRE(test_static_mem_init() == 0); @@ -111,6 +353,11 @@ int main(void) } #endif +#ifdef TEST_KEY_TYPE + if (key_id_cases()) + return 1; +#endif + WolfCertKeyCfg bad = { .type = WOLFCERT_KEY_ECC, .param = 123, .dev_id = WOLFCERT_DEVID_SOFTWARE }; WolfCertKey* k = NULL; diff --git a/wolfcert/keygen.h b/wolfcert/keygen.h index 497cd51..b5002d2 100644 --- a/wolfcert/keygen.h +++ b/wolfcert/keygen.h @@ -28,28 +28,42 @@ extern "C" { typedef struct WolfCertKey WolfCertKey; -/* Generate a key per cfg. With cfg->dev_id != -1 the key lives in the - * CryptoCb backend registered under that id and the handle only references - * it. The handle is allocated from cfg->heap, or the default heap if NULL. */ +/* Generate a key per cfg. cfg->dev_id != -1 routes its operations through + * that CryptoCb device; with cfg->key_id the key also stays in the device and + * the handle only references it. Allocated from cfg->heap or the default. */ WOLFCERT_API int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key); +/* Reference a key a CryptoCb device holds under cfg->key_id, its public half + * from `cert`, PEM or DER: a curve or RSA size keygen makes, matching a + * non-zero cfg->param. Nothing checks that `cert` belongs to that key. + * *out_key is NULL after a failure. */ +WOLFCERT_API int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, + const uint8_t* cert, size_t cert_len, + WolfCertKey** out_key); + /* Load a software key from PEM or DER; the encoding is auto-detected. */ WOLFCERT_API int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, void* heap, WolfCertKey** out_key); -/* Export a software key as PEM. Fails for keys that live behind a CryptoCb - * that does not permit export. */ +/* Export a software key as PEM. Fails with WOLFCERT_ERR_UNSUPPORTED for a + * key with a key_id. */ WOLFCERT_API int wolfcert_key_to_pem(const WolfCertKey* key, WolfCertBuffer* out_pem); /* Export a software key as raw DER (same export constraints as * wolfcert_key_to_pem). */ WOLFCERT_API int wolfcert_key_to_der(const WolfCertKey* key, WolfCertBuffer* out_der); +/* Frees the handle; for a key_id key, the device's free callback decides what + * happens to the key it holds. */ WOLFCERT_API void wolfcert_key_free(WolfCertKey* key); /* Accessors. wolfcert_key_type returns 0 on NULL. */ WOLFCERT_API WolfCertKeyType wolfcert_key_type(const WolfCertKey* key); WOLFCERT_API int wolfcert_key_dev_id(const WolfCertKey* key); +/* Points *id at the key's backend id, or NULL with *id_len 0 if it has + * none. The bytes stay owned by the key. */ +WOLFCERT_API int wolfcert_key_id(const WolfCertKey* key, const uint8_t** id, + size_t* id_len); #ifdef __cplusplus } diff --git a/wolfcert/types.h b/wolfcert/types.h index f2d3b1a..8cc6d4f 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -81,12 +81,20 @@ typedef enum { * registers; WOLFCERT_DEVID_SOFTWARE selects software. */ #define WOLFCERT_DEVID_SOFTWARE (-1) +/* Defaults to wolfSSL's default ECC_MAX_ID_LEN / RSA_MAX_ID_LEN. */ +#ifndef WOLFCERT_KEY_ID_MAX_LEN +#define WOLFCERT_KEY_ID_MAX_LEN 32 +#endif + typedef struct { WolfCertKeyType type; int param; /* RSA 2048/3072/4096 or ECC 256/384/521 bits */ int dev_id; /* wolfSSL CryptoCb devId; -1 for software */ - const char* key_label; /* optional backend identifier for persistent keys */ void* heap; /* optional heap hint; NULL = default */ + /* Backend key id, opaque to wolfCert; needs dev_id. Up to + * WOLFCERT_KEY_ID_MAX_LEN bytes. */ + const uint8_t* key_id; + size_t key_id_len; } WolfCertKeyCfg; /* Called by wolfcert_csr_build() once the standard fields are set, with the From dfff8248042aad8af84d8aaf2c092cf47d00912f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Tue, 6 Oct 2026 15:46:57 +0200 Subject: [PATCH 06/17] Use a backend-resident key for TLS client auth and EST reenroll The HTTP layer only accepted the TLS client key as PEM or DER bytes, so a key held behind a CryptoCb could not authenticate a connection. EST /simplereenroll exported the current key with wolfcert_key_to_pem to use it as the mTLS identity, which fails for any key that cannot leave its backend, so renewing such a key was broken before any network traffic. WolfCertServerCfg, WolfCertHttpRequest and WolfCertHttpSessionCfg gain an appended client_key_src and client_key_dev_id, mirroring wolfSSL's split between a context's devId and its private key's devId: - WOLFCERT_CLIENT_KEY_BUFFER (0, the default for a zeroed struct): client_key is PEM or DER and used in software, as before. - WOLFCERT_CLIENT_KEY_BUFFER_DEV: client_key is PEM or DER, and wolfSSL_CTX_SetDevId puts the connection's crypto, the client key's included, on client_key_dev_id. This is the acceleration case. Without WOLF_CRYPTO_CB it returns WOLFCERT_ERR_UNSUPPORTED. - WOLFCERT_CLIENT_KEY_ID: client_key holds a key id, loaded with wolfSSL_CTX_use_PrivateKey_Id on client_key_dev_id, so the handshake signature runs in the backend. Without WOLF_CRYPTO_CB and WOLF_PRIVATE_KEY_ID it returns WOLFCERT_ERR_UNSUPPORTED. An explicit source rather than a non-zero dev_id selects the device, so a zeroed struct keeps today's behaviour and device id 0 stays usable. wolfcert_http_request and wolfcert_http_session_open check the source before connecting. A source other than _BUFFER needs client_cert, client_key, a CryptoCb client_key_dev_id and an https:// URL, and _ID an id of 1 to WOLFCERT_KEY_ID_MAX_LEN bytes; anything else, or an unknown source, is WOLFCERT_ERR_BAD_ARG, so a request cannot silently go out without the client authentication the caller asked for. The id rules are the ones key generation applies, from one helper. test_http covers each case. wolfcert_est_simple_reenroll passes a key with a key_id by id instead of exporting it. Any other key is exported as DER rather than PEM, since wolfSSL turns a PEM key back into DER anyway, with the _DEV source when it has a dev_id and wolfSSL has WOLF_CRYPTO_CB, so the handshake runs on the device its CSR was signed with. test_est_mtls_roundtrip re-enrolls a software key of every compiled-in type to cover the untyped DER. SCEP still takes the signer and recipient key as DER for PKCS#7, and wolfSSL's PKCS#7 code carries a devId but no key id, so a backend could not tell which key to use. Every SCEP entry point now refuses a key with a key_id with WOLFCERT_ERR_UNSUPPORTED next to its RSA check, before the self-signed signer certificate is signed in the backend. SCEP now exports its signer key with wolfcert_key_export_der, which refuses such a key as well, instead of keeping its own copy of the export. With a key_id, a failed wolfcert_client_enroll, or a wolfcert_client_reenroll that generated a new key, frees the handle but leaves the key in the backend. client.h now says so. --- src/est/est_client.c | 34 ++++++---- src/http.c | 73 +++++++++++++++++++-- src/scep/scep_client.c | 42 ++++-------- tests/integration/test_est_mtls_roundtrip.c | 62 +++++++++++++++++ tests/unit/test_http.c | 68 +++++++++++++++++++ wolfcert/client.h | 6 +- wolfcert/http.h | 8 +++ wolfcert/types.h | 11 ++++ 8 files changed, 252 insertions(+), 52 deletions(-) diff --git a/src/est/est_client.c b/src/est/est_client.c index d8e3eaa..8b31034 100644 --- a/src/est/est_client.c +++ b/src/est/est_client.c @@ -222,6 +222,8 @@ int wolfcert_est_session_open(const WolfCertServerCfg* srv, .client_cert_len = srv->client_cert_len, .client_key = srv->client_key, .client_key_len = srv->client_key_len, + .client_key_src = srv->client_key_src, + .client_key_dev_id = srv->client_key_dev_id, .allow_post_handshake_auth = srv->proto_opts.est.allow_post_handshake_auth, .transport = srv->transport, .heap = heap, @@ -550,8 +552,8 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, WolfCertEstResult* out) { WolfCertServerCfg cfg; - WolfCertBuffer key_pem = { 0 }; - int rc; + WolfCertBuffer key_der = { 0 }; + int rc = WOLFCERT_OK; if (out == NULL) return WOLFCERT_ERR_BAD_ARG; @@ -563,19 +565,25 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, return WOLFCERT_ERR_BAD_ARG; /* The TLS identity is the cert being renewed. */ - rc = wolfcert_key_to_pem(current_key, &key_pem); - if (rc == WOLFCERT_OK) { - cfg = *srv; - cfg.client_cert = current_cert; - cfg.client_cert_len = current_cert_len; - cfg.client_key = key_pem.data; - cfg.client_key_len = key_pem.len; + cfg = *srv; + cfg.client_cert = current_cert; + cfg.client_cert_len = current_cert_len; + cfg.client_key_dev_id = current_key->dev_id; + if (current_key->id_len > 0) { + cfg.client_key = current_key->id; + cfg.client_key_len = current_key->id_len; + cfg.client_key_src = WOLFCERT_CLIENT_KEY_ID; + } + else { + rc = wolfcert_key_to_der(current_key, &key_der); + cfg.client_key = key_der.data; + cfg.client_key_len = key_der.len; + cfg.client_key_src = WOLFCERT_CLIENT_KEY_BUFFER; + } + if (rc == WOLFCERT_OK) rc = est_one_shot(&cfg, EST_OP_SIMPLE_REENROLL, csr_der, csr_der_len, WOLFCERT_ENCODING_PEM, &out->cert_pem, out); - } - if (key_pem.data != NULL) - wc_ForceZero(key_pem.data, (word32)key_pem.len); - wolfcert_buffer_free(&key_pem); + wolfcert_buffer_free_secure(&key_der); return rc; } diff --git a/src/http.c b/src/http.c index 89fbc1f..87523a8 100644 --- a/src/http.c +++ b/src/http.c @@ -926,6 +926,8 @@ typedef struct { size_t client_cert_len; const uint8_t* client_key; size_t client_key_len; + WolfCertClientKeySrc client_key_src; + int client_key_dev_id; int allow_post_handshake_auth; } TlsDials; @@ -935,6 +937,49 @@ static int buf_filetype(const uint8_t* buf, size_t len) : WOLFSSL_FILETYPE_PEM; } +static int check_client_key(WolfCertClientKeySrc src, const uint8_t* cert, + size_t cert_len, const uint8_t* key, + size_t key_len, int dev_id) +{ + if (src == WOLFCERT_CLIENT_KEY_BUFFER) + return WOLFCERT_OK; + if (src != WOLFCERT_CLIENT_KEY_ID) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", + "unknown client_key_src %d", (int)src); + if (cert == NULL || cert_len == 0 || key == NULL || key_len == 0) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", + "client_key_src %d needs client_cert and " + "client_key", (int)src); + return wolfcert_key_id_check(key, key_len, dev_id, "http"); +} + +/* The source was checked by check_client_key. */ +static int use_client_key(WOLFSSL_CTX* ctx, const TlsDials* d) +{ + int rc = WOLFSSL_SUCCESS; + + if (d->client_key_src == WOLFCERT_CLIENT_KEY_ID) { +#ifdef WOLFCERT_USE_KEY_ID + rc = wolfSSL_CTX_use_PrivateKey_Id(ctx, d->client_key, + (long)d->client_key_len, + d->client_key_dev_id); +#else + rc = WOLFSSL_FAILURE; +#endif + } + else { + rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, d->client_key, + (long)d->client_key_len, + buf_filetype(d->client_key, d->client_key_len)); + } + + if (rc != WOLFSSL_SUCCESS) + return WOLFCERT_ERR(WOLFCERT_ERR_TLS, "http", + "client_key_src %d: loading the client key " + "failed (%d)", (int)d->client_key_src, rc); + return WOLFCERT_OK; +} + static int setup_tls_ex(WolfCertConn* c, const TlsDials* dials, const char* sni_host, WOLFSSL_CTX** out_ctx) { @@ -985,12 +1030,10 @@ static int setup_tls_ex(WolfCertConn* c, const TlsDials* dials, return WOLFCERT_ERR_TLS; } - rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, dials->client_key, - (long)dials->client_key_len, - buf_filetype(dials->client_key, dials->client_key_len)); - if (rc != WOLFSSL_SUCCESS) { + rc = use_client_key(ctx, dials); + if (rc != WOLFCERT_OK) { wolfSSL_CTX_free(ctx); - return WOLFCERT_ERR_TLS; + return rc; } } @@ -1041,6 +1084,13 @@ int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, if (cfg == NULL || cfg->base_url == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; + int rc = check_client_key(cfg->client_key_src, cfg->client_cert, + cfg->client_cert_len, cfg->client_key, + cfg->client_key_len, + cfg->client_key_dev_id); + if (rc != WOLFCERT_OK) + return rc; + void* heap = cfg->heap ? cfg->heap : wolfcert_default_heap(); WolfCertHttpSession* s = (WolfCertHttpSession*)WOLFCERT_XMALLOC(sizeof(*s), heap); @@ -1053,11 +1103,18 @@ int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, s->max_body = cfg->max_response_bytes ? cfg->max_response_bytes : WOLFCERT_HTTP_DEFAULT_MAX_BODY; - int rc = wolfcert_http_url_parse(cfg->base_url, &s->base, heap); + rc = wolfcert_http_url_parse(cfg->base_url, &s->base, heap); if (rc != WOLFCERT_OK) { WOLFCERT_XFREE(s, heap); return rc; } + if (cfg->client_key_src != WOLFCERT_CLIENT_KEY_BUFFER && !s->base.tls) { + wolfcert_http_url_free(&s->base); + WOLFCERT_XFREE(s, heap); + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", + "client_key_src %d needs an https:// URL", + (int)cfg->client_key_src); + } rc = dial(&s->conn, s->base.host, s->base.port, cfg->timeout_ms, &cfg->transport); @@ -1075,6 +1132,8 @@ int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, .client_cert_len = cfg->client_cert_len, .client_key = cfg->client_key, .client_key_len = cfg->client_key_len, + .client_key_src = cfg->client_key_src, + .client_key_dev_id = cfg->client_key_dev_id, .allow_post_handshake_auth = cfg->allow_post_handshake_auth, }; @@ -1878,6 +1937,8 @@ int wolfcert_http_request(const WolfCertHttpRequest* req, WolfCertHttpResponse* cfg.client_cert_len = req->client_cert_len; cfg.client_key = req->client_key; cfg.client_key_len = req->client_key_len; + cfg.client_key_src = req->client_key_src; + cfg.client_key_dev_id = req->client_key_dev_id; cfg.heap = req->heap; cfg.transport = req->transport; diff --git a/src/scep/scep_client.c b/src/scep/scep_client.c index 62e42b6..6188f72 100644 --- a/src/scep/scep_client.c +++ b/src/scep/scep_client.c @@ -413,35 +413,6 @@ static int scep_build_txid(const ScepTxidSel* sel, return WOLFCERT_OK; } -/* The caller has already checked that key->type is WOLFCERT_KEY_RSA. */ -static int rsa_key_to_der(const WolfCertKey* key, void* heap, - uint8_t** out_der, size_t* out_len) -{ - uint8_t* der; - int sz; - int n; - - sz = wc_RsaKeyToDer((RsaKey*)key->impl, NULL, 0); - if (sz <= 0) - return WOLFCERT_ERR_WC(sz, "scep", "RsaKeyToDer"); - - der = (uint8_t*)WOLFCERT_XMALLOC((size_t)sz, heap); - if (der == NULL) - return WOLFCERT_ERR_MEMORY; - - n = wc_RsaKeyToDer((RsaKey*)key->impl, der, (word32)sz); - if (n <= 0) { - wc_ForceZero(der, (word32)sz); - WOLFCERT_XFREE(der, heap); - return WOLFCERT_ERR_WC(n, "scep", "RsaKeyToDer"); - } - - *out_der = der; - *out_len = (size_t)n; - - return WOLFCERT_OK; -} - WOLFCERT_TEST_VIS int wolfcert_scep_pem_has_cert(const uint8_t* pem, size_t pem_len, const uint8_t* issuer, size_t issuer_len, const uint8_t* serial, size_t serial_len, @@ -690,6 +661,11 @@ static int scep_call_check(const ScepCall* c) "SCEP (RFC 8894) requires an RSA signer for pkiMessage; " "Ed25519/Ed448/ML-DSA are not permitted"); + /* PKCS#7 takes the private key as DER, which a key_id key cannot give. */ + if (pki && c->key->id_len > 0) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "scep", + "SCEP cannot sign or decrypt with a key_id key"); + return WOLFCERT_OK; } @@ -796,6 +772,8 @@ static int scep_session_connect(WolfCertScepSession* s, .client_cert_len = srv->client_cert_len, .client_key = srv->client_key, .client_key_len = srv->client_key_len, + .client_key_src = srv->client_key_src, + .client_key_dev_id = srv->client_key_dev_id, .transport = srv->transport, .heap = s->heap, }; @@ -1155,6 +1133,7 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, WolfCertBuffer pki = { 0 }; char* url = NULL; int use_post = 0; + int key_len = 0; int rc = WOLFCERT_OK; c->res_out->heap = heap; @@ -1213,8 +1192,9 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, } if (rc == WOLFCERT_OK) - rc = rsa_key_to_der(c->key, heap, &s->in_signer_key, - &s->in_signer_key_len); + rc = wolfcert_key_export_der(c->key, &s->in_signer_key, &key_len, + heap); + s->in_signer_key_len = (size_t)key_len; if (rc == WOLFCERT_OK) rc = scep_prepare(s, c, msg_type, content, content_len, &pki); if (rc == WOLFCERT_OK) diff --git a/tests/integration/test_est_mtls_roundtrip.c b/tests/integration/test_est_mtls_roundtrip.c index dbcda5e..2b305e3 100644 --- a/tests/integration/test_est_mtls_roundtrip.c +++ b/tests/integration/test_est_mtls_roundtrip.c @@ -287,6 +287,40 @@ static int csr_with_critical_san(const WolfCertBuffer* cert_pem, } #endif +/* A software key of each type re-enrolls; its DER reaches TLS untyped. */ +static int reenroll_key_type(const WolfCertServerCfg* cli, WolfCertKeyType type, + int param) +{ + const WolfCertCertMeta meta = { .subject_dn = "CN=reenroll-type,O=wolfSSL" }; + WolfCertKeyCfg kcfg = { .type = type, .param = param, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertKey* key = NULL; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult cert = { 0 }; + WolfCertEstResult renewed = { 0 }; + int rc; + + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + REQUIRE(cert.status == WOLFCERT_EST_STATUS_SUCCESS); + rc = wolfcert_est_simple_reenroll(cli, cert.cert_pem.data, + cert.cert_pem.len, key, csr.data, + csr.len, &renewed); + if (rc != WOLFCERT_OK) + fprintf(stderr, "key type %d reenroll rc=%d (%s)\n", (int)type, rc, + wolfcert_last_error_message()); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(renewed.status == WOLFCERT_EST_STATUS_SUCCESS); + + wolfcert_est_result_free(&renewed); + wolfcert_est_result_free(&cert); + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); + return 0; +} + /* Reenroll of a multi-RDN, multi-SAN cert the server CA issued succeeds; a * changed dNSName or a critical SAN (ECC builds) gets 400. */ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_len, @@ -401,6 +435,34 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ REQUIRE(refused.cert_pem.data == NULL); #endif + static const struct { WolfCertKeyType type; int param; } types[] = { +#ifdef WOLFCERT_HAVE_RSA + { WOLFCERT_KEY_RSA, 2048 }, +#endif +#ifdef WOLFCERT_HAVE_ECC + { WOLFCERT_KEY_ECC, 384 }, +#endif +#ifdef WOLFCERT_HAVE_ED25519 + { WOLFCERT_KEY_ED25519, 0 }, +#endif +#ifdef WOLFCERT_HAVE_ED448 + { WOLFCERT_KEY_ED448, 0 }, +#endif +#ifdef WOLFCERT_HAVE_MLDSA +#ifndef WOLFSSL_NO_ML_DSA_44 + { WOLFCERT_KEY_MLDSA44, 0 }, +#endif +#ifndef WOLFSSL_NO_ML_DSA_65 + { WOLFCERT_KEY_MLDSA65, 0 }, +#endif +#ifndef WOLFSSL_NO_ML_DSA_87 + { WOLFCERT_KEY_MLDSA87, 0 }, +#endif +#endif + }; + for (size_t i = 0; i < sizeof(types) / sizeof(types[0]); i++) + REQUIRE(reenroll_key_type(&cli, types[i].type, types[i].param) == 0); + wolfcert_server_stop(srv); pthread_join(tid, NULL); wolfcert_server_free(srv); diff --git a/tests/unit/test_http.c b/tests/unit/test_http.c index 34f9d3f..e1c5e64 100644 --- a/tests/unit/test_http.c +++ b/tests/unit/test_http.c @@ -1205,6 +1205,72 @@ static int test_chunked_complete_resume(void) return 0; } +/* A client key source other than _BUFFER is checked before any connection. */ +static int test_client_key_checks(void) +{ + static const uint8_t cert[] = "-----BEGIN CERTIFICATE-----"; + static const uint8_t id[] = { 0x01, 0x02 }; + WolfCertHttpRequest req = { + .method = "GET", + .url = "https://127.0.0.1:1/x", + .client_key = id, + .client_key_len = sizeof(id), + .client_key_src = WOLFCERT_CLIENT_KEY_ID, + .client_key_dev_id = 7, + }; + WolfCertHttpSessionCfg scfg = { + .base_url = "https://127.0.0.1:1", + .client_key = id, + .client_key_len = sizeof(id), + .client_key_src = WOLFCERT_CLIENT_KEY_ID, + .client_key_dev_id = 7, + }; + WolfCertHttpResponse resp; + WolfCertHttpSession* s = NULL; + + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); + scfg.client_cert = cert; + scfg.client_cert_len = sizeof(cert); + scfg.client_key_dev_id = WOLFCERT_DEVID_SOFTWARE; + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); + scfg.client_key_dev_id = 7; + scfg.client_cert_len = 0; + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); + scfg.client_cert_len = sizeof(cert); + scfg.client_key_len = 0; + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); + scfg.client_key_len = sizeof(id); +#ifndef WOLFCERT_USE_KEY_ID + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_UNSUPPORTED); +#else + scfg.base_url = "http://127.0.0.1:1"; + REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(strstr(wolfcert_last_error_message(), "https://") != NULL); + scfg.base_url = "https://127.0.0.1:1"; +#endif + REQUIRE(s == NULL); + + req.client_cert = cert; + req.client_cert_len = sizeof(cert); + req.client_key_src = (WolfCertClientKeySrc)7; + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); + req.client_key_src = WOLFCERT_CLIENT_KEY_ID; + req.client_key_dev_id = INVALID_DEVID; + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); + req.client_key_dev_id = 7; + req.client_cert_len = 0; + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); + req.client_cert_len = sizeof(cert); + req.client_key_len = WOLFCERT_KEY_ID_MAX_LEN + 1; + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); +#ifndef WOLFCERT_USE_KEY_ID + req.client_key_len = sizeof(id); + REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_UNSUPPORTED); +#endif + return 0; +} + int main(void) { /* make check has no per-test timeout, and a framing bug shows as a hang. */ @@ -1293,6 +1359,8 @@ int main(void) return 1; if (test_chunked_uppercase_hex_size()) return 1; + if (test_client_key_checks()) + return 1; wolfcert_cleanup(); printf("OK\n"); return 0; diff --git a/wolfcert/client.h b/wolfcert/client.h index 6134a9c..bfdcc65 100644 --- a/wolfcert/client.h +++ b/wolfcert/client.h @@ -52,7 +52,8 @@ WOLFCERT_API int wolfcert_client_fetch_meta(WolfCertClient* client, /* Generate a new key (honoring cfg->dev_id for CryptoCb offloading), build * a CSR from meta, and enroll. On success out_key owns the key and * out_cert_pem owns the issued certificate. A pending enrollment returns - * WOLFCERT_ERR_PENDING and hands out neither. */ + * WOLFCERT_ERR_PENDING and hands out neither. On failure a key generated + * under a key_id stays in the backend; delete it there. */ WOLFCERT_API int wolfcert_client_enroll(WolfCertClient* client, const WolfCertServerCfg* srv, const WolfCertKeyCfg* key_cfg, @@ -64,7 +65,8 @@ WOLFCERT_API int wolfcert_client_enroll(WolfCertClient* client, * The CSR copies current_cert's Subject and SAN: WOLFCERT_ERR_BAD_ARG if meta * sets them, _PARSE for a bad cert, _UNSUPPORTED if one cannot be carried. * A pending renewal returns WOLFCERT_ERR_PENDING and hands out neither - * out_key nor out_cert_pem. */ + * out_key nor out_cert_pem. A new key with a key_id stays in the backend on + * failure, as for enroll. */ WOLFCERT_API int wolfcert_client_reenroll(WolfCertClient* client, const WolfCertServerCfg* srv, const uint8_t* current_cert, size_t current_cert_len, diff --git a/wolfcert/http.h b/wolfcert/http.h index 619068a..4fa34cc 100644 --- a/wolfcert/http.h +++ b/wolfcert/http.h @@ -65,6 +65,10 @@ typedef struct { void* heap; /* NULL -> default */ WolfCertTransport transport; + + /* As in WolfCertServerCfg. */ + WolfCertClientKeySrc client_key_src; + int client_key_dev_id; } WolfCertHttpRequest; typedef struct { @@ -108,6 +112,10 @@ typedef struct { void* heap; WolfCertTransport transport; + + /* As in WolfCertServerCfg. */ + WolfCertClientKeySrc client_key_src; + int client_key_dev_id; } WolfCertHttpSessionCfg; /* Connects without verifying the server; the first request runs the TLS diff --git a/wolfcert/types.h b/wolfcert/types.h index 8cc6d4f..e38b525 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -86,6 +86,12 @@ typedef enum { #define WOLFCERT_KEY_ID_MAX_LEN 32 #endif +/* What a TLS client_key holds. */ +typedef enum { + WOLFCERT_CLIENT_KEY_BUFFER = 0, /* PEM or DER */ + WOLFCERT_CLIENT_KEY_ID = 1 /* key id held by client_key_dev_id */ +} WolfCertClientKeySrc; + typedef struct { WolfCertKeyType type; int param; /* RSA 2048/3072/4096 or ECC 256/384/521 bits */ @@ -241,6 +247,11 @@ typedef struct { void* heap; WolfCertTransport transport; + + /* What client_key holds, and the CryptoCb device holding an _ID key, + * which needs client_cert, client_key and an https:// URL. */ + WolfCertClientKeySrc client_key_src; + int client_key_dev_id; } WolfCertServerCfg; /* Caller-owned byte buffer filled by the library. wolfcert_buffer_free() From 5f55545323d09998de81289f8d86346e05918686 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Tue, 6 Oct 2026 15:46:57 +0200 Subject: [PATCH 07/17] Test EST with a key that stays in its CryptoCb backend test_est_devid_roundtrip registers a mock CryptoCb key store that keeps ECC, RSA and ML-DSA keys by id and never hands them out. For each key type, and each ML-DSA level wolfSSL has, it generates a key in the store, checks that export is refused, builds a CSR, enrolls over a bootstrap mTLS identity, rebuilds the handle by id from the issued certificate as PEM, as PEM ahead of another certificate and as DER padded like a fixed-size flash slot, re-enrolls with that key as the mTLS identity, and enrolls again with its id as the client key, both one-shot and over a keep-alive EST session. A param or ML-DSA level that does not match the certificate is refused. The store counts the private-key operations it performs, and the test checks that the CSR and TLS signatures went through it. It also checks the key_id argument errors and that the four one-shot SCEP calls and the three SCEP session calls refuse a key with a key_id without asking the store for a signature first. The session calls run over a loopback listener that never answers, since the refusal comes before any I/O. For the client key sources, the bootstrap PEM key enrolls once in software, without the store seeing a signature request, and once with WOLFCERT_CLIENT_KEY_BUFFER_DEV, where the store is asked first and declines. The store counts only signature requests, since wolfSSL sends one-shot hashes to the first registered device on its own. An unknown source is refused with WOLFCERT_ERR_BAD_ARG. A key with the store's dev_id but no key_id then re-enrolls, and the store is asked for both the CSR signature and the handshake's, which shows the _DEV source. The mock answers public RSA operations on a stored key as well, because wolfSSL checks its own RSA signature in the handshake with the id-only key, which carries no modulus. Its key generation declines a key with no id, such as a TLS ephemeral key under the _DEV source. The test skips, with exit code 77, when wolfSSL lacks WOLF_CRYPTO_CB or WOLF_PRIVATE_KEY_ID. --- Makefile.am | 5 +- tests/CMakeLists.txt | 5 + tests/integration/test_est_devid_roundtrip.c | 743 +++++++++++++++++++ 3 files changed, 752 insertions(+), 1 deletion(-) create mode 100644 tests/integration/test_est_devid_roundtrip.c diff --git a/Makefile.am b/Makefile.am index 5f59a3f..52c6213 100644 --- a/Makefile.am +++ b/Makefile.am @@ -148,7 +148,8 @@ check_PROGRAMS += test_est_roundtrip test_est_tls_roundtrip test_est_mtls_roundt test_est_pha_roundtrip test_est_async_roundtrip \ test_est_csr_attrs_roundtrip test_est_csr_attrs_apply_roundtrip \ test_est_csr_attrs_enforce test_est_chunked_robustness \ - test_est_pending_roundtrip test_est_mldsa_roundtrip + test_est_pending_roundtrip test_est_mldsa_roundtrip \ + test_est_devid_roundtrip test_est_roundtrip_SOURCES = tests/integration/test_est_roundtrip.c test_est_roundtrip_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread test_est_tls_roundtrip_SOURCES = tests/integration/test_est_tls_roundtrip.c @@ -157,6 +158,8 @@ test_est_mtls_roundtrip_SOURCES = tests/integration/test_est_mtls_roundtrip.c test_est_mtls_roundtrip_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread test_est_mldsa_roundtrip_SOURCES = tests/integration/test_est_mldsa_roundtrip.c test_est_mldsa_roundtrip_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread +test_est_devid_roundtrip_SOURCES = tests/integration/test_est_devid_roundtrip.c +test_est_devid_roundtrip_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread test_est_pha_roundtrip_SOURCES = tests/integration/test_est_pha_roundtrip.c test_est_pha_roundtrip_LDADD = libwolfcert.la $(WOLFSSL_LIBS) -lpthread test_est_async_roundtrip_SOURCES = tests/integration/test_est_async_roundtrip.c diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt index d8a5d03..9a2e809 100644 --- a/tests/CMakeLists.txt +++ b/tests/CMakeLists.txt @@ -70,6 +70,11 @@ if(WOLFCERT_ENABLE_EST) target_link_libraries(test_est_mtls_roundtrip PRIVATE wolfcert Threads::Threads) add_test(NAME est_mtls_roundtrip COMMAND test_est_mtls_roundtrip) + add_executable(test_est_devid_roundtrip integration/test_est_devid_roundtrip.c) + target_link_libraries(test_est_devid_roundtrip PRIVATE wolfcert Threads::Threads) + add_test(NAME est_devid_roundtrip COMMAND test_est_devid_roundtrip) + set_tests_properties(est_devid_roundtrip PROPERTIES SKIP_RETURN_CODE 77) + add_executable(test_est_pha_roundtrip integration/test_est_pha_roundtrip.c) target_link_libraries(test_est_pha_roundtrip PRIVATE wolfcert Threads::Threads) add_test(NAME est_pha_roundtrip COMMAND test_est_pha_roundtrip) diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c new file mode 100644 index 0000000..344ab5c --- /dev/null +++ b/tests/integration/test_est_devid_roundtrip.c @@ -0,0 +1,743 @@ +/* + * Copyright (C) 2026 wolfSSL Inc. + * + * This file is part of wolfCert. + * + * wolfCert is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfCert is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with wolfCert. If not, see . + */ + +/* EST with keys that never leave a mock CryptoCb key store, which keeps them + * by key_id and counts the private-key operations it performs. */ + +#define _POSIX_C_SOURCE 200809L +#define _DEFAULT_SOURCE +#define _DARWIN_C_SOURCE +#define _GNU_SOURCE + +#include +#include +#ifdef WOLFCERT_HAVE_SCEP +#include +#endif +#include + +#include +#include +#include + +#include "tls_test_util.h" + +#include +#include +#include +#include + +#if !defined(WOLF_CRYPTO_CB) || !defined(WOLF_PRIVATE_KEY_ID) +int main(void) +{ + printf("SKIP (wolfSSL built without WOLF_CRYPTO_CB or " + "WOLF_PRIVATE_KEY_ID)\n"); + return 77; +} +#else + +#define REQUIRE(cond) \ + do { \ + if (!(cond)) { \ + fprintf(stderr, "FAIL %s:%d %s\n", __FILE__, __LINE__, #cond); \ + return 1; \ + } \ + } while (0) + +#define MOCK_DEVID 0x6d6b +#define MOCK_SLOTS 4 + +enum { MOCK_ECC = 1, MOCK_RSA, MOCK_MLDSA }; + +typedef struct { + byte id[WOLFCERT_KEY_ID_MAX_LEN]; + int id_len; + int type; +#ifdef WOLFCERT_HAVE_ECC + ecc_key ecc; +#endif +#ifdef WOLFCERT_HAVE_RSA + RsaKey rsa; +#endif +#ifdef WOLFCERT_HAVE_MLDSA + MlDsaKey mldsa; +#endif +} MockSlot; + +static MockSlot mock_slots[MOCK_SLOTS]; +static int mock_sign_requests; +static int mock_keygens; +static int mock_private_ops; + +static MockSlot* mock_find(const byte* id, int id_len) +{ + for (int i = 0; i < MOCK_SLOTS; i++) { + if (mock_slots[i].id_len == id_len && id_len > 0 && + memcmp(mock_slots[i].id, id, (size_t)id_len) == 0) + return &mock_slots[i]; + } + return NULL; +} + +static MockSlot* mock_new(const byte* id, int id_len, int type) +{ + if (mock_find(id, id_len) != NULL) + return NULL; + for (int i = 0; i < MOCK_SLOTS; i++) { + if (mock_slots[i].id_len == 0) { + memcpy(mock_slots[i].id, id, (size_t)id_len); + mock_slots[i].id_len = id_len; + mock_slots[i].type = type; + return &mock_slots[i]; + } + } + return NULL; +} + +static int mock_cb(int devId, wc_CryptoInfo* info, void* ctx) +{ + (void)devId; + (void)ctx; + + if (info->algo_type != WC_ALGO_TYPE_PK) + return CRYPTOCB_UNAVAILABLE; + + switch (info->pk.type) { +#ifdef WOLFCERT_HAVE_ECC + case WC_PK_TYPE_EC_KEYGEN: { + ecc_key* key = info->pk.eckg.key; + byte pub[1 + 2 * MAX_ECC_BYTES]; + word32 pub_len = sizeof(pub); + MockSlot* s; + int rc; + + if (key->idLen == 0) + return CRYPTOCB_UNAVAILABLE; + s = mock_new(key->id, key->idLen, MOCK_ECC); + if (s == NULL) + return BAD_STATE_E; + rc = wc_ecc_init_ex(&s->ecc, NULL, INVALID_DEVID); + if (rc == 0) + rc = wc_ecc_make_key_ex(info->pk.eckg.rng, info->pk.eckg.size, + &s->ecc, info->pk.eckg.curveId); + if (rc == 0) + rc = wc_ecc_export_x963(&s->ecc, pub, &pub_len); + if (rc == 0) + rc = wc_ecc_import_x963_ex(pub, pub_len, key, + info->pk.eckg.curveId); + if (rc == 0) + mock_keygens++; + return rc; + } + case WC_PK_TYPE_ECDSA_SIGN: { + ecc_key* key = info->pk.eccsign.key; + MockSlot* s = mock_find(key->id, key->idLen); + int rc; + + mock_sign_requests++; + if (s == NULL || s->type != MOCK_ECC) + return CRYPTOCB_UNAVAILABLE; + rc = wc_ecc_sign_hash(info->pk.eccsign.in, info->pk.eccsign.inlen, + info->pk.eccsign.out, info->pk.eccsign.outlen, + info->pk.eccsign.rng, &s->ecc); + if (rc == 0) + mock_private_ops++; + return rc; + } +#endif +#ifdef WOLFCERT_HAVE_RSA + case WC_PK_TYPE_RSA_KEYGEN: { + RsaKey* key = info->pk.rsakg.key; + byte n[512], e[8]; + word32 n_len = sizeof(n), e_len = sizeof(e); + MockSlot* s; + int rc; + + if (key->idLen == 0) + return CRYPTOCB_UNAVAILABLE; + s = mock_new(key->id, key->idLen, MOCK_RSA); + if (s == NULL) + return BAD_STATE_E; + rc = wc_InitRsaKey_ex(&s->rsa, NULL, INVALID_DEVID); + if (rc == 0) + rc = wc_MakeRsaKey(&s->rsa, info->pk.rsakg.size, + info->pk.rsakg.e, info->pk.rsakg.rng); + if (rc == 0) + rc = wc_RsaFlattenPublicKey(&s->rsa, e, &e_len, n, &n_len); + if (rc == 0) + rc = wc_RsaPublicKeyDecodeRaw(n, n_len, e, e_len, key); + if (rc == 0) + mock_keygens++; + return rc; + } + case WC_PK_TYPE_RSA: { + RsaKey* key = info->pk.rsa.key; + MockSlot* s = mock_find(key->id, key->idLen); + int rc; + + if (info->pk.rsa.type == RSA_PRIVATE_ENCRYPT) + mock_sign_requests++; + if (s == NULL || s->type != MOCK_RSA) + return CRYPTOCB_UNAVAILABLE; + rc = wc_RsaFunction(info->pk.rsa.in, info->pk.rsa.inLen, + info->pk.rsa.out, info->pk.rsa.outLen, + info->pk.rsa.type, &s->rsa, info->pk.rsa.rng); + if (rc == 0 && (info->pk.rsa.type == RSA_PRIVATE_ENCRYPT || + info->pk.rsa.type == RSA_PRIVATE_DECRYPT)) + mock_private_ops++; + return rc; + } +#endif +#ifdef WOLFCERT_HAVE_MLDSA + case WC_PK_TYPE_PQC_SIG_KEYGEN: { + MlDsaKey* key = (MlDsaKey*)info->pk.pqc_sig_kg.key; + byte pub[WC_MLDSA_87_PUB_KEY_SIZE]; + word32 pub_len = sizeof(pub); + MockSlot* s; + int rc; + + if (info->pk.pqc_sig_kg.type != WC_PQC_SIG_TYPE_MLDSA || + key->idLen == 0) + return CRYPTOCB_UNAVAILABLE; + s = mock_new(key->id, key->idLen, MOCK_MLDSA); + if (s == NULL) + return BAD_STATE_E; + rc = wc_MlDsaKey_Init(&s->mldsa, NULL, INVALID_DEVID); + if (rc == 0) + rc = wc_MlDsaKey_SetParams(&s->mldsa, + (byte)info->pk.pqc_sig_kg.size); + if (rc == 0) + rc = wc_MlDsaKey_MakeKey(&s->mldsa, info->pk.pqc_sig_kg.rng); + if (rc == 0) + rc = wc_MlDsaKey_ExportPubRaw(&s->mldsa, pub, &pub_len); + if (rc == 0) + rc = wc_MlDsaKey_ImportPubRaw(key, pub, pub_len); + if (rc == 0) + mock_keygens++; + return rc; + } + case WC_PK_TYPE_PQC_SIG_SIGN: { + MlDsaKey* key = (MlDsaKey*)info->pk.pqc_sign.key; + MockSlot* s; + int rc; + + mock_sign_requests++; + if (info->pk.pqc_sign.type != WC_PQC_SIG_TYPE_MLDSA || + info->pk.pqc_sign.preHashType != WC_HASH_TYPE_NONE || + info->pk.pqc_sign.addRnd != NULL) + return CRYPTOCB_UNAVAILABLE; + s = mock_find(key->id, key->idLen); + if (s == NULL || s->type != MOCK_MLDSA) + return CRYPTOCB_UNAVAILABLE; + rc = wc_MlDsaKey_SignCtx(&s->mldsa, info->pk.pqc_sign.context, + info->pk.pqc_sign.contextLen, + info->pk.pqc_sign.out, + info->pk.pqc_sign.outlen, + info->pk.pqc_sign.in, info->pk.pqc_sign.inlen, + info->pk.pqc_sign.rng); + if (rc == 0) + mock_private_ops++; + return rc; + } +#endif + default: + return CRYPTOCB_UNAVAILABLE; + } +} + +static void mock_reset(void) +{ + for (int i = 0; i < MOCK_SLOTS; i++) { +#ifdef WOLFCERT_HAVE_ECC + if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_ECC) + wc_ecc_free(&mock_slots[i].ecc); +#endif +#ifdef WOLFCERT_HAVE_RSA + if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_RSA) + wc_FreeRsaKey(&mock_slots[i].rsa); +#endif +#ifdef WOLFCERT_HAVE_MLDSA + if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_MLDSA) + wc_MlDsaKey_Free(&mock_slots[i].mldsa); +#endif + } + memset(mock_slots, 0, sizeof(mock_slots)); +} + +static void* server_thread(void* arg) +{ + wolfcert_server_run((WolfCertServer*)arg); + return NULL; +} + +static int test_cfg_errors(void) +{ + static const uint8_t id[] = "dev-key"; + uint8_t long_id[WOLFCERT_KEY_ID_MAX_LEN + 1] = { 0 }; + WolfCertKeyCfg cfg = { .type = TEST_ENROLL_KEY_TYPE, + .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE, + .key_id = id, .key_id_len = sizeof(id) - 1 }; + WolfCertKey* k = NULL; + + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); + + cfg.dev_id = MOCK_DEVID; + cfg.key_id = long_id; + cfg.key_id_len = sizeof(long_id); + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); + + cfg.key_id = NULL; + cfg.key_id_len = 4; + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); + +#ifdef WOLFCERT_HAVE_ED25519 + cfg.type = WOLFCERT_KEY_ED25519; + cfg.key_id = id; + cfg.key_id_len = sizeof(id) - 1; + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_UNSUPPORTED); +#endif + + REQUIRE(k == NULL); + return 0; +} + +/* Enroll a store-resident key over a bootstrap mTLS identity, reload it by id + * from the issued certificate, then use it as the mTLS identity itself. */ +static int run_key_type(const char* url, WolfCertKeyType type, int param, + const uint8_t* tls_cert, size_t tls_cert_len, + const uint8_t* boot_cert, size_t boot_cert_len, + const uint8_t* boot_key, size_t boot_key_len) +{ + static const uint8_t id[] = "wolfcert/device-key"; + const WolfCertCertMeta meta = { .subject_dn = "CN=devid-device,O=wolfSSL" }; + WolfCertKeyCfg kcfg = { .type = type, .param = param, + .dev_id = MOCK_DEVID, + .key_id = id, .key_id_len = sizeof(id) - 1 }; + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + .client_cert = boot_cert, + .client_cert_len = boot_cert_len, + .client_key = boot_key, + .client_key_len = boot_key_len, + }; + WolfCertKey* key = NULL; + WolfCertKey* reloaded = NULL; + WolfCertBuffer out = { 0 }; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult issued = { 0 }; + WolfCertBuffer renewed = { 0 }; + WolfCertEstResult second = { 0 }; + const uint8_t* got_id = NULL; + size_t got_len = 0; + int ops; + int rc; + + mock_reset(); + mock_keygens = 0; + mock_private_ops = 0; + + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(mock_keygens == 1); + REQUIRE(wolfcert_key_id(key, &got_id, &got_len) == WOLFCERT_OK); + REQUIRE(got_len == sizeof(id) - 1 && memcmp(got_id, id, got_len) == 0); + REQUIRE(wolfcert_key_to_pem(key, &out) == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(wolfcert_key_to_der(key, &out) == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(out.data == NULL); + + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(mock_private_ops == 1); +#ifdef WOLFCERT_HAVE_SCEP + if (type == WOLFCERT_KEY_RSA) { + static const uint8_t dummy[] = { 0x30, 0x00 }; + static const uint8_t txid[] = { '1' }; + const WolfCertServerCfg scep = { + .protocol = WOLFCERT_PROTO_SCEP, + .server_url = "http://127.0.0.1:9/scep", + }; + WolfCertScepResult res; + int before = mock_private_ops; + int src; + + for (int call = 0; call < 4; call++) { + if (call == 0) + src = wolfcert_scep_pkcs_req(&scep, NULL, dummy, + sizeof(dummy), dummy, sizeof(dummy), key, csr.data, + csr.len, &res); + else if (call == 1) + src = wolfcert_scep_renewal_req(&scep, NULL, dummy, + sizeof(dummy), dummy, sizeof(dummy), dummy, + sizeof(dummy), key, csr.data, csr.len, &res); + else if (call == 2) + src = wolfcert_scep_get_cert_initial(&scep, NULL, dummy, + sizeof(dummy), dummy, sizeof(dummy), dummy, + sizeof(dummy), key, csr.data, csr.len, txid, + sizeof(txid), &res); + else + src = wolfcert_scep_get_cert(&scep, NULL, dummy, + sizeof(dummy), dummy, sizeof(dummy), dummy, + sizeof(dummy), key, dummy, sizeof(dummy), &res); + if (src != WOLFCERT_ERR_UNSUPPORTED) + fprintf(stderr, "SCEP call %d rc=%d\n", call, src); + REQUIRE(src == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(strstr(wolfcert_last_error_message(), "key_id") != NULL); + REQUIRE(mock_private_ops == before); + wolfcert_scep_result_free(&res); + } + + /* The session calls too, over a listener that never answers. */ + const WolfCertScepCaps caps = { 0 }; + WolfCertScepSession* ss = NULL; + uint16_t hole_port = 0; + int hole = black_hole_listener(&hole_port); + char hole_url[64]; + + REQUIRE(hole >= 0); + snprintf(hole_url, sizeof(hole_url), "http://127.0.0.1:%u/scep", + hole_port); + WolfCertServerCfg scep_sess = scep; + scep_sess.server_url = hole_url; + REQUIRE(wolfcert_scep_session_open(&scep_sess, &ss) == WOLFCERT_OK); + for (int call = 0; call < 3; call++) { + if (call == 0) + src = wolfcert_scep_session_pkcs_req(ss, &caps, dummy, + sizeof(dummy), dummy, sizeof(dummy), key, csr.data, + csr.len, &res); + else if (call == 1) + src = wolfcert_scep_session_renewal_req(ss, &caps, dummy, + sizeof(dummy), dummy, sizeof(dummy), dummy, + sizeof(dummy), key, csr.data, csr.len, &res); + else + src = wolfcert_scep_session_get_cert_initial(ss, &caps, + dummy, sizeof(dummy), dummy, sizeof(dummy), dummy, + sizeof(dummy), key, csr.data, csr.len, txid, + sizeof(txid), &res); + if (src != WOLFCERT_ERR_UNSUPPORTED) + fprintf(stderr, "SCEP session call %d rc=%d\n", call, src); + REQUIRE(src == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(strstr(wolfcert_last_error_message(), "key_id") != NULL); + REQUIRE(mock_private_ops == before); + wolfcert_scep_result_free(&res); + } + wolfcert_scep_session_close(ss); + close(hole); + } +#endif + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued); + wolfcert_buffer_free(&csr); + if (rc != WOLFCERT_OK) + fprintf(stderr, "enroll rc=%d (%s)\n", rc, + wolfcert_last_error_message()); + REQUIRE(rc == WOLFCERT_OK); + + /* Reload by id from the issued certificate as PEM, ahead of another + * certificate, and as DER padded like a fixed-size flash slot. */ + REQUIRE(wolfcert_key_from_id(&kcfg, issued.cert_pem.data, + issued.cert_pem.len, &reloaded) == + WOLFCERT_OK); + REQUIRE(wolfcert_key_type(reloaded) == type); + REQUIRE(wolfcert_key_to_pem(reloaded, &out) == WOLFCERT_ERR_UNSUPPORTED); + { + static uint8_t buf[16384]; + int der_len = wc_CertPemToDer(issued.cert_pem.data, + (int)issued.cert_pem.len, buf, + sizeof(buf), CERT_TYPE); + WolfCertKey* other = NULL; + + REQUIRE(der_len > 0); + memset(buf + der_len, 0xff, sizeof(buf) - (size_t)der_len); + REQUIRE(wolfcert_key_from_id(&kcfg, buf, sizeof(buf), &other) == + WOLFCERT_OK); + REQUIRE(wolfcert_key_type(other) == type); + wolfcert_key_free(other); + other = NULL; + + REQUIRE(issued.cert_pem.len + tls_cert_len <= sizeof(buf)); + memcpy(buf, issued.cert_pem.data, issued.cert_pem.len); + memcpy(buf + issued.cert_pem.len, tls_cert, tls_cert_len); + REQUIRE(wolfcert_key_from_id(&kcfg, buf, + issued.cert_pem.len + tls_cert_len, + &other) == WOLFCERT_OK); + REQUIRE(wolfcert_key_type(other) == type); + wolfcert_key_free(other); + other = NULL; + + WolfCertKeyCfg wrong = kcfg; + if (type == WOLFCERT_KEY_ECC || type == WOLFCERT_KEY_RSA) { + wrong.param = type == WOLFCERT_KEY_RSA ? 3072 : 384; + REQUIRE(wolfcert_key_from_id(&wrong, issued.cert_pem.data, + issued.cert_pem.len, &other) == + WOLFCERT_ERR_BAD_ARG); + } +#if defined(WOLFCERT_HAVE_MLDSA) && !defined(WOLFSSL_NO_ML_DSA_65) + if (type == WOLFCERT_KEY_MLDSA44) { + wrong.type = WOLFCERT_KEY_MLDSA65; + REQUIRE(wolfcert_key_from_id(&wrong, issued.cert_pem.data, + issued.cert_pem.len, &other) != + WOLFCERT_OK); + } +#endif + REQUIRE(other == NULL); + } + +#ifdef KEEP_PEER_CERT + /* /simplereenroll authenticates with the store key: one signature for the + * CSR, at least one more for the TLS handshake. */ + WolfCertClient* client = NULL; + WolfCertKey* unused = NULL; + const WolfCertCertMeta renew_meta = { 0 }; + + REQUIRE(wolfcert_client_new(&client) == WOLFCERT_OK); + ops = mock_private_ops; + rc = wolfcert_client_reenroll(client, &cli, issued.cert_pem.data, + issued.cert_pem.len, reloaded, NULL, + &renew_meta, &unused, &renewed); + wolfcert_client_free(client); + REQUIRE(unused == NULL); + if (rc != WOLFCERT_OK) + fprintf(stderr, "reenroll rc=%d (%s)\n", rc, + wolfcert_last_error_message()); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(mock_private_ops >= ops + 2); +#endif + + /* The store key as the mTLS identity by id, one-shot and in a session. */ + cli.client_cert = issued.cert_pem.data; + cli.client_cert_len = issued.cert_pem.len; + cli.client_key = id; + cli.client_key_len = sizeof(id) - 1; + cli.client_key_src = WOLFCERT_CLIENT_KEY_ID; + cli.client_key_dev_id = MOCK_DEVID; + REQUIRE(wolfcert_csr_build(reloaded, &meta, &csr) == WOLFCERT_OK); + ops = mock_private_ops; + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &second); + wolfcert_buffer_free(&csr); + if (rc != WOLFCERT_OK) + fprintf(stderr, "id enroll rc=%d (%s)\n", rc, + wolfcert_last_error_message()); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(mock_private_ops > ops); + + WolfCertEstSession* sess = NULL; + WolfCertEstResult third = { 0 }; + REQUIRE(wolfcert_csr_build(reloaded, &meta, &csr) == WOLFCERT_OK); + ops = mock_private_ops; + REQUIRE(wolfcert_est_session_open(&cli, &sess) == WOLFCERT_OK); + rc = wolfcert_est_session_simple_enroll(sess, csr.data, csr.len, &third); + wolfcert_est_session_close(sess); + wolfcert_buffer_free(&csr); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(mock_private_ops > ops); + wolfcert_est_result_free(&third); + + wolfcert_est_result_free(&second); + wolfcert_buffer_free(&renewed); + wolfcert_est_result_free(&issued); + wolfcert_key_free(reloaded); + wolfcert_key_free(key); + mock_reset(); + return 0; +} + +/* A PEM client key signs in software even with a client_key_dev_id. */ +static int test_client_key_src(const char* url, + const uint8_t* tls_cert, size_t tls_cert_len, + const uint8_t* boot_cert, size_t boot_cert_len, + const uint8_t* boot_key, size_t boot_key_len) +{ + const WolfCertCertMeta meta = { .subject_dn = "CN=devid-accel,O=wolfSSL" }; + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, + .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + .client_cert = boot_cert, + .client_cert_len = boot_cert_len, + .client_key = boot_key, + .client_key_len = boot_key_len, + .client_key_src = WOLFCERT_CLIENT_KEY_BUFFER, + .client_key_dev_id = MOCK_DEVID, + }; + WolfCertKey* key = NULL; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult cert = { 0 }; + int requests; + + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + + requests = mock_sign_requests; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + REQUIRE(mock_sign_requests == requests); + wolfcert_est_result_free(&cert); + + cli.client_key_src = (WolfCertClientKeySrc)7; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_ERR_BAD_ARG); + cli.client_key_src = WOLFCERT_CLIENT_KEY_BUFFER; + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); + key = NULL; + +#ifdef KEEP_PEER_CERT + /* A dev_id key without a key_id signs its CSR on the device and the + * handshake in software. */ + const WolfCertCertMeta renew_meta = { 0 }; + WolfCertClient* client = NULL; + WolfCertKey* unused = NULL; + WolfCertBuffer renewed = { 0 }; + + kcfg.dev_id = MOCK_DEVID; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + REQUIRE(wolfcert_client_new(&client) == WOLFCERT_OK); + requests = mock_sign_requests; + int rc = wolfcert_client_reenroll(client, &cli, cert.cert_pem.data, + cert.cert_pem.len, key, NULL, + &renew_meta, &unused, &renewed); + wolfcert_client_free(client); + if (rc != WOLFCERT_OK) + fprintf(stderr, "dev reenroll rc=%d (%s)\n", rc, + wolfcert_last_error_message()); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(mock_sign_requests == requests + 1); + wolfcert_buffer_free(&renewed); + wolfcert_est_result_free(&cert); + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); +#endif + return 0; +} + +int main(void) +{ + uint8_t* tls_cert = NULL; size_t tls_cert_len = 0; + uint8_t* tls_key = NULL; size_t tls_key_len = 0; + uint8_t* boot_cert = NULL; size_t boot_cert_len = 0; + uint8_t* boot_key = NULL; size_t boot_key_len = 0; + WolfCertServer* srv = NULL; + WolfCertBuffer ca_der = { 0 }; + WolfCertBuffer ca_key = { 0 }; + uint8_t* bundle = NULL; + size_t bundle_cap; + pthread_t tid; + char url[128]; + int pem_len; + + REQUIRE(wolfcert_init(NULL) == WOLFCERT_OK); + REQUIRE(wc_CryptoCb_RegisterDevice(MOCK_DEVID, mock_cb, NULL) == 0); + REQUIRE(test_cfg_errors() == 0); + + REQUIRE(mint_self_id("127.0.0.1", 0, &tls_cert, &tls_cert_len, + &tls_key, &tls_key_len) == 0); + REQUIRE(mint_self_id("factory-bootstrap", 1, &boot_cert, &boot_cert_len, + &boot_key, &boot_key_len) == 0); + + WolfCertServerCfgSrv cfg = { + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .bind_port = 0, + .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, + .tls_client_ca_pem = boot_cert, .tls_client_ca_pem_len = boot_cert_len, + }; + + /* Mint the CA first so the server can also trust the certs it issues. */ + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &ca_der, + &ca_key) == WOLFCERT_OK); + wolfcert_server_free(srv); + srv = NULL; + cfg.ca_cert = ca_der.data; + cfg.ca_cert_len = ca_der.len; + cfg.ca_key = ca_key.data; + cfg.ca_key_len = ca_key.len; + + bundle_cap = boot_cert_len + ca_der.len * 2 + 256; + bundle = (uint8_t*)malloc(bundle_cap); + REQUIRE(bundle != NULL); + memcpy(bundle, boot_cert, boot_cert_len); + pem_len = wc_DerToPem(ca_der.data, (word32)ca_der.len, + bundle + boot_cert_len, + (word32)(bundle_cap - boot_cert_len), CERT_TYPE); + REQUIRE(pem_len > 0); + cfg.tls_client_ca_pem = bundle; + cfg.tls_client_ca_pem_len = boot_cert_len + (size_t)pem_len; + + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + +#ifdef WOLFCERT_HAVE_ECC + REQUIRE(run_key_type(url, WOLFCERT_KEY_ECC, 256, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); +#endif +#ifdef WOLFCERT_HAVE_RSA + REQUIRE(run_key_type(url, WOLFCERT_KEY_RSA, 2048, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); +#endif +#ifdef WOLFCERT_HAVE_MLDSA +#ifndef WOLFSSL_NO_ML_DSA_44 + REQUIRE(run_key_type(url, WOLFCERT_KEY_MLDSA44, 0, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); +#endif +#ifndef WOLFSSL_NO_ML_DSA_65 + REQUIRE(run_key_type(url, WOLFCERT_KEY_MLDSA65, 0, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); +#endif +#ifndef WOLFSSL_NO_ML_DSA_87 + REQUIRE(run_key_type(url, WOLFCERT_KEY_MLDSA87, 0, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); +#endif +#endif + REQUIRE(test_client_key_src(url, tls_cert, tls_cert_len, boot_cert, + boot_cert_len, boot_key, boot_key_len) == 0); + + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + wolfcert_buffer_free(&ca_der); + wolfcert_buffer_free_secure(&ca_key); + free(bundle); + free(tls_cert); + free(tls_key); + free(boot_cert); + free(boot_key); + wc_CryptoCb_UnRegisterDevice(MOCK_DEVID); + wolfcert_cleanup(); + printf("est_devid_roundtrip: OK\n"); + return 0; +} +#endif From 172b2392baed5f3868d997c9bb05151163ffcfe0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Wed, 14 Oct 2026 14:07:09 +0200 Subject: [PATCH 08/17] Document key_id for CryptoCb-resident keys ARCHITECTURE section 4.2 showed a key_label and said every operation on a dev_id key, including TLS client auth and SCEP signing, ran in the backend, and told integrators to persist the label. It now shows key_id, says which operations reach the backend, that the backend must also serve public operations on the id, and that a dev_id without a key_id only offloads the computation while the key stays in host memory and can be exported. A table lists the three client_key_src values for TLS client authentication. It says the key cannot be exported, that TLS client auth needs only the id and the certificate while re-enrollment rebuilds a handle with wolfcert_key_from_id, that Ed25519, Ed448 and SCEP do not support a key_id yet, and that a key_id needs WOLF_CRYPTO_CB and WOLF_PRIVATE_KEY_ID. Section 4.7, CONTRIBUTING.md, the AGENTS.md porting hooks and the wolfSCEP migration guide follow. --- AGENTS.md | 2 +- CONTRIBUTING.md | 2 +- docs/ARCHITECTURE.md | 70 ++++++++++++++++++++++++++------- docs/MIGRATING-FROM-WOLFSCEP.md | 2 +- 4 files changed, 59 insertions(+), 17 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 6113650..dc6e54d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -205,7 +205,7 @@ contract, alone or in a group comment. | Static memory / custom heap | `wolfcert_init(heap)` sets the default heap hint; per-call `heap` fields override it, and the hint reaches every wolfSSL call | `wolfcert/memory.h`, README "Integrating with a wolfSSL static-memory pool" | | Network stack without BSD sockets (lwIP, NetX, FreeRTOS+TCP, wolfIP) | Fill `WolfCertServerCfg.transport` (`WolfCertTransport`); TLS records go through it too | `wolfcert/types.h`, `docs/EMBEDDED.md` section 7 | | Persistence in flash / NVM | Store the buffers from `wolfcert_key_to_pem` / `_to_der` and the enroll result; wolfCert does no storage | `wolfcert/keygen.h` | -| Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id` | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | +| Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id`, and the key's backend id as `key_id`; `WolfCertServerCfg.client_key_src` selects such a key for mTLS | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | | Event loop / no blocking | `wolfcert_est_session_open` / `wolfcert_scep_session_open`, then the `_nb` calls until they stop returning `WOLFCERT_ERR_WANT_READ` / `_WANT_WRITE`; `*_session_fd` gives the descriptor to poll | `wolfcert/est.h`, `wolfcert/scep.h` | | Logging | `wolfcert_set_log_cb` (e.g. to a UART) | `wolfcert/log.h` | | RAM budget | `max_response_bytes`, HTTP stack buffers, wolfSSL `Cert` / `CertName` sizing | `docs/EMBEDDED.md` | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4640c67..fa7f910 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,7 +102,7 @@ Email **support@wolfssl.com** instead, and please keep the issue private until a `README.md` has the build and test steps, `docs/ARCHITECTURE.md` the module layout, and `AGENTS.md` the wolfSSL features wolfCert needs. On top of the rules above, wolfCert asks for: - **Heap hints on every allocation.** Allocate through `WOLFCERT_XMALLOC`, `WOLFCERT_XREALLOC` and `WOLFCERT_XFREE` from `wolfcert/memory.h` and pass the hint on to wolfSSL. A public API takes an optional `heap`, directly or in its config struct, and falls back to `wolfcert_default_heap()` when it is NULL. -- **No CryptoCb registration.** wolfCert never calls `wc_CryptoCb_RegisterDevice`; the application registers its backend and passes the `dev_id` in `WolfCertKeyCfg`. +- **No CryptoCb registration.** wolfCert never calls `wc_CryptoCb_RegisterDevice`; the application registers its backend and passes the `dev_id` in `WolfCertKeyCfg`. A backend-resident key is named by `WolfCertKeyCfg.key_id` (`wc_*_init_id`), never by a label, and is never exported. - **A closed set of error codes.** Report every error with `WOLFCERT_ERR`, `WOLFCERT_ERR_WC` or `WOLFCERT_ERR_RC_WC` from `src/internal.h`, and keep `wolfcert_strerror` covering every code in `wolfcert/errors.h`. - **Visibility.** Public and internal functions both use the `wolfcert_` prefix. The CMake build hides every symbol by default, so public prototypes in `wolfcert/*.h` carry `WOLFCERT_API`. Mark an internal function that the in-tree tests call `WOLFCERT_TEST_VIS`, which exports it only in a `WOLFCERT_BUILD_TESTING` build. - **Append-only public structs.** The v0.1.0 ABI is released, so a new field in a public struct goes at its end. diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index a5d1531..b567412 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -323,29 +323,69 @@ hosts. ### 4.2 CryptoCb offload (TPM / HSM / PKCS#11 / custom) wolfCert uses wolfSSL's CryptoCb `devId` as an opaque token. The application -registers the backend; wolfCert threads the devId through every crypto call: +registers the backend; wolfCert threads the devId into every key it creates: ```c /* Application startup: register the CryptoCb with wolfSSL. */ wc_CryptoCb_RegisterDevice(MY_DEVID, my_callback, my_ctx); -/* Generate a key that lives behind the CryptoCb. */ +/* Generate a key inside the backend, under an id the backend defines. */ +static const uint8_t id[] = { 0x01, 0x80, 0x00, 0x01 }; WolfCertKeyCfg cfg = { - .type = WOLFCERT_KEY_ECC, - .param = 256, - .dev_id = MY_DEVID, - .key_label = "tpm:/handles/0x01800001", /* optional */ + .type = WOLFCERT_KEY_ECC, + .param = 256, + .dev_id = MY_DEVID, + .key_id = id, + .key_id_len = sizeof(id), }; WolfCertKey* key; wolfcert_key_generate(&cfg, &key); ``` -From there, every wolfSSL crypto call on the key — CSR signing, TLS handshake -client-auth, SCEP pkiMessage signing — routes through `my_callback`. Pass -`WOLFCERT_DEVID_SOFTWARE` (`-1`) to force software operation. CryptoCb-resident -keys typically can't be exported in PEM, so `wolfcert_key_to_pem` will fail; -persist the key by its `key_label` instead and resolve it against your backend -on the next boot. See `examples/enroll_cryptocb.c` for a full example. +The `key_id` bytes are opaque to wolfCert. They reach the backend in the +wolfCrypt key's `id` field, the same way wolfPKCS11, wolfHSM and the hardware +ports name their keys, and the backend decides what they mean (a PKCS#11 +`CKA_ID`, a TPM handle, a key-store slot). The backend generates the key there +and returns only its public half. + +From there, every private-key operation on the key routes through +`my_callback`: CSR signing, and TLS client authentication by id or for EST +`/simplereenroll`. wolfSSL also hands the backend public-key operations on +that id, such as the check of its own RSA signature in TLS, so the backend +must serve those too. Pass `WOLFCERT_DEVID_SOFTWARE` (`-1`) to force software +operation. + +A `dev_id` without a `key_id` only offloads the computation. The key itself +is an ordinary wolfCrypt key in host memory, and `wolfcert_key_to_pem` exports +it. Only a `key_id` keeps the key in the backend. + +For TLS client authentication, `WolfCertServerCfg.client_key_src` says what +`client_key` holds and where the handshake signs with it: + +| `client_key_src` | `client_key` holds | Signed | +|---|---|---| +| `WOLFCERT_CLIENT_KEY_BUFFER` (default) | PEM or DER | in software | +| `WOLFCERT_CLIENT_KEY_ID` | the key id | in `client_key_dev_id` | + +EST `/simplereenroll` picks the source from the key being renewed. + +A key with a `key_id` never leaves the backend: `wolfcert_key_to_pem` and +`wolfcert_key_to_der` fail with `WOLFCERT_ERR_UNSUPPORTED`. Persist the id and +the issued certificate instead. TLS client authentication needs only those +two: the certificate in `client_cert` and the id in `client_key`, with +`client_key_src = WOLFCERT_CLIENT_KEY_ID` and the device in +`client_key_dev_id`. A source other than `_BUFFER` without the certificate +and key returns `WOLFCERT_ERR_BAD_ARG`. Re-enrollment also needs a key +handle, because the CSR carries the public key: +rebuild it with `wolfcert_key_from_id(&cfg, cert, cert_len, &key)`, which takes +the public half from the certificate since a backend need not be able to +return it. + +RSA, ECC and ML-DSA keys take a `key_id`; Ed25519 and Ed448 do not yet. SCEP +does not support a `key_id` key: its PKCS#7 signing and decryption take the +private key as DER, so the SCEP calls return `WOLFCERT_ERR_UNSUPPORTED`. A +`key_id` needs wolfSSL built with `WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`. +See `examples/enroll_cryptocb.c` for the registration pattern. ### 4.3 Keep-alive sessions and non-blocking I/O @@ -575,7 +615,8 @@ wolfcert_set_log_cb(my_log, NULL); /* 2. Key generation (stays in hardware) */ WolfCertKey* key; WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = MY_DEVID }; + .dev_id = MY_DEVID, + .key_id = my_key_id, .key_id_len = my_key_id_len }; wolfcert_key_generate(&kcfg, &key); /* 3. CSR build */ @@ -602,7 +643,8 @@ wolfcert_est_session_open(&srv, &s); run_nb_loop(s); /* pattern from section 4.3 */ wolfcert_est_session_close(s); -/* 5. Persist the certificate; the key stays behind the CryptoCb */ +/* 5. Persist the certificate; the key stays behind the CryptoCb, and + * wolfcert_key_from_id rebuilds the handle for re-enrollment */ flash_write("device.crt", cert.data, cert.len); /* 6. Shutdown */ diff --git a/docs/MIGRATING-FROM-WOLFSCEP.md b/docs/MIGRATING-FROM-WOLFSCEP.md index 8d5fcc5..51c06e1 100644 --- a/docs/MIGRATING-FROM-WOLFSCEP.md +++ b/docs/MIGRATING-FROM-WOLFSCEP.md @@ -190,7 +190,7 @@ Link against `libwolfcert` and include ``, which pulls in t - **EST (RFC 7030)** for the same lifecycle over TLS, with ECC, Ed25519, Ed448 and ML-DSA keys, none of which SCEP permits. - **Keep-alive sessions with `_nb` calls**, so several operations share one connection and an event loop can drive them through `WOLFCERT_ERR_WANT_READ` and `WOLFCERT_ERR_WANT_WRITE`. -- **CryptoCb offload.** Register your TPM, HSM or PKCS#11 backend with wolfSSL and pass the resulting `dev_id` in `WolfCertKeyCfg`; the private key never has to be in memory. +- **CryptoCb offload.** Register your TPM, HSM or PKCS#11 backend with wolfSSL and pass the resulting `dev_id` in `WolfCertKeyCfg`. With the key's `key_id` as well, the private key stays in the backend (`docs/ARCHITECTURE.md` section 4.2). SCEP itself still needs a software key. - **Static memory.** Every allocation carries a heap hint, so wolfCert runs on a wolfSSL built `WOLFSSL_NO_MALLOC` with a static pool. - **A tested interop matrix**, described in `INTEROP.md`. From 9460f9d2e0c46381d52b69470c4237905945d918 Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sat, 17 Oct 2026 12:26:47 +0000 Subject: [PATCH 09/17] Support key ids for Ed25519 and Ed448 wolfSSL now has wc_ed25519_init_id and wc_ed448_init_id, and its TLS layer builds Ed25519 and Ed448 device keys for wolfSSL_CTX_use_PrivateKey_Id. wolfCert refused a key_id for both because neither existed. When wolfSSL defines ED25519_MAX_ID_LEN or ED448_MAX_ID_LEN, which come with those functions, key generation and wolfcert_key_from_id pass the id to them, and the key algorithm table gains the pub_decode and host_priv entries for both. A version check would not do: wolfSSL master still reports 5.9.4. Older wolfSSL keeps returning WOLFCERT_ERR_UNSUPPORTED. wolfSSL does not hand Ed448 key generation to a CryptoCb yet, so it runs in software and the host_priv check refuses the key. An Ed448 key that already exists in the backend works through wolfcert_key_from_id, and generation needs no change here once wolfSSL dispatches it. The mock key store in test_est_devid_roundtrip generates and signs Ed25519 keys and signs Ed448 ones. Ed25519 runs the same flow as the other types; Ed448 checks that generation is refused, provisions a key in the store with a self-signed certificate, and continues from wolfcert_key_from_id. Both skip on a wolfSSL without the id init. test_keygen also checks that a declined Ed25519 generation is refused. --- docs/ARCHITECTURE.md | 12 +- src/key_algs.c | 75 ++++++++- tests/integration/test_est_devid_roundtrip.c | 153 ++++++++++++++++++- tests/unit/test_keygen.c | 6 +- 4 files changed, 231 insertions(+), 15 deletions(-) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index b567412..e378a26 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -381,11 +381,13 @@ rebuild it with `wolfcert_key_from_id(&cfg, cert, cert_len, &key)`, which takes the public half from the certificate since a backend need not be able to return it. -RSA, ECC and ML-DSA keys take a `key_id`; Ed25519 and Ed448 do not yet. SCEP -does not support a `key_id` key: its PKCS#7 signing and decryption take the -private key as DER, so the SCEP calls return `WOLFCERT_ERR_UNSUPPORTED`. A -`key_id` needs wolfSSL built with `WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`. -See `examples/enroll_cryptocb.c` for the registration pattern. +RSA, ECC and ML-DSA keys take a `key_id`. Ed25519 and Ed448 keys take one +with a wolfSSL newer than 5.9.4, which has `wc_ed25519_init_id` and +`wc_ed448_init_id`. SCEP does not support a `key_id` key: its PKCS#7 +signing and decryption take the private key as DER, so the SCEP calls return +`WOLFCERT_ERR_UNSUPPORTED`. A `key_id` needs wolfSSL built with +`WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`. See `examples/enroll_cryptocb.c` +for the registration pattern. ### 4.3 Keep-alive sessions and non-blocking I/O diff --git a/src/key_algs.c b/src/key_algs.c index 9e33b91..643fb96 100644 --- a/src/key_algs.c +++ b/src/key_algs.c @@ -351,20 +351,33 @@ static void ecc_free(struct WolfCertKey* k) #endif /* WOLFCERT_HAVE_ECC */ #ifdef WOLFCERT_HAVE_ED25519 +/* wolfSSL after 5.9.4 has wc_ed25519_init_id and the TLS support for it. */ +#if defined(WOLFCERT_USE_KEY_ID) && defined(ED25519_MAX_ID_LEN) +#define WOLFCERT_ED25519_KEY_ID +#endif + static int ed25519_alloc_init(struct WolfCertKey* k) { +#ifndef WOLFCERT_ED25519_KEY_ID if (k->id_len > 0) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", - "wolfSSL has no key_id init for Ed25519"); + "this wolfSSL has no key_id init for Ed25519"); +#endif ed25519_key* ek = (ed25519_key*)WOLFCERT_XMALLOC(sizeof(*ek), k->heap); if (ek == NULL) return WOLFCERT_ERR_MEMORY; - int rc = wc_ed25519_init_ex(ek, k->heap, k->dev_id); + int rc; +#ifdef WOLFCERT_ED25519_KEY_ID + if (k->id_len > 0) + rc = wc_ed25519_init_id(ek, k->id, (int)k->id_len, k->heap, k->dev_id); + else +#endif + rc = wc_ed25519_init_ex(ek, k->heap, k->dev_id); if (rc != 0) { WOLFCERT_XFREE(ek, k->heap); - return WOLFCERT_ERR_WC(rc, "keygen", "ed25519_init_ex"); + return WOLFCERT_ERR_WC(rc, "keygen", "ed25519_init"); } k->impl = ek; @@ -392,6 +405,21 @@ static int ed25519_priv_to_der(const struct WolfCertKey* k, uint8_t* buf, word32 return wc_Ed25519PrivateKeyToDer((ed25519_key*)k->impl, buf, cap); } +#ifdef WOLFCERT_ED25519_KEY_ID +static int ed25519_pub_decode(struct WolfCertKey* k, const uint8_t* der, + word32 len) +{ + word32 idx = 0; + return wc_Ed25519PublicKeyDecode(der, &idx, (ed25519_key*)k->impl, len) == 0 + ? WOLFCERT_OK : WOLFCERT_ERR_PARSE; +} + +static int ed25519_host_priv(const struct WolfCertKey* k) +{ + return ((ed25519_key*)k->impl)->privKeySet; +} +#endif + static int ed25519_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) { @@ -423,20 +451,32 @@ static void ed25519_free(struct WolfCertKey* k) #endif #ifdef WOLFCERT_HAVE_ED448 +#if defined(WOLFCERT_USE_KEY_ID) && defined(ED448_MAX_ID_LEN) +#define WOLFCERT_ED448_KEY_ID +#endif + static int ed448_alloc_init(struct WolfCertKey* k) { +#ifndef WOLFCERT_ED448_KEY_ID if (k->id_len > 0) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", - "wolfSSL has no key_id init for Ed448"); + "this wolfSSL has no key_id init for Ed448"); +#endif ed448_key* ek = (ed448_key*)WOLFCERT_XMALLOC(sizeof(*ek), k->heap); if (ek == NULL) return WOLFCERT_ERR_MEMORY; - int rc = wc_ed448_init_ex(ek, k->heap, k->dev_id); + int rc; +#ifdef WOLFCERT_ED448_KEY_ID + if (k->id_len > 0) + rc = wc_ed448_init_id(ek, k->id, (int)k->id_len, k->heap, k->dev_id); + else +#endif + rc = wc_ed448_init_ex(ek, k->heap, k->dev_id); if (rc != 0) { WOLFCERT_XFREE(ek, k->heap); - return WOLFCERT_ERR_WC(rc, "keygen", "ed448_init_ex"); + return WOLFCERT_ERR_WC(rc, "keygen", "ed448_init"); } k->impl = ek; @@ -463,6 +503,21 @@ static int ed448_priv_to_der(const struct WolfCertKey* k, uint8_t* buf, word32 c return wc_Ed448PrivateKeyToDer((ed448_key*)k->impl, buf, cap); } +#ifdef WOLFCERT_ED448_KEY_ID +static int ed448_pub_decode(struct WolfCertKey* k, const uint8_t* der, + word32 len) +{ + word32 idx = 0; + return wc_Ed448PublicKeyDecode(der, &idx, (ed448_key*)k->impl, len) == 0 + ? WOLFCERT_OK : WOLFCERT_ERR_PARSE; +} + +static int ed448_host_priv(const struct WolfCertKey* k) +{ + return ((ed448_key*)k->impl)->privKeySet; +} +#endif + static int ed448_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) { @@ -650,6 +705,10 @@ static const WolfCertKeyAlg ALG_ED25519 = { .priv_decode = ed25519_priv_decode, .priv_to_der = ed25519_priv_to_der, .pub_check = ed25519_pub_check, +#ifdef WOLFCERT_ED25519_KEY_ID + .pub_decode = ed25519_pub_decode, + .host_priv = ed25519_host_priv, +#endif .free_ = ed25519_free, }; #endif @@ -667,6 +726,10 @@ static const WolfCertKeyAlg ALG_ED448 = { .priv_decode = ed448_priv_decode, .priv_to_der = ed448_priv_to_der, .pub_check = ed448_pub_check, +#ifdef WOLFCERT_ED448_KEY_ID + .pub_decode = ed448_pub_decode, + .host_priv = ed448_host_priv, +#endif .free_ = ed448_free, }; #endif diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c index 344ab5c..d02abbd 100644 --- a/tests/integration/test_est_devid_roundtrip.c +++ b/tests/integration/test_est_devid_roundtrip.c @@ -63,7 +63,15 @@ int main(void) #define MOCK_DEVID 0x6d6b #define MOCK_SLOTS 4 -enum { MOCK_ECC = 1, MOCK_RSA, MOCK_MLDSA }; +enum { MOCK_ECC = 1, MOCK_RSA, MOCK_MLDSA, MOCK_ED25519, MOCK_ED448 }; + +/* wolfSSL after 5.9.4 can name Ed25519 and Ed448 keys by id. */ +#if defined(WOLFCERT_HAVE_ED25519) && defined(ED25519_MAX_ID_LEN) +#define MOCK_HAVE_ED25519 +#endif +#if defined(WOLFCERT_HAVE_ED448) && defined(ED448_MAX_ID_LEN) +#define MOCK_HAVE_ED448 +#endif typedef struct { byte id[WOLFCERT_KEY_ID_MAX_LEN]; @@ -78,6 +86,12 @@ typedef struct { #ifdef WOLFCERT_HAVE_MLDSA MlDsaKey mldsa; #endif +#ifdef MOCK_HAVE_ED25519 + ed25519_key ed25519; +#endif +#ifdef MOCK_HAVE_ED448 + ed448_key ed448; +#endif } MockSlot; static MockSlot mock_slots[MOCK_SLOTS]; @@ -255,12 +269,113 @@ static int mock_cb(int devId, wc_CryptoInfo* info, void* ctx) mock_private_ops++; return rc; } +#endif +#ifdef MOCK_HAVE_ED25519 + case WC_PK_TYPE_ED25519_KEYGEN: { + ed25519_key* key = info->pk.ed25519kg.key; + byte pub[ED25519_PUB_KEY_SIZE]; + word32 pub_len = sizeof(pub); + MockSlot* s; + int rc; + + if (key->idLen == 0) + return CRYPTOCB_UNAVAILABLE; + s = mock_new(key->id, key->idLen, MOCK_ED25519); + if (s == NULL) + return BAD_STATE_E; + rc = wc_ed25519_init_ex(&s->ed25519, NULL, INVALID_DEVID); + if (rc == 0) + rc = wc_ed25519_make_key(info->pk.ed25519kg.rng, + info->pk.ed25519kg.size, &s->ed25519); + if (rc == 0) + rc = wc_ed25519_export_public(&s->ed25519, pub, &pub_len); + if (rc == 0) + rc = wc_ed25519_import_public(pub, pub_len, key); + if (rc == 0) + mock_keygens++; + return rc; + } + case WC_PK_TYPE_ED25519_SIGN: { + ed25519_key* key = info->pk.ed25519sign.key; + MockSlot* s = mock_find(key->id, key->idLen); + int rc; + + mock_sign_requests++; + if (s == NULL || s->type != MOCK_ED25519) + return CRYPTOCB_UNAVAILABLE; + rc = wc_ed25519_sign_msg_ex(info->pk.ed25519sign.in, + info->pk.ed25519sign.inLen, + info->pk.ed25519sign.out, + info->pk.ed25519sign.outLen, &s->ed25519, + info->pk.ed25519sign.type, + info->pk.ed25519sign.context, + info->pk.ed25519sign.contextLen); + if (rc == 0) + mock_private_ops++; + return rc; + } +#endif +#ifdef MOCK_HAVE_ED448 + case WC_PK_TYPE_ED448: { + ed448_key* key = info->pk.ed448sign.key; + MockSlot* s = mock_find(key->id, key->idLen); + int rc; + + mock_sign_requests++; + if (s == NULL || s->type != MOCK_ED448) + return CRYPTOCB_UNAVAILABLE; + rc = wc_ed448_sign_msg_ex(info->pk.ed448sign.in, + info->pk.ed448sign.inLen, + info->pk.ed448sign.out, + info->pk.ed448sign.outLen, &s->ed448, + info->pk.ed448sign.type, + info->pk.ed448sign.context, + info->pk.ed448sign.contextLen); + if (rc == 0) + mock_private_ops++; + return rc; + } #endif default: return CRYPTOCB_UNAVAILABLE; } } +#ifdef MOCK_HAVE_ED448 +/* Provisions the store's key out of band, since not every wolfSSL with Ed448 + * key ids passes Ed448 keygen to a CryptoCb. */ +static int mock_provision_ed448(const byte* id, int id_len, byte* cert, + int* cert_len) +{ + MockSlot* s = mock_new(id, id_len, MOCK_ED448); + Cert c; + WC_RNG rng; + int n; + + if (s == NULL || wc_InitRng(&rng) != 0) + return -1; + n = wc_ed448_init_ex(&s->ed448, NULL, INVALID_DEVID); + if (n == 0) + n = wc_ed448_make_key(&rng, ED448_KEY_SIZE, &s->ed448); + if (n == 0) + n = wc_InitCert(&c); + if (n == 0) { + strncpy(c.subject.commonName, "ed448-provisioned", CTC_NAME_SIZE - 1); + c.sigType = CTC_ED448; + n = wc_MakeCert_ex(&c, cert, (word32)*cert_len, ED448_TYPE, &s->ed448, + &rng); + } + if (n > 0) + n = wc_SignCert_ex(c.bodySz, c.sigType, cert, (word32)*cert_len, + ED448_TYPE, &s->ed448, &rng); + wc_FreeRng(&rng); + if (n <= 0) + return -1; + *cert_len = n; + return 0; +} +#endif + static void mock_reset(void) { for (int i = 0; i < MOCK_SLOTS; i++) { @@ -275,6 +390,14 @@ static void mock_reset(void) #ifdef WOLFCERT_HAVE_MLDSA if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_MLDSA) wc_MlDsaKey_Free(&mock_slots[i].mldsa); +#endif +#ifdef MOCK_HAVE_ED25519 + if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_ED25519) + wc_ed25519_free(&mock_slots[i].ed25519); +#endif +#ifdef MOCK_HAVE_ED448 + if (mock_slots[i].id_len > 0 && mock_slots[i].type == MOCK_ED448) + wc_ed448_free(&mock_slots[i].ed448); #endif } memset(mock_slots, 0, sizeof(mock_slots)); @@ -307,7 +430,7 @@ static int test_cfg_errors(void) cfg.key_id_len = 4; REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); -#ifdef WOLFCERT_HAVE_ED25519 +#if defined(WOLFCERT_HAVE_ED25519) && !defined(MOCK_HAVE_ED25519) cfg.type = WOLFCERT_KEY_ED25519; cfg.key_id = id; cfg.key_id_len = sizeof(id) - 1; @@ -357,6 +480,20 @@ static int run_key_type(const char* url, WolfCertKeyType type, int param, mock_keygens = 0; mock_private_ops = 0; +#ifdef MOCK_HAVE_ED448 + if (type == WOLFCERT_KEY_ED448) { + static byte prov[1024]; + int prov_len = sizeof(prov); + + REQUIRE(wolfcert_key_generate(&kcfg, &key) == + WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(mock_provision_ed448(id, sizeof(id) - 1, prov, &prov_len) == 0); + REQUIRE(wolfcert_key_from_id(&kcfg, prov, (size_t)prov_len, &key) == + WOLFCERT_OK); + mock_keygens++; + } + else +#endif REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); REQUIRE(mock_keygens == 1); REQUIRE(wolfcert_key_id(key, &got_id, &got_len) == WOLFCERT_OK); @@ -719,8 +856,18 @@ int main(void) #endif #ifndef WOLFSSL_NO_ML_DSA_87 REQUIRE(run_key_type(url, WOLFCERT_KEY_MLDSA87, 0, tls_cert, tls_cert_len, - boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); #endif +#endif +#ifdef MOCK_HAVE_ED25519 + REQUIRE(run_key_type(url, WOLFCERT_KEY_ED25519, 0, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); +#endif +#ifdef MOCK_HAVE_ED448 + REQUIRE(run_key_type(url, WOLFCERT_KEY_ED448, 0, tls_cert, tls_cert_len, + boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); #endif REQUIRE(test_client_key_src(url, tls_cert, tls_cert_len, boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index ad30cab..5897d27 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -150,6 +150,10 @@ static int key_id_cases(void) if (key_id_declined(WOLFCERT_KEY_MLDSA87, 0)) return 1; #endif +#endif +#if defined(WOLFCERT_HAVE_ED25519) && defined(ED25519_MAX_ID_LEN) + if (key_id_declined(WOLFCERT_KEY_ED25519, 0)) + return 1; #endif cfg.dev_id = DECLINE_DEVID; @@ -278,7 +282,7 @@ static int key_id_cases(void) #endif } #endif -#ifdef WOLFCERT_HAVE_ED25519 +#if defined(WOLFCERT_HAVE_ED25519) && !defined(ED25519_MAX_ID_LEN) cfg.type = WOLFCERT_KEY_ED25519; cfg.param = 0; REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == From ea35309b40592a2e9e39543bb0675a40d69f2b2c Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sat, 17 Oct 2026 17:14:40 +0000 Subject: [PATCH 10/17] Bump the shared library version to 1 Removing WolfCertKeyCfg.key_label, and appending fields to WolfCertKeyCfg, WolfCertServerCfg, WolfCertHttpRequest and WolfCertHttpSessionCfg, changes struct layouts that the library and its callers share. A binary built against the v0.1.0 libwolfcert.so.0 must not load this one. Autoconf moves to -version-info 1:0:0, since an interface was removed. CMake now sets VERSION and SOVERSION itself rather than deriving them from the project version, so both build systems install libwolfcert.so.1.0.0 with soname libwolfcert.so.1. Before, CMake named the file after the project version (0.1.0) and autoconf after libtool's (0.0.0). The release version stays 0.1.0. The two are set by hand in two files, so the build-system parity check now fails when CMake's VERSION or SOVERSION differs from what libtool derives from -version-info. CONTRIBUTING.md's append-only rule for public structs now holds within one shared library version, and removing or moving a field takes a version bump. --- CMakeLists.txt | 4 ++-- CONTRIBUTING.md | 2 +- Makefile.am | 2 +- docs/CI.md | 2 +- scripts/ci/check-buildsystem-parity.sh | 22 +++++++++++++++++++--- 5 files changed, 24 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 1444a0d..5b530de 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -373,8 +373,8 @@ endif() add_library(wolfCert::wolfcert ALIAS wolfcert) set_target_properties(wolfcert PROPERTIES - VERSION ${PROJECT_VERSION} - SOVERSION ${PROJECT_VERSION_MAJOR} + VERSION 1.0.0 + SOVERSION 1 C_VISIBILITY_PRESET hidden) target_include_directories(wolfcert diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa7f910..d6483f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,7 +105,7 @@ Email **support@wolfssl.com** instead, and please keep the issue private until a - **No CryptoCb registration.** wolfCert never calls `wc_CryptoCb_RegisterDevice`; the application registers its backend and passes the `dev_id` in `WolfCertKeyCfg`. A backend-resident key is named by `WolfCertKeyCfg.key_id` (`wc_*_init_id`), never by a label, and is never exported. - **A closed set of error codes.** Report every error with `WOLFCERT_ERR`, `WOLFCERT_ERR_WC` or `WOLFCERT_ERR_RC_WC` from `src/internal.h`, and keep `wolfcert_strerror` covering every code in `wolfcert/errors.h`. - **Visibility.** Public and internal functions both use the `wolfcert_` prefix. The CMake build hides every symbol by default, so public prototypes in `wolfcert/*.h` carry `WOLFCERT_API`. Mark an internal function that the in-tree tests call `WOLFCERT_TEST_VIS`, which exports it only in a `WOLFCERT_BUILD_TESTING` build. -- **Append-only public structs.** The v0.1.0 ABI is released, so a new field in a public struct goes at its end. +- **Append-only public structs.** Within one shared library version, a new field in a public struct goes at its end; removing or moving a field needs a version bump. - **License header.** Every `.c` and `.h` file opens with the full GPL copyright block, copied from an existing source file; the Lint workflow checks it. Build files (`CMakeLists.txt`, `configure.ac`, `Makefile.am`) use the `SPDX-License-Identifier: GPL-3.0-or-later` line instead. - **Include order.** The module's own headers (``, `"internal.h"`) first, then wolfSSL, then system headers. - **Both build systems.** CMake and autoconf are kept at parity. A new source file goes into `CMakeLists.txt` and `Makefile.am` (or `zephyr/include.am` for Zephyr files), and a new non-source file into `EXTRA_DIST`. `scripts/ci/check-buildsystem-parity.sh` checks the library source lists. diff --git a/Makefile.am b/Makefile.am index 52c6213..d6d5335 100644 --- a/Makefile.am +++ b/Makefile.am @@ -52,7 +52,7 @@ endif endif libwolfcert_la_LIBADD = $(WOLFSSL_LIBS) -libwolfcert_la_LDFLAGS = -version-info 0:0:0 -no-undefined +libwolfcert_la_LDFLAGS = -version-info 1:0:0 -no-undefined wolfcertincludedir = $(includedir)/wolfcert wolfcertinclude_HEADERS = \ diff --git a/docs/CI.md b/docs/CI.md index 68df898..59b5aeb 100644 --- a/docs/CI.md +++ b/docs/CI.md @@ -12,7 +12,7 @@ set skips the wolfSSL build entirely. | Workflow | Trigger | What it does | |----------|---------|--------------| | `pr.yml` | PR + push | Merge gate: CMake (`-Werror`) + autoconf + ASan/UBSan on the canonical config, the same config against the minimum wolfSSL release (`cmake-full-floor`), plus per-PR feature/config gating — EST-only, SCEP-only, server-off, the key-alg variants (NO_RSA, ECC-only, RSA-only, no-3DES), TLS 1.3-only, the three ML-DSA per-level builds, the static-memory and no-malloc constrained builds, the platform-pieces-off build (`cmake-no-builtin-transport`), the freestanding ARM compile and config-resolution check (`no-posix-arm`), the header-only (`WOLFCERT_USER_SETTINGS`) build, a macOS build, and the two cheapest configure-must-fail assertions. | -| `lint.yml` | PR + push | GPL license-header check and CMake↔autoconf parity of both the library and test source lists, plus the Zephyr module's library list and the version in `configure.ac`, `CMakeLists.txt` and `wolfcert/version.h` (`scripts/ci/check-buildsystem-parity.sh`). No wolfSSL build, so it fails in seconds. | +| `lint.yml` | PR + push | GPL license-header check and CMake↔autoconf parity of both the library and test source lists and of the shared library version, plus the Zephyr module's library list and the version in `configure.ac`, `CMakeLists.txt` and `wolfcert/version.h` (`scripts/ci/check-buildsystem-parity.sh`). No wolfSSL build, so it fails in seconds. | | `sbom.yml` | PR + push | Generates the SBOM with `make sbom` and `cmake --build --target sbom` against the `full` wolfSSL config, from `options.h` and from `examples/user_settings.h.example`, checks each with `tools/sbom/validate_sbom.py`, `pyspdxtools` and `scripts/ci/check-sbom.py` (identity, license, hash source, that the library hash matches a real `make install` / `cmake --install`, the `options.h` feature set, the wolfSSL dependency version, no host paths), checks that a second run is byte-identical and that both build systems and both configuration modes record the same configuration, and checks `tools/sbom/` against its pinned wolfssl-compliance-tooling commit. See [`SBOM.md`](SBOM.md). | | `nightly.yml` | schedule + dispatch | Re-runs the wolfSSL-variant build matrix against fresh wolfSSL `master`, the macOS extras, and the full negative-config set. Also **reseeds the wolfSSL prefix caches** so the next day's PRs restore instead of build. The feature/config gating itself now runs per-PR (see `pr.yml`). | | `sanitizers.yml` | schedule + dispatch | ASan+UBSan over the full test suite, ThreadSanitizer over the threaded integration roundtrips (against a TSAN-instrumented wolfSSL), and valgrind over a representative subset. | diff --git a/scripts/ci/check-buildsystem-parity.sh b/scripts/ci/check-buildsystem-parity.sh index d4f1f71..d952c4d 100755 --- a/scripts/ci/check-buildsystem-parity.sh +++ b/scripts/ci/check-buildsystem-parity.sh @@ -2,7 +2,8 @@ # SPDX-License-Identifier: GPL-3.0-or-later # # Fail on library or test source drift between CMake and autoconf, Zephyr -# module sources that differ from the client set, or a version mismatch. +# module sources that differ from the client set, or a version or shared +# library version mismatch. set -euo pipefail @@ -84,10 +85,25 @@ if [ -z "$am_ver" ] || [ "$am_ver" != "$cmake_ver" ] || \ status=1 fi +# Libtool's -version-info C:R:A installs libwolfcert.so.... +lt="$(sed -n 's/.*-version-info \([0-9]*:[0-9]*:[0-9]*\).*/\1/p' "$ROOT/Makefile.am")" +IFS=: read -r lt_c lt_r lt_a <<<"$lt" +lt_so=$((lt_c - lt_a)) +lt_ver="$lt_so.$lt_a.$lt_r" +props="$(sed -n '/^set_target_properties(wolfcert PROPERTIES/,/)/p' \ + "$ROOT/CMakeLists.txt")" +cm_ver="$(sed -n 's/^ *VERSION *\([^ ]*\)$/\1/p' <<<"$props")" +cm_so="$(sed -n 's/^ *SOVERSION *\([^ ]*\)$/\1/p' <<<"$props")" +if [ -z "$lt" ] || [ "$cm_ver" != "$lt_ver" ] || [ "$cm_so" != "$lt_so" ]; then + echo "ERROR: CMakeLists.txt VERSION ${cm_ver:-?} SOVERSION ${cm_so:-?} does"\ + "not match Makefile.am -version-info ${lt:-?}" + status=1 +fi + if [ "$status" -eq 0 ]; then echo "build-system parity OK: $(echo "$cmake_srcs" | wc -l | tr -d ' ') library"\ "sources, $(echo "$zephyr_srcs" | wc -l | tr -d ' ') of them in the Zephyr"\ - "module, $(echo "$cmake_tests" | wc -l | tr -d ' ') test sources and the"\ - "version ($am_ver) match." + "module, $(echo "$cmake_tests" | wc -l | tr -d ' ') test sources, the"\ + "version ($am_ver) and the library version $lt_ver match." fi exit "$status" From 8085c137e5249964cb5d427a640fef9e424ee5fc Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sun, 18 Oct 2026 19:37:44 +0000 Subject: [PATCH 11/17] Follow the key id a CryptoCb device assigns A CryptoCb device can give a key it generates another id than the one it was asked for. A TPM does so for a transient key, whose handle it picks itself. wolfcert_key_generate now copies the id the device left in the wolfCrypt key back into the WolfCertKey, so wolfcert_key_id, TLS client authentication by id and a later wolfcert_key_from_id reach the key the device made. An id the device left empty or longer than WOLFCERT_KEY_ID_MAX_LEN fails with WOLFCERT_ERR_CRYPTO. The device holds the key by then, so *out_key still gets the handle, under the requested id, for the caller to delete it there; every other failure leaves *out_key NULL. wolfcert_client_enroll and wolfcert_client_reenroll freed a key they had generated under a key_id when the request failed, and told the caller to delete it in the backend. With an id the device picked, the caller cannot name that key, and a retry loop fills the TPM with transient keys. Both now hand such a key back in out_key on failure too; keys without a key_id are still freed. Both set *out_key to NULL before anything can fail, so the caller always finds a defined value there, and refuse a protocol other than EST with WOLFCERT_ERR_UNSUPPORTED before generating a key, so a SCEP config does not leave one in the backend. test_keygen covers a device that renames the key and one that leaves no id, and est_devid_roundtrip a failed enroll and rekey that hand back a key_id key but not a software one, early failures that leave out_key NULL, and a SCEP config that generates no key. --- docs/ARCHITECTURE.md | 7 +- src/client.c | 107 ++++++++++--------- src/key_algs.c | 53 +++++++++ src/key_algs.h | 3 + src/keygen.c | 17 +++ tests/integration/test_est_devid_roundtrip.c | 84 +++++++++++++++ tests/unit/test_keygen.c | 78 ++++++++++++++ wolfcert/client.h | 12 ++- wolfcert/keygen.h | 6 +- 9 files changed, 307 insertions(+), 60 deletions(-) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index e378a26..0c05cea 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -346,7 +346,8 @@ The `key_id` bytes are opaque to wolfCert. They reach the backend in the wolfCrypt key's `id` field, the same way wolfPKCS11, wolfHSM and the hardware ports name their keys, and the backend decides what they mean (a PKCS#11 `CKA_ID`, a TPM handle, a key-store slot). The backend generates the key there -and returns only its public half. +and returns only its public half. It may also rename the key, as a TPM does +when it picks a transient handle, and `wolfcert_key_id` returns the new id. From there, every private-key operation on the key routes through `my_callback`: CSR signing, and TLS client authentication by id or for EST @@ -381,6 +382,10 @@ rebuild it with `wolfcert_key_from_id(&cfg, cert, cert_len, &key)`, which takes the public half from the certificate since a backend need not be able to return it. +`wolfcert_client_enroll` and `wolfcert_client_reenroll` hand back a key they +generated under a `key_id` even when they fail, so the caller can delete it +in the backend. + RSA, ECC and ML-DSA keys take a `key_id`. Ed25519 and Ed448 keys take one with a wolfSSL newer than 5.9.4, which has `wc_ed25519_init_id` and `wc_ed448_init_id`. SCEP does not support a `key_id` key: its PKCS#7 diff --git a/src/client.c b/src/client.c index b8441c6..0a25229 100644 --- a/src/client.c +++ b/src/client.c @@ -136,6 +136,29 @@ int wolfcert_client_fetch_meta(WolfCertClient* client, const WolfCertServerCfg* return WOLFCERT_ERR_UNSUPPORTED; } +/* Only EST enrolls here; SCEP needs the RA cert, which this API lacks. */ +static int client_proto_check(const WolfCertServerCfg* srv) +{ +#ifdef WOLFCERT_HAVE_EST + if (srv->protocol == WOLFCERT_PROTO_EST) + return WOLFCERT_OK; +#endif + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "client", + "protocol %d cannot enroll through wolfcert_client", + (int)srv->protocol); +} + +/* On failure, a key with a key_id still goes to the caller to delete. */ +static int hand_back(WolfCertKey* key, int rc, WolfCertKey** out_key) +{ + if (rc != WOLFCERT_OK && key != NULL && key->id_len == 0) { + wolfcert_key_free(key); + key = NULL; + } + *out_key = key; + return rc; +} + int wolfcert_client_enroll(WolfCertClient* client, const WolfCertServerCfg* srv, const WolfCertKeyCfg* key_cfg, const WolfCertCertMeta* meta, @@ -145,6 +168,11 @@ int wolfcert_client_enroll(WolfCertClient* client, const WolfCertServerCfg* srv, if (srv == NULL || key_cfg == NULL || meta == NULL || out_key == NULL || out_cert_pem == NULL) return WOLFCERT_ERR_BAD_ARG; + *out_key = NULL; + + int rc = client_proto_check(srv); + if (rc != WOLFCERT_OK) + return rc; /* Shallow copies; csr_attrs_apply writes only scalar fields. */ WolfCertKeyCfg eff_key = *key_cfg; @@ -153,51 +181,33 @@ int wolfcert_client_enroll(WolfCertClient* client, const WolfCertServerCfg* srv, #ifdef WOLFCERT_HAVE_EST /* proto_opts is a union; test the protocol before reading its EST arm. */ if (srv->protocol == WOLFCERT_PROTO_EST && srv->proto_opts.est.auto_csrattrs) { - int rc = wolfcert_client_auto_csrattrs(srv, &eff_key, &eff_meta); + rc = wolfcert_client_auto_csrattrs(srv, &eff_key, &eff_meta); if (rc != WOLFCERT_OK) return rc; } #endif WolfCertKey* key = NULL; - int rc = wolfcert_key_generate(&eff_key, &key); + rc = wolfcert_key_generate(&eff_key, &key); if (rc != WOLFCERT_OK) - return rc; + return hand_back(key, rc, out_key); WolfCertBuffer csr = { 0 }; rc = wolfcert_csr_build(key, &eff_meta, &csr); - if (rc != WOLFCERT_OK) { - wolfcert_key_free(key); - return rc; - } + if (rc != WOLFCERT_OK) + return hand_back(key, rc, out_key); #ifdef WOLFCERT_HAVE_EST - if (srv->protocol == WOLFCERT_PROTO_EST) { - WolfCertEstResult r; + WolfCertEstResult r; - rc = wolfcert_est_simple_enroll(srv, csr.data, csr.len, &r); - rc = wolfcert_client_take_cert(rc, &r, out_cert_pem); - } - else -#endif -#ifdef WOLFCERT_HAVE_SCEP - if (srv->protocol == WOLFCERT_PROTO_SCEP) { - rc = WOLFCERT_ERR_UNSUPPORTED; - /* SCEP enrollment needs the RA cert, which this API does not take. */ - } - else + rc = wolfcert_est_simple_enroll(srv, csr.data, csr.len, &r); + rc = wolfcert_client_take_cert(rc, &r, out_cert_pem); +#else + rc = WOLFCERT_ERR_UNSUPPORTED; #endif - { - rc = WOLFCERT_ERR_UNSUPPORTED; - } wolfcert_buffer_free(&csr); - if (rc != WOLFCERT_OK) { - wolfcert_key_free(key); - return rc; - } - *out_key = key; - return WOLFCERT_OK; + return hand_back(key, rc, out_key); } int wolfcert_client_reenroll(WolfCertClient* client, const WolfCertServerCfg* srv, @@ -211,48 +221,39 @@ int wolfcert_client_reenroll(WolfCertClient* client, const WolfCertServerCfg* sr if (srv == NULL || current_cert == NULL || current_key == NULL || meta == NULL || out_key == NULL || out_cert_pem == NULL) return WOLFCERT_ERR_BAD_ARG; + *out_key = NULL; if (wolfcert_csr_meta_sets_identity(meta)) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "client", "a renewal keeps the certificate's subject and SAN"); + int rc = client_proto_check(srv); + if (rc != WOLFCERT_OK) + return rc; + WolfCertKey* nk = NULL; - int rc; if (new_key_cfg != NULL) { rc = wolfcert_key_generate(new_key_cfg, &nk); if (rc != WOLFCERT_OK) - return rc; + return hand_back(nk, rc, out_key); } const WolfCertKey* signing_key = nk ? nk : current_key; WolfCertBuffer csr = { 0 }; rc = wolfcert_csr_build_ex(signing_key, meta, current_cert, current_cert_len, &csr); - if (rc != WOLFCERT_OK) { - if (nk) - wolfcert_key_free(nk); - return rc; - } + if (rc != WOLFCERT_OK) + return hand_back(nk, rc, out_key); #ifdef WOLFCERT_HAVE_EST - if (srv->protocol == WOLFCERT_PROTO_EST) { - WolfCertEstResult r; + WolfCertEstResult r; - rc = wolfcert_est_simple_reenroll(srv, current_cert, current_cert_len, - current_key, csr.data, csr.len, &r); - rc = wolfcert_client_take_cert(rc, &r, out_cert_pem); - } - else + rc = wolfcert_est_simple_reenroll(srv, current_cert, current_cert_len, + current_key, csr.data, csr.len, &r); + rc = wolfcert_client_take_cert(rc, &r, out_cert_pem); +#else + rc = WOLFCERT_ERR_UNSUPPORTED; #endif - { - rc = WOLFCERT_ERR_UNSUPPORTED; - } wolfcert_buffer_free(&csr); - if (rc != WOLFCERT_OK) { - if (nk) - wolfcert_key_free(nk); - return rc; - } - *out_key = nk ? nk : NULL; - return WOLFCERT_OK; + return hand_back(nk, rc, out_key); } diff --git a/src/key_algs.c b/src/key_algs.c index 643fb96..91f030a 100644 --- a/src/key_algs.c +++ b/src/key_algs.c @@ -135,6 +135,14 @@ static int rsa_host_priv(const struct WolfCertKey* k) return !mp_iszero(&((RsaKey*)k->impl)->d); } +#ifdef WOLFCERT_USE_KEY_ID +static const uint8_t* rsa_impl_id(const struct WolfCertKey* k, int* len) +{ + *len = ((RsaKey*)k->impl)->idLen; + return ((RsaKey*)k->impl)->id; +} +#endif + static int rsa_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) { @@ -275,6 +283,14 @@ static int ecc_host_priv(const struct WolfCertKey* k) return !mp_iszero(wc_ecc_key_get_priv((ecc_key*)k->impl)); } +#ifdef WOLFCERT_USE_KEY_ID +static const uint8_t* ecc_impl_id(const struct WolfCertKey* k, int* len) +{ + *len = ((ecc_key*)k->impl)->idLen; + return ((ecc_key*)k->impl)->id; +} +#endif + /* Uncompressed X9.63 point: the 0x04 marker plus two coordinates. */ #define ECC_X963_CAP (1 + 2 * MAX_ECC_BYTES) @@ -418,6 +434,12 @@ static int ed25519_host_priv(const struct WolfCertKey* k) { return ((ed25519_key*)k->impl)->privKeySet; } + +static const uint8_t* ed25519_impl_id(const struct WolfCertKey* k, int* len) +{ + *len = ((ed25519_key*)k->impl)->idLen; + return ((ed25519_key*)k->impl)->id; +} #endif static int ed25519_pub_check(struct WolfCertKey* k, const uint8_t* pub, @@ -516,6 +538,12 @@ static int ed448_host_priv(const struct WolfCertKey* k) { return ((ed448_key*)k->impl)->privKeySet; } + +static const uint8_t* ed448_impl_id(const struct WolfCertKey* k, int* len) +{ + *len = ((ed448_key*)k->impl)->idLen; + return ((ed448_key*)k->impl)->id; +} #endif static int ed448_pub_check(struct WolfCertKey* k, const uint8_t* pub, @@ -632,6 +660,14 @@ static int mldsa_host_priv(const struct WolfCertKey* k) return ((MlDsaKey*)k->impl)->prvKeySet; } +#ifdef WOLFCERT_USE_KEY_ID +static const uint8_t* mldsa_impl_id(const struct WolfCertKey* k, int* len) +{ + *len = ((MlDsaKey*)k->impl)->idLen; + return ((MlDsaKey*)k->impl)->id; +} +#endif + /* Adopts the certificate's public half, which a PKCS#8 v1 key lacks. */ static int mldsa_pub_check(struct WolfCertKey* k, const uint8_t* pub, word32 pub_len) @@ -669,6 +705,9 @@ static const WolfCertKeyAlg ALG_RSA = { .pub_check = rsa_pub_check, .pub_decode = rsa_pub_decode, .host_priv = rsa_host_priv, +#ifdef WOLFCERT_USE_KEY_ID + .impl_id = rsa_impl_id, +#endif .free_ = rsa_free, }; #endif @@ -688,6 +727,9 @@ static const WolfCertKeyAlg ALG_ECC = { .pub_check = ecc_pub_check, .pub_decode = ecc_pub_decode, .host_priv = ecc_host_priv, +#ifdef WOLFCERT_USE_KEY_ID + .impl_id = ecc_impl_id, +#endif .free_ = ecc_free, }; #endif @@ -708,6 +750,7 @@ static const WolfCertKeyAlg ALG_ED25519 = { #ifdef WOLFCERT_ED25519_KEY_ID .pub_decode = ed25519_pub_decode, .host_priv = ed25519_host_priv, + .impl_id = ed25519_impl_id, #endif .free_ = ed25519_free, }; @@ -729,6 +772,7 @@ static const WolfCertKeyAlg ALG_ED448 = { #ifdef WOLFCERT_ED448_KEY_ID .pub_decode = ed448_pub_decode, .host_priv = ed448_host_priv, + .impl_id = ed448_impl_id, #endif .free_ = ed448_free, }; @@ -750,6 +794,9 @@ static const WolfCertKeyAlg ALG_MLDSA44 = { .pub_check = mldsa_pub_check, .pub_decode = mldsa_pub_decode, .host_priv = mldsa_host_priv, +#ifdef WOLFCERT_USE_KEY_ID + .impl_id = mldsa_impl_id, +#endif .free_ = mldsa_free, }; #endif @@ -769,6 +816,9 @@ static const WolfCertKeyAlg ALG_MLDSA65 = { .pub_check = mldsa_pub_check, .pub_decode = mldsa_pub_decode, .host_priv = mldsa_host_priv, +#ifdef WOLFCERT_USE_KEY_ID + .impl_id = mldsa_impl_id, +#endif .free_ = mldsa_free, }; #endif @@ -788,6 +838,9 @@ static const WolfCertKeyAlg ALG_MLDSA87 = { .pub_check = mldsa_pub_check, .pub_decode = mldsa_pub_decode, .host_priv = mldsa_host_priv, +#ifdef WOLFCERT_USE_KEY_ID + .impl_id = mldsa_impl_id, +#endif .free_ = mldsa_free, }; #endif diff --git a/src/key_algs.h b/src/key_algs.h index d9d7c7a..4ca849b 100644 --- a/src/key_algs.h +++ b/src/key_algs.h @@ -57,6 +57,9 @@ typedef struct WolfCertKeyAlg { /* Non-zero if the private half sits in host memory. NULL if the type * cannot take a key_id. */ int (*host_priv) (const struct WolfCertKey* key); + /* The key id in key->impl, which make may have changed. NULL if the type + * cannot take a key_id. */ + const uint8_t* (*impl_id)(const struct WolfCertKey* key, int* len); void (*free_) (struct WolfCertKey* key); } WolfCertKeyAlg; diff --git a/src/keygen.c b/src/keygen.c index 857bf14..c26887d 100644 --- a/src/keygen.c +++ b/src/keygen.c @@ -76,6 +76,7 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) { if (cfg == NULL || out_key == NULL) return WOLFCERT_ERR_BAD_ARG; + *out_key = NULL; const WolfCertKeyAlg* alg = wolfcert_key_alg(cfg->type); if (alg == NULL) @@ -123,6 +124,22 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) cfg->dev_id); } + /* The device may rename the key, as a TPM does for a transient one. */ + if (k->id_len > 0 && alg->impl_id != NULL) { + int id_len = 0; + const uint8_t* id = alg->impl_id(k, &id_len); + + /* The device holds the key, so hand it out under the requested id. */ + if (id_len <= 0 || id_len > WOLFCERT_KEY_ID_MAX_LEN) { + *out_key = k; + return WOLFCERT_ERR(WOLFCERT_ERR_CRYPTO, "keygen", + "CryptoCb device %d left a bad key id", + cfg->dev_id); + } + memcpy(k->id, id, (size_t)id_len); + k->id_len = (size_t)id_len; + } + *out_key = k; return WOLFCERT_OK; } diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c index d02abbd..aefc68a 100644 --- a/tests/integration/test_est_devid_roundtrip.c +++ b/tests/integration/test_est_devid_roundtrip.c @@ -773,6 +773,89 @@ static int test_client_key_src(const char* url, return 0; } +/* A failed enroll or rekey still hands back a key made under a key_id. */ +static int test_failure_keeps_key(const char* url, const uint8_t* tls_cert, + size_t tls_cert_len) +{ + static const uint8_t id[] = "wolfcert/orphan-key"; + static const uint8_t junk[] = { 0x30, 0x03, 0x02, 0x01, 0x00 }; + const WolfCertCertMeta meta = { .subject_dn = "CN=devid-orphan" }; + const WolfCertCertMeta renew = { 0 }; + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, + .param = TEST_ENROLL_KEY_PARAM, + .dev_id = MOCK_DEVID, + .key_id = id, .key_id_len = sizeof(id) - 1 }; + WolfCertKeyCfg scfg = { .type = TEST_ENROLL_KEY_TYPE, + .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + }; + WolfCertKey* key = NULL; + WolfCertKey* cur = NULL; + WolfCertBuffer cert = { 0 }; + const uint8_t* got_id = NULL; + size_t got_len = 0; + + mock_reset(); + REQUIRE(wolfcert_client_enroll(NULL, &cli, &kcfg, &meta, &key, &cert) != + WOLFCERT_OK); + REQUIRE(key != NULL); + REQUIRE(wolfcert_key_id(key, &got_id, &got_len) == WOLFCERT_OK); + REQUIRE(got_len == sizeof(id) - 1 && memcmp(got_id, id, got_len) == 0); + wolfcert_key_free(key); + key = NULL; + + mock_reset(); + REQUIRE(wolfcert_key_generate(&scfg, &cur) == WOLFCERT_OK); + REQUIRE(wolfcert_client_reenroll(NULL, &cli, junk, sizeof(junk), cur, + &kcfg, &renew, &key, &cert) == + WOLFCERT_ERR_PARSE); + REQUIRE(key != NULL); + wolfcert_key_free(key); + key = NULL; + + REQUIRE(wolfcert_client_enroll(NULL, &cli, &scfg, &meta, &key, &cert) != + WOLFCERT_OK); + REQUIRE(key == NULL); + + /* An early failure also leaves out_key defined. */ + key = cur; + scfg.param = 123; + REQUIRE(wolfcert_client_enroll(NULL, &cli, &scfg, &meta, &key, &cert) != + WOLFCERT_OK); + REQUIRE(key == NULL); + key = cur; + REQUIRE(wolfcert_client_reenroll(NULL, &cli, junk, sizeof(junk), cur, + NULL, &meta, &key, &cert) == + WOLFCERT_ERR_BAD_ARG); + REQUIRE(key == NULL); + scfg.param = TEST_ENROLL_KEY_PARAM; + REQUIRE(wolfcert_client_reenroll(NULL, &cli, junk, sizeof(junk), cur, + &scfg, &renew, &key, &cert) == + WOLFCERT_ERR_PARSE); + REQUIRE(key == NULL); + REQUIRE(cert.data == NULL); + + /* A protocol the client calls cannot enroll creates no key. */ + cli.protocol = WOLFCERT_PROTO_SCEP; + int gens = mock_keygens; + REQUIRE(wolfcert_client_enroll(NULL, &cli, &kcfg, &meta, &key, &cert) == + WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(wolfcert_client_reenroll(NULL, &cli, junk, sizeof(junk), cur, + &kcfg, &renew, &key, &cert) == + WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(key == NULL); + REQUIRE(mock_keygens == gens); + wolfcert_key_free(cur); + mock_reset(); + return 0; +} + int main(void) { uint8_t* tls_cert = NULL; size_t tls_cert_len = 0; @@ -871,6 +954,7 @@ int main(void) #endif REQUIRE(test_client_key_src(url, tls_cert, tls_cert_len, boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); + REQUIRE(test_failure_keeps_key(url, tls_cert, tls_cert_len) == 0); wolfcert_server_stop(srv); pthread_join(tid, NULL); diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index 5897d27..e535868 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -113,12 +113,88 @@ static int key_id_declined(WolfCertKeyType type, int param) return 0; } +#ifdef WOLFCERT_HAVE_ECC +#define RENAME_DEVID 0x726e +static const uint8_t renamed_id[] = { 0x52, 0x45, 0x4e }; + +/* Keeps only the public point of a software key and renames the key, or + * clears its id when ctx is set. */ +static int rename_cb(int devId, wc_CryptoInfo* info, void* ctx) +{ + ecc_key tmp; + byte pub[1 + 2 * MAX_ECC_BYTES]; + word32 pub_len = sizeof(pub); + int rc; + + (void)devId; + if (info->algo_type != WC_ALGO_TYPE_PK || + info->pk.type != WC_PK_TYPE_EC_KEYGEN) + return CRYPTOCB_UNAVAILABLE; + + rc = wc_ecc_init_ex(&tmp, NULL, INVALID_DEVID); + if (rc != 0) + return rc; + rc = wc_ecc_make_key_ex(info->pk.eckg.rng, info->pk.eckg.size, &tmp, + info->pk.eckg.curveId); + if (rc == 0) + rc = wc_ecc_export_x963(&tmp, pub, &pub_len); + if (rc == 0) + rc = wc_ecc_import_x963_ex(pub, pub_len, info->pk.eckg.key, + info->pk.eckg.curveId); + wc_ecc_free(&tmp); + if (rc == 0 && ctx != NULL) + info->pk.eckg.key->idLen = 0; + else if (rc == 0) { + memcpy(info->pk.eckg.key->id, renamed_id, sizeof(renamed_id)); + info->pk.eckg.key->idLen = (int)sizeof(renamed_id); + } + return rc; +} + +/* The id a device gives the key it generates replaces the requested one. */ +static int key_id_renamed(void) +{ + static const uint8_t id[] = { 0x01, 0x02 }; + WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, + .dev_id = RENAME_DEVID, + .key_id = id, .key_id_len = sizeof(id) }; + WolfCertKey* k = NULL; + const uint8_t* got = NULL; + size_t got_len = 0; + + REQUIRE(wc_CryptoCb_RegisterDevice(RENAME_DEVID, rename_cb, NULL) == 0); + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_OK); + REQUIRE(wolfcert_key_id(k, &got, &got_len) == WOLFCERT_OK); + REQUIRE(got_len == sizeof(renamed_id)); + REQUIRE(memcmp(got, renamed_id, sizeof(renamed_id)) == 0); + wolfcert_key_free(k); + wc_CryptoCb_UnRegisterDevice(RENAME_DEVID); + + /* A device that leaves no id still hands out the key, under the + * requested id. */ + k = NULL; + REQUIRE(wc_CryptoCb_RegisterDevice(RENAME_DEVID, rename_cb, + (void*)id) == 0); + REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_CRYPTO); + REQUIRE(k != NULL); + REQUIRE(wolfcert_key_id(k, &got, &got_len) == WOLFCERT_OK); + REQUIRE(got_len == sizeof(id) && memcmp(got, id, sizeof(id)) == 0); + wolfcert_key_free(k); + wc_CryptoCb_UnRegisterDevice(RENAME_DEVID); + return 0; +} +#endif + static int key_id_cases(void) { static const uint8_t id[] = { 0x01, 0x02 }; static const uint8_t junk[] = { 0x30, 0x03, 0x02, 0x01, 0x00 }; WolfCertKey* k = NULL; +#ifdef WOLFCERT_HAVE_ECC + if (key_id_renamed()) + return 1; +#endif REQUIRE(wc_CryptoCb_RegisterDevice(DECLINE_DEVID, decline_cb, NULL) == 0); WolfCertKeyCfg cfg = { .type = TEST_KEY_TYPE, .param = TEST_KEY_PARAM, .dev_id = INVALID_DEVID, @@ -126,8 +202,10 @@ static int key_id_cases(void) REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); cfg.dev_id = DECLINE_DEVID; cfg.key_id_len = 0; + k = (WolfCertKey*)&cfg; REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_BAD_ARG); REQUIRE(strstr(wolfcert_last_error_message(), "key_id_len") != NULL); + REQUIRE(k == NULL); cfg.dev_id = INVALID_DEVID; cfg.key_id_len = sizeof(id); diff --git a/wolfcert/client.h b/wolfcert/client.h index bfdcc65..b01f58d 100644 --- a/wolfcert/client.h +++ b/wolfcert/client.h @@ -52,8 +52,11 @@ WOLFCERT_API int wolfcert_client_fetch_meta(WolfCertClient* client, /* Generate a new key (honoring cfg->dev_id for CryptoCb offloading), build * a CSR from meta, and enroll. On success out_key owns the key and * out_cert_pem owns the issued certificate. A pending enrollment returns - * WOLFCERT_ERR_PENDING and hands out neither. On failure a key generated - * under a key_id stays in the backend; delete it there. */ + * WOLFCERT_ERR_PENDING. On any failure neither is handed out, except that a + * key generated under a key_id stays in the backend and out_key still owns + * it, so the caller can delete it there under wolfcert_key_id. Every call + * generates a new key, so polling a pending request with that key takes + * wolfcert_csr_build and wolfcert_est_simple_enroll. */ WOLFCERT_API int wolfcert_client_enroll(WolfCertClient* client, const WolfCertServerCfg* srv, const WolfCertKeyCfg* key_cfg, @@ -64,9 +67,8 @@ WOLFCERT_API int wolfcert_client_enroll(WolfCertClient* client, /* Re-enroll using an existing cert/key; a NULL new_key_cfg reuses the key. * The CSR copies current_cert's Subject and SAN: WOLFCERT_ERR_BAD_ARG if meta * sets them, _PARSE for a bad cert, _UNSUPPORTED if one cannot be carried. - * A pending renewal returns WOLFCERT_ERR_PENDING and hands out neither - * out_key nor out_cert_pem. A new key with a key_id stays in the backend on - * failure, as for enroll. */ + * A pending renewal returns WOLFCERT_ERR_PENDING. On failure a new key with a + * key_id stays in the backend and in out_key, as for enroll. */ WOLFCERT_API int wolfcert_client_reenroll(WolfCertClient* client, const WolfCertServerCfg* srv, const uint8_t* current_cert, size_t current_cert_len, diff --git a/wolfcert/keygen.h b/wolfcert/keygen.h index b5002d2..79e045b 100644 --- a/wolfcert/keygen.h +++ b/wolfcert/keygen.h @@ -30,7 +30,11 @@ typedef struct WolfCertKey WolfCertKey; /* Generate a key per cfg. cfg->dev_id != -1 routes its operations through * that CryptoCb device; with cfg->key_id the key also stays in the device and - * the handle only references it. Allocated from cfg->heap or the default. */ + * the handle only references it, under the id wolfcert_key_id returns, which + * the device may have changed. Allocated from cfg->heap or the default. + * *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when the device + * left an unusable id: *out_key then holds the key under the requested id so + * the caller can delete it there. */ WOLFCERT_API int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key); /* Reference a key a CryptoCb device holds under cfg->key_id, its public half From a58b53914e130b3e0d8585669e9b40074e1a489b Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sun, 18 Oct 2026 06:15:44 +0000 Subject: [PATCH 12/17] Let wolfcert-server renew the certificates it issued The test server generated a new CA on every start, and it checked client certificates only against tls_client_ca_pem, which also demands one on every handshake. A client could therefore neither renew a certificate this server issued once it restarted, nor enroll anonymously and renew over mTLS from the same server. WolfCertServerCfgSrv gains tls_client_trust_issued, appended to keep the layout: the server asks EST clients for a certificate and accepts one its own CA issued, without demanding one, so /simplereenroll can renew it. Such a certificate does not authenticate /simpleenroll, so next to tls_client_ca_pem alone it cannot enroll a new identity, and a connection whose certificate cannot be checked, such as a resumed session, cannot enroll either. Basic or anonymous enrollment still admit such a client, since they authenticate the request on their own. A self-signed client certificate pinned through tls_client_ca_pem, which wolfSSL with OPENSSL_ALL reports as ASN_SELF_SIGNED_E, and one whose key algorithm differs from that of the CA (ASN_SIG_OID_E) count as not issued here. With no Basic user, client CA or anonymous enrollment the server only renews, so it needs ca_cert and ca_key, since a new CA has issued nothing. wolfcert_server_start() refuses the option for SCEP, without KEEP_PEER_CERT, and alone without ca_cert, all before it loads or creates a CA. wolfcert-server gets --tls-trust-issued, which sets the new field, and --ca-dir DIR, which must name an existing directory owned by the user and not writable by others. It loads ca.cert.der and ca.key.der from DIR into ca_cert and ca_key or, when DIR holds neither, saves the CA the server generated there through wolfcert_server_get_ca(), the key first and with mode 0600, each through a temporary file and a rename. Both files must be regular files of that user that others cannot write, the key one that others cannot read either, and a DIR holding one file without the other is refused. The CLI leaves the option's checks to wolfcert_server_start() and prints its message. Every CA wolfCert generates has the same subject, and neither the CA nor the certificates it issued carried key identifiers, so wolfSSL found an issuer by name only and took the first match. With tls_client_ca_pem naming another wolfCert CA, certificates from one of the two then failed TLS verification. Generated CAs now carry a subject key identifier and issued certificates the matching authority key identifier. A loaded CA without one, or with one that is not KEYID_SIZE bytes, which wolfSSL would hash so that it no longer matches, issues without an authority key identifier. That is decided once, when the CA is generated or loaded. test_est_mtls_roundtrip covers an anonymous enroll followed by an mTLS reenroll, a foreign certificate refused in the handshake, an anonymous reenroll refused with 403, a renewal-only server, and a server whose client CA is a second wolfCert CA: the certificate from that CA enrolls, one the server issued renews but cannot enroll, also not over a resumed TLS session (403 when SESSION_CERTS keeps its certificate, 500 when there is none), and enrolls once Basic is configured, and a client without a certificate is refused. A pinned self-signed client certificate enrolls next to tls_client_trust_issued, and a renewal-only server without ca_cert is refused. A foreign certificate is checked to fail without an HTTP answer, since TLS 1.3 reports the refusal on the first read in some builds. test_server_ca checks the key identifiers, including a loaded CA without one and one with an 8-byte one. cli_proto_scoping checks that a --ca-dir server keeps its CA across a restart, that it renews a certificate it issued only with --tls-trust-issued, and that wolfcert-server refuses --tls-trust-issued for SCEP, alone without --ca-dir or with an empty one, and a --ca-dir that is missing, not a directory, writable by others, holding the certificate without the key or a CA key others can read, and that the CA key is saved with mode 0600. Against a wolfSSL without KEEP_PEER_CERT it expects that refusal instead and skips the renewal. --- README.md | 6 +- cli/wolfcert_server.c | 224 +++++++++- src/ca_issue.c | 30 ++ src/est/est_server.c | 60 +++ src/internal.h | 5 + src/scep/scep_server.c | 1 + src/server.c | 67 ++- tests/integration/cli_proto_scoping.sh | 123 ++++++ tests/integration/test_est_mtls_roundtrip.c | 438 ++++++++++++++++++++ tests/unit/test_server_ca.c | 69 ++- wolfcert/server.h | 12 +- 11 files changed, 1012 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 7387c88..60fbca5 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,11 @@ Start the bundled test server (issues from an auto-generated local CA): # listen address; SCEP authenticates at the pkiMessage layer instead. # EST also needs --basic USER:PASS, --tls-client-ca PEM, or # --est-allow-anonymous to issue to any client; /simplereenroll -# also needs --tls-client-ca and the KEEP_PEER_CERT build above. +# also needs --tls-client-ca or --tls-trust-issued (accept certificates +# this CA issued; --ca-dir DIR keeps the CA across restarts) and the +# KEEP_PEER_CERT build above. --tls-trust-issued with a --ca-dir that +# already holds the CA, and no other option, gives a server that only +# renews. ./wolfcert-server --proto est --listen 127.0.0.1:8443 \ --tls-cert server.crt --tls-key server.key --est-allow-anonymous ./wolfcert-server --proto scep --listen 127.0.0.1:8088 diff --git a/cli/wolfcert_server.c b/cli/wolfcert_server.c index e994ff2..71573d2 100644 --- a/cli/wolfcert_server.c +++ b/cli/wolfcert_server.c @@ -19,8 +19,8 @@ /* * wolfcert-server - minimal EST/SCEP test server. Issues certificates - * against a local CA generated on startup. EST needs --tls-cert/--tls-key - * (RFC 7030); SCEP may be served over plaintext HTTP. + * against a local CA generated on startup or kept in --ca-dir. EST needs + * --tls-cert/--tls-key (RFC 7030); SCEP may be served over plaintext HTTP. */ #define _POSIX_C_SOURCE 200809L @@ -47,12 +47,16 @@ # define SCEP_FAULT_USAGE "" #endif +#include +#include #include #include #include #include #include #include +#include +#include static WolfCertServer* g_server = NULL; @@ -79,7 +83,8 @@ static void print_usage(FILE* out) " [--tls-cert PEM --tls-key PEM [--tls-client-ca PEM]]\n" " [--scep-require-approval] [--scep-enable-next-ca]\n" " [--scep-enable-get-cert] [--scep-split-ra]\n" - " [--est-allow-anonymous]\n" + " [--est-allow-anonymous] [--ca-dir DIR]\n" + " [--tls-trust-issued]\n" "\n" "Options:\n" " --proto est|scep Protocol to serve (required)\n" @@ -92,9 +97,16 @@ static void print_usage(FILE* out) " --tls-key PEMFILE Private key for --tls-cert (PEM)\n" " --tls-client-ca PEMFILE Require mutual TLS; verify clients against this CA\n" " --est-allow-anonymous Issue EST certificates to any client; --proto est\n" - " needs this, --basic or --tls-client-ca.\n" - " /simplereenroll also needs --tls-client-ca and a\n" - " KEEP_PEER_CERT wolfSSL\n" + " needs this, --basic, --tls-client-ca or\n" + " --tls-trust-issued with --ca-dir (renewal only).\n" + " /simplereenroll also needs --tls-client-ca or\n" + " --tls-trust-issued, and a KEEP_PEER_CERT wolfSSL\n" + " --ca-dir DIR Keep the CA in DIR, an existing directory, across\n" + " restarts\n" + " --tls-trust-issued Accept a TLS client certificate this server's CA\n" + " issued, to renew it (EST); it enrolls only with\n" + " --basic or --est-allow-anonymous, and any other\n" + " client certificate must chain to --tls-client-ca\n" " --scep-require-approval Defer SCEP PKCSReq/RenewalReq (pkiStatus=PENDING); issue\n" " on the first accepted GetCertInitial\n" " --scep-enable-next-ca Advertise + answer GetNextCACert (RFC 8894 section 4.7),\n" @@ -200,6 +212,119 @@ static uint8_t* slurp(const char* path, size_t* len) return b; } +/* DIR/name, or with tmp a mkstemp template next to it. */ +static int ca_dir_path(char* path, size_t cap, const char* dir, + const char* name, int tmp) +{ + int n = tmp ? snprintf(path, cap, "%s/.%s.XXXXXX", dir, name) + : snprintf(path, cap, "%s/%s", dir, name); + + return (n < 0 || (size_t)n >= cap) ? -1 : 0; +} + +/* Read DIR/name, a regular file of this user's with no `deny` mode bits; 1 + * when it does not exist, -2 for another owner, type or mode. */ +static int ca_dir_read(const char* dir, const char* name, mode_t deny, + uint8_t** out, size_t* len) +{ + char path[4096]; + struct stat st; + uint8_t* b = NULL; + size_t off = 0; + int fd; + + if (ca_dir_path(path, sizeof(path), dir, name, 0) != 0) + return -1; + fd = open(path, O_RDONLY); + if (fd < 0) + return errno == ENOENT ? 1 : -1; + if (fstat(fd, &st) != 0) { + close(fd); + return -1; + } + if (!S_ISREG(st.st_mode) || st.st_uid != geteuid() || + (st.st_mode & deny) != 0) { + close(fd); + return -2; + } + if (st.st_size > 0) + b = malloc((size_t)st.st_size); + while (b != NULL && off < (size_t)st.st_size) { + ssize_t n = read(fd, b + off, (size_t)st.st_size - off); + if (n < 0 && errno == EINTR) + continue; + if (n <= 0) + break; + off += (size_t)n; + } + close(fd); + if (b == NULL || off != (size_t)st.st_size) { + if (b != NULL) + wc_ForceZero(b, (word32)off); + free(b); + return -1; + } + *out = b; + *len = off; + return 0; +} + +/* Replace DIR/name with data through a temporary file and a rename. */ +static int ca_dir_write(const char* dir, const char* name, const uint8_t* data, + size_t len, mode_t mode) +{ + char path[4096]; + char tmp[4096]; + size_t off = 0; + int ok; + int fd; + + if (ca_dir_path(path, sizeof(path), dir, name, 0) != 0 || + ca_dir_path(tmp, sizeof(tmp), dir, name, 1) != 0) + return -1; + fd = mkstemp(tmp); + if (fd < 0) + return -1; + ok = fchmod(fd, mode) == 0; + while (ok && off < len) { + ssize_t n = write(fd, data + off, len - off); + if (n < 0 && errno == EINTR) + continue; + ok = n > 0; + if (ok) + off += (size_t)n; + } + ok = ok && fsync(fd) == 0; + ok = close(fd) == 0 && ok; + if (ok && rename(tmp, path) == 0) + return 0; + unlink(tmp); + return -1; +} + +/* Keep a CA the server generated in DIR, key first. */ +static int ca_dir_save(const char* dir, WolfCertServer* srv) +{ + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; + int rc = wolfcert_server_get_ca(srv, WOLFCERT_ENCODING_DER, &cert, &key); + + if (rc == WOLFCERT_OK && + ca_dir_write(dir, "ca.key.der", key.data, key.len, 0600) != 0) + rc = WOLFCERT_ERR_IO; + if (rc == WOLFCERT_OK && + ca_dir_write(dir, "ca.cert.der", cert.data, cert.len, 0644) != 0) { + char path[4096]; + + if (ca_dir_path(path, sizeof(path), dir, "ca.key.der", 0) == 0) + unlink(path); + rc = WOLFCERT_ERR_IO; + } + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); + return rc; +} + int main(int argc, char** argv) { static const struct option opts[] = { @@ -224,6 +349,8 @@ int main(int argc, char** argv) { "csrattrs-file", required_argument, NULL, 'F' }, { "est-require-csrattrs", no_argument, NULL, 'Q' }, { "est-allow-anonymous", no_argument, NULL, 'Y' }, + { "ca-dir", required_argument, NULL, 'D' }, + { "tls-trust-issued", no_argument, NULL, 'I' }, { "help", no_argument, NULL, 'h' }, { "version", no_argument, NULL, 'V' }, { 0 } @@ -256,6 +383,8 @@ int main(int argc, char** argv) size_t csr_attrs_blob_len = 0; int est_require_csr_attrs = 0; int est_allow_anonymous = 0; + const char* ca_dir = NULL; + int tls_trust_issued = 0; int basic_rc; int c; @@ -382,6 +511,12 @@ int main(int argc, char** argv) case 'Y': est_allow_anonymous = 1; break; + case 'D': + ca_dir = optarg; + break; + case 'I': + tls_trust_issued = 1; + break; case 'V': printf("wolfcert-server %s\n", wolfcert_version_string()); return 0; @@ -419,12 +554,34 @@ int main(int argc, char** argv) } if (sel == WOLFCERT_PROTO_EST && user == NULL && tls_ca == NULL && - !est_allow_anonymous) { + !est_allow_anonymous && !tls_trust_issued) { fprintf(stderr, "wolfcert-server: --proto est requires --basic, " - "--tls-client-ca or --est-allow-anonymous\n"); + "--tls-client-ca, --est-allow-anonymous or " + "--tls-trust-issued\n"); return 1; } + /* DIR holds the CA private key. */ + if (ca_dir != NULL) { + struct stat st; + + if (stat(ca_dir, &st) != 0) { + fprintf(stderr, "wolfcert-server: --ca-dir %s: %s\n", ca_dir, + strerror(errno)); + return 1; + } + if (!S_ISDIR(st.st_mode)) { + fprintf(stderr, "wolfcert-server: --ca-dir %s is not a directory\n", + ca_dir); + return 1; + } + if (st.st_uid != geteuid() || (st.st_mode & (S_IWGRP | S_IWOTH)) != 0) { + fprintf(stderr, "wolfcert-server: --ca-dir %s must be owned by this " + "user and not writable by others\n", ca_dir); + return 1; + } + } + if (host == NULL) host = strdup("0.0.0.0"); @@ -486,9 +643,45 @@ int main(int argc, char** argv) .csr_attributes_len = csr_attrs_blob_len, .est_require_csr_attributes = est_require_csr_attrs, .est_allow_anonymous_enroll = est_allow_anonymous, + .tls_client_trust_issued = tls_trust_issued, }; - int rc = wolfcert_server_start(&cfg, &g_server); + int rc = WOLFCERT_OK; + uint8_t* ca_cert = NULL; + uint8_t* ca_key = NULL; + size_t ca_cert_len = 0; + size_t ca_key_len = 0; + int ca_new = 0; + + if (ca_dir != NULL) { + int cr = ca_dir_read(ca_dir, "ca.cert.der", S_IWGRP | S_IWOTH, + &ca_cert, &ca_cert_len); + int kr = ca_dir_read(ca_dir, "ca.key.der", S_IRWXG | S_IRWXO, + &ca_key, &ca_key_len); + + if (cr == -2 || kr == -2) { + fprintf(stderr, "wolfcert-server: --ca-dir %s: %s must be a " + "regular file owned by this user and not %s by others\n", + ca_dir, cr == -2 ? "ca.cert.der" : "ca.key.der", + cr == -2 ? "writable" : "accessible"); + rc = WOLFCERT_ERR_IO; + goto out; + } + if (cr < 0 || kr < 0 || cr != kr) { + fprintf(stderr, "wolfcert-server: --ca-dir %s: %s is missing or " + "unreadable\n", ca_dir, + cr != 0 ? "ca.cert.der" : "ca.key.der"); + rc = WOLFCERT_ERR_IO; + goto out; + } + ca_new = (cr == 1); + cfg.ca_cert = ca_cert; + cfg.ca_cert_len = ca_cert_len; + cfg.ca_key = ca_key; + cfg.ca_key_len = ca_key_len; + } + + rc = wolfcert_server_start(&cfg, &g_server); if (rc != WOLFCERT_OK) { const char* m = wolfcert_last_error_message(); fprintf(stderr, "wolfcert-server: start failed (%s)\n", wolfcert_strerror(rc)); @@ -496,6 +689,14 @@ int main(int argc, char** argv) fprintf(stderr, "wolfcert-server: %s\n", m); goto out; } + if (ca_new) { + rc = ca_dir_save(ca_dir, g_server); + if (rc != WOLFCERT_OK) { + fprintf(stderr, "wolfcert-server: cannot save the CA in --ca-dir " + "%s\n", ca_dir); + goto out; + } + } #ifdef CLI_SCEP_FAULTS if (sel == WOLFCERT_PROTO_SCEP) wolfcert_scep_server_set_caps_fault(g_server, scep_caps_status); @@ -523,6 +724,11 @@ int main(int argc, char** argv) out: wolfcert_server_free(g_server); g_server = NULL; + free(ca_cert); + if (ca_key != NULL) { + wc_ForceZero(ca_key, (word32)ca_key_len); + free(ca_key); + } free(host); free(user); free_secret(pass); diff --git a/src/ca_issue.c b/src/ca_issue.c index 62e9274..0417400 100644 --- a/src/ca_issue.c +++ b/src/ca_issue.c @@ -61,6 +61,19 @@ static void ca_sync_from_shim(WolfCertCa* ca, const WolfCertKey* shim) ca->impl = shim->impl; } +/* Non-zero when wolfSSL copies the CA's subject key id unhashed to an AKID */ +int wolfcert_ca_skid_copies(const WolfCertCa* ca) +{ + DecodedCert dc; + int ok; + + wc_InitDecodedCert(&dc, ca->cert_der, (word32)ca->cert_der_len, ca->heap); + ok = wc_ParseCert(&dc, CERT_TYPE, NO_VERIFY, NULL) == 0 && + dc.extSubjKeyIdSet && dc.extSubjKeyIdSz == KEYID_SIZE; + wc_FreeDecodedCert(&dc); + return ok; +} + static int gen_self_signed_cert(WolfCertCa* ca) { const WolfCertKeyAlg* alg = wolfcert_key_alg(ca->type); @@ -96,6 +109,14 @@ static int gen_self_signed_cert(WolfCertCa* ca) return WOLFCERT_ERR_WC(ku, "ca", "SetKeyUsage"); } + /* Every generated CA has the same subject; the key id tells them apart. */ + int kid = wc_SetSubjectKeyIdFromPublicKey_ex(cert, alg->wc_keytype_enum, + ca->impl); + if (kid != 0) { + wc_CertFree(cert); + return WOLFCERT_ERR_WC(kid, "ca", "SetSubjectKeyId"); + } + WC_RNG rng; if (wc_InitRng_ex(&rng, ca->heap, WOLFCERT_DEVID_SOFTWARE) != 0) { wc_CertFree(cert); @@ -131,6 +152,7 @@ static int gen_self_signed_cert(WolfCertCa* ca) ca->cert_der = der; ca->cert_der_len = (size_t)sz; + ca->skid_copies = wolfcert_ca_skid_copies(ca); return WOLFCERT_OK; } @@ -338,6 +360,7 @@ int wolfcert_ca_load(WolfCertCa* ca, const uint8_t* cert, size_t cert_len, ca->cert_der_len = cert_buf.len; ca->key_der = key_buf.data; ca->key_der_len = key_buf.len; + ca->skid_copies = wolfcert_ca_skid_copies(ca); k->impl = NULL; cert_buf.data = NULL; key_buf.data = NULL; @@ -821,6 +844,13 @@ int wolfcert_ca_issue(WolfCertCa* ca, rc = WOLFCERT_ERR_CRYPTO; } + if (rc == 0 && ca->skid_copies) { + int akid = wc_SetAuthKeyIdFromCert(nc, ca->cert_der, + (int)ca->cert_der_len); + if (akid != 0) + rc = WOLFCERT_ERR_WC(akid, "ca", "SetAuthKeyIdFromCert"); + } + if (rc == 0) { nc->sigType = ca_alg->ctc_sig_default; nc->daysValid = 365; diff --git a/src/est/est_server.c b/src/est/est_server.c index 2fc8ce0..b635822 100644 --- a/src/est/est_server.c +++ b/src/est/est_server.c @@ -747,6 +747,43 @@ static int reenroll_identity_check(WolfCertServer* s, #endif } +#ifdef KEEP_PEER_CERT +/* 1 when this server's CA issued the TLS client certificate, 0 when another + * CA did, an error when there is none to check, as after a resumption. */ +static int peer_issued_here(WolfCertServer* s) +{ + WOLFSSL_X509* peer = NULL; + const unsigned char* der = NULL; + int der_len = 0; + int rc; + + if (s->issued_cm == NULL || s->tls_current == NULL) + return 0; + peer = wolfSSL_get_peer_certificate(s->tls_current); + if (peer != NULL) + der = wolfSSL_X509_get_der(peer, &der_len); + if (der == NULL || der_len <= 0) { + rc = WOLFCERT_ERR(WOLFCERT_ERR_TLS, "est", + "enroll: cannot read the client certificate"); + } + else { + rc = wolfSSL_CertManagerVerifyBuffer(s->issued_cm, der, der_len, + WOLFSSL_FILETYPE_ASN1); + if (rc == WOLFSSL_SUCCESS) + rc = 1; + else if (rc == ASN_NO_SIGNER_E || rc == ASN_SIG_CONFIRM_E || + rc == ASN_SELF_SIGNED_E || rc == ASN_SIG_OID_E) + rc = 0; + else + rc = WOLFCERT_ERR(WOLFCERT_ERR_TLS, "est", + "enroll: cannot check the client certificate (%d)", rc); + } + if (peer != NULL) + wolfSSL_FreeX509(peer); + return rc; +} +#endif + static int handler_enroll(WolfCertServer* s, int fd, const EstRequest* req, int reenroll) { @@ -767,6 +804,29 @@ static int handler_enroll(WolfCertServer* s, int fd, const EstRequest* req, "enroll: no Basic credentials or TLS client on this connection"); } + if (!reenroll && s->renew_only) { + send_error(s, fd, 403, "Forbidden", + "this server only renews certificates\n"); + return WOLFCERT_ERR(WOLFCERT_ERR_AUTH, "est", + "enroll: the server only renews certificates"); + } + +#ifdef KEEP_PEER_CERT + int here = (reenroll || s->cfg_basic_user != NULL || + s->cfg.est_allow_anonymous_enroll) ? 0 : peer_issued_here(s); + if (here == 1) { + send_error(s, fd, 403, "Forbidden", + "a certificate issued here can only renew\n"); + return WOLFCERT_ERR(WOLFCERT_ERR_AUTH, "est", + "enroll: client certificate was issued here, not by the client CA"); + } + if (here != 0) { + send_error(s, fd, 500, "Server Error", + "cannot check the client certificate\n"); + return here; + } +#endif + if (req->body == NULL || req->body_len == 0) { send_error(s, fd, 400, "Bad Request", "request body is empty\n"); return WOLFCERT_ERR_HTTP; diff --git a/src/internal.h b/src/internal.h index a4e3169..953f42e 100644 --- a/src/internal.h +++ b/src/internal.h @@ -115,6 +115,7 @@ typedef struct { uint8_t* key_der; size_t key_der_len; void* heap; + int skid_copies; /* SKID is KEYID_SIZE, so issued AKIDs copy it */ } WolfCertCa; int wolfcert_ca_generate(WolfCertCa* ca, WolfCertKeyType type, int param, void* heap); @@ -124,6 +125,7 @@ WOLFCERT_TEST_VIS int wolfcert_ca_load(WolfCertCa* ca, void* heap); int wolfcert_ca_export(const WolfCertCa* ca, WolfCertEncoding enc, WolfCertBuffer* out_cert, WolfCertBuffer* out_key); +int wolfcert_ca_skid_copies(const WolfCertCa* ca); WOLFCERT_TEST_VIS void wolfcert_ca_free(WolfCertCa* ca); /* Rebuild an issued certificate's subject from a decoded CSR. */ @@ -154,6 +156,9 @@ struct WolfCertServer { void* priv; /* protocol-specific state */ WOLFSSL_CTX* tls_ctx; WOLFSSL* tls_current; /* owned by the accept loop */ + /* Only ca.cert_der; set when tls_client_trust_issued meets a client CA. */ + WOLFSSL_CERT_MANAGER* issued_cm; + int renew_only; /* tls_client_trust_issued alone */ int keep_alive; /* handlers clear it to close */ /* Set when the accept loop armed SO_RCVTIMEO/SO_SNDTIMEO; would-block * retries in wolfcert_io_{recv,send} are allowed only then. */ diff --git a/src/scep/scep_server.c b/src/scep/scep_server.c index 5bc5813..e992afa 100644 --- a/src/scep/scep_server.c +++ b/src/scep/scep_server.c @@ -1479,6 +1479,7 @@ static int bundle_root(WolfCertServer* s, uint8_t** root, size_t* root_len) WOLFCERT_XFREE(s->ca.cert_der, s->ca.heap); s->ca.cert_der = ca; s->ca.cert_der_len = ca_len; + s->ca.skid_copies = wolfcert_ca_skid_copies(&s->ca); } wolfcert_key_free(key); diff --git a/src/server.c b/src/server.c index a358426..fd7694c 100644 --- a/src/server.c +++ b/src/server.c @@ -327,7 +327,6 @@ static int tls_setup(WolfCertServer* s, const WolfCertServerCfgSrv* cfg) if (cfg->tls_cert_pem_len == 0 || cfg->tls_key_pem_len == 0) { return WOLFCERT_ERR_BAD_ARG; } - WOLFSSL_CTX* ctx = wolfSSL_CTX_new(wolfTLS_server_method()); if (ctx == NULL) return WOLFCERT_ERR_CRYPTO; @@ -372,6 +371,18 @@ static int tls_setup(WolfCertServer* s, const WolfCertServerCfgSrv* cfg) wolfSSL_CTX_set_verify(ctx, verify, NULL); } + if (cfg->tls_client_trust_issued) { + rc = wolfSSL_CTX_load_verify_buffer(ctx, s->ca.cert_der, + (long)s->ca.cert_der_len, + WOLFSSL_FILETYPE_ASN1); + if (rc != WOLFSSL_SUCCESS) { + wolfSSL_CTX_free(ctx); + return WOLFCERT_ERR(WOLFCERT_ERR_CRYPTO, "server", + "TLS: load_verify_buffer (issuing CA) failed"); + } + if (cfg->tls_client_ca_pem == NULL || cfg->tls_client_ca_pem_len == 0) + wolfSSL_CTX_set_verify(ctx, WOLFSSL_VERIFY_PEER, NULL); + } /* Grouped messages would hold back the PHA CertificateRequest. */ if (cfg->tls_post_handshake_auth) (void)wolfSSL_CTX_clear_group_messages(ctx); @@ -392,6 +403,23 @@ static int tls_setup(WolfCertServer* s, const WolfCertServerCfgSrv* cfg) } #endif + if (cfg->tls_client_trust_issued && cfg->tls_client_ca_pem != NULL && + cfg->tls_client_ca_pem_len > 0) { + s->issued_cm = wolfSSL_CertManagerNew_ex(s->heap); + rc = WOLFSSL_FAILURE; + if (s->issued_cm != NULL) + rc = wolfSSL_CertManagerLoadCABuffer(s->issued_cm, s->ca.cert_der, + (long)s->ca.cert_der_len, + WOLFSSL_FILETYPE_ASN1); + if (rc != WOLFSSL_SUCCESS) { + wolfSSL_CertManagerFree(s->issued_cm); + s->issued_cm = NULL; + wolfSSL_CTX_free(ctx); + return WOLFCERT_ERR(WOLFCERT_ERR_CRYPTO, "server", + "TLS: cannot load the issuing CA"); + } + } + s->tls_ctx = ctx; return WOLFCERT_OK; } @@ -412,11 +440,28 @@ static const WolfCertServerOps* lookup_ops(WolfCertProtocol p) } } +/* Basic, a client CA or the anonymous opt-in admits a /simpleenroll. */ +static int cfg_enroll_auth(const WolfCertServerCfgSrv* cfg) +{ + return cfg->http_basic_user != NULL || + (cfg->tls_client_ca_pem != NULL && cfg->tls_client_ca_pem_len > 0) || + cfg->est_allow_anonymous_enroll; +} + int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) { if (cfg == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; + if (cfg->protocol != WOLFCERT_PROTO_EST && cfg->tls_client_trust_issued) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", + "tls_client_trust_issued is supported only for EST"); +#ifndef KEEP_PEER_CERT + if (cfg->tls_client_trust_issued) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "server", + "tls_client_trust_issued needs wolfSSL built with KEEP_PEER_CERT"); +#endif + const WolfCertServerOps* ops = lookup_ops(cfg->protocol); if (ops == NULL) return WOLFCERT_ERR_UNSUPPORTED; @@ -432,13 +477,20 @@ int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", "http_basic_user and http_basic_pass must both be non-empty"); - if (cfg->protocol == WOLFCERT_PROTO_EST && cfg->http_basic_user == NULL && - (cfg->tls_client_ca_pem == NULL || - cfg->tls_client_ca_pem_len == 0) && - !cfg->est_allow_anonymous_enroll) + int renew_only = cfg->protocol == WOLFCERT_PROTO_EST && + !cfg_enroll_auth(cfg) && cfg->tls_client_trust_issued; + + if (cfg->protocol == WOLFCERT_PROTO_EST && !cfg_enroll_auth(cfg) && + !cfg->tls_client_trust_issued) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", "EST enrollment needs http_basic_user or tls_client_ca_pem, " - "or est_allow_anonymous_enroll"); + "or est_allow_anonymous_enroll, or tls_client_trust_issued to " + "only renew"); + + if (renew_only && cfg->ca_cert == NULL) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "server", + "a renewal-only server needs ca_cert and ca_key; a new CA has " + "issued nothing to renew"); /* Only EST requests the certificate that PHA defers past the handshake. */ if (cfg->protocol != WOLFCERT_PROTO_EST && cfg->tls_post_handshake_auth) @@ -467,6 +519,7 @@ int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out) s->listen_fd = -1; s->ops = ops; s->heap = heap; + s->renew_only = renew_only; if (cfg->challenge_password) s->cfg_challenge = wolfcert_strdup(cfg->challenge_password, heap); @@ -695,6 +748,8 @@ void wolfcert_server_free(WolfCertServer* srv) wolfSSL_CTX_free(srv->tls_ctx); srv->tls_ctx = NULL; } + wolfSSL_CertManagerFree(srv->issued_cm); + srv->issued_cm = NULL; if (srv->listen_fd >= 0) close(srv->listen_fd); diff --git a/tests/integration/cli_proto_scoping.sh b/tests/integration/cli_proto_scoping.sh index d797c26..e9ca5e5 100755 --- a/tests/integration/cli_proto_scoping.sh +++ b/tests/integration/cli_proto_scoping.sh @@ -277,6 +277,39 @@ if [ -x "$SERVER" ]; then expect_server_reject "--basic $b" "non-empty USER:PASS" \ --proto est --tls-cert "$0" --tls-key "$0" --basic "$b" done + expect_server_reject "--tls-trust-issued under scep" "only for EST" \ + --proto scep --tls-trust-issued + # A wolfSSL without KEEP_PEER_CERT refuses --tls-trust-issued first. + trust_issued_ok=1 + want_alone="needs ca_cert and ca_key" + want_empty="needs ca_cert and ca_key" + case "$("$SERVER" --proto est --listen 127.0.0.1:0 --tls-cert "$0" \ + --tls-key "$0" --tls-trust-issued --est-allow-anonymous 2>&1)" in + *KEEP_PEER_CERT*) + trust_issued_ok=0 + want_alone="KEEP_PEER_CERT" + want_empty="KEEP_PEER_CERT" + ;; + *"out of memory"*) + trust_issued_ok=0 + want_empty="" + ;; + esac + expect_server_reject "--tls-trust-issued alone without --ca-dir" \ + "$want_alone" --proto est --tls-cert "$0" --tls-key "$0" \ + --tls-trust-issued + expect_server_reject "missing --ca-dir" "No such file or directory" \ + --proto est --tls-cert "$0" --tls-key "$0" --est-allow-anonymous \ + --ca-dir "$0.missing" + expect_server_reject "--ca-dir naming a file" "is not a directory" \ + --proto est --tls-cert "$0" --tls-key "$0" --est-allow-anonymous \ + --ca-dir "$0" + opendir="$(mktemp -d -t wolfcert-cadir.XXXXXX)" + chmod 0777 "$opendir" + expect_server_reject "--ca-dir writable by others" "not writable by others" \ + --proto est --tls-cert "$0" --tls-key "$0" --est-allow-anonymous \ + --ca-dir "$opendir" + rmdir "$opendir" # $0 is no PEM, so start fails in TLS setup, before anything binds. out="$("$SERVER" --proto est --listen 127.0.0.1:0 --tls-cert "$0" \ --tls-key "$0" --est-allow-anonymous 2>&1)" @@ -289,6 +322,24 @@ if [ -x "$SERVER" ]; then fails=$((fails + 1)) ;; esac + cadir="$(mktemp -d -t wolfcert-cadir.XXXXXX)" + if [ -n "$want_empty" ]; then + expect_server_reject "--tls-trust-issued alone with an empty --ca-dir" \ + "$want_empty" --proto est --listen 127.0.0.1:0 \ + --tls-cert "$0" --tls-key "$0" --tls-trust-issued --ca-dir "$cadir" + else + echo "skip --tls-trust-issued with an empty --ca-dir (no allocator)" + fi + printf 'x' > "$cadir/ca.cert.der" + expect_server_reject "--ca-dir holding the certificate alone" \ + "ca.key.der is missing" --proto est --listen 127.0.0.1:0 \ + --tls-cert "$0" --tls-key "$0" --est-allow-anonymous --ca-dir "$cadir" + printf 'x' > "$cadir/ca.key.der" + chmod 0644 "$cadir/ca.key.der" + expect_server_reject "--ca-dir with a CA key others can read" \ + "not accessible by others" --proto est --listen 127.0.0.1:0 \ + --tls-cert "$0" --tls-key "$0" --est-allow-anonymous --ca-dir "$cadir" + rm -rf "$cadir" fi if [ ! -x "$SERVER" ]; then skip_group "--ca-fingerprint pinning (wolfcert-server not built)" @@ -497,6 +548,78 @@ else kill "$est_pid" 2>/dev/null est_pid="" + # --ca-dir keeps the CA across a restart; only --tls-trust-issued + # lets the certificates it issued renew. + cadir="$tmp/est-ca-dir" + mkdir -m 0700 "$cadir" + cadir_ok=0 + started_pid="" + if [ -f "$tmp/tls.crt" ] && + start_server "$tmp/cadir-1.log" --proto est \ + --tls-cert "$tmp/tls.crt" --tls-key "$tmp/tls.key" \ + --est-allow-anonymous --ca-dir "$cadir"; then + cadir_url="https://127.0.0.1:$port/.well-known/est" + if "$CLI" getcacerts --proto est --url "$cadir_url" \ + --trust "$tmp/pin-ca.pem" --out-cert "$tmp/cadir-ca1.pem" \ + >"$tmp/cadir.log" 2>&1 && + "$CLI" enroll --proto est --url "$cadir_url" \ + --trust "$tmp/pin-ca.pem" --key-type rsa:2048 \ + --subject "CN=ca-dir" \ + --out-key "$tmp/cadir.key" --out-cert "$tmp/cadir.crt" \ + >>"$tmp/cadir.log" 2>&1; then + cadir_ok=1 + case "$(ls -l "$cadir/ca.key.der")" in + -rw-------*) echo "ok --ca-dir keeps the CA key 0600" ;; + *) + echo "FAIL: --ca-dir CA key mode" + fails=$((fails + 1)) + ;; + esac + if "$CLI" reenroll --proto est --url "$cadir_url" \ + --trust "$tmp/pin-ca.pem" --cert "$tmp/cadir.crt" \ + --key "$tmp/cadir.key" \ + --out-cert "$tmp/cadir-untrusted.crt" \ + >>"$tmp/cadir.log" 2>&1; then + echo "FAIL: reenroll without --tls-trust-issued succeeded" + fails=$((fails + 1)) + else + echo "ok reenroll needs --tls-trust-issued" + fi + fi + fi + kill "$started_pid" 2>/dev/null + wait "$started_pid" 2>/dev/null + started_pid="" + if [ "$trust_issued_ok" -eq 0 ]; then + echo "skip --ca-dir renewal (wolfSSL lacks KEEP_PEER_CERT)" + elif [ "$cadir_ok" -eq 1 ] && + start_server "$tmp/cadir-2.log" --proto est \ + --tls-cert "$tmp/tls.crt" --tls-key "$tmp/tls.key" \ + --est-allow-anonymous --ca-dir "$cadir" \ + --tls-trust-issued; then + cadir_url="https://127.0.0.1:$port/.well-known/est" + if "$CLI" getcacerts --proto est --url "$cadir_url" \ + --trust "$tmp/pin-ca.pem" --out-cert "$tmp/cadir-ca2.pem" \ + >>"$tmp/cadir.log" 2>&1 && + cmp -s "$tmp/cadir-ca1.pem" "$tmp/cadir-ca2.pem" && + "$CLI" reenroll --proto est --url "$cadir_url" \ + --trust "$tmp/pin-ca.pem" --cert "$tmp/cadir.crt" \ + --key "$tmp/cadir.key" --out-cert "$tmp/cadir-renewed.crt" \ + >>"$tmp/cadir.log" 2>&1 && + grep -q "BEGIN CERTIFICATE" "$tmp/cadir-renewed.crt"; then + echo "ok --ca-dir keeps the CA and renews its certificates" + else + echo "FAIL: --ca-dir after a restart" + cat "$tmp/cadir.log" "$tmp/cadir-2.log" + fails=$((fails + 1)) + fi + kill "$started_pid" 2>/dev/null + started_pid="" + else + skip_group "--ca-dir (no EST server with --ca-dir would start)" + cat "$tmp/cadir.log" "$tmp/cadir-1.log" 2>/dev/null + fi + # getnextca resolves the current CA through the same pin. expect_reject "getnextca with a mismatched --ca-fingerprint" \ "does not match --ca-fingerprint" \ diff --git a/tests/integration/test_est_mtls_roundtrip.c b/tests/integration/test_est_mtls_roundtrip.c index 2b305e3..87f2531 100644 --- a/tests/integration/test_est_mtls_roundtrip.c +++ b/tests/integration/test_est_mtls_roundtrip.c @@ -566,6 +566,412 @@ static int test_reenroll_under_approval(const uint8_t* tls_cert, size_t tls_cert return 0; } +/* tls_client_trust_issued: anonymous enroll still works, the issued cert + * renews over mTLS, and a cert from another CA is refused. */ +static int test_reenroll_trust_issued(const uint8_t* tls_cert, size_t tls_cert_len, + const uint8_t* tls_key, size_t tls_key_len, + const uint8_t* cli_cert, size_t cli_cert_len, + const uint8_t* cli_key, size_t cli_key_len) +{ + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertCertMeta meta = { .subject_dn = "CN=trust-issued" }; + WolfCertServerCfgSrv cfg = { + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .bind_port = 0, + TEST_CA_CFG, + .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, + .est_allow_anonymous_enroll = 1, + .tls_client_trust_issued = 1, + }; + WolfCertServer* srv = NULL; + WolfCertKey* k1 = NULL; + WolfCertKey* k2 = NULL; + WolfCertKey* foreign = NULL; + WolfCertBuffer ca_pem = { 0 }; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult issued = { 0 }; + WolfCertEstResult renewed = { 0 }; + WolfCertEstResult refused = { 0 }; + static const char anon_req[] = + "POST /.well-known/est/simplereenroll HTTP/1.1\r\n" + "Host: 127.0.0.1\r\nContent-Type: application/pkcs10\r\n" + "Content-Length: 4\r\nConnection: close\r\n\r\nAAAA"; + TestTlsConn conn; + char resp[1024]; + size_t resp_len = 0; + pthread_t tid; + char url[128]; + int rc; + + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + }; + REQUIRE(wolfcert_est_get_cacerts(&cli, WOLFCERT_ENCODING_PEM, &ca_pem) == WOLFCERT_OK); + + REQUIRE(wolfcert_key_generate(&kcfg, &k1) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(k1, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued) == + WOLFCERT_OK); + wolfcert_buffer_free(&csr); + + REQUIRE(wolfcert_key_generate(&kcfg, &k2) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(k2, &meta, &csr) == WOLFCERT_OK); + rc = wolfcert_est_simple_reenroll(&cli, issued.cert_pem.data, issued.cert_pem.len, k1, + csr.data, csr.len, &renewed); + wolfcert_buffer_free(&csr); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(memmem(renewed.cert_pem.data, renewed.cert_pem.len, "BEGIN CERTIFICATE", 17) != NULL); + + REQUIRE(wolfcert_key_from_pem(cli_key, cli_key_len, NULL, &foreign) == + WOLFCERT_OK); + meta.subject_dn = "CN=factory-bootstrap"; + REQUIRE(wolfcert_csr_build(foreign, &meta, &csr) == WOLFCERT_OK); + rc = wolfcert_est_simple_reenroll(&cli, cli_cert, cli_cert_len, foreign, + csr.data, csr.len, &refused); + /* The handshake refuses it, so no HTTP answer comes. */ + REQUIRE(rc != WOLFCERT_OK && rc != WOLFCERT_ERR_HTTP && + rc != WOLFCERT_ERR_AUTH); + REQUIRE(refused.cert_pem.data == NULL); + + /* Without a client certificate there is nothing to renew. */ + REQUIRE(test_tls_connect(&conn, wolfcert_server_port(srv), tls_cert, + tls_cert_len) == 0); + REQUIRE(test_tls_write(&conn, anon_req, sizeof(anon_req) - 1) == 0); + while (resp_len < sizeof(resp) - 1) { + int n = test_tls_read(&conn, resp + resp_len, + sizeof(resp) - 1 - resp_len); + if (n <= 0) + break; + resp_len += (size_t)n; + } + test_tls_close(&conn); + resp[resp_len] = '\0'; + REQUIRE(strncmp(resp, "HTTP/1.1 403", 12) == 0); + + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + srv = NULL; + wolfcert_buffer_free(&csr); + +#ifdef WOLFCERT_HAVE_SCEP + cfg.protocol = WOLFCERT_PROTO_SCEP; + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(srv == NULL); + cfg.protocol = WOLFCERT_PROTO_EST; +#endif + + /* With no other authenticator the server only renews, from a kept CA. */ + cfg.est_allow_anonymous_enroll = 0; + cfg.ca_cert = NULL; + cfg.ca_cert_len = 0; + cfg.ca_key = NULL; + cfg.ca_key_len = 0; + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(srv == NULL); + cfg.ca_cert = test_ca()->cert; + cfg.ca_cert_len = test_ca()->cert_len; + cfg.ca_key = test_ca()->key; + cfg.ca_key_len = test_ca()->key_len; + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + meta.subject_dn = "CN=trust-issued"; + REQUIRE(wolfcert_csr_build(k2, &meta, &csr) == WOLFCERT_OK); + wolfcert_clear_error(); + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &refused); + REQUIRE(rc == WOLFCERT_ERR_AUTH); + REQUIRE(strstr(wolfcert_last_error_message(), "HTTP 403") != NULL); + REQUIRE(refused.cert_pem.data == NULL); + wolfcert_est_result_free(&issued); + rc = wolfcert_est_simple_reenroll(&cli, renewed.cert_pem.data, renewed.cert_pem.len, k2, + csr.data, csr.len, &issued); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(memmem(issued.cert_pem.data, issued.cert_pem.len, "BEGIN CERTIFICATE", 17) != NULL); + + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + wolfcert_buffer_free(&csr); + wolfcert_est_result_free(&renewed); + wolfcert_est_result_free(&issued); + wolfcert_buffer_free(&ca_pem); + wolfcert_key_free(foreign); + wolfcert_key_free(k2); + wolfcert_key_free(k1); + return 0; +} +/* Without ECC the test server offers no TLS 1.2 suite: it loads no DH. */ +#if !defined(WOLFSSL_NO_TLS12) && defined(HAVE_ECC) +/* A TLS 1.2 session resumed from one authenticated by cert/key carries no + * peer certificate; write req on it and return the response's status line. */ +static int resumed_status(uint16_t port, const uint8_t* ca, size_t ca_len, + const WolfCertBuffer* cert, const WolfCertBuffer* key, + const char* req, char* status, size_t status_sz) +{ + TestTlsConn c; + WOLFSSL_SESSION* sess = NULL; + char resp[512]; + int n; + + REQUIRE(test_tls_setup(&c, port, ca, ca_len) == 0); + REQUIRE(wolfSSL_SetVersion(c.ssl, WOLFSSL_TLSV1_2) == WOLFSSL_SUCCESS); + REQUIRE(wolfSSL_use_certificate_buffer(c.ssl, cert->data, (long)cert->len, + WOLFSSL_FILETYPE_PEM) == + WOLFSSL_SUCCESS); + REQUIRE(wolfSSL_use_PrivateKey_buffer(c.ssl, key->data, (long)key->len, + WOLFSSL_FILETYPE_PEM) == + WOLFSSL_SUCCESS); + REQUIRE(wolfSSL_connect(c.ssl) == WOLFSSL_SUCCESS); + sess = wolfSSL_get1_session(c.ssl); + test_tls_close(&c); + REQUIRE(sess != NULL); + + REQUIRE(test_tls_setup(&c, port, ca, ca_len) == 0); + REQUIRE(wolfSSL_SetVersion(c.ssl, WOLFSSL_TLSV1_2) == WOLFSSL_SUCCESS); + REQUIRE(wolfSSL_set_session(c.ssl, sess) == WOLFSSL_SUCCESS); + REQUIRE(wolfSSL_connect(c.ssl) == WOLFSSL_SUCCESS); + wolfSSL_SESSION_free(sess); + REQUIRE(wolfSSL_session_reused(c.ssl) == 1); + REQUIRE(test_tls_write(&c, req, strlen(req)) == 0); + n = test_tls_read(&c, resp, sizeof(resp) - 1); + test_tls_close(&c); + REQUIRE(n > 0); + resp[n] = '\0'; + snprintf(status, status_sz, "%.*s", (int)strcspn(resp, "\r"), resp); + return 0; +} +#endif + +/* tls_client_trust_issued next to a client CA that is another wolfCert CA, + * with the same subject: a certificate from either CA verifies, and one this + * server issued renews but does not enroll. */ +static int test_trust_issued_with_client_ca(const uint8_t* tls_cert, + size_t tls_cert_len, + const uint8_t* tls_key, + size_t tls_key_len) +{ + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertCertMeta meta = { .subject_dn = "CN=bootstrap" }; + WolfCertServerCfgSrv cfg = { + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .bind_port = 0, + .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, + .est_allow_anonymous_enroll = 1, + }; + WolfCertServer* srv = NULL; + WolfCertKey* kb = NULL; + WolfCertKey* k1 = NULL; + WolfCertKey* k2 = NULL; + WolfCertBuffer other_ca = { 0 }; + WolfCertBuffer none = { 0 }; + WolfCertEstResult boot = { 0 }; + WolfCertEstResult issued = { 0 }; + WolfCertEstResult renewed = { 0 }; + WolfCertEstResult refused = { 0 }; + WolfCertBuffer csr = { 0 }; + WolfCertBuffer boot_key = { 0 }; + WolfCertBuffer k1_pem = { 0 }; + char status[64]; + pthread_t tid; + char url[128]; + int rc; + + /* A second CA, as another wolfcert-server would generate it. */ + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + }; + REQUIRE(wolfcert_est_get_cacerts(&cli, WOLFCERT_ENCODING_PEM, + &other_ca) == WOLFCERT_OK); + REQUIRE(wolfcert_key_generate(&kcfg, &kb) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(kb, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &boot) == + WOLFCERT_OK); + wolfcert_buffer_free(&csr); + REQUIRE(wolfcert_key_to_pem(kb, &boot_key) == WOLFCERT_OK); + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + srv = NULL; + + cfg.ca_cert = test_ca()->cert; + cfg.ca_cert_len = test_ca()->cert_len; + cfg.ca_key = test_ca()->key; + cfg.ca_key_len = test_ca()->key_len; + cfg.est_allow_anonymous_enroll = 0; + cfg.tls_client_ca_pem = other_ca.data; + cfg.tls_client_ca_pem_len = other_ca.len; + cfg.tls_client_trust_issued = 1; + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + + /* The client CA still demands a certificate, so no HTTP answer comes. */ + rc = wolfcert_est_get_cacerts(&cli, WOLFCERT_ENCODING_PEM, &none); + REQUIRE(rc != WOLFCERT_OK && rc != WOLFCERT_ERR_HTTP && + rc != WOLFCERT_ERR_AUTH); + + cli.client_cert = boot.cert_pem.data; + cli.client_cert_len = boot.cert_pem.len; + cli.client_key = boot_key.data; + cli.client_key_len = boot_key.len; + meta.subject_dn = "CN=issued-here"; + REQUIRE(wolfcert_key_generate(&kcfg, &k1) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(k1, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued) == + WOLFCERT_OK); + + /* A certificate this server issued does not authenticate an enroll. */ + REQUIRE(wolfcert_key_to_pem(k1, &k1_pem) == WOLFCERT_OK); + cli.client_cert = issued.cert_pem.data; + cli.client_cert_len = issued.cert_pem.len; + cli.client_key = k1_pem.data; + cli.client_key_len = k1_pem.len; + wolfcert_clear_error(); + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &refused); + wolfcert_buffer_free(&csr); + REQUIRE(rc == WOLFCERT_ERR_AUTH); + REQUIRE(strstr(wolfcert_last_error_message(), "HTTP 403") != NULL); + REQUIRE(refused.cert_pem.data == NULL); + + REQUIRE(wolfcert_key_generate(&kcfg, &k2) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(k2, &meta, &csr) == WOLFCERT_OK); + rc = wolfcert_est_simple_reenroll(&cli, issued.cert_pem.data, issued.cert_pem.len, k1, + csr.data, csr.len, &renewed); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(memmem(renewed.cert_pem.data, renewed.cert_pem.len, "BEGIN CERTIFICATE", 17) != NULL); + +#if !defined(WOLFSSL_NO_TLS12) && defined(HAVE_ECC) + /* A resumed session cannot enroll: 403 when SESSION_CERTS keeps its + * certificate, 500 when there is none to check. */ + REQUIRE(resumed_status(wolfcert_server_port(srv), tls_cert, tls_cert_len, + &issued.cert_pem, &k1_pem, + "POST /.well-known/est/simpleenroll HTTP/1.1\r\n" + "Host: 127.0.0.1\r\n" + "Content-Type: application/pkcs10\r\n" + "Content-Length: 4\r\nConnection: close\r\n" + "\r\nAAAA", status, sizeof(status)) == 0); + REQUIRE(strcmp(status, "HTTP/1.1 500 Server Error") == 0 || + strncmp(status, "HTTP/1.1 403", 12) == 0); +#endif + + /* With Basic, a certificate issued here no longer blocks an enroll. */ + WolfCertEstResult with_basic = { 0 }; + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + srv = NULL; + cfg.http_basic_user = "alice"; + cfg.http_basic_pass = "secret"; + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + cli.proto_opts.est.username = "alice"; + cli.proto_opts.est.password = "secret"; + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &with_basic); + REQUIRE(rc == WOLFCERT_OK); + REQUIRE(with_basic.status == WOLFCERT_EST_STATUS_SUCCESS); + wolfcert_est_result_free(&with_basic); + + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + wolfcert_buffer_free(&csr); + wolfcert_est_result_free(&renewed); + wolfcert_est_result_free(&issued); + wolfcert_est_result_free(&boot); + wolfcert_buffer_free(&other_ca); + wolfcert_buffer_free(&k1_pem); + wolfcert_buffer_free(&boot_key); + wolfcert_key_free(k2); + wolfcert_key_free(k1); + wolfcert_key_free(kb); + return 0; +} + +/* A pinned self-signed client certificate still enrolls next to + * tls_client_trust_issued. */ +static int test_trust_issued_pinned_self_signed(const uint8_t* tls_cert, + size_t tls_cert_len, const uint8_t* tls_key, size_t tls_key_len, + const uint8_t* cli_cert, size_t cli_cert_len, const uint8_t* cli_key, + size_t cli_key_len) +{ + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, + .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertCertMeta meta = { .subject_dn = "CN=pinned" }; + WolfCertServerCfgSrv cfg = { + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .bind_port = 0, + TEST_CA_CFG, + .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, + .tls_client_ca_pem = cli_cert, + .tls_client_ca_pem_len = cli_cert_len, + .tls_client_trust_issued = 1, + }; + WolfCertServer* srv = NULL; + WolfCertKey* k = NULL; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult issued = { 0 }; + pthread_t tid; + char url[128]; + int rc; + + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_OK); + REQUIRE(pthread_create(&tid, NULL, server_thread, srv) == 0); + snprintf(url, sizeof(url), "https://127.0.0.1:%u/.well-known/est", + wolfcert_server_port(srv)); + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + .client_cert = cli_cert, + .client_cert_len = cli_cert_len, + .client_key = cli_key, + .client_key_len = cli_key_len, + }; + REQUIRE(wolfcert_key_generate(&kcfg, &k) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(k, &meta, &csr) == WOLFCERT_OK); + rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued); + + wolfcert_server_stop(srv); + pthread_join(tid, NULL); + wolfcert_server_free(srv); + REQUIRE(rc == WOLFCERT_OK); + wolfcert_est_result_free(&issued); + wolfcert_buffer_free(&csr); + wolfcert_key_free(k); + return 0; +} #endif /* KEEP_PEER_CERT */ #ifndef KEEP_PEER_CERT @@ -604,6 +1010,26 @@ static int test_reenroll_needs_peer_cert(const char* url, REQUIRE(issued.cert_pem.data == NULL); return 0; } + +/* tls_client_trust_issued cannot work without the peer certificate. */ +static int test_trust_issued_needs_peer_cert(const uint8_t* tls_cert, + size_t tls_cert_len, + const uint8_t* tls_key, + size_t tls_key_len) +{ + WolfCertServerCfgSrv cfg = { + .protocol = WOLFCERT_PROTO_EST, + .bind_host = "127.0.0.1", + .tls_cert_pem = tls_cert, .tls_cert_pem_len = tls_cert_len, + .tls_key_pem = tls_key, .tls_key_pem_len = tls_key_len, + .tls_client_trust_issued = 1, + }; + WolfCertServer* srv = NULL; + + REQUIRE(wolfcert_server_start(&cfg, &srv) == WOLFCERT_ERR_UNSUPPORTED); + REQUIRE(srv == NULL); + return 0; +} #endif int main(void) @@ -722,6 +1148,8 @@ int main(void) REQUIRE(test_reenroll_needs_peer_cert(url, tls_cert, tls_cert_len, cli_cert, cli_cert_len, cli_key, cli_key_len) == 0); + REQUIRE(test_trust_issued_needs_peer_cert(tls_cert, tls_cert_len, + tls_key, tls_key_len) == 0); printf("skip reenroll cases: wolfSSL built without KEEP_PEER_CERT\n"); #endif @@ -738,6 +1166,16 @@ int main(void) tls_key, tls_key_len, cli_cert, cli_cert_len, cli_key, cli_key_len) == 0); + REQUIRE(test_reenroll_trust_issued(tls_cert, tls_cert_len, + tls_key, tls_key_len, + cli_cert, cli_cert_len, + cli_key, cli_key_len) == 0); + REQUIRE(test_trust_issued_with_client_ca(tls_cert, tls_cert_len, + tls_key, tls_key_len) == 0); + REQUIRE(test_trust_issued_pinned_self_signed(tls_cert, tls_cert_len, + tls_key, tls_key_len, + cli_cert, cli_cert_len, + cli_key, cli_key_len) == 0); #endif free(tls_cert); diff --git a/tests/unit/test_server_ca.c b/tests/unit/test_server_ca.c index 8f2b28c..3f4e4bd 100644 --- a/tests/unit/test_server_ca.c +++ b/tests/unit/test_server_ca.c @@ -801,8 +801,10 @@ static int test_pkcs8_ca_key_normalized(void) #endif #ifdef WOLFCERT_HAVE_ECC -/* A self-signed non-CA certificate and its key. */ -static int make_leaf_pair(WolfCertBuffer* cert_out, WolfCertBuffer* key_out) +/* A self-signed certificate with a skid_len-byte subject key id, or none, and + * its key. */ +static int make_self_pair(int is_ca, int skid_len, WolfCertBuffer* cert_out, + WolfCertBuffer* key_out) { WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, .dev_id = WOLFCERT_DEVID_SOFTWARE }; @@ -825,8 +827,10 @@ static int make_leaf_pair(WolfCertBuffer* cert_out, WolfCertBuffer* key_out) wc_InitCert(&cert); snprintf(cert.subject.commonName, sizeof(cert.subject.commonName), "%s", "wolfCert Leaf"); - cert.isCA = 0; + cert.isCA = is_ca; cert.selfSigned = 1; + memset(cert.skid, 0x5a, (size_t)skid_len); + cert.skidSz = skid_len; cert.daysValid = 30; cert.sigType = CTC_SHA256wECDSA; @@ -851,7 +855,7 @@ static int test_leaf_ca_rejected(void) WolfCertBuffer cert = { 0 }; WolfCertBuffer key = { 0 }; - if (make_leaf_pair(&cert, &key)) + if (make_self_pair(0, 0, &cert, &key)) return 1; if (start_gets(&cert, &key, WOLFCERT_ERR_PARSE)) return 1; @@ -860,6 +864,61 @@ static int test_leaf_ca_rejected(void) wolfcert_buffer_free_secure(&key); return 0; } + +/* A loaded CA without a subject key id, or with one wolfSSL would hash, + * issues without an authority key id; a generated CA's leaves carry it. */ +static int test_issued_key_ids(void) +{ + static const uint8_t san[] = { + 0x30, 0x0b, 0x82, 0x09, 'k', '.', 'e', 'x', 'a', 'm', 'p', 'l', 'e' + }; + WolfCertBuffer cert = { 0 }; + WolfCertBuffer key = { 0 }; + uint8_t* issued = NULL; + size_t issued_len = 0; + DecodedCert ca_dc; + DecodedCert leaf_dc; + int skid_len; + int rc = -1; + int ok; + + for (skid_len = 0; skid_len <= 8; skid_len += 8) { + if (make_self_pair(1, skid_len, &cert, &key)) + return 1; + REQUIRE(issue_with_san(&cert, &key, san, sizeof(san), &rc, &issued, + &issued_len) == 0); + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); + REQUIRE(rc == WOLFCERT_OK); + wc_InitDecodedCert(&leaf_dc, issued, (word32)issued_len, NULL); + ok = wc_ParseCert(&leaf_dc, CERT_TYPE, NO_VERIFY, NULL) == 0 && + !leaf_dc.extAuthKeyIdSet; + wc_FreeDecodedCert(&leaf_dc); + WOLFCERT_XFREE(issued, wolfcert_default_heap()); + issued = NULL; + REQUIRE(ok); + } + + if (generate_ca(WOLFCERT_KEY_ECC, WOLFCERT_ENCODING_DER, &cert, &key)) + return 1; + REQUIRE(issue_with_san(&cert, &key, san, sizeof(san), &rc, &issued, + &issued_len) == 0); + REQUIRE(rc == WOLFCERT_OK); + wc_InitDecodedCert(&ca_dc, cert.data, (word32)cert.len, NULL); + wc_InitDecodedCert(&leaf_dc, issued, (word32)issued_len, NULL); + ok = wc_ParseCert(&ca_dc, CERT_TYPE, NO_VERIFY, NULL) == 0 && + wc_ParseCert(&leaf_dc, CERT_TYPE, NO_VERIFY, NULL) == 0 && + ca_dc.extSubjKeyIdSet && leaf_dc.extAuthKeyIdSet && + memcmp(ca_dc.extSubjKeyId, leaf_dc.extAuthKeyId, + sizeof(ca_dc.extSubjKeyId)) == 0; + wc_FreeDecodedCert(&leaf_dc); + wc_FreeDecodedCert(&ca_dc); + WOLFCERT_XFREE(issued, wolfcert_default_heap()); + wolfcert_buffer_free(&cert); + wolfcert_buffer_free_secure(&key); + REQUIRE(ok); + return 0; +} #endif /* WOLFCERT_HAVE_ECC */ static int test_bad_bind_host_rejected(void) @@ -933,6 +992,8 @@ int main(void) if (test_issued_san_verbatim()) return 1; #ifdef WOLFCERT_HAVE_ECC + if (test_issued_key_ids()) + return 1; if (test_leaf_ca_rejected()) return 1; #endif diff --git a/wolfcert/server.h b/wolfcert/server.h index 1063ce9..d3bff07 100644 --- a/wolfcert/server.h +++ b/wolfcert/server.h @@ -47,9 +47,10 @@ typedef struct { /* TLS identity, required for EST (wolfcert_server_start() returns * WOLFCERT_ERR_TLS without it) and optional for SCEP. tls_client_ca_pem - * enables mutual TLS; EST /simplereenroll needs it (else 403) and a - * wolfSSL built with KEEP_PEER_CERT (else 500). All three PEM buffers - * are copied by wolfcert_server_start(). */ + * enables mutual TLS; EST /simplereenroll needs it or + * tls_client_trust_issued (else 403) and a wolfSSL built with + * KEEP_PEER_CERT (else 500). All three PEM buffers are copied by + * wolfcert_server_start(). */ const uint8_t* tls_cert_pem; size_t tls_cert_pem_len; const uint8_t* tls_key_pem; @@ -111,6 +112,11 @@ typedef struct { size_t ca_cert_len; const uint8_t* ca_key; size_t ca_key_len; + + /* EST: accept client certificates this CA issued, for /simplereenroll + * only, so with tls_client_ca_pem naming this CA /simpleenroll needs + * Basic. Needs KEEP_PEER_CERT, else start returns UNSUPPORTED. */ + int tls_client_trust_issued; } WolfCertServerCfgSrv; WOLFCERT_API int wolfcert_server_start(const WolfCertServerCfgSrv* cfg, WolfCertServer** out); From e65e79b0d120df89255969f789a886ae28f0e3e0 Mon Sep 17 00:00:00 2001 From: Tobias Frauenschlaeger Date: Sun, 18 Oct 2026 06:15:44 +0000 Subject: [PATCH 13/17] Add an EST example with keys in a TPM examples/enroll_tpm.c enrolls, re-enrolls and rotates a key that stays in a TPM, using wolfTPM's CryptoCb with the key's TPM handle as key_id. enroll generates the key in the TPM, either persisted at a free persistent handle or, for 0x80000000, loaded at a transient handle the TPM picks and the example prints. reenroll rebuilds the key handle from the certificate with wolfcert_key_from_id in a new process and authenticates /simplereenroll with it, optionally moving to a new key and evicting or unloading the old one. It refuses a persistent handle that is in use or that the TPM cannot check, and any other transient handle for a new key, removes the key it generated when the enrollment fails, and reports an old key it cannot remove. It refuses to rotate a persistent key to a transient one, which would not survive a TPM reset. Key types are ECC P-256 and P-384, RSA-2048 and, with a wolfTPM built for TPM 2.0 v1.85, ML-DSA-44, -65 and -87. It needs a wolfTPM whose CryptoCb resolves key ids; it still builds against an older one, where wolfcert_key_generate refuses the software key it would get. A certificate is written to a temporary file created exclusively, flushed and fsynced, then renamed into place, so renewing with OUT_CERT equal to CERT cannot lose the old certificate. One that cannot be kept goes to stderr: the renewed certificate when only the write failed, or one to revoke when its new key was evicted again. CMake builds it when find_package(wolftpm) succeeds and the wolfTPM has its CryptoCb and wolfSSL key ids, and otherwise skips it with a message. It runs against a TPM or wolfTPM's fwTPM, with wolfcert-server --ca-dir DIR --tls-trust-issued as the CA. A transient key outlives the process only on a TPM without a resource manager, such as the fwTPM. --- AGENTS.md | 5 +- README.md | 6 +- docs/ARCHITECTURE.md | 14 +- examples/CMakeLists.txt | 28 +++ examples/enroll_tpm.c | 432 ++++++++++++++++++++++++++++++++++++++++ 5 files changed, 481 insertions(+), 4 deletions(-) create mode 100644 examples/enroll_tpm.c diff --git a/AGENTS.md b/AGENTS.md index dc6e54d..4c61a7c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -177,7 +177,8 @@ wolfcert_cleanup(); `wolfcert_client_reenroll` return `WOLFCERT_ERR_PENDING`. - **Renewal:** `wolfcert_client_reenroll` (EST, authenticates with the certificate being renewed) or `wolfcert_scep_renewal_req`. -- **Hardware keys:** `examples/enroll_cryptocb.c`. +- **Hardware keys:** `examples/enroll_cryptocb.c`, and `examples/enroll_tpm.c` + for a TPM through wolfTPM. ## Where to look @@ -190,7 +191,7 @@ wolfcert_cleanup(); | `wolfcert/keygen.h`, `wolfcert/csr.h` | Key generation, import / export, CSR building | | `wolfcert/errors.h`, `wolfcert/status.h`, `wolfcert/log.h` | Error codes, last-error detail, log callback | | `wolfcert/memory.h` | Default heap hint, allocation macros | -| `examples/` | `enroll_est.c`, `enroll_scep.c`, `enroll_cryptocb.c`, `user_settings.h.example` | +| `examples/` | `enroll_est.c`, `enroll_scep.c`, `enroll_cryptocb.c`, `enroll_tpm.c`, `user_settings.h.example` | | `examples/certs/` | Test credentials; never ship them | | `zephyr/samples/wolfcert_est_client/` | EST client on Zephyr (qemu_x86, FRDM-MCXN947) | | `src/` | Implementation; `src/internal.h` is not for applications | diff --git a/README.md b/README.md index 60fbca5..45bf521 100644 --- a/README.md +++ b/README.md @@ -183,7 +183,11 @@ trusted. The signature digest floors at SHA-256 and needs no such override. To call the library directly, see `examples/enroll_est.c`, -`examples/enroll_scep.c`, and `examples/enroll_cryptocb.c`. +`examples/enroll_scep.c`, `examples/enroll_cryptocb.c` and +`examples/enroll_tpm.c`. CMake builds the TPM example as +`example_enroll_tpm` when it finds a wolfTPM with its CryptoCb (pass +`-Dwolftpm_DIR=/lib/cmake/wolftpm`). See +[wolfTPM](https://github.com/wolfSSL/wolfTPM). ### Integrating with a wolfSSL static-memory pool diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 0c05cea..5a029e0 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -394,6 +394,17 @@ signing and decryption take the private key as DER, so the SCEP calls return `WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`. See `examples/enroll_cryptocb.c` for the registration pattern. +`examples/enroll_tpm.c` enrolls and re-enrolls over EST with an ECC, RSA or +ML-DSA key in a TPM. It needs a wolfTPM whose CryptoCb reads a 4-byte +`key_id` as a persistent or transient handle. A key generated under a +persistent handle is stored there. Under `0x80000000` +(`WOLFTPM2_KEYID_TRANSIENT`) the TPM loads it at a transient handle it picks; +a TPM reset drops that key, and so does `/dev/tpmrm0` when the process exits. +An older wolfTPM generates the key in software, which `wolfcert_key_generate` +refuses. ML-DSA needs a TPM with the v1.85 commands, such as wolfTPM's fwTPM. +For a test CA that renews the certificates it issued, start the EST server +from README.md with `--ca-dir DIR --tls-trust-issued` added. + ### 4.3 Keep-alive sessions and non-blocking I/O A session keeps one connection for several requests. Open one when a flow @@ -738,4 +749,5 @@ one key algorithm must be present. - `wolfcert/*.h` — the authoritative API reference; each public function and field states its contract, alone or in a group comment. - `examples/enroll_est.c`, `examples/enroll_scep.c`, - `examples/enroll_cryptocb.c` — runnable minimal integrations. + `examples/enroll_cryptocb.c`, `examples/enroll_tpm.c` - runnable minimal + integrations. diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index 892613b..32f33b3 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -7,6 +7,34 @@ if(WOLFCERT_ENABLE_EST) if(_have_WOLF_CRYPTO_CB) add_executable(example_enroll_cryptocb enroll_cryptocb.c) target_link_libraries(example_enroll_cryptocb PRIVATE wolfcert) + + if(TARGET PkgConfig::WOLFSSL) + set(_wc_example_wolfssl PkgConfig::WOLFSSL) + else() + set(_wc_example_wolfssl wolfssl::wolfssl) + endif() + + find_package(wolftpm CONFIG QUIET) + unset(_have_tpm_key_id CACHE) + if(TARGET wolfssl::wolftpm) + set(CMAKE_REQUIRED_LIBRARIES wolfssl::wolftpm ${_wc_example_wolfssl}) + check_c_source_compiles("${_wc_wolfssl_prologue} + #include + #if !defined(WOLFTPM_CRYPTOCB) || !defined(WOLF_PRIVATE_KEY_ID) + #error missing + #endif + int main(void) { return 0; } + " _have_tpm_key_id) + unset(CMAKE_REQUIRED_LIBRARIES) + endif() + if(_have_tpm_key_id) + add_executable(example_enroll_tpm enroll_tpm.c) + target_link_libraries(example_enroll_tpm + PRIVATE wolfcert wolfssl::wolftpm) + else() + message(STATUS "wolfCert: wolfTPM not found or without its " + "CryptoCb, skipping examples/enroll_tpm.c") + endif() endif() endif() diff --git a/examples/enroll_tpm.c b/examples/enroll_tpm.c new file mode 100644 index 0000000..1f31653 --- /dev/null +++ b/examples/enroll_tpm.c @@ -0,0 +1,432 @@ +/* + * Copyright (C) 2026 wolfSSL Inc. + * + * This file is part of wolfCert. + * + * wolfCert is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * wolfCert is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with wolfCert. If not, see . + */ + +/* + * EST enrollment and re-enrollment with a private key that stays in a TPM. + * The key_id is the key's 4-byte TPM handle, persistent (0x81xxxxxx) or + * transient (0x80xxxxxx). A new key goes to a free persistent handle, or for + * 0x80000000 to a transient handle the TPM picks. A TPM resource manager such + * as /dev/tpmrm0 flushes a transient key when the process exits. + * + * Usage: + * enroll_tpm enroll URL TRUST_PEM SUBJECT KEY_TYPE HANDLE OUT_CERT + * enroll_tpm reenroll URL TRUST_PEM KEY_TYPE HANDLE CERT OUT_CERT + * [NEW_HANDLE] + * KEY_TYPE is ecc:256, ecc:384, rsa:2048 or, with a wolfTPM built for + * TPM 2.0 v1.85, mldsa:44, mldsa:65 or mldsa:87. e.g. + * ./enroll_tpm enroll https://127.0.0.1:8443/.well-known/est ca.pem \ + * "CN=device-42" ecc:256 0x81000100 dev.crt + * ./enroll_tpm reenroll https://127.0.0.1:8443/.well-known/est ca.pem \ + * ecc:256 0x81000100 dev.crt dev2.crt 0x81000101 + */ + +#define _POSIX_C_SOURCE 200809L + +#include +#ifndef WOLFCERT_HAVE_EST +# error "examples/enroll_tpm.c needs wolfCert built with EST enabled" +#endif + +#include +#if !defined(WOLFTPM_CRYPTOCB) || !defined(WOLF_PRIVATE_KEY_ID) +# error "examples/enroll_tpm.c needs wolfTPM's CryptoCb and wolfSSL key ids" +#endif +/* An older wolfTPM lacks it, and keygen then fails at run time */ +#ifndef WOLFTPM2_KEYID_TRANSIENT +# define WOLFTPM2_KEYID_TRANSIENT TRANSIENT_FIRST +#endif + +#include +#include +#include +#include + +typedef struct { + WOLFTPM2_DEV dev; + WOLFTPM2_KEY srk; + TpmCryptoDevCtx ctx; + int dev_id; +} Tpm; + +static uint8_t* read_whole(const char* path, size_t* out_len) +{ + FILE* f = fopen(path, "rb"); + if (!f) + return NULL; + + long len = -1; + if (fseek(f, 0, SEEK_END) == 0) + len = ftell(f); + if (len <= 0 || fseek(f, 0, SEEK_SET) != 0) { + fclose(f); + return NULL; + } + uint8_t* b = (uint8_t*)malloc((size_t)len); + if (!b || fread(b, 1, (size_t)len, f) != (size_t)len) { + free(b); + fclose(f); + return NULL; + } + + fclose(f); + *out_len = (size_t)len; + return b; +} + +/* Writes through a synced temporary file, so a failure keeps the old file. */ +static int write_whole(const char* path, const WolfCertBuffer* b) +{ + char tmp[4096]; + + if (snprintf(tmp, sizeof(tmp), "%s.tmp", path) >= (int)sizeof(tmp)) + return -1; + remove(tmp); + FILE* f = fopen(tmp, "wbx"); + if (!f) + return -1; + + int ok = fwrite(b->data, 1, b->len, f) == b->len; + ok = ok && fflush(f) == 0 && fsync(fileno(f)) == 0; + ok = fclose(f) == 0 && ok; + if (ok && rename(tmp, path) == 0) + return 0; + remove(tmp); + return -1; +} + +static const struct { + const char* name; + WolfCertKeyType type; + int param; +} key_types[] = { + { "ecc:256", WOLFCERT_KEY_ECC, 256 }, + { "ecc:384", WOLFCERT_KEY_ECC, 384 }, + { "rsa:2048", WOLFCERT_KEY_RSA, 2048 }, +#ifdef WOLFTPM_MLDSA_SIGN + { "mldsa:44", WOLFCERT_KEY_MLDSA44, 0 }, + { "mldsa:65", WOLFCERT_KEY_MLDSA65, 0 }, + { "mldsa:87", WOLFCERT_KEY_MLDSA87, 0 }, +#endif +}; + +static int parse_key_type(const char* s, WolfCertKeyCfg* cfg) +{ + for (size_t i = 0; i < sizeof(key_types) / sizeof(key_types[0]); i++) { + if (strcmp(s, key_types[i].name) == 0) { + cfg->type = key_types[i].type; + cfg->param = key_types[i].param; + return 0; + } + } + fprintf(stderr, "unknown KEY_TYPE %s\n", s); + return -1; +} + +static int parse_handle(const char* s, TPM_HANDLE* h, uint8_t id[4]) +{ + char* end = NULL; + unsigned long v = strtoul(s, &end, 0); + + if (end == s || *end != '\0' || + ((v >> HR_SHIFT) != TPM_HT_PERSISTENT && + (v >> HR_SHIFT) != TPM_HT_TRANSIENT)) { + fprintf(stderr, "HANDLE %s is not a persistent (0x81xxxxxx) or " + "transient (0x80xxxxxx) handle\n", s); + return -1; + } + *h = (TPM_HANDLE)v; + id[0] = (uint8_t)(v >> 24); + id[1] = (uint8_t)(v >> 16); + id[2] = (uint8_t)(v >> 8); + id[3] = (uint8_t)v; + return 0; +} + +static void tpm_close(Tpm* t) +{ + if (t->dev_id != INVALID_DEVID) + wolfTPM2_ClearCryptoDevCb(&t->dev, t->dev_id); + if (t->srk.handle.hndl != 0) + wolfTPM2_UnloadHandle(&t->dev, &t->srk.handle); + wolfTPM2_Cleanup(&t->dev); +} + +static int tpm_open(Tpm* t) +{ + memset(t, 0, sizeof(*t)); + t->dev_id = INVALID_DEVID; + + /* /dev/tpmrm0 and socket TPMs such as the fwTPM take no I/O callback. */ + int rc = wolfTPM2_Init(&t->dev, NULL, NULL); + if (rc != 0) { + fprintf(stderr, "TPM: %s\n", wolfTPM2_GetRCString(rc)); + return rc; + } + rc = wolfTPM2_CreateSRK(&t->dev, &t->srk, TPM_ALG_ECC, NULL, 0); + if (rc == 0) { + t->ctx.storageKey = &t->srk; + rc = wolfTPM2_SetCryptoDevCb(&t->dev, wolfTPM2_CryptoDevCb, &t->ctx, + &t->dev_id); + } + if (rc != 0) { + fprintf(stderr, "TPM: %s\n", wolfTPM2_GetRCString(rc)); + tpm_close(t); + } + return rc; +} + +static int new_handle_ok(Tpm* t, TPM_HANDLE handle) +{ + WOLFTPM2_KEY k; + int ok; + + memset(&k, 0, sizeof(k)); + if ((handle >> HR_SHIFT) == TPM_HT_TRANSIENT) + ok = handle == WOLFTPM2_KEYID_TRANSIENT; + else { + int rc = wolfTPM2_ReadPublicKey(&t->dev, &k, handle); + + ok = rc > 0 && (rc & RC_MAX_FMT1) == TPM_RC_HANDLE; + if (rc != 0 && !ok) { + fprintf(stderr, "cannot check TPM handle 0x%08x (%s)\n", + (unsigned)handle, wolfTPM2_GetRCString(rc)); + return 0; + } + } + if (!ok) + fprintf(stderr, "a new key needs a free persistent handle or 0x%08x, " + "not 0x%08x\n", (unsigned)WOLFTPM2_KEYID_TRANSIENT, + (unsigned)handle); + return ok; +} + +/* The handle the TPM holds a key under, 0 if it has no key_id */ +static TPM_HANDLE key_handle(const WolfCertKey* key) +{ + const uint8_t* id = NULL; + size_t len = 0; + + if (key == NULL || wolfcert_key_id(key, &id, &len) != WOLFCERT_OK || + len != 4) + return 0; + return ((TPM_HANDLE)id[0] << 24) | ((TPM_HANDLE)id[1] << 16) | + ((TPM_HANDLE)id[2] << 8) | (TPM_HANDLE)id[3]; +} + +static int evict(Tpm* t, TPM_HANDLE handle) +{ + WOLFTPM2_KEY k; + + memset(&k, 0, sizeof(k)); + int rc = wolfTPM2_ReadPublicKey(&t->dev, &k, handle); + if (rc == 0 && (handle >> HR_SHIFT) == TPM_HT_PERSISTENT) + rc = wolfTPM2_NVDeleteKey(&t->dev, TPM_RH_OWNER, &k); + else if (rc == 0) + rc = wolfTPM2_UnloadHandle(&t->dev, &k.handle); + if (rc != 0) + fprintf(stderr, "cannot evict TPM handle 0x%08x (%s); clear it by " + "hand\n", (unsigned)handle, wolfTPM2_GetRCString(rc)); + return rc; +} + +static void report(const char* what, int rc) +{ + const char* m = wolfcert_last_error_message(); + fprintf(stderr, "%s failed: %s%s%s\n", what, wolfcert_strerror(rc), + m != NULL && *m != '\0' ? ": " : "", m != NULL ? m : ""); +} + +/* Shows a certificate that was issued but could not be kept. */ +static void show_cert(const char* why, const WolfCertBuffer* cert) +{ + fprintf(stderr, "%s:\n", why); + fwrite(cert->data, 1, cert->len, stderr); +} + +/* URL TRUST_PEM SUBJECT KEY_TYPE HANDLE OUT_CERT */ +static int cmd_enroll(Tpm* t, const WolfCertServerCfg* srv, char** argv) +{ + WolfCertKeyCfg kcfg = { .dev_id = t->dev_id }; + WolfCertCertMeta meta = { .subject_dn = argv[2] }; + WolfCertClient* client = NULL; + WolfCertKey* key = NULL; + WolfCertBuffer cert = { 0 }; + TPM_HANDLE handle; + uint8_t id[4]; + + if (parse_key_type(argv[3], &kcfg) != 0 || + parse_handle(argv[4], &handle, id) != 0) + return 1; + kcfg.key_id = id; + kcfg.key_id_len = sizeof(id); + if (!new_handle_ok(t, handle)) + return 1; + + int rc = wolfcert_client_new(&client); + if (rc == WOLFCERT_OK) + rc = wolfcert_client_enroll(client, srv, &kcfg, &meta, &key, &cert); + if (rc != WOLFCERT_OK) { + report("enroll", rc); + } + else if (write_whole(argv[5], &cert) != 0) { + fprintf(stderr, "cannot write %s\n", argv[5]); + rc = WOLFCERT_ERR_IO; + } + else { + printf("enrolled: key in TPM handle 0x%08x, certificate in %s\n", + (unsigned)key_handle(key), argv[5]); + } + /* A key under a key_id comes back on failure too. */ + if (rc != WOLFCERT_OK && key_handle(key) != 0 && + evict(t, key_handle(key)) == 0 && cert.data != NULL) + show_cert("revoke this certificate, its key is evicted", &cert); + + wolfcert_buffer_free(&cert); + wolfcert_key_free(key); + wolfcert_client_free(client); + return rc == WOLFCERT_OK ? 0 : 2; +} + +/* URL TRUST_PEM KEY_TYPE HANDLE CERT OUT_CERT [NEW_HANDLE] */ +static int cmd_reenroll(Tpm* t, const WolfCertServerCfg* srv, int argc, + char** argv) +{ + WolfCertKeyCfg cur_cfg = { .dev_id = t->dev_id }; + WolfCertKeyCfg new_cfg; + WolfCertCertMeta meta = { 0 }; + WolfCertClient* client = NULL; + WolfCertKey* cur_key = NULL; + WolfCertKey* new_key = NULL; + WolfCertBuffer renewed = { 0 }; + TPM_HANDLE handle; + TPM_HANDLE new_handle = 0; + uint8_t id[4]; + uint8_t new_id[4]; + size_t cert_len = 0; + uint8_t* cert = NULL; + int rekey = argc > 6; + + if (parse_key_type(argv[2], &cur_cfg) != 0 || + parse_handle(argv[3], &handle, id) != 0 || + (rekey && parse_handle(argv[6], &new_handle, new_id) != 0)) + return 1; + if (rekey && !new_handle_ok(t, new_handle)) + return 1; + if (rekey && (handle >> HR_SHIFT) == TPM_HT_PERSISTENT && + (new_handle >> HR_SHIFT) == TPM_HT_TRANSIENT) { + fprintf(stderr, "NEW_HANDLE must be persistent when HANDLE is; a " + "transient key does not survive a TPM reset\n"); + return 1; + } + cur_cfg.key_id = id; + cur_cfg.key_id_len = sizeof(id); + new_cfg = cur_cfg; + new_cfg.key_id = new_id; + + cert = read_whole(argv[4], &cert_len); + if (cert == NULL) { + fprintf(stderr, "cannot read %s\n", argv[4]); + return 1; + } + + /* The certificate supplies the public half of the TPM key. */ + int rc = wolfcert_key_from_id(&cur_cfg, cert, cert_len, &cur_key); + if (rc == WOLFCERT_OK) + rc = wolfcert_client_new(&client); + if (rc == WOLFCERT_OK) + rc = wolfcert_client_reenroll(client, srv, cert, cert_len, cur_key, + rekey ? &new_cfg : NULL, &meta, + &new_key, &renewed); + if (rc != WOLFCERT_OK) { + report("reenroll", rc); + } + else if (write_whole(argv[5], &renewed) != 0) { + fprintf(stderr, "cannot write %s\n", argv[5]); + if (!rekey) + show_cert("the renewed certificate", &renewed); + rc = WOLFCERT_ERR_IO; + } + else if (rekey) { + printf("re-enrolled: new key in TPM handle 0x%08x, certificate in %s\n", + (unsigned)key_handle(new_key), argv[5]); + if (evict(t, handle) == 0) + printf("old key at TPM handle 0x%08x evicted\n", (unsigned)handle); + } + else { + printf("re-enrolled: key in TPM handle 0x%08x, certificate in %s\n", + (unsigned)handle, argv[5]); + } + if (rc != WOLFCERT_OK && key_handle(new_key) != 0 && + evict(t, key_handle(new_key)) == 0 && renewed.data != NULL) + show_cert("revoke this certificate, its key is evicted", &renewed); + + wolfcert_buffer_free(&renewed); + wolfcert_key_free(new_key); + wolfcert_key_free(cur_key); + wolfcert_client_free(client); + free(cert); + return rc == WOLFCERT_OK ? 0 : 2; +} + +int main(int argc, char** argv) +{ + int enroll = argc == 8 && strcmp(argv[1], "enroll") == 0; + int reenroll = (argc == 8 || argc == 9) && strcmp(argv[1], "reenroll") == 0; + + if (!enroll && !reenroll) { + fprintf(stderr, + "usage: %s enroll URL TRUST_PEM SUBJECT KEY_TYPE HANDLE " + "OUT_CERT\n" + " %s reenroll URL TRUST_PEM KEY_TYPE HANDLE CERT OUT_CERT " + "[NEW_HANDLE]\n" + "KEY_TYPE: ecc:256, ecc:384, rsa:2048" +#ifdef WOLFTPM_MLDSA_SIGN + ", mldsa:44, mldsa:65, mldsa:87" +#endif + "\n", argv[0], argv[0]); + return 1; + } + + size_t trust_len = 0; + uint8_t* trust = read_whole(argv[3], &trust_len); + if (trust == NULL) { + fprintf(stderr, "cannot read %s\n", argv[3]); + return 1; + } + + WolfCertServerCfg srv = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = argv[2], + .trust_anchors = trust, + .trust_anchors_len = trust_len, + .verify_server = 1, + }; + Tpm tpm; + int ret = 1; + + if (wolfcert_init(NULL) == WOLFCERT_OK && tpm_open(&tpm) == 0) { + ret = enroll ? cmd_enroll(&tpm, &srv, argv + 2) + : cmd_reenroll(&tpm, &srv, argc - 2, argv + 2); + tpm_close(&tpm); + } + + wolfcert_cleanup(); + free(trust); + return ret; +} From 219ffc81f8b975e6a41c1be15c47738d6c313790 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Fri, 23 Oct 2026 16:54:37 +0200 Subject: [PATCH 14/17] Run the TPM example against wolfTPM's fwTPM in CI examples/enroll_tpm.c only built where a developer had a wolfTPM installed, and no CI job had one, so a change that broke the example, or a wolfTPM change that broke key ids, went unnoticed. tests/interop/tpm_wolftpm.sh drives the example against fwtpm_server and wolfcert-server for ECC P-256 and P-384, RSA-2048 and ML-DSA-44/65/87: enroll, an occupied handle refused, a failed enroll that leaves the handle free, renewal in place after a restart of both servers, a rekey whose certificate cannot be written, a rekey that evicts the old key, the evicted key failing to renew, the rotated key renewing, a persistent key refused a transient successor, and a transient key renewed from another process. The fwTPM holds 8 persistent objects, so each key type runs against its own NV state. scripts/ci/build-wolftpm.sh builds wolfTPM's library and fwtpm_server with WOLFTPM_V185 forced on, so a wolfSSL without ML-DSA fails the build instead of the test. build-wolfssl.sh gains the wolftpm config: the canonical line plus --enable-wolftpm, which exports the sp_* API the fwTPM links, --enable-pkcallbacks and WC_RSA_NO_PADDING for its raw RSA. The tpm-interop action runs it all and fails when the example is not built, so a skipped probe cannot pass. pr.yml runs it against the merge of wolfTPM #638, the first commit with key ids, until a wolfTPM release has them; interop.yml runs it nightly against wolfTPM master and seeds the wolftpm wolfSSL cache the PR job restores. --- .github/actions/tpm-interop/action.yml | 64 ++++++++ .github/workflows/interop.yml | 12 ++ .github/workflows/pr.yml | 12 ++ docs/CI.md | 9 +- docs/INTEROP.md | 2 + scripts/ci/build-wolfssl.sh | 7 +- scripts/ci/build-wolftpm.sh | 63 +++++++ tests/interop/tpm_wolftpm.sh | 217 +++++++++++++++++++++++++ 8 files changed, 381 insertions(+), 5 deletions(-) create mode 100644 .github/actions/tpm-interop/action.yml create mode 100755 scripts/ci/build-wolftpm.sh create mode 100755 tests/interop/tpm_wolftpm.sh diff --git a/.github/actions/tpm-interop/action.yml b/.github/actions/tpm-interop/action.yml new file mode 100644 index 0000000..d64aa19 --- /dev/null +++ b/.github/actions/tpm-interop/action.yml @@ -0,0 +1,64 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +name: tpm-interop +description: > + Build wolfSSL (config `wolftpm`, cached), wolfTPM with its fwTPM at + `wolftpm-ref`, and wolfCert with the examples, then run + tests/interop/tpm_wolftpm.sh. + +inputs: + wolfssl-ref: + description: "wolfSSL git ref to build" + required: false + default: master + wolftpm-ref: + description: "wolfTPM git ref to build (branch, tag or SHA)" + required: true + save: + description: "Save the wolfSSL cache after a miss" + required: false + default: "false" + +runs: + using: composite + steps: + - name: Install build dependencies + shell: bash + run: | + sudo apt-get update + sudo apt-get install -y build-essential autoconf automake libtool \ + cmake pkg-config python3 + + - name: Build/restore wolfSSL (wolftpm) + uses: ./.github/actions/build-wolfssl + with: + config: wolftpm + ref: ${{ inputs.wolfssl-ref }} + save: ${{ inputs.save }} + + - name: Build wolfTPM and its fwTPM + shell: bash + run: | + set -euo pipefail + scripts/ci/build-wolftpm.sh --wolfssl "$WOLFSSL_PREFIX" \ + --ref "${{ inputs.wolftpm-ref }}" \ + --prefix "$RUNNER_TEMP/wolftpm" --src "$RUNNER_TEMP/wolftpm-src" + echo "WOLFTPM_PREFIX=$RUNNER_TEMP/wolftpm" >> "$GITHUB_ENV" + + - name: Build wolfCert with the TPM example + shell: bash + run: | + set -euo pipefail + cmake -S . -B build \ + -DWITH_WOLFSSL="$WOLFSSL_PREFIX" \ + -DWOLFCERT_ENABLE_EXAMPLES=ON -DWOLFCERT_WERROR=ON \ + -Dwolftpm_DIR="$WOLFTPM_PREFIX/lib/cmake/wolftpm" + cmake --build build -j "$(nproc)" + test -x build/examples/example_enroll_tpm + + - name: Run tpm_wolftpm.sh + shell: bash + run: | + set -euo pipefail + export LD_LIBRARY_PATH="$WOLFSSL_PREFIX/lib:$WOLFTPM_PREFIX/lib:${LD_LIBRARY_PATH:-}" + FWTPM_SERVER="$WOLFTPM_PREFIX/bin/fwtpm_server" \ + WOLFCERT_BUILD="$PWD/build" bash tests/interop/tpm_wolftpm.sh diff --git a/.github/workflows/interop.yml b/.github/workflows/interop.yml index a901c16..1353f22 100644 --- a/.github/workflows/interop.yml +++ b/.github/workflows/interop.yml @@ -143,3 +143,15 @@ jobs: bash tests/interop/est_stepca.sh; rc=$? [ "$rc" -eq 77 ] && { echo "::notice::step-ca skipped (dep missing)"; exit 0; } exit "$rc" + + wolftpm-fwtpm: + name: wolfTPM fwTPM (wolfTPM master) + runs-on: ubuntu-latest + timeout-minutes: 25 + steps: + - uses: actions/checkout@v4 + - uses: ./.github/actions/tpm-interop + with: + wolfssl-ref: ${{ env.WOLFSSL_REF }} + wolftpm-ref: master + save: "true" # the only job on config wolftpm; pr.yml restores it diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index fdf8960..20d60dd 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -289,3 +289,15 @@ jobs: run: | scripts/ci/assert-configure-fails.sh \ --wolfssl-base "${{ github.workspace }}/.wolfssl-install" + + tpm-interop: + name: wolfTPM fwTPM interop (pinned wolfTPM) + runs-on: ubuntu-latest + timeout-minutes: 25 + steps: + - uses: actions/checkout@v4 + - uses: ./.github/actions/tpm-interop + with: + wolfssl-ref: ${{ env.WOLFSSL_REF }} + # Merge of wolfTPM #638 (key ids); no release has it before v4.3.0. + wolftpm-ref: fe01b8ee096c862897c7efb4aa963c312e2bcc46 diff --git a/docs/CI.md b/docs/CI.md index 59b5aeb..c308ebe 100644 --- a/docs/CI.md +++ b/docs/CI.md @@ -11,12 +11,12 @@ set skips the wolfSSL build entirely. | Workflow | Trigger | What it does | |----------|---------|--------------| -| `pr.yml` | PR + push | Merge gate: CMake (`-Werror`) + autoconf + ASan/UBSan on the canonical config, the same config against the minimum wolfSSL release (`cmake-full-floor`), plus per-PR feature/config gating — EST-only, SCEP-only, server-off, the key-alg variants (NO_RSA, ECC-only, RSA-only, no-3DES), TLS 1.3-only, the three ML-DSA per-level builds, the static-memory and no-malloc constrained builds, the platform-pieces-off build (`cmake-no-builtin-transport`), the freestanding ARM compile and config-resolution check (`no-posix-arm`), the header-only (`WOLFCERT_USER_SETTINGS`) build, a macOS build, and the two cheapest configure-must-fail assertions. | +| `pr.yml` | PR + push | Merge gate: CMake (`-Werror`) + autoconf + ASan/UBSan on the canonical config, the same config against the minimum wolfSSL release (`cmake-full-floor`), plus per-PR feature/config gating - EST-only, SCEP-only, server-off, the key-alg variants (NO_RSA, ECC-only, RSA-only, no-3DES), TLS 1.3-only, the three ML-DSA per-level builds, the static-memory and no-malloc constrained builds, the platform-pieces-off build (`cmake-no-builtin-transport`), the freestanding ARM compile and config-resolution check (`no-posix-arm`), the header-only (`WOLFCERT_USER_SETTINGS`) build, a macOS build, the two cheapest configure-must-fail assertions, and `tests/interop/tpm_wolftpm.sh` against wolfTPM's fwTPM at a pinned wolfTPM commit. | | `lint.yml` | PR + push | GPL license-header check and CMake↔autoconf parity of both the library and test source lists and of the shared library version, plus the Zephyr module's library list and the version in `configure.ac`, `CMakeLists.txt` and `wolfcert/version.h` (`scripts/ci/check-buildsystem-parity.sh`). No wolfSSL build, so it fails in seconds. | | `sbom.yml` | PR + push | Generates the SBOM with `make sbom` and `cmake --build --target sbom` against the `full` wolfSSL config, from `options.h` and from `examples/user_settings.h.example`, checks each with `tools/sbom/validate_sbom.py`, `pyspdxtools` and `scripts/ci/check-sbom.py` (identity, license, hash source, that the library hash matches a real `make install` / `cmake --install`, the `options.h` feature set, the wolfSSL dependency version, no host paths), checks that a second run is byte-identical and that both build systems and both configuration modes record the same configuration, and checks `tools/sbom/` against its pinned wolfssl-compliance-tooling commit. See [`SBOM.md`](SBOM.md). | | `nightly.yml` | schedule + dispatch | Re-runs the wolfSSL-variant build matrix against fresh wolfSSL `master`, the macOS extras, and the full negative-config set. Also **reseeds the wolfSSL prefix caches** so the next day's PRs restore instead of build. The feature/config gating itself now runs per-PR (see `pr.yml`). | | `sanitizers.yml` | schedule + dispatch | ASan+UBSan over the full test suite, ThreadSanitizer over the threaded integration roundtrips (against a TSAN-instrumented wolfSSL), and valgrind over a representative subset. | -| `interop.yml` | schedule + dispatch | Third-party EST/SCEP interop (openssl, micromdm/scep, globalsign/est, cisco/libest, smallstep/step-ca). Best-effort: a dependency that fails to install makes its script exit 77, which is treated as a neutral skip; a real interop regression fails. | +| `interop.yml` | schedule + dispatch | Third-party EST/SCEP interop (openssl, micromdm/scep, globalsign/est, cisco/libest, smallstep/step-ca), and `tpm_wolftpm.sh` against wolfTPM `master`, which also reseeds the `wolftpm` wolfSSL cache the PR job restores. Best-effort: a dependency that fails to install makes its script exit 77, which is treated as a neutral skip; a real interop regression fails. | | `zephyr.yml` | PR + push, schedule + dispatch | Three jobs sharing the west workspace setup (`.github/actions/zephyr-workspace`), each run once per Zephyr release in its matrix (v4.4.2 and v4.5.0). Each job saves its own ccache and restores it, or else the newest one for its toolchain. Only runs on the default branch save caches; the workspace cache is saved by the `qemu_x86` job alone. The `qemu_x86` job runs the Zephyr module on `qemu_x86`: the unit suites, and an EST enrollment gate plus the sample against a host `wolfcert-server`, including a build of the sample with a custom trust anchor. The `qemu_x86 build-only` job builds the rows for off-default Kconfig combinations (tagged `wolfcert_build`). The `mcxn` job builds the EST sample for `frdm_mcxn947/mcxn947/cpu0` with the SDK's `arm-zephyr-eabi` toolchain and checks the sample's `wolfcert-sbom` output; [`zephyr/README.md`](../zephyr/README.md#est-client-sample) lists what CI covers per board. `scripts/ci/twister-assert-ran.py` checks that each step's suites actually ran. | ## wolfSSL configurations @@ -37,8 +37,9 @@ Config names include `full` (all algorithms), `full-tsan`, `full-opensslextra` setups stay covered), `full-all` (`full` plus `--enable-all`, which brings `OPENSSL_ALL` and its compatible defaults), `est-only-nonrsa` (NO_RSA), `rsa-min`, `ecc-only-est`, `no-des3`, `tls13-only`, `mldsa-{44,65,87}off`, -`static-mem`, `no-malloc`, `no-cryptocb` (no `WOLF_CRYPTO_CB`), and the `neg-*` -configs used by the negative-config gate. +`static-mem`, `no-malloc`, `no-cryptocb` (no `WOLF_CRYPTO_CB`), `wolftpm` +(`full` plus what wolfTPM's fwTPM needs), and the `neg-*` configs used by the +negative-config gate. ## Reproducing a CI job locally diff --git a/docs/INTEROP.md b/docs/INTEROP.md index 33667d1..6430b38 100644 --- a/docs/INTEROP.md +++ b/docs/INTEROP.md @@ -17,10 +17,12 @@ Because a failed dependency *build* also ends in a 77 skip (the binary never lan | `est_globalsign.sh` | globalsign/est (Go) | wolfcert-client <-> globalsign estserver/estclient, both directions. | | `est_libest.sh` | cisco/libest (built from source) | wolfcert-client -> libest estserver, libest estclient -> wolfcert-server. | | `est_stepca.sh` | smallstep/step-ca (Go) | EST probe + SCEP enrollment against step-ca, plus a `--ca-id` GetCACert check. | +| `tpm_wolftpm.sh` | wolfTPM's fwTPM (`scripts/ci/build-wolftpm.sh`) | `examples/enroll_tpm` with keys in the fwTPM against wolfcert-server, for ECC P-256 and P-384, RSA-2048 and ML-DSA-44/65/87: enroll, renew in place, rekey, cleanup after a failure, a restart of both servers, and transient handles. Also runs in `pr.yml` at a pinned wolfTPM commit. | ## Dependency build notes - **cisco/libest** is archived and written for OpenSSL 1.x. On a modern OpenSSL 3.0 host it needs two build tweaks (applied in `interop.yml`): `--disable-safec` (its configure now demands an explicit safec choice) and a force-included compat header defining `FIPS_mode()` / `FIPS_mode_set()` as no-ops (OpenSSL 3.0 removed both symbols, which libest still references). +- **wolfTPM** needs a wolfSSL built with `--enable-wolftpm` (the `wolftpm` config of `build-wolfssl.sh`). `build-wolftpm.sh` builds the library and `fwtpm_server` with `WOLFTPM_V185=yes`, so ML-DSA cannot drop out unnoticed. The fwTPM holds 8 persistent objects, so `tpm_wolftpm.sh` gives each key type its own NV state. - **smallstep/step-ca** links `libpcsclite` via cgo (PC/SC, for its PIV/YubiKey provisioners); install `libpcsclite-dev` before `go install`, or the build aborts at pkg-config. ## Notes diff --git a/scripts/ci/build-wolfssl.sh b/scripts/ci/build-wolfssl.sh index d24961c..1ffd128 100755 --- a/scripts/ci/build-wolfssl.sh +++ b/scripts/ci/build-wolfssl.sh @@ -39,7 +39,7 @@ KNOWN_CONFIGS=( est-only-nonrsa rsa-min ecc-only-est no-des3 tls13-only mldsa-44off mldsa-65off mldsa-87off - static-mem no-malloc no-cryptocb + static-mem no-malloc no-cryptocb wolftpm # Negative configs for assert-configure-fails.sh. neg-no-rsa neg-no-pkcs7 neg-no-public-asn neg-no-aes128 ) @@ -123,6 +123,11 @@ resolve_flags() { # No WOLF_CRYPTO_CB, so no WOLF_PRIVATE_KEY_ID either. _base_flags printf '%s\n' --disable-cryptocb ;; + wolftpm) + # wolfTPM's fwTPM links the sp_* API and needs raw RSA. + _base_flags + printf '%s\n' --enable-wolftpm --enable-pkcallbacks \ + 'CPPFLAGS=-DWOLFSSL_ALT_NAMES -DWOLFSSL_CERT_NAME_ALL -DKEEP_PEER_CERT -DWOLFSSL_HAVE_TLS_UNIQUE -DWOLFSSL_PUBLIC_ASN -DWC_RSA_NO_PADDING' ;; # Negative configs: buildable wolfSSL builds that wolfCert rejects neg-no-rsa) diff --git a/scripts/ci/build-wolftpm.sh b/scripts/ci/build-wolftpm.sh new file mode 100755 index 0000000..6ef929e --- /dev/null +++ b/scripts/ci/build-wolftpm.sh @@ -0,0 +1,63 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: GPL-3.0-or-later +# +# Build and install wolfTPM with its fwTPM for the TPM interop test. +# +# Usage: +# build-wolftpm.sh --wolfssl PREFIX [--prefix DIR] [--ref REF] [--jobs N] +# [--src DIR] +# +# Defaults: --ref master, --prefix $PWD/.wolftpm-install, --src +# $PWD/.wolftpm-src. Installs lib/cmake/wolftpm and bin/fwtpm_server. + +set -euo pipefail + +WOLFTPM_REPO="${WOLFTPM_REPO:-https://github.com/wolfSSL/wolfTPM.git}" + +WOLFSSL="" +PREFIX="$PWD/.wolftpm-install" +REF="${WOLFTPM_REF:-master}" +JOBS="" +SRC="$PWD/.wolftpm-src" + +while [ "$#" -gt 0 ]; do + case "$1" in + --wolfssl) WOLFSSL="$2"; shift 2 ;; + --prefix) PREFIX="$2"; shift 2 ;; + --ref) REF="$2"; shift 2 ;; + --jobs) JOBS="$2"; shift 2 ;; + --src) SRC="$2"; shift 2 ;; + *) echo "ERROR: unknown argument '$1'." >&2; exit 2 ;; + esac +done +if [ -z "$WOLFSSL" ] || [ ! -d "$WOLFSSL/include/wolfssl" ]; then + echo "ERROR: --wolfssl must name a wolfSSL install prefix." >&2 + exit 2 +fi +: "${JOBS:=$( (command -v nproc >/dev/null && nproc) || sysctl -n hw.ncpu 2>/dev/null || echo 2)}" + +echo "==> Building wolfTPM $REF against $WOLFSSL" +if [ -d "$SRC/.git" ]; then + git -C "$SRC" fetch -q origin "$REF" + git -C "$SRC" checkout -q --detach FETCH_HEAD +else + rm -rf "$SRC" + # A raw SHA cannot go through --branch, so fall back to a full clone. + git clone --depth 1 --branch "$REF" "$WOLFTPM_REPO" "$SRC" 2>/dev/null \ + || { git clone "$WOLFTPM_REPO" "$SRC" && git -C "$SRC" checkout "$REF"; } +fi +git -C "$SRC" log -1 --format=' commit: %H %s' + +# v1.85 is forced on, so a wolfSSL without ML-DSA fails here, not as missing +# ML-DSA in the test. +cmake -S "$SRC" -B "$SRC/build" \ + -DWITH_WOLFSSL="$WOLFSSL" \ + -DCMAKE_INSTALL_PREFIX="$PREFIX" \ + -DCMAKE_INSTALL_RPATH="$PREFIX/lib;$WOLFSSL/lib" \ + -DWOLFTPM_FWTPM=yes -DWOLFTPM_INTERFACE=SWTPM \ + -DWOLFTPM_V185=yes -DWOLFTPM_EXAMPLES=no +cmake --build "$SRC/build" -j "$JOBS" --target wolftpm fwtpm_server +cmake --install "$SRC/build" + +echo "==> Installed wolfTPM to $PREFIX" +echo "$PREFIX" diff --git a/tests/interop/tpm_wolftpm.sh b/tests/interop/tpm_wolftpm.sh new file mode 100755 index 0000000..6495891 --- /dev/null +++ b/tests/interop/tpm_wolftpm.sh @@ -0,0 +1,217 @@ +#!/usr/bin/env bash +# SPDX-License-Identifier: GPL-3.0-or-later +# +# EST enrollment with keys in a TPM: examples/enroll_tpm against wolfTPM's +# fwTPM and wolfcert-server. Needs fwtpm_server in PATH (or FWTPM_SERVER) and +# a wolfCert build with examples on, found through WOLFCERT_BUILD. +# +# TPM_KEY_TYPES picks the key types (default: all the example knows). + +set -euo pipefail +HERE="$(cd "$(dirname "$0")" && pwd)" +REPO="$(cd "$HERE/../.." && pwd)" +. "$HERE/lib/common.sh" + +FWTPM="${FWTPM_SERVER:-}" +if [ -z "$FWTPM" ]; then + need fwtpm_server "Build wolfTPM with -DWOLFTPM_FWTPM=yes (scripts/ci/build-wolftpm.sh)" + FWTPM="$(command -v fwtpm_server)" +fi +WC_SERVER="$(wolfcert_bin wolfcert-server)" +EXAMPLE="$WOLFCERT_BUILD/examples/example_enroll_tpm" +if [ ! -x "$EXAMPLE" ]; then + echo "ERROR: $EXAMPLE not built; configure wolfCert with" \ + "-DWOLFCERT_ENABLE_EXAMPLES=ON and a wolfTPM with its CryptoCb" >&2 + exit 1 +fi +KEY_TYPES="${TPM_KEY_TYPES:-ecc:256 ecc:384 rsa:2048 mldsa:44 mldsa:65 mldsa:87}" + +cd "$WOLFCERT_INTEROP_WORK" +fw_pid="" +srv_pid="" +trap 'kill_if "$srv_pid"; kill_if "$fw_pid"; echo "--- work dir: $WOLFCERT_INTEROP_WORK"' EXIT + +fails=0 +checks=0 +pass() { checks=$((checks + 1)); echo "ok $1"; } +fail() { + checks=$((checks + 1)); fails=$((fails + 1)) + echo "FAIL $1" + [ -n "${2:-}" ] && [ -f "$2" ] && sed 's/^/ /' "$2" + return 0 +} + +# The fwTPM also binds TPM_PORT + 1 for its platform port. +free_port_pair() { + python3 -c ' +import socket +while True: + a = socket.socket(); a.bind(("127.0.0.1", 0)); p = a.getsockname()[1] + b = socket.socket() + try: + b.bind(("127.0.0.1", p + 1)) + except OSError: + a.close(); b.close(); continue + a.close(); b.close(); print(p); break +' +} + +TPM_PORT="$(free_port_pair)" +export TPM2_SWTPM_PORT="$TPM_PORT" + +# start_fwtpm [--clear]: without --clear a restart keeps the keys. +start_fwtpm() { + local dir="$1"; shift + mkdir -p "$dir" + (cd "$dir" && exec "$FWTPM" "$@" --port "$TPM_PORT" \ + --platform-port $((TPM_PORT + 1))) >>fwtpm.log 2>&1 & + fw_pid=$! + wait_port 127.0.0.1 "$TPM_PORT" +} + +stop_fwtpm() { + kill_if "$fw_pid" + fw_pid="" +} + +TRUST="$REPO/examples/certs/ecc/ca-cert.pem" +mkdir -m 0700 ca + +start_est() { + "$WC_SERVER" --proto est --listen "127.0.0.1:$EST_PORT" \ + --tls-cert "$REPO/examples/certs/ecc/server-cert.pem" \ + --tls-key "$REPO/examples/certs/ecc/server-key.pem" \ + --est-allow-anonymous --ca-dir ca --tls-trust-issued \ + >>est.log 2>&1 & + srv_pid=$! + wait_port 127.0.0.1 "$EST_PORT" + kill -0 "$srv_pid" 2>/dev/null || { cat est.log >&2; exit 1; } +} + +# ex : run the example, output to ; returns its status. +ex() { + local log="$1"; shift + "$EXAMPLE" "$@" >"$log" 2>&1 +} + +# The fwTPM keeps 8 persistent objects, so each key type gets its own NV. +run_type() { + local kt="$1" t="${1/:/-}" + local h0=0x81000100 h1=0x81000101 h2=0x81000102 + + start_fwtpm "tpm-$t" --clear + if ex "$t-enroll.log" enroll "$URL" "$TRUST" "CN=tpm-$t" "$kt" "$h0" "$t-0.crt" && + grep -q "BEGIN CERTIFICATE" "$t-0.crt"; then + pass "$kt: enroll at $h0" + else + fail "$kt: enroll at $h0" "$t-enroll.log" + stop_fwtpm + return 0 + fi + + if ! ex "$t-busy.log" enroll "$URL" "$TRUST" "CN=tpm-$t" "$kt" "$h0" "$t-x.crt" && + grep -q "needs a free persistent handle" "$t-busy.log"; then + pass "$kt: occupied handle refused" + else + fail "$kt: occupied handle refused" "$t-busy.log" + fi + + if ! ex "$t-dead.log" enroll "https://127.0.0.1:1/.well-known/est" "$TRUST" \ + "CN=tpm-$t" "$kt" "$h2" "$t-x.crt" && + ex "$t-after-dead.log" enroll "$URL" "$TRUST" "CN=tpm-$t" "$kt" "$h2" \ + "$t-2.crt"; then + pass "$kt: a failed enroll leaves the handle free" + else + fail "$kt: a failed enroll leaves the handle free" "$t-after-dead.log" + fi + + # Keys and CA survive a restart of both the fwTPM and the EST server. + stop_fwtpm + kill_if "$srv_pid"; srv_pid="" + start_fwtpm "tpm-$t" + start_est + + cp "$t-0.crt" "$t-before.crt" + if ex "$t-renew.log" reenroll "$URL" "$TRUST" "$kt" "$h0" "$t-0.crt" "$t-0.crt" && + ! cmp -s "$t-0.crt" "$t-before.crt" && + grep -q "BEGIN CERTIFICATE" "$t-0.crt" && [ ! -e "$t-0.crt.tmp" ]; then + pass "$kt: renew in place after a restart" + else + fail "$kt: renew in place after a restart" "$t-renew.log" + fi + + if ! ex "$t-ro.log" reenroll "$URL" "$TRUST" "$kt" "$h0" "$t-0.crt" notadir/x.crt "$h1" && + grep -q "revoke this certificate, its key is evicted" "$t-ro.log"; then + pass "$kt: unwritable rekey shows the certificate, evicts the new key" + else + fail "$kt: unwritable rekey shows the certificate, evicts the new key" "$t-ro.log" + fi + + if ex "$t-rekey.log" reenroll "$URL" "$TRUST" "$kt" "$h0" "$t-0.crt" "$t-1.crt" "$h1" && + grep -q "old key at TPM handle $h0 evicted" "$t-rekey.log"; then + pass "$kt: rekey to $h1 evicts $h0" + else + fail "$kt: rekey to $h1 evicts $h0" "$t-rekey.log" + fi + + if ! ex "$t-gone.log" reenroll "$URL" "$TRUST" "$kt" "$h0" "$t-0.crt" "$t-x.crt"; then + pass "$kt: the evicted key cannot renew" + else + fail "$kt: the evicted key cannot renew" "$t-gone.log" + fi + + if ex "$t-renew1.log" reenroll "$URL" "$TRUST" "$kt" "$h1" "$t-1.crt" "$t-1b.crt"; then + pass "$kt: the rotated key renews" + else + fail "$kt: the rotated key renews" "$t-renew1.log" + fi + + if ! ex "$t-down.log" reenroll "$URL" "$TRUST" "$kt" "$h1" "$t-1.crt" "$t-x.crt" \ + 0x80000000 && grep -q "NEW_HANDLE must be persistent" "$t-down.log"; then + pass "$kt: a persistent key does not rotate to a transient one" + else + fail "$kt: a persistent key does not rotate to a transient one" "$t-down.log" + fi + stop_fwtpm +} + +# A transient key lives until the fwTPM restarts; it has no resource manager. +run_transient() { + local kt="$1" t="${1/:/-}-tr" th + + start_fwtpm "tpm-$t" --clear + if ex "$t.log" enroll "$URL" "$TRUST" "CN=tpm-$t" "$kt" 0x80000000 "$t.crt"; then + th="$(sed -n 's/^enrolled: key in TPM handle \(0x[0-9a-f]*\),.*/\1/p' "$t.log")" + pass "$kt: enroll under 0x80000000 (got $th)" + if ex "$t-renew.log" reenroll "$URL" "$TRUST" "$kt" "$th" "$t.crt" "$t-2.crt"; then + pass "$kt: another process renews the transient key" + else + fail "$kt: another process renews the transient key" "$t-renew.log" + fi + else + fail "$kt: enroll under 0x80000000" "$t.log" + fi + if ! ex "$t-other.log" enroll "$URL" "$TRUST" "CN=tpm-$t" "$kt" 0x80000001 "$t-x.crt"; then + pass "$kt: a transient handle other than 0x80000000 is refused" + else + fail "$kt: a transient handle other than 0x80000000 is refused" "$t-other.log" + fi + stop_fwtpm +} + +# A write under a regular file fails even for root. +: >notadir +start_fwtpm tpm-probe --clear +# Picked while the fwTPM holds both of its ports. +EST_PORT="$(free_port)" +URL="https://127.0.0.1:$EST_PORT/.well-known/est" +stop_fwtpm +start_est + +for kt in $KEY_TYPES; do + run_type "$kt" +done +run_transient "${KEY_TYPES%% *}" + +echo "$checks checks, $fails failures" +[ "$fails" -eq 0 ] From dcfc314a1ac9215c658bf7eb3487f4b663590069 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Wed, 11 Nov 2026 16:14:53 +0100 Subject: [PATCH 15/17] Use INVALID_DEVID for software keys WOLFCERT_DEVID_SOFTWARE was -1, which wolfCrypt does not treat as "no device": INVALID_DEVID is -2, so every key, RNG, Cert and PKCS#7 object wolfCert initialized for software still went through a CryptoCb device lookup, and a WOLF_CRYPTO_CB_FIND callback was handed -1 as a device id. It also skipped wolfCrypt's default-device handling, which only kicks in for INVALID_DEVID. Drop the wolfCert constant and use wolfSSL's INVALID_DEVID throughout, which integrators already know from every other wolfSSL API. wolfcert/types.h now includes so the macro is available to applications through . This is a source break for code that used WOLFCERT_DEVID_SOFTWARE; the shared library version was already bumped to 1 on this branch. --- AGENTS.md | 2 +- README.md | 2 +- cli/wolfcert_client.c | 2 +- docs/ARCHITECTURE.md | 3 +- docs/MIGRATING-FROM-WOLFSCEP.md | 2 +- examples/enroll_est.c | 4 +-- examples/enroll_scep.c | 2 +- src/ca_issue.c | 24 +++++++-------- src/internal.h | 2 +- src/keygen.c | 4 +-- src/pkcs7_util.c | 4 +-- src/scep/scep_client.c | 2 +- src/scep/scep_msg.c | 16 +++++----- src/scep/scep_server.c | 12 ++++---- tests/integration/est_client_cases.h | 6 ++-- tests/integration/test_est_async_roundtrip.c | 2 +- .../integration/test_est_chunked_robustness.c | 2 +- .../test_est_csr_attrs_apply_roundtrip.c | 4 +-- .../integration/test_est_csr_attrs_enforce.c | 8 ++--- tests/integration/test_est_devid_roundtrip.c | 6 ++-- tests/integration/test_est_mldsa_roundtrip.c | 2 +- tests/integration/test_est_mtls_roundtrip.c | 30 +++++++++++-------- .../integration/test_est_pending_roundtrip.c | 4 +-- tests/integration/test_est_pha_roundtrip.c | 6 ++-- tests/integration/test_est_roundtrip.c | 8 ++--- tests/integration/test_est_tls_roundtrip.c | 4 +-- tests/integration/test_scep_async_roundtrip.c | 8 ++--- tests/integration/test_scep_get_cert.c | 4 +-- tests/integration/test_scep_poll_roundtrip.c | 4 +-- tests/integration/test_scep_roundtrip.c | 8 ++--- tests/unit/test_csr.c | 30 +++++++++---------- tests/unit/test_est.c | 10 +++---- tests/unit/test_http.c | 2 +- tests/unit/test_keygen.c | 7 +++-- tests/unit/test_server_ca.c | 4 +-- wolfcert/keygen.h | 17 ++++++----- wolfcert/types.h | 7 ++--- zephyr/samples/wolfcert_est_client/src/main.c | 2 +- 38 files changed, 134 insertions(+), 132 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 4c61a7c..7a3ce6e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -149,7 +149,7 @@ WolfCertServerCfg srv = { .verify_server = 1, }; WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=device-0001" }; WolfCertKey* key = NULL; WolfCertBuffer cert = { 0 }; diff --git a/README.md b/README.md index 45bf521..ecf85b9 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ wolfcert_init(my_static_heap_hint); /* Per-object override (here: force a specific pool for a device key): */ WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, .heap = slow_path_pool }; wolfcert_key_generate(&cfg, &key); ``` diff --git a/cli/wolfcert_client.c b/cli/wolfcert_client.c index cbb85e5..1d396ab 100644 --- a/cli/wolfcert_client.c +++ b/cli/wolfcert_client.c @@ -1451,7 +1451,7 @@ static int cmd_enroll(int argc, char** argv) WolfCertKey* key = NULL; WolfCertBuffer csr = { 0 }; WolfCertBuffer issued = { 0 }; - WolfCertKeyCfg kcfg = { .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertKeyCfg kcfg = { .dev_id = INVALID_DEVID }; WolfCertProtocol p = 0; #ifdef WOLFCERT_HAVE_SCEP CaPin pin = { 0 }; diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 5a029e0..e6a6d91 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -353,8 +353,7 @@ From there, every private-key operation on the key routes through `my_callback`: CSR signing, and TLS client authentication by id or for EST `/simplereenroll`. wolfSSL also hands the backend public-key operations on that id, such as the check of its own RSA signature in TLS, so the backend -must serve those too. Pass `WOLFCERT_DEVID_SOFTWARE` (`-1`) to force software -operation. +must serve those too. Pass `INVALID_DEVID` to force software operation. A `dev_id` without a `key_id` only offloads the computation. The key itself is an ordinary wolfCrypt key in host memory, and `wolfcert_key_to_pem` exports diff --git a/docs/MIGRATING-FROM-WOLFSCEP.md b/docs/MIGRATING-FROM-WOLFSCEP.md index 51c06e1..df0452b 100644 --- a/docs/MIGRATING-FROM-WOLFSCEP.md +++ b/docs/MIGRATING-FROM-WOLFSCEP.md @@ -98,7 +98,7 @@ wolfcert_scep_get_ca_caps(&srv, &caps); /* 3) Key and CSR. */ WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; wolfcert_key_generate(&kcfg, &key); diff --git a/examples/enroll_est.c b/examples/enroll_est.c index cd56b57..8bbb326 100644 --- a/examples/enroll_est.c +++ b/examples/enroll_est.c @@ -75,10 +75,10 @@ int main(int argc, char** argv) /* 1) Generate an Ed25519 key, or P-256 when wolfSSL lacks Ed25519. */ #ifdef WOLFCERT_HAVE_ED25519 WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ED25519, .param = 0, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; #else WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; #endif WolfCertKey* key = NULL; if (wolfcert_key_generate(&kcfg, &key) != WOLFCERT_OK) diff --git a/examples/enroll_scep.c b/examples/enroll_scep.c index 2f7f3a4..1dbcde3 100644 --- a/examples/enroll_scep.c +++ b/examples/enroll_scep.c @@ -112,7 +112,7 @@ int main(int argc, char** argv) /* 3) Generate RSA key + CSR. */ WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; if (wolfcert_key_generate(&kcfg, &key) != WOLFCERT_OK) return 2; diff --git a/src/ca_issue.c b/src/ca_issue.c index 0417400..1d3f0c3 100644 --- a/src/ca_issue.c +++ b/src/ca_issue.c @@ -51,7 +51,7 @@ static WolfCertKey* ca_as_key(WolfCertCa* ca, WolfCertKey* shim) memset(shim, 0, sizeof(*shim)); shim->type = ca->type; shim->heap = ca->heap; - shim->dev_id = WOLFCERT_DEVID_SOFTWARE; + shim->dev_id = INVALID_DEVID; shim->impl = ca->impl; return shim; } @@ -84,7 +84,7 @@ static int gen_self_signed_cert(WolfCertCa* ca) if (cert == NULL) return WOLFCERT_ERR_MEMORY; - wc_InitCert_ex(cert, ca->heap, WOLFCERT_DEVID_SOFTWARE); + wc_InitCert_ex(cert, ca->heap, INVALID_DEVID); snprintf(cert->subject.commonName, sizeof(cert->subject.commonName), "%s", "wolfCert Test CA"); @@ -118,7 +118,7 @@ static int gen_self_signed_cert(WolfCertCa* ca) } WC_RNG rng; - if (wc_InitRng_ex(&rng, ca->heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, ca->heap, INVALID_DEVID) != 0) { wc_CertFree(cert); return WOLFCERT_ERR_CRYPTO; } @@ -187,14 +187,14 @@ int wolfcert_ca_generate(WolfCertCa* ca, WolfCertKeyType type, int param, void* ca_sync_from_shim(ca, &shim); WC_RNG rng; - if (wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { alg->free_(&shim); ca->impl = NULL; return WOLFCERT_ERR_CRYPTO; } WolfCertKeyCfg cfg = { .type = ca->type, .param = p, - .dev_id = WOLFCERT_DEVID_SOFTWARE, .heap = heap }; + .dev_id = INVALID_DEVID, .heap = heap }; rc = alg->make(&shim, &cfg, &rng); @@ -486,7 +486,7 @@ static int decode_subject_pubkey(word32 keyOID, if (rk == NULL) return WOLFCERT_ERR_MEMORY; - if (wc_InitRsaKey_ex(rk, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRsaKey_ex(rk, heap, INVALID_DEVID) != 0) { WOLFCERT_XFREE(rk, heap); return WOLFCERT_ERR_CRYPTO; } @@ -509,7 +509,7 @@ static int decode_subject_pubkey(word32 keyOID, if (ek == NULL) return WOLFCERT_ERR_MEMORY; - if (wc_ecc_init_ex(ek, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_ecc_init_ex(ek, heap, INVALID_DEVID) != 0) { WOLFCERT_XFREE(ek, heap); return WOLFCERT_ERR_CRYPTO; } @@ -532,7 +532,7 @@ static int decode_subject_pubkey(word32 keyOID, if (ek == NULL) return WOLFCERT_ERR_MEMORY; - if (wc_ed25519_init_ex(ek, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_ed25519_init_ex(ek, heap, INVALID_DEVID) != 0) { WOLFCERT_XFREE(ek, heap); return WOLFCERT_ERR_CRYPTO; } @@ -555,7 +555,7 @@ static int decode_subject_pubkey(word32 keyOID, if (ek == NULL) return WOLFCERT_ERR_MEMORY; - if (wc_ed448_init_ex(ek, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_ed448_init_ex(ek, heap, INVALID_DEVID) != 0) { WOLFCERT_XFREE(ek, heap); return WOLFCERT_ERR_CRYPTO; } @@ -587,7 +587,7 @@ static int decode_subject_pubkey(word32 keyOID, if (dk == NULL) return WOLFCERT_ERR_MEMORY; - if (wc_MlDsaKey_Init(dk, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_MlDsaKey_Init(dk, heap, INVALID_DEVID) != 0) { WOLFCERT_XFREE(dk, heap); return WOLFCERT_ERR_CRYPTO; } @@ -836,7 +836,7 @@ int wolfcert_ca_issue(WolfCertCa* ca, } if (rc == 0) { - wc_InitCert_ex(nc, heap, WOLFCERT_DEVID_SOFTWARE); + wc_InitCert_ex(nc, heap, INVALID_DEVID); rc = wolfcert_copy_csr_subject(&dc, nc); if (rc == WOLFCERT_OK && @@ -872,7 +872,7 @@ int wolfcert_ca_issue(WolfCertCa* ca, } if (rc == 0) { - if (wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE) != 0) + if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) rc = WOLFCERT_ERR_CRYPTO; else rng_ok = 1; diff --git a/src/internal.h b/src/internal.h index 953f42e..d0ff2e4 100644 --- a/src/internal.h +++ b/src/internal.h @@ -88,7 +88,7 @@ static inline int wolfcert_devid_is_cb(int dev_id) { - return dev_id != WOLFCERT_DEVID_SOFTWARE && dev_id != INVALID_DEVID; + return dev_id != INVALID_DEVID; } /* BAD_ARG or UNSUPPORTED, with a message, unless id names a key a CryptoCb diff --git a/src/keygen.c b/src/keygen.c index c26887d..d7cfe22 100644 --- a/src/keygen.c +++ b/src/keygen.c @@ -210,7 +210,7 @@ int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, const WolfCertKeyAlg* const* list = wolfcert_key_algs_all(); for (; *list != NULL; ++list) { const WolfCertKeyAlg* a = *list; - WolfCertKey* k = alloc_shell(a->type, WOLFCERT_DEVID_SOFTWARE, NULL, 0, + WolfCertKey* k = alloc_shell(a->type, INVALID_DEVID, NULL, 0, heap); if (k == NULL) { if (der != NULL) @@ -471,7 +471,7 @@ WolfCertKeyType wolfcert_key_type(const WolfCertKey* k) int wolfcert_key_dev_id(const WolfCertKey* k) { - return k ? k->dev_id : 0; + return k ? k->dev_id : INVALID_DEVID; } int wolfcert_key_id(const WolfCertKey* k, const uint8_t** id, size_t* id_len) diff --git a/src/pkcs7_util.c b/src/pkcs7_util.c index 40c1fbe..0235aec 100644 --- a/src/pkcs7_util.c +++ b/src/pkcs7_util.c @@ -83,7 +83,7 @@ static int pkcs7_certs_extract(const uint8_t* p7_der, size_t p7_der_len, if (p7_der == NULL || p7_der_len == 0 || out == NULL) return WOLFCERT_ERR_BAD_ARG; - PKCS7* p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -155,7 +155,7 @@ WOLFCERT_TEST_VIS int wolfcert_pkcs7_build_certs_only(const uint8_t* const* cert /* wc_PKCS7_InitWithCert() would set publicKeyOID, which makes the encoder * demand a content hash for ECDSA and RSA-PSS certs. */ - PKCS7* p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; diff --git a/src/scep/scep_client.c b/src/scep/scep_client.c index 6188f72..4423051 100644 --- a/src/scep/scep_client.c +++ b/src/scep/scep_client.c @@ -975,7 +975,7 @@ static int scep_prepare(WolfCertScepSession* s, const ScepCall* c, return rc; WC_RNG rng; - int rng_rc = wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE); + int rng_rc = wc_InitRng_ex(&rng, heap, INVALID_DEVID); if (rng_rc != 0) { wolfcert_buffer_free(&env); return WOLFCERT_ERR_WC(rng_rc, "scep", "RNG init failed"); diff --git a/src/scep/scep_msg.c b/src/scep/scep_msg.c index f164294..9e96c84 100644 --- a/src/scep/scep_msg.c +++ b/src/scep/scep_msg.c @@ -327,7 +327,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, size_t ra_cert_len, const uint8_t* payload, size_t payload_len, int enc_oid, WolfCertBuffer* out_der, void* heap) { - PKCS7* p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -347,7 +347,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, } WC_RNG rng; - if (wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { wc_PKCS7_Free(p7); return WOLFCERT_ERR_CRYPTO; } @@ -391,7 +391,7 @@ int wolfcert_scep_deenvelop(const uint8_t* recipient_cert_der, size_t recipient_ if (env_len == 0 || env_len > WOLFCERT_SCEP_MAX_MSG_SZ) return WOLFCERT_ERR_BAD_ARG; - PKCS7* p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -450,7 +450,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, if (cert == NULL) return WOLFCERT_ERR_MEMORY; - wc_InitCert_ex(cert, heap, WOLFCERT_DEVID_SOFTWARE); + wc_InitCert_ex(cert, heap, INVALID_DEVID); dc = (DecodedCert*)WOLFCERT_XMALLOC(sizeof(*dc), heap); if (dc == NULL) { @@ -503,7 +503,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, return WOLFCERT_ERR_WC(rc, "scep", "SetKeyUsage"); } - if (wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { wc_CertFree(cert); return WOLFCERT_ERR_CRYPTO; } @@ -534,7 +534,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_build_pki_message(const uint8_t* envelope_de const uint8_t* signer_key_der, size_t signer_key_len, int hash_oid, const WolfCertScepAttrs* attrs, WolfCertBuffer* out_der, void* heap) { - PKCS7* p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -545,7 +545,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_build_pki_message(const uint8_t* envelope_de } WC_RNG rng; - if (wc_InitRng_ex(&rng, heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { wc_PKCS7_Free(p7); return WOLFCERT_ERR_CRYPTO; } @@ -739,7 +739,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_parse_pki_message(const uint8_t* pki_der, int bit; int rc; - p7 = wc_PKCS7_New(heap, WOLFCERT_DEVID_SOFTWARE); + p7 = wc_PKCS7_New(heap, INVALID_DEVID); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; diff --git a/src/scep/scep_server.c b/src/scep/scep_server.c index e992afa..40fea76 100644 --- a/src/scep/scep_server.c +++ b/src/scep/scep_server.c @@ -600,7 +600,7 @@ static int send_cert_rep(WolfCertServer* s, int fd, } WC_RNG rng; - if (wc_InitRng_ex(&rng, s->heap, WOLFCERT_DEVID_SOFTWARE) != 0) { + if (wc_InitRng_ex(&rng, s->heap, INVALID_DEVID) != 0) { wolfcert_buffer_free(&resp_env); send_text(s, fd, 500, "Server Error", "text/plain", ""); return WOLFCERT_ERR_CRYPTO; @@ -1318,7 +1318,7 @@ static int handle_request(WolfCertServer* s, int fd) static int make_split_ra(WolfCertServer* s, ScepPriv* p) { WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, .heap = s->heap }; WolfCertCertMeta meta = { .subject_dn = "CN=wolfCert Test RA,O=wolfCert" }; WolfCertKey* key = NULL; @@ -1397,7 +1397,7 @@ static int bundle_cert(WolfCertServer* s, int key_type, void* pub, issuer = s->ca.cert_der; issuer_len = s->ca.cert_der_len; } - if (wc_InitCert_ex(c, s->heap, WOLFCERT_DEVID_SOFTWARE) != 0) + if (wc_InitCert_ex(c, s->heap, INVALID_DEVID) != 0) rc = WOLFCERT_ERR_CRYPTO; if (rc == WOLFCERT_OK) { c->sigType = CTC_SHA256wRSA; @@ -1427,7 +1427,7 @@ static int bundle_cert(WolfCertServer* s, int key_type, void* pub, rc = WOLFCERT_ERR_MEMORY; } if (rc == WOLFCERT_OK) { - if (wc_InitRng_ex(&rng, s->heap, WOLFCERT_DEVID_SOFTWARE) != 0) + if (wc_InitRng_ex(&rng, s->heap, INVALID_DEVID) != 0) rc = WOLFCERT_ERR_CRYPTO; else rng_ok = 1; @@ -1458,7 +1458,7 @@ static int bundle_cert(WolfCertServer* s, int key_type, void* pub, static int bundle_root(WolfCertServer* s, uint8_t** root, size_t* root_len) { WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, .heap = s->heap }; WolfCertKey* key = NULL; uint8_t* ca = NULL; @@ -1492,7 +1492,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_server_set_bundle_fault(WolfCertServer* s, ScepPriv* p = (ScepPriv*)s->priv; RsaKey* ca_key = (RsaKey*)s->ca.impl; WolfCertKeyCfg ecc = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, .heap = s->heap }; WolfCertKey* ecc_key = NULL; uint8_t* der[4] = { NULL, NULL, NULL, NULL }; diff --git a/tests/integration/est_client_cases.h b/tests/integration/est_client_cases.h index ed155c2..1904e6a 100644 --- a/tests/integration/est_client_cases.h +++ b/tests/integration/est_client_cases.h @@ -51,7 +51,7 @@ static inline int enroll_one(const WolfCertServerCfg* client_cfg, const WolfCertBuffer* ca_pem) { WolfCertKeyCfg kcfg = { .type = kt, .param = param, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; const char* dns[] = { "device-7.local" }; WolfCertCertMeta meta = { .subject_dn = "CN=device-7,O=Acme", .san_dns = dns, .san_dns_len = 1 }; @@ -114,7 +114,7 @@ static inline int has_alt(const DNS_entry* list, int type, const char* val, static inline int enroll_check_san(const WolfCertServerCfg* client_cfg) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; const char* dns[] = { "device-san.local" }; const char* ips[] = { "10.20.30.40" }; const char* emails[] = { "dev-san@example.com" }; @@ -174,7 +174,7 @@ static inline int enroll_check_san(const WolfCertServerCfg* client_cfg) static inline int session_basic_auth(const WolfCertServerCfg* client_cfg) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=session-basic-auth" }; WolfCertServerCfg bad_cfg = *client_cfg; WolfCertKey* dk = NULL; diff --git a/tests/integration/test_est_async_roundtrip.c b/tests/integration/test_est_async_roundtrip.c index 06fe883..691c31b 100644 --- a/tests/integration/test_est_async_roundtrip.c +++ b/tests/integration/test_est_async_roundtrip.c @@ -112,7 +112,7 @@ int main(void) &cli_cert, &cli_cert_len, &cli_key, &cli_key_len) == 0); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=async-enrollee" }; diff --git a/tests/integration/test_est_chunked_robustness.c b/tests/integration/test_est_chunked_robustness.c index 56530c0..9925971 100644 --- a/tests/integration/test_est_chunked_robustness.c +++ b/tests/integration/test_est_chunked_robustness.c @@ -422,7 +422,7 @@ static int build_split_enroll(char** head, size_t* head_len, char** tail) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=keepalive-test" }; WolfCertKey* key = NULL; WolfCertBuffer csr = { 0 }; diff --git a/tests/integration/test_est_csr_attrs_apply_roundtrip.c b/tests/integration/test_est_csr_attrs_apply_roundtrip.c index 650aed8..b49a12a 100644 --- a/tests/integration/test_est_csr_attrs_apply_roundtrip.c +++ b/tests/integration/test_est_csr_attrs_apply_roundtrip.c @@ -142,7 +142,7 @@ static int auto_apply_pins_everything(WolfCertServer* s) WolfCertClient* cli = NULL; REQUIRE(wolfcert_client_new(&cli) == WOLFCERT_OK); - WolfCertKeyCfg key_cfg = { .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertKeyCfg key_cfg = { .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=csrattrs-auto-1", .challenge_password = "hunter2", @@ -193,7 +193,7 @@ static int explicit_caller_wins(WolfCertServer* s) WolfCertKeyCfg key_cfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, }; WolfCertCertMeta meta = { .subject_dn = "CN=csrattrs-auto-2", diff --git a/tests/integration/test_est_csr_attrs_enforce.c b/tests/integration/test_est_csr_attrs_enforce.c index 8de562e..0689641 100644 --- a/tests/integration/test_est_csr_attrs_enforce.c +++ b/tests/integration/test_est_csr_attrs_enforce.c @@ -116,7 +116,7 @@ static int enroll_with_challenge(WolfCertServer* s) REQUIRE(wolfcert_client_new(&cli) == WOLFCERT_OK); WolfCertKeyCfg key_cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=enforce-ok", .challenge_password = "hunter2", @@ -150,7 +150,7 @@ static int enroll_without_challenge(WolfCertServer* s) REQUIRE(wolfcert_client_new(&cli) == WOLFCERT_OK); WolfCertKeyCfg key_cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=enforce-reject", }; @@ -204,7 +204,7 @@ static int reject_body_names_missing_oid(uint16_t port) /* OID_CHALLENGE_PASSWORD in dotted form. */ static const char EXPECT_OID[] = "1.2.840.113549.1.9.7"; WolfCertKeyCfg key_cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=raw-enforce" }; WolfCertKey* key = NULL; WolfCertBuffer csr_der = { 0 }; @@ -334,7 +334,7 @@ static int values_only_policy_does_not_block(WolfCertServer* s) REQUIRE(wolfcert_client_new(&cli) == WOLFCERT_OK); WolfCertKeyCfg key_cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=enforce-values-advisory" }; WolfCertKey* key = NULL; diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c index aefc68a..3d510d5 100644 --- a/tests/integration/test_est_devid_roundtrip.c +++ b/tests/integration/test_est_devid_roundtrip.c @@ -415,7 +415,7 @@ static int test_cfg_errors(void) uint8_t long_id[WOLFCERT_KEY_ID_MAX_LEN + 1] = { 0 }; WolfCertKeyCfg cfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE, + .dev_id = INVALID_DEVID, .key_id = id, .key_id_len = sizeof(id) - 1 }; WolfCertKey* k = NULL; @@ -705,7 +705,7 @@ static int test_client_key_src(const char* url, const WolfCertCertMeta meta = { .subject_dn = "CN=devid-accel,O=wolfSSL" }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertServerCfg cli = { .protocol = WOLFCERT_PROTO_EST, .server_url = url, @@ -787,7 +787,7 @@ static int test_failure_keeps_key(const char* url, const uint8_t* tls_cert, .key_id = id, .key_id_len = sizeof(id) - 1 }; WolfCertKeyCfg scfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertServerCfg cli = { .protocol = WOLFCERT_PROTO_EST, .server_url = url, diff --git a/tests/integration/test_est_mldsa_roundtrip.c b/tests/integration/test_est_mldsa_roundtrip.c index 9dfb238..87df39b 100644 --- a/tests/integration/test_est_mldsa_roundtrip.c +++ b/tests/integration/test_est_mldsa_roundtrip.c @@ -63,7 +63,7 @@ static void* server_thread(void* arg) static int enroll_mldsa(const WolfCertServerCfg* client_cfg, WolfCertKeyType kt, const char* label, const WolfCertBuffer* ca_pem) { - WolfCertKeyCfg kcfg = { .type = kt, .dev_id = WOLFCERT_DEVID_SOFTWARE }; + WolfCertKeyCfg kcfg = { .type = kt, .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); diff --git a/tests/integration/test_est_mtls_roundtrip.c b/tests/integration/test_est_mtls_roundtrip.c index 87f2531..d8fa4d1 100644 --- a/tests/integration/test_est_mtls_roundtrip.c +++ b/tests/integration/test_est_mtls_roundtrip.c @@ -80,7 +80,7 @@ static int test_reenroll_ignores_cfg_identity(const char* url, WolfCertEstSession* sess = NULL; WolfCertEstResult res = { 0 }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=factory-bootstrap" }; WolfCertServerCfg cli = { .protocol = WOLFCERT_PROTO_EST, @@ -153,7 +153,7 @@ static int test_reenroll_rejects_identity_change(const char* url, { .subject_dn = "CN=factory-bootstrap", .san_dns = dns, .san_dns_len = 1 }, }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertServerCfg cli = { .protocol = WOLFCERT_PROTO_EST, .server_url = url, @@ -293,7 +293,7 @@ static int reenroll_key_type(const WolfCertServerCfg* cli, WolfCertKeyType type, { const WolfCertCertMeta meta = { .subject_dn = "CN=reenroll-type,O=wolfSSL" }; WolfCertKeyCfg kcfg = { .type = type, .param = param, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertBuffer csr = { 0 }; WolfCertEstResult cert = { 0 }; @@ -345,7 +345,7 @@ static int test_reenroll_server_issued(const uint8_t* tls_cert, size_t tls_cert_ .san_email = email, .san_email_len = 1, }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", @@ -487,7 +487,7 @@ static int test_reenroll_under_approval(const uint8_t* tls_cert, size_t tls_cert const WolfCertCertMeta same = { .subject_dn = "CN=factory-bootstrap" }; const WolfCertCertMeta none = { 0 }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, .bind_host = "127.0.0.1", @@ -574,7 +574,7 @@ static int test_reenroll_trust_issued(const uint8_t* tls_cert, size_t tls_cert_l const uint8_t* cli_key, size_t cli_key_len) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=trust-issued" }; WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, @@ -765,7 +765,7 @@ static int test_trust_issued_with_client_ca(const uint8_t* tls_cert, size_t tls_key_len) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=bootstrap" }; WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, @@ -918,12 +918,16 @@ static int test_trust_issued_with_client_ca(const uint8_t* tls_cert, /* A pinned self-signed client certificate still enrolls next to * tls_client_trust_issued. */ static int test_trust_issued_pinned_self_signed(const uint8_t* tls_cert, - size_t tls_cert_len, const uint8_t* tls_key, size_t tls_key_len, - const uint8_t* cli_cert, size_t cli_cert_len, const uint8_t* cli_key, - size_t cli_key_len) + size_t tls_cert_len, + const uint8_t* tls_key, + size_t tls_key_len, + const uint8_t* cli_cert, + size_t cli_cert_len, + const uint8_t* cli_key, + size_t cli_key_len) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=pinned" }; WolfCertServerCfgSrv cfg = { .protocol = WOLFCERT_PROTO_EST, @@ -982,7 +986,7 @@ static int test_reenroll_needs_peer_cert(const char* url, const uint8_t* cli_key, size_t cli_key_len) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=factory-bootstrap" }; WolfCertServerCfg cli = { .protocol = WOLFCERT_PROTO_EST, @@ -1114,7 +1118,7 @@ int main(void) wolfcert_buffer_free(&ca_pem); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=mtls-est-client" }; diff --git a/tests/integration/test_est_pending_roundtrip.c b/tests/integration/test_est_pending_roundtrip.c index e9c70dc..4f375bd 100644 --- a/tests/integration/test_est_pending_roundtrip.c +++ b/tests/integration/test_est_pending_roundtrip.c @@ -96,7 +96,7 @@ static int make_csr(const char* subject, WolfCertKey** out_key, WolfCertBuffer* out_csr) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; if (wolfcert_key_generate(&kcfg, out_key) != WOLFCERT_OK) return 1; WolfCertCertMeta meta = { .subject_dn = subject }; @@ -222,7 +222,7 @@ static int pending_path(WolfCertServer* s) WolfCertClient* client = NULL; REQUIRE(wolfcert_client_new(&client) == WOLFCERT_OK); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=device-est-pending-client" }; WolfCertKey* key = NULL; WolfCertBuffer cert = { 0 }; diff --git a/tests/integration/test_est_pha_roundtrip.c b/tests/integration/test_est_pha_roundtrip.c index b96605e..07a6ecd 100644 --- a/tests/integration/test_est_pha_roundtrip.c +++ b/tests/integration/test_est_pha_roundtrip.c @@ -74,7 +74,7 @@ static int expect_enroll_refused(const WolfCertServerCfg* cli, const char* cn) wolfcert_buffer_free(&ca_pem); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = cn }; @@ -182,7 +182,7 @@ int main(void) /* /simpleenroll triggers the server's CertificateRequest. */ WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=pha-enrollee" }; @@ -258,7 +258,7 @@ int main(void) .proto_opts.est = { .allow_post_handshake_auth = 1 }, }; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=factory-bootstrap" }; WolfCertKey* dk = NULL; WolfCertBuffer csr = { 0 }; diff --git a/tests/integration/test_est_roundtrip.c b/tests/integration/test_est_roundtrip.c index e38fcb7..dc74a3f 100644 --- a/tests/integration/test_est_roundtrip.c +++ b/tests/integration/test_est_roundtrip.c @@ -172,7 +172,7 @@ static int rdn_is(const char* p, int len, const char* want) static int enroll_check_subject_rdns(const WolfCertServerCfg* client_cfg) { WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); @@ -324,7 +324,7 @@ int main(void) /* A flipped signature bit keeps the CSR parseable and the credentials are * valid, so only the proof-of-possession check can reject it. */ WolfCertKeyCfg pop_kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* pop_dk = NULL; REQUIRE(wolfcert_key_generate(&pop_kcfg, &pop_dk) == WOLFCERT_OK); WolfCertCertMeta pop_meta = { .subject_dn = "CN=pop-tamper" }; @@ -342,7 +342,7 @@ int main(void) wolfcert_key_free(pop_dk); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=auth-fail" }; @@ -384,7 +384,7 @@ int main(void) .password = "hunter" } }; WolfCertKeyCfg akcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* adk = NULL; REQUIRE(wolfcert_key_generate(&akcfg, &adk) == WOLFCERT_OK); WolfCertCertMeta ameta = { .subject_dn = "CN=auth-exact" }; diff --git a/tests/integration/test_est_tls_roundtrip.c b/tests/integration/test_est_tls_roundtrip.c index 4706d93..ce85687 100644 --- a/tests/integration/test_est_tls_roundtrip.c +++ b/tests/integration/test_est_tls_roundtrip.c @@ -180,7 +180,7 @@ static int test_client_reenroll_keeps_identity(const uint8_t* tls_cert, #ifdef KEEP_PEER_CERT WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; int called = 0; #endif @@ -382,7 +382,7 @@ int main(void) REQUIRE(ca_pem.len > 0); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=tls-est-client" }; diff --git a/tests/integration/test_scep_async_roundtrip.c b/tests/integration/test_scep_async_roundtrip.c index 2ad3593..739bf86 100644 --- a/tests/integration/test_scep_async_roundtrip.c +++ b/tests/integration/test_scep_async_roundtrip.c @@ -198,7 +198,7 @@ static int bootstrap(const WolfCertServerCfg* cli, const char* cn, } WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; if (wolfcert_key_generate(&kcfg, key) != WOLFCERT_OK) { wc_FreeDer(ca_der); wolfcert_buffer_free(ca_pem); @@ -255,7 +255,7 @@ static int async_enroll_path(WolfCertServer* s) WolfCertScepResult r = { 0 }; WolfCertScepSession* bsess = NULL; WolfCertKeyCfg kcfg2 = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk2 = NULL; WolfCertCertMeta meta2 = { .subject_dn = "CN=sync-scep-1" }; WolfCertBuffer csr2 = { 0 }; @@ -733,7 +733,7 @@ static int non_rsa_reject_path(WolfCertServer* s) WolfCertKey* dk = NULL; WolfCertBuffer csr = { 0 }; WolfCertKeyCfg ecfg = { .type = WOLFCERT_KEY_ED25519, .param = 0, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* ek = NULL; WolfCertScepSession* sess = NULL; WolfCertScepResult r = { 0 }; @@ -791,7 +791,7 @@ static int blocking_renewal_poll_path(WolfCertServer* s) WolfCertScepResult r3 = { 0 }; WolfCertScepResult r4 = { 0 }; WolfCertKeyCfg nkcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta nmeta = { .subject_dn = "CN=sync-renew-poll" }; WolfCertKey* nk = NULL; WolfCertBuffer ncsr = { 0 }; diff --git a/tests/integration/test_scep_get_cert.c b/tests/integration/test_scep_get_cert.c index 5a8fd5d..c12afec 100644 --- a/tests/integration/test_scep_get_cert.c +++ b/tests/integration/test_scep_get_cert.c @@ -70,7 +70,7 @@ static int get_cert_path(WolfCertServer* s) &ca_der, NULL, NULL, NULL) == 0); WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=device-getcert-1" }; @@ -325,7 +325,7 @@ static int disabled_path(WolfCertServer* s) &ca_der, NULL, NULL, NULL) == 0); WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=device-getcert-off" }; diff --git a/tests/integration/test_scep_poll_roundtrip.c b/tests/integration/test_scep_poll_roundtrip.c index 63b8bb6..fa9822b 100644 --- a/tests/integration/test_scep_poll_roundtrip.c +++ b/tests/integration/test_scep_poll_roundtrip.c @@ -184,7 +184,7 @@ static int poll_path(WolfCertServer* s) &ca_der, NULL, NULL, NULL) == 0); WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=device-poll-1" }; @@ -521,7 +521,7 @@ static int empty_subject_path(WolfCertServer* s) &ca_der, NULL, NULL, NULL) == 0); WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); static const char* const dns[] = { "empty-subject.example" }; diff --git a/tests/integration/test_scep_roundtrip.c b/tests/integration/test_scep_roundtrip.c index efafb03..1f9a5fd 100644 --- a/tests/integration/test_scep_roundtrip.c +++ b/tests/integration/test_scep_roundtrip.c @@ -321,7 +321,7 @@ static int check_rsa4096(const WolfCertServerCfg* cli, const uint8_t* ca_der_buf, size_t ca_der_len) { WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 4096, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=device-scep-4096" }; WolfCertKey* key = NULL; WolfCertBuffer csr = { 0 }; @@ -1824,7 +1824,7 @@ static int test_split_ra(void) TEST_CA_CFG, .scep_split_ra = 1 }; WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=device-split-ra" }; WolfCertServer* s = NULL; WolfCertScepCaps caps = { 0 }; @@ -2007,7 +2007,7 @@ int main(void) REQUIRE(check_getca_media_type(ca_der->buffer, ca_der->length) == 0); WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=device-scep-1" }; @@ -2234,7 +2234,7 @@ int main(void) #ifdef WOLFCERT_HAVE_ED25519 /* Ed25519 signer must be rejected cleanly (RFC 8894 requires RSA). */ WolfCertKeyCfg edcfg = { .type = WOLFCERT_KEY_ED25519, .param = 0, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* edk = NULL; REQUIRE(wolfcert_key_generate(&edcfg, &edk) == WOLFCERT_OK); WolfCertCertMeta edmeta = { .subject_dn = "CN=ed-scep" }; diff --git a/tests/unit/test_csr.c b/tests/unit/test_csr.c index ea088f7..454e441 100644 --- a/tests/unit/test_csr.c +++ b/tests/unit/test_csr.c @@ -44,7 +44,7 @@ static int build_and_reparse(WolfCertKeyType kt, int param) { WolfCertKeyCfg cfg = { .type = kt, .param = param, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; REQUIRE(wolfcert_key_generate(&cfg, &key) == WOLFCERT_OK); @@ -112,7 +112,7 @@ static int ecc_sig_follows_curve(void) for (size_t i = 0; i < sizeof(want) / sizeof(want[0]); i++) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = want[i].param, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertBuffer der = { 0 }; DecodedCert dc; @@ -152,7 +152,7 @@ static int ecc_sig_follows_preferred_hash(void) #endif }; WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; int ret = 0; @@ -189,7 +189,7 @@ static int ecc_sig_follows_preferred_hash(void) static int build_with_extras(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; REQUIRE(wolfcert_key_generate(&cfg, &key) == WOLFCERT_OK); @@ -273,7 +273,7 @@ static int subject_copy_rejects_oversized_rdn(void) static int csr_build_rejects_oversized_rdn(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer der = { 0 }; @@ -314,7 +314,7 @@ static int csr_build_rejects_unprintable_rdn(void) "CN=dev,emailAddress=j\xc3\xbcrgen@example.de" }; WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer der = { 0 }; @@ -377,7 +377,7 @@ static int renewal_keeps_empty_subject(int san_crit) static const byte san[] = { 0x30, 0x0d, 0x82, 0x0b, 'd', 'e', 'v', '.', 'e', 'x', 'a', 'm', 'p', 'l', 'e' }; WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; @@ -464,7 +464,7 @@ static const byte crit_ext_cert[] = { static int renewal_reads_past_unknown_critical_ext(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; @@ -533,7 +533,7 @@ static const byte bmp_subject_cert[] = { static int renewal_refuses_bmpstring_subject(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; @@ -552,7 +552,7 @@ static int renewal_refuses_bmpstring_subject(void) static int renewal_drops_callback_san(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; @@ -590,7 +590,7 @@ static int renewal_drops_callback_san(void) static int renewal_walks_extensions_without_san(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; @@ -626,7 +626,7 @@ static int renewal_walks_extensions_without_san(void) static int renewal_rejects_non_certificate(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer key_pem = { 0 }; @@ -649,7 +649,7 @@ static int renewal_rejects_meta_identity(void) { static const char* const one[] = { "x" }; WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta; WolfCertBuffer csr = { 0 }; @@ -710,7 +710,7 @@ static int count_csr_sans(const WolfCertBuffer* csr) static int csr_carries_large_san(void) { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; char names[LARGE_SAN_COUNT][40]; const char* dns[LARGE_SAN_COUNT]; WolfCertKey* key = NULL; @@ -919,7 +919,7 @@ static int renewal_size_limits(void) const word32 name_max = (word32)sizeof(((Cert*)NULL)->sbjRaw) - 1; const word32 san_max = (word32)sizeof(((Cert*)NULL)->altNames); WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* key = NULL; WolfCertCertMeta meta = { 0 }; WolfCertBuffer csr = { 0 }; diff --git a/tests/unit/test_est.c b/tests/unit/test_est.c index d5b11a8..7c460f2 100644 --- a/tests/unit/test_est.c +++ b/tests/unit/test_est.c @@ -291,7 +291,7 @@ static int test_est_require_server_auth(void) WolfCertEstResult res = { 0 }; WolfCertEstSession* sess = NULL; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* rk = NULL; /* Each call gets ERR_TLS, even simple_enroll with a placeholder CSR. */ @@ -372,7 +372,7 @@ static int test_est_rejects_scep_cfg(void) WolfCertEstResult res = { 0 }; WolfCertEstSession* sess = NULL; WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* rk = NULL; REQUIRE(wolfcert_est_get_cacerts(&srv, WOLFCERT_ENCODING_PEM, @@ -449,10 +449,10 @@ static int test_est_result_defined_on_early_return(void) WolfCertKey* key = NULL; #ifdef WOLFCERT_HAVE_RSA WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; #else WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; #endif REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); @@ -709,7 +709,7 @@ int main(void) wolfcert_buffer_free(&ca_pem); WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, .param = TEST_ENROLL_KEY_PARAM, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; REQUIRE(wolfcert_key_generate(&kcfg, &dk) == WOLFCERT_OK); WolfCertCertMeta meta = { .subject_dn = "CN=device-99" }; diff --git a/tests/unit/test_http.c b/tests/unit/test_http.c index e1c5e64..4b47697 100644 --- a/tests/unit/test_http.c +++ b/tests/unit/test_http.c @@ -1232,7 +1232,7 @@ static int test_client_key_checks(void) REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); scfg.client_cert = cert; scfg.client_cert_len = sizeof(cert); - scfg.client_key_dev_id = WOLFCERT_DEVID_SOFTWARE; + scfg.client_key_dev_id = INVALID_DEVID; REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); scfg.client_key_dev_id = 7; scfg.client_cert_len = 0; diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index e535868..896d0c7 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -49,7 +49,7 @@ static int roundtrip(WolfCertKeyType type, int param) { WolfCertKeyCfg cfg = { .type = type, .param = param, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* k = NULL; REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_OK); REQUIRE(k != NULL); @@ -429,7 +429,7 @@ int main(void) /* Runtime rejection when the wolfSSL build lacks Dilithium. */ { WolfCertKeyCfg cfg = { .type = WOLFCERT_KEY_MLDSA44, .param = 0, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* k = NULL; REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_UNSUPPORTED); } @@ -441,9 +441,10 @@ int main(void) #endif WolfCertKeyCfg bad = { .type = WOLFCERT_KEY_ECC, .param = 123, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* k = NULL; REQUIRE(wolfcert_key_generate(&bad, &k) != WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(NULL) == INVALID_DEVID); wolfcert_cleanup(); printf("OK\n"); diff --git a/tests/unit/test_server_ca.c b/tests/unit/test_server_ca.c index 3f4e4bd..1c404a0 100644 --- a/tests/unit/test_server_ca.c +++ b/tests/unit/test_server_ca.c @@ -363,7 +363,7 @@ static int loaded_ca_signs(const WolfCertBuffer* cert, const WolfCertBuffer* key /* Any compiled algorithm serves as the leaf; the first entry always is. */ WolfCertKeyCfg kcfg = { .type = CA_KEY_TYPES[0], .param = ca_key_param(CA_KEY_TYPES[0]), - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = "CN=leaf" }; WolfCertKey* leaf_key = NULL; WolfCertBuffer csr = { 0 }; @@ -807,7 +807,7 @@ static int make_self_pair(int is_ca, int skid_len, WolfCertBuffer* cert_out, WolfCertBuffer* key_out) { WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertKey* dk = NULL; ecc_key wck; word32 idx = 0; diff --git a/wolfcert/keygen.h b/wolfcert/keygen.h index 79e045b..6caa802 100644 --- a/wolfcert/keygen.h +++ b/wolfcert/keygen.h @@ -28,13 +28,13 @@ extern "C" { typedef struct WolfCertKey WolfCertKey; -/* Generate a key per cfg. cfg->dev_id != -1 routes its operations through - * that CryptoCb device; with cfg->key_id the key also stays in the device and - * the handle only references it, under the id wolfcert_key_id returns, which - * the device may have changed. Allocated from cfg->heap or the default. - * *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when the device - * left an unusable id: *out_key then holds the key under the requested id so - * the caller can delete it there. */ +/* Generate a key per cfg. cfg->dev_id != INVALID_DEVID routes its operations + * through that CryptoCb device; with cfg->key_id the key also stays in the + * device and the handle only references it, under the id wolfcert_key_id + * returns, which the device may have changed. Allocated from cfg->heap or the + * default. *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when + * the device left an unusable id: *out_key then holds the key under the + * requested id so the caller can delete it there. */ WOLFCERT_API int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key); /* Reference a key a CryptoCb device holds under cfg->key_id, its public half @@ -61,7 +61,8 @@ WOLFCERT_API int wolfcert_key_to_der(const WolfCertKey* key, WolfCertBuffer* out * happens to the key it holds. */ WOLFCERT_API void wolfcert_key_free(WolfCertKey* key); -/* Accessors. wolfcert_key_type returns 0 on NULL. */ +/* Accessors. wolfcert_key_type returns 0 on NULL, wolfcert_key_dev_id + * INVALID_DEVID. */ WOLFCERT_API WolfCertKeyType wolfcert_key_type(const WolfCertKey* key); WOLFCERT_API int wolfcert_key_dev_id(const WolfCertKey* key); /* Points *id at the key's backend id, or NULL with *id_len 0 if it has diff --git a/wolfcert/types.h b/wolfcert/types.h index e38b525..cba2c92 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -31,6 +31,7 @@ #include #include +#include #include @@ -77,10 +78,6 @@ typedef enum { WOLFCERT_KEY_MLDSA87 = 7 } WolfCertKeyType; -/* Keys are offloaded through a wolfSSL CryptoCb devId that the application - * registers; WOLFCERT_DEVID_SOFTWARE selects software. */ -#define WOLFCERT_DEVID_SOFTWARE (-1) - /* Defaults to wolfSSL's default ECC_MAX_ID_LEN / RSA_MAX_ID_LEN. */ #ifndef WOLFCERT_KEY_ID_MAX_LEN #define WOLFCERT_KEY_ID_MAX_LEN 32 @@ -95,7 +92,7 @@ typedef enum { typedef struct { WolfCertKeyType type; int param; /* RSA 2048/3072/4096 or ECC 256/384/521 bits */ - int dev_id; /* wolfSSL CryptoCb devId; -1 for software */ + int dev_id; /* CryptoCb devId, or INVALID_DEVID */ void* heap; /* optional heap hint; NULL = default */ /* Backend key id, opaque to wolfCert; needs dev_id. Up to * WOLFCERT_KEY_ID_MAX_LEN bytes. */ diff --git a/zephyr/samples/wolfcert_est_client/src/main.c b/zephyr/samples/wolfcert_est_client/src/main.c index 0f6febc..5e6f07a 100644 --- a/zephyr/samples/wolfcert_est_client/src/main.c +++ b/zephyr/samples/wolfcert_est_client/src/main.c @@ -72,7 +72,7 @@ static int enroll(void) .verify_server = 1, }; WolfCertKeyCfg key_cfg = { .type = WOLFCERT_KEY_ECC, .param = 256, - .dev_id = WOLFCERT_DEVID_SOFTWARE }; + .dev_id = INVALID_DEVID }; WolfCertCertMeta meta = { .subject_dn = CONFIG_WOLFCERT_SAMPLE_SUBJECT }; WolfCertClient* client = NULL; WolfCertKey* key = NULL; From df35b24e2b040b18d4d8f90e9933228d880e0caf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Wed, 11 Nov 2026 16:19:51 +0100 Subject: [PATCH 16/17] Run client crypto on a default CryptoCb device On a part with a crypto accelerator, such as the NXP EdgeLock (ELS/PKC) on the RW612, the TLS connection, SCEP's PKCS#7 and the keys wolfCert generates in software should all run on the accelerator, whether the private key lives in a key slot or in host memory. wolfCert owns the WOLFSSL_CTX, so the application could not set its devId, and every software key, RNG and PKCS#7 object wolfCert created was pinned to software. Add wolfcert_set_default_dev_id() / wolfcert_default_dev_id(), next to the default heap hint. The default starts as WC_USE_DEVID when wolfSSL defines it with WOLF_CRYPTO_CB, which the EdgeLock port does, so such a build needs no application change. It does not fall back to wc_CryptoCb_DefaultDevID(), which without WC_USE_DEVID picks the first registered device and could hand bulk crypto to a TPM. Setting a devId on a wolfSSL without WOLF_CRYPTO_CB returns WOLFCERT_ERR_UNSUPPORTED, and one with no registered device returns WOLFCERT_ERR_BAD_ARG, since wolfCrypt would otherwise run everything in software without a word. The check is skipped under WOLF_CRYPTO_CB_FIND, whose find callback may map an unregistered devId to a device. wolfcert_cleanup() restores the start value, since wolfCrypt_Cleanup() unregisters every device. Where it applies: - A key generated or imported with dev_id = INVALID_DEVID takes the default as its device when it is created, so its keygen, CSR signature and RNG all use it and wolfcert_key_dev_id() reports it. That includes a key_id key, which goes to the default device. A key keeps its device when the default changes later. - The client TLS context gets the default devId, so a PEM or DER client key, which wolfSSL decodes onto the context's devId, signs there too. The context is left alone when the default is INVALID_DEVID, keeping the devId wolfSSL_CTX_new picks for CAAM, ARIA or MAXQ10xx. - EST /simplereenroll runs the connection of a key without a key_id on that key's own dev_id, so it still signs on its device now that WOLFCERT_CLIENT_KEY_BUFFER_DEV is gone. - The SCEP helpers take the devId explicitly: the client signs and decrypts on its key's device and encrypts and verifies on the default; the built-in server passes INVALID_DEVID, generates its keys through the internal wolfcert_key_generate_on(), and stays in software. The certs-only PKCS#7 helpers do no private-key work and stay in software. A key_id key keeps signing in client_key_dev_id through wolfSSL_CTX_use_PrivateKey_Id, so one device can hold the key while another accelerates the connection. A client_key_dev_id of INVALID_DEVID names the default device, as dev_id does in WolfCertKeyCfg. The new test registers an accelerator mock next to the key store and checks that it sees no work by default; sees the TLS crypto and the PEM key's signature once set; becomes the device of a key made with INVALID_DEVID and signs its CSR; and sees no signature for a key_id key, which still signs in the store. A key_id key made with INVALID_DEVID lands in the default device. A SCEP PKCSReq with an accelerator default runs its RSA signatures, decryption, encryption and verification there, and an unregistered devId is refused. --- AGENTS.md | 1 + docs/ARCHITECTURE.md | 21 ++- src/est/est_client.c | 46 +++-- src/http.c | 43 +++-- src/internal.c | 34 ++++ src/internal.h | 28 +++- src/keygen.c | 35 ++-- src/scep/scep_client.c | 54 +++--- src/scep/scep_msg.c | 32 ++-- src/scep/scep_server.c | 14 +- src/wolfcert.c | 1 + tests/integration/test_est_devid_roundtrip.c | 167 ++++++++++++++++++- tests/integration/test_scep_poll_roundtrip.c | 9 +- tests/integration/test_scep_roundtrip.c | 113 +++++++++++-- tests/unit/test_http.c | 2 + tests/unit/test_keygen.c | 9 + tests/unit/test_parse_negative.c | 6 +- tests/unit/test_scep_msg.c | 32 ++-- wolfcert/keygen.h | 17 +- wolfcert/types.h | 13 +- 20 files changed, 530 insertions(+), 147 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 7a3ce6e..b6f22e7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -208,6 +208,7 @@ contract, alone or in a group comment. | Persistence in flash / NVM | Store the buffers from `wolfcert_key_to_pem` / `_to_der` and the enroll result; wolfCert does no storage | `wolfcert/keygen.h` | | Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id`, and the key's backend id as `key_id`; `WolfCertServerCfg.client_key_src` selects such a key for mTLS | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | | Event loop / no blocking | `wolfcert_est_session_open` / `wolfcert_scep_session_open`, then the `_nb` calls until they stop returning `WOLFCERT_ERR_WANT_READ` / `_WANT_WRITE`; `*_session_fd` gives the descriptor to poll | `wolfcert/est.h`, `wolfcert/scep.h` | +| Crypto accelerator for TLS, PKCS#7 and software keys | `wolfcert_set_default_dev_id`; defaults to wolfSSL's `WC_USE_DEVID` when set | `wolfcert/types.h`, `docs/ARCHITECTURE.md` section 4.2 | | Logging | `wolfcert_set_log_cb` (e.g. to a UART) | `wolfcert/log.h` | | RAM budget | `max_response_bytes`, HTTP stack buffers, wolfSSL `Cert` / `CertName` sizing | `docs/EMBEDDED.md` | diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index e6a6d91..8e7e67c 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -353,21 +353,36 @@ From there, every private-key operation on the key routes through `my_callback`: CSR signing, and TLS client authentication by id or for EST `/simplereenroll`. wolfSSL also hands the backend public-key operations on that id, such as the check of its own RSA signature in TLS, so the backend -must serve those too. Pass `INVALID_DEVID` to force software operation. +must serve those too. A `dev_id` without a `key_id` only offloads the computation. The key itself is an ordinary wolfCrypt key in host memory, and `wolfcert_key_to_pem` exports it. Only a `key_id` keeps the key in the backend. +A crypto accelerator gets the rest of the client's work through +`wolfcert_set_default_dev_id`: the TLS connection, SCEP's PKCS#7, and every +key generated or imported with `dev_id = INVALID_DEVID`, which takes the +default as its device. The default is `WC_USE_DEVID` when wolfSSL defines it, +as the NXP EdgeLock port does, else `INVALID_DEVID`; set it to `INVALID_DEVID` +to run all of this in software, except that TLS keeps a devId wolfSSL picks +itself (CAAM, ARIA, MAXQ10xx). The setter returns `WOLFCERT_ERR_BAD_ARG` for a +devId with no registered device, unless wolfSSL has `WOLF_CRYPTO_CB_FIND`, +and `wolfcert_cleanup` restores the start value. A key keeps the device it was +made with, so change the default before generating or importing keys, and +before other threads use wolfCert. A key's own `dev_id` still takes +precedence, so a key held in one device can sign while another accelerates the +connection. The built-in test server always runs in software. + For TLS client authentication, `WolfCertServerCfg.client_key_src` says what `client_key` holds and where the handshake signs with it: | `client_key_src` | `client_key` holds | Signed | |---|---|---| -| `WOLFCERT_CLIENT_KEY_BUFFER` (default) | PEM or DER | in software | +| `WOLFCERT_CLIENT_KEY_BUFFER` (default) | PEM or DER | on the connection's device, the default devId | | `WOLFCERT_CLIENT_KEY_ID` | the key id | in `client_key_dev_id` | -EST `/simplereenroll` picks the source from the key being renewed. +EST `/simplereenroll` picks the source from the key being renewed, and runs +the connection of a key without a `key_id` on that key's `dev_id`. A key with a `key_id` never leaves the backend: `wolfcert_key_to_pem` and `wolfcert_key_to_der` fail with `WOLFCERT_ERR_UNSUPPORTED`. Persist the id and diff --git a/src/est/est_client.c b/src/est/est_client.c index 8b31034..d1460aa 100644 --- a/src/est/est_client.c +++ b/src/est/est_client.c @@ -157,8 +157,8 @@ struct WolfCertEstSession { WolfCertEncoding in_enc; }; -int wolfcert_est_session_open(const WolfCertServerCfg* srv, - WolfCertEstSession** out) +static int est_session_open_dev(const WolfCertServerCfg* srv, int tls_dev_id, + WolfCertEstSession** out) { if (srv == NULL || srv->server_url == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; @@ -228,7 +228,7 @@ int wolfcert_est_session_open(const WolfCertServerCfg* srv, .transport = srv->transport, .heap = heap, }; - rc = wolfcert_http_session_open(&hcfg, &s->http); + rc = wolfcert_http_session_open_dev(&hcfg, tls_dev_id, &s->http); if (rc != WOLFCERT_OK) { /* Free with wolfcert_est_session_close() to zero s->basic_pass. */ wolfcert_est_session_close(s); @@ -239,6 +239,12 @@ int wolfcert_est_session_open(const WolfCertServerCfg* srv, return WOLFCERT_OK; } +int wolfcert_est_session_open(const WolfCertServerCfg* srv, + WolfCertEstSession** out) +{ + return est_session_open_dev(srv, wolfcert_default_dev_id(), out); +} + int wolfcert_est_session_fd(const WolfCertEstSession* s) { return s != NULL ? wolfcert_http_session_fd(s->http) : -1; @@ -500,7 +506,8 @@ int wolfcert_est_session_simple_reenroll_nb(WolfCertEstSession* s, WOLFCERT_ENCODING_PEM, &out->cert_pem, out, 1); } -static int est_one_shot(const WolfCertServerCfg* srv, enum est_session_op op, +static int est_one_shot(const WolfCertServerCfg* srv, int tls_dev_id, + enum est_session_op op, const uint8_t* csr_der, size_t csr_der_len, WolfCertEncoding enc, WolfCertBuffer* out, WolfCertEstResult* res) @@ -511,7 +518,7 @@ static int est_one_shot(const WolfCertServerCfg* srv, enum est_session_op op, est_call_clear(NULL, out, res); rc = est_call_check(op, csr_der, csr_der_len, enc, out); if (rc == WOLFCERT_OK) - rc = wolfcert_est_session_open(srv, &s); + rc = est_session_open_dev(srv, tls_dev_id, &s); if (rc == WOLFCERT_OK) { wolfcert_http_session_set_close(s->http); rc = est_session_call(s, op, csr_der, csr_der_len, enc, out, res, 0); @@ -524,14 +531,15 @@ static int est_one_shot(const WolfCertServerCfg* srv, enum est_session_op op, int wolfcert_est_get_cacerts(const WolfCertServerCfg* srv, WolfCertEncoding enc, WolfCertBuffer* out_ca) { - return est_one_shot(srv, EST_OP_GET_CACERTS, NULL, 0, enc, out_ca, NULL); + return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_GET_CACERTS, + NULL, 0, enc, out_ca, NULL); } int wolfcert_est_get_csr_attrs(const WolfCertServerCfg* srv, WolfCertBuffer* out_attrs_der) { - return est_one_shot(srv, EST_OP_GET_CSRATTRS, NULL, 0, - WOLFCERT_ENCODING_DER, out_attrs_der, NULL); + return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_GET_CSRATTRS, + NULL, 0, WOLFCERT_ENCODING_DER, out_attrs_der, NULL); } int wolfcert_est_simple_enroll(const WolfCertServerCfg* srv, @@ -541,8 +549,9 @@ int wolfcert_est_simple_enroll(const WolfCertServerCfg* srv, if (out == NULL) return WOLFCERT_ERR_BAD_ARG; - return est_one_shot(srv, EST_OP_SIMPLE_ENROLL, csr_der, csr_der_len, - WOLFCERT_ENCODING_PEM, &out->cert_pem, out); + return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_SIMPLE_ENROLL, + csr_der, csr_der_len, WOLFCERT_ENCODING_PEM, + &out->cert_pem, out); } int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, @@ -553,6 +562,7 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, { WolfCertServerCfg cfg; WolfCertBuffer key_der = { 0 }; + int tls_dev_id; int rc = WOLFCERT_OK; if (out == NULL) @@ -564,15 +574,18 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, current_key == NULL) return WOLFCERT_ERR_BAD_ARG; - /* The TLS identity is the cert being renewed. */ + /* The TLS identity is the cert being renewed. wolfSSL signs with a key + * loaded from DER on the context's devId, so that is the key's device. */ cfg = *srv; + tls_dev_id = current_key->dev_id; cfg.client_cert = current_cert; cfg.client_cert_len = current_cert_len; - cfg.client_key_dev_id = current_key->dev_id; if (current_key->id_len > 0) { - cfg.client_key = current_key->id; - cfg.client_key_len = current_key->id_len; - cfg.client_key_src = WOLFCERT_CLIENT_KEY_ID; + cfg.client_key = current_key->id; + cfg.client_key_len = current_key->id_len; + cfg.client_key_src = WOLFCERT_CLIENT_KEY_ID; + cfg.client_key_dev_id = current_key->dev_id; + tls_dev_id = wolfcert_default_dev_id(); } else { rc = wolfcert_key_to_der(current_key, &key_der); @@ -581,7 +594,8 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, cfg.client_key_src = WOLFCERT_CLIENT_KEY_BUFFER; } if (rc == WOLFCERT_OK) - rc = est_one_shot(&cfg, EST_OP_SIMPLE_REENROLL, csr_der, csr_der_len, + rc = est_one_shot(&cfg, tls_dev_id, EST_OP_SIMPLE_REENROLL, + csr_der, csr_der_len, WOLFCERT_ENCODING_PEM, &out->cert_pem, out); wolfcert_buffer_free_secure(&key_der); diff --git a/src/http.c b/src/http.c index 87523a8..65bc170 100644 --- a/src/http.c +++ b/src/http.c @@ -919,16 +919,17 @@ int wolfcert_http_chunked_decode(const uint8_t* in, size_t in_len, } typedef struct { - const uint8_t* trust_anchors; - size_t trust_anchors_len; - int verify_server; - const uint8_t* client_cert; - size_t client_cert_len; - const uint8_t* client_key; - size_t client_key_len; + const uint8_t* trust_anchors; + size_t trust_anchors_len; + int verify_server; + const uint8_t* client_cert; + size_t client_cert_len; + const uint8_t* client_key; + size_t client_key_len; WolfCertClientKeySrc client_key_src; - int client_key_dev_id; - int allow_post_handshake_auth; + int client_key_dev_id; + int allow_post_handshake_auth; + int tls_dev_id; } TlsDials; static int buf_filetype(const uint8_t* buf, size_t len) @@ -968,9 +969,10 @@ static int use_client_key(WOLFSSL_CTX* ctx, const TlsDials* d) #endif } else { + int type = buf_filetype(d->client_key, d->client_key_len); + rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, d->client_key, - (long)d->client_key_len, - buf_filetype(d->client_key, d->client_key_len)); + (long)d->client_key_len, type); } if (rc != WOLFSSL_SUCCESS) @@ -986,6 +988,12 @@ static int setup_tls_ex(WolfCertConn* c, const TlsDials* dials, WOLFSSL_CTX* ctx = wolfSSL_CTX_new(wolfTLS_client_method()); if (ctx == NULL) return WOLFCERT_ERR_TLS; + /* Keeps the devId wolfSSL_CTX_new picks itself, such as CAAM's. */ + if (dials->tls_dev_id != INVALID_DEVID && + wolfSSL_CTX_SetDevId(ctx, dials->tls_dev_id) != WOLFSSL_SUCCESS) { + wolfSSL_CTX_free(ctx); + return WOLFCERT_ERR_TLS; + } #ifdef WOLFSSL_NO_TLS12 (void)wolfSSL_CTX_SetMinVersion(ctx, WOLFSSL_TLSV1_3); @@ -1080,14 +1088,20 @@ static size_t rx_max(size_t max_body) int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, WolfCertHttpSession** out) +{ + return wolfcert_http_session_open_dev(cfg, wolfcert_default_dev_id(), out); +} + +int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, + int tls_dev_id, WolfCertHttpSession** out) { if (cfg == NULL || cfg->base_url == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; + int key_dev_id = wolfcert_devid_or_default(cfg->client_key_dev_id); int rc = check_client_key(cfg->client_key_src, cfg->client_cert, cfg->client_cert_len, cfg->client_key, - cfg->client_key_len, - cfg->client_key_dev_id); + cfg->client_key_len, key_dev_id); if (rc != WOLFCERT_OK) return rc; @@ -1133,8 +1147,9 @@ int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, .client_key = cfg->client_key, .client_key_len = cfg->client_key_len, .client_key_src = cfg->client_key_src, - .client_key_dev_id = cfg->client_key_dev_id, + .client_key_dev_id = key_dev_id, .allow_post_handshake_auth = cfg->allow_post_handshake_auth, + .tls_dev_id = tls_dev_id, }; rc = setup_tls_ex(&s->conn, &dials, s->base.host, &s->ctx); diff --git a/src/internal.c b/src/internal.c index aac6ed0..77b93e4 100644 --- a/src/internal.c +++ b/src/internal.c @@ -22,12 +22,21 @@ #include #include +#ifdef WOLF_CRYPTO_CB +#include +#endif #include #include #include static void* g_default_heap = NULL; +#if defined(WC_USE_DEVID) && defined(WOLF_CRYPTO_CB) +#define START_DEV_ID WC_USE_DEVID +#else +#define START_DEV_ID INVALID_DEVID +#endif +static int g_default_dev_id = START_DEV_ID; static WolfCertLogCb g_log_cb = NULL; static void* g_log_ctx = NULL; static WolfCertLogLevel g_log_level = WOLFCERT_LOG_WARN; @@ -51,6 +60,31 @@ void* wolfcert_default_heap(void) return g_default_heap; } +int wolfcert_set_default_dev_id(int dev_id) +{ +#ifndef WOLF_CRYPTO_CB + if (dev_id != INVALID_DEVID) + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "wolfcert", + "wolfSSL lacks WOLF_CRYPTO_CB"); +#elif !defined(WOLF_CRYPTO_CB_FIND) + if (dev_id != INVALID_DEVID && !wc_CryptoCb_IsDeviceRegistered(dev_id)) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "wolfcert", + "no CryptoCb device %d is registered", dev_id); +#endif + g_default_dev_id = dev_id; + return WOLFCERT_OK; +} + +int wolfcert_default_dev_id(void) +{ + return g_default_dev_id; +} + +void wolfcert_default_dev_id_reset(void) +{ + g_default_dev_id = START_DEV_ID; +} + void wolfcert_set_log_cb(WolfCertLogCb cb, void* ctx) { g_log_cb = cb; diff --git a/src/internal.h b/src/internal.h index d0ff2e4..12da7d8 100644 --- a/src/internal.h +++ b/src/internal.h @@ -91,6 +91,18 @@ static inline int wolfcert_devid_is_cb(int dev_id) return dev_id != INVALID_DEVID; } +static inline int wolfcert_devid_or_default(int dev_id) +{ + return dev_id != INVALID_DEVID ? dev_id : wolfcert_default_dev_id(); +} + +/* Restores the start devId; wolfCrypt_Cleanup unregisters the devices. */ +void wolfcert_default_dev_id_reset(void); + +/* wolfcert_key_generate on dev_id as given, without the default devId. */ +int wolfcert_key_generate_on(const WolfCertKeyCfg* cfg, int dev_id, + WolfCertKey** out_key); + /* BAD_ARG or UNSUPPORTED, with a message, unless id names a key a CryptoCb * device can hold in this build. */ int wolfcert_key_id_check(const uint8_t* id, size_t id_len, int dev_id, @@ -296,6 +308,10 @@ typedef struct { WOLFCERT_TEST_VIS int wolfcert_http_url_parse(const char* url, WolfCertUrl* out, void* heap); WOLFCERT_TEST_VIS void wolfcert_http_url_free (WolfCertUrl* u); +/* wolfcert_http_session_open with the TLS context on tls_dev_id. */ +int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, + int tls_dev_id, WolfCertHttpSession** out); + /* Resume point for wolfcert_http_chunked_complete(); zero it before the first * call, setting max to cap the decoded body (0 for no cap). */ typedef struct { @@ -449,7 +465,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_issuer_name_matches( WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, size_t ra_cert_len, const uint8_t* payload, size_t payload_len, int enc_oid, - WolfCertBuffer* out_der, void* heap); + WolfCertBuffer* out_der, int dev_id, void* heap); /* RFC 8894 section 4.1 GET PKIOperation URL; WOLFCERT_ERR_UNSUPPORTED past * WOLFCERT_SCEP_MAX_GET_URL. */ @@ -469,21 +485,23 @@ WOLFCERT_TEST_VIS int wolfcert_scep_pick_hash_oid(const WolfCertScepCaps* caps, int wolfcert_scep_deenvelop(const uint8_t* recipient_cert_der, size_t recipient_cert_len, const uint8_t* recipient_key_der, size_t recipient_key_len, const uint8_t* env_der, size_t env_len, - WolfCertBuffer* out_plain, void* heap); + WolfCertBuffer* out_plain, int dev_id, void* heap); #ifdef WOLFCERT_HAVE_RSA WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, - const uint8_t* csr_der, size_t csr_len, uint8_t** out_der, size_t* out_len, void* heap); + const uint8_t* csr_der, size_t csr_len, uint8_t** out_der, size_t* out_len, + int dev_id, void* heap); #endif WOLFCERT_TEST_VIS int wolfcert_scep_build_pki_message(const uint8_t* envelope_der, size_t envelope_len, const uint8_t* signer_cert_der, size_t signer_cert_len, const uint8_t* signer_key_der, size_t signer_key_len, int hash_oid, - const WolfCertScepAttrs* attrs, WolfCertBuffer* out_der, void* heap); + const WolfCertScepAttrs* attrs, WolfCertBuffer* out_der, int dev_id, + void* heap); WOLFCERT_TEST_VIS int wolfcert_scep_parse_pki_message(const uint8_t* pki_der, size_t pki_len, WolfCertBuffer* out_envelope, uint8_t** out_transaction_id, size_t* out_tid_len, uint8_t** out_sender_nonce, size_t* out_snonce_len, uint8_t** out_recipient_nonce,size_t* out_rnonce_len, char** out_message_type, char** out_pki_status, uint8_t** out_signer_cert, size_t* out_signer_cert_len, - char** out_fail_info, void* heap); + char** out_fail_info, int dev_id, void* heap); /* GetNextCACert response (RFC 8894 section 4.7.1), signed by the current CA. */ WOLFCERT_TEST_VIS int wolfcert_scep_build_next_ca_response( diff --git a/src/keygen.c b/src/keygen.c index d7cfe22..b985438 100644 --- a/src/keygen.c +++ b/src/keygen.c @@ -49,14 +49,14 @@ static WolfCertKey* alloc_shell(WolfCertKeyType type, int dev_id, return k; } -static int check_key_id(const WolfCertKeyCfg* cfg) +static int check_key_id(const WolfCertKeyCfg* cfg, int dev_id) { if (cfg->key_id_len == 0) return cfg->key_id == NULL ? WOLFCERT_OK : WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", "key_id is set but key_id_len is 0"); - return wolfcert_key_id_check(cfg->key_id, cfg->key_id_len, cfg->dev_id, + return wolfcert_key_id_check(cfg->key_id, cfg->key_id_len, dev_id, "keygen"); } @@ -74,21 +74,31 @@ static void free_shell(WolfCertKey* k) int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) { - if (cfg == NULL || out_key == NULL) + return wolfcert_key_generate_on(cfg, + cfg != NULL ? wolfcert_devid_or_default(cfg->dev_id) : INVALID_DEVID, + out_key); +} + +int wolfcert_key_generate_on(const WolfCertKeyCfg* cfg, int dev_id, + WolfCertKey** out_key) +{ + if (out_key == NULL) return WOLFCERT_ERR_BAD_ARG; *out_key = NULL; + if (cfg == NULL) + return WOLFCERT_ERR_BAD_ARG; const WolfCertKeyAlg* alg = wolfcert_key_alg(cfg->type); if (alg == NULL) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", "unknown or disabled key type %d", (int)cfg->type); - int rc = check_key_id(cfg); + int rc = check_key_id(cfg, dev_id); if (rc != WOLFCERT_OK) return rc; void* heap = cfg->heap ? cfg->heap : wolfcert_default_heap(); - WolfCertKey* k = alloc_shell(cfg->type, cfg->dev_id, cfg->key_id, + WolfCertKey* k = alloc_shell(cfg->type, dev_id, cfg->key_id, cfg->key_id_len, heap); if (k == NULL) return WOLFCERT_ERR_MEMORY; @@ -96,7 +106,7 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) /* The RNG is set up first; a DRBG alloc between the large ML-DSA * allocations tripped a glibc sysmalloc assertion. */ WC_RNG rng; - rc = wc_InitRng_ex(&rng, heap, cfg->dev_id); + rc = wc_InitRng_ex(&rng, heap, dev_id); if (rc != 0) { free_shell(k); return WOLFCERT_ERR_WC(rc, "keygen", "InitRng"); @@ -121,7 +131,7 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) free_shell(k); return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", "CryptoCb device %d did not generate the key", - cfg->dev_id); + dev_id); } /* The device may rename the key, as a TPM does for a transient one. */ @@ -134,7 +144,7 @@ int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) *out_key = k; return WOLFCERT_ERR(WOLFCERT_ERR_CRYPTO, "keygen", "CryptoCb device %d left a bad key id", - cfg->dev_id); + dev_id); } memcpy(k->id, id, (size_t)id_len); k->id_len = (size_t)id_len; @@ -210,8 +220,8 @@ int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, const WolfCertKeyAlg* const* list = wolfcert_key_algs_all(); for (; *list != NULL; ++list) { const WolfCertKeyAlg* a = *list; - WolfCertKey* k = alloc_shell(a->type, INVALID_DEVID, NULL, 0, - heap); + WolfCertKey* k = alloc_shell(a->type, wolfcert_default_dev_id(), NULL, + 0, heap); if (k == NULL) { if (der != NULL) wc_FreeDer(&der); @@ -320,7 +330,8 @@ int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, if (cfg == NULL || cfg->key_id_len == 0 || cert == NULL || cert_len == 0) return WOLFCERT_ERR_BAD_ARG; - int rc = check_key_id(cfg); + int dev_id = wolfcert_devid_or_default(cfg->dev_id); + int rc = check_key_id(cfg, dev_id); if (rc != WOLFCERT_OK) return rc; @@ -336,7 +347,7 @@ int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, if (rc != WOLFCERT_OK) return rc; - WolfCertKey* k = alloc_shell(cfg->type, cfg->dev_id, cfg->key_id, + WolfCertKey* k = alloc_shell(cfg->type, dev_id, cfg->key_id, cfg->key_id_len, heap); if (k == NULL) { WOLFCERT_XFREE(spki, heap); diff --git a/src/scep/scep_client.c b/src/scep/scep_client.c index 4423051..620cc37 100644 --- a/src/scep/scep_client.c +++ b/src/scep/scep_client.c @@ -670,33 +670,38 @@ static int scep_call_check(const ScepCall* c) } struct WolfCertScepSession { - WolfCertHttpSession* http; - char* server_url; /* full SCEP endpoint URL, owned */ - void* heap; + WolfCertHttpSession* http; + char* server_url; /* full SCEP endpoint URL, owned */ + void* heap; WolfCertScepTxidMode txid_mode; WolfCertScepContentCipher content_cipher; WolfCertScepRenewalMsgType renewal_msg_type; WolfCertScepSigningHash signing_hash; - char* ca_id; /* owned copy, or NULL */ + char* ca_id; /* owned copy, or NULL */ /* In-flight state of the single active round trip. */ int in_active; - enum scep_session_op in_op; /* valid when in_active */ + enum scep_session_op in_op; /* valid when in_active */ WolfCertEncoding in_enc; - char* in_url; /* owned request URL */ - WolfCertBuffer in_pki; /* built pkiMessage, owned (POST body) */ + char* in_url; /* owned request URL */ + WolfCertBuffer in_pki; /* pkiMessage POST body, owned */ WolfCertHttpRequest in_req; WolfCertHttpResponse in_resp; - const uint8_t* in_ca_bundle; size_t in_ca_bundle_len; /* in use */ - uint8_t* in_ca_bundle_copy; /* owned, for an _nb request */ - const uint8_t* in_signer; size_t in_signer_len; /* in use */ - uint8_t* in_signer_copy; /* owned: _nb copy or self-signed */ - uint8_t* in_signer_key; size_t in_signer_key_len; /* key DER, zeroized */ - uint8_t* in_txid; size_t in_txid_len; /* owned, from scep_prepare */ - uint8_t in_nonce[SCEP_NONCE_SZ]; - WolfCertBuffer in_ias; /* IssuerAndSubject or IssuerAndSerial sent, owned */ - const void* in_out; /* caller's output, checked on resume */ + const uint8_t* in_ca_bundle; /* in use */ + size_t in_ca_bundle_len; + uint8_t* in_ca_bundle_copy; /* owned, for an _nb request */ + const uint8_t* in_signer; /* in use */ + size_t in_signer_len; + uint8_t* in_signer_copy; /* owned: _nb copy or self-signed */ + uint8_t* in_signer_key; /* key DER, zeroized */ + size_t in_signer_key_len; + int in_signer_dev_id; + uint8_t* in_txid; /* owned, from scep_prepare */ + size_t in_txid_len; + uint8_t in_nonce[SCEP_NONCE_SZ]; + WolfCertBuffer in_ias; /* IssuerAndSubject/Serial, owned */ + const void* in_out; /* caller's output, resume check */ }; static uint8_t* dup_buf(const uint8_t* src, size_t len, void* heap) @@ -970,12 +975,13 @@ static int scep_prepare(WolfCertScepSession* s, const ScepCall* c, WolfCertBuffer env = { 0 }; int rc = wolfcert_scep_envelop(c->ra_cert, c->ra_cert_len, envelope_content, envelope_content_len, - enc_oid, &env, heap); + enc_oid, &env, wolfcert_default_dev_id(), + heap); if (rc != WOLFCERT_OK) return rc; WC_RNG rng; - int rng_rc = wc_InitRng_ex(&rng, heap, INVALID_DEVID); + int rng_rc = wc_InitRng_ex(&rng, heap, wolfcert_default_dev_id()); if (rng_rc != 0) { wolfcert_buffer_free(&env); return WOLFCERT_ERR_WC(rng_rc, "scep", "RNG init failed"); @@ -1004,7 +1010,8 @@ static int scep_prepare(WolfCertScepSession* s, const ScepCall* c, rc = wolfcert_scep_build_pki_message(env.data, env.len, s->in_signer, s->in_signer_len, s->in_signer_key, s->in_signer_key_len, - hash_oid, &attrs, out_pki, heap); + hash_oid, &attrs, out_pki, + s->in_signer_dev_id, heap); wolfcert_buffer_free(&env); return rc; @@ -1031,7 +1038,8 @@ static int scep_finish(const WolfCertScepSession* s, WolfCertScepResult* out) int rc = wolfcert_scep_parse_pki_message(s->in_resp.body, s->in_resp.body_len, &resp_env, &rx_tid, &rx_tid_len, &rx_sn, &rx_sn_len, &rx_rn, &rx_rn_len, - &resp_mt, &status, &rx_signer, &rx_signer_len, &fail_info, heap); + &resp_mt, &status, &rx_signer, &rx_signer_len, &fail_info, + wolfcert_default_dev_id(), heap); WOLFCERT_XFREE(rx_sn, heap); @@ -1104,7 +1112,7 @@ static int scep_finish(const WolfCertScepSession* s, WolfCertScepResult* out) rc = wolfcert_scep_deenvelop(s->in_signer, s->in_signer_len, s->in_signer_key, s->in_signer_key_len, resp_env.data, resp_env.len, &inner, - heap); + s->in_signer_dev_id, heap); if (rc == WOLFCERT_OK) rc = wolfcert_pkcs7_certs_to_pem(inner.data, inner.len, &out->cert_pem, heap); @@ -1142,7 +1150,8 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, rc = wolfcert_scep_self_signed_rsa((RsaKey*)c->key->impl, c->csr, c->csr_len, &s->in_signer_copy, - &s->in_signer_len, heap); + &s->in_signer_len, + c->key->dev_id, heap); s->in_signer = s->in_signer_copy; } else { @@ -1195,6 +1204,7 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, rc = wolfcert_key_export_der(c->key, &s->in_signer_key, &key_len, heap); s->in_signer_key_len = (size_t)key_len; + s->in_signer_dev_id = c->key->dev_id; if (rc == WOLFCERT_OK) rc = scep_prepare(s, c, msg_type, content, content_len, &pki); if (rc == WOLFCERT_OK) diff --git a/src/scep/scep_msg.c b/src/scep/scep_msg.c index 9e96c84..ba742fc 100644 --- a/src/scep/scep_msg.c +++ b/src/scep/scep_msg.c @@ -325,9 +325,9 @@ static int build_signed_attribs(const WolfCertScepAttrs* a, WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, size_t ra_cert_len, const uint8_t* payload, size_t payload_len, int enc_oid, - WolfCertBuffer* out_der, void* heap) + WolfCertBuffer* out_der, int dev_id, void* heap) { - PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); + PKCS7* p7 = wc_PKCS7_New(heap, dev_id); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -347,7 +347,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, } WC_RNG rng; - if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { + if (wc_InitRng_ex(&rng, heap, dev_id) != 0) { wc_PKCS7_Free(p7); return WOLFCERT_ERR_CRYPTO; } @@ -385,13 +385,13 @@ WOLFCERT_TEST_VIS int wolfcert_scep_envelop(const uint8_t* ra_cert_der, int wolfcert_scep_deenvelop(const uint8_t* recipient_cert_der, size_t recipient_cert_len, const uint8_t* recipient_key_der, size_t recipient_key_len, const uint8_t* env_der, size_t env_len, - WolfCertBuffer* out_plain, void* heap) + WolfCertBuffer* out_plain, int dev_id, void* heap) { /* env_len is server-controlled and sizes the env_len + 4096 allocation. */ if (env_len == 0 || env_len > WOLFCERT_SCEP_MAX_MSG_SZ) return WOLFCERT_ERR_BAD_ARG; - PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); + PKCS7* p7 = wc_PKCS7_New(heap, dev_id); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -429,7 +429,7 @@ int wolfcert_scep_deenvelop(const uint8_t* recipient_cert_der, size_t recipient_ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, const uint8_t* csr_der, size_t csr_len, uint8_t** out_der, size_t* out_len, - void* heap) + int dev_id, void* heap) { DecodedCert* dc; Cert* cert; @@ -450,7 +450,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, if (cert == NULL) return WOLFCERT_ERR_MEMORY; - wc_InitCert_ex(cert, heap, INVALID_DEVID); + wc_InitCert_ex(cert, heap, dev_id); dc = (DecodedCert*)WOLFCERT_XMALLOC(sizeof(*dc), heap); if (dc == NULL) { @@ -503,7 +503,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, return WOLFCERT_ERR_WC(rc, "scep", "SetKeyUsage"); } - if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { + if (wc_InitRng_ex(&rng, heap, dev_id) != 0) { wc_CertFree(cert); return WOLFCERT_ERR_CRYPTO; } @@ -532,9 +532,10 @@ WOLFCERT_TEST_VIS int wolfcert_scep_self_signed_rsa(RsaKey* key, WOLFCERT_TEST_VIS int wolfcert_scep_build_pki_message(const uint8_t* envelope_der, size_t envelope_len, const uint8_t* signer_cert_der, size_t signer_cert_len, const uint8_t* signer_key_der, size_t signer_key_len, int hash_oid, - const WolfCertScepAttrs* attrs, WolfCertBuffer* out_der, void* heap) + const WolfCertScepAttrs* attrs, WolfCertBuffer* out_der, int dev_id, + void* heap) { - PKCS7* p7 = wc_PKCS7_New(heap, INVALID_DEVID); + PKCS7* p7 = wc_PKCS7_New(heap, dev_id); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; @@ -545,7 +546,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_build_pki_message(const uint8_t* envelope_de } WC_RNG rng; - if (wc_InitRng_ex(&rng, heap, INVALID_DEVID) != 0) { + if (wc_InitRng_ex(&rng, heap, dev_id) != 0) { wc_PKCS7_Free(p7); return WOLFCERT_ERR_CRYPTO; } @@ -639,7 +640,8 @@ WOLFCERT_TEST_VIS int wolfcert_scep_build_next_ca_response(const uint8_t* next_c rc = wolfcert_scep_build_pki_message(inner.data, inner.len, ca_cert, ca_cert_len, ca_key, ca_key_len, - SHA256h, &attrs, out_der, heap); + SHA256h, &attrs, out_der, + INVALID_DEVID, heap); wolfcert_buffer_free(&inner); return rc; @@ -662,7 +664,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_verify_next_ca_response(const uint8_t* resp_ rc = wolfcert_scep_parse_pki_message(resp_der, resp_len, &content, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, - &signer, &signer_len, NULL, heap); + &signer, &signer_len, NULL, wolfcert_default_dev_id(), heap); /* The rollover signer must share the trusted current CA's public key. */ if (rc == WOLFCERT_OK) { @@ -722,7 +724,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_parse_pki_message(const uint8_t* pki_der, size_t* out_tid_len, uint8_t** out_sender_nonce, size_t* out_snonce_len, uint8_t** out_recipient_nonce,size_t* out_rnonce_len, char** out_message_type, char** out_pki_status, uint8_t** out_signer_cert, size_t* out_signer_cert_len, - char** out_fail_info, void* heap) + char** out_fail_info, int dev_id, void* heap) { PKCS7* p7; PKCS7DecodedAttrib* a; @@ -739,7 +741,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_parse_pki_message(const uint8_t* pki_der, int bit; int rc; - p7 = wc_PKCS7_New(heap, INVALID_DEVID); + p7 = wc_PKCS7_New(heap, dev_id); if (p7 == NULL) return WOLFCERT_ERR_MEMORY; diff --git a/src/scep/scep_server.c b/src/scep/scep_server.c index 40fea76..2b1ef42 100644 --- a/src/scep/scep_server.c +++ b/src/scep/scep_server.c @@ -590,6 +590,7 @@ static int send_cert_rep(WolfCertServer* s, int fd, rc = wolfcert_scep_envelop(env_target, env_target_len, p7.data, p7.len, SCEP_SRV_ENC_OID, &resp_env, + INVALID_DEVID, s->heap); wolfcert_buffer_free(&p7); @@ -679,7 +680,8 @@ static int send_cert_rep(WolfCertServer* s, int fd, rc = wolfcert_scep_build_pki_message(resp_env.data, resp_env.len, sign_cert, sign_cert_len, sign_key, sign_key_len, - SHA256h, &attrs, &pki_out, s->heap); + SHA256h, &attrs, &pki_out, + INVALID_DEVID, s->heap); wolfcert_buffer_free(&resp_env); if (rc != WOLFCERT_OK) { @@ -1099,7 +1101,8 @@ static int handle_pki_op(WolfCertServer* s, int fd, const ScepRequest* req) int rc = wolfcert_scep_parse_pki_message(req->body, req->body_len, &env, &tid, &tid_len, &snonce, &snonce_len, &rnonce, &rnonce_len, - &mt, &ps, &signer_cert, &signer_cert_len, NULL, s->heap); + &mt, &ps, &signer_cert, &signer_cert_len, NULL, INVALID_DEVID, + s->heap); if (rc == WOLFCERT_ERR_MEMORY) { send_text(s, fd, 500, "Server Error", "text/plain", ""); goto out; @@ -1129,6 +1132,7 @@ static int handle_pki_op(WolfCertServer* s, int fd, const ScepRequest* req) rep_identity(s, &rcpt_cert, &rcpt_cert_len, &rcpt_key, &rcpt_key_len); rc = wolfcert_scep_deenvelop(rcpt_cert, rcpt_cert_len, rcpt_key, rcpt_key_len, env.data, env.len, &csr, + INVALID_DEVID, s->heap); if (rc != WOLFCERT_OK) { const char* fail_info = rc == WOLFCERT_ERR_UNSUPPORTED @@ -1328,7 +1332,7 @@ static int make_split_ra(WolfCertServer* s, ScepPriv* p) size_t lens[2]; int rc; - rc = wolfcert_key_generate(&kcfg, &key); + rc = wolfcert_key_generate_on(&kcfg, INVALID_DEVID, &key); if (rc == WOLFCERT_OK) rc = wolfcert_csr_build(key, &meta, &csr); if (rc == WOLFCERT_OK) @@ -1465,7 +1469,7 @@ static int bundle_root(WolfCertServer* s, uint8_t** root, size_t* root_len) size_t ca_len = 0; int rc; - rc = wolfcert_key_generate(&kcfg, &key); + rc = wolfcert_key_generate_on(&kcfg, INVALID_DEVID, &key); if (rc == WOLFCERT_OK) rc = bundle_cert(s, RSA_TYPE, key->impl, "wolfCert Test Root", "keyCertSign,cRLSign,keyEncipherment", BUNDLE_CA, @@ -1535,7 +1539,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_server_set_bundle_fault(WolfCertServer* s, if (rc == WOLFCERT_OK && mode == 1) rc = bundle_root(s, &der[3], &len[3]); if (rc == WOLFCERT_OK && mode == 3) { - rc = wolfcert_key_generate(&ecc, &ecc_key); + rc = wolfcert_key_generate_on(&ecc, INVALID_DEVID, &ecc_key); if (rc == WOLFCERT_OK) rc = bundle_cert(s, ECC_TYPE, ecc_key->impl, "wolfCert Test ECC Leaf", NULL, 0, NULL, NULL, 0, diff --git a/src/wolfcert.c b/src/wolfcert.c index 41e7ae2..137ef27 100644 --- a/src/wolfcert.c +++ b/src/wolfcert.c @@ -40,6 +40,7 @@ int wolfcert_init(void* heap) void wolfcert_cleanup(void) { wolfSSL_Cleanup(); + wolfcert_default_dev_id_reset(); } void wolfcert_buffer_free(WolfCertBuffer* buf) diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c index 3d510d5..f8f8005 100644 --- a/tests/integration/test_est_devid_roundtrip.c +++ b/tests/integration/test_est_devid_roundtrip.c @@ -60,8 +60,9 @@ int main(void) } \ } while (0) -#define MOCK_DEVID 0x6d6b -#define MOCK_SLOTS 4 +#define MOCK_DEVID 0x6d6b +#define ACCEL_DEVID 0x6163 +#define MOCK_SLOTS 4 enum { MOCK_ECC = 1, MOCK_RSA, MOCK_MLDSA, MOCK_ED25519, MOCK_ED448 }; @@ -341,6 +342,29 @@ static int mock_cb(int devId, wc_CryptoInfo* info, void* ctx) } } +/* An accelerator that counts what it is offered and leaves it to software. */ +static int accel_calls; +static int accel_signs; + +static int accel_cb(int devId, wc_CryptoInfo* info, void* ctx) +{ + (void)devId; + (void)ctx; + + accel_calls++; + if (info->algo_type == WC_ALGO_TYPE_PK && + info->pk.type == WC_PK_TYPE_ECDSA_SIGN) + accel_signs++; +#ifndef NO_RSA + if (info->algo_type == WC_ALGO_TYPE_PK && + info->pk.type == WC_PK_TYPE_RSA && + (info->pk.rsa.type == RSA_PRIVATE_ENCRYPT || + info->pk.rsa.type == RSA_PRIVATE_DECRYPT)) + accel_signs++; +#endif + return CRYPTOCB_UNAVAILABLE; +} + #ifdef MOCK_HAVE_ED448 /* Provisions the store's key out of band, since not every wolfSSL with Ed448 * key ids passes Ed448 keygen to a CryptoCb. */ @@ -742,8 +766,8 @@ static int test_client_key_src(const char* url, key = NULL; #ifdef KEEP_PEER_CERT - /* A dev_id key without a key_id signs its CSR on the device and the - * handshake in software. */ + /* A dev_id key without a key_id signs its CSR and the handshake on the + * device. */ const WolfCertCertMeta renew_meta = { 0 }; WolfCertClient* client = NULL; WolfCertKey* unused = NULL; @@ -764,7 +788,7 @@ static int test_client_key_src(const char* url, fprintf(stderr, "dev reenroll rc=%d (%s)\n", rc, wolfcert_last_error_message()); REQUIRE(rc == WOLFCERT_OK); - REQUIRE(mock_sign_requests == requests + 1); + REQUIRE(mock_sign_requests >= requests + 2); wolfcert_buffer_free(&renewed); wolfcert_est_result_free(&cert); wolfcert_buffer_free(&csr); @@ -773,6 +797,124 @@ static int test_client_key_src(const char* url, return 0; } +/* The default devId gets the client's TLS crypto, including a PEM client key's + * signature, while a key_id key still signs in its own device. */ +static int test_default_dev_id(const char* url, + const uint8_t* tls_cert, size_t tls_cert_len, + const uint8_t* boot_cert, size_t boot_cert_len, + const uint8_t* boot_key, size_t boot_key_len) +{ + static const uint8_t id[] = "wolfcert/accel-key"; + static const uint8_t dflt_id[] = "wolfcert/default-key"; + const WolfCertCertMeta meta = { + .subject_dn = "CN=devid-default,O=wolfSSL" + }; + WolfCertKeyCfg kcfg = { .type = TEST_ENROLL_KEY_TYPE, + .param = TEST_ENROLL_KEY_PARAM, + .dev_id = INVALID_DEVID }; + WolfCertServerCfg cli = { + .protocol = WOLFCERT_PROTO_EST, + .server_url = url, + .trust_anchors = tls_cert, + .trust_anchors_len = tls_cert_len, + .verify_server = 1, + .client_cert = boot_cert, + .client_cert_len = boot_cert_len, + .client_key = boot_key, + .client_key_len = boot_key_len, + }; + WolfCertKey* key = NULL; + WolfCertBuffer csr = { 0 }; + WolfCertEstResult cert = { 0 }; + WolfCertEstResult issued = { 0 }; + int ops; + +#ifndef WC_USE_DEVID + REQUIRE(wolfcert_default_dev_id() == INVALID_DEVID); +#endif + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); + accel_calls = 0; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + wolfcert_est_result_free(&cert); + REQUIRE(accel_calls == 0); + + REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); + REQUIRE(wolfcert_default_dev_id() == ACCEL_DEVID); + accel_signs = 0; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + wolfcert_est_result_free(&cert); + REQUIRE(accel_calls > 0); + REQUIRE(accel_signs > 0); + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); + key = NULL; + + /* A key made with INVALID_DEVID now takes the default for its own work. */ + accel_signs = 0; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(key) == ACCEL_DEVID); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(accel_signs == 1); + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); + key = NULL; + + /* A key_id with INVALID_DEVID goes to the default device too. */ + REQUIRE(wolfcert_set_default_dev_id(MOCK_DEVID) == WOLFCERT_OK); + kcfg.key_id = dflt_id; + kcfg.key_id_len = sizeof(dflt_id) - 1; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(key) == MOCK_DEVID); + wolfcert_key_free(key); + key = NULL; + REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); + + kcfg.dev_id = MOCK_DEVID; + kcfg.key_id = id; + kcfg.key_id_len = sizeof(id) - 1; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued) == + WOLFCERT_OK); + + cli.client_cert = issued.cert_pem.data; + cli.client_cert_len = issued.cert_pem.len; + cli.client_key = id; + cli.client_key_len = sizeof(id) - 1; + cli.client_key_src = WOLFCERT_CLIENT_KEY_ID; + cli.client_key_dev_id = MOCK_DEVID; + accel_calls = 0; + accel_signs = 0; + ops = mock_private_ops; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + REQUIRE(accel_calls > 0); + REQUIRE(accel_signs == 0); + REQUIRE(mock_private_ops > ops); + wolfcert_est_result_free(&cert); + + /* client_key_dev_id = INVALID_DEVID names the default device. */ + REQUIRE(wolfcert_set_default_dev_id(MOCK_DEVID) == WOLFCERT_OK); + cli.client_key_dev_id = INVALID_DEVID; + ops = mock_private_ops; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + REQUIRE(mock_private_ops > ops); + + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); + wolfcert_est_result_free(&cert); + wolfcert_est_result_free(&issued); + wolfcert_buffer_free(&csr); + wolfcert_key_free(key); + mock_reset(); + return 0; +} + /* A failed enroll or rekey still hands back a key made under a key_id. */ static int test_failure_keeps_key(const char* url, const uint8_t* tls_cert, size_t tls_cert_len) @@ -873,6 +1015,9 @@ int main(void) REQUIRE(wolfcert_init(NULL) == WOLFCERT_OK); REQUIRE(wc_CryptoCb_RegisterDevice(MOCK_DEVID, mock_cb, NULL) == 0); + REQUIRE(wc_CryptoCb_RegisterDevice(ACCEL_DEVID, accel_cb, NULL) == 0); + /* A WC_USE_DEVID build starts on a device; these checks expect none. */ + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); REQUIRE(test_cfg_errors() == 0); REQUIRE(mint_self_id("127.0.0.1", 0, &tls_cert, &tls_cert_len, @@ -950,10 +1095,13 @@ int main(void) #endif #ifdef MOCK_HAVE_ED448 REQUIRE(run_key_type(url, WOLFCERT_KEY_ED448, 0, tls_cert, tls_cert_len, - boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); + boot_cert, boot_cert_len, boot_key, + boot_key_len) == 0); #endif REQUIRE(test_client_key_src(url, tls_cert, tls_cert_len, boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); + REQUIRE(test_default_dev_id(url, tls_cert, tls_cert_len, boot_cert, + boot_cert_len, boot_key, boot_key_len) == 0); REQUIRE(test_failure_keeps_key(url, tls_cert, tls_cert_len) == 0); wolfcert_server_stop(srv); @@ -966,8 +1114,15 @@ int main(void) free(tls_key); free(boot_cert); free(boot_key); + REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); + wc_CryptoCb_UnRegisterDevice(ACCEL_DEVID); wc_CryptoCb_UnRegisterDevice(MOCK_DEVID); wolfcert_cleanup(); +#ifdef WC_USE_DEVID + REQUIRE(wolfcert_default_dev_id() == WC_USE_DEVID); +#else + REQUIRE(wolfcert_default_dev_id() == INVALID_DEVID); +#endif printf("est_devid_roundtrip: OK\n"); return 0; } diff --git a/tests/integration/test_scep_poll_roundtrip.c b/tests/integration/test_scep_poll_roundtrip.c index fa9822b..a77de5b 100644 --- a/tests/integration/test_scep_poll_roundtrip.c +++ b/tests/integration/test_scep_poll_roundtrip.c @@ -77,6 +77,7 @@ static int post_signed(const char* url, WolfCertKey* dk, REQUIRE(wolfcert_scep_self_signed_rsa((RsaKey*)dk->impl, csr->data, csr->len, &signer, &signer_len, + INVALID_DEVID, NULL) == WOLFCERT_OK); key_len = wc_RsaKeyToDer((RsaKey*)dk->impl, key_der, sizeof(key_der)); REQUIRE(key_len > 0); @@ -91,7 +92,7 @@ static int post_signed(const char* url, WolfCertKey* dk, REQUIRE(wolfcert_scep_build_pki_message(content, content_len, signer, signer_len, key_der, (size_t)key_len, 0, - &attrs, &pki, NULL) == WOLFCERT_OK); + &attrs, &pki, INVALID_DEVID, NULL) == WOLFCERT_OK); snprintf(pki_url, sizeof(pki_url), "%s?operation=PKIOperation", url); WolfCertHttpRequest req = { .method = "POST", .url = pki_url, @@ -101,7 +102,7 @@ static int post_signed(const char* url, WolfCertKey* dk, REQUIRE(resp.status_code == 200); REQUIRE(wolfcert_scep_parse_pki_message(resp.body, resp.body_len, &env, NULL, NULL, NULL, NULL, NULL, NULL, NULL, out_status, - NULL, NULL, out_fail_info, NULL) == WOLFCERT_OK); + NULL, NULL, out_fail_info, INVALID_DEVID, NULL) == WOLFCERT_OK); wolfcert_buffer_free(&env); wolfcert_http_response_free(&resp); @@ -124,6 +125,7 @@ static int poll_ias_refused(const char* url, WolfCertKey* dk, int refused = 0; if (wolfcert_scep_envelop(ca_der, ca_len, ias, ias_len, AES128CBCb, &env, + INVALID_DEVID, NULL) == WOLFCERT_OK && post_signed(url, dk, csr, "20", tid, tid_len, env.data, env.len, &status, &fail_info) == 0) { @@ -251,6 +253,7 @@ static int poll_path(WolfCertServer* s) junk_ias, sizeof(junk_ias)) == 0); REQUIRE(wolfcert_scep_self_signed_rsa((RsaKey*)dk->impl, csr.data, csr.len, &self, &self_len, + INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(wolfcert_scep_issuer_and_subject(self, self_len, csr.data, csr.len, &ias, NULL) @@ -276,7 +279,7 @@ static int poll_path(WolfCertServer* s) char* tk_fail_info = NULL; REQUIRE(wolfcert_scep_envelop(ca_der->buffer, ca_der->length, other_csr.data, other_csr.len, AES128CBCb, - &other_env, NULL) == WOLFCERT_OK); + &other_env, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(post_signed(url, other, &other_csr, "19", r1.transaction_id, r1.transaction_id_len, other_env.data, other_env.len, &tk_status, &tk_fail_info) == 0); diff --git a/tests/integration/test_scep_roundtrip.c b/tests/integration/test_scep_roundtrip.c index 1f9a5fd..c0817a7 100644 --- a/tests/integration/test_scep_roundtrip.c +++ b/tests/integration/test_scep_roundtrip.c @@ -29,6 +29,9 @@ #include #include /* SHA256h */ #include +#ifdef WOLF_CRYPTO_CB +#include +#endif #include #include #include @@ -369,6 +372,80 @@ static int check_rsa4096(const WolfCertServerCfg* cli, return rc; } +#ifdef WOLF_CRYPTO_CB +#define ACCEL_DEVID 0x6163 + +static int accel_priv; +static int accel_pub; + +/* Counts RSA operations and leaves them to software. */ +static int accel_cb(int devId, wc_CryptoInfo* info, void* ctx) +{ + (void)devId; + (void)ctx; + + if (info->algo_type == WC_ALGO_TYPE_PK && info->pk.type == WC_PK_TYPE_RSA) { + if (info->pk.rsa.type == RSA_PRIVATE_ENCRYPT || + info->pk.rsa.type == RSA_PRIVATE_DECRYPT) + accel_priv++; + else + accel_pub++; + } + return CRYPTOCB_UNAVAILABLE; +} + +/* A PKCSReq with a default devId signs, decrypts, encrypts and verifies on + * it, while the built-in server stays in software. */ +static int check_default_dev_id(const WolfCertServerCfg* cli, + const WolfCertScepCaps* caps, + const uint8_t* ca_der_buf, size_t ca_der_len) +{ + WolfCertKeyCfg kcfg = { .type = WOLFCERT_KEY_RSA, .param = 2048, + .dev_id = INVALID_DEVID }; + WolfCertCertMeta meta = { .subject_dn = "CN=device-scep-accel" }; + WolfCertKey* key = NULL; + WolfCertKey* imported = NULL; + WolfCertBuffer pem = { 0 }; + WolfCertBuffer csr = { 0 }; + WolfCertScepResult issued = { 0 }; + +#ifndef WOLF_CRYPTO_CB_FIND + REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID + 1) == + WOLFCERT_ERR_BAD_ARG); +#endif + REQUIRE(wc_CryptoCb_RegisterDevice(ACCEL_DEVID, accel_cb, NULL) == 0); + REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); + + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(key) == ACCEL_DEVID); + REQUIRE(wolfcert_key_to_pem(key, &pem) == WOLFCERT_OK); + REQUIRE(wolfcert_key_from_pem(pem.data, pem.len, NULL, &imported) == + WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(imported) == ACCEL_DEVID); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + + accel_priv = 0; + accel_pub = 0; + REQUIRE(wolfcert_scep_pkcs_req(cli, caps, ca_der_buf, ca_der_len, + ca_der_buf, ca_der_len, + key, csr.data, csr.len, &issued) == + WOLFCERT_OK); + REQUIRE(issued.status == WOLFCERT_SCEP_STATUS_SUCCESS); + /* Self-signed signer, pkiMessage signature and CertRep decryption. */ + REQUIRE(accel_priv >= 3); + REQUIRE(accel_pub >= 2); + + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); + wc_CryptoCb_UnRegisterDevice(ACCEL_DEVID); + wolfcert_scep_result_free(&issued); + wolfcert_buffer_free(&csr); + wolfcert_buffer_free(&pem); + wolfcert_key_free(imported); + wolfcert_key_free(key); + return WOLFCERT_OK; +} +#endif /* WOLF_CRYPTO_CB */ + /* Two PKCSReqs of one key under txid_mode PUBKEY_HASH carry the same * transactionID, the upper-case hex SHA-256 of the CSR's SPKI. */ static int check_pubkey_txid(const WolfCertServerCfg* cli, @@ -489,7 +566,7 @@ static int check_renewal_foreign_signer(const WolfCertServerCfg* cli, int rc; rc = wolfcert_scep_self_signed_rsa((RsaKey*)key->impl, csr, csr_len, - &signer, &signer_len, NULL); + &signer, &signer_len, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) { rc = wolfcert_scep_renewal_req(cli, caps, ca_der_buf, ca_der_len, ca_der_buf, ca_der_len, @@ -874,7 +951,7 @@ static void msgtype_send_cert_rep(const struct msgtype_ctx* mc, int cs, WolfCertBuffer rep = { 0 }; if (wolfcert_scep_build_pki_message(NULL, 0, mc->rep_cert, mc->rep_cert_len, mc->rep_key, mc->rep_key_len, SHA256h, - &attrs, &rep, NULL) != WOLFCERT_OK) + &attrs, &rep, INVALID_DEVID, NULL) != WOLFCERT_OK) return; char hdr[160]; @@ -952,7 +1029,7 @@ static void* msgtype_srv_thread(void* arg) &mt, /* messageType */ NULL, /* pkiStatus */ NULL, NULL, /* signer cert */ - NULL, /* failInfo */ + NULL, INVALID_DEVID, /* failInfo */ NULL) == WOLFCERT_OK) { if (mt != NULL) snprintf(mc->seen, sizeof(mc->seen), "%s", mt); @@ -1250,10 +1327,10 @@ static int check_required_attrs(WolfCertServer* s, const WolfCertKeyCfg* kcfg, rc = wolfcert_key_to_der(key, &kder); if (rc == WOLFCERT_OK) rc = wolfcert_scep_self_signed_rsa((RsaKey*)key->impl, csr.data, - csr.len, &signer, &signer_len, NULL); + csr.len, &signer, &signer_len, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) rc = wolfcert_scep_envelop(ca_der_buf, ca_der_len, csr.data, csr.len, - AES128CBCb, &env, NULL); + AES128CBCb, &env, INVALID_DEVID, NULL); memset(tid, 'A', sizeof(tid)); memset(snonce, 0x22, sizeof(snonce)); @@ -1308,7 +1385,7 @@ static int check_required_attrs(WolfCertServer* s, const WolfCertKeyCfg* kcfg, rc = wolfcert_scep_build_pki_message(env.data, env.len, signer, signer_len, kder.data, kder.len, - SHA256h, &a, &msg, NULL); + SHA256h, &a, &msg, INVALID_DEVID, NULL); if (rc != WOLFCERT_OK) break; @@ -1326,7 +1403,7 @@ static int check_required_attrs(WolfCertServer* s, const WolfCertKeyCfg* kcfg, ok = (st == 200 && rsp != NULL && wolfcert_scep_parse_pki_message(rsp, rsp_len, &renv, &r_tid, &r_tidl, &r_sn, &r_snl, &r_rn, &r_rnl, - &r_mt, &r_st, &r_sc, &r_scl, &r_fi, NULL) == WOLFCERT_OK); + &r_mt, &r_st, &r_sc, &r_scl, &r_fi, INVALID_DEVID, NULL) == WOLFCERT_OK); ok = ok && r_tid != NULL && r_tidl == sizeof(tid) && memcmp(r_tid, tid, sizeof(tid)) == 0 && @@ -1359,7 +1436,7 @@ static int check_required_attrs(WolfCertServer* s, const WolfCertKeyCfg* kcfg, rc = wolfcert_scep_build_pki_message(env.data, env.len, signer, signer_len, kder.data, kder.len, - SHA256h, &a, &msg, NULL); + SHA256h, &a, &msg, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) { if (raw_http_req(wolfcert_server_port(s), "POST", "/scep?operation=PKIOperation", @@ -1611,7 +1688,7 @@ static int check_unprintable_tid(uint16_t port, const WolfCertKeyCfg* kcfg) rc = wolfcert_key_to_der(key, &kder); if (rc == WOLFCERT_OK) rc = wolfcert_scep_self_signed_rsa((RsaKey*)key->impl, csr.data, - csr.len, &signer, &signer_len, NULL); + csr.len, &signer, &signer_len, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) { st = post_raw_tid(port, signer, signer_len, &kder, "tid@1", 0); @@ -1687,10 +1764,10 @@ static int check_malformed_dispatch(uint16_t port, const WolfCertKeyCfg* kcfg, rc = wolfcert_key_to_der(key, &kder); if (rc == WOLFCERT_OK) rc = wolfcert_scep_self_signed_rsa((RsaKey*)key->impl, csr.data, - csr.len, &signer, &signer_len, NULL); + csr.len, &signer, &signer_len, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) rc = wolfcert_scep_envelop(ca_der_buf, ca_der_len, csr.data, csr.len, - AES128CBCb, &env, NULL); + AES128CBCb, &env, INVALID_DEVID, NULL); /* The last round needs a cipher the CA cannot run: copy the envelope and * point its algorithm at an unassigned OID under the same arc. */ @@ -1733,7 +1810,7 @@ static int check_malformed_dispatch(uint16_t port, const WolfCertKeyCfg* kcfg, rc = wolfcert_scep_build_pki_message(content, content_len, signer, signer_len, kder.data, kder.len, - SHA256h, &a, &msg, NULL); + SHA256h, &a, &msg, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) { WolfCertHttpRequest req = { .method = "POST", @@ -1748,7 +1825,7 @@ static int check_malformed_dispatch(uint16_t port, const WolfCertKeyCfg* kcfg, ok = ok && wolfcert_scep_parse_pki_message(resp.body, resp.body_len, &renv, &r_tid, &r_tidl, &r_sn, &r_snl, &r_rn, &r_rnl, &r_mt, &r_st, &r_sc, - &r_scl, &r_fi, NULL) == WOLFCERT_OK; + &r_scl, &r_fi, INVALID_DEVID, NULL) == WOLFCERT_OK; ok = ok && r_mt != NULL && strcmp(r_mt, "3") == 0 && r_st != NULL && strcmp(r_st, "2") == 0 && @@ -1792,7 +1869,7 @@ static int check_malformed_dispatch(uint16_t port, const WolfCertKeyCfg* kcfg, WolfCertBuffer msg = { 0 }; rc = wolfcert_scep_build_pki_message(env.data, env.len, signer, - signer_len, kder.data, kder.len, SHA256h, &a, &msg, NULL); + signer_len, kder.data, kder.len, SHA256h, &a, &msg, INVALID_DEVID, NULL); if (rc == WOLFCERT_OK) { if (raw_http_req(port, "POST", "/scep?operation=PKIOperation", "application/x-pki-message", @@ -2054,6 +2131,10 @@ int main(void) if (rc != WOLFCERT_OK) fprintf(stderr, "SCEP rsa:4096 rc=%d (%s)\n", rc, wolfcert_strerror(rc)); REQUIRE(rc == WOLFCERT_OK); +#ifdef WOLF_CRYPTO_CB + REQUIRE(check_default_dev_id(&cli, &caps, ca_der->buffer, ca_der->length) + == WOLFCERT_OK); +#endif /* A CA advertising SHA-512 or SHA-384 still enrolls within the digests * wolfSSL was built with, and so does a forced SHA-256. */ @@ -2366,7 +2447,7 @@ int main(void) WolfCertBuffer wmsg = { 0 }; REQUIRE(wolfcert_scep_build_pki_message(content, sizeof(content), signer_cert, (size_t)cl, signer_key, (size_t)kl, - SHA256h, &wattrs, &wmsg, NULL) == WOLFCERT_OK); + SHA256h, &wattrs, &wmsg, INVALID_DEVID, NULL) == WOLFCERT_OK); WolfCertBuffer wenv = { 0 }; uint8_t *w_tid = NULL, *w_sn = NULL, *w_rn = NULL, *w_sc = NULL; @@ -2374,7 +2455,7 @@ int main(void) char *w_mt = NULL, *w_st = NULL; REQUIRE(wolfcert_scep_parse_pki_message(wmsg.data, wmsg.len, &wenv, &w_tid, &w_tidl, &w_sn, &w_snl, &w_rn, &w_rnl, - &w_mt, &w_st, &w_sc, &w_scl, NULL, NULL) == WOLFCERT_OK); + &w_mt, &w_st, &w_sc, &w_scl, NULL, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(w_rn != NULL); /* present */ REQUIRE(w_rnl == sizeof(rnonce)); REQUIRE(memcmp(w_rn, rnonce, sizeof(rnonce)) == 0); /* unchanged */ diff --git a/tests/unit/test_http.c b/tests/unit/test_http.c index 4b47697..d420e49 100644 --- a/tests/unit/test_http.c +++ b/tests/unit/test_http.c @@ -1277,6 +1277,8 @@ int main(void) alarm(25); REQUIRE(wolfcert_init(NULL) == WOLFCERT_OK); + /* A WC_USE_DEVID build starts on a device; these checks expect none. */ + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); if (test_url_parser()) return 1; #ifdef WOLFCERT_HAVE_SERVER diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index 896d0c7..6de3cee 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -394,6 +394,8 @@ int main(void) { REQUIRE(test_static_mem_init() == 0); REQUIRE(wolfcert_init(test_heap_hint()) == WOLFCERT_OK); + /* A WC_USE_DEVID build starts on a device; these checks expect none. */ + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); #ifdef WOLFCERT_HAVE_ECC if (roundtrip(WOLFCERT_KEY_ECC, 256)) return 1; @@ -445,6 +447,13 @@ int main(void) WolfCertKey* k = NULL; REQUIRE(wolfcert_key_generate(&bad, &k) != WOLFCERT_OK); REQUIRE(wolfcert_key_dev_id(NULL) == INVALID_DEVID); + k = (WolfCertKey*)&bad; + REQUIRE(wolfcert_key_generate(NULL, &k) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(k == NULL); +#ifndef WOLF_CRYPTO_CB + REQUIRE(wolfcert_set_default_dev_id(7) == WOLFCERT_ERR_UNSUPPORTED); +#endif + REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); wolfcert_cleanup(); printf("OK\n"); diff --git a/tests/unit/test_parse_negative.c b/tests/unit/test_parse_negative.c index e4c4352..be80bfc 100644 --- a/tests/unit/test_parse_negative.c +++ b/tests/unit/test_parse_negative.c @@ -163,10 +163,10 @@ static int test_scep_envelop_alg(void) REQUIRE(csr_len > 0); REQUIRE(wolfcert_scep_self_signed_rsa(&key, csr_der, (size_t)csr_len, - &ra_der, &ra_len, NULL) == WOLFCERT_OK); + &ra_der, &ra_len, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(wolfcert_scep_envelop(ra_der, ra_len, payload, sizeof(payload), - AES128CBCb, &env, NULL) == WOLFCERT_OK); + AES128CBCb, &env, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(oid_present(env.data, env.len, OID_AES128_CBC, sizeof(OID_AES128_CBC))); @@ -177,7 +177,7 @@ static int test_scep_envelop_alg(void) #ifndef NO_DES3 REQUIRE(wolfcert_scep_envelop(ra_der, ra_len, payload, sizeof(payload), - DES3b, &env, NULL) == WOLFCERT_OK); + DES3b, &env, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(oid_present(env.data, env.len, OID_DES3_CBC, sizeof(OID_DES3_CBC))); diff --git a/tests/unit/test_scep_msg.c b/tests/unit/test_scep_msg.c index 28f6510..51c33b3 100644 --- a/tests/unit/test_scep_msg.c +++ b/tests/unit/test_scep_msg.c @@ -351,12 +351,14 @@ static int test_envelop_rejects_ecc_ra(void) if (made_ecc == 0) { ecc_rc = wolfcert_scep_envelop(ecc_ca, ecc_ca_len, payload, sizeof(payload), AES128CBCb, &ecc_env, + INVALID_DEVID, NULL); ecc_env_empty = (ecc_env.data == NULL); } if (made_rsa == 0) { rsa_rc = wolfcert_scep_envelop(rsa_ca, rsa_ca_len, payload, sizeof(payload), AES128CBCb, &rsa_env, + INVALID_DEVID, NULL); rsa_env_ok = (rsa_env.data != NULL && rsa_env.len > 0); } @@ -422,14 +424,14 @@ static int check_no_envelope(const uint8_t* ca_der, size_t ca_len, REQUIRE(wolfcert_scep_build_pki_message(NULL, 0, ca_der, ca_len, key_der, key_len, hash_oid, - &attrs, &pki, NULL) == WOLFCERT_OK); + &attrs, &pki, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(memmem(pki.data, pki.len, ENVELOPED_OID, sizeof(ENVELOPED_OID)) == NULL); prc = wolfcert_scep_parse_pki_message(pki.data, pki.len, &env, &rx_tid, &rx_tid_len, &rx_sn, &rx_sn_len, &rx_rn, &rx_rn_len, - &mt, &status, NULL, NULL, &rx_fi, NULL); + &mt, &status, NULL, NULL, &rx_fi, INVALID_DEVID, NULL); /* Free the parsed outputs before the REQUIREs so a failure cannot leak. */ env_ok = (env.len == 0 && env.data == NULL); status_ok = (status != NULL && strcmp(status, "2") == 0); @@ -512,11 +514,11 @@ static int test_long_transaction_id(void) brc = wolfcert_scep_build_pki_message(NULL, 0, ca_der, ca_len, key_der, key_len, SHA256h, - &attrs, &pki, NULL); + &attrs, &pki, INVALID_DEVID, NULL); if (brc == WOLFCERT_OK) prc = wolfcert_scep_parse_pki_message(pki.data, pki.len, &env, &rx_tid, &rx_tid_len, &rx_sn, &rx_sn_len, NULL, NULL, - &mt, &status, NULL, NULL, NULL, NULL); + &mt, &status, NULL, NULL, NULL, INVALID_DEVID, NULL); else prc = brc; @@ -608,7 +610,7 @@ static int test_signer_subject_matches_csr(void) &csr_der, &csr_len) == 0); REQUIRE(wolfcert_scep_self_signed_rsa(&key, csr_der, csr_len, - &signer_der, &signer_len, NULL) + &signer_der, &signer_len, INVALID_DEVID, NULL) == WOLFCERT_OK); wc_InitDecodedCert(&csr_dc, csr_der, (word32)csr_len, NULL); @@ -656,7 +658,7 @@ static int test_signer_key_usage(void) &csr_der, &csr_len) == 0); REQUIRE(wolfcert_scep_self_signed_rsa(&key, csr_der, csr_len, - &signer_der, &signer_len, NULL) + &signer_der, &signer_len, INVALID_DEVID, NULL) == WOLFCERT_OK); wc_InitDecodedCert(&dc, signer_der, (word32)signer_len, NULL); @@ -1520,7 +1522,7 @@ static int test_next_ca_response_is_signed(void) /* OK proves a signature; the parser refuses degenerate SignedData. */ rc = wolfcert_scep_parse_pki_message(resp.data, resp.len, &content, - NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL); + NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, INVALID_DEVID, NULL); REQUIRE(rc == WOLFCERT_OK); REQUIRE(content.data != NULL && content.len > 0); @@ -1692,7 +1694,7 @@ static int test_signer_is_verified_cert(void) REQUIRE(wolfcert_scep_parse_pki_message(msg, msg_len, &env, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, - &signer, &signer_len, NULL, NULL) == WOLFCERT_OK); + &signer, &signer_len, NULL, INVALID_DEVID, NULL) == WOLFCERT_OK); /* The parser reports the cert that signed. */ REQUIRE(signer != NULL); @@ -1786,7 +1788,7 @@ static int test_signer_subject_fallback(void) REQUIRE(make_csr(&key, &rng, "", "", &csr, &csr_len) == 0); REQUIRE(wolfcert_scep_self_signed_rsa(&key, csr, csr_len, - &signer, &signer_len, NULL) + &signer, &signer_len, INVALID_DEVID, NULL) == WOLFCERT_OK); wc_InitDecodedCert(&dc, signer, (word32)signer_len, NULL); @@ -2124,7 +2126,7 @@ static int test_envelop_cipher_oid(void) #if defined(WOLFSSL_AES_256) WolfCertBuffer env256 = { 0 }; REQUIRE(wolfcert_scep_envelop(ca_der, ca_len, payload, sizeof(payload), - AES256CBCb, &env256, NULL) == WOLFCERT_OK); + AES256CBCb, &env256, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(memmem(env256.data, env256.len, OID_AES256, sizeof(OID_AES256)) != NULL); REQUIRE(memmem(env256.data, env256.len, OID_AES128, sizeof(OID_AES128)) == NULL); wolfcert_buffer_free(&env256); @@ -2132,7 +2134,7 @@ static int test_envelop_cipher_oid(void) WolfCertBuffer env128 = { 0 }; REQUIRE(wolfcert_scep_envelop(ca_der, ca_len, payload, sizeof(payload), - AES128CBCb, &env128, NULL) == WOLFCERT_OK); + AES128CBCb, &env128, INVALID_DEVID, NULL) == WOLFCERT_OK); REQUIRE(memmem(env128.data, env128.len, OID_AES128, sizeof(OID_AES128)) != NULL); wolfcert_buffer_free(&env128); @@ -2300,7 +2302,7 @@ static int test_duplicate_signed_attrib(void) /* Every output is requested so each can be checked after the reject. */ rc = wolfcert_scep_parse_pki_message(msg, msg_len, &env, &tid, &tid_len, &snonce, &snonce_len, &rnonce, &rnonce_len, - &mt, &ps, &signer, &signer_len, &fi, NULL); + &mt, &ps, &signer, &signer_len, &fi, INVALID_DEVID, NULL); if (rc != WOLFCERT_ERR_PROTOCOL) { fprintf(stderr, "duplicate transactionID accepted: rc=%d tid=%.*s\n", rc, (int)tid_len, tid == NULL ? "" : (const char*)tid); @@ -2366,7 +2368,7 @@ static int test_multi_value_signed_attrib(void) rc = wolfcert_scep_parse_pki_message(msg, msg_len, &env, &tid, &tid_len, &snonce, &snonce_len, &rnonce, &rnonce_len, - &mt, &ps, &signer, &signer_len, &fi, NULL); + &mt, &ps, &signer, &signer_len, &fi, INVALID_DEVID, NULL); if (rc != WOLFCERT_ERR_PROTOCOL) { fprintf(stderr, "multi-valued transactionID accepted: rc=%d tid=%.*s\n", rc, (int)tid_len, tid == NULL ? "" : (const char*)tid); @@ -2430,7 +2432,7 @@ static int check_text_attrib(const uint8_t* ca_der, size_t ca_len, wolfcert_clear_error(); rc = wolfcert_scep_parse_pki_message(msg, msg_len, &env, NULL, NULL, NULL, NULL, NULL, NULL, - &mt, &ps, NULL, NULL, &fi, NULL); + &mt, &ps, NULL, NULL, &fi, INVALID_DEVID, NULL); got = mt != NULL ? mt : (ps != NULL ? ps : fi); if (expect_rc == WOLFCERT_OK) @@ -2885,7 +2887,7 @@ static int test_parse_reports_oom(void) REQUIRE(oom_arm(fails) == 0); rc = wolfcert_scep_parse_pki_message(msg, msg_len, &env, &t, &t_len, NULL, NULL, NULL, NULL, &mt, NULL, &signer, &signer_len, - NULL, NULL); + NULL, INVALID_DEVID, NULL); REQUIRE((failed = oom_disarm()) >= 0); /* wolfSSL's PKCS#7 verify can report a failed allocation as a parse * error, so only wolfCert's own allocations must give ERR_MEMORY. */ diff --git a/wolfcert/keygen.h b/wolfcert/keygen.h index 6caa802..afc261d 100644 --- a/wolfcert/keygen.h +++ b/wolfcert/keygen.h @@ -28,13 +28,13 @@ extern "C" { typedef struct WolfCertKey WolfCertKey; -/* Generate a key per cfg. cfg->dev_id != INVALID_DEVID routes its operations - * through that CryptoCb device; with cfg->key_id the key also stays in the - * device and the handle only references it, under the id wolfcert_key_id - * returns, which the device may have changed. Allocated from cfg->heap or the - * default. *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when - * the device left an unusable id: *out_key then holds the key under the - * requested id so the caller can delete it there. */ +/* Generate a key per cfg on CryptoCb device cfg->dev_id, or for INVALID_DEVID + * on the default devId. With cfg->key_id the key also stays in the device and + * the handle only references it, under the id wolfcert_key_id returns, which + * the device may have changed. Allocated from cfg->heap or the default. + * *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when the device + * left an unusable id: *out_key then holds the key under the requested id so + * the caller can delete it there. */ WOLFCERT_API int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key); /* Reference a key a CryptoCb device holds under cfg->key_id, its public half @@ -45,7 +45,8 @@ WOLFCERT_API int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, const uint8_t* cert, size_t cert_len, WolfCertKey** out_key); -/* Load a software key from PEM or DER; the encoding is auto-detected. */ +/* Load a key from PEM or DER, auto-detected, into host memory; its operations + * run on the devId that is the default at the time of the call. */ WOLFCERT_API int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, void* heap, WolfCertKey** out_key); diff --git a/wolfcert/types.h b/wolfcert/types.h index cba2c92..01afb8d 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -92,14 +92,19 @@ typedef enum { typedef struct { WolfCertKeyType type; int param; /* RSA 2048/3072/4096 or ECC 256/384/521 bits */ - int dev_id; /* CryptoCb devId, or INVALID_DEVID */ + int dev_id; /* devId; INVALID_DEVID = the default */ void* heap; /* optional heap hint; NULL = default */ - /* Backend key id, opaque to wolfCert; needs dev_id. Up to + /* Backend key id, opaque to wolfCert; needs a devId. Up to * WOLFCERT_KEY_ID_MAX_LEN bytes. */ const uint8_t* key_id; size_t key_id_len; } WolfCertKeyCfg; +/* Registered devId for client crypto and keys made later with INVALID_DEVID; + * starts as WC_USE_DEVID if defined. Set it before threads use wolfCert. */ +WOLFCERT_API int wolfcert_set_default_dev_id(int dev_id); +WOLFCERT_API int wolfcert_default_dev_id(void); + /* Called by wolfcert_csr_build() once the standard fields are set, with the * wolfSSL Cert* to add what wolfCert does not expose; any error aborts. * A renewal then overwrites Cert's subject and altNames from current_cert. */ @@ -245,8 +250,8 @@ typedef struct { WolfCertTransport transport; - /* What client_key holds, and the CryptoCb device holding an _ID key, - * which needs client_cert, client_key and an https:// URL. */ + /* What client_key holds, and the device holding an _ID key (INVALID_DEVID = + * default). _ID needs client_cert, client_key and an https:// URL. */ WolfCertClientKeySrc client_key_src; int client_key_dev_id; } WolfCertServerCfg; From 4171437fb1c56d1c1e686287e6e32a4b38e5ba06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Frauenschl=C3=A4ger?= Date: Fri, 13 Nov 2026 16:52:34 +0100 Subject: [PATCH 17/17] Use caller devIds as given; take the TLS client key as a handle INVALID_DEVID in WolfCertKeyCfg.dev_id and client_key_dev_id meant "the default devId", the opposite of wolfCrypt, where it means software. It left no way to ask for a software key while a default was set, which is why the test server needed wolfcert_key_generate_on(), and the devId was decided in several places with different rules: keys copied the default when made, connections and PKCS#7 read it on every call, EST reenroll ran the whole TLS context on a software key's own devId, and the SCEP client signed on its key's. Caller devIds are now used as given. dev_id = INVALID_DEVID is software, and a caller who wants the default device writes dev_id = wolfcert_default_dev_id(). wolfcert_key_generate() and wolfcert_key_from_id() refuse a devId no device is registered under, unless wolfSSL has WOLF_CRYPTO_CB_FIND, with WOLFCERT_ERR_BAD_ARG (WOLFCERT_ERR_UNSUPPORTED without WOLF_CRYPTO_CB), so a zero-initialized cfg, which names device 0, fails visibly; a key_id without a devId is refused as before. wolfcert_key_from_pem() loads a software key, and wolfcert_key_to_pem() and _to_der() refuse a key whose device keeps the private half with WOLFCERT_ERR_UNSUPPORTED, instead of failing inside the wolfCrypt export. The default devId now covers only what wolfCert creates itself and has no caller field for: the TLS context and SCEP's PKCS#7 objects and RNGs. Its start value is WOLFCERT_DEFAULT_DEVID, WC_USE_DEVID with WOLF_CRYPTO_CB and INVALID_DEVID otherwise, which user_settings.h may override; any other value without WOLF_CRYPTO_CB is an #error. EST reenroll and the SCEP client use the default too, so tls_dev_id, the _dev session opens, in_signer_dev_id, wolfcert_devid_or_default() and wolfcert_key_generate_on() are gone. The TLS client key can be given as a key handle instead of bytes: client_key_obj in WolfCertServerCfg and both HTTP structs, set instead of client_key and borrowed while the connection opens. A key with a key_id goes to wolfSSL_CTX_use_PrivateKey_Id() on its own devId, any other key is loaded as DER. That replaces client_key_src and client_key_dev_id. wolfSSL signs with a key loaded from a buffer on the context's devId, the default, and uses privateKeyDevId only for a key given by id, so a key held in one device still signs there while another accelerates the connection. client_key_obj next to client_key, without client_cert or on an http:// URL is WOLFCERT_ERR_BAD_ARG. A key of a type wolfcert_key_from_id() does not accept, such as a P-224 key in a TPM, can no longer be the TLS client key by id. EST /simplereenroll passes the key being renewed as the handle. Every field and function removed here is new on this branch, so nothing that shipped changes. test_est_devid_roundtrip covers a software key handle as the mTLS identity, with no device signature, and refused next to client_key; a software key that stays off the default device until its cfg names wolfcert_default_dev_id(); a key_id without a devId and an unregistered devId refused; a dev_id key without a key_id signing its renewal CSR on its device and the handshake on the default; and a software key handle signing its handshake on the default device. test_http checks the client_key_obj argument rules, test_keygen registers its device in the build without key ids so the key-id check is the one that fails, and the SCEP default-devId check expects a software key while its PKCS#7 work runs on the default. --- AGENTS.md | 7 +- docs/ARCHITECTURE.md | 121 ++++++++----------- src/est/est_client.c | 66 +++------- src/http.c | 98 ++++++++------- src/internal.c | 56 ++++----- src/internal.h | 24 +--- src/keygen.c | 37 +++--- src/scep/scep_client.c | 11 +- src/scep/scep_server.c | 6 +- tests/integration/test_est_devid_roundtrip.c | 115 +++++++++++------- tests/integration/test_scep_roundtrip.c | 13 +- tests/unit/test_http.c | 63 +++------- tests/unit/test_keygen.c | 11 +- wolfcert/http.h | 6 +- wolfcert/keygen.h | 21 ++-- wolfcert/types.h | 35 ++++-- 16 files changed, 324 insertions(+), 366 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index b6f22e7..8645388 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -206,9 +206,9 @@ contract, alone or in a group comment. | Static memory / custom heap | `wolfcert_init(heap)` sets the default heap hint; per-call `heap` fields override it, and the hint reaches every wolfSSL call | `wolfcert/memory.h`, README "Integrating with a wolfSSL static-memory pool" | | Network stack without BSD sockets (lwIP, NetX, FreeRTOS+TCP, wolfIP) | Fill `WolfCertServerCfg.transport` (`WolfCertTransport`); TLS records go through it too | `wolfcert/types.h`, `docs/EMBEDDED.md` section 7 | | Persistence in flash / NVM | Store the buffers from `wolfcert_key_to_pem` / `_to_der` and the enroll result; wolfCert does no storage | `wolfcert/keygen.h` | -| Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id`, and the key's backend id as `key_id`; `WolfCertServerCfg.client_key_src` selects such a key for mTLS | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | +| Keys in a TPM, HSM, PKCS#11 token or secure element | Register a backend with `wc_CryptoCb_RegisterDevice`, pass its id as `WolfCertKeyCfg.dev_id`, and the key's backend id as `key_id`; a key handle in `WolfCertServerCfg.client_key_obj` uses such a key for mTLS | `docs/ARCHITECTURE.md` section 4.2, `examples/enroll_cryptocb.c` | | Event loop / no blocking | `wolfcert_est_session_open` / `wolfcert_scep_session_open`, then the `_nb` calls until they stop returning `WOLFCERT_ERR_WANT_READ` / `_WANT_WRITE`; `*_session_fd` gives the descriptor to poll | `wolfcert/est.h`, `wolfcert/scep.h` | -| Crypto accelerator for TLS, PKCS#7 and software keys | `wolfcert_set_default_dev_id`; defaults to wolfSSL's `WC_USE_DEVID` when set | `wolfcert/types.h`, `docs/ARCHITECTURE.md` section 4.2 | +| Crypto accelerator for TLS and PKCS#7 | `wolfcert_set_default_dev_id`, starting at `WOLFCERT_DEFAULT_DEVID` (wolfSSL's `WC_USE_DEVID` when set); a key uses it with `dev_id = wolfcert_default_dev_id()` | `wolfcert/types.h`, `docs/ARCHITECTURE.md` section 4.2 | | Logging | `wolfcert_set_log_cb` (e.g. to a UART) | `wolfcert/log.h` | | RAM budget | `max_response_bytes`, HTTP stack buffers, wolfSSL `Cert` / `CertName` sizing | `docs/EMBEDDED.md` | @@ -239,6 +239,9 @@ contract, alone or in a group comment. which every EST call and SCEP over `https://` refuse with `WOLFCERT_ERR_TLS`. Plain-HTTP SCEP ignores it and relies on the CA fingerprint check instead. +- **Set `dev_id` on every `WolfCertKeyCfg`.** `INVALID_DEVID` is software; + a zero-initialized config names CryptoCb device 0, which keygen refuses + with `WOLFCERT_ERR_BAD_ARG` unless such a device is registered. - **The `wolfcert_client_*` calls are EST-only except `get_ca`.** For SCEP they return `WOLFCERT_ERR_UNSUPPORTED`; use `wolfcert_scep_*`. - **SCEP rejects non-RSA keys** with `WOLFCERT_ERR_UNSUPPORTED`, and an ECC diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 8e7e67c..cb09a36 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -342,82 +342,63 @@ WolfCertKey* key; wolfcert_key_generate(&cfg, &key); ``` +`dev_id` and `key_id` answer different questions. `dev_id` picks the +registered CryptoCb device that runs an operation; `key_id` names one key +inside that device. Together they decide where each operation runs: + +| | `INVALID_DEVID` | `dev_id` only | `dev_id` + `key_id` | +|---|---|---|---| +| Key generation | software | device | device; the key stays there | +| CSR signature | software | key's device | key's device | +| TLS client-auth signature (`client_key_obj`) | default devId | default devId (loaded as DER) | key's device | +| Export, SCEP signing | yes | only if the private half is in host memory | `WOLFCERT_ERR_UNSUPPORTED` | +| Reload in a later run | from PEM or DER | from PEM or DER | `wolfcert_key_from_id` | +| TLS connection, SCEP PKCS#7 and RNGs | default devId | default devId | default devId | + +The last row is work wolfCert sets up itself, with no caller field to pick +a device, so it runs on `wolfcert_default_dev_id()` whatever key is used. + The `key_id` bytes are opaque to wolfCert. They reach the backend in the -wolfCrypt key's `id` field, the same way wolfPKCS11, wolfHSM and the hardware -ports name their keys, and the backend decides what they mean (a PKCS#11 -`CKA_ID`, a TPM handle, a key-store slot). The backend generates the key there -and returns only its public half. It may also rename the key, as a TPM does -when it picks a transient handle, and `wolfcert_key_id` returns the new id. - -From there, every private-key operation on the key routes through -`my_callback`: CSR signing, and TLS client authentication by id or for EST -`/simplereenroll`. wolfSSL also hands the backend public-key operations on -that id, such as the check of its own RSA signature in TLS, so the backend -must serve those too. - -A `dev_id` without a `key_id` only offloads the computation. The key itself -is an ordinary wolfCrypt key in host memory, and `wolfcert_key_to_pem` exports -it. Only a `key_id` keeps the key in the backend. - -A crypto accelerator gets the rest of the client's work through -`wolfcert_set_default_dev_id`: the TLS connection, SCEP's PKCS#7, and every -key generated or imported with `dev_id = INVALID_DEVID`, which takes the -default as its device. The default is `WC_USE_DEVID` when wolfSSL defines it, -as the NXP EdgeLock port does, else `INVALID_DEVID`; set it to `INVALID_DEVID` -to run all of this in software, except that TLS keeps a devId wolfSSL picks -itself (CAAM, ARIA, MAXQ10xx). The setter returns `WOLFCERT_ERR_BAD_ARG` for a -devId with no registered device, unless wolfSSL has `WOLF_CRYPTO_CB_FIND`, -and `wolfcert_cleanup` restores the start value. A key keeps the device it was -made with, so change the default before generating or importing keys, and -before other threads use wolfCert. A key's own `dev_id` still takes -precedence, so a key held in one device can sign while another accelerates the -connection. The built-in test server always runs in software. - -For TLS client authentication, `WolfCertServerCfg.client_key_src` says what -`client_key` holds and where the handshake signs with it: - -| `client_key_src` | `client_key` holds | Signed | -|---|---|---| -| `WOLFCERT_CLIENT_KEY_BUFFER` (default) | PEM or DER | on the connection's device, the default devId | -| `WOLFCERT_CLIENT_KEY_ID` | the key id | in `client_key_dev_id` | - -EST `/simplereenroll` picks the source from the key being renewed, and runs -the connection of a key without a `key_id` on that key's `dev_id`. - -A key with a `key_id` never leaves the backend: `wolfcert_key_to_pem` and -`wolfcert_key_to_der` fail with `WOLFCERT_ERR_UNSUPPORTED`. Persist the id and -the issued certificate instead. TLS client authentication needs only those -two: the certificate in `client_cert` and the id in `client_key`, with -`client_key_src = WOLFCERT_CLIENT_KEY_ID` and the device in -`client_key_dev_id`. A source other than `_BUFFER` without the certificate -and key returns `WOLFCERT_ERR_BAD_ARG`. Re-enrollment also needs a key -handle, because the CSR carries the public key: -rebuild it with `wolfcert_key_from_id(&cfg, cert, cert_len, &key)`, which takes -the public half from the certificate since a backend need not be able to -return it. - -`wolfcert_client_enroll` and `wolfcert_client_reenroll` hand back a key they -generated under a `key_id` even when they fail, so the caller can delete it -in the backend. - -RSA, ECC and ML-DSA keys take a `key_id`. Ed25519 and Ed448 keys take one -with a wolfSSL newer than 5.9.4, which has `wc_ed25519_init_id` and -`wc_ed448_init_id`. SCEP does not support a `key_id` key: its PKCS#7 -signing and decryption take the private key as DER, so the SCEP calls return -`WOLFCERT_ERR_UNSUPPORTED`. A `key_id` needs wolfSSL built with -`WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`. See `examples/enroll_cryptocb.c` -for the registration pattern. +wolfCrypt key's `id` field, as with wolfPKCS11, wolfHSM and the hardware +ports, and the backend decides what they mean (a PKCS#11 `CKA_ID`, a TPM +handle, a key-store slot). The backend may rename the key, as a TPM does +when it picks a transient handle; `wolfcert_key_id` returns the id in use. +wolfSSL also hands the backend public-key operations on that id, such as +the check of its own RSA signature in TLS, so the backend must serve those +too. + +The default devId starts as `WOLFCERT_DEFAULT_DEVID`: `WC_USE_DEVID` when +wolfSSL defines it, as the NXP EdgeLock port does, else `INVALID_DEVID`. A +build may define it in `user_settings.h`. `wolfcert_set_default_dev_id` +changes it at run time and `wolfcert_cleanup` restores it. With +`INVALID_DEVID`, TLS still keeps a devId wolfSSL picks itself (CAAM, ARIA, +MAXQ10xx). The built-in test server always runs in software. + +For TLS client authentication, give the key as PEM or DER in `client_key`, +or as a handle in `client_key_obj`; only a handle can carry a `key_id`. EST +`/simplereenroll` passes the key being renewed as the handle. + +A key with a `key_id` is never exported, so persist its id and the issued +certificate. `wolfcert_key_from_id` rebuilds the handle from those two, +taking the public half from the certificate, and the handle then serves for +TLS client authentication and re-enrollment. + +RSA, ECC and ML-DSA keys take a `key_id`; Ed25519 and Ed448 need a wolfSSL +newer than 5.9.4 (`wc_ed25519_init_id`, `wc_ed448_init_id`). SCEP does not +take one, because its PKCS#7 code needs the private key as DER. A `key_id` +needs wolfSSL built with `WOLF_CRYPTO_CB` and `WOLF_PRIVATE_KEY_ID`; +`examples/enroll_cryptocb.c` shows the registration. `examples/enroll_tpm.c` enrolls and re-enrolls over EST with an ECC, RSA or ML-DSA key in a TPM. It needs a wolfTPM whose CryptoCb reads a 4-byte `key_id` as a persistent or transient handle. A key generated under a persistent handle is stored there. Under `0x80000000` -(`WOLFTPM2_KEYID_TRANSIENT`) the TPM loads it at a transient handle it picks; -a TPM reset drops that key, and so does `/dev/tpmrm0` when the process exits. -An older wolfTPM generates the key in software, which `wolfcert_key_generate` -refuses. ML-DSA needs a TPM with the v1.85 commands, such as wolfTPM's fwTPM. -For a test CA that renews the certificates it issued, start the EST server -from README.md with `--ca-dir DIR --tls-trust-issued` added. +(`WOLFTPM2_KEYID_TRANSIENT`) the TPM picks a transient handle, and a TPM +reset drops the key, as does `/dev/tpmrm0` when the process exits. An older +wolfTPM generates the key in software, which `wolfcert_key_generate` +refuses. ML-DSA needs a TPM with the v1.85 commands, such as wolfTPM's +fwTPM. For a test CA that renews the certificates it issued, start the EST +server from README.md with `--ca-dir DIR --tls-trust-issued` added. ### 4.3 Keep-alive sessions and non-blocking I/O diff --git a/src/est/est_client.c b/src/est/est_client.c index d1460aa..f00bd6d 100644 --- a/src/est/est_client.c +++ b/src/est/est_client.c @@ -157,8 +157,8 @@ struct WolfCertEstSession { WolfCertEncoding in_enc; }; -static int est_session_open_dev(const WolfCertServerCfg* srv, int tls_dev_id, - WolfCertEstSession** out) +int wolfcert_est_session_open(const WolfCertServerCfg* srv, + WolfCertEstSession** out) { if (srv == NULL || srv->server_url == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; @@ -192,7 +192,8 @@ static int est_session_open_dev(const WolfCertServerCfg* srv, int tls_dev_id, memset(s, 0, sizeof(*s)); s->heap = heap; s->has_client_identity = srv->client_cert != NULL && - srv->client_key != NULL; + (srv->client_key != NULL || + srv->client_key_obj != NULL); s->base_url = wolfcert_strdup(srv->server_url, heap); if (s->base_url == NULL) { wolfcert_est_session_close(s); @@ -222,13 +223,12 @@ static int est_session_open_dev(const WolfCertServerCfg* srv, int tls_dev_id, .client_cert_len = srv->client_cert_len, .client_key = srv->client_key, .client_key_len = srv->client_key_len, - .client_key_src = srv->client_key_src, - .client_key_dev_id = srv->client_key_dev_id, + .client_key_obj = srv->client_key_obj, .allow_post_handshake_auth = srv->proto_opts.est.allow_post_handshake_auth, .transport = srv->transport, .heap = heap, }; - rc = wolfcert_http_session_open_dev(&hcfg, tls_dev_id, &s->http); + rc = wolfcert_http_session_open(&hcfg, &s->http); if (rc != WOLFCERT_OK) { /* Free with wolfcert_est_session_close() to zero s->basic_pass. */ wolfcert_est_session_close(s); @@ -239,12 +239,6 @@ static int est_session_open_dev(const WolfCertServerCfg* srv, int tls_dev_id, return WOLFCERT_OK; } -int wolfcert_est_session_open(const WolfCertServerCfg* srv, - WolfCertEstSession** out) -{ - return est_session_open_dev(srv, wolfcert_default_dev_id(), out); -} - int wolfcert_est_session_fd(const WolfCertEstSession* s) { return s != NULL ? wolfcert_http_session_fd(s->http) : -1; @@ -506,8 +500,7 @@ int wolfcert_est_session_simple_reenroll_nb(WolfCertEstSession* s, WOLFCERT_ENCODING_PEM, &out->cert_pem, out, 1); } -static int est_one_shot(const WolfCertServerCfg* srv, int tls_dev_id, - enum est_session_op op, +static int est_one_shot(const WolfCertServerCfg* srv, enum est_session_op op, const uint8_t* csr_der, size_t csr_der_len, WolfCertEncoding enc, WolfCertBuffer* out, WolfCertEstResult* res) @@ -518,7 +511,7 @@ static int est_one_shot(const WolfCertServerCfg* srv, int tls_dev_id, est_call_clear(NULL, out, res); rc = est_call_check(op, csr_der, csr_der_len, enc, out); if (rc == WOLFCERT_OK) - rc = est_session_open_dev(srv, tls_dev_id, &s); + rc = wolfcert_est_session_open(srv, &s); if (rc == WOLFCERT_OK) { wolfcert_http_session_set_close(s->http); rc = est_session_call(s, op, csr_der, csr_der_len, enc, out, res, 0); @@ -531,14 +524,13 @@ static int est_one_shot(const WolfCertServerCfg* srv, int tls_dev_id, int wolfcert_est_get_cacerts(const WolfCertServerCfg* srv, WolfCertEncoding enc, WolfCertBuffer* out_ca) { - return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_GET_CACERTS, - NULL, 0, enc, out_ca, NULL); + return est_one_shot(srv, EST_OP_GET_CACERTS, NULL, 0, enc, out_ca, NULL); } int wolfcert_est_get_csr_attrs(const WolfCertServerCfg* srv, WolfCertBuffer* out_attrs_der) { - return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_GET_CSRATTRS, + return est_one_shot(srv, EST_OP_GET_CSRATTRS, NULL, 0, WOLFCERT_ENCODING_DER, out_attrs_der, NULL); } @@ -549,7 +541,7 @@ int wolfcert_est_simple_enroll(const WolfCertServerCfg* srv, if (out == NULL) return WOLFCERT_ERR_BAD_ARG; - return est_one_shot(srv, wolfcert_default_dev_id(), EST_OP_SIMPLE_ENROLL, + return est_one_shot(srv, EST_OP_SIMPLE_ENROLL, csr_der, csr_der_len, WOLFCERT_ENCODING_PEM, &out->cert_pem, out); } @@ -561,9 +553,6 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, WolfCertEstResult* out) { WolfCertServerCfg cfg; - WolfCertBuffer key_der = { 0 }; - int tls_dev_id; - int rc = WOLFCERT_OK; if (out == NULL) return WOLFCERT_ERR_BAD_ARG; @@ -574,30 +563,13 @@ int wolfcert_est_simple_reenroll(const WolfCertServerCfg* srv, current_key == NULL) return WOLFCERT_ERR_BAD_ARG; - /* The TLS identity is the cert being renewed. wolfSSL signs with a key - * loaded from DER on the context's devId, so that is the key's device. */ + /* The TLS identity is the cert being renewed. */ cfg = *srv; - tls_dev_id = current_key->dev_id; - cfg.client_cert = current_cert; - cfg.client_cert_len = current_cert_len; - if (current_key->id_len > 0) { - cfg.client_key = current_key->id; - cfg.client_key_len = current_key->id_len; - cfg.client_key_src = WOLFCERT_CLIENT_KEY_ID; - cfg.client_key_dev_id = current_key->dev_id; - tls_dev_id = wolfcert_default_dev_id(); - } - else { - rc = wolfcert_key_to_der(current_key, &key_der); - cfg.client_key = key_der.data; - cfg.client_key_len = key_der.len; - cfg.client_key_src = WOLFCERT_CLIENT_KEY_BUFFER; - } - if (rc == WOLFCERT_OK) - rc = est_one_shot(&cfg, tls_dev_id, EST_OP_SIMPLE_REENROLL, - csr_der, csr_der_len, - WOLFCERT_ENCODING_PEM, &out->cert_pem, out); - - wolfcert_buffer_free_secure(&key_der); - return rc; + cfg.client_cert = current_cert; + cfg.client_cert_len = current_cert_len; + cfg.client_key = NULL; + cfg.client_key_len = 0; + cfg.client_key_obj = current_key; + return est_one_shot(&cfg, EST_OP_SIMPLE_REENROLL, csr_der, csr_der_len, + WOLFCERT_ENCODING_PEM, &out->cert_pem, out); } diff --git a/src/http.c b/src/http.c index 65bc170..ad2d2df 100644 --- a/src/http.c +++ b/src/http.c @@ -926,10 +926,8 @@ typedef struct { size_t client_cert_len; const uint8_t* client_key; size_t client_key_len; - WolfCertClientKeySrc client_key_src; - int client_key_dev_id; + const WolfCertKey* client_key_obj; int allow_post_handshake_auth; - int tls_dev_id; } TlsDials; static int buf_filetype(const uint8_t* buf, size_t len) @@ -938,47 +936,62 @@ static int buf_filetype(const uint8_t* buf, size_t len) : WOLFSSL_FILETYPE_PEM; } -static int check_client_key(WolfCertClientKeySrc src, const uint8_t* cert, - size_t cert_len, const uint8_t* key, - size_t key_len, int dev_id) +static int check_client_key(const uint8_t* cert, size_t cert_len, + const uint8_t* key, const WolfCertKey* key_obj) { - if (src == WOLFCERT_CLIENT_KEY_BUFFER) + if (key_obj == NULL) return WOLFCERT_OK; - if (src != WOLFCERT_CLIENT_KEY_ID) + if (key != NULL) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", - "unknown client_key_src %d", (int)src); - if (cert == NULL || cert_len == 0 || key == NULL || key_len == 0) + "set client_key or client_key_obj, not both"); + if (cert == NULL || cert_len == 0) return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", - "client_key_src %d needs client_cert and " - "client_key", (int)src); - return wolfcert_key_id_check(key, key_len, dev_id, "http"); + "client_key_obj needs client_cert"); + return WOLFCERT_OK; } -/* The source was checked by check_client_key. */ -static int use_client_key(WOLFSSL_CTX* ctx, const TlsDials* d) +/* A key with an id signs in its device; any other key loads as DER. */ +static int use_client_key_obj(WOLFSSL_CTX* ctx, const WolfCertKey* k) { - int rc = WOLFSSL_SUCCESS; + WolfCertBuffer der = { 0 }; + int rc; - if (d->client_key_src == WOLFCERT_CLIENT_KEY_ID) { + if (k->id_len > 0) { #ifdef WOLFCERT_USE_KEY_ID - rc = wolfSSL_CTX_use_PrivateKey_Id(ctx, d->client_key, - (long)d->client_key_len, - d->client_key_dev_id); + rc = wolfSSL_CTX_use_PrivateKey_Id(ctx, k->id, (long)k->id_len, + k->dev_id); #else rc = WOLFSSL_FAILURE; #endif } else { - int type = buf_filetype(d->client_key, d->client_key_len); - - rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, d->client_key, - (long)d->client_key_len, type); + rc = wolfcert_key_to_der(k, &der); + if (rc != WOLFCERT_OK) + return rc; + rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, der.data, (long)der.len, + WOLFSSL_FILETYPE_ASN1); + wolfcert_buffer_free_secure(&der); } if (rc != WOLFSSL_SUCCESS) return WOLFCERT_ERR(WOLFCERT_ERR_TLS, "http", - "client_key_src %d: loading the client key " - "failed (%d)", (int)d->client_key_src, rc); + "loading client_key_obj failed (%d)", rc); + return WOLFCERT_OK; +} + +static int use_client_key(WOLFSSL_CTX* ctx, const TlsDials* d) +{ + int rc; + + if (d->client_key_obj != NULL) + return use_client_key_obj(ctx, d->client_key_obj); + + rc = wolfSSL_CTX_use_PrivateKey_buffer(ctx, d->client_key, + (long)d->client_key_len, + buf_filetype(d->client_key, d->client_key_len)); + if (rc != WOLFSSL_SUCCESS) + return WOLFCERT_ERR(WOLFCERT_ERR_TLS, "http", + "loading the client key failed (%d)", rc); return WOLFCERT_OK; } @@ -986,11 +999,13 @@ static int setup_tls_ex(WolfCertConn* c, const TlsDials* dials, const char* sni_host, WOLFSSL_CTX** out_ctx) { WOLFSSL_CTX* ctx = wolfSSL_CTX_new(wolfTLS_client_method()); + int dev_id = wolfcert_default_dev_id(); + if (ctx == NULL) return WOLFCERT_ERR_TLS; /* Keeps the devId wolfSSL_CTX_new picks itself, such as CAAM's. */ - if (dials->tls_dev_id != INVALID_DEVID && - wolfSSL_CTX_SetDevId(ctx, dials->tls_dev_id) != WOLFSSL_SUCCESS) { + if (dev_id != INVALID_DEVID && + wolfSSL_CTX_SetDevId(ctx, dev_id) != WOLFSSL_SUCCESS) { wolfSSL_CTX_free(ctx); return WOLFCERT_ERR_TLS; } @@ -1028,7 +1043,8 @@ static int setup_tls_ex(WolfCertConn* c, const TlsDials* dials, wolfSSL_CTX_set_verify(ctx, dials->verify_server ? WOLFSSL_VERIFY_PEER : WOLFSSL_VERIFY_NONE, NULL); - if (dials->client_cert != NULL && dials->client_key != NULL) { + if (dials->client_cert != NULL && + (dials->client_key != NULL || dials->client_key_obj != NULL)) { /* Load the identity on the CTX so a PHA request can still use it. */ int rc = wolfSSL_CTX_use_certificate_buffer(ctx, dials->client_cert, (long)dials->client_cert_len, @@ -1088,20 +1104,12 @@ static size_t rx_max(size_t max_body) int wolfcert_http_session_open(const WolfCertHttpSessionCfg* cfg, WolfCertHttpSession** out) -{ - return wolfcert_http_session_open_dev(cfg, wolfcert_default_dev_id(), out); -} - -int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, - int tls_dev_id, WolfCertHttpSession** out) { if (cfg == NULL || cfg->base_url == NULL || out == NULL) return WOLFCERT_ERR_BAD_ARG; - int key_dev_id = wolfcert_devid_or_default(cfg->client_key_dev_id); - int rc = check_client_key(cfg->client_key_src, cfg->client_cert, - cfg->client_cert_len, cfg->client_key, - cfg->client_key_len, key_dev_id); + int rc = check_client_key(cfg->client_cert, cfg->client_cert_len, + cfg->client_key, cfg->client_key_obj); if (rc != WOLFCERT_OK) return rc; @@ -1122,12 +1130,11 @@ int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, WOLFCERT_XFREE(s, heap); return rc; } - if (cfg->client_key_src != WOLFCERT_CLIENT_KEY_BUFFER && !s->base.tls) { + if (cfg->client_key_obj != NULL && !s->base.tls) { wolfcert_http_url_free(&s->base); WOLFCERT_XFREE(s, heap); return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "http", - "client_key_src %d needs an https:// URL", - (int)cfg->client_key_src); + "client_key_obj needs an https:// URL"); } rc = dial(&s->conn, s->base.host, s->base.port, cfg->timeout_ms, @@ -1146,10 +1153,8 @@ int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, .client_cert_len = cfg->client_cert_len, .client_key = cfg->client_key, .client_key_len = cfg->client_key_len, - .client_key_src = cfg->client_key_src, - .client_key_dev_id = key_dev_id, + .client_key_obj = cfg->client_key_obj, .allow_post_handshake_auth = cfg->allow_post_handshake_auth, - .tls_dev_id = tls_dev_id, }; rc = setup_tls_ex(&s->conn, &dials, s->base.host, &s->ctx); @@ -1952,8 +1957,7 @@ int wolfcert_http_request(const WolfCertHttpRequest* req, WolfCertHttpResponse* cfg.client_cert_len = req->client_cert_len; cfg.client_key = req->client_key; cfg.client_key_len = req->client_key_len; - cfg.client_key_src = req->client_key_src; - cfg.client_key_dev_id = req->client_key_dev_id; + cfg.client_key_obj = req->client_key_obj; cfg.heap = req->heap; cfg.transport = req->transport; diff --git a/src/internal.c b/src/internal.c index 77b93e4..d2c2d3e 100644 --- a/src/internal.c +++ b/src/internal.c @@ -31,12 +31,7 @@ #include static void* g_default_heap = NULL; -#if defined(WC_USE_DEVID) && defined(WOLF_CRYPTO_CB) -#define START_DEV_ID WC_USE_DEVID -#else -#define START_DEV_ID INVALID_DEVID -#endif -static int g_default_dev_id = START_DEV_ID; +static int g_default_dev_id = WOLFCERT_DEFAULT_DEVID; static WolfCertLogCb g_log_cb = NULL; static void* g_log_ctx = NULL; static WolfCertLogLevel g_log_level = WOLFCERT_LOG_WARN; @@ -60,19 +55,32 @@ void* wolfcert_default_heap(void) return g_default_heap; } -int wolfcert_set_default_dev_id(int dev_id) +int wolfcert_dev_id_check(int dev_id, const char* module) { + if (dev_id == INVALID_DEVID) + return WOLFCERT_OK; #ifndef WOLF_CRYPTO_CB - if (dev_id != INVALID_DEVID) - return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "wolfcert", - "wolfSSL lacks WOLF_CRYPTO_CB"); -#elif !defined(WOLF_CRYPTO_CB_FIND) - if (dev_id != INVALID_DEVID && !wc_CryptoCb_IsDeviceRegistered(dev_id)) - return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "wolfcert", + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, module, + "wolfSSL lacks WOLF_CRYPTO_CB"); +#else +#ifndef WOLF_CRYPTO_CB_FIND + if (!wc_CryptoCb_IsDeviceRegistered(dev_id)) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, module, "no CryptoCb device %d is registered", dev_id); +#else + (void)module; #endif - g_default_dev_id = dev_id; return WOLFCERT_OK; +#endif +} + +int wolfcert_set_default_dev_id(int dev_id) +{ + int rc = wolfcert_dev_id_check(dev_id, "wolfcert"); + + if (rc == WOLFCERT_OK) + g_default_dev_id = dev_id; + return rc; } int wolfcert_default_dev_id(void) @@ -82,7 +90,7 @@ int wolfcert_default_dev_id(void) void wolfcert_default_dev_id_reset(void) { - g_default_dev_id = START_DEV_ID; + g_default_dev_id = WOLFCERT_DEFAULT_DEVID; } void wolfcert_set_log_cb(WolfCertLogCb cb, void* ctx) @@ -428,24 +436,6 @@ int wolfcert_ecc_param_from_curve(int curve_id, int* out_param) } #endif /* WOLFCERT_HAVE_ECC */ -int wolfcert_key_id_check(const uint8_t* id, size_t id_len, int dev_id, - const char* module) -{ - if (id == NULL || id_len == 0 || id_len > WOLFCERT_KEY_ID_MAX_LEN) - return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, module, - "key id must be 1..%d bytes", - WOLFCERT_KEY_ID_MAX_LEN); - if (!wolfcert_devid_is_cb(dev_id)) - return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, module, - "key id needs a CryptoCb device id"); -#ifndef WOLFCERT_USE_KEY_ID - return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, module, - "wolfSSL lacks WOLF_CRYPTO_CB or WOLF_PRIVATE_KEY_ID"); -#else - return WOLFCERT_OK; -#endif -} - WOLFCERT_TEST_VIS int wolfcert_base64_encode(const uint8_t* in, size_t in_len, WolfCertBuffer* out, void* heap) { diff --git a/src/internal.h b/src/internal.h index 12da7d8..1021a85 100644 --- a/src/internal.h +++ b/src/internal.h @@ -86,27 +86,12 @@ #define WOLFCERT_USE_KEY_ID #endif -static inline int wolfcert_devid_is_cb(int dev_id) -{ - return dev_id != INVALID_DEVID; -} - -static inline int wolfcert_devid_or_default(int dev_id) -{ - return dev_id != INVALID_DEVID ? dev_id : wolfcert_default_dev_id(); -} - /* Restores the start devId; wolfCrypt_Cleanup unregisters the devices. */ void wolfcert_default_dev_id_reset(void); -/* wolfcert_key_generate on dev_id as given, without the default devId. */ -int wolfcert_key_generate_on(const WolfCertKeyCfg* cfg, int dev_id, - WolfCertKey** out_key); - -/* BAD_ARG or UNSUPPORTED, with a message, unless id names a key a CryptoCb - * device can hold in this build. */ -int wolfcert_key_id_check(const uint8_t* id, size_t id_len, int dev_id, - const char* module); +/* BAD_ARG or UNSUPPORTED, with a message, unless dev_id is INVALID_DEVID or + * names a registered CryptoCb device. */ +int wolfcert_dev_id_check(int dev_id, const char* module); struct WolfCertKey { WolfCertKeyType type; @@ -308,9 +293,6 @@ typedef struct { WOLFCERT_TEST_VIS int wolfcert_http_url_parse(const char* url, WolfCertUrl* out, void* heap); WOLFCERT_TEST_VIS void wolfcert_http_url_free (WolfCertUrl* u); -/* wolfcert_http_session_open with the TLS context on tls_dev_id. */ -int wolfcert_http_session_open_dev(const WolfCertHttpSessionCfg* cfg, - int tls_dev_id, WolfCertHttpSession** out); /* Resume point for wolfcert_http_chunked_complete(); zero it before the first * call, setting max to cap the decoded body (0 for no cap). */ diff --git a/src/keygen.c b/src/keygen.c index b985438..f938d91 100644 --- a/src/keygen.c +++ b/src/keygen.c @@ -51,13 +51,27 @@ static WolfCertKey* alloc_shell(WolfCertKeyType type, int dev_id, static int check_key_id(const WolfCertKeyCfg* cfg, int dev_id) { + int rc = wolfcert_dev_id_check(dev_id, "keygen"); + + if (rc != WOLFCERT_OK) + return rc; if (cfg->key_id_len == 0) return cfg->key_id == NULL ? WOLFCERT_OK : WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", "key_id is set but key_id_len is 0"); - - return wolfcert_key_id_check(cfg->key_id, cfg->key_id_len, dev_id, - "keygen"); + if (cfg->key_id == NULL || cfg->key_id_len > WOLFCERT_KEY_ID_MAX_LEN) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", + "key id must be 1..%d bytes", + WOLFCERT_KEY_ID_MAX_LEN); + if (dev_id == INVALID_DEVID) + return WOLFCERT_ERR(WOLFCERT_ERR_BAD_ARG, "keygen", + "key id needs a CryptoCb device id"); +#ifndef WOLFCERT_USE_KEY_ID + return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", + "wolfSSL lacks WOLF_CRYPTO_CB or WOLF_PRIVATE_KEY_ID"); +#else + return WOLFCERT_OK; +#endif } static void free_shell(WolfCertKey* k) @@ -73,14 +87,6 @@ static void free_shell(WolfCertKey* k) } int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key) -{ - return wolfcert_key_generate_on(cfg, - cfg != NULL ? wolfcert_devid_or_default(cfg->dev_id) : INVALID_DEVID, - out_key); -} - -int wolfcert_key_generate_on(const WolfCertKeyCfg* cfg, int dev_id, - WolfCertKey** out_key) { if (out_key == NULL) return WOLFCERT_ERR_BAD_ARG; @@ -88,6 +94,8 @@ int wolfcert_key_generate_on(const WolfCertKeyCfg* cfg, int dev_id, if (cfg == NULL) return WOLFCERT_ERR_BAD_ARG; + int dev_id = cfg->dev_id; + const WolfCertKeyAlg* alg = wolfcert_key_alg(cfg->type); if (alg == NULL) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", @@ -220,8 +228,7 @@ int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, const WolfCertKeyAlg* const* list = wolfcert_key_algs_all(); for (; *list != NULL; ++list) { const WolfCertKeyAlg* a = *list; - WolfCertKey* k = alloc_shell(a->type, wolfcert_default_dev_id(), NULL, - 0, heap); + WolfCertKey* k = alloc_shell(a->type, INVALID_DEVID, NULL, 0, heap); if (k == NULL) { if (der != NULL) wc_FreeDer(&der); @@ -330,7 +337,7 @@ int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, if (cfg == NULL || cfg->key_id_len == 0 || cert == NULL || cert_len == 0) return WOLFCERT_ERR_BAD_ARG; - int dev_id = wolfcert_devid_or_default(cfg->dev_id); + int dev_id = cfg->dev_id; int rc = check_key_id(cfg, dev_id); if (rc != WOLFCERT_OK) return rc; @@ -381,7 +388,7 @@ int wolfcert_key_export_der(const WolfCertKey* key, uint8_t** out_der, const WolfCertKeyAlg* alg = wolfcert_key_alg(key->type); if (alg == NULL) return WOLFCERT_ERR_UNSUPPORTED; - if (key->id_len > 0) + if (key->id_len > 0 || (alg->host_priv != NULL && !alg->host_priv(key))) return WOLFCERT_ERR(WOLFCERT_ERR_UNSUPPORTED, "keygen", "the private key stays in CryptoCb device %d", key->dev_id); diff --git a/src/scep/scep_client.c b/src/scep/scep_client.c index 620cc37..26a279b 100644 --- a/src/scep/scep_client.c +++ b/src/scep/scep_client.c @@ -696,7 +696,6 @@ struct WolfCertScepSession { uint8_t* in_signer_copy; /* owned: _nb copy or self-signed */ uint8_t* in_signer_key; /* key DER, zeroized */ size_t in_signer_key_len; - int in_signer_dev_id; uint8_t* in_txid; /* owned, from scep_prepare */ size_t in_txid_len; uint8_t in_nonce[SCEP_NONCE_SZ]; @@ -777,8 +776,7 @@ static int scep_session_connect(WolfCertScepSession* s, .client_cert_len = srv->client_cert_len, .client_key = srv->client_key, .client_key_len = srv->client_key_len, - .client_key_src = srv->client_key_src, - .client_key_dev_id = srv->client_key_dev_id, + .client_key_obj = srv->client_key_obj, .transport = srv->transport, .heap = s->heap, }; @@ -1011,7 +1009,7 @@ static int scep_prepare(WolfCertScepSession* s, const ScepCall* c, s->in_signer, s->in_signer_len, s->in_signer_key, s->in_signer_key_len, hash_oid, &attrs, out_pki, - s->in_signer_dev_id, heap); + wolfcert_default_dev_id(), heap); wolfcert_buffer_free(&env); return rc; @@ -1112,7 +1110,7 @@ static int scep_finish(const WolfCertScepSession* s, WolfCertScepResult* out) rc = wolfcert_scep_deenvelop(s->in_signer, s->in_signer_len, s->in_signer_key, s->in_signer_key_len, resp_env.data, resp_env.len, &inner, - s->in_signer_dev_id, heap); + wolfcert_default_dev_id(), heap); if (rc == WOLFCERT_OK) rc = wolfcert_pkcs7_certs_to_pem(inner.data, inner.len, &out->cert_pem, heap); @@ -1151,7 +1149,7 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, c->csr, c->csr_len, &s->in_signer_copy, &s->in_signer_len, - c->key->dev_id, heap); + wolfcert_default_dev_id(), heap); s->in_signer = s->in_signer_copy; } else { @@ -1204,7 +1202,6 @@ static int scep_session_begin_pki_op(WolfCertScepSession* s, const ScepCall* c, rc = wolfcert_key_export_der(c->key, &s->in_signer_key, &key_len, heap); s->in_signer_key_len = (size_t)key_len; - s->in_signer_dev_id = c->key->dev_id; if (rc == WOLFCERT_OK) rc = scep_prepare(s, c, msg_type, content, content_len, &pki); if (rc == WOLFCERT_OK) diff --git a/src/scep/scep_server.c b/src/scep/scep_server.c index 2b1ef42..45e9fe4 100644 --- a/src/scep/scep_server.c +++ b/src/scep/scep_server.c @@ -1332,7 +1332,7 @@ static int make_split_ra(WolfCertServer* s, ScepPriv* p) size_t lens[2]; int rc; - rc = wolfcert_key_generate_on(&kcfg, INVALID_DEVID, &key); + rc = wolfcert_key_generate(&kcfg, &key); if (rc == WOLFCERT_OK) rc = wolfcert_csr_build(key, &meta, &csr); if (rc == WOLFCERT_OK) @@ -1469,7 +1469,7 @@ static int bundle_root(WolfCertServer* s, uint8_t** root, size_t* root_len) size_t ca_len = 0; int rc; - rc = wolfcert_key_generate_on(&kcfg, INVALID_DEVID, &key); + rc = wolfcert_key_generate(&kcfg, &key); if (rc == WOLFCERT_OK) rc = bundle_cert(s, RSA_TYPE, key->impl, "wolfCert Test Root", "keyCertSign,cRLSign,keyEncipherment", BUNDLE_CA, @@ -1539,7 +1539,7 @@ WOLFCERT_TEST_VIS int wolfcert_scep_server_set_bundle_fault(WolfCertServer* s, if (rc == WOLFCERT_OK && mode == 1) rc = bundle_root(s, &der[3], &len[3]); if (rc == WOLFCERT_OK && mode == 3) { - rc = wolfcert_key_generate_on(&ecc, INVALID_DEVID, &ecc_key); + rc = wolfcert_key_generate(&ecc, &ecc_key); if (rc == WOLFCERT_OK) rc = bundle_cert(s, ECC_TYPE, ecc_key->impl, "wolfCert Test ECC Leaf", NULL, 0, NULL, NULL, 0, diff --git a/tests/integration/test_est_devid_roundtrip.c b/tests/integration/test_est_devid_roundtrip.c index f8f8005..3d4e64f 100644 --- a/tests/integration/test_est_devid_roundtrip.c +++ b/tests/integration/test_est_devid_roundtrip.c @@ -62,6 +62,7 @@ int main(void) #define MOCK_DEVID 0x6d6b #define ACCEL_DEVID 0x6163 +#define UNREGISTERED_DEVID 0x7a7a #define MOCK_SLOTS 4 enum { MOCK_ECC = 1, MOCK_RSA, MOCK_MLDSA, MOCK_ED25519, MOCK_ED448 }; @@ -682,13 +683,12 @@ static int run_key_type(const char* url, WolfCertKeyType type, int param, REQUIRE(mock_private_ops >= ops + 2); #endif - /* The store key as the mTLS identity by id, one-shot and in a session. */ - cli.client_cert = issued.cert_pem.data; - cli.client_cert_len = issued.cert_pem.len; - cli.client_key = id; - cli.client_key_len = sizeof(id) - 1; - cli.client_key_src = WOLFCERT_CLIENT_KEY_ID; - cli.client_key_dev_id = MOCK_DEVID; + /* The store key as the mTLS identity, one-shot and in a session. */ + cli.client_cert = issued.cert_pem.data; + cli.client_cert_len = issued.cert_pem.len; + cli.client_key = NULL; + cli.client_key_len = 0; + cli.client_key_obj = reloaded; REQUIRE(wolfcert_csr_build(reloaded, &meta, &csr) == WOLFCERT_OK); ops = mock_private_ops; rc = wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &second); @@ -720,8 +720,9 @@ static int run_key_type(const char* url, WolfCertKeyType type, int param, return 0; } -/* A PEM client key signs in software even with a client_key_dev_id. */ -static int test_client_key_src(const char* url, +/* A software key handle is an mTLS identity as PEM bytes are; it cannot come + * with client_key. */ +static int test_client_key_obj(const char* url, const uint8_t* tls_cert, size_t tls_cert_len, const uint8_t* boot_cert, size_t boot_cert_len, const uint8_t* boot_key, size_t boot_key_len) @@ -740,34 +741,43 @@ static int test_client_key_src(const char* url, .client_cert_len = boot_cert_len, .client_key = boot_key, .client_key_len = boot_key_len, - .client_key_src = WOLFCERT_CLIENT_KEY_BUFFER, - .client_key_dev_id = MOCK_DEVID, }; WolfCertKey* key = NULL; WolfCertBuffer csr = { 0 }; WolfCertEstResult cert = { 0 }; + WolfCertEstResult again = { 0 }; int requests; REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + WOLFCERT_OK); + cli.client_key_obj = key; + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &again) == + WOLFCERT_ERR_BAD_ARG); + cli.client_cert = cert.cert_pem.data; + cli.client_cert_len = cert.cert_pem.len; + cli.client_key = NULL; + cli.client_key_len = 0; requests = mock_sign_requests; - REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &again) == WOLFCERT_OK); REQUIRE(mock_sign_requests == requests); + wolfcert_est_result_free(&again); wolfcert_est_result_free(&cert); - - cli.client_key_src = (WolfCertClientKeySrc)7; - REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == - WOLFCERT_ERR_BAD_ARG); - cli.client_key_src = WOLFCERT_CLIENT_KEY_BUFFER; wolfcert_buffer_free(&csr); wolfcert_key_free(key); key = NULL; + cli.client_cert = boot_cert; + cli.client_cert_len = boot_cert_len; + cli.client_key = boot_key; + cli.client_key_len = boot_key_len; + cli.client_key_obj = NULL; #ifdef KEEP_PEER_CERT - /* A dev_id key without a key_id signs its CSR and the handshake on the - * device. */ + /* A dev_id key without a key_id signs its CSR on the device and the + * handshake on the default devId. */ const WolfCertCertMeta renew_meta = { 0 }; WolfCertClient* client = NULL; WolfCertKey* unused = NULL; @@ -788,7 +798,7 @@ static int test_client_key_src(const char* url, fprintf(stderr, "dev reenroll rc=%d (%s)\n", rc, wolfcert_last_error_message()); REQUIRE(rc == WOLFCERT_OK); - REQUIRE(mock_sign_requests >= requests + 2); + REQUIRE(mock_sign_requests == requests + 1); wolfcert_buffer_free(&renewed); wolfcert_est_result_free(&cert); wolfcert_buffer_free(&csr); @@ -797,8 +807,8 @@ static int test_client_key_src(const char* url, return 0; } -/* The default devId gets the client's TLS crypto, including a PEM client key's - * signature, while a key_id key still signs in its own device. */ +/* The default devId gets the client's TLS crypto, including the signature of a + * PEM key or a software key handle, while a key_id key signs in its device. */ static int test_default_dev_id(const char* url, const uint8_t* tls_cert, size_t tls_cert_len, const uint8_t* boot_cert, size_t boot_cert_len, @@ -827,6 +837,8 @@ static int test_default_dev_id(const char* url, WolfCertBuffer csr = { 0 }; WolfCertEstResult cert = { 0 }; WolfCertEstResult issued = { 0 }; + WolfCertEstResult soft = { 0 }; + WolfCertKey* soft_key = NULL; int ops; #ifndef WC_USE_DEVID @@ -854,8 +866,19 @@ static int test_default_dev_id(const char* url, wolfcert_key_free(key); key = NULL; - /* A key made with INVALID_DEVID now takes the default for its own work. */ + /* A key made with INVALID_DEVID stays in software; the caller names the + * default device to use it. */ + accel_signs = 0; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); + REQUIRE(wolfcert_key_dev_id(key) == INVALID_DEVID); + REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); + REQUIRE(accel_signs == 0); + REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &soft) == + WOLFCERT_OK); + wolfcert_buffer_free(&csr); + soft_key = key; accel_signs = 0; + kcfg.dev_id = wolfcert_default_dev_id(); REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); REQUIRE(wolfcert_key_dev_id(key) == ACCEL_DEVID); REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); @@ -864,15 +887,21 @@ static int test_default_dev_id(const char* url, wolfcert_key_free(key); key = NULL; - /* A key_id with INVALID_DEVID goes to the default device too. */ - REQUIRE(wolfcert_set_default_dev_id(MOCK_DEVID) == WOLFCERT_OK); + /* A key_id needs a device, and a dev_id a registered one. */ + kcfg.dev_id = INVALID_DEVID; kcfg.key_id = dflt_id; kcfg.key_id_len = sizeof(dflt_id) - 1; - REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); - REQUIRE(wolfcert_key_dev_id(key) == MOCK_DEVID); - wolfcert_key_free(key); - key = NULL; - REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(key == NULL); +#ifndef WOLF_CRYPTO_CB_FIND + kcfg.dev_id = UNREGISTERED_DEVID; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(key == NULL); + kcfg.key_id = NULL; + kcfg.key_id_len = 0; + REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(key == NULL); +#endif kcfg.dev_id = MOCK_DEVID; kcfg.key_id = id; @@ -882,12 +911,11 @@ static int test_default_dev_id(const char* url, REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &issued) == WOLFCERT_OK); - cli.client_cert = issued.cert_pem.data; - cli.client_cert_len = issued.cert_pem.len; - cli.client_key = id; - cli.client_key_len = sizeof(id) - 1; - cli.client_key_src = WOLFCERT_CLIENT_KEY_ID; - cli.client_key_dev_id = MOCK_DEVID; + cli.client_cert = issued.cert_pem.data; + cli.client_cert_len = issued.cert_pem.len; + cli.client_key = NULL; + cli.client_key_len = 0; + cli.client_key_obj = key; accel_calls = 0; accel_signs = 0; ops = mock_private_ops; @@ -898,18 +926,21 @@ static int test_default_dev_id(const char* url, REQUIRE(mock_private_ops > ops); wolfcert_est_result_free(&cert); - /* client_key_dev_id = INVALID_DEVID names the default device. */ - REQUIRE(wolfcert_set_default_dev_id(MOCK_DEVID) == WOLFCERT_OK); - cli.client_key_dev_id = INVALID_DEVID; - ops = mock_private_ops; + /* A software key handle signs its handshake on the default device. */ + cli.client_cert = soft.cert_pem.data; + cli.client_cert_len = soft.cert_pem.len; + cli.client_key_obj = soft_key; + accel_signs = 0; REQUIRE(wolfcert_est_simple_enroll(&cli, csr.data, csr.len, &cert) == WOLFCERT_OK); - REQUIRE(mock_private_ops > ops); + REQUIRE(accel_signs > 0); REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); wolfcert_est_result_free(&cert); + wolfcert_est_result_free(&soft); wolfcert_est_result_free(&issued); wolfcert_buffer_free(&csr); + wolfcert_key_free(soft_key); wolfcert_key_free(key); mock_reset(); return 0; @@ -1098,7 +1129,7 @@ int main(void) boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); #endif - REQUIRE(test_client_key_src(url, tls_cert, tls_cert_len, boot_cert, + REQUIRE(test_client_key_obj(url, tls_cert, tls_cert_len, boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); REQUIRE(test_default_dev_id(url, tls_cert, tls_cert_len, boot_cert, boot_cert_len, boot_key, boot_key_len) == 0); diff --git a/tests/integration/test_scep_roundtrip.c b/tests/integration/test_scep_roundtrip.c index c0817a7..aab0a73 100644 --- a/tests/integration/test_scep_roundtrip.c +++ b/tests/integration/test_scep_roundtrip.c @@ -394,8 +394,9 @@ static int accel_cb(int devId, wc_CryptoInfo* info, void* ctx) return CRYPTOCB_UNAVAILABLE; } -/* A PKCSReq with a default devId signs, decrypts, encrypts and verifies on - * it, while the built-in server stays in software. */ +/* A PKCSReq with a default devId runs its PKCS#7 signing, decryption, + * encryption and verification there; a software key and the built-in server + * stay in software. */ static int check_default_dev_id(const WolfCertServerCfg* cli, const WolfCertScepCaps* caps, const uint8_t* ca_der_buf, size_t ca_der_len) @@ -417,11 +418,11 @@ static int check_default_dev_id(const WolfCertServerCfg* cli, REQUIRE(wolfcert_set_default_dev_id(ACCEL_DEVID) == WOLFCERT_OK); REQUIRE(wolfcert_key_generate(&kcfg, &key) == WOLFCERT_OK); - REQUIRE(wolfcert_key_dev_id(key) == ACCEL_DEVID); + REQUIRE(wolfcert_key_dev_id(key) == INVALID_DEVID); REQUIRE(wolfcert_key_to_pem(key, &pem) == WOLFCERT_OK); REQUIRE(wolfcert_key_from_pem(pem.data, pem.len, NULL, &imported) == WOLFCERT_OK); - REQUIRE(wolfcert_key_dev_id(imported) == ACCEL_DEVID); + REQUIRE(wolfcert_key_dev_id(imported) == INVALID_DEVID); REQUIRE(wolfcert_csr_build(key, &meta, &csr) == WOLFCERT_OK); accel_priv = 0; @@ -431,8 +432,8 @@ static int check_default_dev_id(const WolfCertServerCfg* cli, key, csr.data, csr.len, &issued) == WOLFCERT_OK); REQUIRE(issued.status == WOLFCERT_SCEP_STATUS_SUCCESS); - /* Self-signed signer, pkiMessage signature and CertRep decryption. */ - REQUIRE(accel_priv >= 3); + /* pkiMessage signature and CertRep decryption. */ + REQUIRE(accel_priv >= 2); REQUIRE(accel_pub >= 2); REQUIRE(wolfcert_set_default_dev_id(INVALID_DEVID) == WOLFCERT_OK); diff --git a/tests/unit/test_http.c b/tests/unit/test_http.c index d420e49..1b078fd 100644 --- a/tests/unit/test_http.c +++ b/tests/unit/test_http.c @@ -1205,69 +1205,46 @@ static int test_chunked_complete_resume(void) return 0; } -/* A client key source other than _BUFFER is checked before any connection. */ +/* A client_key_obj is checked before any connection. */ static int test_client_key_checks(void) { static const uint8_t cert[] = "-----BEGIN CERTIFICATE-----"; - static const uint8_t id[] = { 0x01, 0x02 }; + static const uint8_t pem[] = "-----BEGIN PRIVATE KEY-----"; + WolfCertKey key; WolfCertHttpRequest req = { - .method = "GET", - .url = "https://127.0.0.1:1/x", - .client_key = id, - .client_key_len = sizeof(id), - .client_key_src = WOLFCERT_CLIENT_KEY_ID, - .client_key_dev_id = 7, + .method = "GET", + .url = "https://127.0.0.1:1/x", + .client_key_obj = &key, }; WolfCertHttpSessionCfg scfg = { - .base_url = "https://127.0.0.1:1", - .client_key = id, - .client_key_len = sizeof(id), - .client_key_src = WOLFCERT_CLIENT_KEY_ID, - .client_key_dev_id = 7, + .base_url = "https://127.0.0.1:1", + .client_key_obj = &key, }; WolfCertHttpResponse resp; WolfCertHttpSession* s = NULL; + memset(&key, 0, sizeof(key)); REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); + REQUIRE(strstr(wolfcert_last_error_message(), "client_cert") != NULL); REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); - scfg.client_cert = cert; - scfg.client_cert_len = sizeof(cert); - scfg.client_key_dev_id = INVALID_DEVID; + scfg.client_cert = cert; + scfg.client_cert_len = sizeof(cert); + scfg.client_key = pem; + scfg.client_key_len = sizeof(pem); REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); - scfg.client_key_dev_id = 7; - scfg.client_cert_len = 0; - REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); - scfg.client_cert_len = sizeof(cert); - scfg.client_key_len = 0; - REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); - scfg.client_key_len = sizeof(id); -#ifndef WOLFCERT_USE_KEY_ID - REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_UNSUPPORTED); -#else - scfg.base_url = "http://127.0.0.1:1"; + REQUIRE(strstr(wolfcert_last_error_message(), "not both") != NULL); + scfg.client_key = NULL; + scfg.client_key_len = 0; + scfg.base_url = "http://127.0.0.1:1"; REQUIRE(wolfcert_http_session_open(&scfg, &s) == WOLFCERT_ERR_BAD_ARG); REQUIRE(strstr(wolfcert_last_error_message(), "https://") != NULL); - scfg.base_url = "https://127.0.0.1:1"; -#endif REQUIRE(s == NULL); req.client_cert = cert; req.client_cert_len = sizeof(cert); - req.client_key_src = (WolfCertClientKeySrc)7; + req.client_key = pem; + req.client_key_len = sizeof(pem); REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); - req.client_key_src = WOLFCERT_CLIENT_KEY_ID; - req.client_key_dev_id = INVALID_DEVID; - REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); - req.client_key_dev_id = 7; - req.client_cert_len = 0; - REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); - req.client_cert_len = sizeof(cert); - req.client_key_len = WOLFCERT_KEY_ID_MAX_LEN + 1; - REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_BAD_ARG); -#ifndef WOLFCERT_USE_KEY_ID - req.client_key_len = sizeof(id); - REQUIRE(wolfcert_http_request(&req, &resp) == WOLFCERT_ERR_UNSUPPORTED); -#endif return 0; } diff --git a/tests/unit/test_keygen.c b/tests/unit/test_keygen.c index 6de3cee..f10d611 100644 --- a/tests/unit/test_keygen.c +++ b/tests/unit/test_keygen.c @@ -89,7 +89,7 @@ static int roundtrip(WolfCertKeyType type, int param) #ifdef TEST_KEY_TYPE #define DECLINE_DEVID 0x6b69 -#if defined(WOLF_CRYPTO_CB) && defined(WOLF_PRIVATE_KEY_ID) +#ifdef WOLF_CRYPTO_CB static int decline_cb(int devId, wc_CryptoInfo* info, void* ctx) { (void)devId; @@ -97,6 +97,9 @@ static int decline_cb(int devId, wc_CryptoInfo* info, void* ctx) (void)ctx; return CRYPTOCB_UNAVAILABLE; } +#endif + +#if defined(WOLF_CRYPTO_CB) && defined(WOLF_PRIVATE_KEY_ID) /* A device that declines keygen leaves wolfCrypt to generate in software, * which a key_id must refuse. */ @@ -381,10 +384,16 @@ static int key_id_cases(void) .key_id = id, .key_id_len = sizeof(id) }; WolfCertKey* k = NULL; +#ifdef WOLF_CRYPTO_CB + REQUIRE(wc_CryptoCb_RegisterDevice(DECLINE_DEVID, decline_cb, NULL) == 0); +#endif REQUIRE(wolfcert_key_generate(&cfg, &k) == WOLFCERT_ERR_UNSUPPORTED); REQUIRE(wolfcert_key_from_id(&cfg, junk, sizeof(junk), &k) == WOLFCERT_ERR_UNSUPPORTED); REQUIRE(k == NULL); +#ifdef WOLF_CRYPTO_CB + wc_CryptoCb_UnRegisterDevice(DECLINE_DEVID); +#endif return 0; } #endif diff --git a/wolfcert/http.h b/wolfcert/http.h index 4fa34cc..2be4d3e 100644 --- a/wolfcert/http.h +++ b/wolfcert/http.h @@ -67,8 +67,7 @@ typedef struct { WolfCertTransport transport; /* As in WolfCertServerCfg. */ - WolfCertClientKeySrc client_key_src; - int client_key_dev_id; + const WolfCertKey* client_key_obj; } WolfCertHttpRequest; typedef struct { @@ -114,8 +113,7 @@ typedef struct { WolfCertTransport transport; /* As in WolfCertServerCfg. */ - WolfCertClientKeySrc client_key_src; - int client_key_dev_id; + const WolfCertKey* client_key_obj; } WolfCertHttpSessionCfg; /* Connects without verifying the server; the first request runs the TLS diff --git a/wolfcert/keygen.h b/wolfcert/keygen.h index afc261d..861e60f 100644 --- a/wolfcert/keygen.h +++ b/wolfcert/keygen.h @@ -26,15 +26,13 @@ extern "C" { #endif -typedef struct WolfCertKey WolfCertKey; - -/* Generate a key per cfg on CryptoCb device cfg->dev_id, or for INVALID_DEVID - * on the default devId. With cfg->key_id the key also stays in the device and - * the handle only references it, under the id wolfcert_key_id returns, which - * the device may have changed. Allocated from cfg->heap or the default. - * *out_key is NULL after a failure, except WOLFCERT_ERR_CRYPTO when the device - * left an unusable id: *out_key then holds the key under the requested id so - * the caller can delete it there. */ +/* Generate a key per cfg on CryptoCb device cfg->dev_id, or in software for + * INVALID_DEVID. An unregistered dev_id, or a key_id without one, is _BAD_ARG; + * either without wolfSSL's WOLF_CRYPTO_CB / WOLF_PRIVATE_KEY_ID is + * _UNSUPPORTED. With cfg->key_id the key stays in the device, under the id + * wolfcert_key_id returns, which the device may have changed. *out_key is NULL + * after a failure, except WOLFCERT_ERR_CRYPTO when the device left an unusable + * id: *out_key then holds the key under the requested id to delete it there. */ WOLFCERT_API int wolfcert_key_generate(const WolfCertKeyCfg* cfg, WolfCertKey** out_key); /* Reference a key a CryptoCb device holds under cfg->key_id, its public half @@ -45,13 +43,12 @@ WOLFCERT_API int wolfcert_key_from_id(const WolfCertKeyCfg* cfg, const uint8_t* cert, size_t cert_len, WolfCertKey** out_key); -/* Load a key from PEM or DER, auto-detected, into host memory; its operations - * run on the devId that is the default at the time of the call. */ +/* Load a software key from PEM or DER, auto-detected, into host memory. */ WOLFCERT_API int wolfcert_key_from_pem(const uint8_t* data, size_t data_len, void* heap, WolfCertKey** out_key); /* Export a software key as PEM. Fails with WOLFCERT_ERR_UNSUPPORTED for a - * key with a key_id. */ + * key with a key_id or whose private half its device keeps. */ WOLFCERT_API int wolfcert_key_to_pem(const WolfCertKey* key, WolfCertBuffer* out_pem); /* Export a software key as raw DER (same export constraints as diff --git a/wolfcert/types.h b/wolfcert/types.h index 01afb8d..a187e3c 100644 --- a/wolfcert/types.h +++ b/wolfcert/types.h @@ -39,6 +39,8 @@ extern "C" { #endif +typedef struct WolfCertKey WolfCertKey; + typedef enum { WOLFCERT_PROTO_EST = 1, WOLFCERT_PROTO_SCEP = 2 @@ -83,16 +85,10 @@ typedef enum { #define WOLFCERT_KEY_ID_MAX_LEN 32 #endif -/* What a TLS client_key holds. */ -typedef enum { - WOLFCERT_CLIENT_KEY_BUFFER = 0, /* PEM or DER */ - WOLFCERT_CLIENT_KEY_ID = 1 /* key id held by client_key_dev_id */ -} WolfCertClientKeySrc; - typedef struct { WolfCertKeyType type; int param; /* RSA 2048/3072/4096 or ECC 256/384/521 bits */ - int dev_id; /* devId; INVALID_DEVID = the default */ + int dev_id; /* devId as given; INVALID_DEVID = software */ void* heap; /* optional heap hint; NULL = default */ /* Backend key id, opaque to wolfCert; needs a devId. Up to * WOLFCERT_KEY_ID_MAX_LEN bytes. */ @@ -100,8 +96,22 @@ typedef struct { size_t key_id_len; } WolfCertKeyCfg; -/* Registered devId for client crypto and keys made later with INVALID_DEVID; - * starts as WC_USE_DEVID if defined. Set it before threads use wolfCert. */ +/* Start value of the default devId; user_settings.h may override it. */ +#ifndef WOLFCERT_DEFAULT_DEVID + #if defined(WC_USE_DEVID) && defined(WOLF_CRYPTO_CB) + #define WOLFCERT_DEFAULT_DEVID WC_USE_DEVID + #else + #define WOLFCERT_DEFAULT_DEVID INVALID_DEVID + #endif +#endif +#if !defined(WOLF_CRYPTO_CB) && WOLFCERT_DEFAULT_DEVID != INVALID_DEVID + #error "WOLFCERT_DEFAULT_DEVID needs wolfSSL built with WOLF_CRYPTO_CB" +#endif + +/* Registered devId for the TLS contexts and SCEP PKCS#7 objects wolfCert + * creates; keys, their keygen and CSRs use their own. BAD_ARG for an + * unregistered devId, UNSUPPORTED without WOLF_CRYPTO_CB. Set it before + * threads use wolfCert. */ WOLFCERT_API int wolfcert_set_default_dev_id(int dev_id); WOLFCERT_API int wolfcert_default_dev_id(void); @@ -250,10 +260,9 @@ typedef struct { WolfCertTransport transport; - /* What client_key holds, and the device holding an _ID key (INVALID_DEVID = - * default). _ID needs client_cert, client_key and an https:// URL. */ - WolfCertClientKeySrc client_key_src; - int client_key_dev_id; + /* Instead of client_key: the TLS client key as a key handle, borrowed + * while an https:// connection opens; a key_id key signs in its device. */ + const WolfCertKey* client_key_obj; } WolfCertServerCfg; /* Caller-owned byte buffer filled by the library. wolfcert_buffer_free()