pkcs11config configuration utility reference

checkgrant options

Checks if the system has a valid grant and displays grant information.

--days:<d>

Grant is not considered valid if it expires within <d> days.

--machine

Checks the local machine store rather than the current user store.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

Return code 0 indicates a grant has been configured

Return code 1 indicates a missing or expired grant

This command is designed to allow automated systems, such as a builder or monitoring system, to programmatically check if the grant is still valid in preflight checks.

getcertificate options

Retrieves a certificate and/or certificate chain. Use the ListCertificates command to obtain list of available certificates.

If the --chainfile and --file argument specify the same filename, the certificate will be stored first in the file, followed by the chain and PEM format will be used, ignoring any --format setting.

This command is useful when using signing applications that require the certificate in a file on the signing server. See also getpublickey.

--chainfile:<file>

Output file for the certificate chain (PEM format only).

--file:<file>

Output file for the certificate.

--format:<PEM|DER>

Output file format (Default: PEM).

--label:<label>

Label of the certificate to retrieve.

--rootfirst

Writes the root first when writing the chain. The default is to write the intermediate first.

--split

Splits the chain into separate files, one certificate per file. Inserts a number before the extension, if one is provided.

--verbose

Outputs subject and issuer before the PEM block.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

getgrant options

Obtains a new grant if no refresh token exists. If one exists, the existing grant will be renewed. To always obtain a new grant, use --force. If --force is used while having an existing refresh token, the existing grant will first be revoked.

By using the --authurl and --hsmurl switches with this option, initial setup can be done by just using getgrant. See the following example:

pkcs11config getgrant --force --username=sample-user --password=Passw0rd --hsmurl=https://TPP_Server_URL/vedhsm/ --authurl=https://TPP_Server_URL/vedauth/

--authurl:<url>

Sets the authentication server URL. This can also be set using the seturl option.

--autologon

Requests a new grant using credentials that were used to log on to the local system. Client and server must be in the same domain.

--force

Forces getting a new get grant; never refreshes.

--hsmurl:<url>

HSM backend URL. This can also be set using the seturl option.

--password:<pw>

Authentication password.

--proxymode:<mode>

Enables or disables using a proxy server for communication. Available modes: auto, disable, url.

--proxyurl:<url>

URL of the proxy server to use. Implies --proxymode:<url>.

--username:<user>

Authentication username.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

grant options

Grant-related functions. Use -h with the options to get option-specific help. The getgrant, revokegrant, and checkgrant commands are shortcuts for this command.

--check

Checks if the system has a valid grant.

--get

Obtains a new grant.

--machine

Stores the configuration values to the machine configuration store rather than the user configuration store.

--revoke

Revokes an existing grant.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

jwtsign options

Sign a token for use with JWT.

listobjects options

Queries the HSM backend server and returns a list of certificates and public keys from all available environments.

This command is useful in conjunction with getpublickey and getcertificate. It can be used to obtain the --label name they require.

--env:<env-list>

Show only Environments of types specified in <env-list>. Available types are all, apple, cert, gpg, net, keypair, and key.

--grouped

Group related objects

--table

Output in table format.

--type:<type-list>

Show only objects of types specified in <type-list>. Available types are all, priv, pub, cert, and key.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

option options

Manages configuration options. Provides direct management of all configuration options, including options set through other commands, such as seturl.

Creates filters to apply when using listobjects. Example filter:

pkcs11config option --name:"Filter Name" --value:"<environment-label>"

--clear

Clears the value for <name>.

--name:<name>

Name to set, show, or clear.

--show

Displays the value for <name> or all if no -name specified.

--value:<value>

Value to set.

--machine

Stores the configuration values to the machine configuration store rather than the user configuration store. When combined with --csp, the CSP machine store is modified rather than the PKCS#11 store. The machine store is located at /etc/venafi/libhsm.conf.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

proxy options

--mode:<mode>

Enables or disables using a proxy server for communication. Available modes:

auto: Uses the system proxy settings. This is the default.

disable: Disables the proxy for pkcs11config. Will bypass any system proxy settings.

