mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-27 01:16:22 +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.
136 lines
No EOL
5.8 KiB
TOML
136 lines
No EOL
5.8 KiB
TOML
[build-system]
|
|
requires = ["setuptools>=61.0", "wheel"]
|
|
build-backend = "setuptools.build_meta"
|
|
|
|
[project]
|
|
name = "trustgraph-flow"
|
|
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",
|
|
"aiohttp",
|
|
"anthropic",
|
|
"scylla-driver",
|
|
"cohere",
|
|
"cryptography",
|
|
"faiss-cpu",
|
|
"falkordb",
|
|
"fastembed",
|
|
"ibis",
|
|
"jsonschema",
|
|
"langchain",
|
|
"langchain-community",
|
|
"langchain-core",
|
|
"langchain-text-splitters",
|
|
"mcp",
|
|
"minio",
|
|
"mistralai<2.0.0",
|
|
"neo4j",
|
|
"nltk",
|
|
"ollama",
|
|
"openai",
|
|
"pinecone[grpc]",
|
|
"prometheus-client",
|
|
"pulsar-client",
|
|
"pymilvus",
|
|
"pypdf",
|
|
"pyyaml",
|
|
"qdrant-client",
|
|
"rdflib",
|
|
"requests",
|
|
"strawberry-graphql",
|
|
"tabulate",
|
|
"tiktoken",
|
|
"urllib3",
|
|
]
|
|
classifiers = [
|
|
"Programming Language :: Python :: 3",
|
|
"Operating System :: OS Independent",
|
|
]
|
|
|
|
[project.urls]
|
|
Homepage = "https://github.com/trustgraph-ai/trustgraph"
|
|
|
|
[project.scripts]
|
|
agent-manager-react = "trustgraph.agent.react:run"
|
|
agent-orchestrator = "trustgraph.agent.orchestrator:run"
|
|
api-gateway = "trustgraph.gateway:run"
|
|
chunker-recursive = "trustgraph.chunking.recursive:run"
|
|
chunker-token = "trustgraph.chunking.token:run"
|
|
bootstrap = "trustgraph.bootstrap.bootstrapper:run"
|
|
config-svc = "trustgraph.config.service:run"
|
|
flow-svc = "trustgraph.flow.service:run"
|
|
iam-svc = "trustgraph.iam.service:run"
|
|
doc-embeddings-query-milvus = "trustgraph.query.doc_embeddings.milvus:run"
|
|
doc-embeddings-query-pinecone = "trustgraph.query.doc_embeddings.pinecone:run"
|
|
doc-embeddings-query-qdrant = "trustgraph.query.doc_embeddings.qdrant:run"
|
|
doc-embeddings-write-milvus = "trustgraph.storage.doc_embeddings.milvus:run"
|
|
doc-embeddings-write-pinecone = "trustgraph.storage.doc_embeddings.pinecone:run"
|
|
doc-embeddings-write-qdrant = "trustgraph.storage.doc_embeddings.qdrant:run"
|
|
document-embeddings = "trustgraph.embeddings.document_embeddings:run"
|
|
document-rag = "trustgraph.retrieval.document_rag:run"
|
|
embeddings-fastembed = "trustgraph.embeddings.fastembed:run"
|
|
embeddings-ollama = "trustgraph.embeddings.ollama:run"
|
|
graph-embeddings-query-milvus = "trustgraph.query.graph_embeddings.milvus:run"
|
|
graph-embeddings-query-pinecone = "trustgraph.query.graph_embeddings.pinecone:run"
|
|
graph-embeddings-query-qdrant = "trustgraph.query.graph_embeddings.qdrant:run"
|
|
graph-embeddings-write-milvus = "trustgraph.storage.graph_embeddings.milvus:run"
|
|
graph-embeddings-write-pinecone = "trustgraph.storage.graph_embeddings.pinecone:run"
|
|
graph-embeddings-write-qdrant = "trustgraph.storage.graph_embeddings.qdrant:run"
|
|
graph-embeddings = "trustgraph.embeddings.graph_embeddings:run"
|
|
graph-rag = "trustgraph.retrieval.graph_rag:run"
|
|
kg-extract-agent = "trustgraph.extract.kg.agent:run"
|
|
kg-extract-definitions = "trustgraph.extract.kg.definitions:run"
|
|
kg-extract-rows = "trustgraph.extract.kg.rows:run"
|
|
kg-extract-relationships = "trustgraph.extract.kg.relationships:run"
|
|
kg-extract-topics = "trustgraph.extract.kg.topics:run"
|
|
kg-extract-ontology = "trustgraph.extract.kg.ontology:run"
|
|
kg-manager = "trustgraph.cores:run"
|
|
kg-store = "trustgraph.storage.knowledge:run"
|
|
librarian = "trustgraph.librarian:run"
|
|
mcp-tool = "trustgraph.agent.mcp_tool:run"
|
|
metering = "trustgraph.metering:run"
|
|
nlp-query = "trustgraph.retrieval.nlp_query:run"
|
|
rows-write-cassandra = "trustgraph.storage.rows.cassandra:run"
|
|
rows-query-cassandra = "trustgraph.query.rows.cassandra:run"
|
|
row-embeddings = "trustgraph.embeddings.row_embeddings:run"
|
|
row-embeddings-write-qdrant = "trustgraph.storage.row_embeddings.qdrant:run"
|
|
row-embeddings-query-qdrant = "trustgraph.query.row_embeddings.qdrant:run"
|
|
pdf-decoder = "trustgraph.decoding.pdf:run"
|
|
pdf-ocr-mistral = "trustgraph.decoding.mistral_ocr:run"
|
|
prompt-template = "trustgraph.prompt.template:run"
|
|
rev-gateway = "trustgraph.rev_gateway:run"
|
|
run-processing = "trustgraph.processing:run"
|
|
sparql-query = "trustgraph.query.sparql:run"
|
|
structured-query = "trustgraph.retrieval.structured_query:run"
|
|
structured-diag = "trustgraph.retrieval.structured_diag:run"
|
|
text-completion-azure = "trustgraph.model.text_completion.azure:run"
|
|
text-completion-azure-openai = "trustgraph.model.text_completion.azure_openai:run"
|
|
text-completion-claude = "trustgraph.model.text_completion.claude:run"
|
|
text-completion-cohere = "trustgraph.model.text_completion.cohere:run"
|
|
text-completion-llamafile = "trustgraph.model.text_completion.llamafile:run"
|
|
text-completion-lmstudio = "trustgraph.model.text_completion.lmstudio:run"
|
|
text-completion-mistral = "trustgraph.model.text_completion.mistral:run"
|
|
text-completion-ollama = "trustgraph.model.text_completion.ollama:run"
|
|
text-completion-openai = "trustgraph.model.text_completion.openai:run"
|
|
text-completion-tgi = "trustgraph.model.text_completion.tgi:run"
|
|
text-completion-vllm = "trustgraph.model.text_completion.vllm:run"
|
|
triples-query-cassandra = "trustgraph.query.triples.cassandra:run"
|
|
triples-query-falkordb = "trustgraph.query.triples.falkordb:run"
|
|
triples-query-memgraph = "trustgraph.query.triples.memgraph:run"
|
|
triples-query-neo4j = "trustgraph.query.triples.neo4j:run"
|
|
triples-write-cassandra = "trustgraph.storage.triples.cassandra:run"
|
|
triples-write-falkordb = "trustgraph.storage.triples.falkordb:run"
|
|
triples-write-memgraph = "trustgraph.storage.triples.memgraph:run"
|
|
triples-write-neo4j = "trustgraph.storage.triples.neo4j:run"
|
|
wikipedia-lookup = "trustgraph.external.wikipedia:run"
|
|
joke-service = "trustgraph.tool_service.joke:run"
|
|
|
|
[tool.setuptools.packages.find]
|
|
include = ["trustgraph*"]
|
|
|
|
[tool.setuptools.dynamic]
|
|
version = {attr = "trustgraph.flow_version.__version__"} |