Sessão

Descrição detalhada

Gerência de sessões cliente com o HSM.

Funções
void	Connect (string User, string Password)
	Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance. Parâmetros User Usuário/Partição HSM. Password Senha do usuário.
void	Connect (string Address, string User, string Password)
	Conecta a um HSM especifico usando uma conexão criptografada.
void	Connect (string Address, string User, string Password, string Otp)
	Conecta a um HSM especifico usando uma conexão criptografada.
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)
	Estabelece uma conexão com o HSM usando todos os parâmetros da API.
void	Connect (string Address, string User, string Password, string Otp, bool Encrypted, bool UseLoadBalance)
	Estabelece uma conexão com o HSM usando todos os parâmetros da API.
void	ConnectAnonymously (string Address)
	Estabelece uma conexão anônima com o HSM.
void	ConnectToken (string User, string Token)
	Estabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.
void	ConnectToken (string Address, string User, string Token)
	Estabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.
void	ConnectToken (string Address, string User, string Token, bool Encrypted, bool UseLoadBalance)
	stabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.
void	Disconnect (bool flagClose)
	Encerra a conexão com o HSM.
void	Disconnect ()
	Encerra a conexão com o HSM.
UInt32	getCID ()
	Recupera o CID (Correlation ID) da sessão corrente. O CID possibilita a relação da operação no cliente do HSM com os logs do HSM. O CID apenas está disponível quando há uma sessão estabelecida com o HSM, caso contrário o valor será 0 (zero). Este número é normalmente representado em hexadecimal.

Funções

Connect() [1/5]

void Connect ( string User, string Password )

inline

Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance.

Parâmetros

User	Usuário/Partição HSM.
Password	Senha do usuário.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Exemplos

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 e tokenization.cs.

Connect() [2/5]

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

inline

Conecta a um HSM especifico usando uma conexão criptografada.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário/Partição HSM.
Password	Senha do usuário.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Anotações

Esta API utiliza o IP informado para estabelecer a conexão. Caso o load balance seja utilizado, o IP informado será ignorado.

Connect() [3/5]

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

inline

Conecta a um HSM especifico usando uma conexão criptografada.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário/Partição HSM.
Password	Senha do usuário.
Otp	OTP gerado pelo usuário.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Anotações

Esta API utiliza o IP informado para estabelecer a conexão. Caso o load balance seja utilizado, o IP informado será ignorado.

ConnectWithLB() [1/2]

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

inline

Obsoleto(a)

Usar Connect().

ConnectWithLB() [2/2]

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

inline

Obsoleto(a)

Usar Connect().

Connect() [4/5]

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

inline

Estabelece uma conexão com o HSM usando todos os parâmetros da API.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário do HSM.
Password	Senha do usuário do HSM.
Encrypted	Indica se os dados trafegados durante esta sessão serão cifrados.
UseLoadBalance	Indica se as configurações de load balance serão utilizadas ou não. Caso este valor seja definido como true, o campo Address será ignorado.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Connect() [5/5]

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

inline

Estabelece uma conexão com o HSM usando todos os parâmetros da API.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário do HSM.
Password	Senha do usuário do HSM.
Otp	OTP gerado pelo usuário.
Encrypted	Indica se os dados trafegados durante esta sessão serão cifrados.
UseLoadBalance	Indica se as configurações de load balance serão utilizadas ou não. Caso este valor seja definido como true, o campo Address será ignorado.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

ConnectAnonymously()

void ConnectAnonymously ( string Address )

inline

Estabelece uma conexão anônima com o HSM.

Parâmetros

Address

Endereço IP do HSM.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro.

Exemplos

m_of_n.cs.

ConnectToken() [1/3]

void ConnectToken ( string User, string Token )

inline

Estabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.

Parâmetros

User	Usuário do HSM.
Token	Valor do token

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Exemplos

atoken.cs.

ConnectToken() [2/3]

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

inline

Estabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário do HSM.
Token	Valor do token

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

ConnectToken() [3/3]

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

inline

stabelece uma conexão com o HSM usando um token temporário emitido pelo usuário.

Parâmetros

Address	Endereço IP do HSM.
User	Usuário do HSM.
Token	>Valor do token
Encrypted	Indica se os dados trafegados durante esta sessão serão cifrados.
UseLoadBalance	Indica se as configurações de load balance serão utilizadas ou não. Caso este valor seja definido como false, o campo Address será utilizado.

Exceções

Dinamo.Hsm.DinamoException

Lançada quando ocorre um erro no acesso ou validação do usuário.

Disconnect() [1/2]

void Disconnect ( bool flagClose )

inline

Encerra a conexão com o HSM.

Parâmetros

flagClose

Determina se a sessão será fechada fisicamente, ou apenas liberada no cache local.

Exemplos

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 e tokenization.cs.

Disconnect() [2/2]

void Disconnect ( )

inline

Encerra a conexão com o HSM.

getCID()

UInt32 getCID ( )

inline

Recupera o CID (Correlation ID) da sessão corrente. O CID possibilita a relação da operação no cliente do HSM com os logs do HSM. O CID apenas está disponível quando há uma sessão estabelecida com o HSM, caso contrário o valor será 0 (zero). Este número é normalmente representado em hexadecimal.

Retorna

CID.

Exceções

DinamoException

Lança exceção em caso de erro.