Managing the Navigator Key HSM Service

Key HSM includes a command line tool for managing basic server operations. You can also manage logging, audits, and keys.

Using the keyhsm service

You can use the keyhsm service for basic server operations:
$  sudo service keyhsm
keyHsm service usage:
    setup <hsm name> - set up a new connection to an HSM
    trust <path>     - add a trusted client certificate
    validate         - validate that Key HSM is properly configured
    settings         - display the current server configuration
    start            - start the Key HSM proxy server
    status           - show the current Key HSM server status
    stop|shutdown    - force Key HSM server to shut down
    reload           - reload the server (without shutdown)

The reload command causes the application to restart internal services without ending the process itself. If you want to stop and start the process, use the restart command.

Logging and Audits

The Navigator Key HSM logs contain all log and audit information, which by default are stored in the /var/log/keyhsm directory.

You can configure the maximum log size (in bytes) and maximum number of log files to retain by adding or editing the following entries in the /usr/share/keytrustee-server-keyhsm/conf/logback.xml file.

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

            <pattern>%date %level %logger: %msg%n</pattern>

        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

    <root level="info">
        <appender-ref ref="FILE" />
The default log level is info. The filename is /var/log/keyhsm/keyhsm.log, the max file size is 10MB, and the last 10 rolled log files will be retained.

Key Naming Convention

To ensure you can manage keys (for example, delete a key), you must understand the naming convention for keys. Keys adhere to the following naming convention: handle name-uuid-date, which means if you know the key name and date, you can make modifications to it.

The following example shows the key nomenclature in the context of a key list query on Luna HSM:
[root@user 64]# cmu list
Please enter password for token in slot 1 : **********