Descrição detalhada

Gerência do HSM.

Enumerações
enum	TOKEN_TYPE : int { TIME = 1 , EVENT = 2 , CHAP = 3 , NTP = 4 }

Funções
string	GetErrorString (Int32 _errorCode)
	Retorna a mensagem com a descrição do erro.

DateTime	GetHSMDate ()
	Retorna a data/hora do HSM.

void	SetHSMDateTime (DateTime stDateTime)
	Define a data/hora do HSM.

DinamoApi.SYS_COUNTER_INFO	GetHSMCounterInfo ()
	Recupera informações de contadores de sistema do HSM.

void	GetHSMHardwareInfo ()
	Recupera informações de hardware do HSM.

void	Backup (string DestFile, string Pin)
	Recupera um backup do HSM.

void	Restore (string SourceFile, string Pin, bool IncludeNetworkParameters)
	Restaura um backup no HSM.

int	GetLogSize ()
	Recupera o tamanho dos logs do HSM.

byte[]	DGetStatLog ()
	Recupera os logs do HSM.

byte[]	DGetStatLog (int StartPos, int BytesToRead)
	Recupera os logs do HSM.

int	IPFilterOperationStatus ()
	Recupera o status do filtro de IPs do HSM.

int	IPFilterOperationAdd (string szUser, string szIP)
	Adiciona um conjunto IP/usuário na lista (whitelist) de IPs do HSM.

int	IPFilterOperationRemove (string szUser, string szIP)
	Remove um conjunto IP/usuário na lista (whitelist) de IPs do HSM.

int	IPFilterSetStatus (bool bStatus)
	Define o status do filtro de IPs do HSM.

int	IPFilterOptList (DinamoApi.ListIpFilterCallback filterIpCallBack, IntPtr param)
	Recupera lista do filtro de IPs do HSM.

void	SaveLog (string fileName)
	Salva logs do HSM em um arquivo.

void	ClearLog ()
	Limpa logs do HSM.

string	EmitAuthenticationToken (DateTime expirationDate)

string	IssueAToken (ulong expiration)
	Emite umAccess Token de sessão do usuário no HSM.Esta funcionalidade é indicada para o controle granular de autenticação de aplicações, onde a emissão de tokens é gerenciada pelo security officer. A limpeza de Access Tokens expirados acontece em 2 momentos: Quando um usuário que tem um Access Tokens expirado faz login utilizando Access Tokens. Limpa apenas os próprios Access Token expirados. Utilizando a função RunATokenGC(). Limpa todos os Access Tokens expirados do HSM.

string	IssueAToken (long expiration)
	/overload void IssueAToken(ulong expiration)

string	IssueAToken (DateTime expiration)
	/overload void IssueAToken(ulong expiration)

void	RevokeAToken (string aToken)
	Revoga um token de autenticação do HSM.

void	RevokeAuthenticationToken (string strToken)

DinamoApi.DN_A_TOKEN_FULL[]	ListATokenFull ()
	Lista os Access Tokens de sessão do usuário no HSM.

void	RunATokenGC ()
	Executa o Garbage Collector de tokens de sessão do HSM. Este método faz a limpeza de todos os Access Tokens do HSM que não forem mais válidos. O GC deve ser chamado periodicamente pela aplicação para manter os níveis do cache de Access Tokens sob controle. O horário de execução do GC deve ser programada levando em conta os momentos de maiores cargas de trabalho do HSM.

uint	GetATokenCounter ()
	Recupera o contador de Access Tokens de todo o HSM.

Enumerações

◆ TOKEN_TYPE

enum TOKEN_TYPE : int

Enumeradores
TIME
EVENT
CHAP
NTP

Funções

◆ GetErrorString()

string GetErrorString ( Int32 _errorCode )

inline

Retorna a mensagem com a descrição do erro.

Parâmetros

_errorCode Código do erro.

Retorna: Descrição do erro.

◆ GetHSMDate()

DateTime GetHSMDate ( )

inline

Retorna a data/hora do HSM.

Retorna: Data no formato DateTime

