Joseph Doherty
0f2b2b8351
Phase 0 of the shared-GLAuth standardization. config.toml = merged dc=zb,dc=local directory (15 groups in partitioned 55xx/56xx/57xx families, 14 users incl. multi-role spanning all groups, serviceaccount search account). compose runs one glauth/glauth:latest on :3893. README is the deploy/verify runbook. Code-reviewed; fixed scp -r idempotency in the deploy command (README + plan Task 4).
89 lines
4.3 KiB
Markdown
89 lines
4.3 KiB
Markdown
# Shared dev GLAuth (`dc=zb,dc=local`)
|
|
|
|
One [GLAuth](https://github.com/glauth/glauth) directory that **all three sister apps use for
|
|
dev/test auth** — OtOpcUa, MxAccessGateway, ScadaBridge. It runs as a single container on the
|
|
shared Docker host **`10.100.0.35:3893`** (plaintext LDAP). This is the app-neutral source of
|
|
truth; each app just points its `…Ldap:Server` at `10.100.0.35`.
|
|
|
|
> Scope: **dev/test only**. Production uses real corporate AD. See
|
|
> [`../../docs/plans/2026-06-04-shared-glauth-standardization-design.md`](../../docs/plans/2026-06-04-shared-glauth-standardization-design.md).
|
|
|
|
## Directory layout
|
|
|
|
Group families are partitioned into **non-overlapping gid ranges** so the three apps coexist —
|
|
each app maps only its own family and ignores the rest.
|
|
|
|
| Family | Used by | Groups (gidnumber) |
|
|
|---|---|---|
|
|
| `SCADA-*` (55xx) | ScadaBridge roles (DB-mapped) | Admins 5501, Designers 5502, Deploy-All 5503, Deploy-SiteA 5504, Viewers 5505 |
|
|
| OPC-perm (560x) | OtOpcUa + MxGateway OPC-UA write model | ReadOnly 5601, WriteOperate 5602, WriteTune 5603, WriteConfigure 5604, AlarmAck 5605 |
|
|
| `Gw*` (561x) | MxGateway dashboard (config-mapped) | GwAdmin 5610, GwReader 5611 |
|
|
| `OtOpcUa-*` (57xx) | OtOpcUa AdminUI (DB-mapped) | Admins 5701, Designers 5702, Viewers 5703 |
|
|
|
|
**Users** (all password `password` except `serviceaccount` → `serviceaccount123`):
|
|
|
|
- **`serviceaccount`** (`cn=serviceaccount,dc=zb,dc=local`) — the single bind account every app
|
|
uses for search-then-bind. Has a `search *` capability.
|
|
- **`multi-role`** — member of **every** group → all roles in all three apps (canonical cross-app login).
|
|
- **`admin`** — `SCADA-Admins` + `GwAdmin` + `OtOpcUa-Admins` → Administrator everywhere.
|
|
- Per-role testers: `designer` / `deployer` / `site-deployer` (ScadaBridge); `gwreader`
|
|
(MxGateway Viewer); `otdesigner` / `otviewer` (OtOpcUa); `readonly` / `writeop` / `writetune`
|
|
/ `writeconfig` / `alarmack` (OPC perms).
|
|
|
|
## Deploy on `10.100.0.35`
|
|
|
|
> **Access note:** deploying needs working SSH/Docker access to `10.100.0.35`. If your key is not
|
|
> authorized there, hand this folder to whoever administers the box and have them run the same
|
|
> `docker compose up -d`. The artifact is self-contained.
|
|
|
|
```bash
|
|
# From this repo root. Copy the FILES into the dest (not the dir) so a re-deploy
|
|
# doesn't nest them at ~/zb-glauth/glauth/ (scp -r of a dir into an existing dir).
|
|
ssh dohertj2@10.100.0.35 'mkdir -p ~/zb-glauth'
|
|
scp infra/glauth/config.toml infra/glauth/docker-compose.yml dohertj2@10.100.0.35:~/zb-glauth/
|
|
ssh dohertj2@10.100.0.35 'cd ~/zb-glauth && docker compose up -d --force-recreate && docker ps --filter name=zb-shared-glauth'
|
|
```
|
|
|
|
## Verify
|
|
|
|
Bind as the service account and confirm `multi-role` spans all four families:
|
|
|
|
```bash
|
|
ldapsearch -x -H ldap://10.100.0.35:3893 \
|
|
-D cn=serviceaccount,dc=zb,dc=local -w serviceaccount123 \
|
|
-b dc=zb,dc=local "(cn=multi-role)" memberOf
|
|
# → result: 0 Success. memberOf comes back as group DNs (e.g. ou=SCADA-Admins,ou=groups,dc=zb,dc=local)
|
|
# spanning all four families: SCADA-*, ReadOnly/Write*/AlarmAck, GwAdmin/GwReader, OtOpcUa-*.
|
|
# (The shared ZB.MOM.WW.Auth.Ldap lib strips each to its bare RDN, e.g. "SCADA-Admins", at login.)
|
|
```
|
|
|
|
Confirm a user authenticates with `password` (a bad password returns `result: 49`; this user lacks
|
|
the search capability, so a successful bind shows `result: 50 Insufficient access` on the search):
|
|
|
|
```bash
|
|
ldapsearch -x -H ldap://10.100.0.35:3893 \
|
|
-D cn=multi-role,dc=zb,dc=local -w password \
|
|
-b dc=zb,dc=local "(cn=multi-role)" cn
|
|
```
|
|
|
|
No `ldapsearch` locally? Run it from a throwaway container:
|
|
|
|
```bash
|
|
docker run --rm alpine:3.20 sh -c 'apk add -q openldap-clients >/dev/null 2>&1 && \
|
|
ldapsearch -x -H ldap://10.100.0.35:3893 -D cn=serviceaccount,dc=zb,dc=local -w serviceaccount123 \
|
|
-b dc=zb,dc=local "(cn=multi-role)" memberOf'
|
|
```
|
|
|
|
## Editing the directory
|
|
|
|
GLAuth uses the `config` datastore (this `config.toml`, mounted read-only). To add/change a user
|
|
or group, edit `config.toml` and **recreate** the container — a plain `restart` keeps the stale
|
|
file (single-file Docker bind-mount inode trap):
|
|
|
|
```bash
|
|
docker compose up -d --force-recreate
|
|
```
|
|
|
|
Group `gidnumber`s and user `uidnumber`s must stay **unique** across the whole file; keep new
|
|
groups inside the per-app range (55xx / 56xx / 57xx) so the families don't collide.
|