mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 00:16:23 +02:00
67b2fc448f
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.
124 lines
No EOL
6.1 KiB
TOML
124 lines
No EOL
6.1 KiB
TOML
[build-system]
|
|
requires = ["setuptools>=61.0", "wheel"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
[project]
|
|
name = "trustgraph-cli"
|
|
dynamic = ["version"]
|
|
authors = [{name = "trustgraph.ai", email = "security@trustgraph.ai"}]
|
|
description = "TrustGraph provides a means to run a pipeline of flexible AI processing components in a flexible means to achieve a processing pipeline."
|
|
readme = "README.md"
|
|
requires-python = ">=3.8"
|
|
dependencies = [
|
|
"trustgraph-base>=2.4,<2.5",
|
|
"requests",
|
|
"pulsar-client",
|
|
"aiohttp",
|
|
"rdflib",
|
|
"tabulate",
|
|
"msgpack",
|
|
"websockets",
|
|
]
|
|
classifiers = [
|
|
"Programming Language :: Python :: 3",
|
|
"Operating System :: OS Independent",
|
|
]
|
|
|
|
[project.urls]
|
|
Homepage = "https://github.com/trustgraph-ai/trustgraph"
|
|
|
|
[project.scripts]
|
|
tg-add-library-document = "trustgraph.cli.add_library_document:main"
|
|
tg-delete-flow-blueprint = "trustgraph.cli.delete_flow_blueprint:main"
|
|
tg-delete-mcp-tool = "trustgraph.cli.delete_mcp_tool:main"
|
|
tg-delete-kg-core = "trustgraph.cli.delete_kg_core:main"
|
|
tg-delete-tool = "trustgraph.cli.delete_tool:main"
|
|
tg-dump-msgpack = "trustgraph.cli.dump_msgpack:main"
|
|
tg-dump-queues = "trustgraph.cli.dump_queues:main"
|
|
tg-monitor-prompts = "trustgraph.cli.monitor_prompts:main"
|
|
tg-get-flow-blueprint = "trustgraph.cli.get_flow_blueprint:main"
|
|
tg-get-kg-core = "trustgraph.cli.get_kg_core:main"
|
|
tg-get-document-content = "trustgraph.cli.get_document_content:main"
|
|
tg-graph-to-turtle = "trustgraph.cli.graph_to_turtle:main"
|
|
tg-bootstrap-iam = "trustgraph.cli.bootstrap_iam:main"
|
|
tg-login = "trustgraph.cli.login:main"
|
|
tg-create-user = "trustgraph.cli.create_user:main"
|
|
tg-list-users = "trustgraph.cli.list_users:main"
|
|
tg-disable-user = "trustgraph.cli.disable_user:main"
|
|
tg-enable-user = "trustgraph.cli.enable_user:main"
|
|
tg-delete-user = "trustgraph.cli.delete_user:main"
|
|
tg-change-password = "trustgraph.cli.change_password:main"
|
|
tg-reset-password = "trustgraph.cli.reset_password:main"
|
|
tg-create-api-key = "trustgraph.cli.create_api_key:main"
|
|
tg-list-api-keys = "trustgraph.cli.list_api_keys:main"
|
|
tg-revoke-api-key = "trustgraph.cli.revoke_api_key:main"
|
|
tg-list-workspaces = "trustgraph.cli.list_workspaces:main"
|
|
tg-create-workspace = "trustgraph.cli.create_workspace:main"
|
|
tg-invoke-agent = "trustgraph.cli.invoke_agent:main"
|
|
tg-invoke-document-rag = "trustgraph.cli.invoke_document_rag:main"
|
|
tg-invoke-graph-rag = "trustgraph.cli.invoke_graph_rag:main"
|
|
tg-invoke-llm = "trustgraph.cli.invoke_llm:main"
|
|
tg-invoke-embeddings = "trustgraph.cli.invoke_embeddings:main"
|
|
tg-invoke-graph-embeddings = "trustgraph.cli.invoke_graph_embeddings:main"
|
|
tg-invoke-document-embeddings = "trustgraph.cli.invoke_document_embeddings:main"
|
|
tg-invoke-mcp-tool = "trustgraph.cli.invoke_mcp_tool:main"
|
|
tg-invoke-nlp-query = "trustgraph.cli.invoke_nlp_query:main"
|
|
tg-invoke-rows-query = "trustgraph.cli.invoke_rows_query:main"
|
|
tg-invoke-sparql-query = "trustgraph.cli.invoke_sparql_query:main"
|
|
tg-invoke-row-embeddings = "trustgraph.cli.invoke_row_embeddings:main"
|
|
tg-invoke-prompt = "trustgraph.cli.invoke_prompt:main"
|
|
tg-invoke-structured-query = "trustgraph.cli.invoke_structured_query:main"
|
|
tg-load-doc-embeds = "trustgraph.cli.load_doc_embeds:main"
|
|
tg-load-kg-core = "trustgraph.cli.load_kg_core:main"
|
|
tg-load-sample-documents = "trustgraph.cli.load_sample_documents:main"
|
|
tg-load-turtle = "trustgraph.cli.load_turtle:main"
|
|
tg-load-knowledge = "trustgraph.cli.load_knowledge:main"
|
|
tg-load-structured-data = "trustgraph.cli.load_structured_data:main"
|
|
tg-put-flow-blueprint = "trustgraph.cli.put_flow_blueprint:main"
|
|
tg-put-kg-core = "trustgraph.cli.put_kg_core:main"
|
|
tg-remove-library-document = "trustgraph.cli.remove_library_document:main"
|
|
tg-save-doc-embeds = "trustgraph.cli.save_doc_embeds:main"
|
|
tg-set-mcp-tool = "trustgraph.cli.set_mcp_tool:main"
|
|
tg-set-prompt = "trustgraph.cli.set_prompt:main"
|
|
tg-set-token-costs = "trustgraph.cli.set_token_costs:main"
|
|
tg-set-tool = "trustgraph.cli.set_tool:main"
|
|
tg-show-config = "trustgraph.cli.show_config:main"
|
|
tg-show-flow-blueprints = "trustgraph.cli.show_flow_blueprints:main"
|
|
tg-show-flow-state = "trustgraph.cli.show_flow_state:main"
|
|
tg-show-flows = "trustgraph.cli.show_flows:main"
|
|
tg-query-graph = "trustgraph.cli.query_graph:main"
|
|
tg-show-graph = "trustgraph.cli.show_graph:main"
|
|
tg-show-kg-cores = "trustgraph.cli.show_kg_cores:main"
|
|
tg-show-library-documents = "trustgraph.cli.show_library_documents:main"
|
|
tg-show-library-processing = "trustgraph.cli.show_library_processing:main"
|
|
tg-show-mcp-tools = "trustgraph.cli.show_mcp_tools:main"
|
|
tg-show-parameter-types = "trustgraph.cli.show_parameter_types:main"
|
|
tg-show-processor-state = "trustgraph.cli.show_processor_state:main"
|
|
tg-show-prompts = "trustgraph.cli.show_prompts:main"
|
|
tg-show-token-costs = "trustgraph.cli.show_token_costs:main"
|
|
tg-show-token-rate = "trustgraph.cli.show_token_rate:main"
|
|
tg-show-tools = "trustgraph.cli.show_tools:main"
|
|
tg-start-flow = "trustgraph.cli.start_flow:main"
|
|
tg-unload-kg-core = "trustgraph.cli.unload_kg_core:main"
|
|
tg-start-library-processing = "trustgraph.cli.start_library_processing:main"
|
|
tg-stop-flow = "trustgraph.cli.stop_flow:main"
|
|
tg-stop-library-processing = "trustgraph.cli.stop_library_processing:main"
|
|
tg-verify-system-status = "trustgraph.cli.verify_system_status:main"
|
|
tg-list-config-items = "trustgraph.cli.list_config_items:main"
|
|
tg-get-config-item = "trustgraph.cli.get_config_item:main"
|
|
tg-put-config-item = "trustgraph.cli.put_config_item:main"
|
|
tg-delete-config-item = "trustgraph.cli.delete_config_item:main"
|
|
tg-export-workspace-config = "trustgraph.cli.export_workspace_config:main"
|
|
tg-import-workspace-config = "trustgraph.cli.import_workspace_config:main"
|
|
tg-list-collections = "trustgraph.cli.list_collections:main"
|
|
tg-set-collection = "trustgraph.cli.set_collection:main"
|
|
tg-delete-collection = "trustgraph.cli.delete_collection:main"
|
|
tg-show-extraction-provenance = "trustgraph.cli.show_extraction_provenance:main"
|
|
tg-list-explain-traces = "trustgraph.cli.list_explain_traces:main"
|
|
tg-show-explain-trace = "trustgraph.cli.show_explain_trace:main"
|
|
|
|
[tool.setuptools.packages.find]
|
|
include = ["trustgraph*"]
|
|
|
|
[tool.setuptools.dynamic]
|
|
version = {attr = "trustgraph.cli_version.__version__"} |