@azlib/identity 0.2.0

package/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 [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,387 @@
+# @azlib/identity
+
+Storage-agnostic authentication and authorization foundation for Node.js services.
+
+`@azlib/identity` provides a shared core for registration, login, JWT access tokens,
+rotating refresh sessions, predefined relational schema artifacts, and deny-by-default
+authorization. Express and NestJS integrations are thin wrappers over the same core so
+you can plug the package into your own database engine and transport layer.
+
+## Entry points
+
+| Import | Purpose |
+| --- | --- |
+| `@azlib/identity` | Framework-agnostic types, config, errors, authorization, store contract |
+| `@azlib/identity/node` | Node runtime services (password hashing, JWT, register/login/refresh) |
+| `@azlib/identity/express` | Express authentication and authorization middleware |
+| `@azlib/identity/nestjs` | NestJS module, guards, and decorators |
+| `@azlib/identity/schema/*` | Predefined SQL and Prisma schema artifacts |
+
+## Quick start (Express)
+
+1. Apply a schema artifact to your database, e.g. Postgres:
+
+   ```sh
+   psql "$DATABASE_URL" -f node_modules/@azlib/identity/schema/postgres.sql
+   ```
+
+2. Implement the `IdentityStore` contract against your database (or use the bundled
+   in-memory store from `@azlib/identity/test-utils` to prototype).
+
+3. **Mount the pre-built router** — one import, one `app.use` call:
+
+   ```ts
+   import express from "express";
+   import { createIdentityService } from "@azlib/identity/node";
+   import { createIdentityRouter, identityErrorHandler } from "@azlib/identity/express";
+
+   const service = createIdentityService(
+     { accessTokenSecret: process.env.ACCESS_TOKEN_SECRET! },
+     store, // your IdentityStore
+   );
+
+   const app = express();
+   app.use(express.json());
+   app.use("/auth", createIdentityRouter(service));
+   app.use(identityErrorHandler); // converts IdentityError → JSON
+   ```
+
+   That's it. The following endpoints are ready immediately:
+
+   | Method | Path | Description |
+   |--------|------|-------------|
+   | `POST` | `/auth/register` | Create a new account |
+   | `POST` | `/auth/login` | Email + password login |
+   | `POST` | `/auth/refresh` | Rotate the refresh token |
+   | `POST` | `/auth/logout` | Revoke the session |
+   | `GET`  | `/auth/me` | Return the authenticated principal |
+   | `GET`  | `/auth/:provider` | Start an OAuth flow *(if configured)* |
+   | `GET`  | `/auth/:provider/callback` | Handle an OAuth callback *(if configured)* |
+
+### Cookie-mode refresh tokens
+
+Store the refresh token in an `HttpOnly` cookie instead of the response body so the
+client never touches it directly:
+
+```ts
+app.use(
+  "/auth",
+  createIdentityRouter(service, {
+    refreshToken: { cookie: { name: "rt", secure: true, sameSite: "strict" } },
+  }),
+);
+```
+
+`/refresh` and `/logout` read the cookie automatically.
+
+### OAuth with the pre-built router
+
+```ts
+import { createGoogleOAuthProvider } from "@azlib/identity/node";
+
+const service = createIdentityService(
+  {
+    accessTokenSecret: process.env.ACCESS_TOKEN_SECRET!,
+    oauth: {
+      providers: [
+        createGoogleOAuthProvider({
+          clientId:     process.env.GOOGLE_CLIENT_ID!,
+          clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
+        }),
+      ],
+    },
+  },
+  store,
+);
+
+app.use(
+  "/auth",
+  createIdentityRouter(service, {
+    oauthBaseUrl: "https://api.example.com/auth",
+  }),
+);
+// → GET /auth/google          starts OAuth flow
+// → GET /auth/google/callback handles callback and issues tokens
+```
+
+### Manual wiring (advanced)
+
+If you need fine-grained control over individual routes, wire each handler yourself:
+
+```ts
+import { requireAuth } from "@azlib/identity/express";
+
+app.post("/auth/register", (req, res, next) =>
+  service.register(req.body).then((r) => res.json(r), next),
+);
+app.get("/auth/me", requireAuth(service), (req, res) => res.json(req.identity));
+```
+
+A complete runnable example lives in
+[`examples/express-basic`](./examples/express-basic).
+
+## Authorization
+
+Authorization is **deny-by-default**: a principal is only allowed when an explicit grant
+(and any ownership policy) passes. Permissions can be granted directly to a user or
+through an assigned role; both resolve into the principal's `permissions`.
+
+```ts
+import { requirePermission, requireAuthorization } from "@azlib/identity/express";
+
+// Require a single permission.
+app.get(
+  "/reports",
+  requireAuth(identity),
+  requirePermission(identity, "reports:read"),
+  listReports,
+);
+
+// Require a permission AND ownership of the target resource.
+app.delete(
+  "/docs/:id",
+  requireAuth(identity),
+  requireAuthorization(
+    identity,
+    {
+      permission: "documents:delete",
+      policy: ({ principal, resource }) => resource.ownerId === principal.userId,
+    },
+    (req) => loadDocument(req.params.id),
+  ),
+  deleteDocument,
+);
+```
+
+Grant roles and permissions through the store contract:
+
+```ts
+await store.grantRolePermission({ roleId: "editor", permission: "documents:write" });
+await store.assignRole({ userId, roleId: "editor" });
+await store.grantDirectPermission({ userId, permission: "reports:read" });
+```
+
+For non-Express transports, evaluate requirements directly with
+`evaluateAuthorization(requirement, context)` from `@azlib/identity`.
+
+## NestJS
+
+Register the module once with `routes: true` and all standard auth endpoints are
+wired automatically — no controller to write:
+
+```ts
+import { Module } from "@nestjs/common";
+import { createIdentityService } from "@azlib/identity/node";
+import { IdentityModule } from "@azlib/identity/nestjs";
+
+@Module({
+  imports: [
+    IdentityModule.forRoot({
+      service: createIdentityService(config, store),
+      routes: true, // registers POST /auth/register, /login, /refresh, /logout + GET /auth/me
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Customise the prefix or enable cookie-mode refresh tokens:
+
+```ts
+IdentityModule.forRoot({
+  service,
+  routes: {
+    prefix: "v1/auth",
+    cookie: { name: "rt", secure: true },
+  },
+})
+```
+
+### Guards and decorators
+
+Use the guards and decorators on your own controllers for authorization:
+
+```ts
+import {
+  CurrentUser,
+  IdentityAuthGuard,
+  IdentityAuthorizationGuard,
+  RequirePermission,
+} from "@azlib/identity/nestjs";
+
+@Get("reports")
+@UseGuards(IdentityAuthGuard, IdentityAuthorizationGuard)
+@RequirePermission("reports:read")
+listReports(@CurrentUser() user: AuthenticatedIdentity) {
+  return this.reports.findFor(user.userId);
+}
+```
+
+A runnable NestJS app lives in [`examples/nest-basic`](./examples/nest-basic). The same
+`IdentityService` core powers both the Express and NestJS adapters, so behavior is
+identical across frameworks.
+
+## Account lockout
+
+Protect against brute-force credential attacks by automatically locking accounts after too many consecutive failed logins.
+
+```ts
+createIdentityService(
+  {
+    accessTokenSecret: process.env.ACCESS_TOKEN_SECRET!,
+    lockout: {
+      maxFailedAttempts: 5,   // 0 = disabled (default: 10)
+      durationSeconds:  900,  // 0 = permanent lock (default: 900 = 15 min)
+    },
+  },
+  store,
+);
+```
+
+Behaviour:
+
+- Each failed `login()` call increments `failedLoginAttempts` on the user record.
+- When `failedLoginAttempts >= maxFailedAttempts`, the user's `status` is set to
+  `"locked"` and `lockedUntil` is set to `now + durationSeconds`.
+- A `user.account.locked` audit event is emitted once per lockout event.
+- Once the lockout period expires, the next successful login automatically resets
+  the counter and clears `lockedUntil`.
+- Set `maxFailedAttempts: 0` to disable lockout entirely.
+- Set `durationSeconds: 0` for a permanent lock (requires manual admin unlock).
+
+Your `IdentityStore` must persist `failedLoginAttempts` and `lockedUntil`. The
+shipped schema artifacts already include these columns.
+
+## OAuth2 / OpenID Connect
+
+Issue sessions via OAuth2 Authorization Code Flow + OIDC. Configure one or more
+providers when creating the service:
+
+```ts
+import { createIdentityService } from "@azlib/identity/node";
+import { createGoogleOAuthProvider } from "@azlib/identity/node";
+import { createMicrosoftOAuthProvider } from "@azlib/identity/node";
+
+const identity = createIdentityService(
+  {
+    accessTokenSecret: process.env.ACCESS_TOKEN_SECRET!,
+    oauth: {
+      providers: [
+        createGoogleOAuthProvider({
+          clientId:     process.env.GOOGLE_CLIENT_ID!,
+          clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
+        }),
+        createMicrosoftOAuthProvider({
+          clientId:     process.env.MS_CLIENT_ID!,
+          clientSecret: process.env.MS_CLIENT_SECRET!,
+          tenantId:     "common",          // or a specific tenant UUID
+        }),
+      ],
+    },
+  },
+  store,
+);
+
+// identity.oauth is an OAuthService when providers are configured.
+const { url, state } = identity.oauth!.buildAuthorizationUrl("google", REDIRECT_URI);
+// …redirect the user to `url`, persist `state` in a signed cookie/session
+
+// In the callback handler:
+const result = await identity.oauth!.handleCallback("google", {
+  code:          req.query.code as string,
+  state:         req.query.state as string,
+  expectedState: req.session.oauthState,
+  redirectUri:   REDIRECT_URI,
+});
+// result.tokens.accessToken is now ready
+```
+
+### Express helpers
+
+```ts
+import { oauthAuthorize, oauthCallback } from "@azlib/identity/express";
+
+const options = {
+  redirectUri: `${BASE_URL}/auth/google/callback`,
+  getState:    (req) => req.session?.oauthState ?? null,
+  setState:    (req, _res, state) => { req.session!.oauthState = state; },
+  onSuccess:   (_req, res, result) => res.json(result),
+};
+
+app.get("/auth/google",          oauthAuthorize(identity.oauth!, "google", options));
+app.get("/auth/google/callback", oauthCallback(identity.oauth!,  "google", options));
+```
+
+### Callback flow
+
+1. Verify CSRF `state` — throws `OAuthStateMismatchError` on mismatch.
+2. Exchange the authorization `code` for tokens via the provider.
+3. Fetch user info (email, `sub`, display name) from the provider.
+4. If an existing OAuth link (`provider` + `providerUserId`) exists, issue a session for that user.
+5. Otherwise if a local user with the same email exists, link the OAuth identity and issue a session.
+6. Otherwise provision a new user, create the OAuth link, and issue a session.
+
+Your `IdentityStore` should implement the optional `findUserByOAuthId`, `createOAuthLink`, and
+`listOAuthLinks` methods for full OAuth support. The shipped schema artifacts include the
+`identity_oauth_linked_accounts` table.
+
+
+
+The package never talks to a database directly — you provide an `IdentityStore`. Two
+adoption paths:
+
+1. **Use a shipped schema artifact.** Apply one of `@azlib/identity/schema/{postgres,mysql,sqlite}.sql`
+   (or `prisma.schema`) and implement `IdentityStore` over those tables. The artifacts
+   cover users, credentials, sessions, roles, permissions, grants, and audit events.
+2. **Adapt an existing schema.** Implement `IdentityStore` against your own tables. Only
+   the method contract matters; column and table names are yours. Email lookups must be
+   case-insensitive and email must be unique.
+
+Migration notes for adopters:
+
+- Store only the refresh-token **hash** (`refreshTokenHash`); never the raw token.
+- `authVersion` must be persisted per user and returned by `findUserById`; bump it to
+  invalidate all outstanding tokens (e.g. on password reset).
+- `recordEvent` is optional. Omit it to skip persistence; the `overrides.onEvent`
+  lifecycle hook can forward events to external logging regardless.
+- To rotate token policy (TTLs, issuer, secret) safely, change config and let existing
+  access tokens expire; refresh tokens rotate on next use.
+
+## Configuration overrides
+
+```ts
+createIdentityService(
+  {
+    accessTokenSecret: process.env.ACCESS_TOKEN_SECRET!,
+    accessTokenTtlSeconds: 900,
+    refreshTokenTtlSeconds: 60 * 60 * 24 * 14,
+    issuer: "my-service",
+    audience: "my-clients",
+    overrides: {
+      now: () => new Date(),
+      generateId: () => crypto.randomUUID(),
+      onEvent: (event) => metrics.record(event),
+    },
+  },
+  store,
+);
+```
+
+## Security model
+
+- Passwords are hashed with scrypt; only algorithm-tagged hashes are stored.
+- Access tokens are short-lived HS256 JWTs (default 15 minutes).
+- Refresh tokens are opaque and rotated on every use; only their SHA-256 hash is stored,
+  and reuse of a rotated token revokes the session.
+- Login returns a single generic error for both unknown email and wrong password to
+  mitigate account enumeration, and pays the hash-verification cost even for unknown users.
+- Tokens carry an `authVersion`; bump a user's version to invalidate all outstanding tokens.
+
+## Status
+
+This package is under active implementation. See
+[`specs/009-identity-package`](../../specs/009-identity-package) for the plan and tasks.
+
+## License
+
+MIT