@textrp/briij-js-sdk 41.0.0

package/lib/oidc/register.js

@@ -0,0 +1,135 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import { OidcError } from "./error.js";
+import { Method } from "../http-api/index.js";
+import { logger } from "../logger.js";
+
+/**
+ * Client metadata passed to registration endpoint
+ */
+
+/**
+ * Request body for dynamic registration as defined by https://github.com/matrix-org/matrix-spec-proposals/pull/2966
+ */
+
+/**
+ * The OAuth 2.0 grant types that are defined for Matrix in https://spec.matrix.org/v1.17/client-server-api/#grant-types
+ */
+export var OAuthGrantType = /*#__PURE__*/function (OAuthGrantType) {
+  /**
+   * See https://spec.matrix.org/v1.17/client-server-api/#authorization-code-grant
+   */
+  OAuthGrantType["AuthorizationCode"] = "authorization_code";
+  /**
+   * https://spec.matrix.org/v1.17/client-server-api/#refresh-token-grant
+   */
+  OAuthGrantType["RefreshToken"] = "refresh_token";
+  /**
+   * The OAuth 2.0 Device Authorization Grant type identifier as per
+   * https://www.rfc-editor.org/rfc/rfc8628.html#section-7.2 from
+   * [MSC4341](https://github.com/matrix-org/matrix-spec-proposals/pull/4341).
+   *
+   * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+   */
+  OAuthGrantType["DeviceAuthorization"] = "urn:ietf:params:oauth:grant-type:device_code";
+  return OAuthGrantType;
+}({});
+
+/**
+ * The name "scope" is a misnomer here as it is actually a "grant type".
+ *
+ * @deprecated use `OAuthGrantType.DeviceAuthorization` instead
+ */
+export var DEVICE_CODE_SCOPE = OAuthGrantType.DeviceAuthorization;
+
+// Check that URIs have a common base, as per the MSC2966 definition
+var urlHasCommonBase = (base, urlStr) => {
+  if (!urlStr) return false;
+  var url = new URL(urlStr);
+  if (url.protocol !== base.protocol) return false;
+  if (url.hostname !== base.hostname && !url.hostname.endsWith(".".concat(base.hostname))) return false;
+  return true;
+};
+
+/**
+ * Attempts dynamic registration against the configured registration endpoint.
+ * Will ignore any URIs that do not use client_uri as a common base as per the spec.
+ * @param delegatedAuthConfig - Auth config from {@link discoverAndValidateOIDCIssuerWellKnown}
+ * @param clientMetadata - The metadata for the client which to register
+ * @returns Promise<string> resolved with registered clientId
+ * @throws when registration is not supported, on failed request or invalid response
+ */
+export var registerOidcClient = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(function* (delegatedAuthConfig, clientMetadata) {
+    if (!delegatedAuthConfig.registration_endpoint) {
+      throw new Error(OidcError.DynamicRegistrationNotSupported);
+    }
+    var grantTypes = [OAuthGrantType.AuthorizationCode, OAuthGrantType.RefreshToken];
+    if (grantTypes.some(scope => !delegatedAuthConfig.grant_types_supported.includes(scope))) {
+      throw new Error(OidcError.DynamicRegistrationNotSupported);
+    }
+    var commonBase = new URL(clientMetadata.clientUri);
+
+    // https://openid.net/specs/openid-connect-registration-1_0.html
+    var metadata = {
+      client_name: clientMetadata.clientName,
+      client_uri: clientMetadata.clientUri,
+      response_types: ["code"],
+      grant_types: grantTypes,
+      redirect_uris: clientMetadata.redirectUris,
+      id_token_signed_response_alg: "RS256",
+      token_endpoint_auth_method: "none",
+      application_type: clientMetadata.applicationType,
+      contacts: clientMetadata.contacts,
+      logo_uri: urlHasCommonBase(commonBase, clientMetadata.logoUri) ? clientMetadata.logoUri : undefined,
+      policy_uri: urlHasCommonBase(commonBase, clientMetadata.policyUri) ? clientMetadata.policyUri : undefined,
+      tos_uri: urlHasCommonBase(commonBase, clientMetadata.tosUri) ? clientMetadata.tosUri : undefined
+    };
+    var headers = {
+      "Accept": "application/json",
+      "Content-Type": "application/json"
+    };
+    try {
+      var response = yield fetch(delegatedAuthConfig.registration_endpoint, {
+        method: Method.Post,
+        headers,
+        body: JSON.stringify(metadata)
+      });
+      if (response.status >= 400) {
+        throw new Error(OidcError.DynamicRegistrationFailed);
+      }
+      var body = yield response.json();
+      var clientId = body["client_id"];
+      if (!clientId || typeof clientId !== "string") {
+        throw new Error(OidcError.DynamicRegistrationInvalid);
+      }
+      return clientId;
+    } catch (error) {
+      if (Object.values(OidcError).includes(error.message)) {
+        throw error;
+      } else {
+        logger.error("Dynamic registration request failed", error);
+        throw new Error(OidcError.DynamicRegistrationFailed);
+      }
+    }
+  });
+  return function registerOidcClient(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+//# sourceMappingURL=register.js.map

package/lib/oidc/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","names":["OidcError","Method","logger","OAuthGrantType","DEVICE_CODE_SCOPE","DeviceAuthorization","urlHasCommonBase","base","urlStr","url","URL","protocol","hostname","endsWith","concat","registerOidcClient","_ref","_asyncToGenerator","delegatedAuthConfig","clientMetadata","registration_endpoint","Error","DynamicRegistrationNotSupported","grantTypes","AuthorizationCode","RefreshToken","some","scope","grant_types_supported","includes","commonBase","clientUri","metadata","client_name","clientName","client_uri","response_types","grant_types","redirect_uris","redirectUris","id_token_signed_response_alg","token_endpoint_auth_method","application_type","applicationType","contacts","logo_uri","logoUri","undefined","policy_uri","policyUri","tos_uri","tosUri","headers","response","fetch","method","Post","body","JSON","stringify","status","DynamicRegistrationFailed","json","clientId","DynamicRegistrationInvalid","error","Object","values","message","_x","_x2","apply","arguments"],"sources":["../../src/oidc/register.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type OidcClientConfig } from \"./index.ts\";\r\nimport { OidcError } from \"./error.ts\";\r\nimport { Method } from \"../http-api/index.ts\";\r\nimport { logger } from \"../logger.ts\";\r\nimport { type NonEmptyArray } from \"../@types/common.ts\";\r\n\r\n/**\r\n * Client metadata passed to registration endpoint\r\n */\r\nexport type OidcRegistrationClientMetadata = {\r\n    clientName: OidcRegistrationRequestBody[\"client_name\"];\r\n    clientUri: OidcRegistrationRequestBody[\"client_uri\"];\r\n    logoUri?: OidcRegistrationRequestBody[\"logo_uri\"];\r\n    applicationType: OidcRegistrationRequestBody[\"application_type\"];\r\n    redirectUris: OidcRegistrationRequestBody[\"redirect_uris\"];\r\n    contacts: OidcRegistrationRequestBody[\"contacts\"];\r\n    tosUri: OidcRegistrationRequestBody[\"tos_uri\"];\r\n    policyUri: OidcRegistrationRequestBody[\"policy_uri\"];\r\n};\r\n\r\n/**\r\n * Request body for dynamic registration as defined by https://github.com/matrix-org/matrix-spec-proposals/pull/2966\r\n */\r\ninterface OidcRegistrationRequestBody {\r\n    client_name?: string;\r\n    client_uri: string;\r\n    logo_uri?: string;\r\n    contacts?: string[];\r\n    tos_uri?: string;\r\n    policy_uri?: string;\r\n    redirect_uris?: NonEmptyArray<string>;\r\n    response_types?: NonEmptyArray<string>;\r\n    grant_types?: NonEmptyArray<string>;\r\n    id_token_signed_response_alg?: string;\r\n    token_endpoint_auth_method: string;\r\n    application_type: \"web\" | \"native\";\r\n}\r\n\r\n/**\r\n * The OAuth 2.0 grant types that are defined for Matrix in https://spec.matrix.org/v1.17/client-server-api/#grant-types\r\n */\r\nexport enum OAuthGrantType {\r\n    /**\r\n     * See https://spec.matrix.org/v1.17/client-server-api/#authorization-code-grant\r\n     */\r\n    AuthorizationCode = \"authorization_code\",\r\n    /**\r\n     * https://spec.matrix.org/v1.17/client-server-api/#refresh-token-grant\r\n     */\r\n    RefreshToken = \"refresh_token\",\r\n    /**\r\n     * The OAuth 2.0 Device Authorization Grant type identifier as per\r\n     * https://www.rfc-editor.org/rfc/rfc8628.html#section-7.2 from\r\n     * [MSC4341](https://github.com/matrix-org/matrix-spec-proposals/pull/4341).\r\n     *\r\n     * @experimental Note that this is UNSTABLE and may have breaking changes without notice.\r\n     */\r\n    DeviceAuthorization = \"urn:ietf:params:oauth:grant-type:device_code\",\r\n}\r\n\r\n/**\r\n * The name \"scope\" is a misnomer here as it is actually a \"grant type\".\r\n *\r\n * @deprecated use `OAuthGrantType.DeviceAuthorization` instead\r\n */\r\nexport const DEVICE_CODE_SCOPE: string = OAuthGrantType.DeviceAuthorization;\r\n\r\n// Check that URIs have a common base, as per the MSC2966 definition\r\nconst urlHasCommonBase = (base: URL, urlStr?: string): boolean => {\r\n    if (!urlStr) return false;\r\n    const url = new URL(urlStr);\r\n    if (url.protocol !== base.protocol) return false;\r\n    if (url.hostname !== base.hostname && !url.hostname.endsWith(`.${base.hostname}`)) return false;\r\n    return true;\r\n};\r\n\r\n/**\r\n * Attempts dynamic registration against the configured registration endpoint.\r\n * Will ignore any URIs that do not use client_uri as a common base as per the spec.\r\n * @param delegatedAuthConfig - Auth config from {@link discoverAndValidateOIDCIssuerWellKnown}\r\n * @param clientMetadata - The metadata for the client which to register\r\n * @returns Promise<string> resolved with registered clientId\r\n * @throws when registration is not supported, on failed request or invalid response\r\n */\r\nexport const registerOidcClient = async (\r\n    delegatedAuthConfig: OidcClientConfig,\r\n    clientMetadata: OidcRegistrationClientMetadata,\r\n): Promise<string> => {\r\n    if (!delegatedAuthConfig.registration_endpoint) {\r\n        throw new Error(OidcError.DynamicRegistrationNotSupported);\r\n    }\r\n\r\n    const grantTypes: NonEmptyArray<string> = [OAuthGrantType.AuthorizationCode, OAuthGrantType.RefreshToken];\r\n    if (grantTypes.some((scope) => !delegatedAuthConfig.grant_types_supported.includes(scope))) {\r\n        throw new Error(OidcError.DynamicRegistrationNotSupported);\r\n    }\r\n\r\n    const commonBase = new URL(clientMetadata.clientUri);\r\n\r\n    // https://openid.net/specs/openid-connect-registration-1_0.html\r\n    const metadata: OidcRegistrationRequestBody = {\r\n        client_name: clientMetadata.clientName,\r\n        client_uri: clientMetadata.clientUri,\r\n        response_types: [\"code\"],\r\n        grant_types: grantTypes,\r\n        redirect_uris: clientMetadata.redirectUris,\r\n        id_token_signed_response_alg: \"RS256\",\r\n        token_endpoint_auth_method: \"none\",\r\n        application_type: clientMetadata.applicationType,\r\n        contacts: clientMetadata.contacts,\r\n        logo_uri: urlHasCommonBase(commonBase, clientMetadata.logoUri) ? clientMetadata.logoUri : undefined,\r\n        policy_uri: urlHasCommonBase(commonBase, clientMetadata.policyUri) ? clientMetadata.policyUri : undefined,\r\n        tos_uri: urlHasCommonBase(commonBase, clientMetadata.tosUri) ? clientMetadata.tosUri : undefined,\r\n    };\r\n\r\n    const headers = {\r\n        \"Accept\": \"application/json\",\r\n        \"Content-Type\": \"application/json\",\r\n    };\r\n\r\n    try {\r\n        const response = await fetch(delegatedAuthConfig.registration_endpoint, {\r\n            method: Method.Post,\r\n            headers,\r\n            body: JSON.stringify(metadata),\r\n        });\r\n\r\n        if (response.status >= 400) {\r\n            throw new Error(OidcError.DynamicRegistrationFailed);\r\n        }\r\n\r\n        const body = await response.json();\r\n        const clientId = body[\"client_id\"];\r\n        if (!clientId || typeof clientId !== \"string\") {\r\n            throw new Error(OidcError.DynamicRegistrationInvalid);\r\n        }\r\n\r\n        return clientId;\r\n    } catch (error) {\r\n        if (Object.values(OidcError).includes((error as Error).message as OidcError)) {\r\n            throw error;\r\n        } else {\r\n            logger.error(\"Dynamic registration request failed\", error);\r\n            throw new Error(OidcError.DynamicRegistrationFailed);\r\n        }\r\n    }\r\n};\r\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,SAAS,QAAQ,YAAY;AACtC,SAASC,MAAM,QAAQ,sBAAsB;AAC7C,SAASC,MAAM,QAAQ,cAAc;;AAGrC;AACA;AACA;;AAYA;AACA;AACA;;AAgBA;AACA;AACA;AACA,WAAYC,cAAc,0BAAdA,cAAc;EACtB;AACJ;AACA;EAHYA,cAAc;EAKtB;AACJ;AACA;EAPYA,cAAc;EAStB;AACJ;AACA;AACA;AACA;AACA;AACA;EAfYA,cAAc;EAAA,OAAdA,cAAc;AAAA;;AAmB1B;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,iBAAyB,GAAGD,cAAc,CAACE,mBAAmB;;AAE3E;AACA,IAAMC,gBAAgB,GAAGA,CAACC,IAAS,EAAEC,MAAe,KAAc;EAC9D,IAAI,CAACA,MAAM,EAAE,OAAO,KAAK;EACzB,IAAMC,GAAG,GAAG,IAAIC,GAAG,CAACF,MAAM,CAAC;EAC3B,IAAIC,GAAG,CAACE,QAAQ,KAAKJ,IAAI,CAACI,QAAQ,EAAE,OAAO,KAAK;EAChD,IAAIF,GAAG,CAACG,QAAQ,KAAKL,IAAI,CAACK,QAAQ,IAAI,CAACH,GAAG,CAACG,QAAQ,CAACC,QAAQ,KAAAC,MAAA,CAAKP,IAAI,CAACK,QAAQ,CAAE,CAAC,EAAE,OAAO,KAAK;EAC/F,OAAO,IAAI;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMG,kBAAkB;EAAA,IAAAC,IAAA,GAAAC,iBAAA,CAAG,WAC9BC,mBAAqC,EACrCC,cAA8C,EAC5B;IAClB,IAAI,CAACD,mBAAmB,CAACE,qBAAqB,EAAE;MAC5C,MAAM,IAAIC,KAAK,CAACrB,SAAS,CAACsB,+BAA+B,CAAC;IAC9D;IAEA,IAAMC,UAAiC,GAAG,CAACpB,cAAc,CAACqB,iBAAiB,EAAErB,cAAc,CAACsB,YAAY,CAAC;IACzG,IAAIF,UAAU,CAACG,IAAI,CAAEC,KAAK,IAAK,CAACT,mBAAmB,CAACU,qBAAqB,CAACC,QAAQ,CAACF,KAAK,CAAC,CAAC,EAAE;MACxF,MAAM,IAAIN,KAAK,CAACrB,SAAS,CAACsB,+BAA+B,CAAC;IAC9D;IAEA,IAAMQ,UAAU,GAAG,IAAIpB,GAAG,CAACS,cAAc,CAACY,SAAS,CAAC;;IAEpD;IACA,IAAMC,QAAqC,GAAG;MAC1CC,WAAW,EAAEd,cAAc,CAACe,UAAU;MACtCC,UAAU,EAAEhB,cAAc,CAACY,SAAS;MACpCK,cAAc,EAAE,CAAC,MAAM,CAAC;MACxBC,WAAW,EAAEd,UAAU;MACvBe,aAAa,EAAEnB,cAAc,CAACoB,YAAY;MAC1CC,4BAA4B,EAAE,OAAO;MACrCC,0BAA0B,EAAE,MAAM;MAClCC,gBAAgB,EAAEvB,cAAc,CAACwB,eAAe;MAChDC,QAAQ,EAAEzB,cAAc,CAACyB,QAAQ;MACjCC,QAAQ,EAAEvC,gBAAgB,CAACwB,UAAU,EAAEX,cAAc,CAAC2B,OAAO,CAAC,GAAG3B,cAAc,CAAC2B,OAAO,GAAGC,SAAS;MACnGC,UAAU,EAAE1C,gBAAgB,CAACwB,UAAU,EAAEX,cAAc,CAAC8B,SAAS,CAAC,GAAG9B,cAAc,CAAC8B,SAAS,GAAGF,SAAS;MACzGG,OAAO,EAAE5C,gBAAgB,CAACwB,UAAU,EAAEX,cAAc,CAACgC,MAAM,CAAC,GAAGhC,cAAc,CAACgC,MAAM,GAAGJ;IAC3F,CAAC;IAED,IAAMK,OAAO,GAAG;MACZ,QAAQ,EAAE,kBAAkB;MAC5B,cAAc,EAAE;IACpB,CAAC;IAED,IAAI;MACA,IAAMC,QAAQ,SAASC,KAAK,CAACpC,mBAAmB,CAACE,qBAAqB,EAAE;QACpEmC,MAAM,EAAEtD,MAAM,CAACuD,IAAI;QACnBJ,OAAO;QACPK,IAAI,EAAEC,IAAI,CAACC,SAAS,CAAC3B,QAAQ;MACjC,CAAC,CAAC;MAEF,IAAIqB,QAAQ,CAACO,MAAM,IAAI,GAAG,EAAE;QACxB,MAAM,IAAIvC,KAAK,CAACrB,SAAS,CAAC6D,yBAAyB,CAAC;MACxD;MAEA,IAAMJ,IAAI,SAASJ,QAAQ,CAACS,IAAI,CAAC,CAAC;MAClC,IAAMC,QAAQ,GAAGN,IAAI,CAAC,WAAW,CAAC;MAClC,IAAI,CAACM,QAAQ,IAAI,OAAOA,QAAQ,KAAK,QAAQ,EAAE;QAC3C,MAAM,IAAI1C,KAAK,CAACrB,SAAS,CAACgE,0BAA0B,CAAC;MACzD;MAEA,OAAOD,QAAQ;IACnB,CAAC,CAAC,OAAOE,KAAK,EAAE;MACZ,IAAIC,MAAM,CAACC,MAAM,CAACnE,SAAS,CAAC,CAAC6B,QAAQ,CAAEoC,KAAK,CAAWG,OAAoB,CAAC,EAAE;QAC1E,MAAMH,KAAK;MACf,CAAC,MAAM;QACH/D,MAAM,CAAC+D,KAAK,CAAC,qCAAqC,EAAEA,KAAK,CAAC;QAC1D,MAAM,IAAI5C,KAAK,CAACrB,SAAS,CAAC6D,yBAAyB,CAAC;MACxD;IACJ;EACJ,CAAC;EAAA,gBA9DY9C,kBAAkBA,CAAAsD,EAAA,EAAAC,GAAA;IAAA,OAAAtD,IAAA,CAAAuD,KAAA,OAAAC,SAAA;EAAA;AAAA,GA8D9B","ignoreList":[]}

