Configurer Apigee mTLS

Edge for Private Cloud v4.19.01

Après avoir installé le composant apigee-mtls sur chaque nœud du cluster, vous devez le configurer et l'initialiser. Pour ce faire, générez une paire certificat/clé et mettez à jour le fichier de configuration sur votre machine d'administration. Vous déployez ensuite les mêmes fichiers générés sur tous les nœuds du cluster et initialisez le composant apigee-mtls local.

Configurer apigee-mtls (après l'installation initiale)

Cette section explique comment configurer Apigee mTLS pour un seul centre de données immédiatement après l'installation initiale. Pour plus d'informations sur la mise à jour d'une installation existante d'Apigee mTLS, consultez Modifier une configuration apigee-mtls existante. Pour en savoir plus sur la configuration de plusieurs centres de données, consultez la page Configurer plusieurs centres de données pour Apigee mTLS.

Voici le processus général de configuration de apigee-mtls:

  1. Mettez à jour votre fichier de configuration:sur votre machine d'administration, mettez à jour le fichier de configuration pour inclure les paramètres apigee-mtls.
  2. Installer Consul et générer des identifiants:installez Consul et utilisez-le pour générer les identifiants TLS (une seule fois).

    De plus, modifiez votre fichier de configuration mTLS Apigee pour:

    1. Ajouter les informations d'identification
    2. Définir la topologie du cluster

    Notez que vous pouvez utiliser vos identifiants existants ou les générer avec Consul.

  3. Distribuez le fichier de configuration et les identifiants:distribuez la même paire certificat/clé générée et le fichier de configuration mis à jour à tous les nœuds de votre cluster.
  4. Initialiser apigee-mtls:initialisez le composant apigee-mtls sur chaque nœud.

Toutes ces étapes sont décrites plus en détail dans les sections suivantes.

Étape 1: Mettez à jour le fichier de configuration

Cette section explique comment modifier votre fichier de configuration pour inclure des propriétés de configuration mTLS. Pour plus d'informations générales sur le fichier de configuration, consultez la section Créer un fichier de configuration.

Après avoir mis à jour le fichier de configuration avec les propriétés liées à mTLS, copiez-le sur tous les nœuds du cluster avant d'initialiser le composant apigee-mtls sur ces nœuds.

Les commandes qui font référence au fichier de configuration utilisent "config_file" pour indiquer que son emplacement est variable, en fonction de l'emplacement où vous le stockez sur chaque nœud.

Pour mettre à jour le fichier de configuration:

  1. Sur votre ordinateur d'administration, ouvrez le fichier de configuration.
  2. Copiez les propriétés de configuration mTLS suivantes et collez-les dans le fichier de configuration :
    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"

    Définissez la valeur de chaque propriété de sorte qu'elle corresponde à votre configuration.

    Le tableau suivant décrit ces propriétés de configuration:

    Propriété Description
    ALL_IP Liste des adresses IP d'hôtes privés de tous les nœuds du cluster, séparées par des espaces.

    L'ordre des adresses IP n'a pas d'importance, sauf qu'il doit être le même dans tous les fichiers de configuration du cluster.

    Si vous configurez Apigee mTLS pour plusieurs centres de données, répertoriez toutes les adresses IP de tous les hôtes sur toutes les régions.

    LDAP_MTLS_HOSTS Adresse IP de l'hôte privé du nœud OpenLDAP dans le cluster.
    ZK_MTLS_HOSTS

    Liste d'adresses IP d'hôtes privés, séparées par des espaces, sur lesquelles les nœuds ZooKeeper sont hébergés dans le cluster.

    Notez que, compte tenu des exigences, il doit y avoir au moins trois nœuds ZooKeeper.

    CASS_MTLS_HOSTS Liste d'adresses IP d'hôtes privés, séparées par des espaces, sur lesquelles les serveurs Cassandra sont hébergés dans le cluster.
    PG_MTLS_HOSTS Liste d'adresses IP d'hôtes privées séparées par des espaces sur lesquelles les serveurs Postgres sont hébergés dans le cluster.
    RT_MTLS_HOSTS Liste d'adresses IP d'hôtes privés sur lesquels les routeurs sont hébergés dans le cluster, séparées par des espaces.
    MTLS_ENCAPSULATE_LDAP Chiffre le trafic LDAP entre le processeur de messages et le serveur LDAP. Défini sur y.
    MS_MTLS_HOSTS Liste d'adresses IP d'hôtes privés, séparées par des espaces, sur lesquelles les nœuds du serveur de gestion sont hébergés dans le cluster.
    MP_MTLS_HOSTS Liste d'adresses IP d'hôtes privés, séparées par des espaces, sur lesquelles les processeurs de messages sont hébergés dans le cluster.
    QP_MTLS_HOSTS Liste d'adresses IP d'hôtes privés, séparées par des espaces, sur lesquelles des serveurs Qpid sont hébergés dans le cluster.
    ENABLE_SIDECAR_PROXY Détermine si Cassandra et Postgres doivent prendre en compte le maillage de services.

    Vous devez définir cette valeur sur "y".

    ENCRYPT_DATA Clé de chiffrement encodée en base64 utilisée par Consul . Vous avez généré cette clé à l'aide de la commande consul keygen à l'Étape 2: Installez Consul et générez des identifiants.

    Cette valeur doit être identique dans tous les nœuds du cluster.

    PATH_TO_CA_CERT Emplacement du fichier de certificat sur le nœud. Vous avez généré ce fichier à l'étape 2: Installez Consul et générez des identifiants.

    Cet emplacement doit être identique sur tous les nœuds du cluster, pour que les fichiers de configuration soient identiques.

    Le certificat doit être encodé au format X509v3.

    PATH_TO_CA_KEY Emplacement du fichier de clé sur le nœud. Vous avez généré ce fichier à l'étape 2: Installez Consul et générez des identifiants.

    Cet emplacement doit être identique sur tous les nœuds du cluster, pour que les fichiers de configuration soient identiques.

    Le fichier de clé doit être encodé au format X509v3.

    APIGEE_MTLS_NUM_DAYS_CERT_VALID_FOR

    Nombre de jours pendant lesquels un certificat est accepté lorsque vous générez un certificat personnalisé.

    La valeur par défaut est 365. La valeur maximale est de 7 865 jours (5 ans).

    Outre les propriétés répertoriées ci-dessus, Apigee mTLS utilise plusieurs propriétés supplémentaires lorsque vous l'installez dans une configuration multicentre de données. Pour en savoir plus, consultez la page Configurer plusieurs centres de données.

  3. Assurez-vous que la propriété ENABLE_SIDECAR_PROXY est définie sur "y".
  4. Mettez à jour les adresses IP dans les propriétés liées à l'hôte. Veillez à utiliser les adresses IP privées pour chaque nœud, et non les adresses IP publiques.

    Au cours des étapes suivantes, vous définirez les valeurs des autres propriétés telles que ENCRYPT_DATA, PATH_TO_CA_CERT et PATH_TO_CA_KEY. Vous ne définissez pas encore leurs valeurs.

    Lorsque vous modifiez les propriétés de configuration apigee-mtls, tenez compte des points suivants:

    • Toutes les propriétés sont des chaînes. Vous devez encapsuler les valeurs de toutes les propriétés entre guillemets simples ou doubles.
    • Si une valeur liée à l'hôte comporte plusieurs adresses IP privées, séparez chaque adresse IP par un espace.
    • Utilisez des adresses IP privées et non des noms d'hôte ou des adresses IP publiques pour toutes les propriétés liées à l'hôte dans le fichier de configuration.
    • L'ordre des adresses IP dans une valeur de propriété doit être dans le même ordre dans tous les fichiers de configuration du cluster.
  5. Enregistrez les modifications apportées au fichier de configuration.

Étape 2: Installez Consul et générez des identifiants

Cette section explique comment installer Consul et générer des identifiants.

Vous devez choisir l'une des méthodes suivantes pour générer des identifiants:

  • Créez votre propre autorité de certification à l'aide de Consul, comme décrit dans cette section (recommandé)
  • Utiliser les identifiants d'une autorité de certification existante avec Apigee mTLS (avancé)

À propos des identifiants

Les identifiants sont constitués des éléments suivants:

  • Certificat:certificat TLS hébergé sur chaque nœud
  • Clé:clé publique TLS hébergée sur chaque nœud
  • Message Gossip:clé de chiffrement encodée en base64

Vous ne générez qu'une seule version de chacun de ces fichiers. Copiez les fichiers de clé et de certificat sur tous les nœuds de votre cluster, puis ajoutez la clé de chiffrement à votre fichier de configuration que vous copiez également sur tous les nœuds.

Pour en savoir plus sur l'implémentation du chiffrement par Consul, consultez les pages suivantes:

Installer Consul et générer des identifiants

Vous utilisez un binaire Consul local pour générer des identifiants qu'Apigee mTLS utilise pour authentifier les communications sécurisées entre les nœuds de votre cluster de cloud privé. Par conséquent, vous devez installer Consul sur votre machine d'administration avant de pouvoir générer des identifiants.

Pour installer Consul et générer des identifiants mTLS:

  1. Sur votre ordinateur d'administration, téléchargez le binaire Consul 1.6.2 à partir du site Web de HashiCorp.
  2. Extrayez le contenu du fichier d'archive téléchargé. Par exemple, extrayez le contenu dans /opt/consul/.
  3. Sur votre machine d'administration, créez une autorité de certification en exécutant la commande suivante :
    /opt/consul/consul tls ca create

    Consul crée les fichiers suivants, qui correspondent à une paire certificat/clé:

    • consul-agent-ca.pem (certificat)
    • consul-agent-ca-key.pem (clé)

    Par défaut, les fichiers de certificat et de clé sont encodés au format X509v3.

    Vous copierez ensuite ces fichiers sur tous les nœuds du cluster. Toutefois, pour le moment, vous ne devez choisir que l'emplacement des nœuds sur lesquels placer ces fichiers. Elles doivent se trouver au même emplacement sur chaque nœud. Exemple : /opt/apigee/.

  4. Dans le fichier de configuration, définissez la valeur de PATH_TO_CA_CERT sur l'emplacement où vous allez copier le fichier consul-agent-ca.pem sur le nœud. Par exemple :
    PATH_TO_CA_CERT="/opt/apigee/consul-agent-ca.pem"
  5. Définissez la valeur de PATH_TO_CA_KEY sur l'emplacement où vous allez copier le fichier consul-agent-ca-key.pem sur le nœud. Par exemple :
    PATH_TO_CA_KEY="/opt/apigee/consul-agent-ca-key.pem"
  6. Créez une clé de chiffrement pour Consul en exécutant la commande suivante :
    /opt/consul/consul keygen

    Consul génère une chaîne aléatoire qui ressemble à ce qui suit:

    QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY=
  7. Copiez la chaîne et définissez-la comme valeur de la propriété ENCRYPT_DATA dans le fichier de configuration. Par exemple :
    ENCRYPT_DATA="QbhgD+EXAMPLE+Y9u0742X/IqX3X429/x1cIQ+JsQvY="
  8. Enregistrez le fichier de configuration.

L'exemple suivant montre les paramètres liés à mTLS dans un fichier de configuration (avec des exemples de valeurs):

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

Étape 3: Distribuer le fichier de configuration et les identifiants

À l'aide d'un outil tel que scp, copiez les fichiers suivants sur les nœuds qui exécutent ZooKeeper:

  • Fichier de configuration:copiez la version mise à jour de ce fichier et remplacez la version existante sur tous les nœuds (pas seulement sur ceux exécutant ZooKeeper).
  • consul-agent-ca.pem::copie à l'emplacement que vous avez spécifié en tant que valeur de PATH_TO_CA_CERT dans le fichier de configuration.
  • consul-agent-ca-key.pem::copie à l'emplacement que vous avez spécifié comme valeur de PATH_TO_CA_KEY dans le fichier de configuration.

Assurez-vous que les emplacements dans lesquels vous copiez le certificat et les fichiers de clé correspondent aux valeurs que vous avez définies dans le fichier de configuration à l'Étape 2: Installer Consul et générer des identifiants.

Étape 4: Initialiser apigee-mtls

Une fois que vous avez mis à jour votre fichier de configuration, que vous l'avez copié ainsi que les identifiants sur tous les nœuds du cluster, et que vous avez installé apigee-mtls sur chaque nœud, vous êtes prêt à initialiser le composant apigee-mtls sur chaque nœud.

Pour initialiser apigee-mtls:

  1. Connectez-vous à un nœud du cluster en tant qu'utilisateur racine. Vous pouvez effectuer ces étapes sur les nœuds dans l'ordre de votre choix.
  2. Définissez l'utilisateur apigee:apigee comme propriétaire du fichier de configuration mis à jour, comme indiqué dans l'exemple suivant :
    chown apigee:apigee config_file
  3. Configurez le composant apigee-mtls en exécutant la commande suivante :
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls setup -f config_file
  4. (Facultatif) Exécutez la commande suivante pour vérifier que votre configuration a réussi :
    /opt/apigee/apigee-mtls/lib/actions/iptables.sh validate
  5. Lancez Apigee mTLS en exécutant la commande suivante :
    /opt/apigee/apigee-service/bin/apigee-service apigee-mtls start

    Après avoir installé Apigee mTLS, vous devez démarrer ce composant avant tout autre composant du nœud.

  6. (Nœuds Cassandra uniquement) Cassandra nécessite des arguments supplémentaires pour fonctionner dans le maillage de sécurité. Par conséquent, vous devez exécuter les commandes suivantes sur chaque nœud 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. (Nœuds Postgres uniquement) Postgres nécessite des arguments supplémentaires pour fonctionner dans le maillage de sécurité. Par conséquent, vous devez effectuer les opérations suivantes sur les nœuds Postgres:

    (Maître uniquement)

    1. Exécutez les commandes suivantes sur le nœud maître 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

    (Veille uniquement)

    1. Sauvegardez vos données Postgres existantes. Pour installer Apigee mTLS, vous devez réinitialiser les nœuds maîtres/de secours, ce qui entraîne une perte de données. Pour en savoir plus, consultez la page Configurer la réplication maître/de secours pour Postgres.
    2. Supprimer toutes les données Postgres :
      rm -rf /opt/apigee/data/apigee-postgresql/pgdata
    3. Configurez Postgres, puis redémarrez Postgres, comme indiqué dans l'exemple suivant :
      /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

    Si vous effectuez l'installation sur la topologie de plusieurs centres de données, utilisez un chemin d'accès absolu pour le fichier de configuration.

  8. Démarrez les composants Apigee restants sur le nœud dans l'ordre de démarrage, comme indiqué dans l'exemple suivant :
    /opt/apigee/apigee-service/bin/apigee-service component_name start
  9. Répétez ce processus pour chaque nœud du cluster.
  10. (Facultatif) Vérifiez que l'initialisation de apigee-mtls a réussi en utilisant une ou plusieurs des méthodes suivantes :
    1. Valider la configuration iptables
    2. Vérifier l'état du proxy distant
    3. Vérifier l'état du quorum

    Chacune de ces méthodes est décrite dans la section Vérifier votre configuration.

Modifier une configuration apigee-mtls existante

Pour personnaliser une configuration apigee-mtls existante, vous devez désinstaller et réinstaller apigee-mtls.

Pour rappeler ce point, lorsque vous modifiez une configuration mTLS Apigee existante:

  • Si vous modifiez un fichier de configuration, vous devez d'abord désinstaller apigee-mtls, puis réexécuter setup ou 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
  • Vous devez désinstaller et réexécuter setup ou configure sur tous les nœuds du cluster, et pas sur un seul nœud.