The 20260509 ADR landed in docs/adr/ (plural) by mistake. Convention is doc/adr/ (alongside the existing 00_*, 01_*, … docs and the network-architecture/cicd-architecture ADRs that pre-existed there). Note : 20260407-*.md files in the typo'd docs/adr/ are still untracked (never committed) — separate cleanup task.
12 KiB
← ADRs · factory · 20260509 — telegram-gateway auth
Cross-references (bidirectionnel : chaque fichier listé doit citer cette ADR en tête)
- Code (repo
arcodange/telegram-gateway) :auth.go·handler_auth.go·allowlist.go·server.go·chart/values.yaml- User docs :
AUTH.md·HOWTO_ADD_BOT.md- Related ADR :
20260407-network-architecture.md(Cloudflare / Traefik / CrowdSec stack)- Implementation plan :
~/.claude/plans/pour-les-notifications-on-inherited-seal.md§ Phase 1.5
ADR 20260509: Telegram Gateway — Authentication Layer
Status
Proposed
Context
Le service telegram-gateway (Phase 1, livré le 2026-05-09) expose des bots Telegram via webhooks publics sur tg.arcodange.fr/bot/<slug>. À ce stade :
- Tout utilisateur Telegram qui connaît le handle d'un bot peut le DM et déclencher son handler.
- Le gateway valide le
secret_tokenTelegram (qui prouve que Telegram envoie le webhook), pas l'identité du user derrière le message. - Avant d'ouvrir le gateway à d'autres bots utiles (commandes
/build, scripts Ollama, etc.), il faut un protocole d'authentification.
Le besoin métier :
- Un bot principal (
@arcodange_factory_bot, slug internefactory) sert de point d'auth. - Une commande
/auth <code>valide une session pour l'utilisateur Telegram qui l'envoie. - Les autres bots du gateway ne répondent qu'aux utilisateurs déjà authentifiés, par défaut (secure-by-default).
- En garde-fou supplémentaire, une allowlist d'IDs Telegram peut filtrer les utilisateurs autorisés à parler aux bots, indépendamment de l'auth (silent-drop avant tout traitement).
Decision
1. Identité utilisateur
Telegram n'expose pas l'IP de l'utilisateur côté bot. La clé stable est from.id (Telegram user ID, int64, identique pour un même compte sur tous les devices). On l'utilise comme identifiant de session.
Hors scope : auth liée au device/IP — nécessiterait un canal d'auth séparé (web UI sur LAN, etc.).
2. Stockage de session
- Redis (
redis.tools.svc.cluster.local:6379, déjà déployé dans le namespacetools). - Clé :
tg-gw:auth:<from.id>→ valeur1(ou JSON metadata si on enrichit plus tard). - TTL : 24 h par défaut, configurable via env
AUTH_SESSION_TTL(Go duration :12h,7d, etc.). - Refresh : chaque
/authréussi remet le TTL à zéro.
3. Bot principal & commandes
Le bot factory passe du handler echo au handler auth. Le handler auth reconnaît :
| Commande | Effet |
|---|---|
/start |
Message d'accueil + liste des commandes disponibles |
/auth <code> |
Compare <code> à AUTH_SECRET en constant-time ; si OK → SET Redis, deleteMessage du message original (replay defense), reply "✅ Authentifié pour 24 h" |
/whoami |
Affiche le user_id et le TTL restant (ou "non authentifié") |
/logout |
DEL Redis, reply "Déconnecté" |
| autre | Rappel des commandes |
4. Garde-fou allowlist
Env ALLOWED_USERS : CSV de from.id Telegram (12345,67890). Comportement :
- Vide ou absent → ouvert à tous (rétro-compat Phase 1).
- Set → tout
from.idhors-liste fait l'objet d'un silent-drop (HTTP 200 vide vers Telegram, log INFO côté gateway, pas de réponse au user). - Le silent-drop intervient avant la gate auth. Permet de masquer l'existence des bots à des inconnus.
5. Gate requireAuth par bot — secure-by-default
Champ booléen dans chart/values.yaml, par bot. Sémantique :
- Default =
true(secure-by-default). Tout bot omet ce champ → gated. - Pour rendre un bot public, ajout explicite
requireAuth: false. - Pour
handler: auth(le bot principal),requireAuthest forcé àfalseautomatiquement (chicken-and-egg : si l'auth elle-même est gated, personne ne peut s'authentifier).
bots:
factory:
handler: auth # requireAuth auto-forcé à false
pingbot:
handler: echo # requireAuth: true (implicite, défaut)
statusbot:
handler: echo
requireAuth: false # opt-out explicite, bot public
Lorsque requireAuth: true et que le user n'est pas authentifié :
🔒 Authentifie-toi d'abord avec
/auth <code>chez @arcodange_factory_bot
… puis ack 200 à Telegram. Le handler du bot n'est pas appelé.
6. Fail-at-startup
Si AUTH_SECRET est vide ET au moins un bot a handler=auth ou requireAuth: true (y compris par défaut) → le pod échoue au boot avec un message clair. Évite le scénario "auth silencieusement off, bots accessibles à tous sans le savoir". Avec un défaut requireAuth: true, en pratique tout déploiement exige AUTH_SECRET (sauf si tous les bots font opt-out explicite).
Architecture Diagrams
1. Flow /auth (login)
%%{init: {'theme':'neutral'}}%%
sequenceDiagram
participant U as Utilisateur
participant TG as Telegram
participant GW as telegram-gateway
participant R as Redis (tools)
U->>TG: /auth s3cr3t (DM @arcodange_factory_bot)
TG->>GW: POST /bot/factory<br/>X-Telegram-Bot-Api-Secret-Token: …
GW->>GW: verify secret_token (Telegram→GW)
GW->>GW: check ALLOWED_USERS (si configuré)
GW->>GW: factory.handler = auth, parse "/auth s3cr3t"
GW->>GW: subtle.ConstantTimeCompare(s3cr3t, AUTH_SECRET)
alt Code valide
GW->>R: SET tg-gw:auth:<from.id> EX 24h
GW->>TG: deleteMessage (replay defense)
GW->>TG: sendMessage "✅ Authentifié pour 24h"
GW->>TG: 200 OK (ack webhook)
TG->>U: "✅ Authentifié pour 24h"
else Code invalide
GW->>TG: sendMessage "❌ Mauvais code"
GW->>TG: 200 OK
TG->>U: "❌ Mauvais code"
end
2. Accès à un bot gated (requireAuth: true, défaut)
%%{init: {'theme':'neutral'}}%%
sequenceDiagram
participant U as Utilisateur
participant TG as Telegram
participant GW as telegram-gateway
participant R as Redis
participant H as Bot handler (echo / http / shell…)
U->>TG: ping (DM @autre_bot)
TG->>GW: POST /bot/autre_bot
GW->>GW: verify secret_token + parse Update
GW->>GW: ALLOWED_USERS check
GW->>R: EXISTS tg-gw:auth:<from.id>
alt Authentifié
R-->>GW: 1
GW->>H: Handler.Handle(update, bot)
H->>TG: sendMessage (réponse métier)
GW->>TG: 200 OK
else Non authentifié
R-->>GW: 0
GW->>TG: sendMessage "🔒 /auth chez @arcodange_factory_bot"
GW->>TG: 200 OK
end
3. Décision globale à l'arrivée d'un webhook
%%{init: {'theme':'neutral'}}%%
graph TD
%% classDef avec contraste explicite : fond clair → texte sombre
classDef ok fill:#d4edda,stroke:#28a745,color:#155724;
classDef block fill:#f8d7da,stroke:#dc3545,color:#721c24;
classDef neutral fill:#e2e3e5,stroke:#6c757d,color:#383d41;
Start[Webhook POST /bot/<slug>]:::neutral
SecretCheck{secret_token<br/>match ?}:::neutral
AllowlistCheck{from.id ∈<br/>ALLOWED_USERS ?}:::neutral
HandlerKind{handler == auth ?}:::neutral
AuthGate{requireAuth ?<br/>+ session valide ?}:::neutral
Reject401[401 Unauthorized]:::block
SilentDrop[200 vide<br/>silent drop]:::block
Forbidden[reply "🔒 /auth …"<br/>200 OK]:::block
AuthHandler[handler auth<br/>/auth /whoami /logout]:::ok
BotHandler[Bot handler<br/>echo / http / shell]:::ok
Start --> SecretCheck
SecretCheck -- non --> Reject401
SecretCheck -- oui --> AllowlistCheck
AllowlistCheck -- non --> SilentDrop
AllowlistCheck -- oui --> HandlerKind
HandlerKind -- oui --> AuthHandler
HandlerKind -- non --> AuthGate
AuthGate -- pas autorisé --> Forbidden
AuthGate -- OK --> BotHandler
Consequences
Positive
- Confidentialité : les bots métier ne répondent qu'aux comptes Telegram authentifiés, par défaut.
- Défense en profondeur :
ALLOWED_USERS(allowlist),secret_token(Telegram→GW),AUTH_SECRET(user→bot), TTL session. - UX simple : un
/auth <code>ponctuel, valide 24 h. - Pas de migration côté Phase 2/3 : la gate s'insère cleanly avant l'enqueue ou le forward.
- Replay defense : le message contenant le code est supprimé du chat après login réussi.
- Secure-by-default : un nouveau bot ajouté au gateway exige une session sans rien à configurer.
Negative
- Code partagé :
AUTH_SECRETglobal (pas TOTP/per-user). Si compromis → rotation manuelle (changer Secret + redeploy). - Pas de rate-limit sur
/auth: un utilisateur dansALLOWED_USERSpeut bruteforce le code en pratique. Mitigation :ALLOWED_USERSagit en floor, et 128+ bits de code rendent le bruteforce inutile dans la fenêtre de TTL. - Dépendance Redis : si Redis tombe, plus aucun user n'est considéré authentifié → tous les bots gated répondent "🔒". Acceptable (fail-closed) ; Phase 1 a déjà restauré Redis cleanly.
- Pas de session multi-device explicite :
from.idest le même sur tous les devices d'un compte → l'auth couvre déjà tous les devices, ce qui est le comportement attendu.
Alternatives Considered
Alternative 1 : auth par IP
Rejetée. Telegram n'expose pas l'IP du user au bot. Aurait nécessité un canal d'auth secondaire (web UI sur LAN, page d'accueil arcodange.fr) et un binding device. Coût significatif pour un bénéfice ambigu.
Alternative 2 : TOTP / OTP rotatif
Rejetée à ce stade. Plus sécurisé que le code partagé mais ajoute :
- Une étape d'enrôlement (afficher un QR code, scanner avec une app).
- Une horloge synchronisée côté gateway et côté user.
- De la complexité utilisateur (sortir l'app à chaque /auth).
À reconsidérer si le code partagé fuit régulièrement ou si on ouvre à plus d'utilisateurs.
Alternative 3 : Postgres au lieu de Redis pour les sessions
Rejetée. Postgres serait nécessaire pour Phase 2 (queue durable), mais pour des sessions à TTL court, Redis est l'outil idiomatique :
- Latence sub-ms.
- TTL natif (
SET … EX 86400). - Déjà déployé et utilisé (CrowdSec bouncer).
Alternative 4 : pas de session, vérification du code à chaque message
Rejetée. UX terrible (devoir re-taper le code à chaque DM) et n'apporte rien (le code en clair traîne plus longtemps en chat).
Alternative 5 : requireAuth: false par défaut (insecure-by-default)
Rejetée (initialement retenue, puis renversée). Avoir requireAuth: false par défaut signifie qu'un bot ajouté sans précaution est accessible à tous. Avec un gateway pensé "private by design", le défaut sécurisé true cadre bien mieux.
Plan d'implémentation
Voir ~/.claude/plans/pour-les-notifications-on-inherited-seal.md § Phase 1.5.
Résumé des fichiers touchés :
- Nouveaux (repo
arcodange/telegram-gateway) :auth.go,handler_auth.go,allowlist.go,AUTH.md - Modifiés :
telegram_types.go,telegram.go,handlers.go,config.go,server.go,main.go,go.mod,chart/values.yaml,chart/templates/deployment.yaml,HOWTO_ADD_BOT.md - Cluster :
kubectl patch secret telegram-gateway-botspour ajouterAUTH_SECRETet (optionnel)ALLOWED_USERS
Success Metrics
/auth <wrong>→ 100 % refus, 0 SET Redis./auth <right>→ 100 % succès, deleteMessage best-effort exécuté.- Bot avec
requireAuth: true(défaut) répond le message "🔒 …" à 100 % des users non authentifiés. - Session expire effectivement après TTL (vérif via
kubectl exec redis-0 -- redis-cli TTL …). - Aucun secret (code, token bot) dans les logs.
- Latence ajoutée par la gate < 5 ms (Redis EXISTS local).