Configura mTLS Apigee

Dopo aver installato il componente apigee-mtls su ogni nodo nel cluster, devi configurarlo e inizializzarlo. Per farlo, genera una coppia di certificato/chiave e aggiorna il file di configurazione sulla macchina di amministrazione. Successivamente, esegui il deployment degli stessi file generati in tutti i nodi del cluster e inizializza il componente apigee-mtls locale.

Configura apigee-mtls (dopo l'installazione iniziale)

Questa sezione descrive come configurare Apigee mTLS per un singolo data center subito dopo l'installazione iniziale. Per informazioni su come aggiornare un'installazione esistente di Apigee mTLS, consulta Modificare una configurazione apigee-mtls esistente. Per informazioni sulla configurazione di più data center, consulta Configurare più data center per Apigee mTLS.

Di seguito è riportata la procedura generale per la configurazione di apigee-mtls:

  1. Aggiorna il file di configurazione: sul computer di amministrazione, aggiorna il file di configurazione in modo da includere le impostazioni apigee-mtls.
  2. Installa Consul e genera credenziali: installa Consul e utilizzalo per generare le credenziali TLS (solo una volta).

    Inoltre, modifica il file di configurazione mTLS di Apigee in:

    1. Aggiungi le informazioni sulle credenziali
    2. Definisci la topologia del cluster

    Tieni presente che puoi utilizzare le tue credenziali esistenti o generarle con Consul.

  3. Distribuisci il file di configurazione e le credenziali: Distribuisci la stessa coppia di certificato/chiave generata e il file di configurazione aggiornato a tutti i nodi nel cluster.
  4. Inizializza apigee-mtls: inizializza il componente apigee-mtls su ciascun nodo.

Ciascuno di questi passaggi è descritto nelle sezioni seguenti.

Passaggio 1: aggiorna il file di configurazione

Questa sezione descrive come modificare il file di configurazione per includere le proprietà di configurazione mTLS. Per informazioni più generali sul file di configurazione, consulta Creazione di un file di configurazione.

Dopo aver aggiornato il file di configurazione con le proprietà relative a mTLS, puoi copiarlo in tutti i nodi del cluster prima di inizializzare il componente apigee-mtls su quei nodi.

I comandi che fanno riferimento al file di configurazione utilizzano "config_file" per indicare che la sua posizione è variabile, a seconda di dove lo archivi su ciascun nodo.

Per aggiornare il file di configurazione:

  1. Sul computer di amministrazione, apri il file di configurazione.
  2. Copia il seguente set di proprietà di configurazione mTLS e incollalo nel file di configurazione:
    ALL_IP="ALL_PRIVATE_IPS_IN_CLUSTER"
    ZK_MTLS_HOSTS="ZOOKEEPER_PRIVATE_IPS"
    CASS_MTLS_HOSTS="CASSANDRA_PRIVATE_IPS"
    PG_MTLS_HOSTS="POSTGRES_PRIVATE_IPS"
    RT_MTLS_HOSTS="ROUTER_PRIVATE_IPS"
    MS_MTLS_HOSTS="MGMT_SERVER_PRIVATE_IPS"
    MP_MTLS_HOSTS="MESSAGE_PROCESSOR_PRIVATE_IPS"
    QP_MTLS_HOSTS="QPID_PRIVATE_IPS"
    LDAP_MTLS_HOSTS="OPENLDAP_PRIVATE_IPS"
    MTLS_ENCAPSULATE_LDAP="y"
    
    ENABLE_SIDECAR_PROXY="y"
    ENCRYPT_DATA="BASE64_GOSSIP_MESSAGE"
    PATH_TO_CA_CERT="PATH/TO/consul-agent-ca.pem"
    PATH_TO_CA_KEY="PATH/TO/consul-agent-ca-key.pem"
    APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR="NUMBER_OF_DAYS"

    Imposta il valore di ogni proprietà in modo che sia in linea con la tua configurazione.

    La tabella seguente descrive queste proprietà di configurazione:

    Proprietà Descrizione
    ALL_IP Un elenco separato da spazi degli indirizzi IP dell'host privato di tutti i nodi nel cluster.

    L'ordine degli indirizzi IP non è importante, tranne per il fatto che deve essere lo stesso in tutti i file di configurazione del cluster.

    Se configuri Apigee mTLS per più data center, elenca tutti gli indirizzi IP per tutti gli host in tutte le regioni.

    LDAP_MTLS_HOSTS L'indirizzo IP dell'host privato del nodo OpenLDAP nel cluster.
    ZK_MTLS_HOSTS

    Un elenco separato da spazi di indirizzi IP host privati su cui sono ospitati i nodi ZooKeeper nel cluster.

    Tieni presente che, in base ai requisiti, devono esserci almeno tre nodi ZooKeeper.

    CASS_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP host privati su cui sono ospitati i server Cassandra nel cluster.
    PG_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP host privati su cui sono ospitati i server Postgres nel cluster.
    RT_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP host privati su cui i router sono ospitati nel cluster.
    MTLS_ENCAPSULATE_LDAP Cripta il traffico LDAP tra il processore di messaggi e il server LDAP. Impostato su y.
    MS_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP di host privati su cui sono ospitati i nodi del server di gestione nel cluster.
    MP_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP host privati su cui i processori di messaggi sono ospitati nel cluster.
    QP_MTLS_HOSTS Un elenco separato da spazi di indirizzi IP host privati su cui sono ospitati i server Qpid nel cluster.
    ENABLE_SIDECAR_PROXY Determina se Cassandra e Postgres devono essere a conoscenza del mesh di servizi.

    Devi impostare questo valore su "y".

    ENCRYPT_DATA La chiave di crittografia con codifica Base64 utilizzata da Consul . Hai generato questa chiave utilizzando il comando consul keygen nel Passaggio 2: installa Consul e genera le credenziali.

    Questo valore deve essere lo stesso in tutti i nodi nel cluster.

    PATH_TO_CA_CERT La posizione del file del certificato sul nodo. Hai generato questo file nel Passaggio 2: installa Consul e genera le credenziali.

    La località deve essere la stessa per tutti i nodi nel cluster, in modo che i file di configurazione siano gli stessi.

    Il certificato deve avere la codifica X509v3.

    PATH_TO_CA_KEY La posizione del file della chiave sul nodo. Hai generato questo file nel Passaggio 2: installa Consul e genera le credenziali.

    La località deve essere la stessa per tutti i nodi nel cluster, in modo che i file di configurazione siano gli stessi.

    Il file della chiave deve essere codificato in formato X509v3.

    APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR

    Il numero di giorni per i quali un certificato è valido quando generi un certificato personalizzato.

    Il valore predefinito è 365. Il valore massimo è 7865 giorni (5 anni).

    Oltre alle proprietà elencate sopra, Apigee mTLS utilizza diverse proprietà aggiuntive quando viene installato in una configurazione multi-data center. Per maggiori informazioni, consulta Configurare più data center.

  3. Assicurati che la proprietà ENABLE_SIDECAR_PROXY sia impostata su "y".
  4. Aggiorna gli indirizzi IP nelle proprietà relative all'host. Assicurati di utilizzare gli indirizzi IP privati quando fai riferimento a ciascun nodo, non gli indirizzi IP pubblici.

    Nei passaggi successivi, imposterai i valori delle altre proprietà come ENCRYPT_DATA, PATH_TO_CA_CERT e PATH_TO_CA_KEY. Non hai ancora impostato i valori.

    Quando modifichi le proprietà di configurazione di apigee-mtls, tieni presente quanto segue:

    • Tutte le proprietà sono stringhe; devi aggregare i valori di tutte le proprietà tra virgolette singole o doppie.
    • Se un valore relativo all'host ha più di un indirizzo IP privato, separa ogni indirizzo IP con uno spazio.
    • Utilizza indirizzi IP privati e non nomi host o indirizzi IP pubblici per tutte le proprietà relative all'host nel file di configurazione.
    • L'ordine degli indirizzi IP in un valore di proprietà deve essere nello stesso ordine in tutti i file di configurazione del cluster.
  5. Salva le modifiche apportate al file di configurazione.

Passaggio 2: installa Consul e genera le credenziali

Questa sezione descrive come installare Consul e generare le credenziali.

Devi scegliere uno dei seguenti metodi per generare le credenziali:

  • Crea la tua CA utilizzando Consul, come descritto in questa sezione (consigliato)
  • Usa le credenziali di una CA esistente con Apigee mTLS (opzione avanzata)

Informazioni sulle credenziali

Le credenziali sono costituite da quanto segue:

  • Certificato: il certificato TLS ospitato su ciascun nodo
  • Chiave:la chiave pubblica TLS ospitata su ciascun nodo
  • Messaggio di gossip: una chiave di crittografia con codifica Base64

Puoi generare una sola versione di ciascuno di questi file una sola volta. Copia i file della chiave e del certificato in tutti i nodi del cluster e aggiungi la chiave di crittografia al file di configurazione che copi anche in tutti i nodi.

Per saperne di più sull'implementazione della crittografia di Consul, vedi quanto segue:

Installa Consul e genera credenziali

Utilizzi un programma binario di Consul locale per generare le credenziali utilizzate da Apigee mTLS per autenticare le comunicazioni sicure tra i nodi nel tuo cluster Private Cloud. Di conseguenza, devi installare Consul sulla macchina di amministrazione prima di poter generare le credenziali.

Per installare Consul e generare le credenziali mTLS:

  1. Sul computer di amministrazione, scarica il programma binario di Consul 1.6.2 dal sito web di HashiCorp.
  2. Estrai i contenuti del file di archivio scaricato. Ad esempio, estrai i contenuti in /opt/consul/.
  3. Sulla macchina di amministrazione, crea una nuova autorità di certificazione (CA) eseguendo questo comando:
    /opt/consul/consul tls ca create

    Consul crea i seguenti file, che sono una coppia certificato/chiave:

    • consul-agent-ca.pem (certificato)
    • consul-agent-ca-key.pem (chiave)

    Per impostazione predefinita, i file del certificato e della chiave sono codificati in formato X509v3.

    Successivamente, copierai questi file in tutti i nodi del cluster. Tuttavia, al momento devi decidere solo dove inserire i file sui nodi. Devono trovarsi nella stessa posizione su ciascun nodo. Ad esempio, /opt/apigee/.

  4. Nel file di configurazione, imposta il valore di PATH_TO_CA_CERT sulla località in cui copierai il file consul-agent-ca.pem sul nodo. Ad esempio:
    PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
  5. Imposta il valore di PATH_TO_CA_KEY sulla località in cui copierai il file consul-agent-ca-key.pem sul nodo. Ad esempio:
    PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
  6. Crea una chiave di crittografia per Consul eseguendo questo comando:
    /opt/consul/consul keygen

    Consul restituisce una stringa casuale simile alla seguente:

    QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY=
  7. Copia la stringa e impostala come valore della proprietà ENCRYPT_DATA nel file di configurazione. Ad esempio:
    ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
  8. Salva il file di configurazione.

L'esempio seguente mostra le impostazioni relative a mTLS in un file di configurazione (con valori di esempio):

...
IP1=10.126.0.121
IP2=10.126.0.124
IP3=10.126.0.125
IP4=10.126.0.127
IP5=10.126.0.130
ALL_IP="$IP1 $IP2 $IP3 $IP4 $IP5"
LDAP_MTLS_HOSTS="$IP3"
ZK_MTLS_HOSTS="$IP3 $IP4 $IP5"
CASS_MTLS_HOSTS="$IP3 $IP4 $IP5"
PG_MTLS_HOSTS="$IP2 $IP1"
RT_MTLS_HOSTS="$IP4 $IP5"
MS_MTLS_HOSTS="$IP3"
MP_MTLS_HOSTS="$IP4 $IP5"
QP_MTLS_HOSTS="$IP2 $IP1"
ENABLE_SIDECAR_PROXY="y"
ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
...

Passaggio 3: distribuisci il file di configurazione e le credenziali

Copia i seguenti file nei nodi che eseguono ZooKeeper utilizzando uno strumento come scp:

  • File di configurazione: copia la versione aggiornata di questo file e sostituisci la versione esistente su tutti i nodi (non solo su quelli che eseguono ZooKeeper).
  • consul-agent-ca.pem: copia nella posizione specificata come valore di PATH_TO_CA_CERT nel file di configurazione.
  • consul-agent-ca-key.pem: copia nella posizione specificata come valore di PATH_TO_CA_KEY nel file di configurazione.

Assicurati che le posizioni in cui copi i file del certificato e della chiave corrispondano ai valori impostati nel file di configurazione nel Passaggio 2: installa Consul e genera le credenziali.

Passaggio 4: inizializza apigee-mtls

Dopo aver aggiornato il file di configurazione, averlo copiato e le credenziali in tutti i nodi del cluster e aver installato apigee-mtls su ciascun nodo, puoi inizializzare il componente apigee-mtls su ciascun nodo.

Per inizializzare apigee-mtls:

  1. Accedi a un nodo nel cluster come utente root. Puoi eseguire questi passaggi sui nodi nell'ordine che preferisci.
  2. Imposta l'utente apigee:apigee come proprietario del file di configurazione aggiornato, come illustrato nell'esempio seguente:
    chown apigee:apigee config_file
  3. Configura il componente apigee-mtls eseguendo questo comando:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f config_file
  4. (Facoltativo) Esegui questo comando per verificare che la configurazione sia riuscita:
    /opt/apigee/apigee-mtls/lib/actions/iptables.sh validate
  5. Avvia Apigee mTLS eseguendo questo comando:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls start

    Dopo aver installato Apigee mTLS, devi avviare questo componente prima di qualsiasi altro componente sul nodo.

  6. (Solo nodi Cassandra) Cassandra richiede argomenti aggiuntivi per funzionare all'interno del mesh di sicurezza. Di conseguenza, devi eseguire i seguenti comandi su ciascun nodo Cassandra:
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra setup -f config_file
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
  7. (Solo nodi Postgres) Postgres richiede argomenti aggiuntivi per funzionare all'interno del mesh di sicurezza. Di conseguenza, sui nodi Postgres devi eseguire le seguenti operazioni:

    (Solo principale)

    1. Esegui questi comandi sul nodo master Postgres:
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql setup -f config_file
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql configure
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql restart

    (Solo standby)

    1. Esegui il backup dei dati Postgres esistenti. Per installare Apigee mTLS, devi reinizializzare i nodi master/in standby, il che comporterà la perdita di dati. Per maggiori informazioni, consulta Configurare la replica master/in standby per Postgres.
    2. Elimina tutti i dati Postgres:
      rm -rf /opt/apigee/data/apigee-postgresql/pgdata
    3. Configura Postgres e riavvia Postgres, come illustrato nell'esempio seguente:
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql setup -f config_file
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql configure
      /opt/apigee/apigee-service/bin/apigee-service apigee-postgresql restart

    Se esegui l'installazione su una topologia multi-data center, utilizza un percorso assoluto per il file di configurazione.

  8. Avvia i componenti Apigee rimanenti sul nodo nell'ordine di avvio, come illustrato nell'esempio seguente:
    /opt/apigee/apigee-service/bin/apigee-service component_name start
  9. Ripeti questa procedura per ciascun nodo nel cluster.
  10. (Facoltativo) Verifica che l'inizializzazione di apigee-mtls sia riuscita utilizzando uno o più dei seguenti metodi:
    1. Convalida la configurazione iptables
    2. Verifica lo stato del proxy remoto
    3. Verificare lo stato del quorum

    Ciascuno di questi metodi è descritto in Verificare la configurazione.

Modifica una configurazione apigee-mtls esistente

Per personalizzare una configurazione di apigee-mtls esistente, devi disinstallare e reinstallare apigee-mtls.

Per ribadire questo punto, quando modifichi una configurazione mTLS Apigee esistente:

  • Se modifichi un file di configurazione, devi prima disinstallare apigee-mtls ed eseguire nuovamente setup o configure:
    # DO THIS:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls uninstall
    
    # BEFORE YOU DO THIS:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f file
    OR
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls configure
  • Devi disinstallare ed eseguire di nuovo setup o configure su tutti i nodi del cluster, non solo su uno.