url: Uses a specified URL. Use --url:<url> to set the proxy URL.

--url:<url>

URL of the proxy server to use. Implies --mode:url.

--show

Displays current mode and, if applicable, the proxy URL.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

revokegrant options

Revokes any configured grants.

--clear

Deletes a configuration file (or registry entry on Windows) created by a LIBHSMINSTANCE environment variable. For an example, see Using libhsm with multiple grants concurrently.

--force

Forces the grant to be revoked.

--machine

Revokes the local machine grant rather than the current user grant.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

setgrant options

seturl options

Configures the virtual HSM and authentication server URLs. This command is useful to change existing server URLs if the authentication server or virtual HSM URLs change.

--authurl:<url>

URL of the Trust Protection Platform authentication server.

--hsmurl:<url>

URL of the Trust Protection Platform virtual HSM server.

--machine

Stores the configuration values to the machine configuration store rather than the user configuration store.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

storekey options

--contex:<ctx>

The context of the key to store, if the environment holds multiple keys.

--force

Accept all warning prompts.

--label:<label>

The label of the target environment.

--password:<pw>

The password needed to decrypt the private key file.

--private:<file>

The file containing the private key (PFX/P12 or PEM format). If uploading a PEM, the Private Key and Certificate must be in separate files.

--public:<file>

The file containing the public key or certificate (PEM format). If uploading a PEM, the Private Key and Certificate must be in separate files.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

sync options

Synchronizes the certificate store with the certificates available for the user. No additional options.

trace options

Manages settings for diagnostics and troubleshooting. For example usage of this command, see Enabling and disabling PKCS#11 trace logging.

--console

Enable/disable applies to console.

--disable

Disables console or file tracing.

--enable

Enables console or file tracing.

--file:<file>

Sets the trace file path and filename prefix.

--module:<file>

Sets the location of the PKCS#11 library.

--log

Enable/disable applies to trace log.

--output:<out>

Sets the console output target. Can be stderr or stdout.

--show

Shows existing trace settings.

--pkcs11:<file>

Sets the PKCS#11 API trace file path and filename prefix.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

trust options

Manages certificate trust store. Trust is required to be able to communicate with the authentication server and HSM backend. When trust is established, the certificates are stored in the in the user configuration store by default.

When trust is established on Windows, the certificates are stored in CAPI. Trust on Windows only needs to be established if the virtual HSM or authentication server are using a private certificate the Windows system doesn’t already trust (such as through corporate certificate management). When trust is established on non-Windows systems, the certificates by default are stored in ~/.libhsmtrust, unless the user has changed the location via the “CA Trust” configuration value.

--authurl:<url>

Authentication server URL to retrieve certificates from.

--check

Checks if configured HSM backend is trusted.

--delete:<name>

Delete certificate with subject containing <name>.

--file:<file>

PEM certificate file to import certificates from.

--force

Forces import without confirmation.

--hsmurl:<url>

HSM backend URL to retrieve certificates from.

--show

Shows existing certificates in trust store.

--machine

Stores the configuration values to the machine configuration store rather than the user configuration store. When combined with --csp, the CSP machine store is modified rather than the PKCS#11 store.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

update options

Updates CodeSign Protect clients. Requires the Code Signing Client Distribution component be installed on the Trust Protection Platform server.

--arch:<arch>

Override the detected architecture. Available values: x86_64, x86_32, arm64.

--latest

Download and install the latest available version, unless it is already installed.

--our:<path>

Store the package in the specified output directory and do not install it.

--type:<type>

Override the detected package type. Available types: msi, rpm, deb, dmg.

--updateurl:<url>

Client update server URL.

--version:<ver>

Download and install the specified version.

verify options

Verifies a file signature.

--file:<file>

File to verify.

--input:<file>

Filename that holds the signature.

--label:<label>

Label of the key to use for verification.

--gpg

Use VenafiSCD to modify the GnuPG configuration store.

--csp

Modify the CSP configuration store (Windows only).

version options

Displays the version of the pkcs11config utility and the build timestamp. No additional options.