Apigee mTLS konfigurieren

Nachdem Sie Apigee mTLS auf allen Knoten in Ihrem Cluster installiert haben, müssen Sie die apigee-mtls-Komponente konfigurieren und initialisieren. Dazu müssen Sie ein Zertifikat-/Schlüsselpaar generieren und die Konfigurationsdatei auf Ihrem Administrationscomputer aktualisieren. Anschließend stellen Sie dieselben generierten Dateien und die Konfigurationsdatei auf allen Knoten im Cluster bereit und initialisieren die lokale apigee-mtls-Komponente.

apigee-mtls konfigurieren (nach der Erstinstallation)

In diesem Abschnitt wird beschrieben, wie Sie Apigee mTLS direkt nach der Erstinstallation konfigurieren. Informationen zum Aktualisieren einer vorhandenen Installation von Apigee mTLS finden Sie unter Vorhandene apigee-mtls-Konfiguration ändern.

Dieser Abschnitt gilt für Installationen in einem einzelnen Rechenzentrum. Informationen zum Konfigurieren von Apigee mTLS in einer Einrichtung mit mehreren Rechenzentren finden Sie unter Mehrere Rechenzentren für Apigee mTLS konfigurieren.

Der allgemeine Prozess zum Konfigurieren von apigee-mtls ist wie folgt:

  1. Konfigurationsdatei aktualisieren:Aktualisieren Sie auf Ihrem Administrationscomputer die Konfigurationsdatei, um die apigee-mtls-Einstellungen einzufügen.
  2. Consul installieren und Anmeldedaten generieren:Installieren Sie Consul und verwenden Sie es (optional) zum einmaligen Generieren von TLS-Anmeldedaten.

    Bearbeiten Sie außerdem Ihre Apigee-mTLS-Konfigurationsdatei, um:

    1. Anmeldedaten hinzufügen
    2. Clustertopologie definieren

    Sie können Ihre vorhandenen Anmeldedaten verwenden oder mit Consul neue generieren.

  3. Anmeldedaten und Konfigurationsdatei verteilen:Verteilen Sie dasselbe generierte Zertifikat-/Schlüsselpaar und die aktualisierte Konfigurationsdatei auf alle Knoten in Ihrem Cluster.
  4. apigee-mtls initialisieren:Initialisieren Sie die apigee-mtls-Komponente auf jedem Knoten.

Jeder dieser Schritte wird in den folgenden Abschnitten beschrieben.

Schritt 1: Konfigurationsdatei aktualisieren

In diesem Abschnitt wird beschrieben, wie Sie Ihre Konfigurationsdatei ändern, um mTLS-Konfigurationseigenschaften einzufügen. Allgemeinere Informationen zur Konfigurationsdatei finden Sie unter Konfigurationsdatei erstellen.

Nachdem Sie die Konfigurationsdatei mit den mTLS-bezogenen Eigenschaften aktualisiert haben, kopieren Sie sie auf alle Knoten im Cluster, bevor Sie die apigee-mtls-Komponente auf diesen Knoten initialisieren.

