* 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
242 lines
6.5 KiB
Markdown
242 lines
6.5 KiB
Markdown
# Web UI Multi-Tenant Audit
|
|
|
|
**Date:** November 29, 2025
|
|
**Status:** In Progress
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
This document audits the multi-tenant implementation in the LightRAG Web UI (React/TypeScript frontend).
|
|
|
|
## Components Under Audit
|
|
|
|
### 1. Tenant State Store (`stores/tenant.ts`)
|
|
|
|
**Purpose:** Zustand-based state management for tenant and KB selection.
|
|
|
|
**Analysis:**
|
|
|
|
```typescript
|
|
// Key State Properties
|
|
interface TenantState {
|
|
selectedTenant: Tenant | null;
|
|
selectedKB: KnowledgeBase | null;
|
|
tenants: Tenant[];
|
|
knowledgeBases: KnowledgeBase[];
|
|
}
|
|
```
|
|
|
|
**✅ Strengths:**
|
|
- State is persisted to localStorage for page refresh resilience
|
|
- State is initialized on module load (not lazy)
|
|
- Clear separation between tenant and KB selection
|
|
|
|
**⚠️ Potential Issues:**
|
|
- localStorage is domain-scoped, not tenant-scoped
|
|
- If two users access same browser, localStorage could leak tenant context
|
|
- No encryption of stored tenant data
|
|
|
|
**🔍 Test Point:**
|
|
- Verify localStorage is cleared on logout
|
|
- Check if tenant IDs are validated before use
|
|
|
|
### 2. API Client (`api/client.ts`)
|
|
|
|
**Purpose:** Axios instance with interceptors for adding tenant headers.
|
|
|
|
**Analysis:**
|
|
|
|
```typescript
|
|
// Header injection in interceptor
|
|
if (selectedTenant?.tenant_id) {
|
|
config.headers['X-Tenant-ID'] = selectedTenant.tenant_id;
|
|
}
|
|
if (selectedKB?.kb_id) {
|
|
config.headers['X-KB-ID'] = selectedKB.kb_id;
|
|
}
|
|
```
|
|
|
|
**✅ Strengths:**
|
|
- Headers automatically added to ALL requests
|
|
- Console logging enabled for debugging
|
|
- Reads directly from localStorage to avoid circular dependencies
|
|
|
|
**⚠️ Potential Issues:**
|
|
- If localStorage is empty/corrupted, requests proceed without tenant headers
|
|
- No validation that tenant_id/kb_id are valid UUIDs
|
|
- Logging may expose sensitive IDs in production
|
|
|
|
**🔍 Test Points:**
|
|
1. What happens if localStorage has invalid JSON?
|
|
2. What happens if tenant_id is malformed?
|
|
3. Are headers properly propagated for streaming requests?
|
|
|
|
### 3. Tenant API Functions (`api/tenant.ts`)
|
|
|
|
**Purpose:** API functions for tenant/KB CRUD operations.
|
|
|
|
**Analysis:**
|
|
|
|
**✅ Strengths:**
|
|
- Paginated API calls for efficiency
|
|
- Fallback to default tenant if API fails
|
|
- Headers explicitly added for tenant-scoped calls
|
|
|
|
**⚠️ Potential Issues:**
|
|
- Fallback to "default" tenant could hide errors
|
|
- No retry logic for failed API calls
|
|
- Error handling may swallow important context
|
|
|
|
### 4. Document Manager (`features/DocumentManager.tsx`)
|
|
|
|
**Purpose:** Component for managing documents within a tenant/KB.
|
|
|
|
**Analysis from recent fix (2025-02-25):**
|
|
|
|
```typescript
|
|
// Reset document state when tenant or KB changes
|
|
useEffect(() => {
|
|
setCurrentPageDocs([]);
|
|
setDocs(null);
|
|
setStatusCounts({ all: 0 });
|
|
setPagination(prev => ({...prev, page: 1, total_count: 0, ...}));
|
|
setSelectedDocIds([]);
|
|
setPageByStatus({ all: 1, processed: 1, processing: 1, pending: 1, failed: 1 });
|
|
}, [selectedTenant?.tenant_id, selectedKB?.kb_id]);
|
|
```
|
|
|
|
**✅ Strengths:**
|
|
- State is cleared immediately on tenant/KB change
|
|
- Prevents showing stale data from previous context
|
|
- Logging added for debugging
|
|
|
|
**⚠️ Potential Issues:**
|
|
- Brief moment where old data could be visible during transition
|
|
- No loading indicator during context switch
|
|
- Dependency array may not catch all cases
|
|
|
|
### 5. Query/Chat Panel
|
|
|
|
**Purpose:** Component for running queries against the knowledge base.
|
|
|
|
**🔍 Test Points:**
|
|
1. Are queries properly scoped to selected tenant/KB?
|
|
2. Does streaming work correctly with tenant headers?
|
|
3. Are conversation histories properly isolated?
|
|
|
|
---
|
|
|
|
## Detailed Findings
|
|
|
|
### Finding WUI-001: localStorage Security Concern
|
|
**Severity:** Medium
|
|
**Location:** `stores/tenant.ts`, `api/client.ts`
|
|
|
|
**Description:**
|
|
Tenant context is stored in localStorage as plain JSON. This could:
|
|
- Be read by any JavaScript on the same domain
|
|
- Persist after logout if not properly cleared
|
|
- Be shared between browser tabs/windows unintentionally
|
|
|
|
**Recommendation:**
|
|
- Clear localStorage on logout
|
|
- Consider sessionStorage for tenant context
|
|
- Validate tenant context on each API call
|
|
|
|
### Finding WUI-002: Fallback to Default Tenant
|
|
**Severity:** Low
|
|
**Location:** `api/tenant.ts`
|
|
|
|
**Description:**
|
|
When API fails, the code returns a default tenant:
|
|
```typescript
|
|
return {
|
|
items: [{
|
|
tenant_id: 'default',
|
|
tenant_name: 'Default Tenant',
|
|
...
|
|
}],
|
|
...
|
|
}
|
|
```
|
|
|
|
This could mask API errors and lead to unexpected behavior.
|
|
|
|
**Recommendation:**
|
|
- Distinguish between API errors and empty results
|
|
- Show error state to user instead of fallback
|
|
- Log API failures for debugging
|
|
|
|
### Finding WUI-003: Missing Header Validation
|
|
**Severity:** Low
|
|
**Location:** `api/client.ts`
|
|
|
|
**Description:**
|
|
The interceptor logs warnings but doesn't prevent requests without tenant context:
|
|
```typescript
|
|
if (!selectedTenantJson) {
|
|
console.warn('[Axios Interceptor] No SELECTED_TENANT in localStorage');
|
|
}
|
|
// Request still proceeds
|
|
```
|
|
|
|
**Recommendation:**
|
|
- For tenant-required endpoints, block request if no context
|
|
- Add middleware to validate tenant context presence
|
|
|
|
---
|
|
|
|
## Test Scenarios
|
|
|
|
### Scenario WUI-T1: Tenant Selection Persistence
|
|
1. Select Tenant A
|
|
2. Refresh page
|
|
3. Verify Tenant A is still selected
|
|
4. Check localStorage for correct data
|
|
|
|
**Expected:** Tenant A persisted and restored correctly
|
|
|
|
### Scenario WUI-T2: KB Selection Isolation
|
|
1. Select Tenant A, KB Alpha
|
|
2. Verify document list shows only KB Alpha docs
|
|
3. Switch to KB Beta
|
|
4. Verify document list clears and shows KB Beta docs
|
|
|
|
**Expected:** Documents properly filtered by KB
|
|
|
|
### Scenario WUI-T3: Cross-Tenant Query Isolation
|
|
1. Select Tenant A, add document about "apples"
|
|
2. Query "what do you know about apples?"
|
|
3. Switch to Tenant B
|
|
4. Query same question
|
|
5. Verify response is empty/different
|
|
|
|
**Expected:** Query results isolated to selected tenant
|
|
|
|
### Scenario WUI-T4: Header Propagation
|
|
1. Open browser DevTools Network tab
|
|
2. Select Tenant A, KB Alpha
|
|
3. Trigger document upload
|
|
4. Verify request headers include:
|
|
- `X-Tenant-ID: <tenant_a_id>`
|
|
- `X-KB-ID: <kb_alpha_id>`
|
|
|
|
**Expected:** Headers correctly set on all requests
|
|
|
|
---
|
|
|
|
## Conclusion
|
|
|
|
The Web UI implementation has a solid foundation for multi-tenant support with:
|
|
- State management via Zustand
|
|
- Automatic header injection via Axios interceptors
|
|
- State clearing on context change
|
|
|
|
Key areas for improvement:
|
|
1. localStorage security (session vs persistent storage)
|
|
2. Error handling for API failures
|
|
3. Validation of tenant context before API calls
|
|
4. Loading states during context transitions
|
|
|
|
Next step: Verify these findings through manual testing.
|