Package br.ufsc.labsec.utils.env

Enum EnvVerifier

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

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

O arquivo verifier/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 EnvVerifier 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 EnvVerifier 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 EnvVerifier 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.

    • ONLY_VERIFY_ANCHORED

      public static final EnvVerifier ONLY_VERIFY_ANCHORED
      Esconde do relatório de verificação as assinaturas cujo caminho de certificação do assinante não resolve para uma âncora de confiança conhecida. Os valores permitidos são true e false.

    • UNRESTRICTED_ATTRIBUTE_VERIFICATION

      public static final EnvVerifier UNRESTRICTED_ATTRIBUTE_VERIFICATION
      Habilita verificação dos atributos da assinatura independentemente do caminho de certificação, assumindo o certificado do assinante como âncora de confiança. Os valores permitidos são true e false.

    • SIGNATURE_LIMIT

      public static final EnvVerifier SIGNATURE_LIMIT
      Quantidade de assinaturas máxima que podem ser enviadas na mesma requisição para a aplicação.

    • REPORT_TIMEOUT_MS

      public static final EnvVerifier REPORT_TIMEOUT_MS
      Tempo máximo de execução para a geração de um relatório de verificação. Após este tempo de execução, a aplicação é parada e o relatório é devolvido incompleto, com as informações obtidas até aquele momento.

    • DATABASE_PATH

      public static final EnvVerifier 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 EnvVerifier 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.

    • IMMEDIATE_ANCHOR_UPDATE

      public static final EnvVerifier 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.

    • YKUE_API_URI

      public static final EnvVerifier YKUE_API_URI
      URI base para requisições ao serviço do Ykue. A URI deve ser finalizada com `/`, pois o método utilizado em YkueApi usa URI.resolve(URI), que necessita disso para resolver a URI base corretamente.

    • MAX_REQUEST_SIZE_MB

      public static final EnvVerifier 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 EnvVerifier 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 EnvVerifier 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.

    • DEFAULT_DOC_MDP_VERIFICATION

      public static final EnvVerifier DEFAULT_DOC_MDP_VERIFICATION
      O valor padrão do DocMDP a ser considerado para verificação de PDFs assinados.

    • ICPBR_INCREMENTAL_UPDATES_RULES

      public static final EnvVerifier ICPBR_INCREMENTAL_UPDATES_RULES
      Define se o Verificador deve verificar atualizações incrementais com as seguintes regras do ICP-Brasil: 1) O ITI não admite alterações em formulários mesmo com documentos DOCMDP 2 e 3 2) O ITI permite a adição de representação visual de assinaturas em documentos com DOCMDP 2 Os valores permitidos são true e false.

    • LPA_CADES_URL

      public static final EnvVerifier LPA_CADES_URL
      URLs para políticas de assinatura.

    • LPA_CADES_SIGNATURE_URL

      public static final EnvVerifier LPA_CADES_SIGNATURE_URL

    • LPA_PADES_URL

      public static final EnvVerifier LPA_PADES_URL

    • LPA_PADES_SIGNATURE_URL

      public static final EnvVerifier LPA_PADES_SIGNATURE_URL

    • LPA_XADES_URL

      public static final EnvVerifier LPA_XADES_URL

    • LOGGER_LEVEL

      public static final EnvVerifier LOGGER_LEVEL
      Determina quais Levels de log terão permissão de escrita no console durante a execução da aplicação. Os níves são determinados em java.util.logging.Level

    • MAX_PARALLEL_VERIFICATIONS

      public static final EnvVerifier MAX_PARALLEL_VERIFICATIONS
      Define a quantidade máxima de verificações em paralelo realizadas pelo Verificador

    • THREAD_MEMORY_THRESHOLD

      public static final EnvVerifier THREAD_MEMORY_THRESHOLD
      Define a quantidade máxima de memória utilizada por uma única thread em MEMORY_VERIFICATION_PERIOD milissegundos, em MB

    • MEMORY_VERIFICATION_PERIOD

      public static final EnvVerifier MEMORY_VERIFICATION_PERIOD
      Define o período de verificação da quantidade de memória utilizada por uma única thread durante a verificação, em milisegundos

    • SEMAPHORE_ENABLED

      public static final EnvVerifier SEMAPHORE_ENABLED
      Define se o semáforo para verificações será utilizado

    • WATCHDOG_ENABLED

      public static final EnvVerifier WATCHDOG_ENABLED
      Define se o watchdog de memória será utilizado

    • LPA_DOWNLOAD_ON_START

      public static final EnvVerifier LPA_DOWNLOAD_ON_START
      Determina se devemos fazer download de todas as LPAs e PAs no início da aplicação.

  • Method Details

    • values

      public static EnvVerifier[] 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 EnvVerifier 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()