Algo examples by aidankeefe2022 · Pull Request #610 · wolfSSL/wolfssl-examples

aidankeefe2022 · 2026-07-29T19:40:18Z

New Examples

SLH-DSA
SM2/SM3/SM4
Blake2b/Blake2s
KDF
HPKE seal/open example
SRP-6a SHA-256 example
ECCSI + SAKKE example

Revisions on the AI generated examples

Changed the peer to peer/ client server examples to represent the different actors as structs ie. Alice struct and Bob struct to show how data moves and what information is used for each task.

Also added comments to spell out each step using boxing style for the more complex examples
Example:

/* --- Thing is happening --- *
{
      Thing happens
}
/* ---Thing is happening --- */

Key generation, signing and verification for all SHAKE and SHA2 parameter sets, with corrupted-signature rejection.

wolfCrypt-level ShangMi examples: SM3 hash (GB/T 32905 known answer), SM4-GCM with tamper detection, SM2 sign/verify including the ZA digest step, and SM2 ECDH. Requires the wolfSSL/wolfsm overlay.

Incremental hashing checked against the RFC 7693 known-answer vectors, plus BLAKE2b's native keyed mode used as a MAC.

SipHash-2-4 one-shot 64/128-bit MACs and the incremental API, checked against the reference implementation's test vector.

HKDF (RFC 5869), PBKDF2 (RFC 2898) and scrypt (RFC 7914), each verified against its RFC known-answer test vector.

One KEM encapsulation protecting an ordered message sequence via wc_HpkeInitSealContext()/wc_HpkeContextSealBase() and the open equivalents, with out-of-order rejection.

Full exchange (enrollment through mutual proof verification) using SHA-256 and the RFC 5054 2048-bit group.

Identity-based key exchange per RFC 6507-6509: KMS provisions user key material, ECCSI signs the SAKKE-encapsulated SSV, receiver verifies and derives the shared secret.

Add check entries for slh_dsa, blake2, siphash, kdf and mikey-sakke; extend the crypto, pq and pk profiles with their configure flags. crypto/sm is a documented skip: it needs the wolfsm overlay patched into the wolfSSL tree before configure.

wolfSSL-Fenrir-bot

Fenrir Automated Review — PR #610

Scan targets checked: wolfssl-examples-bugs, wolfssl-examples-src

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

This review was generated automatically by Fenrir. Findings are non-blocking.

dgarske

Add the 15 new binaries to .gitignore,

dgarske · 2026-08-07T01:13:03Z

+        ret = wc_SlhDsaKey_Init(&pubKey, param, NULL, INVALID_DEVID);
+        if (ret != 0) goto exit;
+        /* - only have pub key - */
+        wc_SlhDsaKey_ImportPublic(&pubKey, pub, pubLen);


Why was the return code not captured in this example?

dgarske · 2026-08-07T01:14:42Z

+    path: crypto/sm
+    mode: skip
+    reason: >-
+      SM2/SM3/SM4 live in the separate wolfSSL/wolfsm overlay, which must be


Let's make the test clone it and test it. Thanks

dgarske · 2026-08-07T01:15:25Z

