Configura TLS para la API de administración

De forma predeterminada, TLS está inhabilitado para la API de Management y accedes a la API de administración de Edge a través de HTTP con la dirección IP del nodo del servidor de administración y el puerto 8080. Por ejemplo:

http://ms_IP:8080

Como alternativa, puedes configurar el acceso de TLS a la API de administración para que puedas acceder a ella de la siguiente manera:

https://ms_IP:8443

En este ejemplo, configurarás el acceso TLS para usar el puerto 8443. Sin embargo, Edge no requiere ese número de puerto: puedes configurar el servidor de administración para que use otros valores de puerto. El único requisito es que tu firewall permita el tráfico a través del puerto especificado.

Para garantizar la encriptación del tráfico hacia y desde tu API de Management, establece la configuración en el archivo /opt/apigee/customer/application/management-server.properties.

Además de la configuración de TLS, también puedes controlar la validación de la contraseña (longitud y seguridad) modificando el archivo management-server.properties.

Asegúrate de que el puerto TLS esté abierto

En el procedimiento de esta sección, se configura TLS para usar el puerto 8443 en el servidor de administración. Independientemente del puerto que uses, debes asegurarte de que esté abierto en el servidor de administración. Por ejemplo, puedes usar el siguiente comando para abrirlo:

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

Configura TLS

Edita el archivo /opt/apigee/customer/application/management-server.properties para controlar el uso de TLS en el tráfico hacia y desde tu API de administración. Si este archivo no existe, créalo.

Para configurar el acceso de TLS a la API de administración, sigue estos pasos:

  1. Genera el archivo JKS del almacén de claves que contiene tu certificación TLS y tu clave privada. Para obtener más información, consulta Configura TLS/SSL para Edge local.
  2. Copia el archivo JKS del almacén de claves en un directorio del nodo del servidor de administración, como /opt/apigee/customer/application.
  3. Cambia la propiedad del archivo JKS al usuario "apigee":
    chown apigee:apigee keystore.jks

    Donde keystore.jks es el nombre de tu archivo de almacén de claves.

  4. Edita /opt/apigee/customer/application/management-server.properties para establecer las siguientes propiedades. Si ese archivo no existe, créalo:
    conf_webserver_ssl.enabled=true
    # Leave conf_webserver_http.turn.off set to false
    # because many Edge internal calls use HTTP.
    conf_webserver_http.turn.off=false
    conf_webserver_ssl.port=8443
    conf_webserver_keystore.path=/opt/apigee/customer/application/keystore.jks
    # Enter the obfuscated keystore password below.
    conf_webserver_keystore.password=OBF:obfuscatedPassword

    Donde keyStore.jks es tu archivo de almacén de claves y obfuscatedPassword es la contraseña ofuscada del almacén de claves. Consulta Configura TLS/SSL para Edge local para obtener información sobre cómo generar una contraseña ofuscada.

  5. Reinicia el servidor de administración de Edge con el siguiente comando:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

La API de Management ahora admite el acceso a través de TLS.

Configura la IU de Edge para usar TLS y acceder a la API de Edge

En el procedimiento anterior, Apigee recomendó dejar conf_webserver_http.turn.off=false para que la IU de Edge pueda seguir realizando llamadas a la API de Edge a través de HTTP.

Usa el siguiente procedimiento para configurar la IU de Edge de modo que realice estas llamadas solo a través de HTTPS:

  1. Configura el acceso de TLS a la API de administración como se describió anteriormente.
  2. Después de confirmar que TLS funciona para la API de Management, edita /opt/apigee/customer/application/management-server.properties para establecer la siguiente propiedad:
    conf_webserver_http.turn.off=true
  3. Reinicia el servidor de administración de Edge con el siguiente comando:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart 
  4. Edita /opt/apigee/customer/application/ui.properties para establecer la siguiente propiedad para la IU de Edge:
    conf_apigee_apigee.mgmt.baseurl="https://FQ_domain_name:port/v1"

    En el ejemplo anterior, FQ_domain_name es el nombre de dominio completo, según la dirección del certificado del servidor de administración, y port es el puerto que se especificó antes con conf_webserver_ssl.port.

    Si ui.properties no existe, créalo.

  5. Solo si usaste un certificado autofirmado (no se recomienda en un entorno de producción) cuando configuraste el acceso de TLS a la API de administración anterior, agrega la siguiente propiedad a ui.properties:
    conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate=true

    De lo contrario, la IU de Edge rechazará un certificado autofirmado.

  6. Reinicia la IU de Edge con el siguiente comando:
    /opt/apigee/apigee-service/bin/apigee-service edge-ui restart

Propiedades de TLS para el servidor de administración

En la siguiente tabla, se enumeran todas las propiedades de TLS/SSL que puedes establecer en management-server.properties:

Propiedades Descripción

conf_webserver_http.port=8080

El valor predeterminado es 8080.

conf_webserver_ssl.enabled=false

Para habilitar o inhabilitar TLS/SSL. Con TLS/SSL habilitado (true), también debes establecer las propiedades ssl.port y keystore.path.

conf_webserver_http.turn.off=true

Para habilitar o inhabilitar HTTP junto con HTTPS. Si solo quieres usar HTTPS, deja el valor predeterminado en true.

conf_webserver_ssl.port=8443

Es el puerto TLS/SSL.

Es obligatorio cuando TLS/SSL está habilitado (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.path=path

Es la ruta de acceso al archivo de almacén de claves.

Es obligatorio cuando TLS/SSL está habilitado (conf_webserver_ssl.enabled=true).

conf_webserver_keystore.password=password

Usa una contraseña ofuscada con este formato: OBF:xxxxxxxxxx

conf_webserver_cert.alias=alias

Alias opcional del certificado del almacén de claves

conf_webserver_keymanager.password=password

Si tu administrador de claves tiene una contraseña, ingresa una versión ofuscada de la contraseña en este formato:

OBF:xxxxxxxxxx

conf_webserver_trust.all=[false | true]

conf_webserver_trust.store.path=path

conf_webserver_trust.store.password=password

Establece la configuración de tu almacén de confianza. Determina si quieres aceptar todos los certificados TLS/SSL (por ejemplo, para aceptar tipos no estándar). La ruta predeterminada es false. Proporciona la ruta de acceso a tu almacén de confianza y, luego, ingresa una contraseña ofuscada para el almacén de confianza con este formato:

OBF:xxxxxxxxxx

conf_webserver_exclude.cipher.suites=CIPHER_SUITE_1 CIPHER_SUITE_2

conf_webserver_include.cipher.suites=

Indica los conjuntos de algoritmos de cifrado que deseas incluir o excluir. Por ejemplo, si descubres una vulnerabilidad en un algoritmo de cifrado, puedes excluirlo aquí. Separa varios algoritmos de cifrado con un espacio.

Para obtener información sobre los conjuntos de algoritmos de cifrado y la arquitectura de criptografía, consulta la documentación de los proveedores de Oracle de la arquitectura de criptografía de Java para JDK 8.

conf_webserver_ssl.session.cache.size=

conf_webserver_ssl.session.timeout=

Son números enteros que determinan lo siguiente:

  • Es el tamaño de la caché de la sesión TLS/SSL (en bytes) para almacenar información de la sesión de varios clientes.
  • Es la cantidad de tiempo que pueden durar las sesiones de TLS/SSL antes de que se agote el tiempo de espera (en milisegundos).