Descrição detalhada

Autenticação padrão OATH.

Consulte a documentação técnica do HSM sobre detalhes de funcionamento, especificações utilizadas, licenças e nome comercial do módulo.

Autenticação padrão OATH. Mais...

Funções
byte[]	generateOATHHotpBlob (String masterKey) throws TacException
	Gera um blob OATH HOTP(HMAC-based One-Time Password).

byte[]	generateOATHHotpBlob (String masterKey, byte seedLen) throws TacException
	Gera um blob OATH HOTP(HMAC-based One-Time Password).

byte[]	generateOATHHotpBlob (String masterKey, byte seedLen, byte truncationOffset) throws TacException
	Gera um blob OATH HOTP(HMAC-based One-Time Password).

byte[]	importOATHHotpBlob (String masterKey, byte[] seed) throws TacException
	Gera um blob OATH HOTP(HMAC-based One-Time Password).

byte[]	generateOATHTotpBlob (String masterKey) throws TacException
	Gera um blob OATH TOTP(Time-based One-Time Password).

byte[]	generateOATHTotpBlob (String masterKey, byte seedLen, byte truncationOffset, int timeStep, long t0) throws TacException
	Gera um blob OATH TOTP(Time-based One-Time Password).

byte[]	importOATHTotpBlob (String masterKey, byte[] seed, byte truncationOffset, int timeStep, long t0, boolean useDefaultMovingFactor, long movingFactor) throws TacException
	Gera um blob OATH TOTP(Time-based One-Time Password).

byte[]	importOATHTotpBlob (String masterKey, byte[] seed) throws TacException
	Gera um blob OATH TOTP(Time-based One-Time Password).

byte[]	getOATHSeed (String masterKey, byte[] blob) throws TacException
	Recupera a semente(seed) do blob OATH.

String	getNextOATHOTP (String masterKey, int otpLen, byte[] oathBlob) throws TacException
	Gera o próximo OTP a partir do OATH blob informado.

byte[]	checkOATHBlobOTP (String masterKey, String otp, byte[] oathBlob) throws TacException
	Verifica um valor OTP para determinado blob OATH.

byte[]	resyncOATHBlobOTP (String masterKey, String otp1, String otp2, byte[] oathBlob) throws TacException
	Re-sincroniza um blob OATH através da apresentação de dois valores de OTP contínuos.

String	oathOcraGen (int setup, int otpLen, String skId, String suite, byte[] counter, byte[] question, byte[] pinHash, String session, byte[] timestamp) throws TacException
	Gera um valor OCRA (OATH Challenge-Response Algorithm) conforme RFC 6287.

Funções

◆ generateOATHHotpBlob() [1/3]

byte[] generateOATHHotpBlob ( String masterKey ) throws TacException

Gera um blob OATH HOTP(HMAC-based One-Time Password).

Também conhecido como OTP por evento. A semente é gerada dentro do HSM. Tamanho da semente TacNDJavaLib.ISSUE_OATH_SHA1_LEN.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ generateOATHHotpBlob() [2/3]

byte[] generateOATHHotpBlob	(	String	masterKey,
		byte	seedLen ) throws TacException

Gera um blob OATH HOTP(HMAC-based One-Time Password).

Também conhecido como OTP por evento. A semente é gerada dentro do HSM.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seedLen

Define o tamanho da semente OATH. Os seguintes valores são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ generateOATHHotpBlob() [3/3]

byte[] generateOATHHotpBlob	(	String	masterKey,
		byte	seedLen,
		byte	truncationOffset ) throws TacException

Gera um blob OATH HOTP(HMAC-based One-Time Password).

Também conhecido como OTP por evento. A semente é gerada dentro do HSM.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seedLen

Define o tamanho da semente OATH. Os seguintes valores são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

truncationOffset

O seguinte valor é suportado:

Valor	Significado
TacNDJavaLib.ISSUE_OATH_DYN_TRUNC	Define o algoritmo de “truncagem” como dinâmico.

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ importOATHHotpBlob()

byte[] importOATHHotpBlob	(	String	masterKey,
		byte[]	seed ) throws TacException

Gera um blob OATH HOTP(HMAC-based One-Time Password).

Também conhecido como OTP por evento. A semente é importada pelo chamador.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seed

Define uma semente OATH. Os seguintes tamanhos são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ generateOATHTotpBlob() [1/2]

byte[] generateOATHTotpBlob ( String masterKey ) throws TacException

Gera um blob OATH TOTP(Time-based One-Time Password).

Também conhecido como OTP por tempo. A semente é gerada dentro do HSM. Semente de tamanho TacNDJavaLib.ISSUE_OATH_SHA1_LEN.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ generateOATHTotpBlob() [2/2]

byte[] generateOATHTotpBlob	(	String	masterKey,
		byte	seedLen,
		byte	truncationOffset,
		int	timeStep,
		long	t0 ) throws TacException

Gera um blob OATH TOTP(Time-based One-Time Password).

Também conhecido como OTP por tempo. A semente é gerada dentro do HSM.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seedLen

Define o tamanho da semente OATH. Os seguintes valores são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

