95.1.45. pepsi-status

summarise the health of the Pepsi mail pipeline

Section du manuel:

1

95.1.45.1.1. Nom

pepsi-status - imprimer un résumé de santé lisible par un humain de la file, des messages bloqués, des statistiques de remise et d’échec, et des issues TLS sortantes.

95.1.45.1.2. Synopsis

pepsi-status [GLOBAL-OPTIONS] [–json] [–limit N] [–offline]

95.1.45.1.3. Description

pepsi-status imprime un rapport de santé ponctuel et en lecture seule du pipeline Pepsi, tiré de la base de données pepsi partagée et, pour les clés publiées, de ce que servent le Web Key Directory et le DNS. Il est destiné à être exécuté de façon interactive ou via SSH (par exemple depuis un hôte de surveillance) ; il ne modifie jamais une ligne et n’émet aucune notification de base de données, de sorte qu’on peut l’exécuter sans risque sur un déploiement en service à tout moment.

L’outil se connecte à la même base de données que les autres composants, via la section partagée [pepsi-postgres] ; il n’introduit aucune configuration propre (il lit [pepsi-dmarc-reports] WINDOW_DAYS pour la section DMARC et [pepsi-dkim] PUBLIC_DIR pour la section DKIM). Démarré en tant que root, il poursuit sous le compte de service pepsi ; voir Exécution en tant que root.

Le rapport comporte les sections suivantes :

File d’attente

Le contenu actuel de la table pepsi.workqueue, ventilé par stage et status, avec l’âge du message le plus ancien de chaque groupe et un total général. C’est l’arriéré en direct : les lignes pending et running sont du travail en cours, les lignes paused attendent (par exemple un délai de paiement ou un réessai de relais), et les lignes failed/timeout demandent de l’attention. Une ligne sous le tableau compte les messages en pause que retient une étape pepsi-stage-quarantine(1) : ils attendent un opérateur (pepsi-queue(1) quarantine list), et ne sont pas bloqués.

Messages bloqués

Les messages individuels dont le statut est failed ou timeout, du plus ancien au plus récent. Pour chacun, le rapport montre le workqueue_id, le statut, l’étape, l’âge, l’expéditeur d’enveloppe et l’objet. Lorsqu’elles existent, il montre aussi trois raisons. La première est la raison structurée pour laquelle le saut suivant a refusé le message, lorsqu’une étape de relais en a noté une (MTA distant, code SMTP, état étendu et texte de réponse, ou notre propre diagnostic, issus de state.bounce). La deuxième est le texte d’erreur que l’étape a noté lorsqu’elle a fait échouer ou différé le message (state.last_error, affiché sous la forme error:). La troisième est la raison donnée par pepsi-dispatch lorsqu’il a lui-même fait échouer ou expirer le message, par exemple un worker planté ou bloqué, ou une étape non configurée (state.dispatch_error, affiché sous la forme dispatch:). Dans la sortie –json, ces trois éléments sont les champs bounce, last_error et dispatch_error de chaque entrée problems. La liste est plafonnée par –limit ; la taille réelle de l’arriéré est toujours affichée.

Remises et échecs

Compteurs cumulatifs du pipeline : le nombre total de messages qui se sont achevés et ont quitté le pipeline, le total des exécutions d’étape, et par étape le nombre d’exécutions comptabilisées (la colonne MESSAGES, qui est le dénominateur de la moyenne), le temps de traitement moyen, les timeouts et les plantages de workers. Ce sont des totaux sur toute la durée de vie, accumulés depuis la création du schéma. Comme un message remis avec succès est supprimé de la file, il n’existe pas de journal de remise par message et donc pas de fenêtre temporelle glissante : les chiffres sont cumulatifs, ils ne portent pas « sur la dernière heure ».

TLS sortant

Issues des sessions TLS sortantes sur les sept derniers jours de rapport UTC (celui d’aujourd’hui, en UTC, et les six précédents, quel que soit le fuseau horaire du serveur), groupées par domaine de politique et type de résultat, avec les résultats non réussis marqués. Ces données ne sont présentes que lorsque [pepsi-tlsrpt] SEND_REPORTS est activé, et seulement aussi longtemps que pepsi-tlsrpt prune les conserve ([pepsi-tlsrpt] RETAIN_DAYS, également sept jours par défaut) : une rétention plus courte raccourcit donc cette section. La section liste ensuite toute adresse d’hôte MX que le cache du résolveur a actuellement marquée comme échouant à se connecter, avec l’heure de leur dernière connexion réussie (ou never).

Quotas de boîtes aux lettres

