systemd-keyutil

systemd

systemd-keyutil

Perform various operations on private keys and X.509 certificates

systemd-keyutil

OPTIONS

COMMAND

Description

systemd-keyutil can be used to perform various operations on private keys and X.509 certificates.

Commands

validate
Checks that we can load the private key and certificate specified with --private-key= and --certificate= respectively.

As a side effect, if the private key is loaded from a PIN-protected hardware token, this command can be used to cache the PIN in the kernel keyring. The $SYSTEMD_ASK_PASSWORD_KEYRING_TIMEOUT_SEC and $SYSTEMD_ASK_PASSWORD_KEYRING_TYPE environment variables can be used to control how long and in which kernel keyring the PIN is cached.

extract-public
This commands prints the public key in PEM format extracted from either the certificate given with --certificate= or the private key given with --private-key=.

extract-certificate
This command prints the X.509 certificate in PEM format extracted from the certificate given with --certificate=. This is useful when loading a certificate from an OpenSSL provider (e.g. a hardware token) and wanting to output a standalone PEM certificate that can be used without the provider.

pkcs7
This command embeds the PKCS#1 signature (RSA) provided with --signature= in a PKCS#7 signature using the certificate given with --certificate= and writes it to the file specified with --output= in PKCS#7 format (p7s). If --content= is provided it is included in the p7s, otherwise a "detached" signature is created. The --hash-algorithm= option, which defaults to SHA256, specifies what hash algorithm was used to generate the signature.

Options

The following options are understood:

--private-key=PATH/URI; --private-key-source=TYPE[:NAME]; --certificate=PATH; --certificate-source=TYPE[:NAME]
Set the private key and certificate to use. The --certificate= option takes a path to a PEM encoded X.509 certificate or a URI that's passed to the OpenSSL provider configured with --certificate-source. The --certificate-source takes one of file or provider, with the latter being followed by a specific provider identifier, separated with a colon, e.g. provider:pkcs11. The --private-key= option can take a path or a URI that will be passed to the OpenSSL engine or provider, as specified by --private-key-source= as a type:name tuple, such as engine:pkcs11.

--signature=PATH
Input PKCS#1 signature for the pkcs7 command.

--content=PATH
Input data that corresponds to the PKCS#1 signature for the pkcs7 command, used for generating inline (i.e. non-"detached") PKCS#7 signatures.

--hash-algorithm=ALGORITHM
Hash algorithm used to generate the PKCS#1 signature for the pkcs7 command. This should be a valid openssl digest algorithm; use openssl list -digest-algorithms to see a list of valid algorithms on your system. Defaults to SHA256.

--output=PATH
Output PKCS#7 signature for the pkcs7 command.