68. pepsi-setup

Provisionner la base de données, les clés de signature et le DNS pour un déploiement.

68.1. Rôle

pepsi-setup est l’outil d’amorçage d’administration. En une seule invocation, il valide la configuration, installe le schéma, fait créer par le démon de signature DKIM les clés de signature qui lui manquent et imprime les enregistrements DNS à publier ; un check distinct vérifie le DNS en service. Références : pepsi-setup(1) / pepsi.conf(5).

68.2. Fonctionnalités

  • Validation de la configuration. Analyse [pepsi], [pepsi-ingress], [pepsi-dkim] et le pipeline [stage-*] ; vérifie que [stage-init] existe, que chaque NEXT_STAGE/BOUNCE_STAGE se résout, que la configuration du programme de chaque étape (y compris l’acheminement smarthost) s’analyse, et que les domaines et les valeurs PUBLIC_IP sont bien formés. En cas d’erreur, il ne change rien et sort avec un code non nul.

  • Provisionnement des certificats TLS. Pour chaque section d’écouteur/certificat terminant le TLS qui n’a pas de TLS_CERT/TLS_KEY, il remplit la disposition de chemins certbot standard (en réécrivant le fichier de configuration sur place, commentaires préservés) puis exécute certbot certonly --standalone pour obtenir tout certificat pas encore présent sur disque (ou pour élargir un certificat qui ne couvre plus tous les noms). Passez --no-certbot pour omettre l’appel à certbot et gérer les certificats vous-même. Un certificat manquant qui ne peut pas être obtenu est différé, et non fatal : le reste de l’exécution se poursuit et le récapitulatif de fin d’exécution indique ce qu’il reste à faire.

  • Provisionnement de l’accès TLS. Les serveurs s’exécutent sous des utilisateurs non privilégiés, tandis que certbot conserve /etc/letsencrypt réservé à root. Sous systemd, pepsi-setup écrit un drop-in LoadCredential= par unité, de sorte que systemd lit chaque certificat et chaque clé en tant que root au démarrage de l’unité et remet au service une copie privée — les permissions des fichiers n’ont alors plus aucune importance. Il accorde également des ACL POSIX et installe un hook de déploiement certbot (qui réaccorde les droits et redémarre les serveurs, afin qu’un certificat renouvelé soit réellement servi), puis vérifie enfin que tout ce qui subsiste est réellement lisible, en devenant l’utilisateur de service et en ouvrant le fichier.

  • Installation du schéma. Le seul installateur de l’unique schéma pepsi : applique la série de patchs numérotés et les procédures recréables depuis SQL_DIR ; idempotent et réexécutable. Il enregistre ce qu’il a appliqué, par empreinte du contenu, afin que chaque programme puisse refuser un schéma d’une autre version, et il refuse lui-même d’installer par-dessus un schéma plus récent (voir Mise à niveau). run --reset supprime et recrée le schéma (détruisant le courrier en file d’attente ; les clés DKIM, que pepsi-dkim(1) conserve dans des fichiers, ne sont pas touchées).

  • Clés de signature. pepsi-setup ne détient aucune clé privée. Il remet au démon de signature (pepsi-dkim sync-domains, pepsi-dkim(1)) chaque domaine pour lequel Pepsi fait autorité : l’union d”ACCEPTED_DOMAINS, du domaine SERVER_NAME/POSTMASTER de chaque étape, de tout SIGNING_DOMAIN, SRS_DOMAIN ou RESPONSE_FROM fixe explicite, et d”ARC_DOMAIN. Le démon crée, sous son propre compte, une clé RSA de [pepsi-dkim] RSA_BITS (2048 par défaut) et une clé Ed25519 (RFC 8463) pour chaque domaine qui n’en a pas, et indique leurs enregistrements. Un démon qui ne peut pas être exécuté reporte l’étape, non l’exécution. Les fichiers de clés DKIM qui restent sous [pepsi] KEY_DIR (<domain>/dkim.rsa.key et <domain>/dkim.ed25519.key) sont supprimés dès que le démon répond, puisque rien ne signe plus avec eux, et leurs enregistrements sont listés comme pouvant être retirés.

  • Sortie d’enregistrements DNS. Imprime, au format de zone BIND, les clés publiques DKIM que le démon déclare nécessaires (<DKIM_SELECTOR>-YYYYMM._domainkey et <DKIM_SELECTOR>-YYYYMM-ed25519._domainkey, également celles de la génération suivante pendant un renouvellement ; celles qui peuvent être retirées en commentaire), une politique SPF construite à partir du PUBLIC_IP de chaque étape relais (union), une suggestion DMARC là où aucune n’est publiée (avec rua=mailto:dmarc-reports@<domain> lorsqu’une étape exécute pepsi-stage-dmarc-report), un enregistrement TXT MTA-STS _mta-sts (RFC 8461), un enregistrement TLSRPT lorsque [pepsi-tlsrpt] RUA est défini, et des enregistrements DANE/TLSA pour les écouteurs TLS, plus une suggestion CAA facultative en commentaire (RFC 8659, avec l”accounturi du compte certbot lorsqu’il peut être lu) lorsque les certificats proviennent de Let’s Encrypt, et un joker en commentaire *.<domain>. TXT "v=spf1 -all" pour les sous-domaines au nom desquels personne n’envoie, sp=reject; np=reject étant recommandé pour un enregistrement DMARC qui leur laisse une politique plus faible. Les enregistrements déjà publiés avec la bonne valeur sont omis. Le fichier de politique lui-même est servi par pepsi-httpd, pas imprimé. Les longs enregistrements RSA sont scindés en plusieurs chaînes de caractères. Le même enregistrement SPF est suggéré pour chaque domaine servi ; la sortie note que des configurations multi-hôtes particulières peuvent préférer un regroupement par domaine plus strict, toujours correct, que pepsi-setup ne calcule pas automatiquement.

  • Vérification du DNS en service (check) : interroge le DNS et indique, par domaine, si le p= DKIM publié correspond à la clé que détient le démon (un enregistrement qu’un hébergeur DNS a tronqué à une chaîne de 255 octets est désigné comme tel ; l’enregistrement d’une clé retirée est listé comme pouvant être retiré), si l’enregistrement SPF liste chaque PUBLIC_IP et si chacun de ses termes suit la grammaire de la RFC 7208 (un mécanisme inconnu tel que ipv4: annule tout l’enregistrement), si l’enregistrement DMARC est valide et si ses destinations rua=/ruf= peuvent recevoir les rapports (une destination externe doit publier son enregistrement d’autorisation _report._dmarc), et si le TXT _mta-sts est présent et analysable. Un groupe DMARC reports indique par domaine si chaque source rapportée était alignée, et donc si p=reject est sûr, ou quelles sources il refuse (à titre indicatif) ; il s’appuie sur les rapports agrégés authentifiés que pepsi-stage-dmarc-report a stockés pour les derniers WINDOW_DAYS jours. Il compare aussi la politique MTA-STS aux enregistrements MX en service et à ce qui est réellement servi, et vérifie que le domaine SRS peut recevoir ses rebonds. Lorsque ALLOW_ALIGNED_DOMAIN accepte un domaine SRS aligné avec un domaine servi, il vérifie aussi que l’enregistrement DMARC du domaine servi (aspf=s, ou une politique contraignante avec DMARC_ENFORCE activé) ferme la voie SPF qu’emprunterait le courrier falsifié. Il compare tout enregistrement TLSA publié au certificat que sert l’écouteur (quand un enregistrement ne correspond plus à la clé, les expéditeurs qui appliquent DANE refusent notre courrier) et demande à des résolveurs validants publics si cet enregistrement TLSA, ainsi que les enregistrements MX des domaines acceptés, sont authentiques au sens de DNSSEC (un enregistrement sans le bit AD n’est jamais utilisé pour DANE). Il signale les cibles pendantes : un hôte MX ou NS sans adresse, un CNAME à mta-sts., openpgpkey. ou autoconfig. pointant vers un nom sans adresse, un include:/redirect= SPF nommant un domaine sans enregistrement SPF, et un a:/mx: SPF nommant un hôte sans adresse ni MX. Il liste les sous-domaines que nomme la configuration (l’hôte EHLO, mta-sts., autoconfig.) qui existent sans enregistrement SPF propre, ce qu’un joker ne couvre pas. Il récupère chaque nom HTTPS sous lequel pepsi-httpd est joint et signale celui dont la réponse n’a pas d’en-tête Strict-Transport-Security d’au moins six mois (un serveur frontal qui ne le transmet pas). Et il compte les recherches DNS que coûte à un destinataire l’enregistrement SPF du domaine, à travers chaque include, par rapport aux limites de la RFC 7208 de 10 recherches et 2 recherches vides. Pour chaque adresse ayant une identité de bout en bout publiée, il récupère ce que servent le Web Key Directory et les enregistrements OPENPGPKEY/SMIMEA et signale une empreinte que le magasin de clés ne publie pas (Vérifier ce qui est réellement servi). Informatif : ses constats ne déterminent le code de sortie qu’avec --fail-on-findings, ce qu’exécute chaque jour pepsi-setup-check.timer ; un enregistrement qui se casse plus tard fait donc échouer cette unité (systemctl --failed). run journalise les mêmes constats TLSA et de cibles pendantes comme avertissements, et avertit lorsqu’un composant qui se fie au bit AD DNSSEC (DANE dans une étape de relais ou dans la découverte de clés) utilise un résolveur qui ne valide pas ; run et check énoncent tous deux, avec leurs adresses IP, les résolveurs hors de cet hôte auxquels l’installation confie la validation DNSSEC (rien lorsque chaque résolveur est sur la boucle locale). La validation avertit aussi d’une entrée MYNETWORKS de l’ingress plus large qu’un seul hôte (hors boucle locale), puisque chaque hôte qu’elle contient peut relayer et envoyer au nom de n’importe quelle adresse, et le site de proxy inverse qu’elle écrit pour nginx ou Apache désactive les tickets de session TLS pour la confidentialité persistante. Le site ne définit pas de liste d’algorithmes de chiffrement (celle du serveur frontal est partagée avec ses autres sites), mais run lit la configuration effective du serveur frontal (nginx -T, ou l’arborescence de configuration d’Apache) et avertit lorsqu’elle active encore des suites TLS 1.2 sans confidentialité persistante (échange de clés RSA statique), ou indique qu’il n’a pas pu le déterminer.

  • Assistant de configuration initiale (--wizard) : un court questionnaire interactif qui écrit un fichier de configuration complet et déjà validé (au chemin --config, ou /etc/pepsi/pepsi.conf par défaut) puis propose d’exécuter la configuration initiale complète. Il importe les réponses d’une exécution précédente depuis la section [pepsi-wizard] du fichier ; --force écrase sans demander un fichier dépourvu d’une telle section.

