mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-12 01:45:14 +02:00
omnigraph load is now the single data-write command: - works against remote graphs (POSTs the server's /ingest endpoint with the same bearer/actor resolution as other remote commands) — previously load was the only data command forced to open Lance storage directly - --from <base> opts into fork-if-missing for --branch (the former ingest semantics); without --from a missing branch is an error, never a fork - --mode is now required: overwrite is destructive, so there is no implicit default (the old silent default was overwrite) - output gains base_branch/branch_created (and table sums on remote loads) omnigraph ingest stays as a deprecated alias (defaults preserved: --from main --mode merge) that prints a one-line warning to stderr, matching the read/change deprecation convention; removal in a later release. Docs updated in the same change: cli.md, cli-reference.md, policy.md, audit.md, execution.md (unified load section), AGENTS.md quick-flow, README.md. BREAKING CHANGE: scripts running omnigraph load without --mode must now pass it explicitly (previously defaulted to the destructive overwrite). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
175 lines
10 KiB
Markdown
175 lines
10 KiB
Markdown
# Authorization (Cedar policy)
|
|
|
|
OmniGraph integrates AWS Cedar (`cedar-policy = 4.9`) for ABAC.
|
|
|
|
## Policy actions
|
|
|
|
Per-graph actions (bind to `Omnigraph::Graph::"<graph_id>"`):
|
|
|
|
1. `read` — query / snapshot / list branches & commits
|
|
2. `export` — NDJSON export
|
|
3. `change` — mutations
|
|
4. `schema_apply` — apply schema migrations
|
|
5. `branch_create`
|
|
6. `branch_delete`
|
|
7. `branch_merge`
|
|
8. `admin` — reserved for policy-management surfaces (hot reload, audit log, approvals). No call site today; see MR-724 for the reservation rationale.
|
|
9. `invoke_query` — gates invoking a server-side stored query (the `queries:` registry). Graph-scoped (like `admin`) — per-branch access is enforced by the inner `read` / `change` gate, so a rule that sets `branch_scope` on `invoke_query` is rejected. Coarse in this release: an `invoke_query` allow rule permits any stored query on the graph; a future, additive refinement adds an optional per-query-name scope without changing rules written against the coarse action. Enforced at `POST /queries/{name}` (see [server](server.md)). A stored *mutation* is double-gated: `invoke_query` to reach the tool, plus `change` for the write itself (the engine `_as` writers still enforce per the query body).
|
|
|
|
Server-scoped action (v0.6.0+; binds to `Omnigraph::Server::"root"`):
|
|
|
|
10. `graph_list` — `GET /graphs` registry enumeration (multi-graph mode)
|
|
|
|
Server-scoped actions cannot use `branch_scope` or `target_branch_scope` — they operate on the registry, not on a graph's branches. A rule cannot mix server-scoped and per-graph actions; split into separate rules. (Runtime `graph_create` / `graph_delete` are reserved but not shipped in v0.6.0; operators add/remove graphs by editing `omnigraph.yaml` and restarting.)
|
|
|
|
## Scope kinds
|
|
|
|
- `branch_scope` — applied to source branch (`read`, `export`, `change`)
|
|
- `target_branch_scope` — applied to destination (`schema_apply`, branch ops, run ops)
|
|
- `protected_branches` — named list with special rules; rule scopes are `any | protected | unprotected`
|
|
|
|
## Per-graph vs. server-level policy (multi-graph mode)
|
|
|
|
In multi mode (`omnigraph.yaml` with a non-empty `graphs:` map), policy files attach at two levels:
|
|
|
|
```yaml
|
|
server:
|
|
policy:
|
|
file: server-policy.yaml # server-level: graph_list
|
|
|
|
graphs:
|
|
alpha:
|
|
uri: s3://tenant-bucket/alpha
|
|
policy:
|
|
file: policies/alpha.yaml # per-graph: read, change, branch_*, schema_apply
|
|
beta:
|
|
uri: s3://tenant-bucket/beta
|
|
# no per-graph policy → no engine-layer Cedar enforcement on beta
|
|
```
|
|
|
|
**Config follows graph identity, not server mode.** A graph served by **name**
|
|
(`--target <name>` or `server.graph`) uses its own `graphs.<name>.policy.file`,
|
|
exactly as in multi-graph mode. Top-level `policy.file` applies only to an
|
|
**anonymous** graph — one served by a bare `<URI>` with no `graphs:` entry.
|
|
Serving a **named** graph (single- or multi-graph mode) while top-level
|
|
`policy.file` (or `queries:`) is populated **refuses boot**, naming the block,
|
|
since the top-level value would otherwise be silently shadowed by the per-graph
|
|
block. Move per-graph rules to `graphs.<graph_id>.policy.file` and `graph_list`
|
|
rules to `server.policy.file`.
|
|
|
|
Each graph's HTTP request flows through its own per-graph policy. The management endpoint (`GET /graphs`) flows through the server-level policy. When `server.policy.file` is unset, `GET /graphs` is denied in every runtime state, including `--unauthenticated`; with bearer tokens configured, it returns 403 after admission control because `graph_list` is not a `read`-equivalent action. The operator must explicitly authorize via `server-policy.yaml` to expose `/graphs`.
|
|
|
|
Example server-level policy:
|
|
|
|
```yaml
|
|
version: 1
|
|
groups:
|
|
admins: [act-andrew]
|
|
rules:
|
|
- id: admins-can-list-graphs
|
|
allow:
|
|
actors: { group: admins }
|
|
actions: [graph_list]
|
|
```
|
|
|
|
## Configuration
|
|
|
|
`omnigraph.yaml`:
|
|
|
|
```yaml
|
|
policy:
|
|
file: policy.yaml # Cedar rules + groups
|
|
tests: policy.tests.yaml # declarative test cases
|
|
|
|
cli:
|
|
actor: act-andrew # default actor for CLI direct-engine writes
|
|
```
|
|
|
|
Each per-graph rule may use at most one of `branch_scope` or `target_branch_scope`. Server-scoped rules (`graph_list`) take neither — they have no branch context.
|
|
|
|
`cli.actor` is the default actor identity for CLI direct-engine writes
|
|
when `policy.file` is configured. Override per-invocation with `--as
|
|
<ACTOR>` (top-level flag) — `--as` wins, otherwise `cli.actor` is used,
|
|
otherwise no actor. With policy configured and neither set, the
|
|
engine-layer footgun guard intentionally denies the write (silent bypass
|
|
via "I forgot the actor" is exactly what the guard prevents). Remote
|
|
HTTP writes ignore both — they resolve their actor server-side from the
|
|
bearer token.
|
|
|
|
## CLI
|
|
|
|
Policy tooling resolves its graph like server single-mode policy: `cli.graph`
|
|
wins, otherwise `server.graph` is used, otherwise the top-level `policy.file`
|
|
is validated/tested/explained as the anonymous policy.
|
|
|
|
- `omnigraph policy validate` — parse + count actors, exit 1 on parse error.
|
|
- `omnigraph policy test` — run cases in `policy.tests.yaml`, exit 1 on any expectation mismatch.
|
|
- `omnigraph policy explain --actor … --action … [--branch …] [--target-branch …]` — show decision and matched rule.
|
|
- `omnigraph --as <ACTOR> <subcommand>` — set the actor for the duration of one invocation. Effective for `change`, `load` (and its deprecated `ingest` alias), `branch create|delete|merge`, and `schema apply` against local URIs. No-op against remote HTTP URIs (actor is bearer-token-resolved server-side).
|
|
|
|
## Enforcement
|
|
|
|
Policy is a property of the **engine**, not the transport. Every mutating
|
|
write — `mutate_as`, `load_as` (the deprecated `ingest_as` shims route
|
|
through it), `apply_schema_as`,
|
|
`branch_create_as`, `branch_create_from_as`, `branch_delete_as`,
|
|
`branch_merge_as` — calls `Omnigraph::enforce(action, scope, actor)` at
|
|
the head of the method. The gate fires identically whether the call
|
|
originates from the HTTP server, the CLI, or an embedded SDK consumer.
|
|
When no `PolicyChecker` is installed (the dev/embedded default) the gate
|
|
is a strict no-op; when one is installed and the call site forgets to
|
|
thread an actor through, the gate fails closed rather than silently
|
|
bypassing.
|
|
|
|
## Server runtime states (MR-723)
|
|
|
|
The HTTP server classifies its startup configuration into one of three
|
|
states based on whether bearer tokens are configured and whether a
|
|
policy file is set. The state determines what happens to a request that
|
|
reaches `authorize_request()` without a matching policy permit.
|
|
|
|
| State | Tokens | Policy file | Behavior |
|
|
|---|---|---|---|
|
|
| **Open** | no | no | Every request is permitted. Refuses to start unless `--unauthenticated` or `OMNIGRAPH_UNAUTHENTICATED=1` is set — the operator must explicitly opt in. |
|
|
| **DefaultDeny** | yes | no | Every authenticated request for an action other than `read` is rejected with HTTP 403. Closes the "tokens but forgot the policy file" trap — an operator who sets up auth and forgot to point at a policy file used to ship the illusion of protection. |
|
|
| **PolicyEnabled** | yes | yes | Authenticated requests that reach a configured policy engine are evaluated by Cedar. Server-scoped actions still require `server.policy.file`. |
|
|
|
|
The classifier is `classify_server_runtime_state` in
|
|
`crates/omnigraph-server/src/lib.rs`; it returns `Err` for the "no
|
|
tokens, no policy, no flag" cell and for "policy file, no tokens" so the
|
|
server refuses to start instead of silently shipping an open instance or
|
|
a policy-protected server that can only 401. Tests pin every cell of the
|
|
matrix and the State-2 deny path.
|
|
|
|
Server-side, `authorize_request()` still runs at the HTTP boundary —
|
|
that's where actor identity is resolved from the bearer token and where
|
|
admission control / per-actor rate limits live. Engine-layer enforcement
|
|
is the **defense in depth** layer: it catches CLI direct-engine writes,
|
|
embedded SDK consumers, and any future transport that hasn't (or won't)
|
|
re-implement HTTP's authorize_request. Both layers consult the same
|
|
Cedar policy via the same `PolicyChecker` trait, so decisions cannot
|
|
disagree.
|
|
|
|
## Coarse vs. fine enforcement
|
|
|
|
There are two enforcement points, each with non-overlapping
|
|
responsibilities:
|
|
|
|
| Layer | Question it answers | Where it fires |
|
|
|---|---|---|
|
|
| **Engine-layer (coarse)** | Can this actor invoke this action against this branch / branch-transition? | `Omnigraph::enforce(action, scope, actor)` at the head of every `_as` writer; one Cedar decision per call. |
|
|
| **Query-layer (fine)** | For the rows / types this action actually touches, which can the actor see or modify? | Per-row predicates pushed into DataFusion at plan time. **Not yet implemented — see MR-725.** |
|
|
|
|
The engine-layer gate keeps `ResourceScope` deliberately at branch
|
|
granularity (`Graph`, `Branch`, `TargetBranch`, `BranchTransition`).
|
|
Per-type and per-row authority is the query-layer's job; conflating them
|
|
in `ResourceScope` would create two places per-type policy could be
|
|
evaluated and a drift surface between them.
|
|
|
|
## Actor identity (signed-claim-only)
|
|
|
|
The actor identity used for every policy decision comes from the matched bearer token — never from a client-supplied request header, query parameter, or body field. The server resolves the token at the auth middleware boundary, looks up the actor it was minted for, and overwrites whatever the handler may have placed in the policy request. Clients cannot set `actor_id` directly.
|
|
|
|
This is intentional. Trusting client-supplied identity for authorization is "asking the attacker if they're an admin" — Supabase's RLS history names the same footgun. The chokepoint lives in `authorize_request` in `crates/omnigraph-server/src/lib.rs` and is named in `docs/dev/invariants.md` Hard Invariant 11. A regression test asserts the contract: a request with `Authorization: Bearer <token-for-actor-A>` plus `X-Actor-Id: actor-B` always evaluates as actor A, never as actor B.
|
|
|
|
If you find yourself wanting to let clients override `actor_id` for impersonation, delegation, or service-account flows — that's a feature, but it needs explicit design (e.g., signed delegation claims, an `On-Behalf-Of` audit trail). It is not a convenience knob.
|