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. | |
| void | backup (String file, String password) throws TacException |
| Cria um backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo. | |
| void | restoreWithoutNetConfig (String file, String password) throws TacException |
| Restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo. | |
| void | restoreWithNetConfig (String file, String password) throws TacException |
| Restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo. | |
| void | backupData (String file, String password, int direction) throws TacException |
| Cria ou restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo. | |
| 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 |
|---|---|
| 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.
| lExpiration | Expiraçã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. |
| TacException | Lançada quando ocorre um erro na geração do Access Token. |
| void revokeAToken | ( | TacAccessToken | accessToken | ) | throws TacException |
Revoga um Access Token de sessão do usuário no HSM.
| accessToken | Access Token que será revogado. |
| TacException | Lançada quando ocorre um erro na revogação do Access Token. |
| TacAccessToken[] listAToken | ( | ) | throws TacException |
Lista os Access Tokens de sessão do usuário no HSM.
| TacException | Lançada quando ocorre um erro na revogação do Access Token. |
| int getATokenCounter | ( | ) | throws TacException |
Recupera o contador de Access Tokens de todo o HSM.
| TacException | Lançada em caso de erro. |
| 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.
| TacException | Lançada em caso de erro. |
| 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.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| HSMAllInfo getHSMInfo | ( | ) | throws TacException |
Recupera informações do estado do HSM.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| String getHSMStringInfo | ( | ) | throws TacException |
Recupera informações do estado do HSM.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| String getFirmwareVersion | ( | ) | throws TacException |
Recupera a versão do firmware do HSM.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| String getModel | ( | ) | throws TacException |
Recupera o modelo do HSM.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| String getSerialNumber | ( | ) | throws TacException |
Recupera o número serial do HSM.
| TacException | Lançada quando ocorre um erro na recuperação das informações. |
| void backup | ( | String | file, |
| String | password ) throws TacException |
Cria um backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo.
O arquivo de backup será criado, caso exista, será sobrescrito.
| file | Caminho do arquivo de backup. |
| password | Senha do backup. |
| TacException | Lançada quando ocorre um erro na criação do backup. |
| void restoreWithoutNetConfig | ( | String | file, |
| String | password ) throws TacException |
Restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo.
Sem as configurações de rede.
| file | Caminho do arquivo de backup. |
| password | Senha do backup. |
| TacException | Lançada quando ocorre um erro na restauração do backup. |
| void restoreWithNetConfig | ( | String | file, |
| String | password ) throws TacException |
Restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo.
Com as configurações de rede.
| file | Caminho do arquivo de backup. |
| password | Senha do backup. |
| TacException | Lançada quando ocorre um erro na restauração do backup. |
| void backupData | ( | String | file, |
| String | password, | ||
| int | direction ) throws TacException |
Cria ou restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo.
| file | Caminho do arquivo de backup ou restauração. | ||||||||||
| password | Senha do backup ou restauração. | ||||||||||
| direction | Especifica a ação a ser executada.
|
| TacException | Lançada quando ocorre um erro na criação ou restauração do backup. |