Exceções

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

Exemplos: get_date.cs.

◆ SetHSMDateTime()

void SetHSMDateTime ( DateTime stDateTime )

inline

Define a data/hora do HSM.

Parâmetros

stDateTime Data no formato DateTime

Exceções

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

◆ GetHSMCounterInfo()

DinamoApi.SYS_COUNTER_INFO GetHSMCounterInfo ( )

inline

Recupera informações de contadores de sistema do HSM.

Retorna: Informações de contadores de sistema do HSM.

Exceções

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

Exemplos: get_counter_info.cs.

◆ GetHSMHardwareInfo()

void GetHSMHardwareInfo ( )

inline

Recupera informações de hardware do HSM.

Exceções

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

◆ Backup()

void Backup	(	string	DestFile,
		string	Pin )

inline

Recupera um backup do HSM.

Parâmetros

DestFile	Nome do arquivo de destino do backup.
Pin	Senha de proteção do arquivo de backup. Devem ser caracteres ASCII. O tamanho deve estar entre DinamoApi.MIN_BACKUP_PIN_LEN e DinamoApi.MAX_BACKUP_PIN_LEN.

Exceções

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

◆ Restore()

void Restore	(	string	SourceFile,
		string	Pin,
		bool	IncludeNetworkParameters )

inline

Restaura um backup no HSM.

Parâmetros

SourceFile	Nome do arquivo do backup.
Pin	Senha de proteção do arquivo de backup. Devem ser caracteres ASCII. O tamanho deve estar entre DinamoApi.MIN_BACKUP_PIN_LEN e DinamoApi.MAX_BACKUP_PIN_LEN.
IncludeNetworkParameters	Se true, inclui na restauração do HSM as configurações de rede.

Exceções

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

◆ GetLogSize()

int GetLogSize ( )

inline

Recupera o tamanho dos logs do HSM.

Exceções

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

◆ DGetStatLog() [1/2]

byte[] DGetStatLog ( )

inline

Recupera os logs do HSM.

Retorna: Logs completos do HSM.

Exceções

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

◆ DGetStatLog() [2/2]

byte[] DGetStatLog	(	int	StartPos,
		int	BytesToRead )

inline

Recupera os logs do HSM.

Parâmetros

StartPos	Posição inicial, em bytes, do log a ser recuperado. Para receber todo o conteúdo do log indique DinamoApi.GET_LOG_START_FULL.
BytesToRead	Quantidade, em bytes, a ser recuperada a partir da posição inicial indicada por `dwStart`. Para receber todo o conteúdo do log indique DinamoApi.GET_LOG_END_FULL.

Retorna: Logs do HSM.

Exceções

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

◆ IPFilterOperationStatus()

int IPFilterOperationStatus ( )

inline

Recupera o status do filtro de IPs do HSM.

Retorna: Status do filtro de IPs.

Exceções

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

◆ IPFilterOperationAdd()

int IPFilterOperationAdd	(	string	szUser,
		string	szIP )

inline

Adiciona um conjunto IP/usuário na lista (whitelist) de IPs do HSM.

Parâmetros

szUser	Nome do usuário.
szIP	IP

Retorna: Status do filtro de IPs.

Exceções

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

◆ IPFilterOperationRemove()

int IPFilterOperationRemove	(	string	szUser,
		string	szIP )

inline

Remove um conjunto IP/usuário na lista (whitelist) de IPs do HSM.

Parâmetros

szUser	Nome do usuário.
szIP	IP

Retorna: Status do filtro de IPs.

Exceções

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

◆ IPFilterSetStatus()

int IPFilterSetStatus ( bool bStatus )

inline

Define o status do filtro de IPs do HSM.

Parâmetros

bStatus true para habilitado e false para desabilitado.

Retorna: Status do filtro de IPs.

Exceções

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

◆ IPFilterOptList()

int IPFilterOptList	(	DinamoApi.ListIpFilterCallback	filterIpCallBack,
		IntPtr	param )

inline

Recupera lista do filtro de IPs do HSM.

Parâmetros

filterIpCallBack	Callback de listagem de IPs.
param	Parâmetro do callback.

Retorna: Status do filtro de IPs.

Exceções

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

◆ SaveLog()

void SaveLog ( string fileName )

inline

Salva logs do HSM em um arquivo.

Parâmetros

fileName Nome do arquivo para salvar os logs.

Exceções

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

◆ ClearLog()

void ClearLog ( )

inline

Limpa logs do HSM.

Exceções

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

◆ EmitAuthenticationToken()

string EmitAuthenticationToken ( DateTime expirationDate )

inline

Obsoleto(a): Usar IssueAToken().

◆ IssueAToken() [1/3]

string IssueAToken ( ulong expiration )

inline

Emite umAccess Token de sessão do usuário no HSM.Esta funcionalidade é indicada para o controle granular de autenticação de aplicações, onde a emissão de tokens é gerenciada pelo security officer.
A limpeza de Access Tokens expirados acontece em 2 momentos:
Quando um usuário que tem um Access Tokens expirado faz login utilizando Access Tokens. Limpa apenas os próprios Access Token expirados.
Utilizando a função RunATokenGC(). Limpa todos os Access Tokens expirados do HSM.

O limite máximo de Access Tokens emitidos por HSM pode ser visto na tabela abaixo.

Modelo	Limite máximo
Pocket	1024
XP	1 Milhão
ST	1 Milhão

Anotações: Os Access Tokens são mantidos de forma volátil, e desta maneira são apagados quando o HSM é reiniciado. Apesar de serem voláteis, os Access Tokens são replicados entre HSMs.

Esta operação está disponível à partir da vesão 3.17 do firmware do HSM.A implementação de Access Tokens anterior à versão 3.17 do firmware é legada. As aplicações, que utilizam esta funcionalidade, deverão atualizar o cliente do HSM para a versão 3.2.18 ou superior, juntamente com o firmware do HSM para a versão 3.17 ou superior. Não há compatibilidade entre versões novas e antigas de cliente e firmware do HSM.

Parâmetros

expiration Expiração do token. Equivalente a time_t. Medido em segundos a partir de EPOCH(00:00, Jan 1 1970 UTC). Usar DinamoApi.DN_A_TOKEN_INFINITE para token sem expiração.

Retorna: AToken para uso em Connect().

Exceções

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

Exemplos: atoken.cs.

◆ IssueAToken() [2/3]

string IssueAToken ( long expiration )

inline

/overload void IssueAToken(ulong expiration)

◆ IssueAToken() [3/3]

string IssueAToken ( DateTime expiration )

inline

/overload void IssueAToken(ulong expiration)

◆ RevokeAToken()

void RevokeAToken ( string aToken )

inline

Revoga um token de autenticação do HSM.

Parâmetros

aToken Token de autenticação que será revogado.

Exceções

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

Exemplos: atoken.cs.

◆ RevokeAuthenticationToken()

void RevokeAuthenticationToken ( string strToken )

inline

Obsoleto(a): Usar RevokeAToken().

◆ ListATokenFull()

DinamoApi.DN_A_TOKEN_FULL[] ListATokenFull ( )

inline

Lista os Access Tokens de sessão do usuário no HSM.

Retorna: Lista de ATokens do usuário.

Exceções

DinamoException

Exemplos: atoken.cs.

◆ RunATokenGC()

void RunATokenGC ( )

inline

Executa o Garbage Collector de tokens de sessão do HSM. Este método faz a limpeza de todos os Access Tokens do HSM que não forem mais válidos.
O GC deve ser chamado periodicamente pela aplicação para manter os níveis do cache de Access Tokens sob controle. O horário de execução do GC deve ser programada levando em conta os momentos de maiores cargas de trabalho do HSM.

Exceções

DinamoException

Exemplos: atoken.cs.

◆ GetATokenCounter()

uint GetATokenCounter ( )

inline

Recupera o contador de Access Tokens de todo o HSM.

Retorna: Total de Access tokens de todo o HSM.

Exceções

DinamoException

Exemplos: atoken.cs.