Descrição detalhada

Gerência administrativa do HSM.

Gerência administrativa do HSM. Mais...

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.

void	setTlsBundle (String szKey, String szCert) throws TacException
	Define a chave e o certificado que serão utilizados pelo HSM no fechamento do túnel TLS.

void	nsAuthSetState (int acl, int state, SvmkShadow[] shadows) throws TacException
	Define o estado de autorização M de N da partição (NSAuth).

SvmkShadow	scReadShadow (String pin) throws TacException
	Lê a shadow M de N do cartão Smart-card inserido no leitor.

ScInfo	scGetInfo () throws TacException
	Recupera as informações do cartão Smart-card inserido no leitor.

boolean	scIsLibLoaded ()
	Verifica se a biblioteca de acesso ao leitor Smart-card está carregada.

void	scChangePIN (String currentPin, String newPin) throws TacException
	Altera o PIN do cartão Smart-card M de N Dinamo inserido no leitor.

void	scWriteShadow (SvmkShadow shadow, String pin, boolean overwrite) throws TacException
	Escreve uma shadow M de N no cartão Smart-card inserido no leitor.

void	scErase (String pin) throws TacException
	Apaga as informações de um cartão Smart-card M de N Dinamo inserido no leitor.

void	scSetLabel (String pin, String label) throws TacException
	Define o label do cartão Smart-card M de N Dinamo inserido no leitor.

String	scGetLabel (String pin) throws TacException
	Recupera o label do cartão Smart-card M de N Dinamo inserido no leitor.

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

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.

Retorna: AToken para uso em openSession.

Exceções

TacException Lanç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

accessToken Access Token que será revogado.

Exceções

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lanç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

TacException Lançada quando ocorre um erro na recuperação das informações.

◆ backup()

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.

Parâmetros

file	Caminho do arquivo de backup.
password	Senha do backup.

Exceções

TacException Lançada quando ocorre um erro na criação do backup.

◆ restoreWithoutNetConfig()

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.

Parâmetros

file	Caminho do arquivo de backup.
password	Senha do backup.

Exceções

TacException Lançada quando ocorre um erro na restauração do backup.

◆ restoreWithNetConfig()

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.

Parâmetros

file	Caminho do arquivo de backup.
password	Senha do backup.

Exceções

TacException Lançada quando ocorre um erro na restauração do backup.

◆ backupData()

void backupData	(	String	file,
		String	password,
		int	direction ) throws TacException

Cria ou restaura o backup dos objetos (chaves, certificados, etc.) gravados internamente no Dinamo.

Parâmetros

file Caminho do arquivo de backup ou restauração.

password Senha do backup ou restauração.

direction

Especifica a ação a ser executada.

Valor	Significado
TacNDJavaLib.MAKE_BACKUP	O arquivo de backup será criado, caso exista, será sobrescrito.
TacNDJavaLib.MAKE_RESTORE_WITHOUT_NET_CONFIG	Os dados de backup existentes, não incluindo parâmetros de rede, no arquivo indicado por `file` serão restaurados.
TacNDJavaLib.MAKE_RESTORE_WITH_NET_CONFIG	Os dados de backup existentes, incluindo parâmetros de rede, no arquivo indicado por `file` serão restaurados.
TacNDJavaLib.MAKE_USE_WIN_CREDENTIAL	Utiliza as credenciais do Windows para autenticação. Esta opção deve ser utilizado com uma das outras opções. Passar o target da credencial no campo `password`.

Exceções

TacException Lançada quando ocorre um erro na criação ou restauração do backup.

◆ setTlsBundle()

void setTlsBundle	(	String	szKey,
		String	szCert ) throws TacException

Define a chave e o certificado que serão utilizados pelo HSM no fechamento do túnel TLS.

Passar strings vazias em szKey e szCert restaura a chave e o certificado padrão do HSM.

Parâmetros

szKey	Identificador da chave (formato `usuario/chave`) que será utilizada no TLS do HSM. Passar string vazia para usar a chave padrão.
szCert	Identificador do certificado (formato `usuario/cert`) que será utilizado no TLS do HSM. Passar string vazia para usar o certificado padrão.

Exceções

TacException Lançada quando ocorre um erro na operação.

◆ nsAuthSetState()

void nsAuthSetState	(	int	acl,
		int	state,
		SvmkShadow[]	shadows ) throws TacException

