zpcprovider for sign/verify (ecdsa/eddsa)#41

Open

holger-dengler wants to merge 33 commits into

opencryptoki:mainfrom

holger-dengler:provider-sign

Contributor

holger-dengler commented Apr 10, 2026

This PR requires PR #40.

This PR adds OpenSSL provider support for libzpc. This first version covers the main functionality for store, keymgmt, sign/verify and decoder support.

As the series add a lot of new code, it is split into many commits to make the review (hopefully) a bit easier.

ToDo:

public key support for store/decoder
alloc/free needs some debugging

Restriction:

the tests uses hard-coded public keys, so running tests on other machines require code changes in tprovider.c.
the provider only supports uv origins, so testing is limited to SEL environments.

holger-dengler requested review from fcallies and ifranzki

April 10, 2026 15:05

Contributor

ifranzki commented Apr 13, 2026

Are you looking at the Travis build failures? You might need to build OpenSSL from source to have a 3.5.0 version to build against.

Contributor Author

holger-dengler commented Apr 13, 2026

Yes, a fix for the travis is in progress. It looks like travis only provides 3.0 out of the box. So I'll build my own. At least 3.5, better 4.0.

holger-dengler commented

View reviewed changes

src/uri.c Outdated

ifranzki reviewed

View reviewed changes

src/provider.c Outdated

ifranzki reviewed

View reviewed changes

src/object.h Outdated

ifranzki reviewed

View reviewed changes

src/signature.c Outdated

ifranzki reviewed

View reviewed changes

src/signature.c

holger-dengler force-pushed the provider-sign branch 2 times, most recently from 7c72889 to 1659e06 Compare

May 2, 2026 15:53

Contributor Author

holger-dengler commented May 2, 2026 •

edited

Loading

The update contains:

re-order of the commits (move test to the end of the series)
rework of signature/eddsa
pick review comments
minor fixes

holger-dengler requested a review from ifranzki

May 2, 2026 16:10

holger-dengler force-pushed the provider-sign branch from 9258c6f to 6d1b3d8 Compare

May 2, 2026 17:44

Contributor Author

holger-dengler commented May 2, 2026

Another update (force push) to remove the merge conflicts and add a fix for travis.

holger-dengler mentioned this pull request

new tool zpckey for UV key origins #43

Open

Contributor

ifranzki commented May 4, 2026

I would suggest to also add tests that utilize the openssl application to use protected key origins. For example, creating/signing a certificate with a protected key origin specified via URI or PEM using openssl x509 -in cert.csr -out cert.pem -req -signkey <protected key origin> -days 1001.

ifranzki reviewed

View reviewed changes

CMakeLists.txt Outdated

Contributor Author

holger-dengler commented May 4, 2026

I would suggest to also add tests that utilize the openssl application to use protected key origins. For example, creating/signing a certificate with a protected key origin specified via URI or PEM using openssl x509 -in cert.csr -out cert.pem -req -signkey <protected key origin> -days 1001.

I plan to rework the test. tprovider will be renamed (t_provider) and changed to do only the lookup for the provider components. All key-related functional test will be moved to a new t_openssl test script, which uses openssl to create keys and call the functions. such a split is required to run the tests in a CI.

ifranzki reviewed

View reviewed changes

src/provider.c Outdated

ifranzki reviewed

View reviewed changes

src/provider.c Outdated

ifranzki reviewed

View reviewed changes

src/provider.c Outdated

ifranzki reviewed

View reviewed changes

src/provider.c Outdated

ifranzki reviewed

View reviewed changes

src/keymgmt.c

ifranzki reviewed

View reviewed changes

src/keymgmt.c

ifranzki reviewed

View reviewed changes

src/keymgmt.c

Contributor

ifranzki commented May 5, 2026

I would move the provider sources into a subdirectory, e.g. src/provider/. Maybe even move the library sources into a subdirectory e.g. src/lib/.

Contributor Author

holger-dengler commented May 5, 2026

I would postpone the source code restructuring until the provider transition is done (symmetric cipher, secure-key origins etc). There will be eventually also some removal of no longer used code.

ifranzki reviewed

View reviewed changes

openssl.conf.in

holger-dengler force-pushed the provider-sign branch from 6d1b3d8 to 690f619 Compare

May 11, 2026 07:28

holger-dengler added 23 commits

May 30, 2026 15:25


          cmake: Add zpcprovider build target

4b95331

Add a module build target for the zpcprovider. Other than shared
objects, the provider module has no so-name and also no API
versioning.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add provider-specific key object

93c7e9f

The provider-specific key object structure is shared between the
provider components and references to the internal zpc-key
structure(s).

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate provider-specific key object

b603a66

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add hbkzpc-URI parser

49ee96c

A hbkzpc-URI references a hardware-backed key origin. The parser
destructs the URI into key-value pairs.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Add uri build target

77b9be0

Add internal object build target for uri. The internal object can be
shared between targets.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add mapping helpers

83f4898

The mapping helpers provide mappings between e.g. algorithm strings
and algorithm-related values.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate mapping helpers

a9e8976

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add store-loader

01ef999

Introduce a store-loader for hbkzpc-URI based keys. The store-loader
creates a provider-specific key object and adds relevant information
from the URI.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate store-loader

0caef71

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add asymmetric key management

44d4134

Introduce a asymmetric key management to map the provider-specific key
object to a intern zpc-key.

