Como configurar o TLS para a IU de gerenciamento

Por padrão, você acessa a IU do Edge por HTTP usando o endereço IP do nó do servidor de gerenciamento e a porta 9000. Exemplo:

http://ms_IP:9000

Também é possível configurar o acesso TLS à interface do Edge para acessá-lo desta forma:

https://ms_IP:9443

Neste exemplo, você configura o acesso TLS para usar a porta 9443. No entanto, esse número de porta não é exigido pela Edge. Você pode configurar o servidor de gerenciamento para usar outros valores de porta. O único requisito é que o firewall permita o tráfego na porta especificada.

Verifique se a porta TLS está aberta

O procedimento nesta seção configura o TLS para usar a porta 9443 no servidor de gerenciamento. Independentemente da porta usada, você precisa garantir que ela esteja aberta no servidor de gerenciamento. Por exemplo, use o seguinte comando para abri-lo:

iptables -A INPUT -m state --state NEW -m tcp -p tcp --dport 9443 -j ACCEPT --verbose

Configurar a TLS

Use o procedimento a seguir para configurar o acesso TLS à interface de gerenciamento:

  1. Gere o arquivo JKS do keystore que contém a certificação de TLS e a chave privada e copie-o para o nó do servidor de gerenciamento. Para mais informações, consulte Como configurar o TLS/SSL para o Edge local.
  2. Execute este comando para configurar o TLS:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-ssl
  3. Insira o número da porta HTTPS, por exemplo, 9443.
  4. Especifique se você quer desativar o acesso HTTP à interface de gerenciamento. Por padrão, a IU de gerenciamento pode ser acessada por HTTP na porta 9000.
  5. Insira o algoritmo de keystore. O padrão é JKS.
  6. Insira o caminho absoluto para o arquivo JKS do keystore.

    O script copia o arquivo para o diretório /opt/apigee/customer/conf no nó do servidor de gerenciamento e muda a propriedade do arquivo para "apigee".

  7. Digite a senha do keystore em texto não criptografado.
  8. Em seguida, o script reinicia a IU de gerenciamento do Edge. Após a reinicialização, a interface de gerenciamento vai permitir o acesso por TLS.

    Você pode conferir essas configurações no app /opt/apigee/etc/edge-ui.d/SSL.sh.

Como usar um arquivo de configuração para configurar o TLS

Como alternativa ao procedimento acima, é possível transmitir um arquivo de configuração para o comando na etapa 2 do procedimento. Você vai precisar usar esse método se quiser definir propriedades opcionais do TLS.

Para usar um arquivo de configuração, crie um novo arquivo e adicione as seguintes propriedades:

HTTPSPORT=9443
DISABLE_HTTP=y
KEY_ALGO=JKS
KEY_FILE_PATH=/opt/apigee/customer/application/mykeystore.jks
KEY_PASS=clearTextKeystorePWord

Salve o arquivo em um diretório local com o nome que quiser. Em seguida, use o seguinte comando para configurar o TLS:

/opt/apigee/apigee-service/bin/apigee-service edge-ui configure-ssl -f configFile

em que configFile é o caminho completo do arquivo que você salvou.

Configurar a IU do Edge quando o TLS for encerrado no balanceador de carga

Se você tiver um balanceador de carga que encaminha solicitações para a interface do Edge, poderá encerrar a conexão TLS no balanceador de carga e, em seguida, fazer com que o balanceador de carga encaminhe as solicitações para a interface do Edge por HTTP. Essa configuração é compatível, mas você precisa configurar o balanceador de carga e a IU do Edge de maneira adequada.

A configuração extra é necessária quando a interface do Edge envia e-mails para os usuários definirem a senha na criação do usuário ou quando ele solicita a redefinição de uma senha perdida. Esse e-mail contém um URL que o usuário seleciona para definir ou redefinir uma senha. Por padrão, se a IU do Edge não estiver configurada para usar TLS, o URL no e-mail gerado usará o protocolo HTTP, e não HTTPS. Configure o balanceador de carga e a IU do Edge para gerar um endereço de e-mail que use HTTPS.

Para configurar o balanceador de carga, verifique se ele define o seguinte cabeçalho nas solicitações encaminhadas para a interface do Edge:

X-Forwarded-Proto: https

Para configurar a interface do usuário do Edge:

  1. Abra o arquivo /opt/apigee/customer/application/ui.properties em um editor. Se o arquivo não existir, crie-o:
    vi /opt/apigee/customer/application/ui.properties
  2. Defina a seguinte propriedade em ui.properties:
    conf/application.conf+trustxforwarded=true
  3. Salve as alterações em ui.properties.
  4. Reinicie a interface do Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Como definir propriedades opcionais do TLS

A interface do usuário do Edge é compatível com as propriedades de configuração de TLS que podem ser usadas para definir o seguinte:

  • Protocolo TLS padrão
  • Lista de protocolos TLS compatíveis
  • Algoritmos TLS compatíveis
  • Criptografias TLS compatíveis