truncationOffset

O seguinte valor é suportado:

Valor	Significado
TacNDJavaLib.ISSUE_OATH_DYN_TRUNC	Define o algoritmo de “truncagem” como dinâmico.

timeStep

Valor do time step em segundos. Além de definir o time step em segundos para blobs TOTP os seguintes valores também são suportados.

Valor	Significado
TacNDJavaLib.ISSUE_OATH_DEFAULT_TIME_STEP	Utilizar o valor padrão de time step do HSM, atualmente 30 segs.
TacNDJavaLib.ISSUE_OATH_HOTP_TS	Utilizar este valor quando se tratar de HOTP.

t0

Valor do tempo inicial.

Valor	Significado
TacNDJavaLib.ISSUE_OATH_HOTP_T0	Utilizar valor padrão do HSM.

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ importOATHTotpBlob() [1/2]

byte[] importOATHTotpBlob	(	String	masterKey,
		byte[]	seed,
		byte	truncationOffset,
		int	timeStep,
		long	t0,
		boolean	useDefaultMovingFactor,
		long	movingFactor ) throws TacException

Gera um blob OATH TOTP(Time-based One-Time Password).

Também conhecido como OTP por tempo. A semente é importada pelo chamador.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seed

Define uma semente OATH. Os seguintes tamanhos são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

truncationOffset

O seguinte valor é suportado:

Valor	Significado
TacNDJavaLib.ISSUE_OATH_DYN_TRUNC	Define o algoritmo de “truncagem” como dinâmico.

timeStep

Valor do time step em segundos. Além de definir o time step em segundos para blobs TOTP os seguintes valores também são suportados.

Valor	Significado
TacNDJavaLib.ISSUE_OATH_DEFAULT_TIME_STEP	Utilizar o valor padrão de time step do HSM, atualmente 30 segs.
TacNDJavaLib.ISSUE_OATH_HOTP_TS	Utilizar este valor quando se tratar de HOTP.

t0

Valor do tempo inicial.

Valor	Significado
TacNDJavaLib.ISSUE_OATH_HOTP_T0	Utilizar valor padrão do HSM.

useDefaultMovingFactor Definir como true para utilizar o moving factor padrão ou como false para especificar um moving factor em movingFactor.

movingFactor

Define o incremento inicial do cliente antes da utilização. Além da definição do incremento manualmente, pode-se utilizar os valores da seguinte tabela.

Valor	Significado
TacNDJavaLib.ISSUE_OATH_INIT_MF	Utiliza valor padrão de moving factor.

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ importOATHTotpBlob() [2/2]

byte[] importOATHTotpBlob	(	String	masterKey,
		byte[]	seed ) throws TacException

Gera um blob OATH TOTP(Time-based One-Time Password).

Também conhecido como OTP por tempo. A semente é importada pelo chamador.

Parâmetros

masterKey Nome da chave mestre utilizada para proteger os blobs.

seed

Define uma semente OATH. Os seguintes tamanhos são aceitos.

Valor	Tamanho em bytes
TacNDJavaLib.ISSUE_OATH_SHA1_LEN	20
TacNDJavaLib.ISSUE_OATH_SHA256_LEN	32
TacNDJavaLib.ISSUE_OATH_SHA512_LEN	64

Retorna: Retorna o blob OATH.

Exceções

TacException

◆ getOATHSeed()

byte[] getOATHSeed	(	String	masterKey,
		byte[]	blob ) throws TacException

Recupera a semente(seed) do blob OATH.

Parâmetros

masterKey	Nome da chave mestre utilizada para proteger os blobs.
blob	blob OATH.

Retorna: Semente associada ao blob OATH.

Exceções

TacException

◆ getNextOATHOTP()

String getNextOATHOTP	(	String	masterKey,
		int	otpLen,
		byte[]	oathBlob ) throws TacException

Gera o próximo OTP a partir do OATH blob informado.

Parâmetros

masterKey	nome da chave mestre utilizada para proteger os blobs.
otpLen	tamanho do OTP que será gerado. Tamanho mínimo TacNDJavaLib.ISSUE_OATH_MIN_OTP_LEN e máximo TacNDJavaLib.ISSUE_OATH_MAX_OTP_LEN.
oathBlob	blob que será utilizado para a geração do OTP. Este buffer não será alterado.

Retorna: Retorna o OTP gerado.

Exceções

TacException

◆ checkOATHBlobOTP()

byte[] checkOATHBlobOTP	(	String	masterKey,
		String	otp,
		byte[]	oathBlob ) throws TacException

Verifica um valor OTP para determinado blob OATH.

Parâmetros

masterKey	Nome da chave mestre utilizada para proteger os blobs.
otp	OTP a ser verificado. Tamanho mínimo TacNDJavaLib.ISSUE_OATH_MIN_OTP_LEN e máximo TacNDJavaLib.ISSUE_OATH_MAX_OTP_LEN.
oathBlob	blob que terá o OTP verificado. Este buffer será reescrito com o buffer atualizado.

Retorna: blob OATH atualizado.

Exceções

TacException

