2025-07-23 21:22:08 +01:00
|
|
|
[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 = [
|
2026-04-21 21:36:46 +01:00
|
|
|
"trustgraph-base>=2.4,<2.5",
|
2025-07-23 21:22:08 +01:00
|
|
|
"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"
|
2026-01-14 12:31:40 +00:00
|
|
|
tg-delete-flow-blueprint = "trustgraph.cli.delete_flow_blueprint:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2025-11-26 15:16:17 +00:00
|
|
|
tg-dump-queues = "trustgraph.cli.dump_queues:main"
|
2026-03-30 16:08:46 +01:00
|
|
|
tg-monitor-prompts = "trustgraph.cli.monitor_prompts:main"
|
2026-01-14 12:31:40 +00:00
|
|
|
tg-get-flow-blueprint = "trustgraph.cli.get_flow_blueprint:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
tg-get-kg-core = "trustgraph.cli.get_kg_core:main"
|
2026-03-09 13:36:24 +00:00
|
|
|
tg-get-document-content = "trustgraph.cli.get_document_content:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
tg-graph-to-turtle = "trustgraph.cli.graph_to_turtle:main"
|
feat: IAM service, gateway auth middleware, capability model, and CLIs (#849)
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.
2026-04-24 17:29:10 +01:00
|
|
|
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"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2026-02-04 14:10:30 +00:00
|
|
|
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"
|
2025-07-23 21:22:08 +01:00
|
|
|
tg-invoke-mcp-tool = "trustgraph.cli.invoke_mcp_tool:main"
|
2025-09-04 16:06:18 +01:00
|
|
|
tg-invoke-nlp-query = "trustgraph.cli.invoke_nlp_query:main"
|
2026-02-23 15:56:29 +00:00
|
|
|
tg-invoke-rows-query = "trustgraph.cli.invoke_rows_query:main"
|
SPARQL query service (#754)
SPARQL 1.1 query service wrapping pub/sub triples interface
Add a backend-agnostic SPARQL query service that parses SPARQL
queries using rdflib, decomposes them into triple pattern lookups
via the existing TriplesClient pub/sub interface, and performs
in-memory joins, filters, and projections.
Includes:
- SPARQL parser, algebra evaluator, expression evaluator, solution
sequence operations (BGP, JOIN, OPTIONAL, UNION, FILTER, BIND,
VALUES, GROUP BY, ORDER BY, LIMIT/OFFSET, DISTINCT, aggregates)
- FlowProcessor service with TriplesClientSpec
- Gateway dispatcher, request/response translators, API spec
- Python SDK method (FlowInstance.sparql_query)
- CLI command (tg-invoke-sparql-query)
- Tech spec (docs/tech-specs/sparql-query.md)
New unit tests for SPARQL query
2026-04-02 17:21:39 +01:00
|
|
|
tg-invoke-sparql-query = "trustgraph.cli.invoke_sparql_query:main"
|
2026-02-23 21:52:56 +00:00
|
|
|
tg-invoke-row-embeddings = "trustgraph.cli.invoke_row_embeddings:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
tg-invoke-prompt = "trustgraph.cli.invoke_prompt:main"
|
2025-09-04 16:06:18 +01:00
|
|
|
tg-invoke-structured-query = "trustgraph.cli.invoke_structured_query:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2025-08-13 16:07:58 +01:00
|
|
|
tg-load-knowledge = "trustgraph.cli.load_knowledge:main"
|
2025-09-05 15:38:18 +01:00
|
|
|
tg-load-structured-data = "trustgraph.cli.load_structured_data:main"
|
2026-01-14 12:31:40 +00:00
|
|
|
tg-put-flow-blueprint = "trustgraph.cli.put_flow_blueprint:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2026-01-14 12:31:40 +00:00
|
|
|
tg-show-flow-blueprints = "trustgraph.cli.show_flow_blueprints:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
tg-show-flow-state = "trustgraph.cli.show_flow_state:main"
|
|
|
|
|
tg-show-flows = "trustgraph.cli.show_flows:main"
|
Graph query CLI tool (#679)
New CLI tool that enables selective queries against the triple store
unlike tg-show-graph which dumps the entire graph.
Features:
- Filter by subject, predicate, object, and/or named graph
- Auto-detection of term types (IRI, literal, quoted triple)
- Two ways to specify quoted triples:
- Inline Turtle-style: -o "<<s p o>>"
- Explicit flags: --qt-subject, --qt-predicate, --qt-object
- Output formats: space-separated, pipe-separated, JSON, JSON Lines
- Streaming mode for efficient large result sets
Auto-detection rules:
- http://, https://, urn:, or <wrapped> -> IRI
- <<s p o>> -> quoted triple
- Otherwise -> literal
2026-03-10 11:03:34 +00:00
|
|
|
tg-query-graph = "trustgraph.cli.query_graph:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2025-09-26 10:55:10 +01:00
|
|
|
tg-show-parameter-types = "trustgraph.cli.show_parameter_types:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
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"
|
2025-12-04 18:01:47 +00:00
|
|
|
tg-verify-system-status = "trustgraph.cli.verify_system_status:main"
|
2025-08-22 13:36:10 +01:00
|
|
|
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"
|
feat: workspace-based multi-tenancy, replacing user as tenancy axis (#840)
Introduces `workspace` as the isolation boundary for config, flows,
library, and knowledge data. Removes `user` as a schema-level field
throughout the code, API specs, and tests; workspace provides the
same separation more cleanly at the trusted flow.workspace layer
rather than through client-supplied message fields.
Design
------
- IAM tech spec (docs/tech-specs/iam.md) documents current state,
proposed auth/access model, and migration direction.
- Data ownership model (docs/tech-specs/data-ownership-model.md)
captures the workspace/collection/flow hierarchy.
Schema + messaging
------------------
- Drop `user` field from AgentRequest/Step, GraphRagQuery,
DocumentRagQuery, Triples/Graph/Document/Row EmbeddingsRequest,
Sparql/Rows/Structured QueryRequest, ToolServiceRequest.
- Keep collection/workspace routing via flow.workspace at the
service layer.
- Translators updated to not serialise/deserialise user.
API specs
---------
- OpenAPI schemas and path examples cleaned of user fields.
- Websocket async-api messages updated.
- Removed the unused parameters/User.yaml.
Services + base
---------------
- Librarian, collection manager, knowledge, config: all operations
scoped by workspace. Config client API takes workspace as first
positional arg.
- `flow.workspace` set at flow start time by the infrastructure;
no longer pass-through from clients.
- Tool service drops user-personalisation passthrough.
CLI + SDK
---------
- tg-init-workspace and workspace-aware import/export.
- All tg-* commands drop user args; accept --workspace.
- Python API/SDK (flow, socket_client, async_*, explainability,
library) drop user kwargs from every method signature.
MCP server
----------
- All tool endpoints drop user parameters; socket_manager no longer
keyed per user.
Flow service
------------
- Closure-based topic cleanup on flow stop: only delete topics
whose blueprint template was parameterised AND no remaining
live flow (across all workspaces) still resolves to that topic.
Three scopes fall out naturally from template analysis:
* {id} -> per-flow, deleted on stop
* {blueprint} -> per-blueprint, kept while any flow of the
same blueprint exists
* {workspace} -> per-workspace, kept while any flow in the
workspace exists
* literal -> global, never deleted (e.g. tg.request.librarian)
Fixes a bug where stopping a flow silently destroyed the global
librarian exchange, wedging all library operations until manual
restart.
RabbitMQ backend
----------------
- heartbeat=60, blocked_connection_timeout=300. Catches silently
dead connections (broker restart, orphaned channels, network
partitions) within ~2 heartbeat windows, so the consumer
reconnects and re-binds its queue rather than sitting forever
on a zombie connection.
Tests
-----
- Full test refresh: unit, integration, contract, provenance.
- Dropped user-field assertions and constructor kwargs across
~100 test files.
- Renamed user-collection isolation tests to workspace-collection.
2026-04-21 23:23:01 +01:00
|
|
|
tg-export-workspace-config = "trustgraph.cli.export_workspace_config:main"
|
|
|
|
|
tg-import-workspace-config = "trustgraph.cli.import_workspace_config:main"
|
2025-09-18 15:57:52 +01:00
|
|
|
tg-list-collections = "trustgraph.cli.list_collections:main"
|
2025-09-19 16:08:47 +01:00
|
|
|
tg-set-collection = "trustgraph.cli.set_collection:main"
|
2025-09-18 15:57:52 +01:00
|
|
|
tg-delete-collection = "trustgraph.cli.delete_collection:main"
|
2026-03-13 11:37:59 +00:00
|
|
|
tg-show-extraction-provenance = "trustgraph.cli.show_extraction_provenance:main"
|
2026-03-11 13:44:29 +00:00
|
|
|
tg-list-explain-traces = "trustgraph.cli.list_explain_traces:main"
|
|
|
|
|
tg-show-explain-trace = "trustgraph.cli.show_explain_trace:main"
|
2025-07-23 21:22:08 +01:00
|
|
|
|
|
|
|
|
[tool.setuptools.packages.find]
|
|
|
|
|
include = ["trustgraph*"]
|
|
|
|
|
|
|
|
|
|
[tool.setuptools.dynamic]
|
|
|
|
|
version = {attr = "trustgraph.cli_version.__version__"}
|