So aktualisieren Sie die Konfigurationsdatei:

  1. Öffnen Sie die Konfigurationsdatei auf Ihrem Verwaltungscomputer zur Bearbeitung.
  2. Kopieren Sie die folgenden Eigenschaften für die gegenseitige TLS-Authentifizierung und fügen Sie sie in die Konfigurationsdatei ein:
    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"

    Legen Sie den Wert der einzelnen Attribute entsprechend Ihrer Konfiguration fest.

    In der folgenden Tabelle werden diese Konfigurationsattribute beschrieben:

    Attribut Beschreibung
    ALL_IP Eine durch Leerzeichen getrennte Liste der privaten Host-IP-Adressen aller Knoten im Cluster.

    Die Reihenfolge der IP-Adressen spielt keine Rolle, muss aber in allen Konfigurationsdateien im Cluster gleich sein.

    Wenn Sie Apigee mTLS für mehrere Rechenzentren konfigurieren, listen Sie alle IP-Adressen für alle Hosts in allen Regionen auf.

    LDAP_MTLS_HOSTS Die private Host-IP-Adresse des SymasLDAP-Knotens im Cluster.
    ZK_MTLS_HOSTS

    Eine durch Leerzeichen getrennte Liste privater Host-IP-Adressen, auf denen ZooKeeper-Knoten im Cluster gehostet werden.

    Gemäß den Anforderungen müssen mindestens drei ZooKeeper-Knoten vorhanden sein.

    CASS_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste privater Host-IP-Adressen, auf denen Cassandra-Server im Cluster gehostet werden.
    PG_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste der privaten Host-IP-Adressen, auf denen Postgres-Server im Cluster gehostet werden.
    RT_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste privater Host-IP-Adressen, auf denen Router im Cluster gehostet werden.
    MTLS_ENCAPSULATE_LDAP Verschlüsselt den LDAP-Traffic zwischen dem Message Processor und dem LDAP-Server. Legen Sie y fest.
    MS_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste privater Host-IP-Adressen, auf denen Management Server-Knoten im Cluster gehostet werden.
    MP_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste der privaten Host-IP-Adressen, auf denen Message Processors im Cluster gehostet werden.
    QP_MTLS_HOSTS Eine durch Leerzeichen getrennte Liste der privaten Host-IP-Adressen, auf denen Qpid-Server im Cluster gehostet werden.
    ENABLE_SIDECAR_PROXY Bestimmt, ob Cassandra und Postgres das Service Mesh kennen sollen.

    Sie müssen diesen Wert auf „y“ setzen.

    ENCRYPT_DATA Der von Consul verwendete base64-codierte Verschlüsselungsschlüssel. Sie haben diesen Schlüssel mit dem Befehl consul keygen in Schritt 2: Consul installieren und Anmeldedaten generieren generiert.

    Dieser Wert muss für alle Knoten im Cluster identisch sein.

    PATH_TO_CA_CERT Der Speicherort der Zertifikatsdatei auf dem Knoten. Sie haben diese Datei in Schritt 2: Consul installieren und Anmeldedaten generieren generiert.

    Dieser Speicherort sollte für alle Knoten im Cluster identisch sein, damit die Konfigurationsdateien gleich sind.

    Das Zertifikat muss X509v3-codiert sein.

    PATH_TO_CA_KEY Der Speicherort der Schlüsseldatei auf dem Knoten. Sie haben diese Datei in Schritt 2: Consul installieren und Anmeldedaten generieren generiert.

    Dieser Speicherort sollte für alle Knoten im Cluster identisch sein, damit die Konfigurationsdateien gleich sind.

    Die Schlüsseldatei muss X509v3-codiert sein.

    APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR

    Die Anzahl der Tage, für die ein Zertifikat gültig ist, wenn Sie ein benutzerdefiniertes Zertifikat generieren.

    Der Standardwert ist 365. Der Höchstwert beträgt 7.865 Tage (5 Jahre).

    Zusätzlich zu den oben aufgeführten Properties verwendet Apigee mTLS mehrere zusätzliche Properties, wenn Sie es in einer Konfiguration mit mehreren Rechenzentren installieren. Weitere Informationen finden Sie unter Mehrere Rechenzentren konfigurieren.

  3. Achten Sie darauf, dass ENABLE_SIDECAR_PROXY auf „y“ gesetzt ist.
  4. Aktualisieren Sie die IP-Adressen in den hostbezogenen Properties. Verwenden Sie beim Verweisen auf die einzelnen Knoten unbedingt die privaten IP-Adressen und nicht die öffentlichen IP-Adressen.

    In späteren Schritten legen Sie die Werte der anderen Attribute wie ENCRYPT_DATA, PATH_TO_CA_CERT und PATH_TO_CA_KEY fest. Sie haben noch keine Werte für sie festgelegt.

    Beachten Sie beim Bearbeiten der Konfigurationseigenschaften von apigee-mtls Folgendes:

    • Alle Attribute sind Strings. Die Werte aller Attribute müssen in einfache oder doppelte Anführungszeichen gesetzt werden.
    • Wenn ein hostbezogener Wert mehr als eine private IP-Adresse hat, trennen Sie die einzelnen IP-Adressen durch ein Leerzeichen.
    • Verwenden Sie für alle hostbezogenen Attribute in der Konfigurationsdatei private IP-Adressen und keine Hostnamen oder öffentlichen IP-Adressen.
    • Die Reihenfolge der IP-Adressen in einem Attributwert muss in allen Konfigurationsdateien im Cluster dieselbe sein.
  5. Speichern Sie die Änderungen in der Konfigurationsdatei.

Schritt 2: Consul installieren und Anmeldedaten generieren

In diesem Abschnitt wird beschrieben, wie Sie Consul installieren und die Anmeldedaten generieren, die von den mTLS-fähigen Komponenten verwendet werden.