Anotações: Caso seja lançado o erro D_OATH_BLOB_UPDATE esta chamada deverá ser refeita passando o oathBlob com tamanho de ISSUE_OATH_OUTPUT_MAX_BLOB_LEN contendo blob atual, para que o blob seja atualizado. Ver detalhes na especificação de OATH_UPDATE_BLOB.

◆ resyncOATHBlobOTP()

byte[] resyncOATHBlobOTP	(	String	masterKey,
		String	otp1,
		String	otp2,
		byte[]	oathBlob ) throws TacException

Re-sincroniza um blob OATH através da apresentação de dois valores de OTP contínuos.

Apenas para HOTP(OTP por evento).

Parâmetros

masterKey	Nome da chave mestre utilizada para proteger os blobs.
otp1	Primeiro OTP. Tamanho mínimo TacNDJavaLib.ISSUE_OATH_MIN_OTP_LEN e máximo TacNDJavaLib.ISSUE_OATH_MAX_OTP_LEN.
otp2	Segundo OTP. Tamanho mínimo TacNDJavaLib.ISSUE_OATH_MIN_OTP_LEN e máximo TacNDJavaLib.ISSUE_OATH_MAX_OTP_LEN.
oathBlob	blob que terá o OTP verificado. Este buffer será reescrito com o buffer atualizado.

Retorna: blob OATH atualizado.

Exceções

TacException

Anotações: A partir da versão 4.0.2 do firmware a janela será estendida em 200 intervalos para mais e para menos. No caso de tokens HOTP os intervalos serão contados por quantidade de eventos, no caso dos tokens TOTP serão contados por quantidade de time-steps. Caso seja lançado o erro D_OATH_BLOB_UPDATE esta chamada deverá ser refeita passando o oathBlob com tamanho de ISSUE_OATH_OUTPUT_MAX_BLOB_LEN contendo blob atual, para que o blob seja atualizado. Ver detalhes na especificação de OATH_UPDATE_BLOB.

◆ oathOcraGen()

String oathOcraGen	(	int	setup,
		int	otpLen,
		String	skId,
		String	suite,
		byte[]	counter,
		byte[]	question,
		byte[]	pinHash,
		String	session,
		byte[]	timestamp ) throws TacException

Gera um valor OCRA (OATH Challenge-Response Algorithm) conforme RFC 6287.

Parâmetros

setup	Flags que habilitam os campos opcionais do cálculo OCRA. A tabela seguinte é aceita. Valor \| Significado :-—\|:-------— `TacNDJavaLib#DN_OATH_OCRA_USE_CTR` \| Inclui o campo counter no cálculo. `TacNDJavaLib#DN_OATH_OCRA_USE_PH20` \| Inclui hash SHA-1 da senha em pinHash (20 bytes). `TacNDJavaLib#DN_OATH_OCRA_USE_PH32` \| Inclui hash SHA-256 da senha em pinHash (32 bytes). `TacNDJavaLib#DN_OATH_OCRA_USE_PH64` \| Inclui hash SHA-512 da senha em pinHash (64 bytes). `TacNDJavaLib#DN_OATH_OCRA_USE_TS` \| Inclui o timestamp no cálculo.
otpLen	Tamanho do OTP gerado em dígitos, entre `TacNDJavaLib#ISSUE_OATH_MIN_OTP_LEN` e `TacNDJavaLib#ISSUE_OATH_MAX_OTP_LEN`.
skId	Nome da chave HMAC (SHA-1, SHA-256 ou SHA-512) no HSM usada no cálculo. Tamanho máximo `TacNDJavaLib#MAX_OBJ_ID_FQN_LEN`.
suite	String de suite OCRA conforme RFC 6287. Tamanho máximo `TacNDJavaLib#DN_OATH_OCRA_MAX_SUITE_LEN`.
counter	Contador de `TacNDJavaLib#DN_OATH_OCRA_CTR_LEN` bytes. Obrigatório quando `TacNDJavaLib#DN_OATH_OCRA_USE_CTR` estiver definido em setup, ignorado caso contrário. Pode ser null.
question	Desafio (challenge). Obrigatório. Tamanho máximo `TacNDJavaLib#DN_OATH_OCRA_MAX_Q_LEN`.
pinHash	Hash da senha do usuário. O tamanho deve ser compatível com a flag de hash definida em setup (`TacNDJavaLib#DN_OATH_OCRA_USE_PH20`, `TacNDJavaLib#DN_OATH_OCRA_USE_PH32` ou `TacNDJavaLib#DN_OATH_OCRA_USE_PH64`). Pode ser null se nenhuma flag de hash estiver ativa.
session	Informação de sessão do cliente. Tamanho máximo `TacNDJavaLib#DN_OATH_OCRA_CSESS_MAX_LEN`. Pode ser null.
timestamp	Timestamp de `TacNDJavaLib#DN_OATH_OCRA_TIME_STEPS_LEN` bytes. Obrigatório quando `TacNDJavaLib#DN_OATH_OCRA_USE_TS` estiver definido em setup, ignorado caso contrário. Pode ser null.

Retorna: OTP gerado como string com comprimento igual a otpLen dígitos.

Exceções

TacException