Client Component Configuration Parameters

Configure HSM parameters.

Following are the HSM configuration parameters and its descriptions:

SSL Parameter Description
certificate Absolute/relative file path to the user certificate signed by Partition Owner using PO key and partitionOwnerCert.pem (cert-c).
pkey Absolute/relative file path to the private key file used in SSL connection to HSM server (pkey-c).
CApath Absolute/relative file path to the CA certs that are used by oci hsm client to verify the HSM partition SSL connection. These certificates are bundled inside the client RPM package.
owner_cert_path Absolute or relative file path of the partitionOwnerCert.pem.

Following are the HSM configuration client parameters and its descriptions:

Client Parameter Description
daemon_id Provide identification (ID) to the clients. if you're running many clients on the same host.
reconnect_attempts

Number of attempts taken by the client to reconnect with the server after connectivity is lost between client and server.

-1 value makes the server retry connection for an infinite number of times.

Supported values: -1 to 3

reconnect_interval Time interval (in seconds) taken by the client to reconnect with the disconnected server.

Supported values: 1 to 10

reconnect_interval_count Number of times client attempts to execute a command (Optional). Default value is 3.

Supported values: 0 to 3

command_retry_attempt_time Duration of attempts for the client to run a command (Optional). Default value is 3.

Supported values: 0 to 10

Following are the OCI HSM mutual authentication parameters and its descriptions:

Mutual Authentication Parameter Description
e2e_mutual_auth_cert_path Path to the certificate used to establish an end-to-end connection.
e2e_mutual_auth_cert_pkey

Path to the private key used to establish an end-to-end connection.

Following are the OCI HSM server parameters and its descriptions:

Server Parameter Description
hostname DNS of the HSM Cluster.
port Port of the HSM Cluster.

Following are the OCI HSM logging parameters and its descriptions:

Logging Parameter Description
log_level Defines the log severity in the log file. Logs become more detailed as the level setting goes from ERROR to INFO to DEBUG.
logfiles_location Absolute path to the log directory.