@idpartners/client-attestation-sdk 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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

@@ -1,3 +1,112 @@
-# Temporary Holding Version
+# client-attestation-sdk (TypeScript)
 
-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.
+Client-side builder SDK for **OAuth Attestation-Based Client Authentication**
+(`draft-ietf-oauth-attestation-based-client-auth`). Mints the three artifacts a client
+presents at the token endpoint:
+
+- **Client Attestation JWT** (`typ=oauth-client-attestation+jwt`) — issued by a Client Attester,
+  names the client (`sub` = `client_id`) and binds its instance key via `cnf.jwk`.
+- **Client Attestation PoP JWT** (`typ=oauth-client-attestation-pop+jwt`) — proves possession of
+  the instance key (PoP method `attestation_pop_jwt`).
+- **DPoP proof JWT** (`typ=dpop+jwt`) — combined mode (PoP method `dpop_combined`); its embedded
+  `jwk` header is the instance key bound in the attestation's `cnf`.
+
+This is one port of a polyglot SDK; it emits byte-compatible artifacts with the Java and Python
+ports and is judged by a shared Java verifier. Built on [panva `jose`](https://github.com/panva/jose).
+`kid` values are RFC 7638 JWK thumbprints (SHA-256, base64url); `iat`/`exp` are integer epoch seconds.
+
+## Install / build
+
+Requires **Node 20+**. The package uses Node built-ins (`node:crypto`, `node:fs`, and
+`node:child_process` for the SPIRE evidence source), so it does not run on edge or browser runtimes.
+
+Not on npm yet (it will publish as `@idpartners/client-attestation-sdk`). Build from a clone:
+
+```bash
+npm install
+npm run build   # tsc -> dist/
+```
+
+## Usage
+
+jose's crypto is async, so key factories and `build()` return promises.
+
+```ts
+import {
+  ClientAttestationBuilder,
+  ClientAttestationCredential,
+  SigningKeyPair,
+} from "client-attestation-sdk";
+
+// Attester side: issue the attestation.
+const attester = await SigningKeyPair.generate("ES256");     // or SigningKeyPair.fromJwk(jwk, "ES256")
+const instance = await SigningKeyPair.generate("ES256");     // the client's instance key
+const attestation = await new ClientAttestationBuilder(attester, "https://attester.example.com")
+  .clientId("https://rp.example.com")
+  .confirmationKey(instance)
+  .expiresIn(300)
+  // optional: .authorizationDetails(...) / .workload(...) / .operator(sub, issuer?) —
+  // operator names who's accountable for running the client (RFC 8693 may_act-shaped; an
+  // assertion, not proof of authorisation), distinct from clientId and from the principal.
+  .build();
+
+// Client side: produce token-request headers.
+const cred = new ClientAttestationCredential(attestation, instance);
+
+const popHeaders = await cred.popHeaders("https://rp.example.com", "https://as.example.com");
+// { "OAuth-Client-Attestation": "...", "OAuth-Client-Attestation-PoP": "..." }
+
+const dpopHeaders = await cred.dpopHeaders("POST", "https://as.example.com/as/token.oauth2");
+// { "OAuth-Client-Attestation": "...", "DPoP": "..." }
+```
+
+The one-call `ClientAttestation` orchestration class (see the [root README](../README.md#get-a-token-in-one-call))
+wraps this: `{ popMethod: "dpop_combined" }` in its options switches it to DPoP mode, and a fetched
+challenge is carried through automatically as the PoP JWT's `challenge` claim or the DPoP proof's `nonce`
+claim, whichever mode is active. `operator: {...}` asks the attester to state the client's operator: it
+goes in the mint request and, repeated as compact sorted-key JSON, in the token request's `operator` form
+parameter. `DRAFT_REVISION` names the draft revision implemented (`"10"`).
+
+### Presenting the token at a resource
+
+```ts
+const ca = new ClientAttestation("pf.example.com", { popMethod: "dpop_combined" });
+await ca.fetch("https://api.example.com/things");                     // headers + one nonce retry
+const headers = await ca.requestHeaders("GET", "https://api.example.com/things");
+```
+
+`requestHeaders(method, url)` returns what to send for one request. For a Bearer token that is just
+`Authorization: Bearer <t>`. When the AS answers `token_type: DPoP` (normal in `dpop_combined` mode) the
+token is bound to the instance key that minted the attestation, so the SDK keeps that key with the cached
+token and returns `Authorization: DPoP <t>` plus a fresh `DPoP` proof (`htm`, `htu` without query or
+fragment, `ath`, and the last `DPoP-Nonce` that origin sent). `authorizationHeader()` still works, but for
+a DPoP-bound token it returns only the `DPoP` scheme - a resource will also want the proof.
+
+`ca.fetch` resends once when a resource answers with a `use_dpop_nonce` challenge (401
+`WWW-Authenticate: DPoP error="use_dpop_nonce"`, or a 400 JSON error) and a `DPoP-Nonce`. String,
+`URLSearchParams`, `ArrayBuffer` and `Request` bodies are resent; a one-shot `ReadableStream` body is not,
+and the challenge response is returned instead. The token request itself retries once on an AS's
+`use_dpop_nonce` demand.
+
+### Failing closed
+
+- If the attester advertises a `challenge_endpoint` and the challenge cannot be fetched, `token()` throws
+  `ClientAttestationError`. Pass `requireChallenge: false` to mint without one instead.
+- `CLIENT_ATTESTATION_TOKEN_FILE` or `SPIFFE_ENDPOINT_SOCKET` pointing at a missing path throws
+  `EvidenceNotFound` naming the variable - it never falls through to another identity source.
+- `challengeAtToken: false` keeps the attester challenge in the mint's instance proof but leaves it out
+  of the token-endpoint PoP `challenge` claim / DPoP `nonce` - for attesters that consume a challenge at
+  mint and reject it when the token request presents it again.
+- The PingFederate host and every endpoint the attester advertises must be `https`, except loopback
+  (`localhost`, `127.0.0.1`, `::1`). Pass `allowInsecure: true` for, say, an in-cluster plain-http PF.
+
+The validator's `ProtectedResource` strips control characters from every quoted `WWW-Authenticate` value,
+and validation failures never echo the token's own `alg`, `kid`, `iss` or `aud` back in
+`error_description`.
+
+## Test & interop
+
+```bash
+npm test        # vitest — self-verifies each artifact with jose
+npm run emit    # writes ../vectors/out/typescript.json for the cross-language Java verifier
+```

package/dist/builders.d.ts

@@ -0,0 +1,96 @@
+import type { JWK } from "jose";
+import { SigningKeyPair } from "./signing-key-pair.js";
+import { type JwsSigner } from "./signer.js";
+export declare const ATTESTATION_TYP = "oauth-client-attestation+jwt";
+export declare const POP_TYP = "oauth-client-attestation-pop+jwt";
+export declare const DPOP_TYP = "dpop+jwt";
+/**
+ * Builds a Client Attestation JWT — the credential a Client Attester issues to name a client
+ * (`sub`) and bind its instance key via `cnf.jwk`. Attester side; sign with the attester's key.
+ */
+export declare class ClientAttestationBuilder {
+    #private;
+    constructor(attesterKey: SigningKeyPair | JwsSigner, issuer: string);
+    /** The client being attested — becomes the attestation `sub` (= `client_id`). */
+    clientId(clientId: string): this;
+    /** Binds the client instance key as `cnf.jwk`. Must be a public JWK. */
+    confirmationJwk(publicInstanceJwk: JWK): this;
+    /** Convenience: binds the public half of the given instance key as `cnf.jwk`. */
+    confirmationKey(instanceKey: SigningKeyPair): this;
+    issuedAt(epochSeconds: number): this;
+    /** Sets an absolute `exp`. */
+    expiresAt(epochSeconds: number): this;
+    /** Sets `exp` to `iat + seconds`. */
+    expiresIn(seconds: number): this;
+    /** The optional RFC 9396 `authorization_details` entitlement the attester asserts. */
+    authorizationDetails(details: unknown[]): this;
+    /** Optional attester-asserted `workload` attributes. */
+    workload(workload: Record<string, unknown>): this;
+    /**
+     * Names the client's OPERATOR — the human or organisation accountable for running this client,
+     * as distinct from the client itself (`sub`) and from the principal it acts for.
+     *
+     * Deliberately a top-level claim rather than a member of `workload`: `workload` describes the
+     * running software, whereas the operator is an accountability statement about who answers for
+     * it. It is per-client and static, so it does not affect how far an attestation can be cached.
+     *
+     * The shape mirrors RFC 8693 `may_act` (`{ sub: ..., iss: ... }`) on purpose. An AS that wants
+     * the operator to become the party authorised to act for the subject can lift this straight
+     * into `may_act`; `iss` names the OP the operator's `sub` is meaningful in, so the identifier is
+     * not ambiguous across directories.
+     *
+     * This is an ASSERTION by the attester, not proof the operator authorised anything. A relying
+     * AS should treat it as it treats the rest of the attestation: trusted exactly as far as the
+     * attester is.
+     */
+    operator(sub: string, issuer?: string | null): this;
+    build(): Promise<string>;
+}
+/**
+ * Builds a Client Attestation PoP JWT proving possession of the instance key. Client side of
+ * `attest_jwt_client_auth`; mint a fresh one per token request.
+ */
+export declare class PopBuilder {
+    #private;
+    constructor(instanceKey: SigningKeyPair);
+    /** Sets the optional `iss`; when present the verifier requires it to equal the attestation `sub`. */
+    clientId(clientId: string | null): this;
+    /** The AS identifier this PoP is bound to (`aud`) — required. */
+    audience(audience: string): this;
+    challenge(challenge: string | null): this;
+    jwtId(jwtId: string): this;
+    issuedAt(epochSeconds: number): this;
+    build(): Promise<string>;
+}
+/**
+ * Builds a DPoP proof JWT (RFC 9449) for attestation combined mode
+ * (PoP method `dpop_combined`): the embedded `jwk` header MUST be the attestation's `cnf` key.
+ */
+export declare class DpopProofBuilder {
+    #private;
+    constructor(instanceKey: SigningKeyPair);
+    /** The request's HTTP method (`htm`, upper-cased when built); defaults to `POST`. */
+    method(htm: string | null | undefined): this;
+    /**
+     * The target URL (`htu`) — required. Normalised when built: query and fragment are dropped, and
+     * scheme and host lower-cased (RFC 9449 section 4.2).
+     */
+    uri(htu: string): this;
+    /** The server challenge, carried in DPoP `nonce`. */
+    nonce(nonce: string | null): this;
+    /**
+     * The access token this proof accompanies at a resource: sets `ath` = base64url(SHA-256(token)).
+     * Leave unset for a proof sent to the token endpoint.
+     */
+    accessToken(accessToken: string | null): this;
+    jwtId(jwtId: string): this;
+    issuedAt(epochSeconds: number): this;
+    build(): Promise<string>;
+}
+/** RFC 9449 `ath`: base64url(SHA-256(ASCII access token)). */
+export declare function accessTokenHash(accessToken: string): string;
+/**
+ * The DPoP `htu` for a URL: scheme, host, port and path, with no query and no fragment. Scheme and host
+ * are lower-cased and a default port dropped; a URL with no path keeps none (no slash is invented).
+ */
+export declare function normalizeHtu(url: string): string;