package/lib/oidc/tokenRefresher.d.ts

@@ -0,0 +1,91 @@
+import { type IdTokenClaims } from "oidc-client-ts";
+import { type AccessTokens } from "../http-api/index.ts";
+/**
+ * @experimental
+ * Class responsible for refreshing OIDC access tokens
+ *
+ * Client implementations will likely want to override {@link persistTokens} to persist tokens after successful refresh
+ *
+ */
+export declare class OidcTokenRefresher {
+    /**
+     * The OIDC issuer as returned by the /auth_issuer API
+     */
+    private issuer;
+    /**
+     * id of this client as registered with the OP
+     */
+    private clientId;
+    /**
+     * redirectUri as registered with OP
+     */
+    private redirectUri;
+    /**
+     * Device ID of current session
+     */
+    protected deviceId: string;
+    /**
+     * idTokenClaims as returned from authorization grant
+     * used to validate tokens
+     */
+    private readonly idTokenClaims;
+    /**
+     * This is now just a resolved promise and will be removed in a future version.
+     * Initialisation is done lazily at token refresh time.
+     * @deprecated Consumers no longer need to wait for this promise.
+     */
+    readonly oidcClientReady: Promise<void>;
+    private initPromise?;
+    private oidcClient;
+    private inflightRefreshRequest?;
+    constructor(
+    /**
+     * The OIDC issuer as returned by the /auth_issuer API
+     */
+    issuer: string, 
+    /**
+     * id of this client as registered with the OP
+     */
+    clientId: string, 
+    /**
+     * redirectUri as registered with OP
+     */
+    redirectUri: string, 
+    /**
+     * Device ID of current session
+     */
+    deviceId: string, 
+    /**
+     * idTokenClaims as returned from authorization grant
+     * used to validate tokens
+     */
+    idTokenClaims: IdTokenClaims);
+    /**
+     * Ensures that the client is initialised.
+     * @returns Promise that resolves when initialisation is complete
+     * @throws if initialisation fails
+     */
+    private ensureInit;
+    private initialiseOidcClient;
+    /**
+     * Attempt token refresh using given refresh token
+     * @param refreshToken - refresh token to use in request with token issuer
+     * @returns tokens - Promise that resolves with new access and refresh tokens
+     * @throws when token refresh fails
+     */
+    doRefreshAccessToken(refreshToken: string): Promise<AccessTokens>;
+    /**
+     * Persist the new tokens, called after tokens are successfully refreshed.
+     *
+     * This function is intended to be overriden by the consumer when persistence is necessary.
+     *
+     * @param tokens.accessToken - new access token
+     * @param tokens.refreshToken - OPTIONAL new refresh token
+     */
+    protected persistTokens(tokens: {
+        accessToken: string;
+        refreshToken?: string;
+    }): Promise<void>;
+    private getNewTokens;
+}
+//# sourceMappingURL=tokenRefresher.d.ts.map