Sie müssen eine der folgenden Methoden zum Generieren Ihrer Anmeldedaten auswählen:

  • (Empfohlen) Erstellen Sie mit Consul eine eigene Zertifizierungsstelle (Certificate Authority, CA), wie in diesem Abschnitt beschrieben.
  • Anmeldedaten einer vorhandenen Zertifizierungsstelle mit Apigee mTLS verwenden (erweitert)

Anmeldedaten

Die Anmeldedaten bestehen aus Folgendem:

  • Zertifikat:Das TLS-Zertifikat
  • Schlüssel:Der öffentliche TLS-Schlüssel
  • Gossip-Nachricht:Ein Base64-codierter Verschlüsselungsschlüssel

Sie generieren nur einmal eine einzelne Version jeder dieser Dateien. Anschließend kopieren Sie die Schlüssel- und Zertifikatsdateien auf alle Knoten in Ihrem Cluster und fügen den Verschlüsselungsschlüssel in Ihre Konfigurationsdatei ein, die Sie ebenfalls auf alle Knoten kopieren.

Weitere Informationen zur Verschlüsselungsimplementierung von Consul finden Sie unter:

Consul installieren und Anmeldedaten generieren

Verwenden Sie ein lokales Consul-Binärprogramm, um Anmeldedaten zu generieren, die von Apigee mTLS zur Authentifizierung der sicheren Kommunikation zwischen den Knoten in Ihrem Private Cloud-Cluster verwendet werden . Daher müssen Sie Consul auf Ihrem Administrationscomputer installieren, bevor Sie Anmeldedaten generieren können.

So installieren Sie Consul und generieren mTLS-Anmeldedaten:

  1. Laden Sie auf Ihrem Verwaltungscomputer die Consul 1.8.0-Binärdatei von der HashiCorp-Website herunter.
  2. Extrahieren Sie den Inhalt der heruntergeladenen Archivdatei. Extrahieren Sie den Inhalt beispielsweise nach /opt/consul/.
  3. Erstellen Sie auf Ihrem Verwaltungscomputer eine neue Zertifizierungsstelle (Certificate Authority, CA), indem Sie den folgenden Befehl ausführen:
    /opt/consul/consul tls ca create

    Consul erstellt die folgenden Dateien, die ein Zertifikat-/Schlüsselpaar bilden:

    • consul-agent-ca.pem (Zertifikat)
    • consul-agent-ca-key.pem (Schlüssel)

    Standardmäßig sind Zertifikats- und Schlüsseldateien X509v3-codiert.

    Später kopieren Sie diese Dateien auf alle Knoten im Cluster. Derzeit müssen Sie jedoch nur entscheiden, wo auf den Knoten Sie diese Dateien ablegen. Sie sollten sich auf jedem Knoten am selben Speicherort befinden. Beispiel: /opt/apigee/.

  4. Legen Sie in der Konfigurationsdatei den Wert von PATH_TO_CA_CERT auf den Speicherort fest, an den Sie die Datei consul-agent-ca.pem auf dem Knoten kopieren möchten. Beispiel:
    PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
  5. Legen Sie den Wert von PATH_TO_CA_KEY auf den Speicherort fest, an den Sie die Datei consul-agent-ca-key.pem auf dem Knoten kopieren möchten. Beispiel:
    PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
  6. Erstellen Sie einen Verschlüsselungsschlüssel für Consul, indem Sie den folgenden Befehl ausführen:
    /opt/consul/consul keygen

    Consul gibt einen zufälligen String aus, der dem folgenden ähnelt:

    QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY=
  7. Kopieren Sie diesen generierten String und legen Sie ihn als Wert des Attributs ENCRYPT_DATA in Ihrer Konfigurationsdatei fest. Beispiel:
    ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
  8. Speichern Sie die Konfigurationsdatei.

Das folgende Beispiel zeigt die mTLS-bezogenen Einstellungen in einer Konfigurationsdatei (mit Beispielwerten):

...
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"
...

Schritt 3: Konfigurationsdatei und Anmeldedaten verteilen

Kopieren Sie die folgenden Dateien mit einem Tool wie scp auf alle Knoten:

  • Konfigurationsdatei:Kopieren Sie die aktualisierte Version dieser Datei und ersetzen Sie die vorhandene Version auf allen Knoten (nicht nur auf den Knoten, auf denen ZooKeeper ausgeführt wird).
  • consul-agent-ca.pem::Kopieren Sie die Datei an den Speicherort, den Sie in der Konfigurationsdatei als Wert von PATH_TO_CA_CERT angegeben haben.
  • consul-agent-ca-key.pem::Kopieren Sie die Datei an den Speicherort, den Sie in der Konfigurationsdatei als Wert von PATH_TO_CA_KEY angegeben haben.

