Detailed description

Client session management with HSM.

Functions

void Connect (string User, string Password)

Establishes an encrypted connection with the HSM using the load balance.

Parameters

User	HSM User/Partition.
Password	User password.

void Connect (string Address, string User, string Password)

Connects to a specific HSM using an encrypted connection.

void Connect (string Address, string User, string Password, string Otp)

Connects to a specific HSM using an encrypted connection.

void ConnectWithLB (string User, string Password, string Otp)

void ConnectWithLB (string Address, string User, string Password, string Otp)

void Connect (string Address, string User, string Password, bool Encrypted, bool UseLoadBalance)

Establishes a connection with the HSM using all the API parameters.

void Connect (string Address, string User, string Password, string Otp, bool Encrypted, bool UseLoadBalance)

Establishes a connection with the HSM using all the API parameters.

void ConnectAnonymously (string Address)

Establishes an anonymous connection to the HSM.

void ConnectToken (string User, string Token)

Establishes a connection with the HSM using a temporary token issued by the user.

void ConnectToken (string Address, string User, string Token)

Establishes a connection with the HSM using a temporary token issued by the user.

void ConnectToken (string Address, string User, string Token, bool Encrypted, bool UseLoadBalance)

establishes a connection with the HSM using a temporary token issued by the user.

void Disconnect (bool flagClose)

Terminates the connection to the HSM.

void Disconnect ()

Terminates the connection to the HSM.

UInt32 getCID ()

Retrieves the CID (Correlation ID) of the current session. The CID makes it possible to relate the operation on the HSM client to the HSM logs. The CID is only available when there is an established session with the HSM, otherwise the value will be 0 (zero). This number is usually represented in hexadecimal.

Functions

◆ Connect() [1/5]

void Connect	(	string	User,
		string	Password
	)

inline

Establishes an encrypted connection to the HSM using the load balance settings.

Parameters

User	HSM User/Partition.
Password	User password.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

Examples: atoken.cs, basic_post_put_get_delete_pix.cs, batchsign.cs, bchain_ckd.cs, bchain_eddsa_sign.cs, bchain_get_address.cs, bchain_get_pub.cs, bchain_sign_hash.cs, block_object.cs, dukpt.cs, eft_gen_pin.cs, eft_gen_verify_cvv.cs, eft_verify_pinblock.cs, enc_dec.cs, export_import_tr31.cs, generate_hash.cs, generate_hmac.cs, generate_hmac_lau.cs, get_counter_info.cs, get_date.cs, import_export_pkcs12.cs, list_association.cs, oath.cs, post_put_get_delete_pix.cs, read_file.cs, rsa_enc_dec. cs, sign_check_jws.cs, sign_hash.cs, sign_verify_dict.cs, sign_verify_pix.cs, signxml.cs, spb.cs, spb_file_cip.cs, spb_import_activate.cs and tokenization.cs.

◆ Connect() [2/5]

void Connect	(	string	Address,
		string	User,
		string	Password
	)

inline

Connects to a specific HSM using an encrypted connection.

Parameters

Address	IP address of the HSM.
User	HSM User/Partition.
Password	User password.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

Notes: This API uses the IP entered to establish the connection. If load balancing is used, the IP entered will be ignored.

◆ Connect() [3/5]

void Connect	(	string	Address,
		string	User,
		string	Password,
		string	Otp
	)

inline

Connects to a specific HSM using an encrypted connection.

Parameters

Address	IP address of the HSM.
User	HSM User/Partition.
Password	User password.
Otp	OTP generated by the user.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

Notes: This API uses the IP entered to establish the connection. If load balancing is used, the IP entered will be ignored.

◆ ConnectWithLB() [1/2]

void ConnectWithLB	(	string	User,
		string	Password,
		string	Otp
	)

inline

Obsolete:: Use Connect().

◆ ConnectWithLB() [2/2]

void ConnectWithLB	(	string	Address,
		string	User,
		string	Password,
		string	Otp
	)

inline

Obsolete:: Use Connect().

◆ Connect() [4/5]

