Configuração de ambiente

A configuração de ambiente define os parâmetros da biblioteca nativa e das bibliotecas de integração do HSM. Estes parâmetros são mantidos em variáveis de ambiente do sistema.

A configuração feita via console gráfica fica no escopo (perfil) do usuário, e portanto válidas e reconhecidas somente para as aplicações executando sob o perfil do usuário corrente.

Não há necessidade de perfil administrativo ou elevação de privilégio para o usuário setar ou editar a configuração de ambiente.

Informações sensíveis, como credencias de senhas e identificação de usuários, são mantidas sob controle do Gerenciador de Credenciais do Windows. Não há necessidade de abrir o gerenciador para editar as credencias, mas caso decida fazê-lo o procedimento é:

1. Para abrir digite gerenciador de credenciais na caixa de busca da barra de tarefas (taskbar) e selecione Gerenciador de Credenciais.

2. Selecione a aba Credenciais do Windows. As credencias mantidas pela console ficam na lista de Credenciais Genéricas e são pré-fixadas com a string dinamo_.

Gerenciador de Credenciais do Windows

As opções de configuração de ambiente estão agrupadas em abas:

1. Configuração de ambiente

2. Log

3. MS CAPI

4. Cloud MS CAPI

5. PKCS#11

6. Engine

As demais opções são ações diretas:

1. Tela Inicial

2. Verificar atualização

3. Sair

Após concluir a edição da configuração clique no botão Aplicar antes de trocar de aba.

Sessão

Aba Sessão

Cache de sessão

O checkbox Cache de sessão habilita e desabilita o sistema de cache de sessões da biblioteca. Veja maiores detalhes sobre o funcionamento do cache no tópico Cache de Sessão.

Balanceamento de carga

O checkbox Balanceador de carga habilita e desabilita o sistema de balanceamento da biblioteca.

O Dinamo dispõe de um mecanismo de balanceamento de carga, permitindo maior disponibilidade do ambiente e desempenho para as aplicações. É possível ter até 16 (dezesseis) unidades do HSM em sistema de balanceamento de carga, com a mesma quantidade de sessões em cada um dos equipamentos.

O balanceamento de carga é transparente para a aplicação, ou seja, uma vez habilitado no ambiente, a aplicação se beneficia sem precisar de qualquer alteração.

O funcionamento é um esquema tipo round-robin, distribuindo conexões circularmente entre os HSM configurados. A unidade de balanceamento é a sessão com o HSM, independente da carga ou das APIs utilizadas em cada sessão e também da taxa de utilização de recursos. O HSM que vai estabelecer a sessão com a aplicação é definido pela estrutura de balanceamento e não pela aplicação. O mecanismo funciona por processo, ou seja, dentro de cada processo são suas sessões que serão balanceadas; caso dois processos rodem ao mesmo tempo, cada um terá uma estrutura de balanceamento separada e independente.

Quando esta opção está habilitada, o endereço IP do HSM onde será aberta a sessão é lido da lista de balanceamento, e o endereço IP informado via API é ignorado.

Na lista de endereços IP indique os HSM que farão parte do balanceamento, utilize os botões + e - para acrescentar e remover entradas na lista.

Veja maiores detalhes em Balanceamento de Carga.

Conexão

Tentativas de conexão

Define o número de novas tentativas para estabelecer uma conexão com o HSM, caso a primeira tentativa falhe por algum motivo. O valor default é 3.

Timeout de envio

Define, dentro de uma sessão estabelecida, o tempo máximo (em milissegundos) que a biblioteca irá aguardar por uma resposta de confirmação antes de decidir que o envio falhou e uma condição de erro deve ser reportada para a aplicação.

Valor não definido significa trabalhar com o tempo default usado na pilha do protocolo TCP/IP do sistema operacional. Consulte documentação de seu sistema operacional em particular sobre este valor.

Timeout de recepção

Define, dentro de uma sessão estabelecida, o tempo máximo (em milissegundos) que a biblioteca irá aguardar por uma resposta a uma solicitação antes de decidir que a comunicação falhou e uma condição de erro deve ser reportada para a aplicação.

Valor não definido significa trabalhar com o tempo default usado na pilha do protocolo TCP/IP do sistema operacional. Consulte documentação de seu sistema operacional em particular sobre este valor.

Tempo de suspensão

É o tempo (em segundos) de suspensão no balanceamento de carga (BC), o período que a biblioteca vai retirar da lista da balanceamento um endereço problemático.

Durante a operação da biblioteca com balanceamento de carga pode acontecer de um ou mais dos endereços indicados na lista não conseguir estabelecer sessão com a aplicação. Neste caso a biblioteca vai retirar temporariamente da lista de balanceamento o endereço problemático e vai tentar uma nova conexão vencido este prazo.

Log

A configuração de log setada na aba Log é utilizada por todas as bibliotecas (nativa, MS CAPI, PKCS#11 e JCA).

Console Dinamocon

Nível de log global

O sistema tem os seguintes níveis de log:

1. Somente erros

2. Depuração

3. Desabilitar

O nível de informação logada em arquivo aumenta a partir do nível 1. No nível Desabilitado nenhum log em arquivo é gerado.

Durante o operação normal da aplicação o log geralmente fica desabilitado ou setado para o nível Apenas erros, pois os aquivos gerados podem ser bastante grande, além de impactar negativamente o desempenho. Aumente o nível de log quando precisar gerar mais informação para depuração de problemas ou como subsídio para o pessoal de suporte.

Saída padrão

Essa opção faz com que os logs sejam enviados para a saída padrão do sistema (stdout).

É a opção recomendada para ser utilizada no caso de ambientes com aplicações em containers.

Diretório de log global

Os arquivo de log são gerados individualmente para cada processo que carrega a biblioteca; cada processo gera um arquivo de log que tem a identificação do processo (Process ID ou PID) no nome do arquivo. Por exemplo, para um nome arquivo de log tacndlib.log os arquivos gerados seriam da forma tacndlib_<PID>.log, como por exemplo tacndlib_3456.log, tacndlib_5947.log, etc.

Defina uma pasta para a gravação dos arquivos de log das bibliotecas. É necessário que as aplicações tenham permissão de escrita na pasta selecionada.

MS CAPI

Consulte o tópico Configuração Local sobre detalhes de configuração da biblioteca MS CAPI ou o tópico MS Crypto API para informações gerais sobre MS CAPI.

Cloud MS CAPI

Consulte o tópico Configuração Nuvem sobre detalhes de configuração da biblioteca MS CAPI ou o tópico MS Crypto API para informações gerais sobre MS CAPI.

PKCS#11

Consulte o tópico Configuração sobre detalhes de configuração da biblioteca PKCS#11 ou o tópico PKCS#11 para informações gerais sobre PKCS#11.

Engine

Consulte o tópico Configuração sobre detalhes de configuração da biblioteca Engine OpenSSL ou o tópico Engine OpenSSL para informações gerais sobre Engine OpenSSL.

Escopo da Configuração

Usando a console Dinamocon (ou definindo as variáveis de ambiente no perfil do usuário) o escopo dos parâmetros é sempre por usuário.

Para definir um escopo por aplicação, é necessário carregar esta aplicação com uma definição específica das variáveis, por exemplo encapsulando a carga num arquivo de lote (batch).

Para definir um escopo global (do sistema) é preciso definir as variáveis na âmbito do sistema, por exemplo via painel de controle na área de variáveis de sistema.

Para detalhes sobre cada parâmetro e a variável correspondente consulte o tópico Variáveis de ambiente.