Skip to content

README: document cloud PKCS#11 modules (Certum SimplySign example) - #501

Merged
mtrojnar merged 1 commit into
mtrojnar:masterfrom
Le-Syl21:docs/cloud-pkcs11-module
Aug 26, 2026
Merged

README: document cloud PKCS#11 modules (Certum SimplySign example)#501
mtrojnar merged 1 commit into
mtrojnar:masterfrom
Le-Syl21:docs/cloud-pkcs11-module

Conversation

@Le-Syl21

Copy link
Copy Markdown
Contributor

Pull Request Type

  • Documentation

Related Issue

Issue number: #498

Current Behavior

The README documents PKCS#11 use with a local token (SoftHSM, OpenSC) through
either the engine or the provider. Cloud signing services that ship their own
PKCS#11 module work the same way, but nothing says so, so it is not obvious
that osslsigncode already covers them.

New Behavior

A short section on cloud PKCS#11 modules, following the existing engine and
provider sections, with Certum SimplySign via ssign-pkcs11 as the example.

Scope of Changes

One new section in README.md, no code. It notes explicitly that ssign-pkcs11 is
an independent third-party project, not affiliated with or endorsed by
osslsigncode. Both the -provider and -engine forms are shown, plus the fact
that either may be omitted since osslsigncode tries pkcs11prov first and
falls back to the libp11 pkcs11 engine.

I am the author of ssign-pkcs11, so treat the wording as a proposal — happy to
cut it down, drop the project link, or move it to osslsigncode.md instead.

Testing

  • Manual testing

Checked against osslsigncode 2.13 / OpenSSL 3.5.5 on Debian, with a real
Certum certificate: all three forms shown or mentioned here (-provider,
-engine, and neither) signed and verified a file end to end, using the same
pkcs11:type=cert / pkcs11:type=private URIs as in the examples.

Note the paths in the examples follow the /usr/lib64/... convention already
used in the surrounding sections rather than the Debian ones I tested with.

Additional Notes

No behaviour change; docs only.

License Declaration

  • I hereby agree to license my contribution under the project's license.

Add a section alongside the existing engine and provider ones, covering
PKCS#11 modules backed by a signing service's own HSM, with Certum
SimplySign via the third-party ssign-pkcs11 as the example. Shows both
the -provider and -engine invocations, and notes that either may be
omitted since osslsigncode tries pkcs11prov before the libp11 engine.
@mtrojnar
mtrojnar merged commit 944ca06 into mtrojnar:master Aug 26, 2026
10 checks passed
@Le-Syl21
Le-Syl21 deleted the docs/cloud-pkcs11-module branch August 26, 2026 13:06
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.

2 participants