package/lib/oidc/tokenRefresher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenRefresher.d.ts","sourceRoot":"","sources":["../../src/oidc/tokenRefresher.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,aAAa,EAAmD,MAAM,gBAAgB,CAAC;AAErG,OAAO,EAAE,KAAK,YAAY,EAA2B,MAAM,sBAAsB,CAAC;AAKlF;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAevB;;OAEG;IACH,OAAO,CAAC,MAAM;IACd;;OAEG;IACH,OAAO,CAAC,QAAQ;IAChB;;OAEG;IACH,OAAO,CAAC,WAAW;IACnB;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM;IAC1B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa;IAlClC;;;;OAIG;IACH,SAAgB,eAAe,EAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAGhD,OAAO,CAAC,WAAW,CAAC,CAAgB;IAEpC,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,sBAAsB,CAAC,CAAwB;;IAGnD;;OAEG;IACK,MAAM,EAAE,MAAM;IACtB;;OAEG;IACK,QAAQ,EAAE,MAAM;IACxB;;OAEG;IACK,WAAW,EAAE,MAAM;IAC3B;;OAEG;IACO,QAAQ,EAAE,MAAM;IAC1B;;;OAGG;IACc,aAAa,EAAE,aAAa;IAKjD;;;;OAIG;YACW,UAAU;YAeV,oBAAoB;IA0BlC;;;;;OAKG;IACU,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB9E;;;;;;;OAOG;cACa,aAAa,CAAC,MAAM,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YAItF,YAAY;CA6B7B"}

