Abilitazione della crittografia della chiave segreta

Questo documento spiega come abilitare la crittografia dei secret consumer delle app per sviluppatori (credenziali client) archiviati nel database Cassandra.

Panoramica

Tradizionalmente, Apigee Edge for Private Cloud ha fornito la crittografia facoltativa per i dati della mappa chiave-valore (KVM) e i token di accesso OAuth.

La tabella seguente descrive le opzioni di crittografia per i dati inattivi in Apigee for Private Cloud:

Per abilitare la crittografia delle credenziali client, devi eseguire le seguenti attività su tutti i nodi del server di gestione e del processore di messaggi:

• Crea un archivio chiavi per archiviare una chiave di crittografia (KEK). Apigee utilizza questa chiave criptata per criptare le chiavi secret necessarie per criptare i dati.
• Modifica le proprietà di configurazione su tutti i nodi del server di gestione e del processore di messaggi.
• Crea un'app per sviluppatori per attivare la creazione della chiave.
• Riavvia i nodi.

Queste attività sono spiegate in questo documento.

Informazioni sulla funzionalità di crittografia delle chiavi

I passaggi descritti in questo documento spiegano come abilitare la funzionalità KEK, che consente ad Apigee di criptare le chiavi secret utilizzate per criptare i secret consumer delle app per sviluppatori quando vengono archiviati inattivi nel database Cassandra.

Per impostazione predefinita, tutti i valori esistenti nel database rimarranno invariati (in testo normale) e continueranno a funzionare come prima.

Se esegui un'operazione di scrittura su un'entità non criptata, questa verrà criptata al salvataggio dell' operazione. Ad esempio, se revochi un token non criptato e poi lo approvi, il token appena approvato verrà criptato.

Proteggere le chiavi

Assicurati di archiviare una copia dell'archivio chiavi in cui è archiviata la KEK in una posizione sicura. Ti consigliamo di utilizzare un meccanismo sicuro per salvare una copia dell'archivio chiavi. Come spiegano le istruzioni riportate in questo documento, un archivio chiavi deve essere inserito in ogni nodo del server di gestione e del processore di messaggi in cui il file di configurazione locale può farvi riferimento. Tuttavia, è anche importante archiviare una copia dell'archivio chiavi in un altro luogo per la sicurezza e come backup.

Abilitare la crittografia delle chiavi

Per criptare la chiave secret consumer:

Prerequisiti

Prima di eseguire i passaggi descritti in questo documento, devi soddisfare i seguenti requisiti:

• Devi installare o eseguire l'upgrade ad Apigee Edge for Private Cloud 4.50.00.10 o versioni successive.
• Devi essere un amministratore di Apigee Edge for Private Cloud.

Passaggio 1: genera un archivio chiavi

Per creare un archivio chiavi per contenere la chiave di crittografia (KEK):

