Habilita la encriptación de claves secretas

En este documento, se explica cómo habilitar la encriptación de los secretos de consumidor de la app para desarrolladores (credenciales de cliente) almacenados en la base de datos de Cassandra.

Descripción general

Tradicionalmente, Apigee Edge para nube privada proporcionó encriptación opcional para los datos del mapa de pares clave-valor (KVM) y los tokens de acceso de OAuth.

En la siguiente tabla, se describen las opciones de encriptación para los datos en reposo en Apigee para la nube privada:

Entidad Encriptación habilitada de forma predeterminada Encriptación disponible de forma opcional Documentación relacionada
KVM No Sí Consulta Acerca de los KVM encriptados.
Tokens de acceso de OAuth No Sí Consulta Tokens de hash para mayor seguridad.
Secretos de consumidor de la app para desarrolladores No Sí Para habilitar, realiza los pasos de configuración que se indican en este documento.

Para habilitar la encriptación de las credenciales de cliente, debes realizar las siguientes tareas en todos los nodos del servidor de administración y del procesador de mensajes:

  • Crea un almacén de claves para almacenar una clave de encriptación de claves (KEK). Apigee usa esta clave encriptada para encriptar las claves secretas necesarias para encriptar tus datos.
  • Edita las propiedades de configuración en todos los nodos del servidor de administración y de Message Processor.
  • Crea una app para desarrolladores para activar la creación de claves.
  • Reinicia los nodos.

Estas tareas se explican en este documento.

Qué debes saber sobre la función de encriptación de claves

En los pasos de este documento, se explica cómo habilitar la función KEK, que permite que Apigee encripte las claves secretas que se usan para encriptar los secretos de consumidor de la app para desarrolladores cuando se almacenan en reposo en la base de datos de Cassandra.

De forma predeterminada, los valores existentes en la base de datos no se modificarán (en texto sin formato) y seguirán funcionando como antes.

Si realizas alguna operación de escritura en una entidad sin encriptar, se encriptará cuando la operación se guarde. Por ejemplo, si revocas un token sin encriptar y, luego, lo apruebas , el token recién aprobado se encriptará.

Cómo proteger las claves

Asegúrate de almacenar una copia del almacén de claves en el que se almacena la KEK en una ubicación segura. Te recomendamos que uses tu propio mecanismo seguro para guardar una copia del almacén de claves. Como explican las instrucciones de este documento, se debe colocar un almacén de claves en cada nodo de Message Processor y del servidor de administración en el que el archivo de configuración local pueda hacer referencia a él. Sin embargo, también es importante almacenar una copia del almacén de claves en otro lugar para su protección y como copia de seguridad.

Cómo habilitar la encriptación de claves

Sigue estos pasos para la encriptación de claves secretas de consumidor:

Requisitos previos

Debes cumplir con estos requisitos antes de realizar los pasos de este documento:

  • Debes instalar o actualizar a Apigee Edge para nube privada 4.50.00.10 o versiones posteriores.
  • Debes ser administrador de Apigee Edge para nube privada.

Paso 1: Genera un almacén de claves

Sigue estos pasos para crear un almacén de claves que contenga la clave de encriptación de claves (KEK):

  1. Ejecuta el siguiente comando para generar un almacén de claves que almacene una clave que se usará para encriptar la KEK. Ingresa el comando exactamente como se muestra. (Puedes proporcionar el nombre del almacén de claves que desees):
    keytool -genseckey -alias KEYSTORE_NAME -keyalg AES -keysize 256 \
-keystore kekstore.p12 -storetype PKCS12

    Cuando se te solicite, ingresa una contraseña. Usarás esta contraseña en las secciones posteriores cuando configures el servidor de administración y el procesador de mensajes.

    Este comando genera un archivo de almacén de claves kekstore.p12 que contiene una clave con el alias KEYSTORE_NAME.

  2. (Opcional) Verifica que el archivo se haya generado correctamente con el siguiente comando. Si el archivo es correcto, el comando muestra una clave con el alias KEYSTORE_NAME: 
    keytool -list -keystore kekstore.p12

Paso 2: Configura el servidor de administración

A continuación, configura el servidor de administración. Si tienes servidores de administración instalados en varios nodos, debes repetir estos pasos en cada nodo.

  1. Copia el archivo de almacén de claves que generaste en el paso 1 en un directorio del nodo del servidor de administración, como /opt/apigee/customer/application. Por ejemplo: 
    cp certs/kekstore.p12 /opt/apigee/customer/application
  2. Asegúrate de que el archivo sea legible para el usuario apigee: 
    chown apigee:apigee /opt/apigee/customer/application/kekstore.p12
     
    chmod 400 /opt/apigee/customer/application/kekstore.p12
  3. Agrega las siguientes propiedades a /opt/apigee/customer/application/management-server.properties. Si el archivo no existe, créalo. Consulta también Referencia del archivo de propiedades.
    conf_keymanagement_kmscred.encryption.enabled=true

# Fallback is true to ensure your existing plaintext credentials continue to work
conf_keymanagement_kmscred.encryption.allowFallback=true

conf_keymanagement_kmscred.encryption.keystore.path=PATH_TO_KEYSTORE_FILE
conf_keymanagement_kmscred.encryption.kek.alias=KEYSTORE_NAME

# These could alternately be set as environment variables. These variables should be
# accessible to Apigee user during bootup of the Java process. If environment
# variables are specified, you can skip the password configs below.
# KMSCRED_ENCRYPTION_KEYSTORE_PASS=
# KMSCRED_ENCRYPTION_KEK_PASS=
See also Using environment variables for configuration properties.

