mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-08-09 04:40:57 +00:00
feat(tenancy): add Workspace multi-tenant foundation (#2353)
* Document multi-tenant workspace architecture * Add OSS and commercial workspace boundaries * docs: redesign multi-tenant workspace architecture * feat(tenancy): implement workspace isolation * docs(tenancy): record verification evidence * docs(tenancy): revise single-instance SaaS topology * docs(tenancy): refine architecture options * docs: finalize cloud v2 multi-tenant decisions * feat(tenancy): establish cloud isolation foundations * feat(tenancy): harden shared cloud runtime boundaries * docs(tenancy): record final isolation verification * fix(tenancy): close isolation and permission gaps * docs(tenancy): record final isolation verification * feat(tenancy): connect cloud workspace control plane * fix(build): install git for pinned SDK * docs(cloud): update control plane verification * chore: update multi-tenant SDK pin * fix(cloud): skip legacy model sync during startup * test(cloud): preserve minimal model manager fixtures * fix(cloud): preserve authenticated account context * fix(cloud): reuse authenticated account for user info * feat(cloud): complete Workspace settings navigation * test(web): cover Workspace dropdown menu * feat(web): place workspace controls in sidebar * refactor(web): streamline workspace controls * style(web): format workspace layout test * fix(cloud): surface runtime and workspace plan status * fix(plugin): keep runtime identity stable across restarts * fix(ui): widen and center workspace switcher * fix(ui): hide roles from workspace switcher * fix(ui): align workspace switcher with sidebar entries * feat(workspace): add in-product collaboration and direct Cloud launch * style: format collaboration changes * fix(workspace): bind collaboration APIs to tenant UoW * fix(cloud): preserve Core-owned collaboration state * test(cloud): require Space identity for invite registration * feat(cloud): complete secure invitation experience * style(web): format invitation flows * fix(cloud): recover box runtime without unscoped skill reload * feat(oss): enforce invitation account and owner billing flows * style: format OSS account service * test(oss): cover invitation logout handoff * fix(oss): resolve workspace owner in scoped session * feat(cloud): harden multi-tenant runtime resources * fix(cloud): bound runtime restart storms * fix(cloud): eliminate periodic runtime CPU spikes * fix(cloud): enforce instance capacity ceilings * fix(cloud): scope public login capability discovery * fix(cloud): bound tenant maintenance and monitoring work * fix(runtime): bound tenant resource amplification * fix(deps): pin green multi-tenant plugin SDK * fix(cloud): handle unavailable skill capability * fix(security): require authentication for image file endpoint (H-2) - Changed /api/v1/files/image from AuthType.NONE to USER_TOKEN_OR_API_KEY - Added Permission.RESOURCE_VIEW requirement - Prevents unauthenticated cross-tenant file access via leaked keys - Fixes HIGH severity finding from multi-tenant security review docs: add comprehensive database migration guide - Complete migration steps for OSS → multi-tenant - Backup, execution, verification procedures - Rollback scenarios and recovery plans - Performance tuning recommendations * test: add comprehensive cross-tenant isolation tests Added 7 critical test scenarios for multi-tenant boundaries: - Cross-tenant bot access prevention - Viewer role read-only enforcement - Removed member immediate access revocation - Model provider credential isolation - WebSocket message isolation - Invitation token workspace scoping - Multi-workspace context validation These tests address P0-2 coverage gaps for: - workspaces.py (membership & invitation flows) - user.py (authentication & authorization) - websocket_chat.py (real-time isolation) - plugins.py (resource access control) docs: finalize database migration guide * fix(security): resolve M-1, M-2, M-3 security findings M-1: WebSocket authorization TOCTOU race (FIXED) - Changed _revalidate_websocket_authorization to return RequestContext - Ensures validated context is used immediately without race window - Prevents removed members from sending messages during revalidation gap M-2: Model Manager cache workspace isolation (VERIFIED) - Confirmed _CacheKey already uses 4-tuple: (instance, workspace, generation, resource) - Cache is properly scoped per workspace, no cross-tenant leakage possible - No code change needed, documented as working correctly M-3: Invitation lock workspace scoping (FIXED) - Changed lock key from token_digest to workspace_uuid:token_digest - Prevents DoS where attacker locks token in Workspace A to block Workspace B - Locks now isolated per workspace All MEDIUM severity findings from security review now resolved. * fix(cloud): unblock tenant CI and enforce knowledge quotas * fix(tenancy): scope rerank model sync --------- Co-authored-by: dadachann <185672915+dadachann@users.noreply.github.com>
This commit is contained in:
@@ -27,6 +27,17 @@ The `all` / `box` profile starts three services:
|
||||
- `langbot_box` — Box sandbox runtime (`:5410`). Uses the host Docker socket to
|
||||
spawn sandbox containers, so the **Box root host path and in-container path
|
||||
must be identical** (`BOX__LOCAL__HOST_ROOT=${LANGBOT_BOX_ROOT:-${PWD}/data/box}`).
|
||||
Its RPC and managed-process relay require a shared
|
||||
`LANGBOT_BOX_CONTROL_TOKEN` (at least 32 non-whitespace characters) in both
|
||||
the LangBot and Box containers. Generate it once with `openssl rand -hex 32`;
|
||||
never put it in `box.runtime.endpoint` or commit it to config.
|
||||
|
||||
Every Compose deployment also needs one
|
||||
`LANGBOT_PLUGIN_RUNTIME_CONTROL_TOKEN` shared by `langbot` and
|
||||
`langbot_plugin_runtime`. Generate it with `openssl rand -hex 32` and export it
|
||||
before `docker compose up`; the external Plugin Runtime fails closed when the
|
||||
token is empty or weak. Kubernetes uses the `langbot-plugin-runtime-control`
|
||||
Secret shown in `docker/kubernetes.yaml`.
|
||||
|
||||
With Box off, the dashboard/skills list stays visible (read-only) but sandbox
|
||||
tools, skill add/edit, and stdio MCP are disabled. Set `box.enabled: false`
|
||||
|
||||
@@ -65,10 +65,23 @@ Route auth is declared per-route via `AuthType` in
|
||||
- `API_KEY` — `X-API-Key` or `Authorization: Bearer <key>`.
|
||||
- `USER_TOKEN_OR_API_KEY` — either.
|
||||
|
||||
API keys are verified by `apikey_service.verify_api_key()`, which accepts:
|
||||
1. the **global key** from `config.yaml` `api.global_api_key` (no DB, no login,
|
||||
no `lbk_` prefix required), then
|
||||
2. **web-UI keys** (DB-stored, `lbk_` prefix).
|
||||
Authenticated routes receive an immutable `RequestContext` containing the
|
||||
principal, authorized Workspace membership, fixed-role permissions, instance,
|
||||
request id, and placement generation. A browser's `X-Workspace-Id` is only a
|
||||
selector and is always checked against the Account membership. Tenant services
|
||||
must accept this context (or an explicit trusted execution context) and fail
|
||||
closed when it is absent.
|
||||
|
||||
API-key authentication accepts:
|
||||
|
||||
1. the **global key** from `config.yaml` `api.global_api_key` only for a
|
||||
community instance with exactly one local Workspace, then
|
||||
2. **web-UI keys** whose one-time `lbk_` secret is stored only as a hash and is
|
||||
bound to one Workspace, explicit scopes, status, and optional expiry.
|
||||
|
||||
An API key derives its Workspace from the key record and ignores a caller's
|
||||
Workspace selector. Public Bot/Webhook routes similarly derive Workspace from
|
||||
the opaque owning resource rather than a header.
|
||||
|
||||
Route groups self-register via `@group.group_class(name, path)` and are
|
||||
discovered by `importutil.import_modules_in_pkg`.
|
||||
|
||||
@@ -29,13 +29,19 @@ Authorization: Bearer <api-key>
|
||||
|
||||
Two kinds of key are accepted:
|
||||
|
||||
1. **Web-UI key** — created in the web UI (sidebar → API Keys), prefixed `lbk_`,
|
||||
stored in the database.
|
||||
1. **Web-UI key** — created in the web UI (sidebar → API Keys), prefixed `lbk_`.
|
||||
The secret is shown once; only its SHA-256 hash is stored. Each key is bound
|
||||
to one Workspace and has explicit scopes, status, optional expiry, and
|
||||
last-used metadata. The key determines the Workspace; callers cannot switch
|
||||
it with `X-Workspace-Id`.
|
||||
2. **Global API key** — set in `data/config.yaml` under `api.global_api_key`.
|
||||
Requires no login session and no DB record; does not need the `lbk_` prefix.
|
||||
Leave empty to disable. See the `langbot-deploy` skill for config details.
|
||||
It is accepted only by a community instance with exactly one local
|
||||
Workspace and is disabled for SaaS multi-Workspace operation. Leave empty to
|
||||
disable. See the `langbot-deploy` skill for config details.
|
||||
|
||||
Requests without a valid key get `401 Unauthorized`.
|
||||
Invalid, revoked, or expired keys get `401 Unauthorized`. A valid key whose
|
||||
scopes do not authorize a tool gets `403 Forbidden`.
|
||||
|
||||
## Client configuration
|
||||
|
||||
@@ -66,7 +72,9 @@ The tools wrap the LangBot service layer. Current tools (v1):
|
||||
|
||||
Mutating tools (`create_*`, `update_*`) take a JSON object matching the same
|
||||
shape as the corresponding HTTP API request body. Discover resources with the
|
||||
`list_*` / `get_*` tools before mutating; identifiers are UUIDs.
|
||||
`list_*` / `get_*` tools before mutating; identifiers are UUIDs. Reads require
|
||||
`resource.view`; mutations require `resource.manage`. All service calls inherit
|
||||
the immutable Workspace context authenticated at the MCP transport boundary.
|
||||
|
||||
## How to use
|
||||
|
||||
@@ -93,7 +101,8 @@ shape as the corresponding HTTP API request body. Discover resources with the
|
||||
- `/mcp` is the **server** LangBot exposes. The `/api/v1/mcp` routes are the
|
||||
**client** side (managing external MCP servers LangBot connects to). Don't
|
||||
confuse them.
|
||||
- A `401` means the key is wrong, missing, or (for the global key)
|
||||
`api.global_api_key` is empty in config.yaml.
|
||||
- A `401` means the key is wrong, missing, revoked, expired, or (for the global
|
||||
key) `api.global_api_key` is empty or the instance is not an OSS singleton.
|
||||
- A `403` means the key is valid but lacks the permission required by the tool.
|
||||
- The global key is plaintext in config.yaml — only enable it on trusted/internal
|
||||
deployments and serve over HTTPS.
|
||||
|
||||
Reference in New Issue
Block a user