Not supported:
- key generation
- key import

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate asymmetric key management

97373a5

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add algorithm-id helpers

d4ba262

Add helpers to generate DER-encoded algorithm-ids based on key and
digest information.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate algorithm-id helpers

c4d6916

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add signature algorithms

054f911

Add signature algorithms for sign/verify with ECDSA and EDDSA keys.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate signature algorithms

1a0afe9

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add tls-property helpers

6df41b7

Add the supported TLS properties for the zpcprovider.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate tls-property helpers

093a86a

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          asn1: Add ASN.1 module (definition and functions)

f7ff22a

The ASN.1 module provides DER en-/decoding for hbkzpc-URIs. These
functions are required for the decoder/encoder support.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Add ASN.1 build target

d4a5cf0

Add internal object build target for ASN.1 module. The internal object
can be shared between targets.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          provider: Add decoders for hbkzpc-URI

Add decoders for PEM and DER to support hbkzpc-URI files.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          cmake: Integrate decoder implementation

dbfddad

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          test: Add OpenSSL configuration template

378a3a8

To use the zpc functionality via the OpenSSL API, the zpcprovider has
to be defined in the OpenSSL configuration.

The build configures the template and creates a `openssl.cnf` file,
which can be used for test purposes. The configuration file will be
created in the build output folder.

The build also configures a second template and creates a
configuration drop-in file `zpcprovider.cnf`. This file can be
included in existing OpenSSL configuration files.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>


          dbg: Add gdb-scripts for zpcprovider

be9e7a9

The scripts set breakpoints for to all zpcprovider functions, which
are called by the OpenSSL provider API (dispatch functions). Each
zpcprovider component has its own gdb-script. Sourcing multiple
scripts is possible.

Signed-off-by: Holger Dengler <dengler@linux.ibm.com>

holger-dengler force-pushed the provider-sign branch from 996860e to be9e7a9 Compare

June 1, 2026 05:45

Contributor Author

holger-dengler commented Jun 1, 2026

New PR versions:

Review comments for man pages
Buildfile cleanups
rework of compare API
misc

The review of hbkzpcprovider.conf.5 is still pending.

holger-dengler removed the request for review from fcallies

June 1, 2026 07:07

ifranzki reviewed

View reviewed changes

src/signature.c

+              static const OSSL_DISPATCH ed448_functions[] = {
+              	DISPATCH_DEFN(SIGNATURE, NEWCTX,               ed448_newctx),
+              	DISPATCH_DEFN(SIGNATURE, FREECTX,              sig_freectx),
+              	DISPATCH_DEFN(SIGNATURE, DUPCTX,               sig_dupctx),

Contributor

ifranzki Jun 1, 2026

Is DUPCTX intentionally only added here (for Ed448), but not for Ed25519 and ECDSA above?

Contributor Author

holger-dengler Jun 1, 2026

Good catch. Fixed.

ifranzki reviewed

View reviewed changes

src/signature.c


		DISPATCH_END,
		};

Contributor

ifranzki Jun 1, 2026

You might also want to implement the query_key_types function for all 3 signature methods.
This function should just return an NULL terminated array of strings with one element "EC", "ED25519" and "ED448" respectively. See default provider implementation.

Not sure how important this is, but evp_pkey_signature_init() does call it if its available.

Contributor Author

holger-dengler Jun 1, 2026

It looks like the dispatch function has been introduced with openssl 3.4. I'll look into it.

ifranzki reviewed

View reviewed changes

src/signature.c

+              	OPENSSL_free(sctx);
+              }
+              #if OPENSSL_VERSION_NUMBER < 0x30100000L

Contributor

ifranzki Jun 1, 2026

Better use #if OPENSSL_VERSION_PREREQ(3, 1) this is easier to read.

Contributor Author

holger-dengler Jun 1, 2026

Ok, but I have to invert the check. Version >= v3.1 provides already the MD_CTX_dup() function.

Contributor

ifranzki Jun 1, 2026

yea, use #if !OPENSSL_VERSION_PREREQ(3, 1) then :-)

ifranzki reviewed

View reviewed changes

src/ecc_key.c

+              	/* protected key compare */
+              	if (ec_key1->key_set && ec_key2->key_set &&
+              	    memcmp(ec_key1->prot.protkey, ec_key2->prot.protkey,

Contributor

ifranzki Jun 1, 2026 •

edited

Loading

Bob recommends to use memcmp_consttime() here and also above for comparing the public key to not leak any timing... Not sure if its that critical, since both the public key and a protected key can't really leak any sensitive information. Nevertheless, if its that easy to just use memcmp_consttime() then maybe its better to do it.

Contributor Author

holger-dengler Jun 1, 2026

Hm, I'm not aware of memcmp_consttime(). It seems not to be part of glibc. But I can use CRYPTO_memcmp() from OpenSSL instead.

Contributor

ifranzki Jun 1, 2026

Its part of the libzpc source code. libzpc uses it at several places.
See:

libzpc/src/misc.h

Line 28 in dcdc591

int memcmp_consttime(const void *, const void *, size_t);

Contributor

ifranzki Jun 1, 2026

Seems to be implemented in https://github.com/opencryptoki/libzpc/blob/main/src/misc_asm.S

Contributor Author

holger-dengler Jun 1, 2026

Oh, I missed that implementation.

Contributor Author

holger-dengler Jun 1, 2026

Fixed.

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

Labels

None yet