@o3co/auth-provider-user-ledger-http 0.0.0-stage → 0.18.0-rc.1

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 2026 1o1 Co. Ltd.
+
+   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

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @o3co/auth-provider-user-ledger-http
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Part of auth-provider 0.18.0-rc.1, built from `modules/user-ledger-http` of https://github.com/o3co/auth.provider. Its modules, settings and documentation are there.
+
+Copyright 2026 1o1 Co. Ltd. Licensed under the Apache License, Version 2.0.

package/package.json

@@ -1,6 +1,25 @@
 {
   "name": "@o3co/auth-provider-user-ledger-http",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.18.0-rc.1",
+  "type": "module",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/o3co/auth.provider",
+    "directory": "modules/user-ledger-http"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "exports": {
+    "./users-http/module": {
+      "types": "./users-http/src/module.d.ts",
+      "default": "./users-http/src/module.js"
+    }
+  },
+  "dependencies": {
+    "@o3co/auth-provider-foundation": "0.18.0-rc.1",
+    "@o3co/auth-provider-identity": "0.18.0-rc.1",
+    "zod": "4.6.5"
+  }
 }

package/users-http/README.md

@@ -0,0 +1,38 @@
+# users-http
+
+## Responsibilities
+- Contributes a user ledger to `users`: asks the operator's HTTP ledger to verify an identifier and password, through `outbound`.
+- Reads each answer once, at this boundary, into a `users` user.
+- Answers every lookup by subject unanswerable: the ledger offers none.
+
+## Not here
+- Written links and verified contacts (`users`). Whether the ledger may be reached, redirects, and the caps on size and time (`outbound`). The names of attributes and the shape of a subject (`users`). Hashing passwords (the ledger's).
+
+## Offers
+- Composition definition only (a contribution to `users`' `ledgers`).
+- Operator section: `verify-url` (the password call's whole URL, https or a plain-http pair outbound names, no fragment; required), `credential` (optional: a bare RFC 6750 token with at least 32 bytes of key material, counted as the fewest of its bytes, hex or base64 decoding), `timeout-ms` and `max-response-bytes` (each narrows outbound's cap).
+- The password call, as the HTTP user repository's `authenticateUrl`:
+
+  | | |
+  |---|---|
+  | Request | `POST {verify-url}`, `Content-Type` and `Accept: application/json`, the body `{"email": identifier, "password"}` |
+  | Credential | `Authorization: Bearer {credential}` when set; none sent otherwise |
+  | `200`, a JSON object with an `id` of a subject's shape (`users`) and a non-empty string `username` | the user: `id` is the subject; `email`, `name`, `picture`, `groups` and a boolean `emailVerified` (only beside `email`) are the attributes `users` names for them; other fields are dropped |
+  | `200` otherwise | unavailable |
+  | `401` or `403` with a Bearer challenge, when a credential was sent | unavailable (the credential is refused) |
+  | `401` or `403` otherwise | none |
+  | any other status, `404` and other `2xx` included | unavailable |
+
+## Invariants
+- The ledger is reached only through `outbound`, at the URL's host alone; a redirect is not followed. The URL is an internal destination: a private address is reached only when its host is in `outbound.internal-hosts`.
+- The password goes in the request body alone, never in a URL, a log line or an error.
+- Boot is refused on a `verify-url` that outbound's destination policy refuses.
+- A destination refused when sending, or no answer in time or size, is unavailable. A wrong URL makes verification unavailable, never "no such user", unless what answers there is a `401` or `403` without a Bearer challenge, which reads as none.
+- A user is a new frozen value. Attributes keep the ledger's values as given.
+- An error or log line carries no text or bytes from the ledger. Each failure logs one warning with its status, or its kind alone: outbound's refusal reason or failure, `credential-refused`, `no-answer` or `malformed`.
+- Boot reports never show the credential.
+- The operator's ledger must do the same work for an unknown identifier as for a known one; this module sends the same one request either way.
+- Holds no state, so it is safe on multiple instances.
+
+## Depends on
+- `kernel`, `users`, `outbound`, `url-setting`

package/users-http/config.example

@@ -0,0 +1,3 @@
+users-http {
+	verify-url = "https://ledger.example.invalid/verify"
+}

package/users-http/src/module.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@o3co/auth-provider-foundation/kernel").Module;
+export default _default;

package/users-http/src/module.js

@@ -0,0 +1,124 @@
+import { deepFreeze, defineModule, Unavailable } from "@o3co/auth-provider-foundation/kernel";
+import { DestinationRefused, jsonObjectOf, OutboundUnavailable, outbound, outboundPolicy, } from "@o3co/auth-provider-foundation/outbound";
+import { urlSetting } from "@o3co/auth-provider-foundation/url-setting";
+import { isWellFormedSubject, ledgers, userAttribute, } from "@o3co/auth-provider-identity/users";
+import { z } from "zod";
+/** The fewest bytes of key material a token can be read as: its own, or as hex or base64 decodes them. */
+function keyBytes(token) {
+    const hex = /^(?:[0-9a-fA-F]{2})+$/.test(token) ? token.length / 2 : undefined;
+    const body = token.replace(/=+$/, "");
+    const padding = token.length - body.length;
+    // Base64 as written: one alphabet, no lone sixth bit, and padding that completes the last four.
+    const alphabet = /^[A-Za-z0-9+/]+$/.test(body) || /^[A-Za-z0-9_-]+$/.test(body);
+    const rest = body.length % 4;
+    const base64 = alphabet && padding <= 2 && rest !== 1 && (padding === 0 || rest + padding === 4)
+        ? Math.floor((body.length * 3) / 4)
+        : undefined;
+    return Math.min(...[Buffer.byteLength(token), hex, base64].filter((n) => n !== undefined));
+}
+const section = z.strictObject({
+    /** Where a password is verified. Plain http is reached only where outbound's policy names it. */
+    "verify-url": urlSetting({ schemes: ["https", "http"] }),
+    /** A bare bearer token (RFC 6750 b64token) of at least 32 bytes of key material. */
+    credential: z
+        .string()
+        .regex(/^[A-Za-z0-9\-._~+/]+=*$/)
+        .refine((token) => keyBytes(token) >= 32, "at least 32 bytes of key material")
+        .optional(),
+    "timeout-ms": z.number().int().min(1).max(60_000).optional(),
+    "max-response-bytes": z.number().int().min(1).max(16_777_216).optional(),
+});
+const none = deepFreeze({ kind: "none" });
+/** The ledger's fields kept as given, each with users' name for it. */
+const keptFields = [
+    ["email", userAttribute.email],
+    ["name", userAttribute.name],
+    ["picture", userAttribute.picture],
+    ["groups", userAttribute.groups],
+];
+const isName = (value) => typeof value === "string" && value !== "";
+const unanswerable = deepFreeze({ kind: "unanswerable" });
+/** Whether a WWW-Authenticate value names the Bearer scheme; a quoted string is read as empty. */
+function challengesBearer(value) {
+    if (value === undefined)
+        return false;
+    const unquoted = value.replace(/"(?:[^"\\]|\\[\s\S])*"?/g, '""');
+    // After the scheme: the end, a comma, or a space then token68 or parameters; `bearer=` is a
+    // parameter of another scheme (RFC 9110 §11.6.1).
+    return /(?:^|,)[ \t]*bearer(?:[ \t]*(?:,|$)|[ \t]+(?![ \t=]))/i.test(unquoted);
+}
+/** The kind outbound gives a failure to send, or no-answer for anything else. */
+function kindOf(error) {
+    if (error instanceof DestinationRefused)
+        return error.reason;
+    if (error instanceof OutboundUnavailable)
+        return error.failure;
+    return "no-answer";
+}
+/** The ledger's request: the identifier under the name the HTTP user repository reads, and the password. */
+const requestOf = (identifier, password) => JSON.stringify({ email: identifier, password });
+/** The ledger's user `{id, username, ...}` as a new frozen user, or undefined when it is not one. */
+function userOf(answer) {
+    const { id, username, emailVerified } = answer;
+    if (!isWellFormedSubject(id) || !isName(username))
+        return undefined;
+    const attributes = Object.fromEntries([
+        ...keptFields.filter(([field]) => Object.hasOwn(answer, field)).map(([f, a]) => [a, answer[f]]),
+        // Only a boolean says whether the email is verified, and only beside the email it is about.
+        ...(typeof emailVerified === "boolean" && Object.hasOwn(answer, "email")
+            ? [[userAttribute.emailVerified, emailVerified]]
+            : []),
+    ]);
+    return deepFreeze({ kind: "user", user: { subject: id, attributes } });
+}
+export default defineModule({ name: "users-http", section, replicaSafe: true }, (m) => [
+    m.contribute(ledgers).by(async (c) => {
+        const { "verify-url": url, credential, "max-response-bytes": maxBytes, "timeout-ms": timeoutMs, } = c.section;
+        // The operator's own URL: a host in `internal-hosts` is reached at a private address.
+        const narrower = {
+            hosts: [new URL(url).hostname],
+            internal: true,
+            ...(maxBytes === undefined ? {} : { maxBytes }),
+            ...(timeoutMs === undefined ? {} : { timeoutMs }),
+        };
+        const refusal = (await c.get(outboundPolicy)).refusalOf(url, narrower);
+        if (refusal !== undefined) {
+            return c.refuse("users-http.verify-url", `outbound's destination policy refuses it: ${refusal}`);
+        }
+        const out = await c.get(outbound);
+        /** Logs why the ledger failed, by its kind or status alone, and answers unavailable. */
+        const failed = (why) => {
+            c.log.warn("users-http.ledger_failed", why);
+            return new Unavailable("users-http");
+        };
+        const verify = async (identifier, password) => {
+            const headers = {
+                accept: "application/json",
+                "content-type": "application/json",
+                ...(credential === undefined ? {} : { authorization: `Bearer ${credential}` }),
+            };
+            const body = requestOf(identifier, password);
+            const answer = await out
+                .fetch(url, { method: "POST", headers, body }, narrower)
+                .catch((error) => {
+                throw failed({ reason: kindOf(error) });
+            });
+            if (answer.status === 401 || answer.status === 403) {
+                // A challenge refuses the credential; with none sent, it can only refuse the user.
+                const challenged = challengesBearer(answer.headers.get("www-authenticate"));
+                if (credential === undefined || !challenged)
+                    return none;
+                throw failed({ reason: "credential-refused" });
+            }
+            if (answer.status !== 200)
+                throw failed({ status: answer.status });
+            const read = jsonObjectOf(answer);
+            const user = read.kind === "object" ? userOf(read.value) : undefined;
+            if (!user)
+                throw failed({ reason: "malformed" });
+            return user;
+        };
+        // The ledger offers no lookup by subject.
+        return { verify, bySubject: async () => unanswerable };
+    }),
+]);