conf_keymanagement_kmscred.encryption.keystore.pass=KEYSTORE_PASSWORD
conf_keymanagement_kmscred.encryption.kek.pass=KEK_PASSWORD

    Ten en cuenta que KEK_PASSWORD puede ser igual a KEYSTORE_PASSWORD según la herramienta que se use para generar el almacén de claves.

  4. Reinicia el servidor de administración con los siguientes comandos: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
     
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server wait_for_ready

    El comando wait_for_ready muestra el siguiente mensaje cuando el servidor de administración está listo:

    Checking if management-server is up: management-server is up.
  5. Si tienes servidores de administración instalados en varios nodos, repite los pasos 1 a 4 anteriores en cada nodo del servidor de administración.

Paso 3: Crea una app para desarrolladores

Ahora que se actualizaron los servidores de administración, debes crear una app para desarrolladores para activar la generación de la clave que se usa para encriptar los datos de las credenciales de cliente:

  1. Crea una app para desarrolladores para activar la creación de una clave de encriptación de datos (KEK). Para obtener los pasos, consulta Cómo registrar una app.
  2. Borra la app para desarrolladores si lo deseas. No es necesario que la conserves una vez que se genere la clave de encriptación.

Paso 4: Configura los procesadores de mensajes

Hasta que se habilite la encriptación en los Message Processors, las solicitudes del entorno de ejecución no podrán procesar ninguna credencial encriptada.

  1. Copia el archivo de almacén de claves que generaste en el paso 1 en un directorio del nodo del Message Processor, como /opt/apigee/customer/application. Por ejemplo: 
    cp certs/kekstore.p12 /opt/apigee/customer/application
  2. Asegúrate de que el archivo sea legible para el usuario apigee: 
    chown apigee:apigee /opt/apigee/customer/application/kekstore.p12
  3. Agrega las siguientes propiedades a /opt/apigee/customer/application/message-processor.properties. Si el archivo no existe, créalo. Consulta también Referencia del archivo de propiedades. 
    conf_keymanagement_kmscred.encryption.enabled=true

# Fallback is true to ensure your existing plaintext credentials continue to work
conf_keymanagement_kmscred.encryption.allowFallback=true

conf_keymanagement_kmscred.encryption.keystore.path=PATH_TO_KEYSTORE_FILE
conf_keymanagement_kmscred.encryption.kek.alias=KEYSTORE_NAME

# These could alternately be set as environment variables. These variables should be
# accessible to Apigee user during bootup of the Java process. If environment
# variables are specified, you can skip the password configs below.
# KMSCRED_ENCRYPTION_KEYSTORE_PASS=
# KMSCRED_ENCRYPTION_KEK_PASS=
See also Using environment variables for configuration properties.


conf_keymanagement_kmscred.encryption.keystore.pass=KEYSTORE_PASSWORD
conf_keymanagement_kmscred.encryption.kek.pass=KEK_PASSWORD

    Ten en cuenta que KEK_PASSWORD puede ser igual a KEYSTORE_PASSWORD según la herramienta que se use para generar el almacén de claves.

  4. Reinicia el Message Processor con los siguientes comandos: 
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
     
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor wait_for_ready

    El comando wait_for_ready muestra el siguiente mensaje cuando el Message Processor está listo para procesar mensajes:

    Checking if message-processor is up: message-processor is up.
  5. Si tienes procesadores de mensajes instalados en varios nodos, repite los pasos 1 a 4 en cada nodo del procesador de mensajes.

Resumen

Cualquier app para desarrolladores que crees a partir de ahora tendrá su secreto de credenciales encriptado en reposo en la base de datos de Cassandra.

Usa variables de entorno para las propiedades de configuración

Como alternativa, puedes establecer las siguientes propiedades de configuración del Message Processor y del servidor de administración con variables de entorno. Si se configuran, las variables de entorno anulan las propiedades establecidas en el archivo de configuración del Message Processor o del servidor de administración. 

conf_keymanagement_kmscred.encryption.keystore.pass=
conf_keymanagement_kmscred.encryption.kek.pass=

Las variables de entorno correspondientes son las siguientes: 

export KMSCRED_ENCRYPTION_KEYSTORE_PASS=KEYSTORE_PASSWORD
 
export KMSCRED_ENCRYPTION_KEK_PASS=KEK_PASSWORD

Si configuras estas variables de entorno, puedes omitir estas propiedades de configuración de los archivos de configuración en los nodos del Message Processor y del servidor de administración, ya que se ignorarán: 

conf_keymanagement_kmscred.encryption.keystore.pass
conf_keymanagement_kmscred.encryption.kek.pass

Referencia del archivo de propiedades

En esta sección, se describen las propiedades de configuración que debes establecer en todos los nodos de Message Processor y del servidor de administración, como se explicó anteriormente en este documento.

Propiedad Predeterminado Descripción
conf_keymanagement_kmscred.encryption.enabled false Debe ser true para habilitar la encriptación de claves.
conf_keymanagement_kmscred.encryption.allowFallback false Establece allowFallback en true para asegurarte de que tus credenciales de texto sin formato existentes sigan funcionando.
conf_keymanagement_kmscred.encryption.keystore.path N/A Proporciona la ruta de acceso al almacén de claves KEK en el nodo de Message Processor o del servidor de administración. Consulta Paso 2: Configura el servidor de administración y Paso 3: Configura los procesadores de mensajes.
conf_keymanagement_kmscred.encryption.kek.alias N/A Alias con el que se almacena la KEK en el almacén de claves.
conf_keymanagement_kmscred.encryption.keystore.pass N/A Es opcional si usas variables de entorno para establecer estas propiedades. Consulta también Usa variables de entorno para las propiedades de configuración.
conf_keymanagement_kmscred.encryption.kek.pass N/A Es opcional si usas variables de entorno para establecer estas propiedades. Consulta también Usa variables de entorno para las propiedades de configuración.