mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-26 17:06:22 +02:00
Replaces the legacy GATEWAY_SECRET shared-token gate with an IAM-backed
identity and authorisation model. The gateway no longer has an
"allow-all" or "no auth" mode; every request is authenticated via the
IAM service, authorised against a capability model that encodes both
the operation and the workspace it targets, and rejected with a
deliberately-uninformative 401 / 403 on any failure.
IAM service (trustgraph-flow/trustgraph/iam, trustgraph-base/schema/iam)
-----------------------------------------------------------------------
* New backend service (iam-svc) owning users, workspaces, API keys,
passwords and JWT signing keys in Cassandra. Reached over the
standard pub/sub request/response pattern; gateway is the only
caller.
* Operations: bootstrap, resolve-api-key, login, get-signing-key-public,
rotate-signing-key, create/list/get/update/disable/delete/enable-user,
change-password, reset-password, create/list/get/update/disable-
workspace, create/list/revoke-api-key.
* Ed25519 JWT signing (alg=EdDSA). Key rotation writes a new kid and
retires the previous one; validation is grace-period friendly.
* Passwords: PBKDF2-HMAC-SHA-256, 600k iterations, per-user salt.
* API keys: 128-bit random, SHA-256 hashed. Plaintext returned once.
* Bootstrap is explicit: --bootstrap-mode {token,bootstrap} is a
required startup argument with no permissive default. Masked
"auth failure" errors hide whether a refused bootstrap request was
due to mode, state, or authorisation.
Gateway authentication (trustgraph-flow/trustgraph/gateway/auth.py)
-------------------------------------------------------------------
* IamAuth replaces the legacy Authenticator. Distinguishes JWTs
(three-segment dotted) from API keys by shape; verifies JWTs
locally using the cached IAM public key; resolves API keys via
IAM with a short-TTL hash-keyed cache. Every failure path
surfaces the same 401 body ("auth failure") so callers cannot
enumerate credential state.
* Public key is fetched at gateway startup with a bounded retry loop;
traffic does not begin flowing until auth has started.
Capability model (trustgraph-flow/trustgraph/gateway/capabilities.py)
---------------------------------------------------------------------
* Roles have two dimensions: a capability set and a workspace scope.
OSS ships reader / writer / admin; the first two are workspace-
assigned, admin is cross-workspace ("*"). No "cross-workspace"
pseudo-capability — workspace permission is a property of the role.
* check(identity, capability, target_workspace=None) is the single
authorisation test: some role must grant the capability *and* be
active in the target workspace.
* enforce_workspace validates a request-body workspace against the
caller's role scopes and injects the resolved value. Cross-
workspace admin is permitted by role scope, not by a bypass.
* Gateway endpoints declare a required capability explicitly — no
permissive default. Construction fails fast if omitted. Enterprise
editions can replace the role table without changing the wire
protocol.
WebSocket first-frame auth (dispatch/mux.py, endpoint/socket.py)
----------------------------------------------------------------
* /api/v1/socket handshake unconditionally accepts; authentication
runs on the first WebSocket frame ({"type":"auth","token":"..."})
with {"type":"auth-ok","workspace":"..."} / {"type":"auth-failed"}.
The socket stays open on failure so the client can re-authenticate
— browsers treat a handshake-time 401 as terminal, breaking
reconnection.
* Mux.receive rejects every non-auth frame before auth succeeds,
enforces the caller's workspace (envelope + inner payload) using
the role-scope resolver, and supports mid-session re-auth.
* Flow import/export streaming endpoints keep the legacy ?token=
handshake (URL-scoped short-lived transfers; no re-auth need).
Auth surface
------------
* POST /api/v1/auth/login — public, returns a JWT.
* POST /api/v1/auth/bootstrap — public; forwards to IAM's bootstrap
op which itself enforces mode + tables-empty.
* POST /api/v1/auth/change-password — any authenticated user.
* POST /api/v1/iam — admin-only generic forwarder for the rest of
the IAM API (per-op REST endpoints to follow in a later change).
Removed / breaking
------------------
* GATEWAY_SECRET / --api-token / default_api_token and the legacy
Authenticator.permitted contract. The gateway cannot run without
IAM.
* ?token= on /api/v1/socket.
* DispatcherManager and Mux both raise on auth=None — no silent
downgrade path.
CLI tools (trustgraph-cli)
--------------------------
tg-bootstrap-iam, tg-login, tg-create-user, tg-list-users,
tg-disable-user, tg-enable-user, tg-delete-user, tg-change-password,
tg-reset-password, tg-create-api-key, tg-list-api-keys,
tg-revoke-api-key, tg-create-workspace, tg-list-workspaces. Passwords
read via getpass; tokens / one-time secrets written to stdout with
operator context on stderr so shell composition works cleanly.
AsyncSocketClient / SocketClient updated to the first-frame auth
protocol.
Specifications
--------------
* docs/tech-specs/iam.md updated with the error policy, workspace
resolver extension point, and OSS role-scope model.
* docs/tech-specs/iam-protocol.md (new) — transport, dataclasses,
operation table, error taxonomy, bootstrap modes.
* docs/tech-specs/capabilities.md (new) — capability vocabulary, OSS
role bundles, agent-as-composition note, enforcement-boundary
policy, enterprise extensibility.
Tests
-----
* test_auth.py (rewritten) — IamAuth + JWT round-trip with real
Ed25519 keypairs + API-key cache behaviour.
* test_capabilities.py (new) — role table sanity, check across
role x workspace combinations, enforce_workspace paths,
unknown-cap / unknown-role fail-closed.
* Every endpoint test construction now names its capability
explicitly (no permissive defaults relied upon). New tests pin
the fail-closed invariants: DispatcherManager / Mux refuse
auth=None; i18n path-traversal defense is exercised.
* test_socket_graceful_shutdown rewritten against IamAuth.
201 lines
No EOL
6 KiB
Python
201 lines
No EOL
6 KiB
Python
"""
|
|
Tests for Gateway Dispatch Mux
|
|
"""
|
|
|
|
import pytest
|
|
import asyncio
|
|
from unittest.mock import MagicMock, AsyncMock
|
|
|
|
from trustgraph.gateway.dispatch.mux import Mux, MAX_QUEUE_SIZE
|
|
|
|
|
|
class TestMux:
|
|
"""Test cases for Mux class"""
|
|
|
|
def test_mux_requires_auth(self):
|
|
"""Constructing a Mux without an ``auth`` argument must
|
|
fail. The Mux implements the first-frame auth protocol and
|
|
there is no no-auth mode — a no-auth Mux would silently
|
|
accept every frame without authenticating it."""
|
|
with pytest.raises(ValueError, match="auth"):
|
|
Mux(
|
|
dispatcher_manager=MagicMock(),
|
|
ws=MagicMock(),
|
|
running=MagicMock(),
|
|
auth=None,
|
|
)
|
|
|
|
def test_mux_initialization(self):
|
|
"""Test Mux initialization"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = MagicMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
assert mux.dispatcher_manager == mock_dispatcher_manager
|
|
assert mux.ws == mock_ws
|
|
assert mux.running == mock_running
|
|
assert isinstance(mux.q, asyncio.Queue)
|
|
assert mux.q.maxsize == MAX_QUEUE_SIZE
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_destroy_with_websocket(self):
|
|
"""Test Mux destroy method with websocket"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = AsyncMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Call destroy
|
|
await mux.destroy()
|
|
|
|
# Verify running.stop was called
|
|
mock_running.stop.assert_called_once()
|
|
|
|
# Verify websocket close was called
|
|
mock_ws.close.assert_called_once()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_destroy_without_websocket(self):
|
|
"""Test Mux destroy method without websocket"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=None,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Call destroy
|
|
await mux.destroy()
|
|
|
|
# Verify running.stop was called
|
|
mock_running.stop.assert_called_once()
|
|
# No websocket to close
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_receive_valid_message(self):
|
|
"""Test Mux receive method with valid message"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = AsyncMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Mock message with valid JSON
|
|
mock_msg = MagicMock()
|
|
mock_msg.json.return_value = {
|
|
"request": {"type": "test"},
|
|
"id": "test-id-123",
|
|
"service": "test-service"
|
|
}
|
|
|
|
# Call receive
|
|
await mux.receive(mock_msg)
|
|
|
|
# Verify json was called
|
|
mock_msg.json.assert_called_once()
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_receive_message_without_request(self):
|
|
"""Test Mux receive method with message missing request field"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = AsyncMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Mock message without request field
|
|
mock_msg = MagicMock()
|
|
mock_msg.json.return_value = {
|
|
"id": "test-id-123"
|
|
}
|
|
|
|
# receive method should handle the RuntimeError internally
|
|
# Based on the code, it seems to catch exceptions
|
|
await mux.receive(mock_msg)
|
|
|
|
mock_ws.send_json.assert_called_once_with({
|
|
"error": {"message": "Bad message", "type": "error"},
|
|
"complete": True,
|
|
"id": "test-id-123",
|
|
})
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_receive_message_without_id(self):
|
|
"""Test Mux receive method with message missing id field"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = AsyncMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Mock message without id field
|
|
mock_msg = MagicMock()
|
|
mock_msg.json.return_value = {
|
|
"request": {"type": "test"}
|
|
}
|
|
|
|
# receive method should handle the RuntimeError internally
|
|
await mux.receive(mock_msg)
|
|
|
|
mock_ws.send_json.assert_called_once_with({
|
|
"error": {"message": "Bad message", "type": "error"},
|
|
"complete": True,
|
|
})
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_mux_receive_invalid_json(self):
|
|
"""Test Mux receive method with invalid JSON"""
|
|
mock_dispatcher_manager = MagicMock()
|
|
mock_ws = AsyncMock()
|
|
mock_running = MagicMock()
|
|
|
|
mux = Mux(
|
|
dispatcher_manager=mock_dispatcher_manager,
|
|
ws=mock_ws,
|
|
running=mock_running,
|
|
auth=MagicMock(),
|
|
)
|
|
|
|
# Mock message with invalid JSON
|
|
mock_msg = MagicMock()
|
|
mock_msg.json.side_effect = ValueError("Invalid JSON")
|
|
|
|
# receive method should handle the ValueError internally
|
|
await mux.receive(mock_msg)
|
|
|
|
mock_msg.json.assert_called_once()
|
|
mock_ws.send_json.assert_called_once_with({
|
|
"error": {"message": "Invalid JSON", "type": "error"},
|
|
"complete": True,
|
|
}) |