@nodefony/realtime 10.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/LICENSE +544 -0
  2. package/README.md +207 -0
  3. package/dist/_virtual/_@oxc-project_runtime@0.148.0/helpers/esm/decorate.js +9 -0
  4. package/dist/_virtual/_@oxc-project_runtime@0.148.0/helpers/esm/decorateMetadata.js +6 -0
  5. package/dist/index.js +218 -0
  6. package/dist/nodefony/config/config.js +63 -0
  7. package/dist/nodefony/config/defineModuleConfig.js +60 -0
  8. package/dist/nodefony/decorators/realtimeDecorators.js +240 -0
  9. package/dist/nodefony/interfaces/IBackplane.js +1 -0
  10. package/dist/nodefony/interfaces/IChannelPolicy.js +1 -0
  11. package/dist/nodefony/interfaces/IClientLogsLimits.js +1 -0
  12. package/dist/nodefony/interfaces/IRealtimeAuthenticator.js +1 -0
  13. package/dist/nodefony/interfaces/IRealtimeAuthenticatorMatcher.js +1 -0
  14. package/dist/nodefony/interfaces/IRealtimeController.js +1 -0
  15. package/dist/nodefony/interfaces/IRealtimeHandshake.js +1 -0
  16. package/dist/nodefony/interfaces/IRealtimeProbe.js +1 -0
  17. package/dist/nodefony/interfaces/IRealtimeToken.js +1 -0
  18. package/dist/nodefony/interfaces/index.js +1 -0
  19. package/dist/nodefony/src/backplane/ClusterBackplane.js +105 -0
  20. package/dist/nodefony/src/backplane/LoopbackBackplane.js +40 -0
  21. package/dist/nodefony/src/backplane/RedisBackplane.js +176 -0
  22. package/dist/nodefony/src/backplane/backplaneRegistry.js +20 -0
  23. package/dist/nodefony/src/backplane/envelope.js +109 -0
  24. package/dist/nodefony/src/backplane/originId.js +35 -0
  25. package/dist/nodefony/src/backplane/publishQueue.js +96 -0
  26. package/dist/nodefony/src/cluster/ClusterProbeClient.js +284 -0
  27. package/dist/nodefony/src/server/AnonymousRealtimeToken.js +35 -0
  28. package/dist/nodefony/src/server/RealtimeAdminApi.js +87 -0
  29. package/dist/nodefony/src/server/RealtimeController.js +601 -0
  30. package/dist/nodefony/src/server/RealtimeHub.js +926 -0
  31. package/dist/nodefony/src/server/ServerRealtimeSocket.js +168 -0
  32. package/dist/nodefony/src/server/deniedDetail.js +29 -0
  33. package/dist/nodefony/src/server/syslogUplink.js +105 -0
  34. package/dist/nodefony/src/server/welcomeEnv.js +25 -0
  35. package/dist/nodefony/src/service/RealtimeService.js +240 -0
  36. package/dist/nodefony/src/transport/WsConnectionTransport.js +94 -0
  37. package/dist/nodefony/testing/index.js +163 -0
  38. package/dist/types/index.d.ts +99 -0
  39. package/dist/types/nodefony/config/config.d.ts +43 -0
  40. package/dist/types/nodefony/config/defineModuleConfig.d.ts +49 -0
  41. package/dist/types/nodefony/decorators/realtimeDecorators.d.ts +190 -0
  42. package/dist/types/nodefony/interfaces/IBackplane.d.ts +128 -0
  43. package/dist/types/nodefony/interfaces/IChannelPolicy.d.ts +28 -0
  44. package/dist/types/nodefony/interfaces/IClientLogsLimits.d.ts +22 -0
  45. package/dist/types/nodefony/interfaces/IRealtimeAuthenticator.d.ts +53 -0
  46. package/dist/types/nodefony/interfaces/IRealtimeAuthenticatorMatcher.d.ts +46 -0
  47. package/dist/types/nodefony/interfaces/IRealtimeController.d.ts +36 -0
  48. package/dist/types/nodefony/interfaces/IRealtimeHandshake.d.ts +27 -0
  49. package/dist/types/nodefony/interfaces/IRealtimeProbe.d.ts +206 -0
  50. package/dist/types/nodefony/interfaces/IRealtimeToken.d.ts +48 -0
  51. package/dist/types/nodefony/interfaces/index.d.ts +18 -0
  52. package/dist/types/nodefony/src/backplane/ClusterBackplane.d.ts +76 -0
  53. package/dist/types/nodefony/src/backplane/LoopbackBackplane.d.ts +29 -0
  54. package/dist/types/nodefony/src/backplane/RedisBackplane.d.ts +164 -0
  55. package/dist/types/nodefony/src/backplane/backplaneRegistry.d.ts +51 -0
  56. package/dist/types/nodefony/src/backplane/envelope.d.ts +27 -0
  57. package/dist/types/nodefony/src/backplane/originId.d.ts +22 -0
  58. package/dist/types/nodefony/src/backplane/publishQueue.d.ts +71 -0
  59. package/dist/types/nodefony/src/cluster/ClusterProbeClient.d.ts +90 -0
  60. package/dist/types/nodefony/src/server/AnonymousRealtimeToken.d.ts +3 -0
  61. package/dist/types/nodefony/src/server/RealtimeAdminApi.d.ts +18 -0
  62. package/dist/types/nodefony/src/server/RealtimeController.d.ts +165 -0
  63. package/dist/types/nodefony/src/server/RealtimeHub.d.ts +516 -0
  64. package/dist/types/nodefony/src/server/ServerRealtimeSocket.d.ts +63 -0
  65. package/dist/types/nodefony/src/server/deniedDetail.d.ts +25 -0
  66. package/dist/types/nodefony/src/server/syslogUplink.d.ts +58 -0
  67. package/dist/types/nodefony/src/server/welcomeEnv.d.ts +21 -0
  68. package/dist/types/nodefony/src/service/RealtimeService.d.ts +167 -0
  69. package/dist/types/nodefony/src/transport/WsConnectionTransport.d.ts +78 -0
  70. package/dist/types/nodefony/testing/index.d.ts +169 -0
  71. package/docs/actions.md +573 -0
  72. package/docs/architecture.md +889 -0
  73. package/docs/configuration.md +803 -0
  74. package/docs/cookbook-chat.md +1619 -0
  75. package/docs/couverture-bancs.md +139 -0
  76. package/docs/index.md +372 -0
  77. package/docs/observabilite.md +592 -0
  78. package/docs/protocole.md +518 -0
  79. package/docs/securite.md +845 -0
  80. package/docs/vocabulaire.md +845 -0
  81. package/package.json +83 -0
