Skip to content

Add crypto callbacks for LMS and XMSS#10380

Open
padelsbach wants to merge 2 commits intowolfSSL:masterfrom
padelsbach:lms-xmss
Open

Add crypto callbacks for LMS and XMSS#10380
padelsbach wants to merge 2 commits intowolfSSL:masterfrom
padelsbach:lms-xmss

Conversation

@padelsbach
Copy link
Copy Markdown
Contributor

@padelsbach padelsbach commented May 1, 2026

Description

Add struct fields and callbacks (MakeKey, Sign, Verify and SigsLeft) into existing LMS and XMSS code. Add wc_LmsKey_InitId and _InitLabel for PKCS11 compat. Added unit tests.

Testing

New unit tests

Checklist

  • added tests
  • updated/added doxygen
  • updated appropriate READMEs
  • Updated manual and documentation

Copy link
Copy Markdown

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

Choose a reason for hiding this comment

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

Fenrir Automated Review — PR #10380

Scan targets checked: wolfcrypt-bugs, wolfcrypt-src

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

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

Comment thread wolfcrypt/src/wc_xmss.c Outdated
switch (key->params->hash) {
#ifdef WC_XMSS_SHA256
case WC_HASH_TYPE_SHA256:
ret = wc_Hash(WC_HASH_TYPE_SHA256, msg, msgSz, hash, needSz);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟠 [Medium] wc_XmssKey_HashMsg breaks for XMSS-SHA2_*_192 (SHA-256 truncated) · Logic errors

For XMSS-SHA2_*_192 variants params->n is 24 while params->hash is WC_HASH_TYPE_SHA256. wc_Hash rejects hash_len < 32 with BUFFER_E, so the helper always fails for the 192-bit profiles. The LMS counterpart hashes into a 32-byte stack buffer and copies needSz bytes; the XMSS path skips that step.

Fix: Hash into a WC_SHA256_DIGEST_SIZE stack buffer and XMEMCPY(hash, full, needSz), mirroring the LMS_SHA256_192 path.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fixed

@padelsbach padelsbach force-pushed the lms-xmss branch 3 times, most recently from 49f1cc2 to 6673edd Compare May 4, 2026 17:47
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 4, 2026

MemBrowse Memory Report

No memory changes detected for:

@padelsbach
Copy link
Copy Markdown
Contributor Author

jenkins retest this please

Copy link
Copy Markdown
Contributor

@Frauschi Frauschi left a comment

Choose a reason for hiding this comment

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

A lot of minor things, mainly as the WiP patch I sent you was in a very rough state tbh (sorry for that).

Comment thread doc/LMS_XMSS_CryptoCb.md Outdated
struct {
/* Raw message. Backends following the PKCS#11 v3.2
* CKM_HSS / CKM_XMSS convention of operating on a
* pre-computed digest can call wc_LmsKey_HashMsg /
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit, but I'm unsure if we want to have a specific PKCS#11 reference here.

WOLFSSL_LOCAL int wc_CryptoCb_PqcStatefulSigKeyGen(int type, void* key,
WC_RNG* rng);
/* The raw message is forwarded to the callback. Backends that follow the
* PKCS#11 v3.2 CKM_HSS / CKM_XMSS convention (digest input) can call
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Same as above regarding the mention of PKCS#11 V3.2

Comment thread wolfcrypt/src/wc_lms.c Outdated
Comment thread wolfcrypt/src/wc_lms.c Outdated
Comment thread wolfcrypt/src/wc_xmss.c Outdated
Comment thread wolfcrypt/src/wc_xmss.c Outdated
Comment thread wolfcrypt/src/wc_xmss.c
Comment thread wolfcrypt/src/wc_lms.c Outdated
const byte* msg, int msgSz);
/* Compute the digest of a message with the hash function dictated by the
* XMSS parameter set. Useful for crypto-callback / HSM backends that follow
* the PKCS#11 v3.2 CKM_XMSS / CKM_XMSSMT convention of taking a
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Again, I would remove/weaken the PKCS#11 reference here and be more general.

@Frauschi Frauschi assigned padelsbach and unassigned wolfSSL-Bot May 5, 2026
@padelsbach
Copy link
Copy Markdown
Contributor Author

jenkins retest this please

@Frauschi
Copy link
Copy Markdown
Contributor

Frauschi commented May 6, 2026

Ok, I have updates regarding the PKCS#11 "pre-hash" thing. It turns out that this is actually an error in their specification, which is already corrected in the current working drafts for the next version. The data passed to the sign and verify operations is indeed the whole message, not any pre-hashed digest!

After taking a more in-depth look into the algorithms, a simple pre-hash as proposed in the two helper methods of this PR also does not work and breaks spec compliance. Within both algorithms, the message is hashed together with the current state of the private key, which is not available in a CryptoCb / PKCS#11 setup on the host. Hence, this would have never worked properly anyway.

In total, this greatly simplifies our efforts, as the “normal” callbacks can directly be used for PKCS#11 as well. Hence, the two new helper methods for pre-hashing (wc_LmsKey_HashMsg() and wc_XmssKey_HashMsg()) can be removed completely. Furthermore, all the PKCS#11-related comments are unnecessary as a result.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants