API Java
HSM Dinamo
Carregando...
Procurando...
Nenhuma entrada encontrado
Gerência

Descrição detalhada

Gerência do HSM.

Consulte a documentação técnica do HSM.

Funções

TacAccessToken issueAToken (long lExpiration) throws TacException
 Emite um Access Token de sessão do usuário no HSM.
 
void revokeAToken (TacAccessToken accessToken) throws TacException
 Revoga um Access Token de sessão do usuário no HSM.
 
TacAccessToken[] listAToken () throws TacException
 Lista os Access Tokens de sessão do usuário no HSM.
 
int getATokenCounter () throws TacException
 Recupera o contador de Access Tokens de todo o HSM.
 
void runATokenGC () throws TacException
 Executa o Garbage Collector de tokens de sessão do HSM.
 
HSMStatInfo getStatInfo () throws TacException
 Recupera informações de estatística do HSM, como os números de uso de sessões, CPU e memória.
 
HSMAllInfo getHSMInfo () throws TacException
 Recupera informações do estado do HSM.
 
String getHSMStringInfo () throws TacException
 Recupera informações do estado do HSM.
 
String getFirmwareVersion () throws TacException
 Recupera a versão do firmware do HSM.
 
String getModel () throws TacException
 Recupera o modelo do HSM.
 
String getSerialNumber () throws TacException
 Recupera o número serial do HSM.
 

Funções

◆ issueAToken()

TacAccessToken issueAToken ( long lExpiration) throws TacException

Emite um Access 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 revokeAToken(). 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 a partir da versã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
lExpirationExpiração do token. Equivalente a time_t. Medido em segundos a partir de EPOCH(00:00, Jan 1 1970 UTC). Usar TacNDJavaLib.DN_A_TOKEN_INFINITE para token sem expiração.
Retorna
AToken para uso em openSession.
Exceções
TacExceptionLançada quando ocorre um erro na geração do Access Token.

◆ revokeAToken()

void revokeAToken ( TacAccessToken accessToken) throws TacException

Revoga um Access Token de sessão do usuário no HSM.

Parâmetros
accessTokenAccess Token que será revogado.
Exceções
TacExceptionLançada quando ocorre um erro na revogação do Access Token.

◆ listAToken()

TacAccessToken[] listAToken ( ) throws TacException

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

Retorna
Lista de ATokens do usuário.
Exceções
TacExceptionLançada quando ocorre um erro na revogação do Access Token.

◆ getATokenCounter()

int getATokenCounter ( ) throws TacException

Recupera o contador de Access Tokens de todo o HSM.

Retorna
Total de Access tokens de todo o HSM.
Exceções
TacExceptionLançada em caso de erro.

◆ runATokenGC()

void runATokenGC ( ) throws TacException

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
TacExceptionLançada em caso de erro.

◆ getStatInfo()

HSMStatInfo getStatInfo ( ) throws TacException

Recupera informações de estatística do HSM, como os números de uso de sessões, CPU e memória.

Retorna
Informações de estatística.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.

◆ getHSMInfo()

HSMAllInfo getHSMInfo ( ) throws TacException

Recupera informações do estado do HSM.

Retorna
Informações de estatística.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.

◆ getHSMStringInfo()

String getHSMStringInfo ( ) throws TacException

Recupera informações do estado do HSM.

Retorna
Informações do estado do HSM.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.

◆ getFirmwareVersion()

String getFirmwareVersion ( ) throws TacException

Recupera a versão do firmware do HSM.

Retorna
Versão do firmware do HSM ou null se não houver esta informação.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.

◆ getModel()

String getModel ( ) throws TacException

Recupera o modelo do HSM.

Retorna
Modelo do HSM ou null se não houver esta informação.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.

◆ getSerialNumber()

String getSerialNumber ( ) throws TacException

Recupera o número serial do HSM.

Retorna
Número serial do HSM ou null se não houver esta informação.
Exceções
TacExceptionLançada quando ocorre um erro na recuperação das informações.