add support for PKCS11 v3.2 by Nicolas-Peiffer · Pull Request #191 · miekg/pkcs11

Nicolas-Peiffer · 2026-04-22T16:21:56Z

Add support for PKCS11 v3.2
Use softhsmv3 for integration testing
Update files headers with SPDX licence ID
Update files headers copyrights
Update Github Action CICD

Tests

Tests are passing with softhsmv3:

Waiting on your feedbacks, testing and improvements 😄

proof of concept to upgrade to v3 of pkcs11 Signed-off-by: Miek Gieben <miek@miek.nl>

Signed-off-by: Miek Gieben <miek@miek.nl>

…spec/v3.2/cs01/include/pkcs11-v3.2/

… CKA_TRUST_EMAIL_PROTECTION, CKA_TRUST_TIME_STAMPING, and CKA_TRUST_OCSP_SIGNING are now defined as standard PKCS#11 v3.2 attributes in pkcs11t.h/zconst.go.

…dation

…golang.org/x/tools/go/analysis/passes/printf Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

C_AsyncComplete allocates CK_ASYNC_DATA.pValue on the token side. The caller is responsible for freeing it. Add defer C.free() after copying the bytes into Go-managed memory via C.GoBytes, preventing a memory leak on every successful async result retrieval. Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

Add Encapsulate/Decapsulate on PublicKey/PrivateKey to expose the PKCS miekg#11 v3.2 ML-KEM key encapsulation API (§5.19) at the p11 layer. Add VerifyStateless on PublicKey for the v3.2 stateless signature verification flow (§5.15) where the signature is bound at init time. Add KEMKeyPair to give callers a typed container for KEM key pairs. Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

TestV32AuthenticatedWrap — renamed to skippedTestV32AuthenticatedWrap with a //nolint:unused directive and a TODO comment explaining the SoftHSMv3 bug (wrap produces the right blob size but unwrap returns wrong key value). The test body is preserved in full so it can be re-enabled once the upstream issue is fixed. TestV32GetSessionValidationFlags — new test for C_GetSessionValidationFlags (v3.2 §5.8.4). Performs an RSA sign, then queries the FIPS validation status of the session. Skips gracefully if the token doesn't support it (acceptable for non-FIPS mode). TestV32PQCParamSetReadback — new table-driven test that verifies CKA_PARAMETER_SET is correctly stored and returned by C_GetAttributeValue for all three PQC families (ML-KEM-768, ML-DSA-65, SLH-DSA-SHA2-128s). This exercises the v3.2 attribute infrastructure and ensures key templates are persisted correctly — useful because a broken attribute store would silently break all PQC key usage downstream. Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com> nolint

… into pkcs11-v3.2-pr

Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

…atest SoftHSMv3 needMech now probes via GetMechanismList instead of GetMechanismInfo; newer SoftHSMv3 returns CKR_MECHANISM_INVALID from C_GetMechanismInfo for mechanisms that are present in C_GetMechanismList. TestPSSParams switches from CKM_RSA_PKCS_PSS (raw pre-hashed digest) to CKM_SHA256_RSA_PKCS_PSS (hash-then-sign); the raw PSS mechanism is no longer advertised by the latest SoftHSMv3. TestOAEPParams was failing with CKR_KEY_FUNCTION_NOT_PERMITTED at EncryptInit because getRSA delegated to generateRSAKeyPair which only sets CKA_VERIFY/CKA_SIGN. getRSA now generates the key pair inline with CKA_ENCRYPT and CKA_DECRYPT set. Also fixes a typo in getRSA where the private key lookup used CKO_PUBLIC_KEY. Tested with pqctoday-org/pqctoday-hsm@37bf66a Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

Tested with pqctoday-org/pqctoday-hsm@37bf66a Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

spencerpogo · 2026-06-16T21:48:18Z

 {
 	params->pOAEPParams = pOAEPParams;
 }
 */


Missing bindings for CK_SIGN_ADDITIONAL_CONTEXT. Should have a C method to populate this struct and Go methods to create it.

ML-DSA Signature
...
The mechanism has an optional parameter CK_SIGN_ADDITIONAL_CONTEXT. If no parameter is supplied the HedgeVariant is set to CKH_HEDGE_PREFERRED, ulContextLen is set to zero and pContext is set to NULL.

https://www.thalesdocs.com/gphsm/luna/7/docs/network/Content/sdk/extensions/pqc/ML-DSA_programming_guide.htm

Hi, TY @spencerpogo for your review.
I tried to cover your request in commit ed5b5af. To be transparent, I used a LLM to take into account your comment.

My current level of confidence is the tests that are passing. But I do not know if this is enough.

spencerpogo · 2026-06-16T21:50:39Z

Need support for ML-DSA signing context here

As per message #191 (comment) and commit ed5b5af

spencerpogo · 2026-06-16T21:50:48Z

 		param, arena = cECDH1DeriveParams(p, arena)
 	case *RSAAESKeyWrapParams:
 		param, arena = cRSAAESKeyWrapParams(p, arena)
 	}


Need support for ML-DSA signing context here

As per message #191 (comment) and commit ed5b5af

miekg#191 (comment)