Utilisez pepsi-config pour inspecter la configuration effective.

68.3. Sécurité

pepsi-setup est l’endroit où la plupart des frontières de privilèges du déploiement sont mises en place, et il les vérifie plutôt que de les supposer :

  • Rôles de base de données. Chaque compte de service reçoit son propre rôle authentifié par pair. pepsi et pepsi-crypto reçoivent le droit du pipeline moins les restrictions (seul pepsi-crypto peut lire crypto_identity.private_wrapped ou toucher à otp_key ; les autres rôles ne peuvent mettre à jour que les indicateurs d’usage d’une identité) ; pepsi-ingress, pepsi-httpd et pepsi-telemetry sont réduits à ce qu’utilise leur code ; pepsi-keydisc, pepsi-whitelist et pepsi-config reçoivent quelques tables ou colonnes nommées. Les tables d’identifiants (y compris own_enrolment/own_session) appartiennent à pepsi-httpd seul, crl_cache est écrite par pepsi-keydisc seul, et seul pepsi-config peut écrire config_override ou mettre en file une setup_task. Après les avoir appliqués, run et schema interrogent PostgreSQL et refusent de se terminer en cas de discordance (Un attaquant qui a la base de données).

  • Secrets. Chaque secret réside dans un fragment secrets.d appartenant à l’unique compte qui le lit, sécurisé en tout premier lieu à chaque exécution ; la clé de chiffrement des clés n’est générée que lorsque la base de données confirme qu’aucune clé enveloppée n’existe encore (Un attaquant qui a le fichier de configuration, La frontière de garde des clés privées).

  • Configurations refusées. Un [pepsi-srs] SRS_DOMAIN aligné au sens de DMARC avec un domaine servi (sauf si ALLOW_ALIGNED_DOMAIN = yes), puisque la réexpédition blanchirait les contrefaçons de ce domaine en une réussite DMARC ; un CRYPTO_GENERATE_RSA_BITS autre que 2048, 3072, 4096 ou 8192 ou inférieur à CRYPTO_MIN_RSA_BITS ; une clé partagée S/MIME sur une courbe elliptique ; un KEY_WRAP_SECRET de moins de 16 caractères. Une entrée MYNETWORKS plus large qu’un seul hôte et un serveur frontal qui propose encore des suites TLS 1.2 à RSA statique sont des avertissements.

  • Confiance DNSSEC. Avec DANE en usage (DANE = strict est la valeur par défaut des étapes de relais), run vérifie que le résolveur positionne le bit AD et nomme les résolveurs hors de l’hôte auxquels l’installation confie la validation (L’adversaire réseau).

  • Logins recyclés. run met à jour l’enregistrement d’attribution de logins RFC 7293 et signale le matériel de clé plus ancien que le propriétaire actuel d’un login (Un identifiant de connexion qui change de propriétaire).

  • L’applicateur. apply n’agit que sur une liste fermée de dix-sept types de tâches, chacun autorisé par la portée consignée et par le fait que la ligne a été écrite via le rôle pepsi-config ; il n’y a ni redémarrage ni commande arbitraire. Le second facteur de la demande d’un propriétaire (confirm-enrolment compris) est vérifié ici, jamais par le tier web (Un second facteur pour la gestion des clés, Connexion à la console par e-mail, Un composant compromis). Le raisonnement se trouve dans pepsi-setup(1), The applier’s trust model.

