Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds verification commands to openssl calls #147

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adds verification commands to openssl calls #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/documentation/crypto-providers/cryptoki.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,14 @@ openssl dgst -engine pkcs11 -keyform engine -sign "pkcs11:id=$ProjectSlug/$Signi
>
> The following digests are supported: `sha256`, `sha384`, `sha512`

**Verification:**
To verify the signature, run the following command:

~~~ powershell
# Extract the public key of the certificate to a separate file first
openssl dgst -verify "/path/to/public_key.pem" -sha256 -signature "artifact.sig" "artifact.bin"
~~~

##### openssl pkeyutl

The _[pkeyutl][openssl-pkeyutl]_ command performs low-level cryptographic operations, such as signing.
Expand Down Expand Up @@ -224,6 +232,13 @@ Sample: sign the hash code in `artifact.hash.bin` using PSS padding, write the s
openssl pkeyutl -engine pkcs11 -keyform engine -inkey "pkcs11:id=$ProjectSlug/$SigningPolicySlug;type=private" -sign -in "artifact.hash.bin" -out "artifact.sig" -pkeyopt digest:sha256 -pkeyopt rsa_padding_mode:pss -pkeyopt rsa_pss_saltlen:-1 -pkeyopt rsa_mgf1_md:sha256
~~~

**Verification:**
To verify the signature, run the following command:

~~~ powershell
openssl pkeyutl -verify -certin "/path/to/certificate.der" -inform DER -pkeyopt ... (same as above) -in "artifact.sig" -sigfile "artifact.sig"
~~~

#### openssl cms

The _[cms][openssl-cms]_ command can be used to create embedded S/MIME or detached PEM/DER signatures. It uses the Cryptographic Message Syntax format (CMS, formerly known as PKCS#7).
Expand All @@ -240,6 +255,19 @@ Sample: sign the file `artifact.bin` using `certificate.pem`, write the detached
openssl cms -engine pkcs11 -signer "certificate.pem" -inkey "pkcs11:id=$ProjectSlug/$SigningPolicySlug;type=private" -keyform engine -sign -binary -in "artifact.bin" -noattr -out "artifact.sig" -outform PEM
~~~

**Verification:**
To verify the signature, run the following command:

~~~ powershell
openssl cms -verify -purpose codesign -in "artifact.sig" -out "restored.bin"
~~~

{:.panel.warning}
> **OpenSSL CMS verification**
>
> * Prior to OpenSSL 3.2, the `-purpose any` flag has to be used
> * When signing with a certificate that is not trusted on the respective platform, the `-CAFile ./path/to/root.cer` has to be provided

## osslsigncode {#osslsigncode}

_[osslsigncode]_ is a tool that allows applying Windows Authenticode signatures on Linux systems using OpenSSL. Accordingly, it also requires an OpenSC pkcs11 OpenSSL engine installation. See the [OpenSSL](#openssl) section for details.
Expand Down