Implement Go wrappers for the two PKCS#11 v3.2 ML-DSA mechanism parameter structures: - MLDSAParams (CK_SIGN_ADDITIONAL_CONTEXT): hedge variant + optional context bytes, for use with CKM_ML_DSA. - HashMLDSAParams (CK_HASH_SIGN_ADDITIONAL_CONTEXT): hedge variant + optional context bytes + hash mechanism, for use with CKM_HASH_ML_DSA and its SHA/SHAKE variants. Both types are accepted by NewMechanism and serialized to their C counterparts in cMechanism, following the same pointer-deferral pattern used by OAEPParams and RSAAESKeyWrapParams. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> CC miekg#191 (comment) miekg#191 (comment) miekg#191 (comment)

miekg and others added 30 commits January 4, 2022 14:09

Upgrade to pkcs11 v3

2dc21d2

proof of concept to upgrade to v3 of pkcs11 Signed-off-by: Miek Gieben <miek@miek.nl>

Make clear where we found the header files

d721e3f

Signed-off-by: Miek Gieben <miek@miek.nl>

update pkcs11 headers from https://docs.oasis-open.org/pkcs11/pkcs11-…

9ac09c9

…spec/v3.2/cs01/include/pkcs11-v3.2/

CKA_TRUST_SERVER_AUTH, CKA_TRUST_CLIENT_AUTH, CKA_TRUST_CODE_SIGNING,…

e7f37cd

… CKA_TRUST_EMAIL_PROTECTION, CKA_TRUST_TIME_STAMPING, and CKA_TRUST_OCSP_SIGNING are now defined as standard PKCS#11 v3.2 attributes in pkcs11t.h/zconst.go.

simplify plaintext and decrypted comparison as per go linter recomman…

796b5e4

…dation

redundant return statement https://staticcheck.dev/docs/checks/#S1023

213bbb2

non-constant format string in call to fmt.Fprintf https://pkg.go.dev/…

cfd54c8

…golang.org/x/tools/go/analysis/passes/printf Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

refactor to add CK_FUNCTION_LIST_3_2 and support for PKCS#11 v3.2

09c730b

update

de51ef7

prepare integration testing with softhsmv3

23d16e1

add CK_ constants

9e5df54

streamline copyrights headers

ef12f14

update how we fetch OASIS PKCS 11 C headers

a797aba

update test doc

eafe628

start adding doc

0a0db5a

Update architecture-diagrams.md

300f203

Update component-diagrams.md

08541ff

Update sequence-diagrams.md

85779c1

Update flow-diagrams.md

f890eb8

add ref to diagrams

8f43687

update link to thales OSS

346536e

rework copyright header and add SPDX Licence ID

ee407b2

update version number

02525aa

reduce merge conflicts with upstream master

b0db92c

Merge branch 'pkcs11-v3.2' of https://github.com/Nicolas-Peiffer/pkcs11…

a3a4c67

… into pkcs11-v3.2-pr

remove duplicate memBytes

af6a1da

fix merging error

faec7b7

Nicolas-Peiffer added 3 commits April 22, 2026 17:58

suggest next release tag

166d208

add go build

d58c011

update

042baa6

Nicolas-Peiffer force-pushed the pkcs11-v3.2-pr branch 2 times, most recently from a21ac90 to 042baa6 Compare April 22, 2026 16:51

Nicolas-Peiffer added 3 commits April 23, 2026 10:55

update ML-KEM key names and move KEM func below

c5cadad

Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

fix parapgrah ref for oasis pkcs11 v3.2 spec

4062638

Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

add permalink to oasis github

76f8085

Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

Nicolas-Peiffer marked this pull request as ready for review April 23, 2026 09:29

Nicolas-Peiffer marked this pull request as draft April 23, 2026 14:33

Nicolas-Peiffer added 3 commits April 23, 2026 16:38

softhsmv3 repo name changed

2d9ce3d

Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

TestV32AuthenticatedWrap passes

87161bd

Tested with pqctoday-org/pqctoday-hsm@37bf66a Signed-off-by: Nicolas-Peiffer <102670102+Nicolas-Peiffer@users.noreply.github.com>

spencerpogo suggested changes Jun 16, 2026

View reviewed changes

Nicolas-Peiffer added 2 commits June 22, 2026 15:24

remove SPDX ID

bba4b02

miekg#191 (comment)

Nicolas-Peiffer force-pushed the pkcs11-v3.2-pr branch from 933f947 to ed5b5af Compare June 22, 2026 14:22

Navigation Menu

add support for PKCS11 v3.2 - #191

add support for PKCS11 v3.2#191
Nicolas-Peiffer wants to merge 41 commits into
miekg:masterfrom
ThalesGroup:pkcs11-v3.2-pr

Nicolas-Peiffer commented Apr 22, 2026 •

edited

Loading

Uh oh!

spencerpogo Jun 16, 2026

Uh oh!

Nicolas-Peiffer Jun 22, 2026

Uh oh!

spencerpogo Jun 16, 2026

Uh oh!

Nicolas-Peiffer Jun 23, 2026

Uh oh!

spencerpogo Jun 16, 2026

Uh oh!

Nicolas-Peiffer Jun 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Nicolas-Peiffer commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related

Tests

Uh oh!

spencerpogo Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Nicolas-Peiffer Jun 22, 2026

Choose a reason for hiding this comment

Uh oh!

spencerpogo Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Nicolas-Peiffer Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

spencerpogo Jun 16, 2026

Choose a reason for hiding this comment

Uh oh!

Nicolas-Peiffer Jun 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Nicolas-Peiffer commented Apr 22, 2026 •

edited

Loading