@@ -0,0 +1,845 @@
1
+ ---
2
+ title: "Sécurité du temps réel — qui entre, qui écoute, jusqu'à quand"
3
+ navTitle: Sécurité du temps réel
4
+ lang: fr
5
+ module: "@nodefony/realtime"
6
+ topic: realtime
7
+ coverageModule: realtime
8
+ section: "Realtime"
9
+ audience: [developer]
10
+ tags:
11
+ [
12
+ realtime,
13
+ websocket,
14
+ securite,
15
+ handshake,
16
+ origin,
17
+ cswsh,
18
+ canaux,
19
+ autorisation,
20
+ revocation,
21
+ zero-trust,
22
+ ]
23
+ version: "doc"
24
+ status: stable
25
+ updated: 2026-07-19
26
+ source: "src/packages/@nodefony/realtime/docs/securite.md"
27
+ ---
28
+
29
+ # Sécurité du temps réel — qui entre, qui écoute, jusqu'à quand
30
+
31
+ > Une WebSocket n'est pas une requête, c'est une **porte qui reste ouverte**. Nodefony la garde
32
+ > avec quatre verrous : l'origine à l'entrée, l'identité au handshake, l'autorisation par frame,
33
+ > la révocation dans la durée. Cette page dit ce que chaque verrou bloque **et où il s'arrête** —
34
+ > une protection partielle y est annoncée comme partielle.
35
+
36
+ 📍 [Documentation](../../../../../docs/index.md) › [Realtime](index.md) › **Sécurité**
37
+
38
+ ## 🧠 Le modèle mental — un transporteur, un décideur
39
+
40
+ La règle qui explique tout le reste : **`@nodefony/realtime` ne décide jamais d'une autorisation.**
41
+ Il transporte des déclarations (« ce canal exige `ROLE_ADMIN` ») jusqu'à un décideur, et
42
+ `@nodefony/security` est ce décideur. Le module realtime ignore la hiérarchie de rôles, ignore la
43
+ session, ignore l'utilisateur réel.
44
+
45
+ Conséquence directe, à garder en tête pendant toute la lecture : **sans `@nodefony/security` câblé,
46
+ aucune politique de canal n'est appliquée.** Le transport fonctionne, les déclarations sont
47
+ collectées, personne ne les fait respecter.
48
+
49
+ ```mermaid
50
+ flowchart TD
51
+ C["Client — GET /realtime<br/>Upgrade: websocket"] --> H1["1. Transport HTTP<br/>same-origin anti-CSWSH"]
52
+ H1 -->|refus| X1["close 1008"]
53
+ H1 --> H2["2. Firewall HTTP<br/>zone protégée ? 401 si anonyme"]
54
+ H2 --> H3["3. Origin realtime<br/>allowlist stricte (opt-in)"]
55
+ H3 -->|refus| X2["close 4003"]
56
+ H3 --> H4["4. Authenticator<br/>handshake → IRealtimeToken"]
57
+ H4 -->|throw| X3["close 4001"]
58
+ H4 --> W["welcome — la porte est ouverte"]
59
+ W --> F["chaque frame entrante"]
60
+ F --> V{"verrou de frame<br/>posé par security ?"}
61
+ V -->|non| PASS["tout passe"]
62
+ V -->|oui| D{"policy du canal<br/>satisfaite ?"}
63
+ D -->|non| DEN["drop + realtime:denied<br/>+ audit"]
64
+ D -->|oui| ACT["handler métier"]
65
+ W -.->|toutes les 30 s| REV["re-validation identité<br/>session morte → close 4001"]
66
+ ```
67
+
68
+ Les étapes 1 et 2 appartiennent à `@nodefony/http` et `@nodefony/security` : la requête d'upgrade
69
+ **est** une requête HTTP, elle traverse le pipeline normal avant d'atteindre le realtime. Les
70
+ étapes 3, 4 et le verrou de frame sont portés par ce module.
71
+
72
+ ## 📖 Lexique
73
+
74
+ <!-- prettier-ignore -->
75
+ | Terme | Sens |
76
+ | --- | --- |
77
+ | Handshake | La requête HTTP `Upgrade: websocket` qui ouvre la connexion. **Tout le contrôle d'identité s'y joue.** |
78
+ | Frame | Un message JSON-RPC 2.0 circulant une fois la porte ouverte (`subscribe`, `api.request`, notification). |
79
+ | Canal (_channel_) | Un flux nommé auquel on s'abonne (`orders:feed`, `nodefony:syslog`) ; le hub le diffuse à tous ses abonnés. |
80
+ | CSWSH | _Cross-Site WebSocket Hijacking_ : un site tiers ouvre une WS vers ton app, **avec le cookie de la victime**. |
81
+ | Origin | En-tête RFC 6455 §10.2 disant d'où vient la page qui ouvre la socket. Seule preuve d'origine disponible. |
82
+ | Token realtime | `IRealtimeToken` — carte d'identité de la connexion, figée au handshake, lue en O(1) à chaque frame. |
83
+ | Verrou de frame | `FrameAuthorizer` — fonction **sync** qui accepte ou refuse une frame. Posée par security au boot. |
84
+ | Policy de canal | `IChannelPolicy` — exigences déclarées sur un canal (`authenticated`, `roles`, `scopes`). |
85
+ | Namespace réservé | Le préfixe `nodefony:`, qui marque les canaux de la plateforme (`nodefony:syslog`, `nodefony:audit`…) et porte un **plancher** d'autorisation que la config ne peut pas descendre. |
86
+ | Zero Trust | Aucune identité n'est supposée : un visiteur porte toujours un token, anonyme par défaut. |
87
+ | Fail-closed / loud | En cas de doute on **refuse** ; toute dégradation de sécurité est **annoncée** (WARNING), jamais silencieuse. |
88
+ | Backplane | Le bus qui propage les publications entre pods (Redis, IPC cluster). |
89
+ | BFF | _Backend-For-Frontend_ : la session serveur (cookie opaque) qui porte l'identité web. |
90
+
91
+ ## 🔐 Qu'est-ce que ça défend, concrètement ?
92
+
93
+ Une WebSocket authentifiée est une cible de choix : elle porte une identité, vit longtemps et
94
+ diffuse en continu.
95
+
96
+ | Attaque | Ce qui la bloque | Où |
97
+ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------ |
98
+ | **CSWSH** — `evil.com` fait `new WebSocket("wss://app.exemple.com/rt")`, le navigateur joint le cookie | Contrôle d'`Origin` same-origin par défaut, puis allowlist stricte | `@nodefony/http` transport, puis `csrf.checkOrigin` realtime |
99
+ | **Écoute des flux internes** — un visiteur s'abonne à `nodefony:syslog` et lit les logs du pod | Plancher des namespaces réservés (authentifié + `ROLE_ADMIN`) | Verrou de frame `@nodefony/security` |
100
+ | **Élévation par canal métier** — un `ROLE_USER` s'abonne au canal admin d'un autre module | Policy déclarée sur le canal, évaluée avec la hiérarchie de rôles | `@RealtimeChannel(name, { roles })` + verrou de frame |
101
+ | **Pont API plus permissif que REST** — `api.request {path}` pour contourner un 401 HTTP | Re-match de la MÊME zone firewall que `GET {path}` | Verrou de frame, surface `api.request` |
102
+ | **Socket zombie** — un admin se déconnecte, sa socket continue de diffuser | Re-validation périodique de l'identité, fermeture `4001` | Tick de révocation du hub |
103
+ | **DoS mémoire par abonnements** — une connexion ouvre des milliers de canaux | Plafond de canaux par connexion (256 par défaut) | `limits.maxChannelsPerConnection` |
104
+ | **DoS mémoire par lenteur** — un client ne lit pas, la file d'envoi enfle jusqu'à l'OOM | Jet de frames à 1 MiB, fermeture `1013` à 8 MiB | Back-pressure du transport WS |
105
+ | **Oracle d'autorisation** — sonder les canaux pour cartographier les droits | Motif de refus **générique** (`forbidden`), jamais le détail | `realtime:denied` |
106
+
107
+ > [!IMPORTANT]
108
+ > Les lignes 2 à 5 supposent `@nodefony/security` chargé **avec au moins une zone protégée**. Sans
109
+ > cela, le verrou de frame n'est jamais posé et ces défenses sont inertes — c'est la condition
110
+ > détaillée au verrou 3, le point le plus important de la page.
111
+
112
+ ## 🎯 La vision Nodefony — une seule politique, deux transports
113
+
114
+ HTTP et WebSocket vivent dans le même contexte : la sécurité en hérite, **on n'écrit pas deux
115
+ politiques.**
116
+
117
+ - Une zone du firewall couvre HTTP **et** WS par défaut (`realtime: true` —
118
+ `security/nodefony/config/config.ts:109`). L'opt-out est explicite ; un opt-in aurait été
119
+ _fail-open_ (une zone qui oublie le flag laisserait le WS anonyme).
120
+ - Le verrou de frame consulte la **même** fonction de match que le HTTP, `Firewall.matchPath()`
121
+ (`firewall.ts:696`), et la **même** hiérarchie de rôles, `Firewall.hasRole()`
122
+ (`firewall.ts:466`). Invariant par construction : `api.request {path}` n'accorde jamais plus que
123
+ `GET {path}`.
124
+ - L'identité du handshake est celle du firewall HTTP : `FirewallRealtimeAuthenticator`
125
+ (`FirewallRealtimeAuthenticator.ts:57`) ne relit ni cookie ni base, il **promeut** l'`IUser` déjà
126
+ posé dans l'ALS. Zéro lecture redondante par connexion.
127
+
128
+ Le compromis assumé : l'identité est **figée au handshake**, les frames lisent un cache O(1). C'est
129
+ ce qui rend le temps réel tenable, et ce qui crée le besoin d'un tick de révocation (verrou 4).
130
+
131
+ ## 🚀 Démarrage rapide
132
+
133
+ Objectif : dans une app générée par `nodefony create app`, exposer un canal `orders:feed` réservé
134
+ aux administrateurs, et voir ce que reçoit un client non autorisé.
135
+
136
+ ### 1. Déclarer la zone et activer l'origine stricte
137
+
138
+ ```typescript
139
+ // nodefony.config.ts — extrait
140
+ use("@nodefony/security", {
141
+ areas: {
142
+ // Zone protégée : le handshake WS de /rt passe par le MÊME contrôle que
143
+ // le HTTP. `realtime` vaut true par défaut → ne pas l'écrire suffit.
144
+ app: {
145
+ pattern: "^/rt",
146
+ authenticators: ["session"],
147
+ },
148
+ },
149
+ roleHierarchy: {
150
+ ROLE_ADMIN: ["ROLE_USER"],
151
+ },
152
+ });
153
+
154
+ use("@nodefony/realtime", {
155
+ csrf: {
156
+ checkOrigin: {
157
+ // Deuxième barrière d'origine : allowlist EXACTE (pas de wildcard).
158
+ enabled: true,
159
+ allowList: ["https://app.exemple.com", "https://127.0.0.1:5152"],
160
+ // Un client sans en-tête Origin (mobile natif, script) est refusé.
161
+ allowMissingOrigin: false,
162
+ },
163
+ },
164
+ limits: {
165
+ // Garde anti-OOM : au-delà, le subscribe est refusé (pas de close).
166
+ maxChannelsPerConnection: 64,
167
+ },
168
+ });
169
+ ```
170
+
171
+ ### 2. Le controller : un canal libre, un canal gardé
172
+
173
+ ```typescript
174
+ // nodefony/controllers/OrdersRealtimeController.ts — compile tel quel
175
+ import { controller, route } from "@nodefony/framework";
176
+ import { Context } from "@nodefony/http";
177
+ import { RealtimeChannel, RealtimeController } from "@nodefony/realtime";
178
+ import type { RealtimePublish } from "@nodefony/realtime";
179
+
180
+ @controller("/rt")
181
+ class OrdersRealtimeController extends RealtimeController {
182
+ constructor(context: Context) {
183
+ super("OrdersRealtimeController", context);
184
+ }
185
+
186
+ @route("orders-ws", {
187
+ path: "/orders",
188
+ requirements: { methods: ["WEBSOCKET"] },
189
+ })
190
+ async realtime(message: string | Buffer | null): Promise<void> {
191
+ this.handleRealtime(message);
192
+ }
193
+
194
+ // Canal PUBLIC : aucune policy déclarée → libre pour tout connecté.
195
+ @RealtimeChannel("orders:public")
196
+ publicFeed(channel: string, publish: RealtimePublish): () => void {
197
+ const timer = setInterval(() => publish(channel, { ts: Date.now() }), 2000);
198
+ return () => clearInterval(timer);
199
+ }
200
+
201
+ // Canal GARDÉ : la policy est une DÉCLARATION, transportée jusqu'à
202
+ // @nodefony/security qui l'évalue (hiérarchie de rôles comprise).
203
+ @RealtimeChannel("orders:feed", {
204
+ authenticated: true,
205
+ roles: ["ROLE_ADMIN"],
206
+ })
207
+ adminFeed(channel: string, publish: RealtimePublish): () => void {
208
+ const timer = setInterval(() => publish(channel, { pending: 3 }), 1000);
209
+ return () => clearInterval(timer);
210
+ }
211
+ }
212
+
213
+ export default OrdersRealtimeController;
214
+ ```
215
+
216
+ ### 3. Ce qu'observe le client refusé
217
+
218
+ Un `ROLE_USER` connecté demande les deux canaux. Le premier marche, le second est refusé — et le
219
+ refus est **visible**, jamais un silence.
220
+
221
+ ```typescript
222
+ // frontend — le client isomorphe du core
223
+ import { RealtimeClient } from "nodefony/client";
224
+
225
+ const socket = new RealtimeClient({ url: "wss://app.exemple.com/rt/orders" });
226
+
227
+ // Refus poussés par le serveur — première classe côté client.
228
+ socket.onDenied((denied) => {
229
+ // { channel: "orders:feed", reason: "forbidden" }
230
+ // Motif GÉNÉRIQUE : jamais « il te manque ROLE_ADMIN » (pas d'oracle).
231
+ console.warn("canal refusé", denied.channel, denied.reason);
232
+ });
233
+
234
+ await socket.connect();
235
+ socket.subscribe("orders:public"); // ✅ ticks reçus
236
+ socket.subscribe("orders:feed"); // ❌ aucun tick, un realtime:denied à la place
237
+ ```
238
+
239
+ **Ce qu'on observe côté serveur** : un log `WARNING` « WS realtime frame refused by authorizer »
240
+ et une entrée d'audit `category: "ws"`, `action: "frame.denied"`, `outcome: "denied"`, avec
241
+ l'acteur et le canal visé. Le canal n'est jamais ouvert : le provider ne démarre pas, le hub n'est
242
+ même pas appelé.
243
+
244
+ > [!WARNING]
245
+ > Ce démarrage rapide ne protège `orders:feed` que si `@nodefony/security` est chargé **et** que la
246
+ > zone `app` reste protégée. Retire le module, ou passe la zone en `realtime: false`, et le canal
247
+ > redevient ouvert à tout connecté — le serveur le signalera par un WARNING au boot, mais il ne
248
+ > refusera pas de démarrer.
249
+
250
+ ## 🛡️ Verrou 1 — l'origine : bloquer le CSWSH
251
+
252
+ Le navigateur n'applique **pas** CORS aux WebSockets. N'importe quelle page peut ouvrir une socket
253
+ vers ton domaine, et le navigateur y joindra les cookies de la victime. L'en-tête `Origin`
254
+ (RFC 6455 §10.2) est la seule information exploitable côté serveur.
255
+
256
+ Nodefony pose **deux barrières successives**, à deux étages différents.
257
+
258
+ | Barrière | Étage | Défaut | Origin absent | Refus |
259
+ | -------------------- | -------------------- | ----------------------------------- | ------------- | ------------ |
260
+ | Contrôle same-origin | `@nodefony/http` | **actif** (`allowedOrigins: false`) | accepté | `close 1008` |
261
+ | Allowlist stricte | `@nodefony/realtime` | **inactif** (`enabled: false`) | configurable | `close 4003` |
262
+
263
+ **Barrière 1 — transport, active sans rien faire.** `HttpKernel.checkWebsocketOrigin()`
264
+ (`http-kernel.ts:599`) exige que l'`Origin` du handshake corresponde au `Host` servi, avec tolérance
265
+ loopback en développement et une allowlist optionnelle (`allowedOrigins`,
266
+ `http/nodefony/config/config.ts:525`) acceptant le hostname exact ou un wildcard à un label. Une
267
+ requête **sans** `Origin` est acceptée : un attaquant non-navigateur n'a pas besoin de CSWSH.
268
+
269
+ **Barrière 2 — module realtime, opt-in et plus stricte.** `RealtimeHub.checkOrigin()`
270
+ (`RealtimeHub.ts:896`) consulte une garde compilée une fois au boot par `buildOriginGuard()`
271
+ (`RealtimeService.ts:291`) depuis `checkOriginSchema` (`realtime/nodefony/config/config.ts:162`).
272
+ Trois différences comptent :
273
+
274
+ 1. **Match exact scheme + host + port**, aucun wildcard. Durcissement volontaire par rapport au
275
+ CORS `Access-Control-Allow-Origin: *`.
276
+ 2. **Origin absent → refusé** par défaut (`allowMissingOrigin: false`). C'est le seul moyen de
277
+ fermer la porte aux clients non-navigateur.
278
+ 3. **Fail-closed** : `enabled: true` avec une `allowList` vide refuse **tout**. Une erreur de
279
+ configuration ferme la porte, elle ne l'ouvre pas.
280
+
281
+ Le refus est journalisé (`WARNING`, avec l'origine reçue) puis la socket est fermée en `4003`
282
+ « origin not allowed » — plage 4000-4999 réservée aux applications (RFC 6455 §7.4.2). Aucune frame
283
+ n'est jamais traitée.
284
+
285
+ > [!CAUTION]
286
+ > **Ce que l'Origin ne prouve pas.** C'est une déclaration du navigateur, pas une preuve
287
+ > cryptographique : un client non-navigateur peut l'inventer. L'Origin protège les **victimes de
288
+ > navigateur** (CSWSH), pas contre un attaquant qui contrôle son propre client. La défense contre
289
+ > ce dernier, c'est l'authentification — verrou suivant.
290
+
291
+ ## 🔐 Verrou 2 — l'identité : une seule fois, au handshake
292
+
293
+ ### Le pipeline exact
294
+
295
+ `RealtimeController.onHandshake()` (`RealtimeController.ts:312`) exécute, une fois par connexion :
296
+
297
+ 1. Construction d'un DTO neutre `IRealtimeHandshake` par `buildHandshakeFromContext()`
298
+ (`RealtimeController.ts:1053`) — headers, cookies aplatis, url, origin, sous-protocoles. Aucune
299
+ dépendance à `@nodefony/security` dans le contrat.
300
+ 2. Contrôle d'origine (verrou 1).
301
+ 3. Résolution de l'authenticator par `RealtimeHub.resolveAuthenticator()` (`RealtimeHub.ts:871`) :
302
+ les matchers sont testés dans l'ordre d'enregistrement, **le premier qui matche capture**.
303
+ 4. `authenticator.authenticate(handshake)` — **async autorisé** (on est en cold path, une fois par
304
+ connexion : lire un store est acceptable ici, jamais par frame).
305
+ 5. Pose du token sur la WeakMap `peer → token` via `RealtimeHub.setTokenForPeer()`
306
+ (`RealtimeHub.ts:936`), **avant** l'envoi du `welcome` : le lookup est garanti dès la première
307
+ frame.
308
+
309
+ Un `throw` de `authenticate()` ferme la socket en `4001` « unauthorized », après un log `WARNING`
310
+ nommant l'authenticator fautif. Le hook `onFailure` est invoqué dans un `try/catch` : un hook
311
+ d'audit défectueux ne peut pas empêcher la fermeture.
312
+
313
+ ### Les matchers — quelle porte, quel vigile
314
+
315
+ `RealtimeHub.useAuthenticator()` (`RealtimeHub.ts:853`) associe un sélecteur à une stratégie.
316
+ `compileMatcher()` (`RealtimeHub.ts:855`) le compile une fois :
317
+
318
+ - `pattern` chaîne → RegExp **préfixe ancrée**, méta-caractères échappés par `RegExp.escape`.
319
+ `"/admin/"` matche `/admin/` et `/admin/foo`, littéralement.
320
+ - `pattern` RegExp → utilisée telle quelle.
321
+ - `host` optionnel → comparaison **stricte** (insensible à la casse) sur l'en-tête `Host`, sans
322
+ wildcard.
323
+ - Le match porte sur le **path**, query comprise, jamais sur l'URL absolue : `handshakePath()`
324
+ (`RealtimeController.ts:1105`) extrait `pathname + search` du `WebsocketContext.url`, qui est
325
+ absolu. Sans cette extraction, un matcher `^/nodefony/…` ne se déclencherait jamais.
326
+
327
+ `@nodefony/security` enregistre ces matchers automatiquement dans `Firewall.#wireRealtime()`
328
+ (`firewall.ts:253`) : **une instance d'authenticator par zone protégée**, car le hub dédoublonne par
329
+ identité d'instance et une instance partagée n'enregistrerait que le premier matcher.
330
+
331
+ ### Zero Trust — il y a toujours un token
332
+
333
+ `RealtimeHub.getTokenForPeer()` (`RealtimeHub.ts:940`) ne renvoie **jamais** `null` : à défaut de
334
+ token posé, c'est `ANONYMOUS_REALTIME_TOKEN` (`AnonymousRealtimeToken.ts:18`), singleton gelé,
335
+ `isAuthenticated() === false`, `roles: ["ROLE_ANONYMOUS"]`. Le code consommateur (verrou, audit)
336
+ n'a jamais à écrire « et s'il n'y a pas de token ? ».
337
+
338
+ | Situation au handshake | Token posé | Connexion |
339
+ | ------------------------------------------------ | --------------------------- | ------------ |
340
+ | Aucun authenticator enregistré | `ANONYMOUS_REALTIME_TOKEN` | ouverte |
341
+ | Aucun matcher ne capture l'URL | `ANONYMOUS_REALTIME_TOKEN` | ouverte |
342
+ | Matcher trouvé mais `supports()` renvoie `false` | `ANONYMOUS_REALTIME_TOKEN` | **ouverte** |
343
+ | `authenticate()` réussit | le token de l'authenticator | ouverte |
344
+ | `authenticate()` throw | aucun | `close 4001` |
345
+
346
+ > [!WARNING]
347
+ > La troisième ligne est un comportement à comprendre : un authenticator qui **matche mais ne
348
+ > supporte pas** le handshake fait retomber la connexion en anonyme, sans fermeture. C'est le cas
349
+ > de `FirewallRealtimeAuthenticator.supports()` (`FirewallRealtimeAuthenticator.ts:80`) quand aucune
350
+ > identité authentifiée n'est en ALS. Ce n'est pas un trou **parce que** le firewall HTTP a déjà
351
+ > refusé l'anonyme en amont sur une zone protégée (Zero Trust appliqué à la requête d'upgrade). Sur
352
+ > une route WS **hors zone**, en revanche, la connexion anonyme aboutit : la protection y repose
353
+ > entièrement sur les policies de canal.
354
+
355
+ Le `welcome` transporte ensuite l'identité résolue (`type`, `authenticated`, `userIdentifier`,
356
+ `roles`, `scopes`) : le client sait qui il est sans appeler une route. Vue « sur soi » — aucun
357
+ secret, aucun claim d'un tiers.
358
+
359
+ ## 🧑‍⚖️ Verrou 3 — l'autorisation par frame
360
+
361
+ C'est le verrou le plus important et celui dont les limites doivent être les mieux comprises.
362
+
363
+ ### Et si le module de sécurité n'est pas chargé du tout ?
364
+
365
+ La question mérite d'être posée avant la mécanique, parce que la réponse a longtemps été mauvaise.
366
+ Sans `@nodefony/security`, personne ne pose de décideur : le hub laissait alors passer **tout**, y
367
+ compris les canaux qui décrivent l'intérieur du serveur — journaux, requêtes de base, métriques,
368
+ supervision. Un tableau de bord anonyme lisait les journaux du pod.
369
+
370
+ Le hub applique donc son **propre plancher**, qui ne dépend d'aucun module : tant qu'aucun verrou
371
+ n'est posé, une connexion cliente ne peut pas s'abonner à un canal de plateforme.
372
+
373
+ Un seul territoire porte cette marque : **`nodefony:`**. Tout ce que la plateforme expose sur la
374
+ socket y vit, et rien d'autre n'y entre.
375
+
376
+ | Canal | Ce qu'il expose |
377
+ | --------------------------------------------------------------------------------------- | --------------------------- |
378
+ | `nodefony:audit` | journal d'audit |
379
+ | `nodefony:syslog` | journaux du serveur |
380
+ | `nodefony:orm:health` · `nodefony:orm:flow` · `nodefony:orm:rich` | requêtes et santé des bases |
381
+ | `nodefony:dashboard` · `nodefony:supervision` · `nodefony:debugbar` · `nodefony:socket` | métriques et supervision |
382
+ | `nodefony:kernel:ping` · `nodefony:kernel:gc` | contrôle du pod |
383
+
384
+ Le raisonnement tient en une phrase : **sans module de sécurité, aucune identité n'existe**, donc
385
+ personne ne peut prouver qu'il a le droit de lire ces canaux — le seul état sûr est le refus. Les
386
+ canaux applicatifs (`chat:`, le vôtre) ne sont pas concernés : une application sans authentification
387
+ continue de fonctionner.
388
+
389
+ Trois conséquences pratiques :
390
+
391
+ - Le client **reçoit** `realtime:denied` avec le motif `forbidden` — il n'attend pas dans le vide.
392
+ - Le serveur **journalise une fois** au premier refus, en expliquant comment ouvrir (charger
393
+ `@nodefony/security` et déclarer une zone protégée). Un écran vide doit toujours avoir une cause
394
+ lisible quelque part.
395
+ - La sonde compte les refus (`systemFloorDeniedTotal`), ce qui distingue « configuration
396
+ incomplète » de « quelqu'un insiste ».
397
+
398
+ Dès qu'un module de sécurité pose son verrou, ce plancher s'efface : c'est le verrou qui décide,
399
+ avec les rôles — ce que le hub, seul, ne sait pas faire.
400
+
401
+ > [!NOTE]
402
+ > Un service **du serveur** qui s'abonne à ses propres journaux n'est pas concerné : il ne passe pas
403
+ > par la porte des connexions clientes. Le plancher vise le réseau, pas le code local.
404
+
405
+ ### La chaîne complète
406
+
407
+ ```mermaid
408
+ sequenceDiagram
409
+ participant C as Client
410
+ participant P as JsonRpcPeer
411
+ participant H as RealtimeHub
412
+ participant S as security — verrou
413
+ C->>P: {"method":"subscribe","params":{"channel":"nodefony:syslog"}}
414
+ P->>P: beforeDispatch (sync, hot path)
415
+ P->>H: runAuthorizer(frame, peer)
416
+ H->>H: getTokenForPeer(peer) — O(1) WeakMap
417
+ H->>S: frameAuthorizer(frame, token)
418
+ S->>S: plancher système ? puis policy métier ?
419
+ S-->>H: false
420
+ H-->>P: false
421
+ P->>P: onFrameAudit("denied", frame, peer)
422
+ P-->>C: realtime:denied {channel, reason:"forbidden"}
423
+ ```
424
+
425
+ Le verrou est **strictement synchrone** — `FrameAuthorizer` (`RealtimeHub.ts:39`). Un `await` par
426
+ frame coûterait une microtask et sérialiserait le pipeline RPC de la connexion. Il ne lit que de la
427
+ mémoire : le token déjà résolu, et la cible de la frame.
428
+
429
+ ### Les trois surfaces gardées
430
+
431
+ `buildFrameAuthorizer()` (`frameAuthorizer.ts:388`) ne garde que ce qui atteint des données :
432
+
433
+ <!-- prettier-ignore -->
434
+ | Frame | Contrôle appliqué |
435
+ | --- | --- |
436
+ | `api.request {path}` | Re-match de zone HTTP : zone protégée + anonyme → refus |
437
+ | `subscribe {channel}` | Plancher système, puis policy métier déclarée sur le canal |
438
+ | notification `method` = canal inbound | Même politique que `subscribe` (on ne pousse pas sur un canal protégé) |
439
+ | action `@RealtimeAction` | Authentifié **par défaut** ; rôle/scope si déclarés ; ouverte seulement si `{ authenticated: false }` est écrit |
440
+ | `ping`, `unsubscribe` | **passent** — pas de surface de données |
441
+
442
+ Deux détails évitent des faux refus : `authorizeApiRequest()` (`frameAuthorizer.ts:316`) laisse
443
+ passer une frame au `path` invalide (le handler renverra `-32602` — le verrou ne duplique pas la
444
+ validation), et `authorizeChannel()` (`frameAuthorizer.ts:309`) laisse passer un `channel`
445
+ non-chaîne (`startChannel` ignore de toute façon un canal absent).
446
+
447
+ ### Le plancher système — les namespaces réservés
448
+
449
+ Certains namespaces exposent l'intérieur du pod. Ils portent une politique par défaut que la config
450
+ peut **resserrer**, jamais desserrer.
451
+
452
+ | Cible | Politique par défaut |
453
+ | ------------------------------------------ | ------------------------------------------------------------- |
454
+ | `nodefony:audit` | authentifié + `ROLE_NODEFONY_ADMIN` (`frameAuthorizer.ts:99`) |
455
+ | tout le reste de `nodefony:` | authentifié + `ROLE_ADMIN` (`frameAuthorizer.ts:70`) |
456
+ | tout canal contenant `:health` ou `:stats` | authentifié + `ROLE_ADMIN` |
457
+ | tout le reste | libre, sauf policy déclarée |
458
+
459
+ Le journal d'audit est un **canal précis**, pas un namespace : sa règle est posée devant celle du
460
+ territoire (premier match gagnant), et elle n'existe que si le hub réserve bien ce territoire.
461
+
462
+ Trois durcissements méritent d'être connus :
463
+
464
+ - **Match insensible à la casse, sans allocation** — `startsWithCI()` (`frameAuthorizer.ts:181`).
465
+ Un `NODEFONY:syslog` ne contourne pas le plancher `nodefony:` par un changement de casse.
466
+ - **Plancher irréductible** — `floorReserved()` (`frameAuthorizer.ts:255`) : une règle de config qui
467
+ tenterait d'ouvrir un namespace réservé (`{ authenticated: false }`) se voit ré-imposer
468
+ `authenticated: true`. Le test porte sur le **namespace du canal**, pas sur le préfixe de la règle
469
+ qui a matché : un préfixe de config plus court ou altéré ne contourne rien.
470
+ - **La config passe avant les défauts** — les règles de `realtimeChannels`
471
+ (`security/nodefony/config/config.ts:1093`) sont placées en tête, premier match gagnant. On peut
472
+ donc re-cibler `nodefony:syslog` sur `ROLE_SECURITY_AUDITOR` ; on ne peut pas l'ouvrir à l'anonyme.
473
+
474
+ Le canal du journal d'audit (`nodefony:audit`) est enregistré comme **canal système** sur le hub
475
+ (`RealtimeHub.registerSystemChannel()`, `RealtimeHub.ts:1117`) : il devient servable par n'importe
476
+ quel endpoint realtime, sans qu'aucun controller ne le connaisse — et il est gardé par sa règle
477
+ dédiée. Son enregistrement est **couplé** à la pose du verrou (même condition), donc il n'existe
478
+ jamais de canal d'audit non gardé.
479
+
480
+ ### La policy métier — déclarer sur le canal
481
+
482
+ `@RealtimeChannel(name, policy)` (`realtimeDecorators.ts:142`) et `@RealtimeInbound(name, policy)`
483
+ (`realtimeDecorators.ts:182`) attachent un `IChannelPolicy` au **nom** du canal. Les trois axes sont
484
+ cumulatifs (ET) ; un axe absent n'impose rien :
485
+
486
+ | Axe | Sens | Évalué par |
487
+ | --------------- | ----------------------------------------------------------------------------- | ---------------------------------------- |
488
+ | `authenticated` | token non anonyme | `satisfies()` (`frameAuthorizer.ts:240`) |
489
+ | `roles` | un des rôles suffit, **hiérarchie comprise** | `Firewall.hasRole()` (`firewall.ts:466`) |
490
+ | `scopes` | un des scopes suffit — axe API (JWT, clé API), une session BFF n'en porte pas | comparaison directe |
491
+
492
+ Une policy **vide** n'est pas enregistrée : `definePolicy()` (`realtimeDecorators.ts:40`) ignore un
493
+ objet sans contrainte — le canal reste libre, le registre reste vide. Les déclarations sont publiées
494
+ au hub **au handshake**, pas au boot (`RealtimeHub.registerChannelPolicy()`, `RealtimeHub.ts:1037`,
495
+ idempotent) ; le décideur les relit par `RealtimeService.resolveChannelPolicy()`
496
+ (`RealtimeService.ts:277`).
497
+
498
+ ### ⚠️ Une policy est attachée à un nom EXACT — les canaux dérivés n'héritent pas
499
+
500
+ `@RealtimeChannel("chat:room", { roles })` garde `chat:room`, **et rien d'autre**. Le registre est
501
+ indexé par le nom, à la lettre : un canal **dérivé** — `chat:room:1000` (cadence),
502
+ `orm:queries@1234` (forage), `chat:room:<identifiant>` — ne matche pas. Il est servi par la
503
+ fabrique dynamique du contrôleur (`createRealtimeChannel`), et `resolveChannelPolicy()` rend `null`
504
+ pour lui : aucune contrainte.
505
+
506
+ C'est le piège le plus facile à ne pas voir, parce que tout a l'air correct : la déclaration est
507
+ là, le canal fonctionne, et le refus attendu n'arrive jamais.
508
+
509
+ Le serveur le **dit** désormais. Au premier canal servi dynamiquement sans politique, alors que le
510
+ module en déclare pour d'autres canaux, un avertissement est journalisé une fois
511
+ (`RealtimeHub.noticeUnguardedDynamicChannel()`, `RealtimeHub.ts:1090`) :
512
+
513
+ ```
514
+ le canal "chat:room:1000" est servi par une fabrique DYNAMIQUE et n'est couvert par AUCUNE
515
+ politique déclarée, alors que ce module en déclare pour d'autres canaux. […]
516
+ ```
517
+
518
+ Deux façons de fermer, selon l'intention :
519
+
520
+ - **le canal doit être gardé** → l'exposer sous un nom déclaré (un canal par nom exact), ou porter
521
+ la vérification **dans la fabrique** elle-même, qui reçoit le nom demandé et peut refuser (`null`) ;
522
+ - **le canal est public** → rien à faire, l'avertissement dit seulement qu'il n'est pas gardé.
523
+
524
+ > Une déclaration par **motif** (`chat:*`) lèverait la limite ; elle n'existe pas encore et ne se
525
+ > conçoit pas seule — elle fait partie d'un chantier plus large sur les canaux à membres.
526
+
527
+ ### ⚠️ La condition d'activation — le point critique
528
+
529
+ Le verrou n'existe que si quelqu'un le pose. Deux conditions doivent être vraies **en même temps** :
530
+
531
+ 1. `@nodefony/security` est chargé, et
532
+ 2. au moins une zone a `security: true` **et** `realtime: true`.
533
+
534
+ C'est exactement le test de `Firewall.#wireRealtime()` (`firewall.ts:253`) : sans zone qualifiante,
535
+ `wired` reste faux, `setFrameAuthorizer` n'est jamais appelé, et **aucune** policy de canal n'est
536
+ évaluée — ni métier, ni système. `nodefony:syslog` redevient un canal ordinaire.
537
+
538
+ Deuxième subtilité : `beforeDispatch` n'est branché sur une connexion que si le verrou est **déjà**
539
+ posé au moment de son handshake (`RealtimeController.ts:429`, via
540
+ `RealtimeHub.hasFrameAuthorizer()` — `RealtimeHub.ts:961`). Choix de performance délibéré (un hub
541
+ non sécurisé garde un coût nul par frame), mais avec une conséquence : **une connexion ouverte avant
542
+ la pose du verrou n'est jamais gardée**, et ce jusqu'à sa fermeture. En fonctionnement normal le
543
+ firewall se construit au boot, avant tout trafic ; le cas ne se présente qu'en appelant
544
+ `setFrameAuthorizer()` à chaud.
545
+
546
+ **Le refus de dégrader en silence.** Quand des policies sont déclarées sans décideur câblé,
547
+ `RealtimeHub.hasUnenforcedChannelPolicies()` (`RealtimeHub.ts:1020`) renvoie `true` et le controller
548
+ émet un WARNING explicite, une seule fois par process (`RealtimeController.ts:522`) :
549
+
550
+ ```text
551
+ Realtime channel policies declared but NO frame authorizer is wired —
552
+ these policies are NOT enforced (a protected channel is currently open).
553
+ Load @nodefony/security with a realtime zone to enforce them.
554
+ ```
555
+
556
+ C'est le comportement prouvé par `realtimeUnenforcedPolicy.attack.test.ts` : une policy déclarée
557
+ sans `frameAuthorizer` est détectée comme **inerte**, et l'ajout du `frameAuthorizer` éteint
558
+ l'alerte. Le test ne prouve pas que le canal est fermé — il prouve que le framework **le dit**.
559
+
560
+ > [!CAUTION]
561
+ > **Portée exacte de cette alerte.** Elle se déclenche uniquement s'il existe au moins une policy
562
+ > **déclarée** par un décorateur. Une application qui n'utilise aucun `@RealtimeChannel` avec
563
+ > policy, mais qui expose des canaux de namespace réservé (`nodefony:syslog`, `nodefony:orm:health`…), ne déclenche
564
+ > **rien** : le registre `#channelPolicies` reste vide, la condition est fausse, et les planchers
565
+ > système restent pourtant non appliqués. La détection couvre le risque métier, pas le risque
566
+ > plateforme.
567
+
568
+ ### Ce que le refus laisse voir
569
+
570
+ Le refus doit être observable sans devenir un oracle. Nodefony tranche ainsi :
571
+
572
+ | Type de frame refusée | Réponse au client |
573
+ | ----------------------------------- | -------------------------------------------------------------------------------- |
574
+ | Requête (avec `id`) | `-32001 "unauthorized"` — `JsonRpcPeer.receive()` (`JsonRpcPeer.ts:400`) |
575
+ | Notification (`subscribe`, inbound) | `realtime:denied { channel, reason: "forbidden" }` (`RealtimeController.ts:432`) |
576
+ | Dépassement du plafond de canaux | `realtime:denied { channel, reason: "limit" }` |
577
+ | Canal sans aucun producteur | `realtime:denied { channel, reason: "unknown" }` |
578
+
579
+ Le message est **générique** dans les trois cas : jamais « il te manque `ROLE_ADMIN` », jamais le nom
580
+ de la zone. Sans `realtime:denied`, une notification refusée serait droppée en silence (elle n'a pas
581
+ de canal de réponse) et le client se croirait abonné. **Aucun abonnement ne reste sans réponse** :
582
+ un canal que personne ne produit — nom mal orthographié, module non chargé — rend `unknown`, qui
583
+ n'ouvre aucun oracle (un canal gardé est tranché en amont, donc `forbidden` qu'il existe ou non).
584
+ Le motif `limit` est volontairement distinct de
585
+ `forbidden` : une borne de ressource n'est pas un secret, et les confondre enverrait un développeur
586
+ chercher un problème de droits.
587
+
588
+ Côté serveur, chaque refus alimente le journal d'audit via le rapporteur `onDeny`
589
+ (`FrameDenyReporter`, `frameAuthorizer.ts:57`), tiré **uniquement** sur refus — le chemin autorisé
590
+ n'alloue rien. L'entrée porte `category: "ws"`, `action: "frame.denied"`, l'acteur, la ressource et
591
+ une raison machine stable (`zone_protected` ou `channel_policy`).
592
+
593
+ ## ⏳ Verrou 4 — la révocation : une socket survit à sa session
594
+
595
+ Le problème est structurel : l'identité est figée au handshake, le verrou est sync, donc une frame
596
+ ne peut pas relire la session. Un administrateur qui se déconnecte garderait ses flux `nodefony:syslog` et
597
+ `nodefony:audit` tant que sa socket vit.
598
+
599
+ Nodefony ferme l'écart par deux mécanismes de granularité différente.
600
+
601
+ | Surface | Re-validation | Fenêtre d'exposition | Où |
602
+ | --------------------------- | -------------------- | -------------------- | --------------------------------------------------------------------- |
603
+ | `api.request` (data plane) | **à chaque frame** | nulle | `RealtimeController.invokeApiRequest()` (`RealtimeController.ts:818`) |
604
+ | `subscribe` / flux de canal | **périodique**, 30 s | ≤ 30 s | `RealtimeHub.revalidateRevocable()` (`RealtimeHub.ts:736`) |
605
+
606
+ **Sur `api.request`**, `token.isValid()` est appelé avant l'exécution de l'action ; identité périmée
607
+ ou changée → `-32000` avec `status: 401`, et le client bascule sur un `fetch` HTTP porteur du cookie
608
+ courant. Une erreur de re-validation vaut refus (fail-closed).
609
+
610
+ **Sur les canaux**, le hub n'inscrit au registre de révocation que les connexions dont le token porte
611
+ `isValid` (`RealtimeController.ts:550`) — anonymes et JWT n'y entrent jamais, coût nul.
612
+ `RealtimeHub.registerRevocable()` (`RealtimeHub.ts:704`) démarre un `setInterval` `unref` au premier
613
+ inscrit et l'arrête dès que le registre se vide : zéro timer au repos. Période :
614
+ `REVOCATION_REVALIDATE_MS` (`RealtimeHub.ts:111`), 30 s, alignée sur le heartbeat WS.
615
+
616
+ Ce que `realtimeRevocation.attack.test.ts` prouve exactement :
617
+
618
+ | Cas | Comportement prouvé |
619
+ | ------------------------------------------ | -------------------------------------------------------- |
620
+ | `isValid()` renvoie `false` | `close(4001, "session revoked")` |
621
+ | `isValid()` renvoie `true` | socket **intacte** (contrôle positif, pas de faux refus) |
622
+ | `isValid()` **throw** (store indisponible) | socket fermée — fail-closed, parité avec `api.request` |
623
+ | déjà révoqué | retiré du registre avant le close → aucun re-close |
624
+ | déconnexion propre | `unregisterRevocable` → plus jamais re-validé |
625
+ | registre vide | tick no-op, aucun crash |
626
+
627
+ La source de vérité côté security est `buildSessionRevalidator()`
628
+ (`FirewallRealtimeAuthenticator.ts:227`) : il relit la session BFF **par son id capturé au handshake**
629
+ et vérifie qu'elle est toujours vivante **et toujours celle du même utilisateur** — ce second point
630
+ attrape le changement de compte sur un navigateur partagé.
631
+
632
+ > [!CAUTION]
633
+ > **Trois limites à connaître.**
634
+ >
635
+ > 1. **Fenêtre de 30 s.** Entre le logout et le tick suivant, les flux continuent. Pour une coupure
636
+ > immédiate, fermer la socket explicitement côté serveur.
637
+ > 2. **Best-effort si la session est illisible au handshake.** Si l'id ou le store ne sont pas
638
+ > accessibles, `buildSessionRevalidator()` renvoie `null` ; `UserRealtimeToken.isValid()`
639
+ > (`UserRealtimeToken.ts:78`) répond alors toujours `true`. La connexion **est** inscrite au
640
+ > registre (le token expose bien `isValid`) mais ne sera **jamais** révoquée. Choix assumé pour
641
+ > éviter les faux refus — à connaître, car cela ne se voit pas.
642
+ > 3. **Les identités sans `isValid` ne sont pas révocables du tout** : anonyme, JWT, clé API. Pour
643
+ > un JWT, la révocation reste portée par son `exp` et par la reconnexion.
644
+
645
+ ## 🚧 Plafonds anti-abus — borner une connexion
646
+
647
+ Une connexion ouverte est une ressource. Trois bornes existent ; il faut aussi savoir ce qui **n'est
648
+ pas** borné.
649
+
650
+ ### Canaux par connexion
651
+
652
+ Chaque canal ouvert coûte un provider, un ticker et une entrée de Map. Sans borne, une connexion
653
+ peut abonner jusqu'à l'OOM — un déni de service mémoire déclenché par **un seul** client.
654
+
655
+ `RealtimeController.startChannel()` (`RealtimeController.ts:706`) refuse au-delà de
656
+ `limits.maxChannelsPerConnection` (`realtime/nodefony/config/config.ts:142`), défaut **256**,
657
+ `null` pour illimité. Points prouvés par `realtimeChannelCap.attack.test.ts` :
658
+
659
+ - le plafond est actif **même sans `RealtimeService`** — le hub porte le défaut 256
660
+ (`RealtimeHub.ts:315`), il n'y a pas de fenêtre où la garde n'existerait pas ;
661
+ - au-delà, le hub **n'est jamais appelé** : le canal n'est pas ouvert, aucun provider ne démarre ;
662
+ - le refus est **observable** (`realtime:denied`, motif `limit`) ;
663
+ - un re-`subscribe` d'un canal déjà tenu **ne consomme pas de slot** (l'idempotence est vérifiée
664
+ avant le plafond) — un client qui redemande son canal n'est pas puni ;
665
+ - `null` rétablit le multiplexage illimité, opt-out explicite.
666
+
667
+ C'est une **garde**, pas une bride : sous le seuil, le multiplexage N-canaux reste entier. Le log de
668
+ refus est en `DEBUG` et non `WARNING` — un log par subscribe refusé sous flood serait lui-même un
669
+ amplificateur.
670
+
671
+ ### Back-pressure — le client qui ne lit pas
672
+
673
+ Un onglet en arrière-plan, un mobile en zone blanche, une fenêtre TCP pleine : la file d'envoi
674
+ grossit sans borne, et le multiplexage concentre le risque (une socket lente bloque tous ses
675
+ canaux). `WsConnectionTransport.send()` (`WsConnectionTransport.ts:76`) applique deux seuils :
676
+
677
+ | `bufferedAmount` | Action |
678
+ | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
679
+ | > `websocket.maxBackpressure` — 4 MiB par défaut (`http`, `http/nodefony/config/config.ts:625`) | politique `websocket.backpressurePolicy` : `drop` (défaut) jette la frame — canaux d'état, le prochain snapshot la remplace |
680
+ | `websocket.backpressureCloseAfterDrops` drops CONSÉCUTIFS — 1000 par défaut | `close(1013)` « Try Again Later » ; le client se reconnecte et resynchronise |
681
+
682
+ ### Taille des messages entrants
683
+
684
+ Portée par `@nodefony/http` : `websocket.maxPayload` (`http/nodefony/config/config.ts:516`), défaut
685
+ **1 MiB**, au-delà fermeture RFC 6455 `1009` « Message Too Big ». C'est un durcissement par rapport
686
+ au défaut de la librairie `ws`.
687
+
688
+ ### Ce qui n'est PAS borné
689
+
690
+ <!-- prettier-ignore -->
691
+ | Absent | Conséquence |
692
+ | --- | --- |
693
+ | Limite de **fréquence** des frames entrantes | Un client authentifié peut inonder le peer ; seul le coût CPU le freine |
694
+ | Limite de **connexions par IP ou par utilisateur** | Rien n'empêche N sockets par client au niveau du module |
695
+ | Plafond **global** de canaux du process | Le plafond est par connexion ; M connexions × 256 canaux reste possible |
696
+ | Seuils de back-pressure **configurables** | `slowConsumer.bytes` ne pilote que le **comptage** de la sonde, pas les seuils de drop/close (`WsConnectionTransport` est construit sans override, `RealtimeController.ts:373`) |
697
+
698
+ ## ⚙️ Configuration de sécurité
699
+
700
+ Seules les clés à **effet de sécurité** figurent ici ; le catalogue complet est dans
701
+ [`configuration.md`](./configuration.md).
702
+ Source unique des défauts : `realtimeConfigSchema` (`realtime/nodefony/config/config.ts:259`).
703
+
704
+ | Clé | Défaut | Effet de sécurité |
705
+ | ------------------------------------- | -------- | ----------------------------------------------------------------------------------------- |
706
+ | `csrf.checkOrigin.enabled` | `false` | Active l'allowlist d'origines à l'upgrade |
707
+ | `csrf.checkOrigin.allowList` | `[]` | Origines acceptées, **match exact**. Vide + activé = tout refusé |
708
+ | `csrf.checkOrigin.allowMissingOrigin` | `false` | Accepter une upgrade sans `Origin` (clients non-navigateur) |
709
+ | `limits.maxChannelsPerConnection` | `256` | Plafond de canaux par connexion ; `null` = illimité |
710
+ | `slowConsumer.bytes` | `1 MiB` | Seuil de **comptage** des consommateurs lents dans la sonde |
711
+ | `backplane.namespace` | dérivé | Cloison du pub/sub cross-pod |
712
+ | `backplane.secret` | _absent_ | Scelle les messages du transport partagé (HMAC) ; absent = bus ouvert + `WARNING` au boot |
713
+ | `enabled` | `true` | `false` = module inerte : aucun câblage hub depuis la config |
714
+ | `areas.<nom>.realtime` _(security)_ | `true` | La zone couvre aussi les frames WS. `false` = opt-out explicite |
715
+ | `realtimeChannels` _(security)_ | `[]` | Règles de canal par préfixe, **placées avant** les défauts système |
716
+
717
+ > [!TIP]
718
+ > **`backplane.namespace` est une clé de sécurité, pas de confort.** Le numéro de base Redis ne
719
+ > cloisonne pas le pub/sub : deux déploiements de la même app sur un Redis mutualisé, sans
720
+ > namespace, échangent leurs fan-outs. Le poser dès que staging et production partagent un Redis.
721
+
722
+ ## 🚫 Ce que ce module ne défend pas
723
+
724
+ Cette section existe pour éviter une confiance mal placée. Chaque point est vérifié au code.
725
+
726
+ **1. Il n'y a pas de frontière de canal entre modules.** Un nom de canal est une chaîne dans un
727
+ registre global (`#channelPolicies` du hub singleton, `RealtimeHub.ts:295`). Rien n'empêche le
728
+ controller du module A de servir un canal au nom d'un canal du module B, ni de déclarer une policy
729
+ plus faible sur ce même nom — la déclaration la plus récente écrase (`RealtimeHub.ts:751`, idempotent
730
+ par écrasement). En pratique, l'exploitation exige que le controller fautif accepte le nom (sa
731
+ factory doit renvoyer un provider), donc un override permissif de `createRealtimeChannel` ; et les
732
+ namespaces réservés restent couverts par le plancher système **si** le verrou est posé. Une garde
733
+ d'appartenance par module est un manque connu et assumé, pas une protection existante.
734
+
735
+ **2. Le backplane n'authentifie l'émetteur que si tu poses un secret.** Ce qui ENTRE par le bus est filtré par
736
+ canal — seul un canal déclaré broadcast est réinjecté (`RealtimeHub.#admitFromBackplane`), donc
737
+ `syslog:`, `nodefony:audit` et les canaux d'observabilité restent hors d'atteinte depuis le
738
+ transport. Mais l'**identité de l'émetteur** n'est vérifiée que lorsque `backplane.secret` est posé :
739
+ les messages sont alors scellés (HMAC-SHA256, `envelope.ts`) et un message non scellé ou altéré est
740
+ ignoré. Sans secret, quiconque écrit dans le Redis publie sur les canaux **broadcast** de tous les
741
+ pods — le boot l'annonce en `WARNING`. Le rejeu d'un message scellé intact reste possible : la
742
+ sémantique du transport est _at-most-once_, sans anti-rejeu.
743
+
744
+ **3. L'autorisation d'un canal n'est vérifiée qu'au `subscribe`.** Une fois abonné, le fan-out ne
745
+ re-consulte pas la policy : un changement de rôle en cours de connexion ne coupe pas le flux. Seule
746
+ la révocation de session (verrou 4, fenêtre 30 s) ferme la socket.
747
+
748
+ **4. Le contenu publié n'est pas filtré par abonné.** Le hub diffuse la charge telle quelle à tous
749
+ les abonnés du canal ; masquer partiellement un flux impose au provider de publier sur des canaux
750
+ distincts.
751
+
752
+ **5. Pas de limitation de débit ni de quota de connexions**, et **pas de chiffrement propre** : la
753
+ confidentialité et l'intégrité sont déléguées à TLS — `wss://` n'est pas optionnel en production.
754
+
755
+ **6. `enabled: false` désarme aussi les gardes du module.** Le service devient inerte
756
+ (`RealtimeService.init()`, `RealtimeService.ts:77`) : ni garde d'origine, ni plafond de canaux posés
757
+ depuis la config. Le hub conserve son défaut de 256 canaux, mais l'allowlist d'origines configurée
758
+ n'est pas appliquée.
759
+
760
+ ## 📜 Normes appliquées
761
+
762
+ | Norme | Application |
763
+ | ------------------------------------- | -------------------------------------------------------------------------------------------- |
764
+ | **RFC 6455 §10.2** (Origin) | Contrôle d'origine à l'upgrade, aux deux étages |
765
+ | **RFC 6455 §7.4.2** (codes 4000-4999) | `4001` unauthorized / session revoked, `4003` origin not allowed |
766
+ | **RFC 6455 §7.4.1 / registre IANA** | `1008` Policy Violation (origine transport), `1009` Message Too Big, `1013` Try Again Later |
767
+ | **RFC 6455 §4.1** | `Sec-WebSocket-Protocol` normalisé en liste dans le DTO de handshake |
768
+ | **RFC 7230 §5.4** | Comparaison du `Host` par le matcher d'authenticator |
769
+ | **JSON-RPC 2.0 §5.1** | `-32001` (plage `Server error`) pour une requête refusée, `-32602` pour des params invalides |
770
+ | **OWASP WSTG-CLNT-10** | Anti-CSWSH : validation d'`Origin` obligatoire, les navigateurs n'appliquent pas CORS aux WS |
771
+ | **Zero Trust / OWASP A01** | Zone protégée + anonyme = refus ; token toujours présent, jamais `null` |
772
+
773
+ ## 📡 Observabilité — Studio
774
+
775
+ - **Santé de la socket** : `/nodefony/realtime/api/health`, alimenté par `RealtimeHub.probe()`
776
+ (`RealtimeHub.ts:775`) — canaux, abonnés, fan-out, connexions, back-pressure et carte d'identité
777
+ du backplane. Un `drops` qui grimpe signale des clients en souffrance ; un `slowConsumers` non nul
778
+ précède souvent une fermeture `1013`. Même snapshot en flux sur le canal `nodefony:socket`
779
+ (namespace réservé : `ROLE_ADMIN`).
780
+ - **Journal d'audit** : les refus de frame arrivent sur le canal `nodefony:audit`
781
+ (`ROLE_NODEFONY_ADMIN`) et dans le data plane d'audit de `@nodefony/security`.
782
+ - **Page module** : `/nodefony/modules/realtime` — la config effective (dont `csrf.checkOrigin` et
783
+ `limits`) y est lisible telle qu'appliquée au boot.
784
+
785
+ ## ⚠️ Pièges
786
+
787
+ | Symptôme | Cause | Correction |
788
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
789
+ | Le canal `ROLE_ADMIN` est servi à tout le monde, sans erreur | Aucune zone `security: true` + `realtime: true` → verrou de frame jamais posé | Déclarer une zone protégée couvrant la route WS ; chercher le WARNING « policies … NOT enforced » |
790
+ | `nodefony:syslog` accessible en anonyme, **et aucun WARNING** | L'alerte ne couvre que les policies **déclarées** ; un plancher système non appliqué reste muet | Vérifier que le verrou est posé (log « Realtime data plane locked ») — ne pas se fier au silence |
791
+ | L'allowlist d'origines est configurée mais tout passe | `csrf.checkOrigin.enabled` reste `false` (défaut) | Poser `enabled: true` ; vérifier `allowList` non vide, sinon **tout** est refusé |
792
+ | Le client mobile natif ne se connecte plus après activation de l'origine | `allowMissingOrigin: false` refuse les clients sans `Origin` | Passer à `true` **uniquement** si un credential fort est vérifié (JWT signé, clé API) |
793
+ | Un matcher d'authenticator ne se déclenche jamais | Le matcher est comparé au **path**, pas à l'URL absolue ; un `pattern` chaîne est un préfixe **ancré** | Écrire `"/rt/"` et non `"rt"` ni `"wss://host/rt"` |
794
+ | Deux zones, un seul authenticator enregistré | Le hub dédoublonne par identité d'instance — une instance partagée n'enregistre que le premier matcher | Une **instance** d'authenticator par zone |
795
+ | Un admin déconnecté garde ses flux pendant une dizaine de secondes | Le tick de révocation est périodique (30 s), pas immédiat | Comportement attendu ; pour une coupure immédiate, fermer la socket côté serveur |
796
+ | Une session révoquée ne ferme **jamais** la socket | La session n'était pas lisible au handshake → revalidateur `null`, `isValid()` répond toujours `true` | Vérifier que le handshake traverse bien la zone (session chargée avant le controller realtime) |
797
+ | Le client se croit abonné, ne reçoit rien | Refus d'autorisation, plafond atteint, **ou nom de canal sans producteur** (pas de réponse RPC) | Écouter `realtime:denied` : `forbidden` (droits), `limit` (borne), `unknown` (le nom ne désigne rien) |
798
+ | `slowConsumer.bytes` augmenté, les frames sont toujours jetées à 1 MiB | Cette clé pilote le **comptage** de la sonde, pas les seuils de drop/close du transport | Les seuils de back-pressure ne sont pas configurables aujourd'hui |
799
+ | Deux déploiements se parlent en cross-talk | Pas de `backplane.namespace` sur un Redis mutualisé (la base Redis ne cloisonne pas le pub/sub) | Poser un `namespace` explicite par déploiement |
800
+ | Le fan-out cross-pod s'arrête après avoir posé un secret | `backplane.secret` différent d'un pod à l'autre : les messages sont scellés, aucun ne se vérifie | Le **même** secret sur tous les pods (`NF_REALTIME_BACKPLANE_SECRET`) ; suivre `ingressRejectedTotal` |
801
+ | Un canal broadcast ne reçoit rien des autres pods | Le préfixe n'est pas déclaré côté receveur → l'entrée refuse le canal (compté) | Déclarer le préfixe (`broadcast` du controller) sur **tous** les pods, pas seulement l'émetteur |
802
+
803
+ ## 🧪 Tests & couverture
804
+
805
+ L'inventaire chiffré (cas comptés, fichiers, répartition unitaires / attaque / intégration / E2E)
806
+ est rendu par la carte de tests de la page, régénérée depuis le dépôt — aucun chiffre n'est figé
807
+ dans ce texte.
808
+
809
+ **Tests d'attaque** — ce sont eux qui font foi sur cette page :
810
+
811
+ | Fichier | Ce qu'il prouve |
812
+ | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
813
+ | `realtimeUnenforcedPolicy.attack.test.ts` | Une policy déclarée sans `frameAuthorizer` est détectée comme inerte (fail-loud). Ne prouve **pas** que le canal est fermé. |
814
+ | `realtimeRevocation.attack.test.ts` | Fermeture `4001` d'une session révoquée, contrôle positif, fail-closed sur erreur, pas de re-close |
815
+ | `realtimeChannelCap.attack.test.ts` | Le plafond refuse sans appeler le hub, le refus est observable, l'idempotence ne consomme pas de slot |
816
+ | `backplaneInjection.attack.test.ts` | Un pair ne peut pas pousser sur un canal non broadcast (rejet compté) ; sur bus scellé, un message forgé, altéré ou repointé est ignoré |
817
+
818
+ **Unitaires** : `RealtimeHubSecurity.test.ts` couvre les quatre seams (garde d'origine, matchers et
819
+ ordre de capture, mapping `peer → token` avec repli anonyme, verrou de frame et son retrait), le
820
+ registre de policies et l'absence d'allocation quand aucun seam n'est utilisé.
821
+
822
+ **E2E** : `realtimeChannelAuth.e2e.test.ts` exerce la matrice identité × canal (anonyme / user /
823
+ admin / service × canal libre, authentifié, rôle, scope, système) avec le **vrai** client isomorphe,
824
+ le **vrai** controller et le **vrai** verrou de `@nodefony/security` reliés par un câble loopback —
825
+ on observe le tick reçu ou le `realtime:denied`, jamais un booléen interne.
826
+ `realtimeFirewallWiring.e2e.test.ts` couvre la jonction firewall → hub.
827
+
828
+ **Ce qui manque** : pas de banc de charge dédié à la sécurité (surcoût du verrou sous flood), et
829
+ aucun test ne couvre le **rejeu** d'un message scellé — cohérent avec le fait que ce vecteur n'est
830
+ pas défendu (sémantique _at-most-once_).
831
+
832
+ Outils : `nodefony-security-review`, `nodefony-load-test`, `nodefony-check-memory-health`.
833
+ Couverture chiffrée : `npm run coverage` dans le module.
834
+
835
+ ## 🔗 Pour aller plus loin
836
+
837
+ - ⬆️ **Retour au hub** : [Realtime — vue d'ensemble](index.md) · [Toute la documentation](../../../../../docs/index.md)
838
+ - [`architecture.md`](./architecture.md) — la pile, le hub, le fan-out, le trajet d'une frame
839
+ - [`configuration.md`](./configuration.md) — toutes les clés de `defineRealtimeConfig`
840
+ - [`vocabulaire.md`](./vocabulaire.md) — socket, hub, peer, backplane, canal
841
+ - [`cookbook-chat.md`](./cookbook-chat.md) — un canal broadcast de bout en bout
842
+ - [Sécurité — vue d'ensemble](../../security/docs/index.md) — le firewall, les zones, les
843
+ authenticators, l'autorisation et l'audit
844
+ - [Firewall — le pare-feu applicatif](../../security/docs/firewall.md) — zones, Zero Trust,
845
+ hiérarchie de rôles : la source de toutes les décisions appliquées ici