Package br.ufsc.labsec.utils.env

Enum EnvSigner

java.lang.Object
java.lang.Enum<EnvSigner>
br.ufsc.labsec.utils.env.EnvSigner
All Implemented Interfaces:
Serializable, Comparable<EnvSigner>, Constable
public enum EnvSigner
extends Enum<EnvSigner>
Configurações que podem modificar o comportamento do Assinador na geração de arquivos assinados digitalmente via variáveis de ambiente.

O arquivo signer/src/main/resources/.env.example é um exemplo da sintaxe utilizada pela aplicação.

O arquivo signer/src/main/resources/.env é utilizado pela aplicação como fonte das variáveis caso exista.

Variáveis expostas pela diretiva Docker env_file têm prioridade em relação ao arquivo supracitado.

  • Enum Constant Details

    • URL_BASE

      public static final EnvSigner URL_BASE
      URL padrão para requisições através da documentação OpenAPI. Esta variável não tem valor padrão e deve ser configurada a priori.

    • URL_DESCRIPTION

      public static final EnvSigner URL_DESCRIPTION
      Texto de ajuda para identificação da variável URL_BASE, útil quando outros servidores são configurados na documentação OpenAPI. Esta variável não tem valor padrão e deve ser configurada a priori.

    • PATH_STORAGE

      public static final EnvSigner PATH_STORAGE
      Caminho absoluto do diretório para escrita de arquivos em cache. O usuário do sistema operacional ou contêiner executando a aplicação deve ter permissão de leitura e escrita de arquivos neste diretório.

    • DATABASE_PATH

      public static final EnvSigner DATABASE_PATH
      Caminho absoluto do arquivo onde o banco de dados SQLite para âncoras de confiança é armazenado. O usuário do sistema operacional ou contêiner executando a aplicação deve ter permissão de leitura e escrita de arquivos no diretório pai.

    • CLEAR_DATABASE

      public static final EnvSigner CLEAR_DATABASE
      Exclui o arquivo de banco de dados de âncoras de confiança a cada inicialização da aplicação. Os valores permitidos são true e false.

    • YKUE_BROKER

      public static final EnvSigner YKUE_BROKER
      URL de conexão com o broker MQTT do Ykue. O padrão é o definido pelo próprio Ykue, em YkueConstants.MQTT_TLS_BROKER.

    • YKUE_USER

      public static final EnvSigner YKUE_USER
      Usuário para utilização do broker MQTT que se comunica com o gerenciador de identidades Ykue, instanciado em YkueWrapper. Esta variável não tem valor padrão e deve ser configurada a priori.

    • YKUE_PASS

      public static final EnvSigner YKUE_PASS
      Senha associada ao usuário YKUE_USER. Esta variável não tem valor padrão e deve ser configurada a priori.

    • TSA_URL

      public static final EnvSigner TSA_URL
      URL de carimbadora conforme a RFC 3161. Para o caso de autenticação por OAuth2, o token a ser utilizado deve ser primeiramente obtido em TSA_TOKEN_URL. Mutuamente exclusivo com TSA_CERT_URL.

    • TSA_TOKEN_URL

      public static final EnvSigner TSA_TOKEN_URL
      URL de obtenção do token de acesso para TSA_URL quando utilizada autenticação de carimbadora OAuth2 conforme RFC 6749.

    • TSA_AUTH_TYPE

      public static final EnvSigner TSA_AUTH_TYPE
      Tipo de autenticação de carimbadora remota, podendo ser "Basic" ou "OAuth2". TSA_URL sempre se refere ao endpoint de carimbamento, independente do tipo. No caso de autenticação por OAuth2, há a necessidade de TSA_TOKEN_URL para se obter o accessToken referente.

    • TSA_CLIENT_ID

      public static final EnvSigner TSA_CLIENT_ID
      Identificador do cliente para o serviço de carimbadora, disponível em TSA_URL.

    • TSA_CLIENT_SECRET

      public static final EnvSigner TSA_CLIENT_SECRET
      Senha para o serviço de carimbadora associada ao identificador TSA_CLIENT_ID.

    • TSA_CERT_URL

      public static final EnvSigner TSA_CERT_URL
      URL para arquivo PKCS#12 de carimbadora, contendo o seu certificado e chave privada.

    • TSA_CERT_PASS

      public static final EnvSigner TSA_CERT_PASS
      Senha do arquivo PKCS#12 em TSA_CERT_URL.

    • TSA_CERT_ALIAS

      public static final EnvSigner TSA_CERT_ALIAS
      Alias do certificado do arquivo PKCS#12 em TSA_CERT_URL.

    • IMMEDIATE_ANCHOR_UPDATE

      public static final EnvSigner IMMEDIATE_ANCHOR_UPDATE
      Executa adições e remoções de âncoras de confiança imediatamente após a requisição. Caso contrário, as alterações são aplicadas apenas na próxima execução do Scheduler Os valores permitidos são true e false.

    • MAX_REQUEST_SIZE_MB

      public static final EnvSigner MAX_REQUEST_SIZE_MB
      Configura o tamanho máximo permitido de uma requisição (em MB).

    • REQUEST_RATE_LIMIT_BUCKET_DURATION_SECONDS

      public static final EnvSigner REQUEST_RATE_LIMIT_BUCKET_DURATION_SECONDS
      Especifica o período de tempo durante o qual um determinado número de solicitações é permitido. O período deve ser especificado em segundos.

    • REQUEST_RATE_LIMIT_BUCKET_REQUESTS

      public static final EnvSigner REQUEST_RATE_LIMIT_BUCKET_REQUESTS
      Define o número máximo de solicitações permitidas durante o intervalo de tempo especificado para o limite de taxa de solicitações. Ou seja, determina quantas solicitações podem ser feitas dentro do intervalo de tempo definido.

  • Method Details

    • values

      public static EnvSigner[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static EnvSigner valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • get

      public Object get()