Achten Sie darauf, dass die Speicherorte, an die Sie die Zertifikats- und Schlüsseldateien kopieren, mit den Werten übereinstimmen, die Sie in der Konfigurationsdatei in Schritt 2: Consul installieren und Anmeldedaten generieren festgelegt haben.

Schritt 4: apigee-mtls initialisieren

Nachdem Sie apigee-mtls auf jedem Knoten installiert, die Konfigurationsdatei aktualisiert und sie sowie die Anmeldedaten auf alle Knoten im Cluster kopiert haben, können Sie die Komponente apigee-mtls auf jedem Knoten initialisieren.

So initialisieren Sie apigee-mtls:

  1. Melden Sie sich als Root-Nutzer bei einem Knoten im Cluster an. Sie können diese Schritte auf den Knoten in beliebiger Reihenfolge ausführen.
  2. Machen Sie den Nutzer apigee:apigee zum Inhaber der aktualisierten Konfigurationsdatei, wie im folgenden Beispiel gezeigt:
    chown apigee:apigee config_file
  3. Konfigurieren Sie die apigee-mtls-Komponente mit dem folgenden Befehl:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f config_file
  4. Optional: Führen Sie den folgenden Befehl aus, um zu prüfen, ob die Einrichtung erfolgreich war:
    /opt/apigee/apigee-mtls/lib/actions/iptables.sh validate
  5. Starten Sie Apigee mTLS mit dem folgenden Befehl:
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls start

    Nach der Installation von Apigee mTLS müssen Sie diese Komponente vor allen anderen Komponenten auf dem Knoten starten.

  6. Nur Cassandra-Knoten: Für Cassandra sind zusätzliche Argumente erforderlich, damit sie im Sicherheits-Mesh funktioniert. Daher müssen Sie die folgenden Befehle auf jedem Cassandra-Knoten ausführen:
    /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. (Nur Postgres-Knoten) Für Postgres sind zusätzliche Argumente erforderlich, damit es im Sicherheits-Mesh funktioniert. Daher müssen Sie auf den Postgres-Knoten Folgendes tun:

    (Nur primär)

    1. Führen Sie die folgenden Befehle auf dem primären Postgres-Knoten aus:
      /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

    (Nur Standby)

    1. Sichern Sie Ihre vorhandenen Postgres-Daten. Wenn Sie Apigee mTLS installieren möchten, müssen Sie die primären/Standby-Knoten neu initialisieren. Dabei kommt es zu Datenverlust. Weitere Informationen finden Sie unter Primär-/Standby-Replikation für Postgres einrichten.
    2. Alle Postgres-Daten löschen:
      rm -rf /opt/apigee/data/apigee-postgresql/pgdata
    3. Konfigurieren Sie Postgres und starten Sie Postgres dann neu, wie im folgenden Beispiel gezeigt:
      /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

    Wenn Sie die Installation in einer Topologie mit mehreren Rechenzentren durchführen, verwenden Sie einen absoluten Pfad für die Konfigurationsdatei.

  8. Starten Sie die verbleibenden Apigee-Komponenten auf dem Knoten in der Startreihenfolge, wie im folgenden Beispiel gezeigt:
    /opt/apigee/apigee-service/bin/apigee-service component_name start
  9. Wiederholen Sie diesen Vorgang für jeden Knoten im Cluster.
  10. Optional: Sie können prüfen, ob die apigee-mtls -Initialisierung erfolgreich war. Verwenden Sie dazu eine oder mehrere der folgenden Methoden:
    1. iptables-Konfiguration validieren
    2. Status des Remote-Proxys prüfen
    3. Quorumstatus prüfen

    Jede dieser Methoden wird unter Konfiguration überprüfen beschrieben.

Vorhandene apigee-mtls-Konfiguration ändern

Wenn Sie eine vorhandene apigee-mtls-Konfiguration anpassen möchten, müssen Sie apigee-mtls deinstallieren und neu installieren. Außerdem müssen Sie die Anpassung auf alle Knoten anwenden.

Zur Wiederholung: Wenn Sie eine vorhandene Apigee-mTLS-Konfiguration ändern, gilt Folgendes:

  • Wenn Sie eine Konfigurationsdatei ändern, müssen Sie zuerst apigee-mtls deinstallieren und setup oder configure noch einmal ausführen:
    # 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
  • Sie müssen setup oder configure auf allen Knoten im Cluster deinstallieren und neu ausführen, nicht nur auf einem einzelnen Knoten.