* feat: Implement multi-tenant architecture with tenant and knowledge base models - Added data models for tenants, knowledge bases, and related configurations. - Introduced role and permission management for users in the multi-tenant system. - Created a service layer for managing tenants and knowledge bases, including CRUD operations. - Developed a tenant-aware instance manager for LightRAG with caching and isolation features. - Added a migration script to transition existing workspace-based deployments to the new multi-tenant architecture. * chore: ignore lightrag/api/webui/assets/ directory * chore: stop tracking lightrag/api/webui/assets (ignore in .gitignore) * feat: Initialize LightRAG Multi-Tenant Stack with PostgreSQL - Added README.md for project overview, setup instructions, and architecture details. - Created docker-compose.yml to define services: PostgreSQL, Redis, LightRAG API, and Web UI. - Introduced env.example for environment variable configuration. - Implemented init-postgres.sql for PostgreSQL schema initialization with multi-tenant support. - Added reproduce_issue.py for testing default tenant access via API. * feat: Enhance TenantSelector and update related components for improved multi-tenant support * feat: Enhance testing capabilities and update documentation - Updated Makefile to include new test commands for various modes (compatibility, isolation, multi-tenant, security, coverage, and dry-run). - Modified API health check endpoint in Makefile to reflect new port configuration. - Updated QUICK_START.md and README.md to reflect changes in service URLs and ports. - Added environment variables for testing modes in env.example. - Introduced run_all_tests.sh script to automate testing across different modes. - Created conftest.py for pytest configuration, including database fixtures and mock services. - Implemented database helper functions for streamlined database operations in tests. - Added test collection hooks to skip tests based on the current MULTITENANT_MODE. * feat: Implement multi-tenant support with demo mode enabled by default - Added multi-tenant configuration to the environment and Docker setup. - Created pre-configured demo tenants (acme-corp and techstart) for testing. - Updated API endpoints to support tenant-specific data access. - Enhanced Makefile commands for better service management and database operations. - Introduced user-tenant membership system with role-based access control. - Added comprehensive documentation for multi-tenant setup and usage. - Fixed issues with document visibility in multi-tenant environments. - Implemented necessary database migrations for user memberships and legacy support. * feat(audit): Add final audit report for multi-tenant implementation - Documented overall assessment, architecture overview, test results, security findings, and recommendations. - Included detailed findings on critical security issues and architectural concerns. fix(security): Implement security fixes based on audit findings - Removed global RAG fallback and enforced strict tenant context. - Configured super-admin access and required user authentication for tenant access. - Cleared localStorage on logout and improved error handling in WebUI. chore(logs): Create task logs for audit and security fixes implementation - Documented actions, decisions, and next steps for both audit and security fixes. - Summarized test results and remaining recommendations. chore(scripts): Enhance development stack management scripts - Added scripts for cleaning, starting, and stopping the development stack. - Improved output messages and ensured graceful shutdown of services. feat(starter): Initialize PostgreSQL with AGE extension support - Created initialization scripts for PostgreSQL extensions including uuid-ossp, vector, and AGE. - Ensured successful installation and verification of extensions. * feat: Implement auto-select for first tenant and KB on initial load in WebUI - Removed WEBUI_INITIAL_STATE_FIX.md as the issue is resolved. - Added useTenantInitialization hook to automatically select the first available tenant and KB on app load. - Integrated the new hook into the Root component of the WebUI. - Updated RetrievalTesting component to ensure a KB is selected before allowing user interaction. - Created end-to-end tests for multi-tenant isolation and real service interactions. - Added scripts for starting, stopping, and cleaning the development stack. - Enhanced API and tenant routes to support tenant-specific pipeline status initialization. - Updated constants for backend URL to reflect the correct port. - Improved error handling and logging in various components. * feat: Add multi-tenant support with enhanced E2E testing scripts and client functionality * update client * Add integration and unit tests for multi-tenant API, models, security, and storage - Implement integration tests for tenant and knowledge base management endpoints in `test_tenant_api_routes.py`. - Create unit tests for tenant isolation, model validation, and role permissions in `test_tenant_models.py`. - Add security tests to enforce role-based permissions and context validation in `test_tenant_security.py`. - Develop tests for tenant-aware storage operations and context isolation in `test_tenant_storage_phase3.py`. * feat(e2e): Implement OpenAI model support and database reset functionality * Add comprehensive test suite for gpt-5-nano compatibility - Introduced tests for parameter normalization, embeddings, and entity extraction. - Implemented direct API testing for gpt-5-nano. - Validated .env configuration loading and OpenAI API connectivity. - Analyzed reasoning token overhead with various token limits. - Documented test procedures and expected outcomes in README files. - Ensured all tests pass for production readiness. * kg(postgres_impl): ensure AGE extension is loaded in session and configure graph initialization * dev: add hybrid dev helper scripts, Makefile, docker-compose.dev-db and local development docs * feat(dev): add dev helper scripts and local development documentation for hybrid setup * feat(multi-tenant): add detailed specifications and logs for multi-tenant improvements, including UX, backend handling, and ingestion pipeline * feat(migration): add generated tenant/kb columns, indexes, triggers; drop unused tables; update schema and docs * test(backward-compat): adapt tests to new StorageNameSpace/TenantService APIs (use concrete dummy storages) * chore: multi-tenant and UX updates — docs, webui, storage, tenant service adjustments * tests: stabilize integration tests + skip external services; fix multi-tenant API behavior and idempotency - gpt5_nano_compatibility: add pytest-asyncio markers, skip when OPENAI key missing, prevent module-level asyncio.run collection, add conftest - Ollama tests: add server availability check and skip markers; avoid pytest collection warnings by renaming helper classes - Graph storage tests: rename interactive test functions to avoid pytest collection - Document & Tenant routes: support external_ids for idempotency; ensure HTTPExceptions are re-raised - LightRAG core: support external_ids in apipeline_enqueue_documents and idempotent logic - Tests updated to match API changes (tenant routes & document routes) - Add logs and scripts for inspection and audit
4.7 KiB
4.7 KiB
Multi-Tenancy Audit Report
Date: November 21, 2025 Project: LightRAG Auditor: GitHub Copilot
Executive Summary
The current multi-tenancy implementation in LightRAG relies on application-level isolation. While it provides helper classes (TenantSQLBuilder, MongoTenantHelper, etc.) to filter data by tenant_id and kb_id, it lacks enforcement at the database or framework level. This design is susceptible to data leaks if developers fail to use the helpers correctly.
The "battle-tested" approach requires Row-Level Security (RLS) for PostgreSQL, strict repository wrappers for NoSQL stores, and middleware-enforced tenant identification (subdomains + JWT).
Gap Analysis
| Feature | Current Implementation | Battle-Tested Standard | Gap Severity |
|---|---|---|---|
| Tenant Identification | Headers (X-Tenant-ID) or JWT metadata. No subdomain support. |
Subdomains (tenant.app.com) + JWT tenant_id claim. |
High |
| PostgreSQL Isolation | WHERE clause filtering via TenantSQLBuilder. |
Row-Level Security (RLS) + Tenant UUID PK. | Critical |
| MongoDB Isolation | Manual field filtering via MongoTenantHelper. |
Tenant-scoped Repository or ODM Middleware (Beanie). | High |
| Neo4j/Memgraph Isolation | Cypher query modification via helper. | Tenant Session Wrapper or Label Prefixing. | High |
| Vector DB Isolation | Metadata filtering via helper. | Tenant-scoped Repository or Collection Separation. | High |
| Redis Isolation | Key prefixing via RedisTenantNamespace (manual usage). |
Key Prefixing enforced by wrapper/dependency. | Medium |
| Framework Enforcement | Optional dependencies in routers. | Global Middleware + Dependency Injection. | High |
Detailed Findings
1. Tenant Identification
- Current:
lightrag/api/dependencies.pyextractstenant_idfrom headers or JWT. - Risk: Clients can potentially spoof
X-Tenant-IDif not strictly validated against the JWT. Subdomains are not used, making it harder to isolate tenants at the DNS/networking level (e.g., for CORS or cookies).
2. PostgreSQL
- Current:
lightrag/kg/postgres_tenant_support.pymodifies SQL strings. - Risk: "Trusting the application code". A raw SQL query without the builder will leak data. RLS is the only way to prevent this at the database engine level.
3. MongoDB
- Current:
lightrag/kg/mongo_tenant_support.pyprovides helper methods. - Risk: Developers must remember to call
add_tenant_fieldsandget_tenant_filter.
4. Neo4j
- Current:
lightrag/kg/graph_tenant_support.pyinjectsWHEREclauses. - Risk: Complex Cypher queries might be difficult to parse and modify correctly. A session wrapper that enforces parameters is safer.
5. Redis
- Current:
lightrag/kg/redis_tenant_support.pyprovidesRedisTenantNamespace. - Risk: Manual usage of the namespace wrapper is required.
6. Vector Databases (Qdrant, Milvus, FAISS, Nano)
- Current:
lightrag/kg/vector_tenant_support.pyprovides helper methods for metadata filtering and ID prefixing. - Risk: Similar to other NoSQL stores, developers must manually apply filters and metadata.
- Qdrant: Relies on
mustconditions in filters. - Milvus: Relies on
exprstrings. - FAISS: Relies on index naming or metadata filtering (which can be slow if not optimized).
- Nano: Relies on metadata filtering.
- Qdrant: Relies on
7. Other Graph Databases (Memgraph, NetworkX)
- Current:
lightrag/kg/graph_tenant_support.pycovers these. - Risk:
- Memgraph: Similar to Neo4j, relies on Cypher query modification.
- NetworkX: In-memory graph. Isolation relies on creating subgraphs or filtering edges manually. If the graph is persisted, it needs careful handling.
Recommendations
- Implement Subdomain Middleware: Add middleware to resolve
tenant_idfrom subdomains and validate it against Redis/DB. - Enable PostgreSQL RLS:
- Add
tenant_idtocurrent_setting. - Enable RLS on all tables.
- Create policies to enforce isolation.
- Add
- Refactor MongoDB Access: Create a
MongoTenantRepoclass that wraps the collection and automatically applies filters. - Refactor Neo4j/Memgraph Access: Create a
GraphTenantSessionclass that wraps the driver session. - Refactor Vector DB Access: Create a
VectorTenantRepoclass (or specific implementations) that wraps the client and enforces metadata/filtering. - Global Dependency: Ensure
get_tenant_contextis used globally or at the router level for all tenant-specific endpoints.
Action Plan
See docs/action_plan/02-implementation-plan.md for the detailed steps.