6 Commits
Author SHA1 Message Date
marc bc05d312a6 feat: permission hooks, isAllowed and permittedOrgs 2026-10-21 14:38:15 +02:00
marc ee15ee0adf ci: stage releases for 2FA approval instead of publishing them
The npm trusted publisher may only stage, so a version goes live once a
maintainer approves it with 2FA. Staging needs npm 11.15 or later; Node 24.12
ships 11.6, so the job installs a pinned npm first.
2026-10-20 13:16:37 +02:00
marc 9b7003a691 ci: publish to npmjs on version tags with trusted publishing
No npm token: the workflow's OIDC identity is the npm trusted publisher, and
npm records provenance for the tag's commit.
2026-10-20 12:39:34 +02:00
marc 10fb0858f6 docs: 1.0.0 release link points at crudylabs/pgmorbac-fastify on GitHub 2026-10-03 15:32:06 +02:00
marc 73d3bc36c8 fix: exports resolve dist only
The source condition pointed consumers at TypeScript sources; it only made sense
inside the crudy monorepo.
2026-10-03 10:00:58 +02:00
marc 94f1f13302 feat: @crudy/pgmorbac-fastify, MIT, its own repository
The Fastify layer over pgmorbac: permission checks, RLS session context,
management routes, PostgREST data proxy, and the migration loader for the SQL
from @crudy/pgmorbac. The SQL is no longer bundled here.
2026-10-03 09:58:18 +02:00
18 changed files with 394 additions and 3250 deletions
-56
View File
@@ -1,56 +0,0 @@
# Per-repo Drone pipeline template for an extracted @crudy/* package or module (RFC 0006).
# Copy this to .drone.yml in the standalone repo. It consumes dependencies from Verdaccio and
# publishes the package on a tag. Set the `verdaccio_url` and `npm_token` Drone secrets.
---
kind: pipeline
type: docker
name: default
trigger:
event:
- push
- pull_request
- tag
steps:
- name: install
image: node:24
environment:
VERDACCIO:
from_secret: verdaccio_url
commands:
- npm ci --registry "$VERDACCIO"
- name: lint
image: node:24
commands:
- npm run --if-present lint -- --max-warnings=0
- name: typecheck
image: node:24
commands:
- npx tsc --noEmit
- name: test
image: node:24
commands:
- npm test --if-present
- name: build
image: node:24
commands:
- npm run --if-present build
- name: publish
image: node:24
environment:
VERDACCIO:
from_secret: verdaccio_url
NPM_TOKEN:
from_secret: npm_token
commands:
- echo "//${VERDACCIO#*://}:_authToken=$NPM_TOKEN" > .npmrc
- npm publish --registry "$VERDACCIO"
when:
event:
- tag
+53
View File
@@ -0,0 +1,53 @@
# Stages @crudy/pgmorbac-fastify to npmjs on version tags (v<major>.<minor>.<patch>)
# through npm trusted publishing: GitHub's OIDC token stands in for an npm
# token, and npm attaches a provenance statement naming this repository and
# commit. The trusted publisher may only stage: a staged version goes live once
# a maintainer approves it with 2FA (npm stage approve, or npmjs.com). The
# organisation only allows its own actions, so checkout and Node setup are
# plain shell. prepack builds dist from src.
name: publish
on:
push:
tags: ['v*']
permissions:
contents: read
id-token: write
jobs:
publish:
runs-on: ubuntu-latest
env:
NODE_VERSION: v24.12.0
steps:
- name: Check out the tag
run: |
case "$GITHUB_REF_NAME" in v[0-9]*.[0-9]*.[0-9]*) ;; *) echo "not a version tag: $GITHUB_REF_NAME" >&2; exit 1 ;; esac
git init -q .
git fetch -q --depth 1 "https://github.com/$GITHUB_REPOSITORY" "refs/tags/$GITHUB_REF_NAME:refs/tags/$GITHUB_REF_NAME"
git checkout -q "refs/tags/$GITHUB_REF_NAME"
- name: Install Node
run: |
base="https://nodejs.org/dist/$NODE_VERSION"
file="node-$NODE_VERSION-linux-x64.tar.xz"
curl -fsSLO "$base/$file"
curl -fsSL "$base/SHASUMS256.txt" | grep " $file\$" | sha256sum -c -
mkdir -p "$RUNNER_TEMP/node"
tar -xJf "$file" -C "$RUNNER_TEMP/node" --strip-components=1
rm "$file"
echo "$RUNNER_TEMP/node/bin" >> "$GITHUB_PATH"
- name: Install npm with staged publishing
run: npm install -g npm@11.21.1
- run: npm install --no-audit --no-fund
- run: npm run check
- name: Publish
run: |
VERSION=$(node -p "require('./package.json').version")
[ "v$VERSION" = "$GITHUB_REF_NAME" ] || { echo "tag $GITHUB_REF_NAME does not match package version $VERSION" >&2; exit 1; }
NAME=$(node -p "require('./package.json').name")
if npm view "$NAME@$VERSION" version >/dev/null 2>&1; then
echo "$NAME@$VERSION is already published"
else
npm stage publish
fi
+3
View File
@@ -0,0 +1,3 @@
node_modules/
dist/
package-lock.json
+11 -1
View File
@@ -5,6 +5,16 @@ All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.1.0] - 2026-10-21
### Added
- `addPermissionHook('pre' | 'post', hook)`: application rules every permission decision runs. Hooks can only refuse; a throwing hook fails the decision.
- `isAllowed` and `permittedOrgs`: the hooked decision without a reply, for one org or several.
### Changed
- `hasPermission`, `hasPermissionAny`, `canPerform`, `canActOnUser`, `canGrantRule`, the user listing and role assignment decide through `isAllowed`, so hooks apply to each.
- The data proxy forwards only the `X-Org-Ids` the caller is allowed in, instead of every listed org once one passed. Rows are unchanged without hooks: RLS already hid the others.
## [1.0.0] - 2026-07-25 ## [1.0.0] - 2026-07-25
### Added ### Added
@@ -22,4 +32,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `withMorbacContext` accepts an org selection, serialised to `morbac.org_ids` - `withMorbacContext` accepts an org selection, serialised to `morbac.org_ids`
where a JSON null element names the unattributed bucket. where a JSON null element names the unattributed bucket.
[1.0.0]: https://git.villains.fr/crudy/pgmorbac-node/releases/tag/v1.0.0 [1.0.0]: https://github.com/crudylabs/pgmorbac-fastify/releases/tag/v1.0.0
+17 -197
View File
@@ -1,201 +1,21 @@
Apache License MIT License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION Copyright (c) 2025-2026 Marc Villain
1. Definitions. Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
"License" shall mean the terms and conditions for use, reproduction, The above copyright notice and this permission notice shall be included in all
and distribution as defined by Sections 1 through 9 of this document. copies or substantial portions of the Software.
"Licensor" shall mean the copyright owner or entity authorized by THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
the copyright owner that is granting the License. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
"Legal Entity" shall mean the union of the acting entity and all AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
other entities that control, are controlled by, or are under common LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
control with that entity. For the purposes of this definition, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
"control" means (i) the power, direct or indirect, to cause the SOFTWARE.
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2025-2026 Marc Villain
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-4
View File
@@ -1,4 +0,0 @@
@crudy/pgmorbac
Copyright 2025-2026 Marc Villain
This product includes software developed as part of the Crudy project.
+36 -20
View File
@@ -1,18 +1,18 @@
# @crudy/pgmorbac # @crudy/pgmorbac-fastify
**Multi-OrBAC permission helpers for Fastify and PostgreSQL.** **Multi-OrBAC permission helpers for Fastify and PostgreSQL.**
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Node](https://img.shields.io/badge/Node-%3E%3D18-brightgreen.svg)](https://nodejs.org/) [![Node](https://img.shields.io/badge/Node-%3E%3D18-brightgreen.svg)](https://nodejs.org/)
This is the Node.js companion to the [`pgmorbac` PostgreSQL extension](https://github.com/crudylabs/pgmorbac). The extension implements the Multi-OrBAC access control model in the database (`morbac` schema); this package wires it into a Fastify backend: permission checks, RLS session context, management routes, a PostgREST data proxy, and the migration loader that ships the extension SQL. This is the Node.js companion to the [`pgmorbac` PostgreSQL extension](https://github.com/crudylabs/pgmorbac). The extension implements the Multi-OrBAC access control model in the database (`morbac` schema); this package wires it into a Fastify backend: permission checks, RLS session context, management routes, a PostgREST data proxy, and the migration loader for the extension SQL from [`@crudy/pgmorbac`](https://www.npmjs.com/package/@crudy/pgmorbac).
> The SQL extension is a separate project under the MIT license. This helper package is Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). > MIT, like the pgmorbac SQL extension it builds on. See [LICENSE](LICENSE).
## Install ## Install
```bash ```bash
npm install @crudy/pgmorbac npm install @crudy/pgmorbac-fastify
``` ```
Peer dependencies (both optional, install the ones you use): `fastify >=5`, `pg >=8`. Peer dependencies (both optional, install the ones you use): `fastify >=5`, `pg >=8`.
@@ -23,14 +23,14 @@ The package is split into focused entry points so you only pull in what you need
| Import | Purpose | | Import | Purpose |
|--------|---------| |--------|---------|
| `@crudy/pgmorbac` | RLS session context and shared domain types | | `@crudy/pgmorbac-fastify` | RLS session context and shared domain types |
| `@crudy/pgmorbac/permissions` | `hasPermission`, org-scope resolution, admin checks | | `@crudy/pgmorbac-fastify/permissions` | `hasPermission`, `isAllowed`, `permittedOrgs`, permission hooks, org-scope resolution, admin checks |
| `@crudy/pgmorbac/proxy` | PostgREST data proxy with per-route permissions | | `@crudy/pgmorbac-fastify/proxy` | PostgREST data proxy with per-route permissions |
| `@crudy/pgmorbac/plugin` | Fastify management routes (orgs, roles, rules, users, delegations) | | `@crudy/pgmorbac-fastify/plugin` | Fastify management routes (orgs, roles, rules, users, delegations) |
| `@crudy/pgmorbac/list-query` | PostgREST-style sort/filter/pagination parsing | | `@crudy/pgmorbac-fastify/list-query` | PostgREST-style sort/filter/pagination parsing |
| `@crudy/pgmorbac/schemas` | JSON schema response fragments | | `@crudy/pgmorbac-fastify/schemas` | JSON schema response fragments |
| `@crudy/pgmorbac/migrations` | Loads the bundled `morbac` extension SQL as migrations | | `@crudy/pgmorbac-fastify/migrations` | Loads the bundled `morbac` extension SQL as migrations |
| `@crudy/pgmorbac/api` | Domain type definitions (`Org`, `Role`, `Rule`, ...) | | `@crudy/pgmorbac-fastify/api` | Domain type definitions (`Org`, `Role`, `Rule`, ...) |
## Usage ## Usage
@@ -39,7 +39,7 @@ The package is split into focused entry points so you only pull in what you need
Every org-scoped route authorizes with `hasPermission`. Authentication is necessary but not sufficient; the check calls `morbac.is_allowed` and requires an `X-Org-Id` header. Every org-scoped route authorizes with `hasPermission`. Authentication is necessary but not sufficient; the check calls `morbac.is_allowed` and requires an `X-Org-Id` header.
```ts ```ts
import { hasPermission } from '@crudy/pgmorbac/permissions'; import { hasPermission } from '@crudy/pgmorbac-fastify/permissions';
app.get('/documents', async (req, reply) => { app.get('/documents', async (req, reply) => {
const orgId = req.headers['x-org-id'] as string; const orgId = req.headers['x-org-id'] as string;
@@ -48,12 +48,27 @@ app.get('/documents', async (req, reply) => {
}); });
``` ```
For a decision without a reply, use `isAllowed(pool, userId, orgId, activity, view)`; for several orgs at once, `permittedOrgs`. Never query `morbac.is_allowed` directly: it skips the hooks below.
### Permission hooks
An application adds its own rules to every decision with `addPermissionHook`. A `pre` hook runs before morbac is asked and a `post` hook receives morbac's answer. Either can only refuse: a decision is allowed when morbac allows it and every hook returns `true`. A hook that throws fails the decision with its error.
```ts
import { addPermissionHook } from '@crudy/pgmorbac-fastify/permissions';
// No action in an org whose subscription lapsed.
addPermissionHook('pre', async ({ orgId }) => orgId === null || await subscriptionActive(orgId));
```
The hooks run in `hasPermission`, `hasPermissionAny`, `canPerform`, `canActOnUser`, `canGrantRule`, `isAllowed`, `permittedOrgs` and the data proxy, which forwards only the `X-Org-Ids` the caller is allowed in. `hasAnyPermission` names no org and runs none. Row-level security evaluates morbac alone, so a rule that must also hide rows belongs in the database.
### RLS session context ### RLS session context
Run queries under the acting user so `morbac` row-level security policies apply as a second gate behind `hasPermission`. Required for non-`BYPASSRLS` runtime roles. Run queries under the acting user so `morbac` row-level security policies apply as a second gate behind `hasPermission`. Required for non-`BYPASSRLS` runtime roles.
```ts ```ts
import { withMorbacContext } from '@crudy/pgmorbac'; import { withMorbacContext } from '@crudy/pgmorbac-fastify';
const rows = await withMorbacContext(pool, { userId, orgId }, async (client) => { const rows = await withMorbacContext(pool, { userId, orgId }, async (client) => {
const { rows } = await client.query('SELECT * FROM app.orgs'); const { rows } = await client.query('SELECT * FROM app.orgs');
@@ -66,7 +81,7 @@ const rows = await withMorbacContext(pool, { userId, orgId }, async (client) =>
Expose an `app`-schema table through the backend with an explicit permission. A path that is never registered does not exist (fail closed). Expose an `app`-schema table through the backend with an explicit permission. A path that is never registered does not exist (fail closed).
```ts ```ts
import { createProxyRegistry } from '@crudy/pgmorbac/proxy'; import { createProxyRegistry } from '@crudy/pgmorbac-fastify/proxy';
const proxy = createProxyRegistry(pool, process.env.POSTGREST_URL!); const proxy = createProxyRegistry(pool, process.env.POSTGREST_URL!);
proxy.proxyDataRoute(app, 'GET', '/data/documents', 'documents', { activity: 'read', view: 'documents' }); proxy.proxyDataRoute(app, 'GET', '/data/documents', 'documents', { activity: 'read', view: 'documents' });
@@ -76,10 +91,10 @@ Pass `null` as the permission for any-authenticated-user access with no org chec
### Migrations ### Migrations
The extension SQL ships inside this package (`sql/pgmorbac--<version>.sql`, plus `sql/upgrades/`). Feed it to your migration runner before your own DDL. `morbacMigrations()` returns the extension SQL from `@crudy/pgmorbac` (install script plus upgrade scripts) ready for your migration runner. Feed it before your own DDL.
```ts ```ts
import { morbacMigrations } from '@crudy/pgmorbac/migrations'; import { morbacMigrations } from '@crudy/pgmorbac-fastify/migrations';
for (const { filename, sql } of morbacMigrations()) { for (const { filename, sql } of morbacMigrations()) {
await runMigration(filename, sql); await runMigration(filename, sql);
@@ -93,7 +108,7 @@ The base script keeps the historical filename `0001_morbac.sql` so `schema_migra
Register CRUD routes for orgs, roles, rules, users, global rules, activities, and delegations. Supply optional hooks for license-limit enforcement and event emission. Register CRUD routes for orgs, roles, rules, users, global rules, activities, and delegations. Supply optional hooks for license-limit enforcement and event emission.
```ts ```ts
import { createMgmtRoutes } from '@crudy/pgmorbac/plugin'; import { createMgmtRoutes } from '@crudy/pgmorbac-fastify/plugin';
createMgmtRoutes({ createMgmtRoutes({
db: pool, db: pool,
@@ -107,6 +122,7 @@ createMgmtRoutes({
- **Deny by default.** Unregistered routes do not exist; unauthorized reads return `404` over `403` to avoid enumeration. - **Deny by default.** Unregistered routes do not exist; unauthorized reads return `404` over `403` to avoid enumeration.
- **Reads are checked too.** List and detail routes require the same permission checks as writes. - **Reads are checked too.** List and detail routes require the same permission checks as writes.
- **Two gates stacked.** `hasPermission` (application) plus `morbac` RLS (database) when running under a non-`BYPASSRLS` role. - **Two gates stacked.** `hasPermission` (application) plus `morbac` RLS (database) when running under a non-`BYPASSRLS` role.
- **Hooks only narrow.** An application rule added with `addPermissionHook` can refuse a decision morbac allowed, never allow one it refused.
- **Allowlisted queries.** `list-query` parameterizes values and allowlists sortable/filterable columns; user input is never interpolated. - **Allowlisted queries.** `list-query` parameterizes values and allowlists sortable/filterable columns; user input is never interpolated.
## Related ## Related
@@ -116,4 +132,4 @@ createMgmtRoutes({
## License ## License
Apache-2.0 (c) 2025-2026 Marc Villain. See [LICENSE](LICENSE) and [NOTICE](NOTICE). MIT (c) 2025-2026 Marc Villain. See [LICENSE](LICENSE).
+19 -28
View File
@@ -1,72 +1,65 @@
{ {
"name": "@crudy/pgmorbac", "name": "@crudy/pgmorbac-fastify",
"version": "1.0.0", "version": "1.1.0",
"type": "module", "type": "module",
"description": "Crudy pgmorbac - Multi-OrBAC permission helpers for Fastify and PostgreSQL", "description": "Fastify layer over pgmorbac: permission checks, RLS session context, management routes, PostgREST data proxy, migration loader",
"keywords": [ "keywords": [
"morbac",
"orbac",
"rbac",
"authorization",
"access-control", "access-control",
"postgresql", "authorization",
"fastify", "fastify",
"rls", "morbac",
"multi-tenant" "multi-tenant",
"orbac",
"pgmorbac",
"postgresql",
"rbac",
"rls"
], ],
"author": "Marc Villain", "author": "Marc Villain",
"homepage": "https://pgmorbac.crudy.fr", "homepage": "https://pgmorbac.crudy.fr",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/crudylabs/pgmorbac-node.git" "url": "git+https://github.com/crudylabs/pgmorbac-fastify.git"
}, },
"bugs": { "bugs": {
"url": "https://github.com/crudylabs/pgmorbac-node/issues" "url": "https://github.com/crudylabs/pgmorbac-fastify/issues"
}, },
"license": "MIT",
"exports": { "exports": {
".": { ".": {
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"source": "./src/index.ts",
"default": "./dist/index.js" "default": "./dist/index.js"
}, },
"./permissions": { "./permissions": {
"types": "./dist/permissions.d.ts", "types": "./dist/permissions.d.ts",
"source": "./src/permissions.ts",
"default": "./dist/permissions.js" "default": "./dist/permissions.js"
}, },
"./proxy": { "./proxy": {
"types": "./dist/proxy.d.ts", "types": "./dist/proxy.d.ts",
"source": "./src/proxy.ts",
"default": "./dist/proxy.js" "default": "./dist/proxy.js"
}, },
"./list-query": { "./list-query": {
"types": "./dist/list-query.d.ts", "types": "./dist/list-query.d.ts",
"source": "./src/list-query.ts",
"default": "./dist/list-query.js" "default": "./dist/list-query.js"
}, },
"./rls-context": { "./rls-context": {
"types": "./dist/rls-context.d.ts", "types": "./dist/rls-context.d.ts",
"source": "./src/rls-context.ts",
"default": "./dist/rls-context.js" "default": "./dist/rls-context.js"
}, },
"./plugin": { "./plugin": {
"types": "./dist/plugin.d.ts", "types": "./dist/plugin.d.ts",
"source": "./src/plugin.ts",
"default": "./dist/plugin.js" "default": "./dist/plugin.js"
}, },
"./schemas": { "./schemas": {
"types": "./dist/schemas.d.ts", "types": "./dist/schemas.d.ts",
"source": "./src/schemas.ts",
"default": "./dist/schemas.js" "default": "./dist/schemas.js"
}, },
"./api": { "./api": {
"types": "./dist/api.d.ts", "types": "./dist/api.d.ts",
"source": "./src/api.ts",
"default": "./dist/api.js" "default": "./dist/api.js"
}, },
"./migrations": { "./migrations": {
"types": "./dist/migrations.d.ts", "types": "./dist/migrations.d.ts",
"source": "./src/migrations.ts",
"default": "./dist/migrations.js" "default": "./dist/migrations.js"
} }
}, },
@@ -74,24 +67,23 @@
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"files": [ "files": [
"dist", "dist",
"sql",
"package.json", "package.json",
"src", "src",
"README.md", "README.md",
"CHANGELOG.md", "CHANGELOG.md",
"LICENSE", "LICENSE"
"NOTICE"
], ],
"scripts": { "scripts": {
"build": "tsc", "build": "tsc",
"prepack": "npm run build", "prepack": "npm run build",
"check": "tsc --noEmit" "check": "tsc --noEmit",
"test": "tsc && node --test 'test/*.test.mjs'"
}, },
"publishConfig": { "publishConfig": {
"registry": "http://localhost:4873",
"access": "public" "access": "public"
}, },
"dependencies": { "dependencies": {
"@crudy/pgmorbac": "^1.0.0",
"bcryptjs": "^2" "bcryptjs": "^2"
}, },
"peerDependencies": { "peerDependencies": {
@@ -112,6 +104,5 @@
"fastify": "^5", "fastify": "^5",
"pg": "^8", "pg": "^8",
"typescript": "^5" "typescript": "^5"
}, }
"license": "Apache-2.0"
} }
File diff suppressed because it is too large Load Diff
+6 -3
View File
@@ -243,7 +243,10 @@ export interface MorbacApi {
revokeDelegation(token: string, orgIds: string[], id: string): Promise<null>; revokeDelegation(token: string, orgIds: string[], id: string): Promise<null>;
} }
export function createMorbacApi(apiUrl: string): MorbacApi { // apiUrl may be a function so a browser caller resolves the origin per request
// rather than when its module loads.
export function createMorbacApi(apiUrl: string | (() => string)): MorbacApi {
const base = typeof apiUrl === 'function' ? apiUrl : () => apiUrl;
async function api(method: string, path: string, token: string, orgIds: string[], body?: unknown): Promise<unknown> { async function api(method: string, path: string, token: string, orgIds: string[], body?: unknown): Promise<unknown> {
const headers: Record<string, string> = { const headers: Record<string, string> = {
Authorization: `Bearer ${token}`, Authorization: `Bearer ${token}`,
@@ -254,7 +257,7 @@ export function createMorbacApi(apiUrl: string): MorbacApi {
headers['X-Org-Ids'] = orgIds.join(','); headers['X-Org-Ids'] = orgIds.join(',');
} }
if (body !== undefined) headers['Content-Type'] = 'application/json'; if (body !== undefined) headers['Content-Type'] = 'application/json';
const res = await fetch(`${apiUrl}${path}`, { const res = await fetch(`${base()}${path}`, {
method, method,
headers, headers,
credentials: 'include', credentials: 'include',
@@ -279,7 +282,7 @@ export function createMorbacApi(apiUrl: string): MorbacApi {
const PERM_TTL_MS = 30_000; const PERM_TTL_MS = 30_000;
async function fetchPermission(token: string, orgId: string, activity: string, view: string): Promise<boolean> { async function fetchPermission(token: string, orgId: string, activity: string, view: string): Promise<boolean> {
const res = await fetch(`${apiUrl}/me/permissions/check`, { const res = await fetch(`${base()}/me/permissions/check`, {
method: 'POST', method: 'POST',
headers: { headers: {
Authorization: `Bearer ${token}`, Authorization: `Bearer ${token}`,
+3
View File
@@ -6,9 +6,12 @@ export {
orgSelectionToSetting, orgSelectionToSetting,
orgTargetsToHeader, orgTargetsToHeader,
hasAnyPermission, hasAnyPermission,
isAllowed,
permittedOrgs,
type OrgTarget, type OrgTarget,
type OrgSelection, type OrgSelection,
} from './permissions.js'; } from './permissions.js';
export { addPermissionHook, type PermissionCheck, type PrePermissionHook, type PostPermissionHook } from './permission-hooks.js';
export type { DataPermission } from './proxy.js'; export type { DataPermission } from './proxy.js';
export type { export type {
Org, Org,
+20 -32
View File
@@ -1,40 +1,28 @@
import { readFileSync, readdirSync, existsSync } from 'fs'; import { extensionSql, upgradeScripts, version } from '@crudy/pgmorbac';
import { fileURLToPath } from 'url';
import { dirname, join } from 'path';
const sqlDir = join(dirname(fileURLToPath(import.meta.url)), '..', 'sql');
export interface MorbacMigration { export interface MorbacMigration {
filename: string; filename: string;
sql: string; sql: string;
} }
// The morbac schema ships with this package as a PGXN-style extension script // The pgmorbac install and upgrade scripts (from @crudy/pgmorbac) as plain
// (sql/pgmorbac--<version>.sql) plus upgrade scripts (sql/upgrades/). For the // migrations for a migration runner. Without CREATE EXTENSION the morbac schema is
// crudy migration runner they are exposed as plain migrations: the base script // created up front, and the installed version is recorded. The base keeps the
// keeps the historical filename 0001_morbac.sql so schema_migrations rows on // historical filename 0001_morbac.sql so schema_migrations rows on existing
// existing databases stay valid, and upgrade scripts follow in version order // databases stay valid; its bytes must not change for an unchanged extension
// as 0001_morbac--<old>--<new>.sql. // version, or boot re-runs it. Upgrades follow as 0001_morbac--<old>--<new>.sql.
export function morbacMigrations(): MorbacMigration[] { export function morbacMigrations(): MorbacMigration[] {
const base = readdirSync(sqlDir) const lines = extensionSql().split('\n');
.filter(f => /^pgmorbac--\d+\.\d+\.\d+\.sql$/.test(f)) lines.splice(lines.indexOf('') + 1, 0, 'CREATE SCHEMA IF NOT EXISTS morbac;');
.sort(); const sql = lines.join('\n') + `
if (base.length !== 1) { -- Record the installed schema version (readable via
throw new Error(`[pgmorbac] Expected exactly one base script in ${sqlDir}, found ${base.length}`); -- morbac.get_config('schema_version'); upgrade scripts bump it).
} INSERT INTO morbac.config (key, value, description)
const migrations: MorbacMigration[] = [{ VALUES ('schema_version', '${version}', 'Installed pgmorbac schema version')
filename: '0001_morbac.sql', ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value, updated_at = CURRENT_TIMESTAMP;
sql: readFileSync(join(sqlDir, base[0]), 'utf8'), `;
}]; return [
{ filename: '0001_morbac.sql', sql },
const upgradesDir = join(sqlDir, 'upgrades'); ...upgradeScripts().map(u => ({ filename: `0001_morbac--${u.from}--${u.to}.sql`, sql: u.sql })),
if (existsSync(upgradesDir)) { ];
for (const f of readdirSync(upgradesDir).filter(n => n.endsWith('.sql')).sort()) {
migrations.push({
filename: `0001_morbac${f.replace(/^pgmorbac/, '').replace(/\.sql$/, '')}.sql`,
sql: readFileSync(join(upgradesDir, f), 'utf8'),
});
}
}
return migrations;
} }
+55
View File
@@ -0,0 +1,55 @@
import type { FastifyRequest } from 'fastify';
import type { Pool } from 'pg';
/** One permission decision: may this user perform (activity, view) in this org. */
export interface PermissionCheck {
userId: string;
/** The org acted in, or null for the no-org perimeter. */
orgId: string | null;
activity: string;
view: string;
/** The request behind the decision, when there is one. */
req?: FastifyRequest;
}
/** Runs before morbac is asked. Returning false refuses without asking it. */
export type PrePermissionHook = (check: PermissionCheck, db: Pool) => boolean | Promise<boolean>;
/** Runs after morbac answered, with that answer. Returning false refuses. */
export type PostPermissionHook = (check: PermissionCheck, allowed: boolean, db: Pool) => boolean | Promise<boolean>;
const pre: PrePermissionHook[] = [];
const post: PostPermissionHook[] = [];
/**
* Adds an application rule to every permission decision the helpers make. A
* hook can only narrow: a decision is allowed when morbac allows it and every
* hook agrees, so no hook can grant what morbac refused. A hook that throws
* fails the decision with its error; nothing is swallowed into an allow.
* Returns a function that removes the hook.
*/
export function addPermissionHook(phase: 'pre', hook: PrePermissionHook): () => void;
export function addPermissionHook(phase: 'post', hook: PostPermissionHook): () => void;
export function addPermissionHook(phase: 'pre' | 'post', hook: PrePermissionHook | PostPermissionHook): () => void {
const list = (phase === 'pre' ? pre : post) as unknown[];
list.push(hook);
return () => {
const i = list.indexOf(hook);
if (i !== -1) list.splice(i, 1);
};
}
export async function runPreHooks(check: PermissionCheck, db: Pool): Promise<boolean> {
for (const hook of pre) {
if (await hook(check, db) !== true) return false;
}
return true;
}
export async function runPostHooks(check: PermissionCheck, allowed: boolean, db: Pool): Promise<boolean> {
let result = allowed;
for (const hook of post) {
if (await hook(check, allowed, db) !== true) result = false;
}
return result;
}
+69 -42
View File
@@ -1,5 +1,8 @@
import type { FastifyRequest, FastifyReply } from 'fastify'; import type { FastifyRequest, FastifyReply } from 'fastify';
import type { Pool } from 'pg'; import type { Pool } from 'pg';
import { runPostHooks, runPreHooks } from './permission-hooks.js';
export { addPermissionHook, type PermissionCheck, type PrePermissionHook, type PostPermissionHook } from './permission-hooks.js';
export const SYSTEM_ORG_ID = '00000000-0000-0000-0000-000000000000'; export const SYSTEM_ORG_ID = '00000000-0000-0000-0000-000000000000';
@@ -122,18 +125,12 @@ export async function canActOnUser(
activity: string, activity: string,
view: string, view: string,
): Promise<boolean> { ): Promise<boolean> {
const { rows } = await db.query<{ ok: boolean }>( if (await isAllowed(db, callerId, null, activity, view)) return true;
`SELECT ( const { rows } = await db.query<{ org_id: string }>(
morbac.is_allowed($1::UUID, NULL::UUID, $3, $4) 'SELECT DISTINCT org_id FROM morbac.user_roles WHERE user_id = $1::UUID',
OR EXISTS ( [targetUserId],
SELECT 1 FROM morbac.user_roles ur
WHERE ur.user_id = $2::UUID
AND morbac.is_allowed($1::UUID, ur.org_id, $3, $4)
)
) AS ok`,
[callerId, targetUserId, activity, view],
); );
return rows[0]?.ok ?? false; return (await permittedOrgs(db, callerId, rows.map((r) => r.org_id), activity, view)).length > 0;
} }
/** True if the caller may reach org (activity, view) at every org that a rule /** True if the caller may reach org (activity, view) at every org that a rule
@@ -153,20 +150,14 @@ export async function canGrantRule(
activity: string, activity: string,
view: string, view: string,
): Promise<boolean> { ): Promise<boolean> {
const { rows } = await db.query<{ ok: boolean }>( const { rows } = await db.query<{ org_id: string }>(
`SELECT ( 'SELECT org_id FROM morbac.get_org_scope($1::UUID, $2) AS s(org_id)',
NOT EXISTS ( [ruleOrgId, scope],
SELECT 1 FROM morbac.get_org_scope($2::UUID, $3) AS s(org_id)
WHERE NOT morbac.is_allowed($1::UUID, s.org_id, $4, $5)
)
AND (
$3 NOT IN ('unattributed', 'all')
OR morbac.is_allowed($1::UUID, NULL::UUID, $4, $5)
)
) AS ok`,
[callerId, ruleOrgId, scope, activity, view],
); );
return rows[0]?.ok ?? false; const covered = rows.map((r) => r.org_id);
if ((await permittedOrgs(db, callerId, covered, activity, view)).length !== covered.length) return false;
if (scope !== 'unattributed' && scope !== 'all') return true;
return isAllowed(db, callerId, null, activity, view);
} }
/** True iff (activity, view) has an explicit row in morbac.activity_view_bindings. /** True iff (activity, view) has an explicit row in morbac.activity_view_bindings.
@@ -211,7 +202,8 @@ export async function requireGlobalAdmin(db: Pool, req: FastifyRequest, reply: F
/** True if the user may perform (activity, view) in ANY context: any org they /** True if the user may perform (activity, view) in ANY context: any org they
* belong to, unattributed objects, or via a global rule. For deciding whether * belong to, unattributed objects, or via a global rule. For deciding whether
* to expose a feature at all -- never a substitute for the per-object check. */ * to expose a feature at all -- never a substitute for the per-object check.
* Names no org, so permission hooks do not run. */
export async function hasAnyPermission( export async function hasAnyPermission(
db: Pool, db: Pool,
userId: string, userId: string,
@@ -245,11 +237,7 @@ export async function canPerform(
if (!user) return false; if (!user) return false;
const apiKeyScope = ((req as unknown) as Record<string, unknown>).apiKeyScope as ApiKeyScope | undefined; const apiKeyScope = ((req as unknown) as Record<string, unknown>).apiKeyScope as ApiKeyScope | undefined;
if (!scopeAllows(apiKeyScope, activity, target)) return false; if (!scopeAllows(apiKeyScope, activity, target)) return false;
const { rows } = await db.query<{ allowed: boolean }>( return isAllowed(db, user.id, orgId, activity, target, req);
'SELECT morbac.is_allowed($1::UUID, $2::UUID, $3, $4) AS allowed',
[user.id, orgId, activity, target],
);
return rows[0]?.allowed === true;
} }
/** Reads an API key's scope off a request, for callers that must reason about it. */ /** Reads an API key's scope off a request, for callers that must reason about it. */
@@ -277,11 +265,7 @@ export async function hasPermission(
reply.code(403).send({ error: 'Insufficient permissions' }); reply.code(403).send({ error: 'Insufficient permissions' });
return false; return false;
} }
const { rows } = await db.query<{ allowed: boolean }>( if (!await isAllowed(db, user.id, orgId, activity, target, req)) {
'SELECT morbac.is_allowed($1::UUID, $2::UUID, $3, $4) AS allowed',
[user.id, orgId, activity, target],
);
if (!rows[0]?.allowed) {
reply.code(403).send({ error: 'Insufficient permissions' }); reply.code(403).send({ error: 'Insufficient permissions' });
return false; return false;
} }
@@ -312,15 +296,58 @@ export async function hasPermissionAny(
reply.code(403).send({ error: 'Insufficient permissions' }); reply.code(403).send({ error: 'Insufficient permissions' });
return false; return false;
} }
const real = orgIds.filter((v) => v && v.toLowerCase() !== 'unattributed'); const real = orgIds.filter((v) => v && v.toLowerCase() !== UNATTRIBUTED_ORG_TOKEN);
const { rows } = await db.query<{ allowed: boolean }>( if ((await permittedOrgs(db, user.id, real, activity, target, req)).length === 0) {
`SELECT bool_or(morbac.is_allowed($1::UUID, o::UUID, $3, $4)) AS allowed
FROM unnest($2::UUID[]) o`,
[user.id, real, activity, target],
);
if (!rows[0]?.allowed) {
reply.code(403).send({ error: 'Insufficient permissions' }); reply.code(403).send({ error: 'Insufficient permissions' });
return false; return false;
} }
return true; return true;
} }
/**
* The one permission decision every helper makes: morbac's answer, narrowed by
* the application's permission hooks (`addPermissionHook`). Use it instead of
* querying `morbac.is_allowed` directly, which would skip those hooks.
*/
export async function isAllowed(
db: Pool,
userId: string,
orgId: string | null,
activity: string,
view: string,
req?: FastifyRequest,
): Promise<boolean> {
const check = { userId, orgId, activity, view, req };
if (!await runPreHooks(check, db)) return false;
const { rows } = await db.query<{ allowed: boolean }>(
'SELECT morbac.is_allowed($1::UUID, $2::UUID, $3, $4) AS allowed',
[userId, orgId, activity, view],
);
return runPostHooks(check, rows[0]?.allowed === true, db);
}
/** The orgs among `orgIds` where `isAllowed` would answer yes, in their given order, asked of morbac in one query. */
export async function permittedOrgs(
db: Pool,
userId: string,
orgIds: string[],
activity: string,
view: string,
req?: FastifyRequest,
): Promise<string[]> {
const candidates: string[] = [];
for (const orgId of new Set(orgIds)) {
if (await runPreHooks({ userId, orgId, activity, view, req }, db)) candidates.push(orgId);
}
if (candidates.length === 0) return [];
const { rows } = await db.query<{ o: string }>(
'SELECT o FROM unnest($2::UUID[]) o WHERE morbac.is_allowed($1::UUID, o, $3, $4)',
[userId, candidates, activity, view],
);
const allowed = new Set(rows.map((r) => r.o.toLowerCase()));
const out: string[] = [];
for (const orgId of candidates) {
if (await runPostHooks({ userId, orgId, activity, view, req }, allowed.has(orgId.toLowerCase()), db)) out.push(orgId);
}
return out;
}
+11 -7
View File
@@ -1,6 +1,6 @@
import type { FastifyRequest, FastifyReply } from 'fastify'; import type { FastifyRequest, FastifyReply } from 'fastify';
import type { Pool } from 'pg'; import type { Pool } from 'pg';
import { hasPermission, hasPermissionAny } from './permissions.js'; import { checkApiKeyScope, hasPermission, permittedOrgs, UNATTRIBUTED_ORG_TOKEN } from './permissions.js';
export interface DataPermission { export interface DataPermission {
activity: string; activity: string;
@@ -95,13 +95,17 @@ export function createProxyRegistry(db: Pool, postgrestUrl: string): ProxyRegist
return reply; return reply;
} }
} else if (orgIdsVal && orgIdsVal.trim()) { } else if (orgIdsVal && orgIdsVal.trim()) {
// A multi-org list read (e.g. "all organizations"): scoped to the // A multi-org list read (e.g. "all organizations"). Only the orgs
// set via X-Org-Ids. RLS filters each row, so the gate only needs // where the caller is allowed go upstream: RLS filters rows by
// permission in one of them. // morbac alone, so an org a permission hook refused would
// otherwise still show its rows.
if (!checkApiKeyScope(req, reply, permission.activity, permission.view)) return reply;
const ids = orgIdsVal.split(',').map(s => s.trim()).filter(Boolean); const ids = orgIdsVal.split(',').map(s => s.trim()).filter(Boolean);
if (!await hasPermissionAny(db, req, reply, ids, permission.activity, permission.view)) { const unattributed = ids.some((id) => id.toLowerCase() === UNATTRIBUTED_ORG_TOKEN);
return reply; const real = ids.filter((id) => id.toLowerCase() !== UNATTRIBUTED_ORG_TOKEN);
} const allowed = await permittedOrgs(db, user.id, real, permission.activity, permission.view, req);
if (allowed.length === 0) return reply.code(403).send({ error: 'Insufficient permissions' });
req.headers['x-org-ids'] = (unattributed ? [...allowed, UNATTRIBUTED_ORG_TOKEN] : allowed).join(',');
} else { } else {
return reply.code(400).send({ error: 'X-Org-Id header is required' }); return reply.code(400).send({ error: 'X-Org-Id header is required' });
} }
+3 -8
View File
@@ -1,4 +1,5 @@
import type { Pool } from 'pg'; import type { Pool } from 'pg';
import { isAllowed } from '../permissions.js';
/** /**
* Whether the caller may hand out this role at all: assigning it is exercising * Whether the caller may hand out this role at all: assigning it is exercising
@@ -7,12 +8,6 @@ import type { Pool } from 'pg';
export async function callerControlsRoleOrg( export async function callerControlsRoleOrg(
db: Pool, callerId: string, roleId: string, activity: string, db: Pool, callerId: string, roleId: string, activity: string,
): Promise<boolean> { ): Promise<boolean> {
const { rows } = await db.query<{ ok: boolean }>( const { rows } = await db.query<{ org_id: string | null }>('SELECT org_id FROM morbac.roles WHERE id = $1::UUID', [roleId]);
`SELECT EXISTS ( return rows.length > 0 && isAllowed(db, callerId, rows[0].org_id, activity, 'user_roles');
SELECT 1 FROM morbac.roles r
WHERE r.id = $2::UUID AND morbac.is_allowed($1::UUID, r.org_id, $3, 'user_roles')
) AS ok`,
[callerId, roleId, activity],
);
return rows[0]?.ok ?? false;
} }
+5 -11
View File
@@ -4,7 +4,7 @@ import bcrypt from 'bcryptjs';
import type { CheckLimitFn } from '../plugin.js'; import type { CheckLimitFn } from '../plugin.js';
import { import {
getUser, getOrgScope, orgScopeExpr, hasPermission, canActOnUser, checkApiKeyScope, getUser, getOrgScope, orgScopeExpr, hasPermission, canActOnUser, checkApiKeyScope,
getAccountType, viewForType, SYSTEM_ORG_ID, getAccountType, viewForType, isAllowed, SYSTEM_ORG_ID,
} from '../permissions.js'; } from '../permissions.js';
import { userResponse, notFound, forbidden, unauthorized, badRequest } from '../schemas.js'; import { userResponse, notFound, forbidden, unauthorized, badRequest } from '../schemas.js';
import { generatePassword } from '../password.js'; import { generatePassword } from '../password.js';
@@ -37,17 +37,11 @@ export function createUserCrudRoutes(db: Pool, checkLimit?: CheckLimitFn) {
// no-org perimeter (a NULL org), not a claim about every org. Any // no-org perimeter (a NULL org), not a claim about every org. Any
// grant that reaches it answers: a role rule scoped unattributed or // grant that reaches it answers: a role rule scoped unattributed or
// all, a user rule with no org, or a global rule. // all, a user rule with no org, or a global rule.
const [sysRes, svcRes, noOrgRes] = await Promise.all([ const [canSeeSystem, canSeeService, canReadUnattached] = await Promise.all([
db.query<{ allowed: boolean }>('SELECT morbac.is_allowed($1::UUID, $2::UUID, $3, $4) AS allowed', isAllowed(db, user.id, checkOrg, 'read', 'system_users', req),
[user.id, checkOrg, 'read', 'system_users']), isAllowed(db, user.id, checkOrg, 'read', 'service_users', req),
db.query<{ allowed: boolean }>('SELECT morbac.is_allowed($1::UUID, $2::UUID, $3, $4) AS allowed', isAllowed(db, user.id, null, 'read', 'users', req),
[user.id, checkOrg, 'read', 'service_users']),
db.query<{ allowed: boolean }>('SELECT morbac.is_allowed($1::UUID, NULL, $2, $3) AS allowed',
[user.id, 'read', 'users']),
]); ]);
const canSeeSystem = sysRes.rows[0]?.allowed ?? false;
const canSeeService = svcRes.rows[0]?.allowed ?? false;
const canReadUnattached = noOrgRes.rows[0]?.allowed ?? false;
const { expr, params } = orgScopeExpr(orgIds, 'ur2.org_id'); const { expr, params } = orgScopeExpr(orgIds, 'ur2.org_id');
const isSystemScope = orgIds.includes(SYSTEM_ORG_ID); const isSystemScope = orgIds.includes(SYSTEM_ORG_ID);
+83
View File
@@ -0,0 +1,83 @@
import { test, beforeEach } from 'node:test';
import assert from 'node:assert/strict';
import { addPermissionHook, isAllowed, permittedOrgs } from '../dist/index.js';
import { hasPermission, canActOnUser, canGrantRule } from '../dist/permissions.js';
const A = '00000000-0000-4000-8000-00000000000a';
const B = '00000000-0000-4000-8000-00000000000b';
// morbac allows everything in `allowed` (null = the no-org perimeter).
function fakeDb(allowed, extra = {}) {
return {
async query(sql, params) {
if (sql.includes('unnest')) return { rows: params[1].filter((o) => allowed.has(o)).map((o) => ({ o })) };
if (sql.includes('morbac.is_allowed')) return { rows: [{ allowed: allowed.has(params[1]) }] };
if (sql.includes('user_roles')) return { rows: (extra.memberships ?? []).map((org_id) => ({ org_id })) };
if (sql.includes('get_org_scope')) return { rows: (extra.scope ?? []).map((org_id) => ({ org_id })) };
throw new Error(`unexpected query ${sql}`);
},
};
}
let removers = [];
beforeEach(() => { removers.forEach((r) => r()); removers = []; });
const hook = (phase, fn) => removers.push(addPermissionHook(phase, fn));
test('without hooks the answer is morbac\'s', async () => {
assert.equal(await isAllowed(fakeDb(new Set([A])), 'u', A, 'read', 'x'), true);
assert.equal(await isAllowed(fakeDb(new Set()), 'u', A, 'read', 'x'), false);
});
test('a pre hook refuses without asking morbac', async () => {
const db = fakeDb(new Set([A]));
let asked = false;
const query = db.query.bind(db);
db.query = async (...a) => { asked = true; return query(...a); };
hook('pre', (c) => c.orgId !== A);
assert.equal(await isAllowed(db, 'u', A, 'read', 'x'), false);
assert.equal(asked, false);
});
test('no hook can grant what morbac refused', async () => {
hook('pre', () => true);
hook('post', () => true);
assert.equal(await isAllowed(fakeDb(new Set()), 'u', A, 'read', 'x'), false);
});
test('a post hook sees the answer and can refuse it', async () => {
const seen = [];
hook('post', (c, allowed) => { seen.push(allowed); return c.activity !== 'delete'; });
assert.equal(await isAllowed(fakeDb(new Set([A])), 'u', A, 'delete', 'x'), false);
assert.equal(await isAllowed(fakeDb(new Set([A])), 'u', A, 'read', 'x'), true);
assert.deepEqual(seen, [true, true]);
});
test('a hook that is not exactly true refuses', async () => {
hook('pre', () => undefined);
assert.equal(await isAllowed(fakeDb(new Set([A])), 'u', A, 'read', 'x'), false);
});
test('a throwing hook fails the decision rather than allowing it', async () => {
hook('pre', () => { throw new Error('boom'); });
await assert.rejects(isAllowed(fakeDb(new Set([A])), 'u', A, 'read', 'x'), /boom/);
});
test('permittedOrgs drops the orgs a hook refuses', async () => {
hook('pre', (c) => c.orgId !== B);
assert.deepEqual(await permittedOrgs(fakeDb(new Set([A, B])), 'u', [A, B], 'read', 'x'), [A]);
});
test('hasPermission answers 403 when a hook refuses', async () => {
hook('pre', () => false);
let code;
const reply = { code(c) { code = c; return this; }, send() { return this; } };
assert.equal(await hasPermission(fakeDb(new Set([A])), { user: { id: 'u' } }, reply, A, 'read', 'x'), false);
assert.equal(code, 403);
});
test('canActOnUser and canGrantRule go through the hooks', async () => {
hook('pre', (c) => c.orgId !== B);
assert.equal(await canActOnUser(fakeDb(new Set([B]), { memberships: [B] }), 'u', 't', 'update', 'users'), false);
assert.equal(await canGrantRule(fakeDb(new Set([A, B]), { scope: [A, B] }), 'u', A, 'subtree', 'read', 'x'), false);
assert.equal(await canGrantRule(fakeDb(new Set([A])), 'u', A, 'self', 'read', 'x'), true);
});