Session

Descrição detalhada

Gerência de sessões client com o HSM.

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

Gerência de sessões client com o HSM. Mais...

Funções
void	openSession (String strAddr, String strUsrId, String strPwd) throws TacException
	Estabelece uma conexão cifrada com o HSM.
void	openSession (String strAddr, String strUsrId, String strPwd, boolean bLoadBalance) throws TacException
	Estabelece uma conexão cifrada com o HSM.
void	openSession (String strAddr, String strUsrId, String strPwd, String strOtp, boolean bLoadBalance) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando OTP.
void	openSession (String strAddr, String strUsrId, String strPwd, String strOtp) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando OTP.
void	openSession (String strAddr, String strUsrId, String strPwd, int nPort, int nFlags) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance.
void	openSession (String strAddr, String strUsrId, String strPwd, String strOtp, int nPort, int nFlags) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance e OTP.
void	setOpenSession (byte[] session)
	Define um handle de sessão previamente aberto para ser usado nesta instância.
void	openSession (String strAddr, TacAccessToken stAToken, int nPort, int nFlags) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando AToken.
void	openSession (String strAddr, byte[] jbaAToken, int nPort, int nFlags) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando AToken.
void	openSession (String strAddr, TacAccessToken stAToken, int nPort, boolean bLoadBalance, boolean bSessionCache, boolean bEncrypted) throws TacException
	Estabelece uma conexão com o HSM utilizando AToken.
void	openSession (String strAddr, byte[] jbaAToken, int nPort, boolean bLoadBalance, boolean bSessionCache, boolean bEncrypted) throws TacException
	Estabelece uma conexão com o HSM utilizando AToken.
void	openSession (String strAddr, String strUsrId, String strPwd, int nPort, boolean bLoadBalance, boolean bSessionCache, boolean bEncrypted) throws TacException
	Estabelece uma conexão cifrada com o HSM.
void	openSession (String strAddr, String strUsrId, String strPwd, String strOtp, int nPort, boolean bLoadBalance, boolean bSessionCache, boolean bEncrypted) throws TacException
	Estabelece uma conexão cifrada com o HSM utilizando OTP.
static byte[]	getHSMTLSCert (String strAddr, int nPort, int nOutFormat) throws TacException
	Recupera o certificado TLS do HSM sem abrir uma sessão autenticada.
void	openSessionCert (String strAddr, String strUsrId, String strPwd, byte[] baPrivKey, String strPrivKeyPwd, byte[] baPrivKeyCert, byte[] baHSMCert, int nPort, int nFlags) throws TacException
	Estabelece uma conexão com o HSM autenticada por usuário, senha e certificado (autenticação mútua TLS).
void	openSessionHsmCert (String strAddr, String strUsrId, String strPwd, byte[] baHSMCert, int nPort, int nFlags) throws TacException
	Estabelece uma conexão com o HSM autenticada por usuário, senha e verificação do certificado do HSM.
void	closeSession (int nFlags) throws TacException
	Encerra a conexão com o HSM.
void	closeSession (boolean bPhysicallyClose) throws TacException
	Encerra a conexão com o HSM.
void	closeSession () throws TacException
	Finaliza a sessão entregando de volta a conexão aberta para o pool de gerenciamento.
long	getCID () throws TacException
	Recupera o CID (Correlation ID) da sessão corrente.

Funções

openSession() [1/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd ) throws TacException

Estabelece uma conexão cifrada com o HSM.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do usuário do HSM.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do usuário.

openSession() [2/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		boolean	bLoadBalance ) throws TacException

Estabelece uma conexão cifrada com o HSM.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do usuário do HSM.
bLoadBalance	Se verdadeiro utiliza o load balance

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do usuário.