Une ligne par compte local dont Pepsi a tenu la comptabilité, mesure la plus ancienne d’abord : l’occupation, la limite effective, le taux de remplissage, d’où vient le chiffre (fsquota/maildirsize/scan) et depuis combien de temps la boîte aux lettres a été mesurée. Remettre du courrier à un compte crée sa ligne : une ligne existe donc pour chaque compte auquel Pepsi a remis du courrier, qu’il ait un quota ou non. Sur un déploiement qui n’utilise pas la fonctionnalité, la section liste donc quand même ces comptes, avec - dans les colonnes LIMIT et FULL. Elle n’est vide — et le dit — que lorsque aucune remise locale n’a été comptabilisée.

LIMIT est la limite réellement en vigueur, résolue exactement comme le chemin de remise la résout : la limite propre au compte s’il en a une, sinon la valeur par défaut du site [pepsi] MAILBOX_QUOTA, un 0 explicite sur le compte signifiant illimité et non hériter, le quota propre au noyau resserrant celle qui l’a emporté.

USED est la dernière mesure plus tout ce qui a été remis depuis ; elle ne fait que croître, car rien n’indique à Pepsi qu’un utilisateur supprime du courrier par IMAP : c’est donc une borne supérieure plutôt qu’un fait. MEASURED est le temps écoulé depuis que quelqu’un a réellement regardé, et cela compte parce qu’un refus au RCPT repose sur la fraîcheur d’une mesure : un compte affiché « plein » face à une mesure très ancienne est un compte dont le reconcile de pepsi-quota(1) devrait s’occuper.

Changements de clé des correspondants

Combien de clés de chiffrement de correspondants la règle Autocrypt « le plus récent l’emporte » a remplacées au cours des 30 derniers jours (rotated), et combien de tels remplacements ACCEPT_ROTATION = expired a refusés (held). Viennent ensuite les rotations et retenues les plus récentes, au plus –limit d’entre elles, chacune avec la date, l’adresse, le protocole, les anciennes et nouvelles empreintes, et l’indication que la nouvelle clé était celle du correspondant lui-même (inbound) ou présentée par un tiers (gossip). Une rotation est le seul moyen par lequel un message qui prétend simplement venir d’un correspondant peut changer la clé avec laquelle nous lui chiffrons le courrier. C’est pourquoi elle est montrée ici plutôt que laissée dans le journal d’audit. Les chiffres sont lus dans les lignes key.peer.rotate et key.peer.rotate.held de pepsi.event_log, que la base de données écrit en même temps que le changement lui-même, de sorte que la section remonte aussi loin que [pepsi-admin] EVENT_RETENTION les conserve. Voir pepsi-stage-autocrypt-learn(1).

Rapports agrégés DMARC

Ce que disent les rapports agrégés DMARC stockés par pepsi-stage-dmarc-report(1) sur les derniers [pepsi-dmarc-reports] WINDOW_DAYS (7) jours, par domaine de politique : combien de messages couvrent les rapports authentifiés et de quelles organisations, et soit que chaque source était alignée (p=reject n’en refuse aucune), soit un WARNING indiquant combien de messages de combien de sources ne l’étaient pas. Viennent ensuite les sources non alignées, au plus –limit d’entre elles, chacune avec son adresse, son nombre de messages, son domaine From:, son domaine d’enveloppe, son d= DKIM, sa disposition et ses rapporteurs. Un rapport dont le courrier n’a réussi ni SPF ni DMARC est compté comme ignoré et ne décide de rien.

Liste des clés connues comme compromises

Quand la liste badkeys a été vérifiée pour la dernière fois et de quelle liste il s’agissait, avec un avertissement lorsqu’elle n’a jamais été récupérée, n’a pas été vérifiée depuis trois jours, ou que la dernière mise à jour a échoué ou a été refusée. Voir blocklist de pepsi-keys(1).

Réputation IP

Combien des listes de blocage IP activées (iplists de pepsi-reputation(1)) sont à jour, et un avertissement pour chacune que l’ingress ne peut pas utiliser : une liste stale, never-loaded ou no-rsync, ou dont le dernier téléchargement a échoué. Puis la dernière auto-vérification de cet hôte auprès des listes de blocage DNS (pepsi-reputation check) : depuis combien de temps elle a eu lieu et combien de listes n’ont pas pu être interrogées, un avertissement pour chaque inscription de l’une des adresses ou de l’un des domaines de cet hôte, et un avertissement lorsqu’elle n’a jamais eu lieu ou date de trois jours.

Greylisting