+        /* - Get Sender Public Validation Token - */
+
+        /* - Verify the Message - */
+        ret = wc_HashEccsiId(&Bob.publicKeyEccsi, WC_HASH_TYPE_SHA256,


MIKEY-SAKKE Message struct omits the length fields the receiver needs, so Bob reaches for the sender's compile-time constants
Recommendation: Add senderIdSz and ssvSz to Message and have Bob read both from there, and bound the memcpy into Message.senderId against sizeof(Message.senderId).

dgarske · 2026-08-07T01:16:02Z

+        /* - Get Sender Public Validation Token - */
+        ret = wc_DecodeEccsiPvtFromSig(&Bob.publicKeyEccsi,
+                Message.signature, Message.signatureSz, senderPvt);
+        if (ret != 0) {printf("Could not Decode Pvt."); goto BobFail;}


Make sure printfs have \n. I really don't like the squashed single line. If its too verbose use a macro or local static function to help.

dgarske · 2026-08-07T01:16:28Z

+        /* - Get The Shared secret value out of the Message - */
+
+        /* - Error - */
+        if (0) {


Can we avoid if (0) dead code here??

dgarske · 2026-08-07T01:19:44Z

+    WC_RNG           rng;
+    int              rngInit = 0;
+    byte*            sig = NULL;
+    byte             pub[64];


Use WC_SLHDSA_MAX_PUB_LEN from wc_slhdsa.h instead of the literal 64.

dgarske · 2026-08-07T01:20:16Z

+        int        secretSigningKeyInit;
+        ecc_point* publicValidationToken;
+        ecc_point* receiverSecretKey;
+        byte       dirived_sharedSecretValue[SSV_SZ]; /* plaintext SSV (Bob's copy) */


Fix all spelling errors for dirived_ -> derived_

dgarske · 2026-08-07T01:21:16Z

+
+#if defined(WOLFCRYPT_HAVE_ECCSI) && defined(WOLFCRYPT_HAVE_SAKKE)
+
+#define SSV_SZ      16


AUTH_SZ 257, ECCSI_SIG_SZ 129, ECCSI_PUB_KEY_SZ (32 * 2) and SAKKE_PUB_KEY_SZ (128 * 2) are all hand-derived from the parameter sets. I verified each against wolfSSL: 257 = 1 + 2128 for the SAKKE 1024-bit encapsulated point, 129 = 432+1 which is exactly what wc_SignEccsiHash() bounds-checks, and the two raw public-key sizes match what wc_ExportEccsiPublicKey/wc_ExportSakkePublicKey require with raw=1. So all four are correct today. But sakke.h exports wc_GetSakkeAuthSize(SakkeKey* key, word16* authSz) for precisely the first of these, and using it would make the example self-describing and immune to a parameter-set change.

Recommendation: Use wc_GetSakkeAuthSize() to set Message.authSz, and add a short comment next to the remaining constants noting which parameter set they are derived from.

dgarske · 2026-08-07T01:21:57Z

+CFLAGS=-Wall -I$(WOLFSSL_INSTALL_DIR)/include
+LIBS=-L$(WOLFSSL_INSTALL_DIR)/lib -lwolfssl -lm
+
+siphash-mac: siphash-mac.o


Recommendation: Add all: targets to crypto/siphash/Makefile and pk/mikey-sakke/Makefile and list all in .PHONY, matching the other Makefiles in this PR.

dgarske · 2026-08-07T01:23:26Z

+    if (ret != 0)
+        printf("error %d: %s\n", ret, wc_GetErrorString(ret));
+
+    if (Bob.receiverSecretKey != NULL)


Let's also wipe sharedSecretValue values for Alice and Bob.

anhu and others added 15 commits July 29, 2026 13:38

Add SLH-DSA (FIPS 205) example

dbf6e9a

Key generation, signing and verification for all SHAKE and SHA2 parameter sets, with corrupted-signature rejection.

Add SM2/SM3/SM4 examples

eba0390

wolfCrypt-level ShangMi examples: SM3 hash (GB/T 32905 known answer), SM4-GCM with tamper detection, SM2 sign/verify including the ZA digest step, and SM2 ECDH. Requires the wolfSSL/wolfsm overlay.

Add BLAKE2b/BLAKE2s examples

73dde4a

Incremental hashing checked against the RFC 7693 known-answer vectors, plus BLAKE2b's native keyed mode used as a MAC.

Add SipHash example

9f75129

SipHash-2-4 one-shot 64/128-bit MACs and the incremental API, checked against the reference implementation's test vector.

Add KDF examples

f09fb73

HKDF (RFC 5869), PBKDF2 (RFC 2898) and scrypt (RFC 7914), each verified against its RFC known-answer test vector.

Add HPKE seal/open context example

96fb285

One KEM encapsulation protecting an ordered message sequence via wc_HpkeInitSealContext()/wc_HpkeContextSealBase() and the open equivalents, with out-of-order rejection.

Add SRP-6a SHA-256 example

6398f45

Full exchange (enrollment through mutual proof verification) using SHA-256 and the RFC 5054 2048-bit group.

Add MIKEY-SAKKE (ECCSI + SAKKE) example

0aeba02

Identity-based key exchange per RFC 6507-6509: KMS provisions user key material, ECCSI signs the SAKKE-encapsulated SSV, receiver verifies and derives the shared secret.

Mikey-Sakke example revised

a6933bd

srp_sha256 revised

edac069

hpke_context revised

6715f35

sm2-ecdh revised

23c020e

Mikey-sakke format fix

5626aa3

revised slh_dsa

213cb56

aidankeefe2022 self-assigned this Jul 29, 2026

aidankeefe2022 marked this pull request as ready for review July 30, 2026 16:30

aidankeefe2022 requested a review from wolfSSL-Fenrir-bot July 30, 2026 16:30

wolfSSL-Fenrir-bot reviewed Jul 30, 2026

View reviewed changes

Comment thread pq/slh_dsa/slh_dsa.c Outdated

Comment thread hash/blake2/blake2-keyed-mac.c

Comment thread pk/srp/srp_sha256.c

removed useless sig corruption

5c56a1c

aidankeefe2022 assigned wolfSSL-Bot and unassigned aidankeefe2022 Jul 30, 2026

dgarske self-requested a review August 6, 2026 22:43

dgarske requested changes Aug 7, 2026

View reviewed changes

dgarske assigned aidankeefe2022 Aug 7, 2026


		#if defined(WOLFCRYPT_HAVE_ECCSI) && defined(WOLFCRYPT_HAVE_SAKKE)

		#define SSV_SZ 16

Uh oh!

Conversation

aidankeefe2022 commented Jul 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Examples

Revisions on the AI generated examples

Uh oh!

wolfSSL-Fenrir-bot left a comment

Choose a reason for hiding this comment

Fenrir Automated Review — PR #610

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dgarske left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

aidankeefe2022 commented Jul 29, 2026 •

edited

Loading