Define o estado de autorização M de N da partição (NSAuth).

Utilizado para associar o HSM a uma partição M de N e definir o nível de acesso a objetos usando shadows de Smart-cards Dinamo. A sessão deve estar autenticada.

Estados disponíveis (@iliteral{code} state @endiliteral )
Estado	Significado	`acl`
`TacNDJavaLib#DN_S_NSAUTH_ASSOC`	Define o estado associado. Informar o ACL desejado em `acl`.	combinação de `NSAUTH_ACL_*`
`TacNDJavaLib#DN_S_NSAUTH_RESET`	Reseta o estado NSAuth (não associado e não autorizado).	`TacNDJavaLib#NSAUTH_ACL_NOP`
`TacNDJavaLib#DN_S_NSAUTH_AUTH`	Define o estado autorizado. Não disponível ainda.	`TacNDJavaLib#NSAUTH_ACL_NOP`
`TacNDJavaLib#DN_S_NSAUTH_eAUTH`	Define a sessão como autorizada. O ACL deve ter sido definido antes via `TacNDJavaLib#DN_S_NSAUTH_ASSOC`.	`TacNDJavaLib#NSAUTH_ACL_NOP`
`TacNDJavaLib#DN_S_NSAUTH_CHECK`	Verifica o conjunto de shadows. Não altera o estado NSAuth.	`TacNDJavaLib#NSAUTH_ACL_NOP`

Parâmetros

acl	Permissões de acesso a objetos (combinação de flags `NSAUTH_ACL_*`). Relevante apenas para `TacNDJavaLib#DN_S_NSAUTH_ASSOC`; passar `TacNDJavaLib#NSAUTH_ACL_NOP` nos demais estados.
state	Estado a ser definido. Ver tabela acima.
shadows	Shadows dos Smart-cards da partição M de N. Pode ser `null` ou vazio para estados que não requerem shadows (ex. `TacNDJavaLib#DN_S_NSAUTH_RESET`, `TacNDJavaLib#DN_S_NSAUTH_eAUTH`).

Exceções

TacException

◆ scReadShadow()

SvmkShadow scReadShadow ( String pin ) throws TacException

Lê a shadow M de N do cartão Smart-card inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM. Verifique a disponibilidade da biblioteca com scIsLibLoaded().

Parâmetros

pin	PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.

Retorna: Shadow lida do cartão.

Exceções

TacException

◆ scGetInfo()

ScInfo scGetInfo ( ) throws TacException

Recupera as informações do cartão Smart-card inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Retorna: Estrutura com os dados do cartão.

Exceções

TacException

◆ scIsLibLoaded()

boolean scIsLibLoaded ( )

Verifica se a biblioteca de acesso ao leitor Smart-card está carregada.

Retorna: true se a biblioteca está disponível, false caso contrário.

◆ scChangePIN()

void scChangePIN	(	String	currentPin,
		String	newPin ) throws TacException

Altera o PIN do cartão Smart-card M de N Dinamo inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Parâmetros

currentPin	PIN atual do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.
newPin	Novo PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.

Exceções

TacException

◆ scWriteShadow()

void scWriteShadow	(	SvmkShadow	shadow,
		String	pin,
		boolean	overwrite ) throws TacException

Escreve uma shadow M de N no cartão Smart-card inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Parâmetros

shadow	Shadow a ser gravada no cartão.
pin	PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.
overwrite	`true` para sobrescrever uma shadow existente.

Exceções

TacException

◆ scErase()

void scErase ( String pin ) throws TacException

Apaga as informações de um cartão Smart-card M de N Dinamo inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Parâmetros

pin	PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.

Exceções

TacException

◆ scSetLabel()

void scSetLabel	(	String	pin,
		String	label ) throws TacException

Define o label do cartão Smart-card M de N Dinamo inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Parâmetros

pin	PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.
label	Label ASCII. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_LABEL_LEN`.

Exceções

TacException

◆ scGetLabel()

String scGetLabel ( String pin ) throws TacException

Recupera o label do cartão Smart-card M de N Dinamo inserido no leitor.

Esta operação acessa o cartão diretamente via leitor USB/CCID e não requer sessão HSM.

Parâmetros

pin	PIN do cartão. Tamanho máximo `TacNDJavaLib#DN_SC_MAX_PIN_LEN`.

Retorna: Label do cartão no formato ASCII.

Exceções

TacException