@objectstack/plugin-security 4.0.4 → 4.0.5

package/README.md

@@ -1,47 +1,117 @@
 # @objectstack/plugin-security
 
-Security Plugin for ObjectStack — RBAC, Row-Level Security (RLS), and Field-Level Security runtime.
+> Security plugin for ObjectStack — RBAC, Row-Level Security (RLS), and Field-Level Masking enforced transparently through the ObjectQL middleware chain.
 
-## Features
+[![npm](https://img.shields.io/npm/v/@objectstack/plugin-security.svg)](https://www.npmjs.com/package/@objectstack/plugin-security)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-- **RBAC Permission Evaluator**: Checks object-level CRUD permissions per user role with most-permissive merging across multiple roles.
-- **Row-Level Security (RLS)**: Compiles RLS policy expressions into ObjectQL query filters, automatically injected into all read operations.
-- **Field-Level Masking**: Strips non-readable fields from query results and identifies non-editable fields.
-- **ObjectQL Middleware Integration**: Hooks into the ObjectQL pipeline to enforce security transparently on every operation.
-- **System Bypass**: System-level operations skip security checks for internal workflows.
+## Overview
 
-## Usage
+`plugin-security` hooks into the ObjectQL pipeline and applies authorization on every read and write:
+
+1. **Resolve permission sets** — match user roles against `SysPermissionSet` metadata.
+2. **Check object CRUD** — `allowRead`, `allowCreate`, `allowEdit`, `allowDelete`.
+3. **Inject RLS** — compile row-level policy expressions into query filters.
+4. **Mask fields** — remove non-readable fields from results; flag non-editable fields on writes.
+
+System-context operations bypass checks so internal jobs, migrations, and seed scripts work unobstructed.
+
+## Installation
+
+```bash
+pnpm add @objectstack/plugin-security
+```
+
+## Quick Start
 
 ```typescript
-import { SecurityPlugin } from '@objectstack/plugin-security';
 import { ObjectKernel } from '@objectstack/core';
+import { SecurityPlugin } from '@objectstack/plugin-security';
 
-const kernel = new ObjectKernel({
-  plugins: [
-    new SecurityPlugin(),
-  ],
-});
+const kernel = new ObjectKernel();
+kernel.use(new SecurityPlugin());
+await kernel.bootstrap();
 ```
 
-### Exported Components
+### Multi-tenant vs single-tenant
+
+`SecurityPlugin` defaults to **multi-tenant** mode. In this mode it:
+
+- Auto-injects `organization_id = ctx.tenantId` on insert when the target object declares an `organization_id` field.
+- Honours the wildcard `tenant_isolation` RLS policy
+  (`organization_id = current_user.organization_id`) shipped with the
+  default `member_default` / `viewer_readonly` permission sets.
+
+For single-tenant deployments, switch it off:
 
 ```typescript
-import {
-  SecurityPlugin,
-  PermissionEvaluator,
-  RLSCompiler,
-  FieldMasker,
-} from '@objectstack/plugin-security';
+kernel.use(new SecurityPlugin({ multiTenant: false }));
 ```
 
-## Architecture
+This skips the per-insert metadata lookup that drives `organization_id`
+auto-injection (the `owner_id` injection still runs) and strips wildcard
+`current_user.organization_id` policies from the per-request policy
+set so the field-existence safety net never has to drop them
+individually. Field-Level Security, owner-based RLS, and per-object
+CRUD checks operate identically regardless of this flag.
+
+In CLI / dev-server mode the same switch is exposed via the
+`OS_MULTI_TENANT` environment variable (default `true`); set
+`OS_MULTI_TENANT=false` before `objectstack serve` / `pnpm dev` to disable.
+
+## Key Exports
+
+| Export | Kind | Description |
+|:---|:---|:---|
+| `SecurityPlugin` | class | Kernel plugin that installs the four-step security chain. |
+| `PermissionEvaluator` | class | Evaluates object-level CRUD permissions across roles (most-permissive merge). |
+| `RLSCompiler` | class | Compiles RLS expressions into ObjectQL filter AST. |
+| `FieldMasker` | class | Strips non-readable fields and identifies non-editable ones. |
+| `SysRole`, `SysPermissionSet` | objects | Metadata objects registered by the plugin. |
+
+## System objects
+
+The plugin contributes these system objects to the kernel:
+
+| Object | Purpose |
+|:---|:---|
+| `sys_role` | User role definitions. |
+| `sys_permission_set` | Bundles object and field permissions; can include RLS expressions. |
+
+Assignment tables (role ↔ user, role ↔ permission_set) are provided by [`@objectstack/plugin-auth`](../plugin-auth) when used together.
+
+## RLS expression language
+
+RLS policies are authored in the same expression language as object validations. Example:
+
+```json
+{
+  "object": "project_task",
+  "read": "owner_id = $user.id OR team_id in $user.team_ids"
+}
+```
+
+Compilation output is a filter AST merged into every query's `where` clause, so drivers see it as a normal filter.
+
+## When to use
+
+- ✅ Any multi-user deployment.
+- ✅ Enforcing tenant isolation (combine with [`@objectstack/service-tenant`](../../services/service-tenant)).
+
+## When not to use
+
+- ❌ Trusted single-user CLI scripts — disable per-request via the system context.
+
+## Related Packages
+
+- [`@objectstack/plugin-auth`](../plugin-auth) — authentication and user resolution.
+- [`@objectstack/plugin-audit`](../plugin-audit) — pairs with security for full compliance trails.
+- [`@objectstack/objectql`](../../objectql) — query engine.
 
-The plugin registers three core services and executes a 4-step security chain on every data operation:
+## Links
 
-1. **Resolve Permission Sets** — Match user roles to permission set definitions from metadata.
-2. **Check Object Permissions** — Validate CRUD access (`allowRead`, `allowCreate`, `allowEdit`, `allowDelete`).
-3. **Inject RLS Filters** — Compile row-level policy expressions and merge them into the query.
-4. **Mask Fields** — Remove restricted fields from results based on field-level permissions.
+- 📖 Docs: <https://objectstack.ai/docs>
+- 📚 API Reference: <https://objectstack.ai/docs/references/security>
 
 ## License