package/lib/oidc/tokenRefresher.js

@@ -0,0 +1,187 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+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.
+*/
+
+import { OidcClient, WebStorageStateStore, ErrorResponse } from "oidc-client-ts";
+import { TokenRefreshLogoutError } from "../http-api/index.js";
+import { generateScope } from "./authorize.js";
+import { discoverAndValidateOIDCIssuerWellKnown } from "./discovery.js";
+import { logger } from "../logger.js";
+
+/**
+ * @experimental
+ * Class responsible for refreshing OIDC access tokens
+ *
+ * Client implementations will likely want to override {@link persistTokens} to persist tokens after successful refresh
+ *
+ */
+export class OidcTokenRefresher {
+  constructor(
+  /**
+   * The OIDC issuer as returned by the /auth_issuer API
+   */
+  issuer,
+  /**
+   * id of this client as registered with the OP
+   */
+  clientId,
+  /**
+   * redirectUri as registered with OP
+   */
+  redirectUri,
+  /**
+   * Device ID of current session
+   */
+  deviceId,
+  /**
+   * idTokenClaims as returned from authorization grant
+   * used to validate tokens
+   */
+  idTokenClaims) {
+    this.issuer = issuer;
+    this.clientId = clientId;
+    this.redirectUri = redirectUri;
+    this.deviceId = deviceId;
+    this.idTokenClaims = idTokenClaims;
+    /**
+     * This is now just a resolved promise and will be removed in a future version.
+     * Initialisation is done lazily at token refresh time.
+     * @deprecated Consumers no longer need to wait for this promise.
+     */
+    _defineProperty(this, "oidcClientReady", void 0);
+    // If there is a initialisation attempt in progress, we keep track of it here.
+    _defineProperty(this, "initPromise", void 0);
+    _defineProperty(this, "oidcClient", void 0);
+    _defineProperty(this, "inflightRefreshRequest", void 0);
+    this.oidcClientReady = Promise.resolve();
+  }
+
+  /**
+   * Ensures that the client is initialised.
+   * @returns Promise that resolves when initialisation is complete
+   * @throws if initialisation fails
+   */
+  ensureInit() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      if (!_this.oidcClient) {
+        if (_this.initPromise) {
+          return _this.initPromise;
+        }
+        _this.initPromise = _this.initialiseOidcClient(_this.issuer, _this.clientId, _this.deviceId, _this.redirectUri);
+        try {
+          yield _this.initPromise;
+        } finally {
+          _this.initPromise = undefined;
+        }
+      }
+    })();
+  }
+  initialiseOidcClient(issuer, clientId, deviceId, redirectUri) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      try {
+        var _config$signingKeys;
+        var config = yield discoverAndValidateOIDCIssuerWellKnown(issuer);
+        var scope = generateScope(deviceId);
+        _this2.oidcClient = new OidcClient({
+          metadata: config,
+          signingKeys: (_config$signingKeys = config.signingKeys) !== null && _config$signingKeys !== void 0 ? _config$signingKeys : undefined,
+          client_id: clientId,
+          scope,
+          redirect_uri: redirectUri,
+          authority: config.issuer,
+          stateStore: new WebStorageStateStore({
+            prefix: "mx_oidc_",
+            store: window.sessionStorage
+          })
+        });
+      } catch (error) {
+        logger.error("Failed to initialise OIDC client.", error);
+        throw new Error("Failed to initialise OIDC client.");
+      }
+    })();
+  }
+
+  /**
+   * Attempt token refresh using given refresh token
+   * @param refreshToken - refresh token to use in request with token issuer
+   * @returns tokens - Promise that resolves with new access and refresh tokens
+   * @throws when token refresh fails
+   */
+  doRefreshAccessToken(refreshToken) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      yield _this3.ensureInit();
+      if (!_this3.inflightRefreshRequest) {
+        _this3.inflightRefreshRequest = _this3.getNewTokens(refreshToken);
+      }
+      try {
+        var tokens = yield _this3.inflightRefreshRequest;
+        return tokens;
+      } catch (e) {
+        // If we encounter an OIDC error then signal that it should cause a logout by upgrading it to a TokenRefreshLogoutError
+        if (e instanceof ErrorResponse) {
+          throw new TokenRefreshLogoutError(e);
+        }
+        throw e;
+      } finally {
+        _this3.inflightRefreshRequest = undefined;
+      }
+    })();
+  }
+
+  /**
+   * Persist the new tokens, called after tokens are successfully refreshed.
+   *
+   * This function is intended to be overriden by the consumer when persistence is necessary.
+   *
+   * @param tokens.accessToken - new access token
+   * @param tokens.refreshToken - OPTIONAL new refresh token
+   */
+  persistTokens(tokens) {
+    return _asyncToGenerator(function* () {})();
+  } // NOOP
+  getNewTokens(refreshToken) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this4.oidcClient) {
+        throw new Error("Cannot get new token before OIDC client is initialised.");
+      }
+      var refreshTokenState = {
+        refresh_token: refreshToken,
+        session_state: "test",
+        data: undefined,
+        profile: _this4.idTokenClaims
+      };
+      var requestStart = Date.now();
+      var response = yield _this4.oidcClient.useRefreshToken({
+        state: refreshTokenState,
+        timeoutInSeconds: 300
+      });
+      var tokens = {
+        accessToken: response.access_token,
+        refreshToken: response.refresh_token,
+        // We use the request start time to calculate the expiry time as we don't know when the server received our request
+        expiry: response.expires_in ? new Date(requestStart + response.expires_in * 1000) : undefined
+      };
+      yield _this4.persistTokens(tokens);
+      return tokens;
+    })();
+  }
+}
+//# sourceMappingURL=tokenRefresher.js.map

