Scroll to navigation

P11KMIP.CONF(5) openCryptoki P11KMIP.CONF(5)

NAME

p11kmip.conf - Configuration file for the p11kmip command.

DESCRIPTION

The p11kmip tool uses the configuration file /etc/opencryptoki/p11kmip.conf to read information about how to connect to a KMIP server and interact with a PKCS #11 token repository.

A custom file path can be set with the environment variable P11KMIP_CONF_FILE. If the environment variable is not set, then the user-specific file ~/.p11kmip.conf is checked first. If that file is also absent, the global /etc/opencryptoki/p11kmip.conf config file is read. If this file is also unavailable, an error message is displayed.

SYNTAX

There are two sections in the configuration. Both consist of a title, brackets, and a set of key-value pairs.

The first section configures the connection to the KMIP server. It contains the following keywords: host, tls_client_cert, tls_client_key, wrap_key_format, wrap_key_algorithm, wrap_key_size, wrap_padding_method, wrap_hashing_algorithm.

Example:

kmip {
host = "0.0.0.0:5696"
tls_client_cert = "/tmp/certs/client_certificate_jane_doe.pem"
tls_client_key = "/tmp/certs/client_key_jane_doe.pem"


wrap_key_format = "PKCS1"
wrap_key_algorithm = "RSA"
wrap_key_size = 2048
wrap_padding_method = "PKCS1.5"
wrap_hashing_algorithm = "SHA-1" }

Must be specified in the format "hostname[:port]", where "hostname" may be an IPv4 address, IPv6 address, or a symbolic hostname, and "port" may optionally specify a non-standard port number. If "port" is not specified, 5696 is used as the default.

Must specify the path to a PEM format file containing the client certificate used for TLS authentication to the KMIP server.

Must specify the path to a PEM format file containing the client private key used for TLS authentication to the KMIP server.

Required. Specifies the format used to transmit the wrapping key. Valid values:
  • PKCS1 - PKCS #1 encoded RSA public key
  • PKCS8 - PKCS #8 encoded public key
  • TransparentPublicKey - transparent RSA public key structure

Required. Specifies the algorithm used for key wrapping. Valid values:
•
RSA - currently the only supported wrapping algorithm

Required. An unquoted integer specifying the length in bits of the wrapping key. This value must match the length of the actual wrapping and unwrapping key provided when the tool is invoked.

Required. Specifies the padding method used during the key wrap. Valid values:
  • PKCS1.5 - PKCS #1 v1.5 padding
  • OAEP - Optimal Asymmetric Encryption Padding

Optional. Specifies the hashing algorithm used by the padding method. Required only when wrap_padding_method is OAEP; ignored and may be absent for all other padding methods. Valid values when wrap_padding_method is OAEP:
  • SHA-1
  • SHA-256

The second section configures interaction with the PKCS #11 token repository. It contains the following keyword: slot .

Example: pkcs11 {
slot = 0 }

An unquoted integer specifying the PKCS #11 slot number to use.

Of these attributes, the host , tls_client_cert , tls_client_key attributes of the kmip section and the slot attribute of the pkcs11 section may be absent from the file if specified by an environment variable or command option.

The attributes wrap_key_format, wrap_key_algorithm, wrap_key_size, and wrap_padding_method can only be specified in the configuration file; there are no corresponding environment variables or command-line options. When a configuration file is present, all four of these attributes are required. The wrap_hashing_algorithm attribute is optional, but required when wrap_padding_method is "OAEP". Attributes and groups may be specified in any order within the configuration file.

Notes

The pound sign ('#') is used to indicate a comment up to and including the end of line.

SEE ALSO

p11kmip(1)
August 2026 3.28.0