Descripción detallada

Gestión de sesiones de cliente con HSM.

Funciones

void Conectar (cadena Usuario, cadena Contraseña)

Establece una conexión cifrada con el HSM utilizando el equilibrio de carga.

Parámetros

Usuario	Usuario/Partición HSM.
Contraseña	Contraseña de usuario.

void Conectar (cadena Dirección, cadena Usuario, cadena Contraseña)

Se conecta a un HSM concreto mediante una conexión cifrada.

void Conectar (cadena Dirección, cadena Usuario, cadena Contraseña, cadena Otp)

Se conecta a un HSM concreto mediante una conexión cifrada.

void ConnectWithLB (cadena Usuario, cadena Contraseña, cadena Otp)

void ConnectWithLB (cadena Dirección, cadena Usuario, cadena Contraseña, cadena Otp)

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

Establece una conexión con el HSM utilizando todos los parámetros de la API.

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

Establece una conexión con el HSM utilizando todos los parámetros de la API.

void ConectarAnónimamente (cadena Dirección)

Establece una conexión anónima con el HSM.

void ConnectToken (cadena Usuario, cadena Token)

Establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

void ConnectToken (cadena Dirección, cadena Usuario, cadena Token)

Establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

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

establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

void Desconectar (bool flagCerrar)

Finaliza la conexión con el HSM.

void Desconectar ()

Finaliza la conexión con el HSM.

UInt32 getCID ()

Recupera el CID (Correlation ID) de la sesión actual. El CID permite relacionar la operación en el cliente HSM con los registros del HSM. El CID sólo está disponible cuando existe una sesión establecida con el HSM; en caso contrario, el valor será 0 (cero). Este número suele representarse en hexadecimal.

Funciones

◆ Conectar() [1/5]

void Conectar	(	cadena	Usuario,
		cadena	Contraseña )

en línea

Establece una conexión cifrada con el HSM utilizando los ajustes de equilibrio de carga.

Parámetros

Usuario	Usuario/Partición HSM.
Contraseña	Contraseña de usuario.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

Ejemplos: 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 y tokenisation.cs.

◆ Conectar() [2/5]

void Conectar	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Contraseña )

en línea

Se conecta a un HSM concreto mediante una conexión cifrada.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario/Partición HSM.
Contraseña	Contraseña de usuario.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

Notas: Esta API utiliza la IP introducida para establecer la conexión. Si se utiliza el equilibrio de carga, se ignorará la IP introducida.

◆ Conectar() [3/5]

void Conectar	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Contraseña,
		cadena	Otp )

en línea

Se conecta a un HSM concreto mediante una conexión cifrada.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario/Partición HSM.
Contraseña	Contraseña de usuario.
Otp	OTP generado por el usuario.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

Notas: Esta API utiliza la IP introducida para establecer la conexión. Si se utiliza el equilibrio de carga, se ignorará la IP introducida.

◆ ConectarConLB() [1/2]

void ConectarConLB	(	cadena	Usuario,
		cadena	Contraseña,
		cadena	Otp )

en línea

Obsoleto: Utiliza Connect().

◆ ConectarConLB() [2/2]

void ConectarConLB	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Contraseña,
		cadena	Otp )

en línea

Obsoleto: Utiliza Connect().

◆ Conectar() [4/5]

void Conectar	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Contraseña,
		bool	Cifrado,
		bool	UseLoadBalance )

en línea

Establece una conexión con el HSM utilizando todos los parámetros de la API.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario de HSM.
Contraseña	Contraseña de usuario del HSM.
Cifrado	Indica si los datos transmitidos durante esta sesión serán encriptados.
UseLoadBalance	Indica si se utilizará o no la configuración de equilibrio de carga. Si este valor es verdadero, se ignorará el campo Dirección.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

◆ Conectar() [5/5]

void Conectar	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Contraseña,
		cadena	Otp,
		bool	Cifrado,
		bool	UseLoadBalance )

en línea

Establece una conexión con el HSM utilizando todos los parámetros de la API.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario de HSM.
Contraseña	Contraseña de usuario del HSM.
Otp	OTP generado por el usuario.
Cifrado	Indica si los datos transmitidos durante esta sesión serán encriptados.
UseLoadBalance	Indica si se utilizará o no la configuración de equilibrio de carga. Si este valor es verdadero, se ignorará el campo Dirección.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

◆ ConectarAnónimamente()

void ConectarAnónimamente ( cadena Dirección )

en línea

Establece una conexión anónima con el HSM.

Parámetros

Dirección Dirección IP del HSM.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error.

Ejemplos: m_de_n.cs.

◆ ConnectToken() [1/3]

void ConectarToken	(	cadena	Usuario,
		cadena	Ficha )

en línea

Establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

Parámetros

Usuario	Usuario de HSM.
Ficha	Valor de la ficha

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

Ejemplos: atoken.cs.

◆ ConnectToken() [2/3]

void ConectarToken	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Ficha )

en línea

Establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario de HSM.
Ficha	Valor de la ficha

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

◆ ConnectToken() [3/3]

void ConectarToken	(	cadena	Dirección,
		cadena	Usuario,
		cadena	Ficha,
		bool	Cifrado,
		bool	UseLoadBalance )

en línea

establece una conexión con el HSM utilizando un token temporal emitido por el usuario.

Parámetros

Dirección	Dirección IP del HSM.
Usuario	Usuario de HSM.
Ficha	>Valor del código
Cifrado	Indica si los datos transmitidos durante esta sesión serán encriptados.
UseLoadBalance	Indica si se utilizará o no la configuración del equilibrio de carga. Si este valor es falso, se utilizará el campo Dirección.

Excepciones

Dinamo.Hsm.DinamoException Se lanza cuando se produce un error de acceso o validación de usuario.

◆ Desconectar() [1/2]

void Desconectar ( bool flagClose )

en línea

Finaliza la conexión con el HSM.

Parámetros

flagClose Determina si la sesión se cerrará físicamente o sólo se liberará en la caché local.

Ejemplos: 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 y tokenisation.cs.

◆ Desconectar() [2/2]

void Desconectar ( )

en línea

Finaliza la conexión con el HSM.

◆ getCID()

UInt32 getCID ( )

en línea

Recupera el CID (Correlation ID) de la sesión actual. El CID permite relacionar la operación en el cliente HSM con los registros del HSM. El CID sólo está disponible cuando existe una sesión establecida con el HSM; en caso contrario, el valor será 0 (cero). Este número suele representarse en hexadecimal.

Devolución: CID.

Excepciones

DinamoException Lanza una excepción en caso de error.