package/lib/oidc/tokenRefresher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenRefresher.js","names":["OidcClient","WebStorageStateStore","ErrorResponse","TokenRefreshLogoutError","generateScope","discoverAndValidateOIDCIssuerWellKnown","logger","OidcTokenRefresher","constructor","issuer","clientId","redirectUri","deviceId","idTokenClaims","_defineProperty","oidcClientReady","Promise","resolve","ensureInit","_this","_asyncToGenerator","oidcClient","initPromise","initialiseOidcClient","undefined","_this2","_config$signingKeys","config","scope","metadata","signingKeys","client_id","redirect_uri","authority","stateStore","prefix","store","window","sessionStorage","error","Error","doRefreshAccessToken","refreshToken","_this3","inflightRefreshRequest","getNewTokens","tokens","e","persistTokens","_this4","refreshTokenState","refresh_token","session_state","data","profile","requestStart","Date","now","response","useRefreshToken","state","timeoutInSeconds","accessToken","access_token","expiry","expires_in"],"sources":["../../src/oidc/tokenRefresher.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type IdTokenClaims, OidcClient, WebStorageStateStore, ErrorResponse } from \"oidc-client-ts\";\r\n\r\nimport { type AccessTokens, TokenRefreshLogoutError } from \"../http-api/index.ts\";\r\nimport { generateScope } from \"./authorize.ts\";\r\nimport { discoverAndValidateOIDCIssuerWellKnown } from \"./discovery.ts\";\r\nimport { logger } from \"../logger.ts\";\r\n\r\n/**\r\n * @experimental\r\n * Class responsible for refreshing OIDC access tokens\r\n *\r\n * Client implementations will likely want to override {@link persistTokens} to persist tokens after successful refresh\r\n *\r\n */\r\nexport class OidcTokenRefresher {\r\n    /**\r\n     * This is now just a resolved promise and will be removed in a future version.\r\n     * Initialisation is done lazily at token refresh time.\r\n     * @deprecated Consumers no longer need to wait for this promise.\r\n     */\r\n    public readonly oidcClientReady!: Promise<void>;\r\n\r\n    // If there is a initialisation attempt in progress, we keep track of it here.\r\n    private initPromise?: Promise<void>;\r\n\r\n    private oidcClient!: OidcClient;\r\n    private inflightRefreshRequest?: Promise<AccessTokens>;\r\n\r\n    public constructor(\r\n        /**\r\n         * The OIDC issuer as returned by the /auth_issuer API\r\n         */\r\n        private issuer: string,\r\n        /**\r\n         * id of this client as registered with the OP\r\n         */\r\n        private clientId: string,\r\n        /**\r\n         * redirectUri as registered with OP\r\n         */\r\n        private redirectUri: string,\r\n        /**\r\n         * Device ID of current session\r\n         */\r\n        protected deviceId: string,\r\n        /**\r\n         * idTokenClaims as returned from authorization grant\r\n         * used to validate tokens\r\n         */\r\n        private readonly idTokenClaims: IdTokenClaims,\r\n    ) {\r\n        this.oidcClientReady = Promise.resolve();\r\n    }\r\n\r\n    /**\r\n     * Ensures that the client is initialised.\r\n     * @returns Promise that resolves when initialisation is complete\r\n     * @throws if initialisation fails\r\n     */\r\n    private async ensureInit(): Promise<void> {\r\n        if (!this.oidcClient) {\r\n            if (this.initPromise) {\r\n                return this.initPromise;\r\n            }\r\n\r\n            this.initPromise = this.initialiseOidcClient(this.issuer, this.clientId, this.deviceId, this.redirectUri);\r\n            try {\r\n                await this.initPromise;\r\n            } finally {\r\n                this.initPromise = undefined;\r\n            }\r\n        }\r\n    }\r\n\r\n    private async initialiseOidcClient(\r\n        issuer: string,\r\n        clientId: string,\r\n        deviceId: string,\r\n        redirectUri: string,\r\n    ): Promise<void> {\r\n        try {\r\n            const config = await discoverAndValidateOIDCIssuerWellKnown(issuer);\r\n\r\n            const scope = generateScope(deviceId);\r\n\r\n            this.oidcClient = new OidcClient({\r\n                metadata: config,\r\n                signingKeys: config.signingKeys ?? undefined,\r\n                client_id: clientId,\r\n                scope,\r\n                redirect_uri: redirectUri,\r\n                authority: config.issuer,\r\n                stateStore: new WebStorageStateStore({ prefix: \"mx_oidc_\", store: window.sessionStorage }),\r\n            });\r\n        } catch (error) {\r\n            logger.error(\"Failed to initialise OIDC client.\", error);\r\n            throw new Error(\"Failed to initialise OIDC client.\");\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Attempt token refresh using given refresh token\r\n     * @param refreshToken - refresh token to use in request with token issuer\r\n     * @returns tokens - Promise that resolves with new access and refresh tokens\r\n     * @throws when token refresh fails\r\n     */\r\n    public async doRefreshAccessToken(refreshToken: string): Promise<AccessTokens> {\r\n        await this.ensureInit();\r\n\r\n        if (!this.inflightRefreshRequest) {\r\n            this.inflightRefreshRequest = this.getNewTokens(refreshToken);\r\n        }\r\n        try {\r\n            const tokens = await this.inflightRefreshRequest;\r\n            return tokens;\r\n        } catch (e) {\r\n            // If we encounter an OIDC error then signal that it should cause a logout by upgrading it to a TokenRefreshLogoutError\r\n            if (e instanceof ErrorResponse) {\r\n                throw new TokenRefreshLogoutError(e);\r\n            }\r\n            throw e;\r\n        } finally {\r\n            this.inflightRefreshRequest = undefined;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Persist the new tokens, called after tokens are successfully refreshed.\r\n     *\r\n     * This function is intended to be overriden by the consumer when persistence is necessary.\r\n     *\r\n     * @param tokens.accessToken - new access token\r\n     * @param tokens.refreshToken - OPTIONAL new refresh token\r\n     */\r\n    protected async persistTokens(tokens: { accessToken: string; refreshToken?: string }): Promise<void> {\r\n        // NOOP\r\n    }\r\n\r\n    private async getNewTokens(refreshToken: string): Promise<AccessTokens> {\r\n        if (!this.oidcClient) {\r\n            throw new Error(\"Cannot get new token before OIDC client is initialised.\");\r\n        }\r\n\r\n        const refreshTokenState = {\r\n            refresh_token: refreshToken,\r\n            session_state: \"test\",\r\n            data: undefined,\r\n            profile: this.idTokenClaims,\r\n        };\r\n\r\n        const requestStart = Date.now();\r\n        const response = await this.oidcClient.useRefreshToken({\r\n            state: refreshTokenState,\r\n            timeoutInSeconds: 300,\r\n        });\r\n\r\n        const tokens = {\r\n            accessToken: response.access_token,\r\n            refreshToken: response.refresh_token,\r\n            // We use the request start time to calculate the expiry time as we don't know when the server received our request\r\n            expiry: response.expires_in ? new Date(requestStart + response.expires_in * 1000) : undefined,\r\n        } satisfies AccessTokens;\r\n\r\n        await this.persistTokens(tokens);\r\n\r\n        return tokens;\r\n    }\r\n}\r\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAA6BA,UAAU,EAAEC,oBAAoB,EAAEC,aAAa,QAAQ,gBAAgB;AAEpG,SAA4BC,uBAAuB,QAAQ,sBAAsB;AACjF,SAASC,aAAa,QAAQ,gBAAgB;AAC9C,SAASC,sCAAsC,QAAQ,gBAAgB;AACvE,SAASC,MAAM,QAAQ,cAAc;;AAErC;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,kBAAkB,CAAC;EAcrBC,WAAWA;EACd;AACR;AACA;EACgBC,MAAc;EACtB;AACR;AACA;EACgBC,QAAgB;EACxB;AACR;AACA;EACgBC,WAAmB;EAC3B;AACR;AACA;EACkBC,QAAgB;EAC1B;AACR;AACA;AACA;EACyBC,aAA4B,EAC/C;IAAA,KAlBUJ,MAAc,GAAdA,MAAc;IAAA,KAIdC,QAAgB,GAAhBA,QAAgB;IAAA,KAIhBC,WAAmB,GAAnBA,WAAmB;IAAA,KAIjBC,QAAgB,GAAhBA,QAAgB;IAAA,KAKTC,aAA4B,GAA5BA,aAA4B;IAlCjD;AACJ;AACA;AACA;AACA;IAJIC,eAAA;IAOA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IA6BI,IAAI,CAACC,eAAe,GAAGC,OAAO,CAACC,OAAO,CAAC,CAAC;EAC5C;;EAEA;AACJ;AACA;AACA;AACA;EACkBC,UAAUA,CAAA,EAAkB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MACtC,IAAI,CAACD,KAAI,CAACE,UAAU,EAAE;QAClB,IAAIF,KAAI,CAACG,WAAW,EAAE;UAClB,OAAOH,KAAI,CAACG,WAAW;QAC3B;QAEAH,KAAI,CAACG,WAAW,GAAGH,KAAI,CAACI,oBAAoB,CAACJ,KAAI,CAACV,MAAM,EAAEU,KAAI,CAACT,QAAQ,EAAES,KAAI,CAACP,QAAQ,EAAEO,KAAI,CAACR,WAAW,CAAC;QACzG,IAAI;UACA,MAAMQ,KAAI,CAACG,WAAW;QAC1B,CAAC,SAAS;UACNH,KAAI,CAACG,WAAW,GAAGE,SAAS;QAChC;MACJ;IAAC;EACL;EAEcD,oBAAoBA,CAC9Bd,MAAc,EACdC,QAAgB,EAChBE,QAAgB,EAChBD,WAAmB,EACN;IAAA,IAAAc,MAAA;IAAA,OAAAL,iBAAA;MACb,IAAI;QAAA,IAAAM,mBAAA;QACA,IAAMC,MAAM,SAAStB,sCAAsC,CAACI,MAAM,CAAC;QAEnE,IAAMmB,KAAK,GAAGxB,aAAa,CAACQ,QAAQ,CAAC;QAErCa,MAAI,CAACJ,UAAU,GAAG,IAAIrB,UAAU,CAAC;UAC7B6B,QAAQ,EAAEF,MAAM;UAChBG,WAAW,GAAAJ,mBAAA,GAAEC,MAAM,CAACG,WAAW,cAAAJ,mBAAA,cAAAA,mBAAA,GAAIF,SAAS;UAC5CO,SAAS,EAAErB,QAAQ;UACnBkB,KAAK;UACLI,YAAY,EAAErB,WAAW;UACzBsB,SAAS,EAAEN,MAAM,CAAClB,MAAM;UACxByB,UAAU,EAAE,IAAIjC,oBAAoB,CAAC;YAAEkC,MAAM,EAAE,UAAU;YAAEC,KAAK,EAAEC,MAAM,CAACC;UAAe,CAAC;QAC7F,CAAC,CAAC;MACN,CAAC,CAAC,OAAOC,KAAK,EAAE;QACZjC,MAAM,CAACiC,KAAK,CAAC,mCAAmC,EAAEA,KAAK,CAAC;QACxD,MAAM,IAAIC,KAAK,CAAC,mCAAmC,CAAC;MACxD;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACiBC,oBAAoBA,CAACC,YAAoB,EAAyB;IAAA,IAAAC,MAAA;IAAA,OAAAvB,iBAAA;MAC3E,MAAMuB,MAAI,CAACzB,UAAU,CAAC,CAAC;MAEvB,IAAI,CAACyB,MAAI,CAACC,sBAAsB,EAAE;QAC9BD,MAAI,CAACC,sBAAsB,GAAGD,MAAI,CAACE,YAAY,CAACH,YAAY,CAAC;MACjE;MACA,IAAI;QACA,IAAMI,MAAM,SAASH,MAAI,CAACC,sBAAsB;QAChD,OAAOE,MAAM;MACjB,CAAC,CAAC,OAAOC,CAAC,EAAE;QACR;QACA,IAAIA,CAAC,YAAY7C,aAAa,EAAE;UAC5B,MAAM,IAAIC,uBAAuB,CAAC4C,CAAC,CAAC;QACxC;QACA,MAAMA,CAAC;MACX,CAAC,SAAS;QACNJ,MAAI,CAACC,sBAAsB,GAAGpB,SAAS;MAC3C;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACoBwB,aAAaA,CAACF,MAAsD,EAAiB;IAAA,OAAA1B,iBAAA;EAErG,CAAC,CADG;EAGUyB,YAAYA,CAACH,YAAoB,EAAyB;IAAA,IAAAO,MAAA;IAAA,OAAA7B,iBAAA;MACpE,IAAI,CAAC6B,MAAI,CAAC5B,UAAU,EAAE;QAClB,MAAM,IAAImB,KAAK,CAAC,yDAAyD,CAAC;MAC9E;MAEA,IAAMU,iBAAiB,GAAG;QACtBC,aAAa,EAAET,YAAY;QAC3BU,aAAa,EAAE,MAAM;QACrBC,IAAI,EAAE7B,SAAS;QACf8B,OAAO,EAAEL,MAAI,CAACpC;MAClB,CAAC;MAED,IAAM0C,YAAY,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC;MAC/B,IAAMC,QAAQ,SAAST,MAAI,CAAC5B,UAAU,CAACsC,eAAe,CAAC;QACnDC,KAAK,EAAEV,iBAAiB;QACxBW,gBAAgB,EAAE;MACtB,CAAC,CAAC;MAEF,IAAMf,MAAM,GAAG;QACXgB,WAAW,EAAEJ,QAAQ,CAACK,YAAY;QAClCrB,YAAY,EAAEgB,QAAQ,CAACP,aAAa;QACpC;QACAa,MAAM,EAAEN,QAAQ,CAACO,UAAU,GAAG,IAAIT,IAAI,CAACD,YAAY,GAAGG,QAAQ,CAACO,UAAU,GAAG,IAAI,CAAC,GAAGzC;MACxF,CAAwB;MAExB,MAAMyB,MAAI,CAACD,aAAa,CAACF,MAAM,CAAC;MAEhC,OAAOA,MAAM;IAAC;EAClB;AACJ","ignoreList":[]}

