-
-
Notifications
You must be signed in to change notification settings - Fork 2
plugin access controls
RBAC + ABAC authorization system with role hierarchy, pattern matching, and permission caching. Pro plugin.
Requires: a Pro license tier or higher. Set it with
nself license set nself_pro_...before installing.
nself license set nself_pro_xxxxx...
nself plugin install access-controlsExtends ɳSelf Auth with fine-grained authorization. It implements both Role-Based Access Control (RBAC) and Attribute-Based Access Control (ABAC) in one policy engine on port 3027.
-
RBAC mode: define roles with fine-grained permissions. Roles support a parent-child hierarchy, so a child role inherits its parent's permissions. Permissions accept wildcard patterns such as
posts:*or*. - ABAC mode: define policy rules with conditions and patterns that evaluate at request time. Policies carry a priority and an enabled flag, and the engine resolves them against the request context.
- Scoped roles: assign a role with a specific scope, for example a channel moderator.
- Caching: permission results are cached in memory with a configurable TTL for fast repeat checks.
-
Multi-app isolation: every record is scoped by
source_account_id, so independent apps in one nSelf deploy never see each other's roles or policies.
| Env Var | Default | Description |
|---|---|---|
ACL_PLUGIN_PORT |
3027 |
Access controls service port |
ACL_CACHE_TTL_SECONDS |
300 |
Permission cache TTL in seconds |
ACL_MAX_ROLE_DEPTH |
10 |
Maximum depth for role-hierarchy inheritance |
ACL_DEFAULT_DENY |
true |
Deny when no role or policy grants access |
ACL_API_KEY |
(unset) | API key for service-to-service auth |
ACCESS_CONTROLS_ALLOWED_ORIGINS |
(unset) | Comma-separated CORS allow-list |
DATABASE_URL |
(required) | Postgres connection string |
| Port | Purpose |
|---|---|
| 3027 | Access controls REST API |
6 tables are added to your Postgres database. Every table is scoped by source_account_id for multi-app isolation:
-
acl_roles, role definitions with parent-child hierarchy -
acl_permissions, permission definitions -
acl_role_permissions, role-to-permission mappings -
acl_user_roles, user-to-role assignments -
acl_policies, ABAC policy rules with priority and enabled flag -
acl_webhook_events, event log
The service exposes a versioned REST API under /v1:
| Method | Path | Purpose |
|---|---|---|
| POST | /v1/authorize |
Check a single authorization decision |
| POST | /v1/authorize/batch |
Check authorization in batch |
| POST | /v1/roles |
Create a role |
| GET | /v1/roles |
List roles |
| GET | /v1/roles/hierarchy |
Get the role hierarchy |
| POST | /v1/permissions |
Create a permission |
| POST | /v1/users/:userId/roles |
Assign a role to a user |
| GET | /v1/users/:userId/permissions |
Get a user's effective permissions |
| POST | /v1/policies |
Create an ABAC policy |
| POST | /v1/cache/invalidate |
Invalidate the permission cache |
| GET | /v1/cache/stats |
Read cache statistics |
| GET | /health |
Health check |
Use the /v1/authorize endpoint from your app or a Hasura action to gate access before a mutation or query runs. Because the engine owns the policy decision, you do not duplicate the rules in Hasura permissions. Hasura still enforces per-row source_account_id filtering, and this plugin enforces the role and policy decision on top.
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · docs.nself.org
Getting Started
Commands
- Commands, Overview
- Lifecycle: cmd-init · cmd-build · cmd-start · cmd-stop · cmd-restart · cmd-dev
- Monitoring: cmd-status · cmd-logs · cmd-health · cmd-urls · cmd-doctor · cmd-monitor · cmd-alerts · cmd-sentry · cmd-watchdog · cmd-dogfood
- Data: cmd-db · cmd-backup · cmd-dr · cmd-queue · cmd-webhooks
- Config: cmd-config · cmd-service · cmd-env · cmd-promote
- Networking: cmd-ssl · cmd-trust · cmd-dns-setup
- Security: cmd-security · cmd-secrets · cmd-waf
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license
- AI: cmd-ai · cmd-claw · cmd-model
- Templates: cmd-template
- Utilities: cmd-exec · cmd-clean · cmd-reset · cmd-update · cmd-upgrade · cmd-version · cmd-admin · cmd-migrate · cmd-migrate-firebase · cmd-migrate-supabase · cmd-completion
Features
- Features, Overview
- Feature-Auth
- Feature-Storage
- Feature-Search
- Feature-Functions
- Feature-Email
- Feature-Monitoring
- Feature-Plugins
- Feature-ɳClaw, AI Assistant
- Feature-ɳChat, Messaging
- Feature-ɳTV, Media Player
- Feature-ɳFamily, Family Social
- Feature-ɳCloud, Managed Hosting
- Feature-Memory-Rooms, Knowledge Organization
- Feature-Agent-Dashboard, Agent Metrics
- Feature-Image-Generation, AI Image Generation
Configuration
- Configuration, Overview
- Config-Env-Vars
- Config-Postgres
- Config-Hasura
- Config-Auth
- Config-Nginx
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
Free (25)
- plugin-backup
- plugin-content-acquisition
- plugin-content-progress
- plugin-cron
- plugin-donorbox
- plugin-feature-flags
- plugin-github
- plugin-github-runner
- plugin-invitations
- plugin-jobs
- plugin-link-preview
- plugin-mdns
- plugin-mlflow
- plugin-monitoring
- plugin-notifications
- plugin-notify
- plugin-paypal
- plugin-search
- plugin-shopify
- plugin-stripe
- plugin-subtitle-manager
- plugin-tokens
- plugin-torrent-manager
- plugin-vpn
- plugin-webhooks
Pro (62)
- plugin-access-controls
- plugin-activity-feed
- plugin-admin-api
- nself-ai-gateway
- nself-ai-cc
- nself-ai-mcp
- plugin-analytics
- plugin-auth
- plugin-backup-pro
- plugin-bots
- plugin-browser
- plugin-calendar
- plugin-cdn
- plugin-chat
- plugin-claw
- plugin-claw-budget
- plugin-claw-news
- plugin-claw-web
- plugin-cloudflare
- plugin-cms
- plugin-compliance
- plugin-cron-pro
- plugin-ddns
- plugin-devices
- plugin-documents
- plugin-donorbox-pro
- plugin-entitlements
- plugin-epg
- plugin-file-processing
- plugin-game-metadata
- plugin-geocoding
- plugin-geolocation
- plugin-google
- plugin-home
- plugin-idme
- plugin-knowledge-base
- plugin-linkedin
- plugin-livekit
- plugin-media-processing
- plugin-meetings
- plugin-moderation
- plugin-mux
- plugin-notify-pro
- plugin-object-storage
- plugin-observability
- plugin-paypal-pro
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-recording
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-shopify-pro
- plugin-social
- plugin-sports
- plugin-stream-gateway
- plugin-streaming
- plugin-stripe-pro
- plugin-support
- plugin-tmdb
- plugin-voice
- plugin-web3
- plugin-workflows
Planned (26)
plugin-auditplugin-blogplugin-checkoutplugin-commerceplugin-drmplugin-exportplugin-flowplugin-importplugin-ldapplugin-mailgunplugin-mediaplugin-oauth-providersplugin-pagesplugin-postmarkplugin-rate-limitplugin-reportsplugin-samlplugin-schedulerplugin-sendgridplugin-ssoplugin-subscriptionplugin-thumbplugin-transcoderplugin-twilioplugin-wafplugin-watermark
Guides
- Guide-Production-Deployment
- Guide-SSL-Setup
- Guide-Multi-Tenancy
- Guide-Security-Hardening
- Guide-Monitoring-Setup
- Guide-Backup-Restore
- Guide-Custom-Services
- Guide-Migration-from-v1
Architecture
Reference
- API-Reference
- reference-error-codes, Error Codes
Licensing
Security
Brand
Operations
- operations/release-cascade, Release Cascade
- operations/self-healing, Self-Healing Schema
- operations/redis-tuning, Redis Pool Tuning
- operations/meilisearch-warmup, MeiliSearch Warm-Up
- operations/jwt-rotation, JWT Key Rotation
- operations/windows-wsl2-setup, Windows / WSL2 Setup
- operations/gemini-oauth-reauth, Gemini OAuth Reauth
Contributing
Admin
- USER-ACTION-QUEUE, Pending Admin Actions