68.4. Options de ligne de commande

Sans sous-commande, pepsi-setup effectue la configuration initiale complète (identique à run). Le détail complet est dans pepsi-setup(1) ; les options sont :

Sous-commandes :

  • run — valider, provisionner le TLS, installer le schéma, remettre les domaines de signature à pepsi-dkim, imprimer le DNS (l’action par défaut). -r/--reset supprime et recrée d’abord le schéma (détruit tout le courrier en file d’attente ; les clés DKIM sont conservées).

  • schema — installer ou mettre à niveau le schéma et les droits des rôles, et rien d’autre ; n’a besoin que de [pepsi-postgres], et fonctionne donc aussi avec le fichier de configuration d’un collecteur de télémétrie. Refuse un schéma plus récent (code de sortie 78). --backup-dir DIR enregistre d’abord le schéma avec pg_dump lorsqu’il y a quelque chose à mettre à niveau, puis --backup-keep N supprime toutes les sauvegardes sauf les N plus récentes (2 par défaut, 0 les garde toutes) ; --if-installed ne fait rien sur une base de données qui n’a pas encore de schéma. C’est ce qu’exécute une mise à niveau de paquet ; voir Mise à niveau.

  • check — interroger le DNS en service et signaler les discordances ; ne modifie rien, et ses constats ne déterminent le code de sortie qu’avec --fail-on-findings (code 1 pour un enregistrement manquant, erroné, invalide ou injoignable ou pour une inscription sur une liste de blocage, chacun étant aussi journalisé comme avertissement ; une recherche échouée ne compte pas). Il avertit aussi de l’état par adresse (paramètres, identités du magasin de clés, listes blanches <login>/..., quotas de boîtes aux lettres) conservé pour un login qui n’existe plus, et du matériel de clé plus ancien que le propriétaire actuel d’un login (enregistrement d’attribution de logins RFC 7293 ; la base de données abandonne d’elle-même les paramètres, listes blanches, quota et journaux de réponse du propriétaire précédent, jamais les clés) ; run journalise les mêmes avertissements.

  • validate — vérifier la configuration exactement comme le fait run, sans rien modifier (ni base de données, ni DNS, ni clés, ni certificats) ; se termine avec le code 1 en cas de refus. Lancez-le après avoir modifié pepsi.conf et avant de redémarrer quoi que ce soit.

  • visualize — imprimer le pipeline [stage-*] sous forme de graphe Graphviz dot sur la sortie standard (une arête pleine par NEXT_STAGE, une arête rouge en pointillés par BOUNCE_STAGE) ; passez-le à dot -Tpng.

  • questions — imprimer l’entretien de configuration en JSON : les étapes, la forme de chaque question, sa valeur par défaut, son texte d’aide et le moment où elle est posée. Ce modèle décrit aussi bien l’assistant en terminal que la configuration dans le navigateur, et un fichier --answers se conforme à ce schéma.

  • apply — effectuer le travail de configuration privilégié demandé par l’interface du navigateur, en lisant les lignes d’intention de pepsi.setup_task. Normalement démarré à la demande par systemd. --once écoule ce qui est en attente puis sort ; --idle SECS fixe le temps d’attente sans rien à faire avant de sortir ; --clear supprime toutes les lignes en file sans en exécuter aucune (mutuellement exclusive avec les deux autres).

  • bootstrap — frapper et imprimer le jeton porteur à usage unique qui crée le premier compte administrateur (--valid-for SECS, --admin-url URL).

  • import [MTA] — signaler ce qui serait migré depuis un MTA existant (postfix, exim, sendmail, qmail, stalwart) sans rien écrire ; --root lit sous un autre répertoire, --out écrit le rapport et les fichiers de tables convertis, --alias-style choisit la façon dont les noms d’alias nus sont qualifiés.

