docs(archreview): P2 doc-drift sweep (IPC-06/07/17/21, SEC-09/22, CLI-12/16, TST-13)
Reconcile load-bearing docs with shipped behavior: - IPC-06: gateway.md Worker Envelope sketch -> points to mxaccess_worker.proto as source of truth (string correlation_id, real oneof arms incl. worker_shutdown_ack/worker_ready). - IPC-07: docs/Grpc.md six RPCs -> seven; document QueryActiveAlarms handler + validation row. - IPC-21: gateway.md Session RPC moved from live API into a 'Future work: not implemented' subsection. - TST-13: drop stale design-era sketches from gateway.md; correct the single-subscriber-default (config-gated fan-out) note. - SEC-09: dashboard GroupToRole sample GwAdmin:Admin -> Administrator so it passes GatewayOptionsValidator; clarify Administrator is the canonical role. - SEC-22: rewrite docs/Authentication.md to the pipeline that actually ships (ZB.MOM.WW.Auth.ApiKeys package + gateway-owned CachingApiKeyVerifier, CoalescingMarkApiKeyStore, CanonicalForwardingApiKeyAuditStore, etc.); remove 18 stale type names (grep-verified absent). - IPC-17: correct wrong Python generated dir (mxgateway -> zb_mom_ww_mxgateway) in CLAUDE.md + 3 docs. - CLI-12: Java docs Java 21 -> Java 17 (JDK17 retarget for Ignition 8.3). - CLI-16: docs/ClientPackaging.md reconciled with real .slnx, Python package name, and gradle project names; fix stale generateProto task name. Docs-only; type/path/version claims verified against source. Claude-Session: https://claude.ai/code/session_01DMXXvNuPekkkrTEyPNxEkW
This commit is contained in:
@@ -418,8 +418,12 @@ Do not show API key secrets or pepper values.
|
||||
|
||||
Dashboard authentication is LDAP-backed, distinct from the API-key model used
|
||||
on the gRPC API. Users sign in with directory credentials; the gateway maps
|
||||
their LDAP groups to one of two dashboard roles (`Admin` or `Viewer`) and
|
||||
issues a cookie carrying those role claims.
|
||||
their LDAP groups to one of two dashboard roles (`Administrator` or `Viewer`) and
|
||||
issues a cookie carrying those role claims. `Administrator` is the canonical
|
||||
role value — the exact string `GroupToRole` values and the validator accept
|
||||
(`DashboardRoles.Admin`); the shorthand "Admin" used elsewhere in this document
|
||||
names the same role and the `MxGateway.Dashboard.Admin` policy, not a distinct
|
||||
config value.
|
||||
|
||||
Implemented behavior:
|
||||
|
||||
@@ -541,7 +545,7 @@ Effective configuration:
|
||||
"RecentSessionLimit": 200,
|
||||
"ShowTagValues": false,
|
||||
"GroupToRole": {
|
||||
"GwAdmin": "Admin",
|
||||
"GwAdmin": "Administrator",
|
||||
"GwReader": "Viewer"
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user