Affichée lorsque le déploiement pratique le greylisting (une section [pepsi-greylist], ou un milter d’ingress dont le SOCKET est celui du démon). Si pepsi-greylist(1) répond à une négociation milter sur sa socket (la question est posée avant le passage au compte de service, pour que root puisse se connecter ; un compte extérieur au groupe de la socket apprend qu’elle n’a pas été posée), puis les comptes des dernières 24 heures : différés, acceptés au réessai, acceptés depuis un autre hôte (par échelon et selon la manière dont l’hôte correspondait), jamais réessayés, connus, contournés par motif, exemptés, refusés, et les erreurs qui ont laissé passer un destinataire, avec un avertissement s’il y en a eu.

Clés DKIM

Ce que le démon de signature pepsi-dkim(1) indique dans son fichier d’état public ([pepsi-dkim] PUBLIC_DIR/status.json ; aucune clé n’est lue) : depuis combien de temps il a été écrit, si le renouvellement est activé et tous les combien de jours, la méthode de mise à jour DNS, et si une bascule attend le DNS. Puis, par domaine de signature, les clés current, next et retiring, chacune avec son sélecteur, son algorithme, sa taille RSA et son état DNS (visible, missing, disagree ou unknown), les enregistrements à publier (un WARNING chacun) et les enregistrements qui peuvent être retirés. Un WARNING signale aussi un domaine pour lequel aucune clé ne signe, une clé courante dont l’enregistrement n’est pas visible (les destinataires font échouer ses signatures tant qu’il n’est pas publié), un renouvellement qui a attendu les enregistrements de la clé suivante, un démon qui ne signe pour aucun domaine, et un fichier d’état pas encore écrit ou illisible.

Clés publiées telles que servies

For every address with a published, active end-to-end identity, what a correspondent is given: both Web Key Directory methods (openpgpkey.domain and the domain itself) and the OPENPGPKEY and SMIMEA records, fetched with the same hardened clients and [pepsi-keydiscovery] settings that key discovery uses, compared with the key store. The section says how many addresses are served exactly as stored and lists every channel of the others: MISMATCH (a fingerprint the store does not publish for the address is served; the address line then starts with WARNING), INCOMPLETE (a stored key is not served, or neither WKD method serves anything), FAILED (the channel could not be asked) and ABSENT. A DNS record that nobody published is not a fault. This is the one section that uses the network rather than the database; –offline skips it. The check runs from this host: a server that answers other askers differently is not detected.

Clés de déchiffrement RSA

Les identités S/MIME actives dont Pepsi détient la clé privée, qui peuvent déchiffrer (purpose encrypt ou both), et dont le certificat porte une clé RSA – jugé d’après le certificat, puisque le nom d’algorithme consigné d’une identité importée est un texte libre. Le S/MIME entrant qui leur est destiné arrive en transport de clé RSA et atteint une opération à clé privée RSA, le chemin que concerne l’exposition restante à Bleichenbacher et Marvin ; une identité avec purpose = both (CRYPTO_SMIME_SHARED_KEY) est marquée « signing and decryption share this key ». La section donne le nombre, liste les identités jusqu’à –limit, et se termine par une ligne INFO : générer une identité P-256 avec pepsi-keys identity generate fait arriver le nouveau courrier en accord de clé ECDH, tandis que l’identité RSA continue de déchiffrer ce qui lui a été envoyé. Détenir une identité RSA est une configuration délibérée ; rien ici n’est donc un avertissement. (none: …) lorsqu’il n’existe aucune telle identité.

Résolveur DNSSEC

Les résolveurs dont les consommateurs DANE se fient au bit AD DNSSEC (chaque étape de relais dont DANE n’est pas off, via son DNS_SERVERS, [pepsi] DNS_SERVERS ou resolv.conf, et dane dans [pepsi-keydiscovery] SOURCES), une ligne par ensemble de résolveurs avec les consommateurs qui l’utilisent. Chaque résolveur est affiché dans sa graphie DNS_SERVERS, qui nomme le transport : une adresse nue est du DNS simple, tls://… du DNS over TLS, https://… du DNS over HTTPS. On demande à chaque ensemble le SOA signé de ietf.org : validates lorsque la réponse porte le bit AD, un avertissement lorsqu’elle ne le porte pas (le résolveur ne valide pas, de sorte que chaque recherche DANE ne trouve rien et que DANE est configuré mais jamais appliqué) ou lorsqu’aucune réponse ne vient. Un avertissement supplémentaire nomme chaque résolveur de l’ensemble qui n’est pas sur cet hôte et est joint en DNS simple, puisque quiconque se trouve sur le chemin peut falsifier le bit. –offline conserve la liste et saute la sonde. (nothing uses DANE) lorsqu’aucun consommateur n’est configuré.