package/lib/oidc/validate.d.ts

@@ -0,0 +1,78 @@
+import { type IdTokenClaims, type OidcMetadata, type SigninResponse } from "oidc-client-ts";
+/**
+ * Metadata from OAuth 2.0 client authentication API as per
+ * https://spec.matrix.org/v1.17/client-server-api/#get_matrixclientv1auth_metadata
+ * With validated properties required in type
+ */
+export type ValidatedAuthMetadata = Partial<OidcMetadata> & Pick<OidcMetadata, "issuer" | "authorization_endpoint" | "token_endpoint" | "revocation_endpoint" | "response_types_supported" | "grant_types_supported" | "code_challenge_methods_supported"> & {
+    account_management_uri?: string;
+    account_management_actions_supported?: string[];
+    prompt_values_supported?: string[];
+    device_authorization_endpoint?: string;
+};
+/**
+ * Validates OAuth 2.0 auth metadata as defined by
+ * https://spec.matrix.org/v1.17/client-server-api/#get_matrixclientv1auth_metadata
+ * is compatible with Element's OAuth/OIDC flow
+ * @param authMetadata - json object
+ * @returns valid issuer config
+ * @throws Error - when issuer config is not found or is invalid
+ */
+export declare const validateAuthMetadata: (authMetadata: unknown) => ValidatedAuthMetadata;
+export declare const decodeIdToken: (token: string) => IdTokenClaims;
+/**
+ * Validate idToken
+ * https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
+ * @param idToken - id token from token endpoint
+ * @param issuer - issuer for the OP as found during discovery
+ * @param clientId - this client's id as registered with the OP
+ * @param nonce - nonce used in the authentication request
+ * @throws when id token is invalid
+ */
+export declare const validateIdToken: (idToken: string | undefined, issuer: string, clientId: string, nonce: string | undefined) => void;
+/**
+ * State we ask OidcClient to store when starting oidc authorization flow (in `generateOidcAuthorizationUrl`)
+ * so that we can access it on return from the OP and complete login
+ */
+export type UserState = {
+    /**
+     * Remember which server we were trying to login to
+     */
+    homeserverUrl: string;
+    identityServerUrl?: string;
+    /**
+     * Used to validate id token
+     */
+    nonce: string;
+};
+/**
+ * Validate stored user state exists and is valid
+ * @param userState - userState returned by oidcClient.processSigninResponse
+ * @throws when userState is invalid
+ */
+export declare function validateStoredUserState(userState: unknown): asserts userState is UserState;
+/**
+ * The expected response type from the token endpoint during authorization code flow
+ * Normalized to always use capitalized 'Bearer' for token_type
+ *
+ * See https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4,
+ * https://openid.net/specs/openid-connect-basic-1_0.html#TokenOK.
+ */
+export type BearerTokenResponse = {
+    token_type: "Bearer";
+    access_token: string;
+    scope: string;
+    refresh_token?: string;
+    expires_in?: number;
+    expires_at?: number;
+    id_token: string;
+};
+/**
+ * Make required properties required in type
+ */
+type ValidSignInResponse = SigninResponse & BearerTokenResponse & {
+    token_type: "Bearer" | "bearer";
+};
+export declare function validateBearerTokenResponse(response: unknown): asserts response is ValidSignInResponse;
+export {};
+//# sourceMappingURL=validate.d.ts.map

package/lib/oidc/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/oidc/validate.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAM5F;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC,GACrD,IAAI,CAGA,YAAY,EACV,QAAQ,GACR,wBAAwB,GACxB,gBAAgB,GAChB,qBAAqB,GACrB,0BAA0B,GAC1B,uBAAuB,GACvB,kCAAkC,CACvC,GAAG;IAGA,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,oCAAoC,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhD,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC,6BAA6B,CAAC,EAAE,MAAM,CAAC;CAC1C,CAAC;AAqCN;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,OAAO,KAAG,qBA2B5D,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,aAO7C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GACxB,SAAS,MAAM,GAAG,SAAS,EAC3B,QAAQ,MAAM,EACd,UAAU,MAAM,EAChB,OAAO,MAAM,GAAG,SAAS,KAC1B,IAyCF,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AACF;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,SAAS,CAc1F;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,UAAU,EAAE,QAAQ,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,KAAK,mBAAmB,GAAG,cAAc,GACrC,mBAAmB,GAAG;IAClB,UAAU,EAAE,QAAQ,GAAG,QAAQ,CAAC;CACnC,CAAC;AAWN,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,IAAI,mBAAmB,CAItG"}