How to log in and log out of HSM - Key Management Service

This topic explains the procedures for logging in to and logging out of HSM using the loginHSM and logoutHSM commands.

Feature description

The loginHSM command initiates a session with HSM, requiring the user's credentials.
The logoutHSM command terminates the current user's session.

Important

In contrast to loginHSM and logoutHSM found in hsm_mgmt_tool, key_mgmt_tool solely supports the CU operation for user login.

Syntax

Enter parameters as specified in the syntax below. For details on the parameters, refer to Parameters.

loginHSM -u <user type>
         { -p | -hpswd } <password>
         -s <username>
         
logoutHSM

Important

Parameters must be entered in the order outlined in the syntax.

Examples

Logging in to HSM

Command:  loginHSM -u CU -s crypto_user -p user123

       	Cfm3LoginHSM returned: 0x00 : HSM Return: SUCCESS

       	Cluster Status:
       	Node id 0 status: 0x00000000 : HSM Return: SUCCESS

Logging out of HSM

Command:  logoutHSM

       	Cfm3LogoutHSM returned: 0x00 : HSM Return: SUCCESS

       	Cluster Status:
       	Node id 0 status: 0x00000000 : HSM Return: SUCCESS

Parameters

Parameter name	Description	Required	Valid values
-f	Specifies the user type for login.	Yes	CU
-s	Specifies the username.	Yes	No Special Requirements
{-p \| -hpswd }	User password, this parameter is a string containing 7 to 32 characters, and the value is case-sensitive. The password will be displayed in plaintext when typed. To hide the password, use the -hpswd parameter instead of the password and follow the prompts.	Yes	No Special Requirements