Configuração

Info

A partir da versão 4.13.0 do client do HSM, a configuração via arquivo de configuração Configuration.ND foi descontinuada.

A CSP JCA/JCE do Dinamo está em uma camada acima da API nativa do Dinamo. Consulte o tópico Variáveis de ambiente sobre opções de configuração da biblioteca cliente.

A configuração da JCA/JCE dinamo pode ser feita das seguintes formas (pela ordem):

1. Propriedades de sistema (System properties);
2. Arquivo de propriedades de sistema;
3. Variáveis de ambiente;
4. Windows Credential Manager.

O carregamento das informações segue a ordem de prioridade acima. Por exemplo, se houver uma configuração em variável de ambiente e também houver a mesma configuração feita via propriedades de sistema, a configuração feita na propriedade de sistema prevalecerá.

Configurações

Arquivo de Configuração

Define o caminho completo do arquivo de configuração, do tipo propriedades de sistema. A definição deste arquivo é opcional. E nele as configurações devem ser informadas como propriedades de sistema.

Exemplo de arquivo:

.properties

dinamo.hsm.jca.ip=127.0.0.1
dinamo.hsm.jca.user=master
dinamo.hsm.jca.pwd=12345678

Tipo	Chave
Propriedade de sistema	dinamo.hsm.config.file
Variável de ambiente	HSM_JCA_CONFIG_FILE

Endereço IP

Endereço do HSM.

Opcional caso o balanceamento de carga esteja habilitado.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.ip
Variável de ambiente	HSM_JCA_IP
Windows Credential Manager	Target

Usuário

Nome do usuário do HSM.

Opcional se utilizar tokens de acesso ou Windows Credential.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.user
Variável de ambiente	HSM_JCA_USER
Windows Credential Manager	User Name

Senha

Senha do usuário

Opcional se utilizar tokens de acesso ou Windows Credential.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.pwd
Variável de ambiente	HSM_JCA_PWD
Windows Credential Manager	Password

Token de Acesso

Tokens de acesso do HSM. Dever ser informado em base 64.

Torna usuário e senha desnecessários.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.atoken
Variável de ambiente	HSM_JCA_ATOKEN

Ignora o Balanceamento

Faz o bypass do load balance e torna ip obrigatório.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.bypass.lb
Variável de ambiente	HSM_JCA_BYPASS_LB

Aceita os valores true ou false.

Se não for informado, falor padrão é false.

Nível de Log

Nìvel de log da JCA.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.log.level
Variável de ambiente	HSM_JCA_LOG_LEVEL

Valores possíveis.

Tipo	Valor
Desabilitado	0
Info	1
Warning	2
Error	3
Debug	4

Se não for informado, o valor padrão é 0.

Arquivo de Log

Caminho para o arquivo de log, incluindo nome do arquivo.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.log.path
Variável de ambiente	HSM_JCA_LOG_PATH

Se não for informado, o valor padrão é DinamoJCA.log.

Desabilita TLS

Desabilita a conexão encriptada TLS.

Perigo

Usar apenas para casos específicos de depuração. Agumas operações podem não funcionar com esta opção habilitada.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.disable.tls
Variável de ambiente	HSM_JCA_DISABLE_TLS

Aceita os valores true ou false.

Se não for informado, falor padrão é false.

Chaves Exportáveis

Simétricas

Criar chaves simétricas como exportáveis.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.exportable.symkey
Variável de ambiente	HSM_JCA_EXPORTABLE_SYMKEY

Aceita os valores true ou false.

Se não for informado, falor padrão é true.

Assimétricas

Criar chaves assimétricas como exportáveis.

Tipo	Chave
Propriedade de sistema	dinamo.hsm.jca.exportable.asymkey
Variável de ambiente	HSM_JCA_EXPORTABLE_ASYMKEY

Aceita os valores true ou false.

Se não for informado, falor padrão é false.

Propriedades de Sistema

Podem ser definidas como configurações, parâmetros, programaticamente ou outra forma disponível.

Exemplo:

java -D"dinamo.hsm.jca.ip=127.0.0.1" -D"dinamo.hsm.jca.user=master" -D"dinamo.hsm.jca.pwd=12345678" -jar app.jar

Arquivo de Propriedades

Arquivo de propriedades. Informar o arquivo de configuração através de propriedades de sistema ou variável de ambiente.

Exemplo de arquivo:

conf.properties

dinamo.hsm.jca.ip=127.0.0.1
dinamo.hsm.jca.user=master
dinamo.hsm.jca.pwd=12345678

Exemplo de chamada:

java -D"dinamo.hsm.config.file=conf.properties" -jar app.jar

Variáveis de Ambiente

Definir de acordo com o sistema operacional.

Exemplo:

export HSM_JCA_IP="127.0.0.1"
export HSM_JCA_USER="master"
export HSM_JCA_PWD="12345678"

Credential Manager

Credenciais Windows podem ser utilizadas e estão em último lugar na ordem de precedência.

Esta credencial será utilizada quando o Endereço for configurado (propriedades de sistema, variáveis de ambiente ou arquivo de configuração) na JCA e o usuário e senha não.

Utilizando o Credential Manager (Gerenciador de Credenciais) do Windows na opção de Windows Credentials é possível criar uma credencial genérica.

Gerenciador de Credenciais do Windows

Esta credencial genérica deve ter o IP do HSM como endereço e o usuário e senha definidos nos campos correspondentes.

Criação de nova credencial

Nas configurações da JCA, deve-se informar o Endereço IP do HSM e ele será utilizado para encontrar a credencial no Gerenciador de Credenciais do Windows.

Exemplo de configuração:

export HSM_JCA_IP="127.0.0.1"