DNSSEC propre

Si la chaîne de confiance DNSSEC des propres domaines de cet hôte tient. On demande au premier ensemble de résolveurs de la section Résolveur DNSSEC (resolv.conf lorsque rien n’utilise DANE), en demandant le bit AD, les enregistrements MX de chaque entrée de [pepsi-ingress] ACCEPTED_DOMAINS et, là où un hôte MX en publie, ses enregistrements TLSA _25._tcp. Chaque ligne indique validated (bit AD positionné), insecure (pas de bit AD : la zone n’est pas signée ou n’a pas de DS chez le parent), bogus avec l’Extended DNS Error RFC 8914 qu’a donnée le résolveur (Signature Expired, DNSKEY Missing, DNSSEC Bogus …), servfail (un SERVFAIL ne nommant aucun échec DNSSEC : bogus, ou serveurs de la zone injoignables) ou no answer. bogus et servfail sont des WARNING : tout résolveur validant refuse le nom, de sorte que les expéditeurs qui se trouvent derrière l’un d’eux ne peuvent pas trouver le MX et que les expéditeurs utilisant DANE diffèrent le courrier. Un RRset TLSA insecure est aussi un WARNING, puisque DANE ne l’utilise jamais ; un MX insecure ne l’est pas, puisque la signature est facultative. Le résolveur doit valider pour que les verdicts aient un sens (voir la section ci-dessus).

Vient ensuite une ligne par zone que sert cet hôte, listant les clés de son RRset DNSKEY (key tag, algorithme, KSK/ZSK, taille RSA), ou none (unsigned). Ce sont les zones des domaines acceptés, de [pepsi-ingress] HOSTNAME et de [pepsi-srs] SRS_DOMAIN, chacune trouvée par son enregistrement SOA. Un WARNING avec le remède suit pour chaque clé qui utilise un algorithme avec lequel les RFC 8624 / RFC 9905 disent de ne pas signer (RSAMD5, DSA, RSASHA1, DSA-NSEC3-SHA1, RSASHA1-NSEC3-SHA1, ECC-GOST ; RSASHA512 est NOT RECOMMENDED), un module RSA inférieur à 2048 bits, une clé qui signe aussi une autre de ces zones, et une clé figurant dans la liste des clés connues comme compromises (pepsi.compromised_key). pepsi-setup check rapporte les mêmes constats dans son groupe DNSKEY. –offline saute la section.

Ancres de confiance S/MIME

Les ancres de confiance activées qui se portent garantes de tous les domaines de courrier : aucune portée définie avec pepsi-keys ca scope et aucun nameConstraints dans le certificat. Chacune est un WARNING nommant l’identifiant et le libellé de l’ancre (ou son sujet), puisqu’une signature de n’importe quelle adresse qui s’enchaîne jusqu’à elle se lit valid ; la dernière ligne indique comment en limiter la portée. (every enabled anchor is limited …) lorsqu’il n’y en a aucune. En --json, unscoped_anchors.

Le texte libre du rapport lisible par un humain — la réponse d’un MTA distant, l’objet d’un message, un nom d’hôte issu du cache du résolveur — voit ses caractères de contrôle remplacés par des espaces avant d’être imprimé. Tout ce texte est choisi par quelqu’un d’autre, et cet outil est fait pour être exécuté via SSH sur un déploiement en service, c’est-à-dire précisément là où une séquence d’échappement de terminal repeindrait l’écran de l’opérateur. La sortie --json n’est pas concernée : l’échappement JSON s’en charge déjà.

95.1.45.1.4. Options

–json

Émet tout le rapport sous la forme d’un unique objet JSON (clés queue, quarantined, problem_total, problems, global, stages, tls_report_days, tls, dns_failures, mailboxes, quota_default_bytes, key_change_days, key_changes_rotated, key_changes_held, key_changes, dmarc_window_days, dmarc, dmarc_unaligned, key_blocklist, reputation, greylist (summary avec socket, probe_error, probe_denied, counts et never_retried, ou une error), rsa_decryption, unscoped_anchors, dkim (path, le document d’état du démon sous status et une error lorsqu’il n’a pas pu être lu), resolvers et, sauf avec –offline, served_keys et own_dnssec) au lieu du texte lisible par un humain, pour les scripts et la surveillance. served_keys.addresses contient un objet par adresse avec ses channels, chacun portant channel, verdict (ok, absent, failed, incomplete ou mismatch), expected, served, unexpected et missing. resolvers contient un objet par ensemble de résolveurs : source, users, servers, off_host, et validates (absent avec –offline ou lorsque la sonde n’a reçu aucune réponse, ce que error explique alors). own_dnssec contient les servers interrogés et des records, chacun avec name, rtype (MX ou TLSA), verdict (validated, insecure, absent, bogus, servfail ou no answer) et un detail facultatif (l’Extended DNS Error), puis zones (un objet par zone servie : zone, names, keys) et key_findings (zone, key_tag, problem, detail).