Options, qui viennent toutes avant la sous-commande :

  • --no-certbot — ne pas invoquer certbot pour les certificats TLS manquants ; ils sont différés à la place (voir Provisionnement des certificats TLS ci-dessus).

  • --no-reverse-proxy — ne pas s’intégrer automatiquement à un serveur HTTP frontal existant ; laisser pepsi-httpd lier le port 443 directement.

  • -y/--yes-to-all, -n/--no-to-all — répondre de la même façon à chaque proposition interactive, de sorte que la configuration ne se bloque jamais sur une saisie.

  • --wizard — exécuter l’assistant de configuration interactif (n’exige pas de fichier de configuration existant) ; --force écrase sans demander un fichier non importable. Avec lui : --expert SPEC pose en outre les options plus profondes (--expert=help les liste), --import MTA / --no-import / --import-root DIR commandent la migration des paramètres d’un MTA existant, et --answers FILE répond à chaque question à partir d’un JSON au lieu de la poser.

  • -c/--config FILE, -L/--log LEVEL, -v/--verbose, -h/--help, -V/--version — les options partagées par tous les outils Pepsi. Contrairement aux autres, pepsi-setup ignore [pepsi] LOG et LOG_JSON (la journalisation démarre avant qu’une configuration ne soit chargée) ; passez -L.

68.5. Configuration

Lit [pepsi-dkim] (validée intégralement ; PUBLIC_DIR situe l’état du démon), la section partagée [pepsi] (KEY_DIR, où run supprime les fichiers de clés DKIM restants, DKIM_SELECTOR, DKIM_ALGORITHMS, ARC_DOMAIN, ARC_ALGORITHM, ORIGINATE_SUCCESS_DSN, MTA_STS_MODE, MTA_STS_MAX_AGE), [pepsi-postgres] (CONFIG, SQL_DIR), [pepsi-ingress] (HOSTNAME, ACCEPTED_DOMAINS), et les sections [stage-*] — y compris le PUBLIC_IP de chaque étape relais (collecté par PROGRAM). Référence complète : pepsi.conf(5).

68.6. Voir aussi

Installation, Configuration, pepsi-setup(1), pepsi-dkim(1), pepsi.conf(5).