1. Esegui il comando seguente per generare un archivio chiavi per archiviare una chiave che verrà utilizzata per criptare la KEK. Inserisci il comando esattamente come mostrato. (Puoi fornire il nome dell'archivio chiavi che preferisci):
   

   keytool -genseckey -alias KEYSTORE_NAME -keyalg AES -keysize 256 \
   -keystore kekstore.p12 -storetype PKCS12

   Quando richiesto, inserisci una password. Utilizzerai questa password nelle sezioni successive quando configurerai il server di gestione e il processore di messaggi.

   Questo comando genera un file di archivio chiavi kekstore.p12 contenente una chiave con l'alias KEYSTORE_NAME.

2. (Facoltativo) Verifica che il file sia stato generato correttamente con il comando seguente. Se il file è corretto, il comando restituisce una chiave con l'alias KEYSTORE_NAME:

   keytool -list -keystore kekstore.p12

Passaggio 2: configura il server di gestione

Poi, configura il server di gestione. Se hai installato i server di gestione su più nodi, devi ripetere questi passaggi su ogni nodo.

1. Copia il file dell'archivio chiavi generato nel Passaggio 1 in una directory sul nodo del server di gestione, ad esempio /opt/apigee/customer/application. Ad esempio:

   cp certs/kekstore.p12 /opt/apigee/customer/application

2. Assicurati che il file sia leggibile dall'utente apigee:

   chown apigee:apigee /opt/apigee/customer/application/kekstore.p12

   chmod 400 /opt/apigee/customer/application/kekstore.p12

3. Aggiungi le seguenti proprietà a /opt/apigee/customer/application/management-server.properties. Se il file non esiste, crealo. Consulta anche Riferimento al file delle proprietà.
   

   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

   Tieni presente che KEK_PASSWORD potrebbe essere uguale a KEYSTORE_PASSWORD a seconda dello strumento utilizzato per generare l'archivio chiavi.

4. Riavvia il server di gestione utilizzando i seguenti comandi:

   /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

   /opt/apigee/apigee-service/bin/apigee-service edge-management-server wait_for_ready

   Il comando wait_for_ready restituisce il seguente messaggio quando il server di gestione è pronto:

   Checking if management-server is up: management-server is up.

5. Se hai installato i server di gestione su più nodi, ripeti i passaggi da 1 a 4 sopra su ogni nodo del server di gestione.

Passaggio 3: crea un'app per sviluppatori

Ora che i server di gestione sono aggiornati, devi creare un'app per sviluppatori per attivare la generazione della chiave utilizzata per criptare i dati delle credenziali client:

1. Crea un'app per sviluppatori per attivare la creazione di una chiave di crittografia dei dati (KEK). Per i passaggi, consulta Registrare un'app.
2. Se vuoi, elimina l'app per sviluppatori. Non è necessario conservarla una volta generata la chiave di crittografia.

Passaggio 4: configura i processori di messaggi

Finché la crittografia non è abilitata nei processori di messaggi, le richieste di runtime non saranno in grado di elaborare le credenziali criptate.

1. Copia il file dell'archivio chiavi generato nel Passaggio 1 in una directory sul nodo del processore di messaggi, ad esempio /opt/apigee/customer/application. Ad esempio:

   cp certs/kekstore.p12 /opt/apigee/customer/application

2. Assicurati che il file sia leggibile dall'utente apigee:

   chown apigee:apigee /opt/apigee/customer/application/kekstore.p12

3. Aggiungi le seguenti proprietà a /opt/apigee/customer/application/message-processor.properties. Se il file non esiste, crealo. Consulta anche Riferimento al file delle proprietà.

   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

   Tieni presente che KEK_PASSWORD potrebbe essere uguale a KEYSTORE_PASSWORD a seconda dello strumento utilizzato per generare l'archivio chiavi.

4. Riavvia il processore di messaggi utilizzando i seguenti comandi:

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

   /opt/apigee/apigee-service/bin/apigee-service edge-message-processor wait_for_ready

   Il comando wait_for_ready restituisce il seguente messaggio quando il processore di messaggi è pronto per elaborare i messaggi:

   Checking if message-processor is up: message-processor is up.

5. Se hai installato i processori di messaggi su più nodi, ripeti i passaggi da 1 a 4 su ogni nodo del processore di messaggi.

Riepilogo

I secret delle credenziali di tutte le app per sviluppatori che crei da ora in poi verranno criptati inattivi nel database Cassandra.

Utilizzare le variabili di ambiente per le proprietà di configurazione

In alternativa, puoi impostare le seguenti proprietà di configurazione del server di gestione e del processore di messaggi utilizzando le variabili di ambiente. Se impostate, le variabili di ambiente sostituiscono le proprietà impostate nel file di configurazione del server di gestione o del processore di messaggi.

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

Le variabili di ambiente corrispondenti sono:

export KMSCRED_ENCRYPTION_KEYSTORE_PASS=KEYSTORE_PASSWORD

export KMSCRED_ENCRYPTION_KEK_PASS=KEK_PASSWORD

Se imposti queste variabili di ambiente, puoi omettere queste proprietà di configurazione dai file di configurazione sui nodi del server di gestione e del processore di messaggi, perché verranno ignorate:

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

Riferimento al file delle proprietà

Questa sezione descrive le proprietà di configurazione che devi impostare su tutti i nodi del server di gestione e del processore di messaggi, come spiegato in precedenza in questo documento.