openSession() [3/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		String	strOtp,
		boolean	bLoadBalance ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando OTP.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do usuário do HSM.
strOtp	OTP do usuário do HSM.
bLoadBalance	Se verdadeiro utiliza o load balance

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do usuário.

openSession() [4/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		String	strOtp ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando OTP.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do usuário do HSM.
strOtp	OTP do usuário do HSM.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do usuário.

openSession() [5/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do Usuário do HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
nFlags	Sempre igual a zero.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [6/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		String	strOtp,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando as configurações de load balance e OTP.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
strUsrId	Usuário do HSM.
strPwd	Senha do Usuário do HSM.
strOtp	Otp do Usuário do HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
nFlags	Sempre igual a zero.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

setOpenSession()

void setOpenSession

(

byte[]

session

)

Define um handle de sessão previamente aberto para ser usado nesta instância.

Parâmetros

session

Handle de sessão previamente aberto

openSession() [7/12]

void openSession	(	String	strAddr,
		TacAccessToken	stAToken,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando AToken.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
stAToken	AToken de acesso ao HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
nFlags	Sempre igual a zero.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [8/12]

void openSession	(	String	strAddr,
		byte[]	jbaAToken,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando AToken.

Parâmetros

strAddr	Endereço IP do HSM. Se passado em branco o sistema utiliza o load balance
jbaAToken	AToken de acesso ao HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
nFlags	Sempre igual a zero.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [9/12]

void openSession	(	String	strAddr,
		TacAccessToken	stAToken,
		int	nPort,
		boolean	bLoadBalance,
		boolean	bSessionCache,
		boolean	bEncrypted ) throws TacException

Estabelece uma conexão com o HSM utilizando AToken.

Parâmetros

strAddr	Endereço IP do HSM.
stAToken	AToken de acesso ao HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
bLoadBalance	Se verdadeiro utiliza o load balance
bSessionCache	Se verdadeiro utiliza o gerenciador de cache de sessão.
bEncrypted	Se verdadeiro utiliza uma conexão criptografada. Algumas operações como geração de chaves ou troca de senha de Usuário só pode ser utilizada em conexões criptografadas.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [10/12]

void openSession	(	String	strAddr,
		byte[]	jbaAToken,
		int	nPort,
		boolean	bLoadBalance,
		boolean	bSessionCache,
		boolean	bEncrypted ) throws TacException

Estabelece uma conexão com o HSM utilizando AToken.

Parâmetros

strAddr	Endereço IP do HSM.
jbaAToken	AToken de acesso ao HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
bLoadBalance	Se verdadeiro utiliza o load balance
bSessionCache	Se verdadeiro utiliza o gerenciador de cache de sessão.
bEncrypted	Se verdadeiro utiliza uma conexão criptografada. Algumas operações como geração de chaves ou troca de senha de Usuário só pode ser utilizada em conexões criptografadas.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [11/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		int	nPort,
		boolean	bLoadBalance,
		boolean	bSessionCache,
		boolean	bEncrypted ) throws TacException

Estabelece uma conexão cifrada com o HSM.

Parâmetros

strAddr	Endereço IP do HSM.
strUsrId	Usuário do HSM.
strPwd	Senha do Usuário do HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
bLoadBalance	Se verdadeiro utiliza o load balance
bSessionCache	Se verdadeiro utiliza o gerenciador de cache de sessão.
bEncrypted	Se verdadeiro utiliza uma conexão criptografada. Algumas operações como geração de chaves ou troca de senha de Usuário só pode ser utilizada em conexões criptografadas.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

openSession() [12/12]

void openSession	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		String	strOtp,
		int	nPort,
		boolean	bLoadBalance,
		boolean	bSessionCache,
		boolean	bEncrypted ) throws TacException

Estabelece uma conexão cifrada com o HSM utilizando OTP.

Parâmetros

strAddr	Endereço IP do HSM.
strUsrId	Usuário do HSM.
strPwd	Senha do Usuário do HSM.
strOtp	OTP do Usuário do HSM.
nPort	Porta do HSM. Atenção: só é possível utilizar a 4433.
bLoadBalance	Se verdadeiro utiliza o load balance
bSessionCache	Se verdadeiro utiliza o gerenciador de cache de sessão.
bEncrypted	Se verdadeiro utiliza uma conexão criptografada. Algumas operações como geração de chaves ou troca de senha de Usuário só pode ser utilizada em conexões criptografadas.

Exceções

TacException

Lançada quando ocorre um erro no acesso ou validação do Usuário.

getHSMTLSCert()

static byte[] getHSMTLSCert ( String strAddr, int nPort, int nOutFormat ) throws TacException

static

Recupera o certificado TLS do HSM sem abrir uma sessão autenticada.

Este método é estático e não requer uma sessão aberta. Ele é tipicamente chamado antes de openSessionCert para obter o certificado do servidor que será verificado durante a autenticação mútua TLS.

Parâmetros

strAddr	Endereço IP ou nome do HSM.
nPort	Porta TCP do HSM (normalmente TacNDJavaLib#DEFAULT_PORT).
nOutFormat	Formato do certificado de saída. TacNDJavaLib#CERT_OUT_DER — X.509 DER TacNDJavaLib#CERT_OUT_PEM — X.509 PEM

Retorna

Certificado do HSM no formato especificado em nOutFormat.

Exceções

TacException

Lançada quando ocorre um erro na recuperação do certificado.

openSessionCert()

void openSessionCert	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		byte[]	baPrivKey,
		String	strPrivKeyPwd,
		byte[]	baPrivKeyCert,
		byte[]	baHSMCert,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão com o HSM autenticada por usuário, senha e certificado (autenticação mútua TLS).

O HSM autentica o cliente por meio de sua chave privada e certificado no nível TLS, e o cliente verifica a identidade do HSM usando o certificado do servidor (baHSMCert). Ambos os lados se autenticam mutuamente.

Parâmetros

strAddr	Endereço IP ou nome do HSM.
strUsrId	Identificação do usuário no HSM.
strPwd	Senha do usuário.
baPrivKey	Chave privada do cliente no formato PEM.
strPrivKeyPwd	Senha da chave privada informada em baPrivKey. Passar null ou string vazia se não houver senha.
baPrivKeyCert	Certificado do cliente (par da chave privada) em formato PEM ou DER. Utilizado para autenticação TLS mútua no nível do canal.
baHSMCert	Certificado do HSM no formato PEM ou DER. Obtido com getHSMTLSCert().
nPort	Porta TCP do HSM (normalmente TacNDJavaLib#DEFAULT_PORT).
nFlags	Combinação de flags de sessão, por exemplo TacNDJavaLib#ENCRYPTED_CONN.

Exceções

TacException

Lançada quando ocorre um erro na abertura da sessão.

openSessionHsmCert()

void openSessionHsmCert	(	String	strAddr,
		String	strUsrId,
		String	strPwd,
		byte[]	baHSMCert,
		int	nPort,
		int	nFlags ) throws TacException

Estabelece uma conexão com o HSM autenticada por usuário, senha e verificação do certificado do HSM.

O certificado TLS do HSM é verificado contra baHSMCert antes de prosseguir com a autenticação de usuário e senha. O cliente não apresenta certificado próprio — use openSessionCert para autenticação mútua TLS.

Parâmetros

strAddr	Endereço IP ou nome do HSM.
strUsrId	Identificação do usuário no HSM.
strPwd	Senha do usuário.
baHSMCert	Certificado do HSM no formato PEM ou DER. Obtido com getHSMTLSCert(String, int, int).
nPort	Porta TCP do HSM (normalmente TacNDJavaLib#DEFAULT_PORT).
nFlags	Combinação de flags de sessão, por exemplo TacNDJavaLib#ENCRYPTED_CONN.

Exceções

TacException

Lançada quando ocorre um erro na abertura da sessão.

closeSession() [1/3]

void closeSession

(

int

nFlags

)

throws TacException

Encerra a conexão com o HSM.

Parâmetros

nFlags

Sempre igual a zero.

Exceções

TacException

Lançada em caso de falha no fechamento da sessão.

closeSession() [2/3]

void closeSession

(

boolean

bPhysicallyClose

)

throws TacException

Encerra a conexão com o HSM.

Parâmetros

bPhysicallyClose

Determina se a sessão será fechada fisicamente, ou apenas liberada no cache local.

Exceções

TacException

Lançada em caso de falha no fechamento da sessão.

closeSession() [3/3]

void closeSession

(

)

throws TacException

Finaliza a sessão entregando de volta a conexão aberta para o pool de gerenciamento.

Exceções

TacException

Lançada em caso de falha no fechamento da sessão.

getCID()

long getCID

(

)

throws TacException

Recupera o CID (Correlation ID) da sessão corrente.

O CID possibilita a relação da operação no cliente do HSM com os logs do HSM. O CID apenas está disponível quando há uma sessão estabelecida com o HSM, caso contrário o valor será 0 (zero). Este número é normalmente representado em hexadecimal.

Retorna

CID

Exceções

TacException

Lança exceção no caso de erro