diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4dcbe60 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog + +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/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.1.0] - 2026-07-22 + +### Added +- Initial release of the Node.js companion to the `pgmorbac` PostgreSQL extension. +- `hasPermission` and org-scope helpers backed by `morbac.is_allowed`. +- PostgREST data proxy with per-route permissions and a hard page-size cap. +- Fastify management routes for orgs, roles, rules, users, global rules, activities, and delegations. +- JSON schema response fragments and shared domain types. + +[0.1.0]: https://git.villains.fr/crudy/pgmorbac-node/releases/tag/v0.1.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dc94a5b --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + 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. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..0b11931 --- /dev/null +++ b/NOTICE @@ -0,0 +1,4 @@ +@crudy/pgmorbac +Copyright 2025-2026 Marc Villain + +This product includes software developed as part of the Crudy project. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2065719 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# @crudy/pgmorbac + +**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) +[![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://git.villains.fr/crudy/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, a PostgREST data proxy, management routes, and the JSON schemas and domain types that go with them. + +> The SQL extension is a separate project under the MIT license. This helper package is Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). + +## Install + +```bash +npm install @crudy/pgmorbac +``` + +Peer dependencies (both optional, install the ones you use): `fastify >=5`, `pg >=8`. + +## Exports + +The package is split into focused entry points so you only pull in what you need. + +| Import | Purpose | +|--------|---------| +| `@crudy/pgmorbac` | Shared domain types (`DataPermission`, `Org`, `Role`, `Rule`, ...) | +| `@crudy/pgmorbac/permissions` | `hasPermission`, org-scope resolution, admin checks | +| `@crudy/pgmorbac/proxy` | PostgREST data proxy with per-route permissions | +| `@crudy/pgmorbac/plugin` | Fastify management routes (orgs, roles, rules, users, delegations) | +| `@crudy/pgmorbac/schemas` | JSON schema response fragments | +| `@crudy/pgmorbac/api` | Domain type definitions | + +## Usage + +### Permission checks + +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 +import { hasPermission } from '@crudy/pgmorbac/permissions'; + +app.get('/documents', async (req, reply) => { + const orgId = req.headers['x-org-id'] as string; + if (!(await hasPermission(pool, req, reply, orgId, 'read', 'documents'))) return; + // ... authorized: read and return rows +}); +``` + +### Data proxy + +Expose an `app`-schema table through the backend with an explicit permission. A path that is never registered does not exist (fail closed). + +```ts +import { createProxyRegistry } from '@crudy/pgmorbac/proxy'; + +const proxy = createProxyRegistry(pool, process.env.POSTGREST_URL!); +proxy.proxyDataRoute(app, 'GET', '/data/documents', 'documents', { activity: 'read', view: 'documents' }); +``` + +Pass `null` as the permission for any-authenticated-user access with no org check. Page size is capped at `MAX_PAGE_LIMIT` (1000); over-large `limit` values are rejected, never silently clamped. + +### Management routes + +Register CRUD routes for orgs, roles, rules, users, global rules, activities, and delegations. Supply optional hooks for license-limit enforcement and event emission. + +```ts +import { createMgmtRoutes } from '@crudy/pgmorbac/plugin'; + +createMgmtRoutes({ + db: pool, + checkLimit: async (reply, name, sql, params) => { /* enforce quotas */ return true; }, + emitOrgEvent: (event) => { /* audit / notify */ }, +}); +``` + +## Security model + +- **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. +- **Allowlisted queries.** Values are parameterized and columns allowlisted; user input is never interpolated. + +## Related + +- [pgmorbac](https://git.villains.fr/crudy/pgmorbac) — the PostgreSQL extension (MIT) +- [Documentation](https://pgmorbac.villains.fr) — model, architecture, integration guides + +## License + +Apache-2.0 (c) 2025-2026 Marc Villain. See [LICENSE](LICENSE) and [NOTICE](NOTICE). diff --git a/package.json b/package.json index 67e80e4..d7cb938 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,28 @@ "name": "@crudy/pgmorbac", "version": "0.1.0", "type": "module", - "description": "Crudy pgmorbac — Multi-OrBAC permission helpers for Fastify and PostgreSQL", + "description": "Crudy pgmorbac - Multi-OrBAC permission helpers for Fastify and PostgreSQL", + "license": "Apache-2.0", + "keywords": [ + "morbac", + "orbac", + "rbac", + "authorization", + "access-control", + "postgresql", + "fastify", + "rls", + "multi-tenant" + ], + "author": "Marc Villain", + "homepage": "https://pgmorbac.villains.fr", + "repository": { + "type": "git", + "url": "https://git.villains.fr/crudy/pgmorbac-node.git" + }, + "bugs": { + "url": "https://git.villains.fr/crudy/pgmorbac-node/issues" + }, "exports": { ".": { "types": "./dist/index.d.ts", "source": "./src/index.ts", "default": "./dist/index.js" }, "./permissions": { "types": "./dist/permissions.d.ts", "source": "./src/permissions.ts", "default": "./dist/permissions.js" }, @@ -13,7 +34,7 @@ }, "main": "./dist/index.js", "types": "./dist/index.d.ts", - "files": ["dist", "package.json"], + "files": ["dist", "package.json", "README.md", "CHANGELOG.md", "LICENSE", "NOTICE"], "scripts": { "build": "tsc", "prepack": "npm run build"