Esses parâmetros opcionais só estão disponíveis quando você define a seguinte propriedade de configuração no arquivo de configuração, conforme descrito em Como usar um arquivo de configuração para configurar o TLS:

TLS_CONFIGURE=y

A tabela a seguir descreve essas propriedades:

Propriedade Descrição
TLS_PROTOCOL Define o protocolo TLS padrão para a IU do Edge. Por padrão, é o TLS 1.2. Os valores válidos são TLSv1.2, TLSv1.1 e TLSv1.
TLS_ENABLED_PROTOCOL

Define a lista de protocolos ativados como uma matriz separada por vírgulas. Exemplo:

TLS_ENABLED_PROTOCOL=[\"TLSv1.2\", \"TLSv1.1\", \"TLSv1\"]

Observe que é necessário executar escape no caractere ".

Por padrão, todos os protocolos estão ativados.

TLS_DISABLED_ALGO

Define os pacotes de criptografia desativados e também pode ser usado para impedir que tamanhos pequenos de chave sejam usados para o handshake de TLS. Não há valor padrão.

Os valores transmitidos ao TLS_DISABLED_ALGO correspondem aos permitidos para jdk.tls.disabledAlgorithms, conforme descrito aqui. No entanto, não é permitido usar caracteres de espaço ao definir TLS_DISABLED_ALGO:

TLS_DISABLED_ALGO=EC\ keySize\ <\ 160,RSA\ keySize\ <\ 2048

TLS_ENABLED_CIPHERS

Define a lista de criptografia TLS disponíveis como uma matriz separada por vírgulas. Exemplo:

TLS_ENABLED_CIPHERS=[\"TLS_DHE_RSA_WITH_AES_128_CBC_SHA\",
\"TLS_DHE_DSS_WITH_AES_128_CBC_SHA\"]

Observe que é necessário executar escape no caractere ".

A lista padrão de criptografias ativadas é:

"TLS_DHE_RSA_WITH_AES_256_CBC_SHA",
"TLS_DHE_RSA_WITH_AES_128_CBC_SHA",
"TLS_DHE_DSS_WITH_AES_128_CBC_SHA",
"TLS_RSA_WITH_AES_256_CBC_SHA",
"TLS_RSA_WITH_AES_128_CBC_SHA",
"SSL_RSA_WITH_RC4_128_SHA",
"SSL_RSA_WITH_RC4_128_MD5",
"TLS_EMPTY_RENEGOTIATION_INFO_SCSV"

Confira a lista de criptografias disponíveis aqui.

Como desativar protocolos TLS

Para desativar os protocolos TLS, você precisa editar o arquivo de configuração, descrito em Como usar um arquivo de configuração para configurar o TLS, da seguinte maneira:

  1. Abra o arquivo de configuração em um editor.
  2. Para desativar um único protocolo TLS, por exemplo, TLSv1.0, adicione o seguinte ao arquivo de configuração:
    TLS_CONFIGURE=y
    TLS_DISABLED_ALGO="tlsv1"

    Para desativar vários protocolos, por exemplo, TLSv1.0 e TLSv1.1, adicione o seguinte ao arquivo de configuração:

    TLS_CONFIGURE=y
    TLS_DISABLED_ALGO="tlsv1, tlsv1.1"
  3. Salve as alterações no arquivo de configuração.
  4. Execute este comando para configurar o TLS:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui configure-ssl -f configFile

    em que configFile é o caminho completo para o arquivo de configuração.

  5. Reinicie a interface do Edge:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Usar cookies seguros

O Apigee Edge para nuvem privada é compatível com a adição da sinalização secure ao cabeçalho Set-Cookie para respostas da IU do Edge. Se essa sinalização estiver presente, o cookie só poderá ser enviado por canais ativados para TLS. Se não estiver presente, o cookie poderá ser enviado por qualquer canal, seja seguro ou não.

Cookies sem a sinalização secure podem permitir que um invasor capture e reutilize o cookie ou sequestre uma sessão ativa. Portanto, a prática recomendada é ativar essa configuração.

Para definir a sinalização secure para cookies da interface do Edge:

  1. Abra o seguinte arquivo em um editor de texto:
    /opt/apigee/customer/application/ui.properties

    Se o arquivo não existir, crie-o.

  2. Defina a propriedade conf_application_session.secure como true no arquivo ui.properties, como mostra o exemplo a seguir:
    conf_application_session.secure=true
  3. Salve as mudanças.
  4. Reinicie a interface do Edge usando o utilitário apigee-serice, como mostrado no exemplo a seguir:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Para confirmar se a mudança está funcionando, verifique os cabeçalhos de resposta na interface do Edge usando um utilitário como curl. Por exemplo:

curl -i -v https://edge_UI_URL

O cabeçalho precisa conter uma linha semelhante a esta:

Set-Cookie: secure; ...

Desativar o TLS na interface do Edge

Para desativar o TLS na interface do usuário do Edge, use o seguinte comando:

/opt/apigee/apigee-service/bin/apigee-service edge-ui disable-ssl