feat: jarm

packages/client/lib/AccessTokenClient.ts

@@ -156,7 +156,7 @@ export class AccessTokenClient {
 
       return request as AccessTokenRequest;
     }
-    
+
     throw new Error('Credential offer request follows neither pre-authorized code nor authorization code flow requirements.');
   }
 

packages/common/lib/jwt/jwtUtils.ts

@@ -41,3 +41,31 @@ export function getNowSkewed(now?: number, skewTime?: number) {
 export function epochTime() {
   return Math.floor(Date.now() / 1000);
 }
+
+export const BASE64_URL_REGEX = /^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$/;
+
+export const isJws = (jws: string) => {
+  const jwsParts = jws.split('.');
+  return jwsParts.length === 3 && jwsParts.every((part) => BASE64_URL_REGEX.test(part));
+};
+export const isJwe = (jwe: string) => {
+  const jweParts = jwe.split('.');
+  return jweParts.length === 5 && jweParts.every((part) => BASE64_URL_REGEX.test(part));
+};
+
+export const decodeProtectedHeader = (jwt: string) => {
+  return jwtDecode(jwt, { header: true });
+};
+
+export const decodeJwt = (jwt: string): JwtPayload => {
+  return jwtDecode(jwt, { header: false });
+};
+
+export const checkExp = (input: {
+  exp: number;
+  now?: number; // The number of milliseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
+  clockSkew?: number;
+}) => {
+  const { exp, now, clockSkew } = input;
+  return exp < (now ?? Date.now() / 1000) - (clockSkew ?? 120);
+};

packages/jarm/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 [2022] [Sphereon B.V.]
+
+   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.

packages/jarm/lib/index.ts

@@ -0,0 +1,3 @@
+export * from './jarm-auth-response-send/index.js';
+export * from './jarm-auth-response/index.js';
+export * from './metadata/index.js';

packages/jarm/lib/jarm-auth-response-send/index.ts

@@ -0,0 +1 @@
+export * from './jarm-auth-response-send.js';

packages/jarm/lib/jarm-auth-response-send/jarm-auth-response-send.ts

@@ -0,0 +1,76 @@
+import { appendFragmentParams, appendQueryParams } from '../utils.js';
+import type { JarmResponseMode, Openid4vpJarmResponseMode } from '../v-response-mode-registry.js';
+import { getJarmDefaultResponseMode, validateResponseMode } from '../v-response-mode-registry.js';
+import type { ResponseTypeOut } from '../v-response-type-registry.js';
+
+interface JarmAuthResponseSendInput {
+  authRequestParams: {
+    response_mode?: JarmResponseMode | Openid4vpJarmResponseMode;
+    response_type: ResponseTypeOut;
+  } & (
+    | {
+        response_uri: string;
+      }
+    | {
+        redirect_uri: string;
+      }
+  );
+
+  authResponse: string;
+}
+
+export const jarmAuthResponseSend = async (input: JarmAuthResponseSendInput): Promise<Response> => {
+  const { authRequestParams, authResponse } = input;
+
+  const responseEndpoint = 'response_uri' in authRequestParams ? new URL(authRequestParams.response_uri) : new URL(authRequestParams.redirect_uri);
+
+  const responseMode =
+    authRequestParams.response_mode && authRequestParams.response_mode !== 'jwt'
+      ? authRequestParams.response_mode
+      : getJarmDefaultResponseMode(authRequestParams);
+
+  validateResponseMode({
+    response_type: authRequestParams.response_type,
+    response_mode: responseMode,
+  });
+
+  switch (responseMode) {
+    case 'direct_post.jwt':
+      return handleDirectPostJwt(responseEndpoint, authResponse);
+    case 'query.jwt':
+      return handleQueryJwt(responseEndpoint, authResponse);
+    case 'fragment.jwt':
+      return handleFragmentJwt(responseEndpoint, authResponse);
+    case 'form_post.jwt':
+      throw new Error('Not implemented');
+  }
+};
+
+async function handleDirectPostJwt(responseEndpoint: URL, responseJwt: string) {
+  const response = await fetch(responseEndpoint, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+    body: `response=${responseJwt}`,
+  });
+
+  return response;
+}
+
+async function handleQueryJwt(responseEndpoint: URL, responseJwt: string) {
+  const responseUrl = appendQueryParams({
+    url: responseEndpoint,
+    params: { response: responseJwt },
+  });
+
+  const response = await fetch(responseUrl, { method: 'POST' });
+  return response;
+}
+
+async function handleFragmentJwt(responseEndpoint: URL, responseJwt: string) {
+  const responseUrl = appendFragmentParams({
+    url: responseEndpoint,
+    fragments: { response: responseJwt },
+  });
+  const response = await fetch(responseUrl, { method: 'POST' });
+  return response;
+}

packages/jarm/lib/jarm-auth-response/c-jarm-auth-response.ts

@@ -0,0 +1,41 @@
+import * as v from 'valibot';
+
+import { vJarmResponseMode, vOpenid4vpJarmResponseMode } from '../v-response-mode-registry.js';
+import { vResponseType } from '../v-response-type-registry.js';
+
+import type { JarmAuthResponseParams } from './v-jarm-auth-response-params.js';
+import type { JarmDirectPostJwtResponseParams } from './v-jarm-direct-post-jwt-auth-response-params.js';
+
+export const vAuthRequestParams = v.looseObject({
+  state: v.optional(v.string()),
+  response_mode: v.optional(v.union([vJarmResponseMode, vOpenid4vpJarmResponseMode])),
+  client_id: v.string(),
+  response_type: vResponseType,
+  client_metadata: v.looseObject({
+    jwks: v.optional(
+      v.object({
+        keys: v.array(v.looseObject({ kid: v.optional(v.string()), kty: v.string() })),
+      }),
+    ),
+    jwks_uri: v.optional(v.string()),
+  }),
+});
+
+export type AuthRequestParams = v.InferInput<typeof vAuthRequestParams>;
+
+export const vOAuthAuthRequestGetParamsOut = v.object({
+  authRequestParams: vAuthRequestParams,
+});
+
+export type OAuthAuthRequestGetParamsOut = v.InferOutput<typeof vOAuthAuthRequestGetParamsOut>;
+
+export interface JarmDirectPostJwtAuthResponseValidationContext {
+  openid4vp: {
+    authRequest: {
+      getParams: (input: JarmAuthResponseParams | JarmDirectPostJwtResponseParams) => Promise<OAuthAuthRequestGetParamsOut>;
+    };
+  };
+  jwe: {
+    decryptCompact: (input: { jwe: string; jwk: { kid: string } }) => Promise<{ plaintext: string }>;
+  };
+}

packages/jarm/lib/jarm-auth-response/index.ts

@@ -0,0 +1,4 @@
+export * from './c-jarm-auth-response.js';
+export * from './jarm-auth-response.js';
+export * from './v-jarm-auth-response-params.js';
+export * from './v-jarm-direct-post-jwt-auth-response-params.js';