–offline

Saute les sections Clés publiées telles que servies et DNSSEC propre ainsi que la sonde DNSSEC de la section Résolveur DNSSEC, les seules parties qui interrogent le réseau, pour un rapport qui ne touche qu’à la base de données et à la configuration locale.

–limit N

Lister au plus N messages bloqués (failed/timeout) individuels, au plus *N* comptes de quota de boîte aux lettres, au plus *N* changements de clés de correspondants, au plus *N* sources DMARC non alignées et au plus *N* identités de déchiffrement RSA. Par défaut 50. L’arriéré total rapporté n’est pas affecté par ce plafond.

La section des messages bloqués indique « affichage de X sur Y » lorsqu’elle est tronquée ; la section des quotas de boîtes aux lettres ne le fait pas, de sorte que sur un hôte comptant plus de N comptes comptabilisés cette liste est silencieusement celle des N mesures les plus anciennes. C’est le bout utile de la liste, mais augmentez –limit avant de conclure qu’un compte est absent.

95.1.45.1.5. Exécution en tant que root

Pepsi donne à chaque composant son propre rôle PostgreSQL, authentifié via la socket locale par le compte système sous lequel il s’exécute, et root n’en fait délibérément pas partie. Plutôt que d’échouer à se connecter et de vous obliger à penser à sudo -u pepsi pepsi-status, l’outil détecte qu’il a été démarré en tant que root et devient le compte de service non privilégié pepsi avant de se connecter ; le rapport lui-même reste strictement en lecture seule.

Le fichier de configuration (et tout fragment @inline-secret@ qu’il référence) est lu avant le basculement, de sorte qu’une configuration lisible par root seul est toujours chargée normalement.

Si le compte pepsi n’existe pas (une arborescence source non installée, un banc de test), l’identité est laissée intacte, un avertissement est journalisé et la connexion est tentée en tant qu’utilisateur appelant, de sorte qu’une installation où root peut atteindre la base de données continue de fonctionner.

95.1.45.1.6. Options globales

Ces options peuvent apparaître avant ou après les autres options.

-c FILE, –config FILE

Lit la configuration depuis FILE au lieu de parcourir les emplacements par défaut.

-L LOGLEVEL, –log LOGLEVEL

Règle la verbosité de journalisation. LOGLEVEL est l’un de error, warn, info, debug ou trace. En l’absence de l’option, l’option globale [pepsi] LOG s’applique, et à défaut info.

-v, –verbose

Affiche les messages de journal de toutes les sources, y compris les bibliothèques tierces.

-h, –help

Affiche un résumé d’utilisation et quitte.

-V, –version

Affiche la version et quitte.

95.1.45.1.7. Code de sortie

0

Achèvement réussi.

1

Une erreur s’est produite : un fichier de configuration malformé ou une connexion ou requête de base de données échouée. La raison est écrite dans le journal. Une vérification des clés servies qui ne peut pas s’exécuter est signalée dans sa section, non par le code de sortie.

78

Le schéma de la base de données appartient à une autre version de Pepsi (non installé, plus ancien, plus récent ou modifié) ; exécutez pepsi-setup schema (voir pepsi-setup(1)).

95.1.45.1.8. Fichiers

Lorsque –config n’est pas fourni, le premier fichier existant de la liste suivante est utilisé. Chaque composant Pepsi partage le même fichier de configuration, c’est donc la même liste que chacun parcourt :

  • $XDG_CONFIG_HOME/pepsi.conf

  • $HOME/.config/pepsi.conf

  • /etc/pepsi/pepsi.conf

  • /etc/pepsi.conf

95.1.45.1.9. Exemples

Imprimer le rapport de santé complet

pepsi-status -c /etc/pepsi/pepsi.conf

Collecter le rapport en JSON pour un système de surveillance via SSH

ssh mail.example.com pepsi-status --json

Afficher jusqu’à 200 messages bloqués

pepsi-status -c /etc/pepsi/pepsi.conf --limit 200

95.1.45.1.10. Voir aussi

pepsi-queue(1), pepsi-tlsrpt(1), pepsi-quota(1), pepsi-dispatch(1), pepsi.conf(5), pepsi-setup(1)

95.1.45.1.11. Bogues

Signalez les bogues au gestionnaire de tickets de Pepsi.