void Connect	(	string	Address,
		string	User,
		string	Password,
		bool	Encrypted,
		bool	UseLoadBalance
	)

inline

Establishes a connection with the HSM using all the API parameters.

Parameters

Address	IP address of the HSM.
User	HSM user.
Password	HSM user password.
Encrypted	Indicates whether the data transmitted during this session will be encrypted.
UseLoadBalance	Indicates whether the load balance settings will be used or not. If this value is set to true, the Address field will be ignored.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

◆ Connect() [5/5]

void Connect	(	string	Address,
		string	User,
		string	Password,
		string	Otp,
		bool	Encrypted,
		bool	UseLoadBalance
	)

inline

Establishes a connection with the HSM using all the API parameters.

Parameters

Address	IP address of the HSM.
User	HSM user.
Password	HSM user password.
Otp	OTP generated by the user.
Encrypted	Indicates whether the data transmitted during this session will be encrypted.
UseLoadBalance	Indicates whether the load balance settings will be used or not. If this value is set to true, the Address field will be ignored.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

◆ ConnectAnonymously()

void ConnectAnonymously ( string Address )

inline

Establishes an anonymous connection to the HSM.

Parameters

Address IP address of the HSM.

Exceptions

Dinamo.Hsm.DinamoException Launched when an error occurs.

Examples: m_of_n.cs.

◆ ConnectToken() [1/3]

void ConnectToken	(	string	User,
		string	Token
	)

inline

Establishes a connection with the HSM using a temporary token issued by the user.

Parameters

User	HSM user.
Token	Token value

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

Examples: atoken.cs.

◆ ConnectToken() [2/3]

void ConnectToken	(	string	Address,
		string	User,
		string	Token
	)

inline

Establishes a connection with the HSM using a temporary token issued by the user.

Parameters

Address	IP address of the HSM.
User	HSM user.
Token	Token value

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

◆ ConnectToken() [3/3]

void ConnectToken	(	string	Address,
		string	User,
		string	Token,
		bool	Encrypted,
		bool	UseLoadBalance
	)

inline

establishes a connection with the HSM using a temporary token issued by the user.

Parameters

Address	IP address of the HSM.
User	HSM user.
Token	>Token value
Encrypted	Indicates whether the data transmitted during this session will be encrypted.
UseLoadBalance	Indicates whether the load balance settings will be used or not. If this value is set to false, the Address field will be used.

Exceptions

Dinamo.Hsm.DinamoException Posted when a user access or validation error occurs.

◆ Disconnect() [1/2]

void Disconnect ( bool flagClose )

inline

Terminates the connection to the HSM.

Parameters

flagClose Determines whether the session will be physically closed, or only released in the local cache.

Examples: atoken.cs, basic_post_put_get_delete_pix.cs, batchsign.cs, bchain_ckd.cs, bchain_eddsa_sign.cs, bchain_get_address.cs, bchain_get_pub.cs, bchain_sign_hash.cs, block_object.cs, dukpt.cs, eft_gen_pin.cs, eft_gen_verify_cvv.cs, eft_verify_pinblock.cs, export_import_tr31.cs, generate_hash.cs, generate_hmac.cs, generate_hmac_lau.cs, get_counter_info.cs, get_date.cs, import_export_pkcs12.cs, m_of_n.cs, oath.cs, post_put_get_delete_pix.cs, read_file.cs, rsa_enc_dec.cs, sign_hash.cs, signxml.cs, spb.cs, spb_file_cip.cs, spb_import_activate.cs and tokenization.cs.

◆ Disconnect() [2/2]

void Disconnect ( )

inline

Terminates the connection to the HSM.

◆ getCID()

UInt32 getCID ( )

inline

Retrieves the CID (Correlation ID) of the current session. The CID makes it possible to relate the operation on the HSM client to the HSM logs. The CID is only available when there is an established session with the HSM, otherwise the value will be 0 (zero). This number is usually represented in hexadecimal.

Return: CID.

Exceptions

DinamoException Throws exception in case of error.