@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/oidc/authorize.js

@@ -0,0 +1,278 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+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 { Log, OidcClient, SigninResponse, SigninState, WebStorageStateStore } from "oidc-client-ts";
+import { logger } from "../logger.js";
+import { randomString } from "../randomstring.js";
+import { OidcError } from "./error.js";
+import { validateBearerTokenResponse, validateIdToken, validateStoredUserState } from "./validate.js";
+import { sha256 } from "../digest.js";
+import { encodeUnpaddedBase64Url } from "../base64.js";
+
+// reexport for backwards compatibility
+
+/**
+ * Authorization parameters which are used in the authentication request of an OIDC auth code flow.
+ *
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#RequestParameters.
+ */
+
+/**
+ * @experimental
+ * Generate the scope used in authorization request with OIDC OP
+ * @returns scope
+ */
+export var generateScope = deviceId => {
+  var safeDeviceId = deviceId !== null && deviceId !== void 0 ? deviceId : randomString(10);
+  return "openid urn:matrix:org.matrix.msc2967.client:api:* urn:matrix:org.matrix.msc2967.client:device:".concat(safeDeviceId);
+};
+
+// https://www.rfc-editor.org/rfc/rfc7636
+var generateCodeChallenge = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(function* (codeVerifier) {
+    if (!globalThis.crypto.subtle) {
+      // @TODO(kerrya) should this be allowed? configurable?
+      logger.warn("A secure context is required to generate code challenge. Using plain text code challenge");
+      return codeVerifier;
+    }
+    var hashBuffer = yield sha256(codeVerifier);
+    return encodeUnpaddedBase64Url(hashBuffer);
+  });
+  return function generateCodeChallenge(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+/**
+ * Generate authorization params to pass to {@link generateAuthorizationUrl}.
+ *
+ * Used as part of an authorization code OIDC flow: see https://openid.net/specs/openid-connect-basic-1_0.html#CodeFlow.
+ *
+ * @param redirectUri - absolute url for OP to redirect to after authorization
+ * @returns AuthorizationParams
+ */
+export var generateAuthorizationParams = _ref2 => {
+  var {
+    redirectUri
+  } = _ref2;
+  return {
+    scope: generateScope(),
+    redirectUri,
+    state: randomString(8),
+    nonce: randomString(8),
+    codeVerifier: randomString(64) // https://tools.ietf.org/html/rfc7636#section-4.1 length needs to be 43-128 characters
+  };
+};
+
+/**
+ * @deprecated use generateOidcAuthorizationUrl
+ * Generate a URL to attempt authorization with the OP
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest
+ * @param authorizationUrl - endpoint to attempt authorization with the OP
+ * @param clientId - id of this client as registered with the OP
+ * @param authorizationParams - params to be used in the url
+ * @returns a Promise with the url as a string
+ */
+export var generateAuthorizationUrl = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator(function* (authorizationUrl, clientId, _ref3) {
+    var {
+      scope,
+      redirectUri,
+      state,
+      nonce,
+      codeVerifier
+    } = _ref3;
+    var url = new URL(authorizationUrl);
+    url.searchParams.append("response_mode", "query");
+    url.searchParams.append("response_type", "code");
+    url.searchParams.append("redirect_uri", redirectUri);
+    url.searchParams.append("client_id", clientId);
+    url.searchParams.append("state", state);
+    url.searchParams.append("scope", scope);
+    url.searchParams.append("nonce", nonce);
+    url.searchParams.append("code_challenge_method", "S256");
+    url.searchParams.append("code_challenge", yield generateCodeChallenge(codeVerifier));
+    return url.toString();
+  });
+  return function generateAuthorizationUrl(_x2, _x3, _x4) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+
+/**
+ * @experimental
+ * Generate a URL to attempt authorization with the OP
+ * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest
+ * @param metadata - validated metadata from OP discovery
+ * @param clientId - this client's id as registered with the OP
+ * @param homeserverUrl - used to establish the session on return from the OP
+ * @param identityServerUrl - used to establish the session on return from the OP
+ * @param nonce - state
+ * @param prompt - indicates to the OP which flow the user should see - eg login or registration
+ *          See https://openid.net/specs/openid-connect-prompt-create-1_0.html#name-prompt-parameter
+ * @param urlState - value to append to the opaque state identifier to uniquely identify the callback
+ * @returns a Promise with the url as a string
+ */
+export var generateOidcAuthorizationUrl = /*#__PURE__*/function () {
+  var _ref6 = _asyncToGenerator(function* (_ref5) {
+    var {
+      metadata,
+      redirectUri,
+      clientId,
+      homeserverUrl,
+      identityServerUrl,
+      nonce,
+      prompt,
+      urlState
+    } = _ref5;
+    var scope = generateScope();
+    var oidcClient = new OidcClient(_objectSpread(_objectSpread({}, metadata), {}, {
+      client_id: clientId,
+      redirect_uri: redirectUri,
+      authority: metadata.issuer,
+      response_mode: "query",
+      response_type: "code",
+      scope,
+      stateStore: new WebStorageStateStore({
+        prefix: "mx_oidc_",
+        store: window.sessionStorage
+      })
+    }));
+    var userState = {
+      homeserverUrl,
+      nonce,
+      identityServerUrl
+    };
+    var request = yield oidcClient.createSigninRequest({
+      state: userState,
+      nonce,
+      prompt,
+      url_state: urlState
+    });
+    return request.url;
+  });
+  return function generateOidcAuthorizationUrl(_x5) {
+    return _ref6.apply(this, arguments);
+  };
+}();
+
+/**
+ * Normalize token_type to use capital case to make consuming the token response easier
+ * token_type is case insensitive, and it is spec-compliant for OPs to return token_type: "bearer"
+ * Later, when used in auth headers it is case sensitive and must be Bearer
+ * See: https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4
+ *
+ * @param response - validated token response
+ * @returns response with token_type set to 'Bearer'
+ */
+var normalizeBearerTokenResponseTokenType = response => ({
+  id_token: response.id_token,
+  scope: response.scope,
+  expires_at: response.expires_at,
+  refresh_token: response.refresh_token,
+  access_token: response.access_token,
+  token_type: "Bearer"
+});
+
+/**
+ * @experimental
+ * Attempt to exchange authorization code for bearer token.
+ *
+ * Takes the authorization code returned by the OpenID Provider via the authorization URL, and makes a
+ * request to the Token Endpoint, to obtain the access token, refresh token, etc.
+ *
+ * @param code - authorization code as returned by OP during authorization
+ * @param storedAuthorizationParams - stored params from start of oidc login flow
+ * @returns valid bearer token response
+ * @throws An `Error` with `message` set to an entry in {@link OidcError},
+ *      when the request fails, or the returned token response is invalid.
+ */
+export var completeAuthorizationCodeGrant = /*#__PURE__*/function () {
+  var _ref7 = _asyncToGenerator(function* (code, state) {
+    /**
+     * Element Web strips and changes the url on starting the app
+     * Use the code and state from query params to rebuild a url
+     * so that oidc-client can parse it
+     */
+    var reconstructedUrl = new URL(window.location.origin);
+    reconstructedUrl.searchParams.append("code", code);
+    reconstructedUrl.searchParams.append("state", state);
+
+    // set oidc-client to use our logger
+    Log.setLogger(logger);
+    try {
+      var response = new SigninResponse(reconstructedUrl.searchParams);
+      var stateStore = new WebStorageStateStore({
+        prefix: "mx_oidc_",
+        store: window.sessionStorage
+      });
+
+      // retrieve the state we put in storage at the start of oidc auth flow
+      var stateString = yield stateStore.get(response.state);
+      if (!stateString) {
+        throw new Error(OidcError.MissingOrInvalidStoredState);
+      }
+
+      // hydrate the sign in state and create a client
+      // the stored sign in state includes oidc configuration we set at the start of the oidc login flow
+      var signInState = yield SigninState.fromStorageString(stateString);
+      var client = new OidcClient(_objectSpread(_objectSpread({}, signInState), {}, {
+        stateStore
+      }));
+
+      // validate the code and state, and attempt to swap the code for tokens
+      var signinResponse = yield client.processSigninResponse(reconstructedUrl.href);
+
+      // extra values we stored at the start of the login flow
+      // used to complete login in the client
+      var userState = signinResponse.userState;
+      validateStoredUserState(userState);
+
+      // throws when response is invalid
+      validateBearerTokenResponse(signinResponse);
+      // throws when token is invalid
+      validateIdToken(signinResponse.id_token, client.settings.authority, client.settings.client_id, userState.nonce);
+      var normalizedTokenResponse = normalizeBearerTokenResponseTokenType(signinResponse);
+      return {
+        oidcClientSettings: {
+          clientId: client.settings.client_id,
+          issuer: client.settings.authority
+        },
+        tokenResponse: normalizedTokenResponse,
+        homeserverUrl: userState.homeserverUrl,
+        identityServerUrl: userState.identityServerUrl,
+        idTokenClaims: signinResponse.profile
+      };
+    } catch (error) {
+      logger.error("Oidc login failed", error);
+      var errorType = error.message;
+
+      // rethrow errors that we recognise
+      if (Object.values(OidcError).includes(errorType)) {
+        throw error;
+      }
+      throw new Error(OidcError.CodeExchangeFailed);
+    }
+  });
+  return function completeAuthorizationCodeGrant(_x6, _x7) {
+    return _ref7.apply(this, arguments);
+  };
+}();
+//# sourceMappingURL=authorize.js.map

package/lib/oidc/authorize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authorize.js","names":["Log","OidcClient","SigninResponse","SigninState","WebStorageStateStore","logger","randomString","OidcError","validateBearerTokenResponse","validateIdToken","validateStoredUserState","sha256","encodeUnpaddedBase64Url","generateScope","deviceId","safeDeviceId","concat","generateCodeChallenge","_ref","_asyncToGenerator","codeVerifier","globalThis","crypto","subtle","warn","hashBuffer","_x","apply","arguments","generateAuthorizationParams","_ref2","redirectUri","scope","state","nonce","generateAuthorizationUrl","_ref4","authorizationUrl","clientId","_ref3","url","URL","searchParams","append","toString","_x2","_x3","_x4","generateOidcAuthorizationUrl","_ref6","_ref5","metadata","homeserverUrl","identityServerUrl","prompt","urlState","oidcClient","_objectSpread","client_id","redirect_uri","authority","issuer","response_mode","response_type","stateStore","prefix","store","window","sessionStorage","userState","request","createSigninRequest","url_state","_x5","normalizeBearerTokenResponseTokenType","response","id_token","expires_at","refresh_token","access_token","token_type","completeAuthorizationCodeGrant","_ref7","code","reconstructedUrl","location","origin","setLogger","stateString","get","Error","MissingOrInvalidStoredState","signInState","fromStorageString","client","signinResponse","processSigninResponse","href","settings","normalizedTokenResponse","oidcClientSettings","tokenResponse","idTokenClaims","profile","error","errorType","message","Object","values","includes","CodeExchangeFailed","_x6","_x7"],"sources":["../../src/oidc/authorize.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { IdTokenClaims, Log, OidcClient, SigninResponse, SigninState, WebStorageStateStore } from \"oidc-client-ts\";\n\nimport { logger } from \"../logger.ts\";\nimport { randomString } from \"../randomstring.ts\";\nimport { OidcError } from \"./error.ts\";\nimport {\n    BearerTokenResponse,\n    UserState,\n    validateBearerTokenResponse,\n    ValidatedIssuerMetadata,\n    validateIdToken,\n    validateStoredUserState,\n} from \"./validate.ts\";\nimport { sha256 } from \"../digest.ts\";\nimport { encodeUnpaddedBase64Url } from \"../base64.ts\";\n\n// reexport for backwards compatibility\nexport type { BearerTokenResponse };\n\n/**\n * Authorization parameters which are used in the authentication request of an OIDC auth code flow.\n *\n * See https://openid.net/specs/openid-connect-basic-1_0.html#RequestParameters.\n */\nexport type AuthorizationParams = {\n    state: string;\n    scope: string;\n    redirectUri: string;\n    codeVerifier: string;\n    nonce: string;\n};\n\n/**\n * @experimental\n * Generate the scope used in authorization request with OIDC OP\n * @returns scope\n */\nexport const generateScope = (deviceId?: string): string => {\n    const safeDeviceId = deviceId ?? randomString(10);\n    return `openid urn:matrix:org.matrix.msc2967.client:api:* urn:matrix:org.matrix.msc2967.client:device:${safeDeviceId}`;\n};\n\n// https://www.rfc-editor.org/rfc/rfc7636\nconst generateCodeChallenge = async (codeVerifier: string): Promise<string> => {\n    if (!globalThis.crypto.subtle) {\n        // @TODO(kerrya) should this be allowed? configurable?\n        logger.warn(\"A secure context is required to generate code challenge. Using plain text code challenge\");\n        return codeVerifier;\n    }\n\n    const hashBuffer = await sha256(codeVerifier);\n    return encodeUnpaddedBase64Url(hashBuffer);\n};\n\n/**\n * Generate authorization params to pass to {@link generateAuthorizationUrl}.\n *\n * Used as part of an authorization code OIDC flow: see https://openid.net/specs/openid-connect-basic-1_0.html#CodeFlow.\n *\n * @param redirectUri - absolute url for OP to redirect to after authorization\n * @returns AuthorizationParams\n */\nexport const generateAuthorizationParams = ({ redirectUri }: { redirectUri: string }): AuthorizationParams => ({\n    scope: generateScope(),\n    redirectUri,\n    state: randomString(8),\n    nonce: randomString(8),\n    codeVerifier: randomString(64), // https://tools.ietf.org/html/rfc7636#section-4.1 length needs to be 43-128 characters\n});\n\n/**\n * @deprecated use generateOidcAuthorizationUrl\n * Generate a URL to attempt authorization with the OP\n * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest\n * @param authorizationUrl - endpoint to attempt authorization with the OP\n * @param clientId - id of this client as registered with the OP\n * @param authorizationParams - params to be used in the url\n * @returns a Promise with the url as a string\n */\nexport const generateAuthorizationUrl = async (\n    authorizationUrl: string,\n    clientId: string,\n    { scope, redirectUri, state, nonce, codeVerifier }: AuthorizationParams,\n): Promise<string> => {\n    const url = new URL(authorizationUrl);\n    url.searchParams.append(\"response_mode\", \"query\");\n    url.searchParams.append(\"response_type\", \"code\");\n    url.searchParams.append(\"redirect_uri\", redirectUri);\n    url.searchParams.append(\"client_id\", clientId);\n    url.searchParams.append(\"state\", state);\n    url.searchParams.append(\"scope\", scope);\n    url.searchParams.append(\"nonce\", nonce);\n\n    url.searchParams.append(\"code_challenge_method\", \"S256\");\n    url.searchParams.append(\"code_challenge\", await generateCodeChallenge(codeVerifier));\n\n    return url.toString();\n};\n\n/**\n * @experimental\n * Generate a URL to attempt authorization with the OP\n * See https://openid.net/specs/openid-connect-basic-1_0.html#CodeRequest\n * @param metadata - validated metadata from OP discovery\n * @param clientId - this client's id as registered with the OP\n * @param homeserverUrl - used to establish the session on return from the OP\n * @param identityServerUrl - used to establish the session on return from the OP\n * @param nonce - state\n * @param prompt - indicates to the OP which flow the user should see - eg login or registration\n *          See https://openid.net/specs/openid-connect-prompt-create-1_0.html#name-prompt-parameter\n * @param urlState - value to append to the opaque state identifier to uniquely identify the callback\n * @returns a Promise with the url as a string\n */\nexport const generateOidcAuthorizationUrl = async ({\n    metadata,\n    redirectUri,\n    clientId,\n    homeserverUrl,\n    identityServerUrl,\n    nonce,\n    prompt,\n    urlState,\n}: {\n    clientId: string;\n    metadata: ValidatedIssuerMetadata;\n    homeserverUrl: string;\n    identityServerUrl?: string;\n    redirectUri: string;\n    nonce: string;\n    prompt?: string;\n    urlState?: string;\n}): Promise<string> => {\n    const scope = generateScope();\n    const oidcClient = new OidcClient({\n        ...metadata,\n        client_id: clientId,\n        redirect_uri: redirectUri,\n        authority: metadata.issuer,\n        response_mode: \"query\",\n        response_type: \"code\",\n        scope,\n        stateStore: new WebStorageStateStore({ prefix: \"mx_oidc_\", store: window.sessionStorage }),\n    });\n    const userState: UserState = { homeserverUrl, nonce, identityServerUrl };\n    const request = await oidcClient.createSigninRequest({\n        state: userState,\n        nonce,\n        prompt,\n        url_state: urlState,\n    });\n\n    return request.url;\n};\n\n/**\n * Normalize token_type to use capital case to make consuming the token response easier\n * token_type is case insensitive, and it is spec-compliant for OPs to return token_type: \"bearer\"\n * Later, when used in auth headers it is case sensitive and must be Bearer\n * See: https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.4\n *\n * @param response - validated token response\n * @returns response with token_type set to 'Bearer'\n */\nconst normalizeBearerTokenResponseTokenType = (response: SigninResponse): BearerTokenResponse =>\n    ({\n        id_token: response.id_token,\n        scope: response.scope,\n        expires_at: response.expires_at,\n        refresh_token: response.refresh_token,\n        access_token: response.access_token,\n        token_type: \"Bearer\",\n    }) as BearerTokenResponse;\n\n/**\n * @experimental\n * Attempt to exchange authorization code for bearer token.\n *\n * Takes the authorization code returned by the OpenID Provider via the authorization URL, and makes a\n * request to the Token Endpoint, to obtain the access token, refresh token, etc.\n *\n * @param code - authorization code as returned by OP during authorization\n * @param storedAuthorizationParams - stored params from start of oidc login flow\n * @returns valid bearer token response\n * @throws An `Error` with `message` set to an entry in {@link OidcError},\n *      when the request fails, or the returned token response is invalid.\n */\nexport const completeAuthorizationCodeGrant = async (\n    code: string,\n    state: string,\n): Promise<{\n    oidcClientSettings: { clientId: string; issuer: string };\n    tokenResponse: BearerTokenResponse;\n    homeserverUrl: string;\n    idTokenClaims: IdTokenClaims;\n    identityServerUrl?: string;\n}> => {\n    /**\n     * Element Web strips and changes the url on starting the app\n     * Use the code and state from query params to rebuild a url\n     * so that oidc-client can parse it\n     */\n    const reconstructedUrl = new URL(window.location.origin);\n    reconstructedUrl.searchParams.append(\"code\", code);\n    reconstructedUrl.searchParams.append(\"state\", state);\n\n    // set oidc-client to use our logger\n    Log.setLogger(logger);\n    try {\n        const response = new SigninResponse(reconstructedUrl.searchParams);\n\n        const stateStore = new WebStorageStateStore({ prefix: \"mx_oidc_\", store: window.sessionStorage });\n\n        // retrieve the state we put in storage at the start of oidc auth flow\n        const stateString = await stateStore.get(response.state!);\n        if (!stateString) {\n            throw new Error(OidcError.MissingOrInvalidStoredState);\n        }\n\n        // hydrate the sign in state and create a client\n        // the stored sign in state includes oidc configuration we set at the start of the oidc login flow\n        const signInState = await SigninState.fromStorageString(stateString);\n        const client = new OidcClient({ ...signInState, stateStore });\n\n        // validate the code and state, and attempt to swap the code for tokens\n        const signinResponse = await client.processSigninResponse(reconstructedUrl.href);\n\n        // extra values we stored at the start of the login flow\n        // used to complete login in the client\n        const userState = signinResponse.userState;\n        validateStoredUserState(userState);\n\n        // throws when response is invalid\n        validateBearerTokenResponse(signinResponse);\n        // throws when token is invalid\n        validateIdToken(signinResponse.id_token, client.settings.authority, client.settings.client_id, userState.nonce);\n        const normalizedTokenResponse = normalizeBearerTokenResponseTokenType(signinResponse);\n\n        return {\n            oidcClientSettings: {\n                clientId: client.settings.client_id,\n                issuer: client.settings.authority,\n            },\n            tokenResponse: normalizedTokenResponse,\n            homeserverUrl: userState.homeserverUrl,\n            identityServerUrl: userState.identityServerUrl,\n            idTokenClaims: signinResponse.profile,\n        };\n    } catch (error) {\n        logger.error(\"Oidc login failed\", error);\n        const errorType = (error as Error).message;\n\n        // rethrow errors that we recognise\n        if (Object.values(OidcError).includes(errorType as any)) {\n            throw error;\n        }\n        throw new Error(OidcError.CodeExchangeFailed);\n    }\n};\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAAwBA,GAAG,EAAEC,UAAU,EAAEC,cAAc,EAAEC,WAAW,EAAEC,oBAAoB,QAAQ,gBAAgB;AAElH,SAASC,MAAM,QAAQ,cAAc;AACrC,SAASC,YAAY,QAAQ,oBAAoB;AACjD,SAASC,SAAS,QAAQ,YAAY;AACtC,SAGIC,2BAA2B,EAE3BC,eAAe,EACfC,uBAAuB,QACpB,eAAe;AACtB,SAASC,MAAM,QAAQ,cAAc;AACrC,SAASC,uBAAuB,QAAQ,cAAc;;AAEtD;;AAGA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,aAAa,GAAIC,QAAiB,IAAa;EACxD,IAAMC,YAAY,GAAGD,QAAQ,aAARA,QAAQ,cAARA,QAAQ,GAAIR,YAAY,CAAC,EAAE,CAAC;EACjD,wGAAAU,MAAA,CAAwGD,YAAY;AACxH,CAAC;;AAED;AACA,IAAME,qBAAqB;EAAA,IAAAC,IAAA,GAAAC,iBAAA,CAAG,WAAOC,YAAoB,EAAsB;IAC3E,IAAI,CAACC,UAAU,CAACC,MAAM,CAACC,MAAM,EAAE;MAC3B;MACAlB,MAAM,CAACmB,IAAI,CAAC,0FAA0F,CAAC;MACvG,OAAOJ,YAAY;IACvB;IAEA,IAAMK,UAAU,SAASd,MAAM,CAACS,YAAY,CAAC;IAC7C,OAAOR,uBAAuB,CAACa,UAAU,CAAC;EAC9C,CAAC;EAAA,gBATKR,qBAAqBA,CAAAS,EAAA;IAAA,OAAAR,IAAA,CAAAS,KAAA,OAAAC,SAAA;EAAA;AAAA,GAS1B;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,2BAA2B,GAAGC,KAAA;EAAA,IAAC;IAAEC;EAAqC,CAAC,GAAAD,KAAA;EAAA,OAA2B;IAC3GE,KAAK,EAAEnB,aAAa,CAAC,CAAC;IACtBkB,WAAW;IACXE,KAAK,EAAE3B,YAAY,CAAC,CAAC,CAAC;IACtB4B,KAAK,EAAE5B,YAAY,CAAC,CAAC,CAAC;IACtBc,YAAY,EAAEd,YAAY,CAAC,EAAE,CAAC,CAAE;EACpC,CAAC;AAAA,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAM6B,wBAAwB;EAAA,IAAAC,KAAA,GAAAjB,iBAAA,CAAG,WACpCkB,gBAAwB,EACxBC,QAAgB,EAAAC,KAAA,EAEE;IAAA,IADlB;MAAEP,KAAK;MAAED,WAAW;MAAEE,KAAK;MAAEC,KAAK;MAAEd;IAAkC,CAAC,GAAAmB,KAAA;IAEvE,IAAMC,GAAG,GAAG,IAAIC,GAAG,CAACJ,gBAAgB,CAAC;IACrCG,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC;IACjDH,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC;IAChDH,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,cAAc,EAAEZ,WAAW,CAAC;IACpDS,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,WAAW,EAAEL,QAAQ,CAAC;IAC9CE,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,OAAO,EAAEV,KAAK,CAAC;IACvCO,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,OAAO,EAAEX,KAAK,CAAC;IACvCQ,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,OAAO,EAAET,KAAK,CAAC;IAEvCM,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACxDH,GAAG,CAACE,YAAY,CAACC,MAAM,CAAC,gBAAgB,QAAQ1B,qBAAqB,CAACG,YAAY,CAAC,CAAC;IAEpF,OAAOoB,GAAG,CAACI,QAAQ,CAAC,CAAC;EACzB,CAAC;EAAA,gBAlBYT,wBAAwBA,CAAAU,GAAA,EAAAC,GAAA,EAAAC,GAAA;IAAA,OAAAX,KAAA,CAAAT,KAAA,OAAAC,SAAA;EAAA;AAAA,GAkBpC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMoB,4BAA4B;EAAA,IAAAC,KAAA,GAAA9B,iBAAA,CAAG,WAAA+B,KAAA,EAkBrB;IAAA,IAlB4B;MAC/CC,QAAQ;MACRpB,WAAW;MACXO,QAAQ;MACRc,aAAa;MACbC,iBAAiB;MACjBnB,KAAK;MACLoB,MAAM;MACNC;IAUJ,CAAC,GAAAL,KAAA;IACG,IAAMlB,KAAK,GAAGnB,aAAa,CAAC,CAAC;IAC7B,IAAM2C,UAAU,GAAG,IAAIvD,UAAU,CAAAwD,aAAA,CAAAA,aAAA,KAC1BN,QAAQ;MACXO,SAAS,EAAEpB,QAAQ;MACnBqB,YAAY,EAAE5B,WAAW;MACzB6B,SAAS,EAAET,QAAQ,CAACU,MAAM;MAC1BC,aAAa,EAAE,OAAO;MACtBC,aAAa,EAAE,MAAM;MACrB/B,KAAK;MACLgC,UAAU,EAAE,IAAI5D,oBAAoB,CAAC;QAAE6D,MAAM,EAAE,UAAU;QAAEC,KAAK,EAAEC,MAAM,CAACC;MAAe,CAAC;IAAC,EAC7F,CAAC;IACF,IAAMC,SAAoB,GAAG;MAAEjB,aAAa;MAAElB,KAAK;MAAEmB;IAAkB,CAAC;IACxE,IAAMiB,OAAO,SAASd,UAAU,CAACe,mBAAmB,CAAC;MACjDtC,KAAK,EAAEoC,SAAS;MAChBnC,KAAK;MACLoB,MAAM;MACNkB,SAAS,EAAEjB;IACf,CAAC,CAAC;IAEF,OAAOe,OAAO,CAAC9B,GAAG;EACtB,CAAC;EAAA,gBAvCYQ,4BAA4BA,CAAAyB,GAAA;IAAA,OAAAxB,KAAA,CAAAtB,KAAA,OAAAC,SAAA;EAAA;AAAA,GAuCxC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAM8C,qCAAqC,GAAIC,QAAwB,KAClE;EACGC,QAAQ,EAAED,QAAQ,CAACC,QAAQ;EAC3B5C,KAAK,EAAE2C,QAAQ,CAAC3C,KAAK;EACrB6C,UAAU,EAAEF,QAAQ,CAACE,UAAU;EAC/BC,aAAa,EAAEH,QAAQ,CAACG,aAAa;EACrCC,YAAY,EAAEJ,QAAQ,CAACI,YAAY;EACnCC,UAAU,EAAE;AAChB,CAAC,CAAwB;;AAE7B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,8BAA8B;EAAA,IAAAC,KAAA,GAAA/D,iBAAA,CAAG,WAC1CgE,IAAY,EACZlD,KAAa,EAOX;IACF;AACJ;AACA;AACA;AACA;IACI,IAAMmD,gBAAgB,GAAG,IAAI3C,GAAG,CAAC0B,MAAM,CAACkB,QAAQ,CAACC,MAAM,CAAC;IACxDF,gBAAgB,CAAC1C,YAAY,CAACC,MAAM,CAAC,MAAM,EAAEwC,IAAI,CAAC;IAClDC,gBAAgB,CAAC1C,YAAY,CAACC,MAAM,CAAC,OAAO,EAAEV,KAAK,CAAC;;IAEpD;IACAjC,GAAG,CAACuF,SAAS,CAAClF,MAAM,CAAC;IACrB,IAAI;MACA,IAAMsE,QAAQ,GAAG,IAAIzE,cAAc,CAACkF,gBAAgB,CAAC1C,YAAY,CAAC;MAElE,IAAMsB,UAAU,GAAG,IAAI5D,oBAAoB,CAAC;QAAE6D,MAAM,EAAE,UAAU;QAAEC,KAAK,EAAEC,MAAM,CAACC;MAAe,CAAC,CAAC;;MAEjG;MACA,IAAMoB,WAAW,SAASxB,UAAU,CAACyB,GAAG,CAACd,QAAQ,CAAC1C,KAAM,CAAC;MACzD,IAAI,CAACuD,WAAW,EAAE;QACd,MAAM,IAAIE,KAAK,CAACnF,SAAS,CAACoF,2BAA2B,CAAC;MAC1D;;MAEA;MACA;MACA,IAAMC,WAAW,SAASzF,WAAW,CAAC0F,iBAAiB,CAACL,WAAW,CAAC;MACpE,IAAMM,MAAM,GAAG,IAAI7F,UAAU,CAAAwD,aAAA,CAAAA,aAAA,KAAMmC,WAAW;QAAE5B;MAAU,EAAE,CAAC;;MAE7D;MACA,IAAM+B,cAAc,SAASD,MAAM,CAACE,qBAAqB,CAACZ,gBAAgB,CAACa,IAAI,CAAC;;MAEhF;MACA;MACA,IAAM5B,SAAS,GAAG0B,cAAc,CAAC1B,SAAS;MAC1C3D,uBAAuB,CAAC2D,SAAS,CAAC;;MAElC;MACA7D,2BAA2B,CAACuF,cAAc,CAAC;MAC3C;MACAtF,eAAe,CAACsF,cAAc,CAACnB,QAAQ,EAAEkB,MAAM,CAACI,QAAQ,CAACtC,SAAS,EAAEkC,MAAM,CAACI,QAAQ,CAACxC,SAAS,EAAEW,SAAS,CAACnC,KAAK,CAAC;MAC/G,IAAMiE,uBAAuB,GAAGzB,qCAAqC,CAACqB,cAAc,CAAC;MAErF,OAAO;QACHK,kBAAkB,EAAE;UAChB9D,QAAQ,EAAEwD,MAAM,CAACI,QAAQ,CAACxC,SAAS;UACnCG,MAAM,EAAEiC,MAAM,CAACI,QAAQ,CAACtC;QAC5B,CAAC;QACDyC,aAAa,EAAEF,uBAAuB;QACtC/C,aAAa,EAAEiB,SAAS,CAACjB,aAAa;QACtCC,iBAAiB,EAAEgB,SAAS,CAAChB,iBAAiB;QAC9CiD,aAAa,EAAEP,cAAc,CAACQ;MAClC,CAAC;IACL,CAAC,CAAC,OAAOC,KAAK,EAAE;MACZnG,MAAM,CAACmG,KAAK,CAAC,mBAAmB,EAAEA,KAAK,CAAC;MACxC,IAAMC,SAAS,GAAID,KAAK,CAAWE,OAAO;;MAE1C;MACA,IAAIC,MAAM,CAACC,MAAM,CAACrG,SAAS,CAAC,CAACsG,QAAQ,CAACJ,SAAgB,CAAC,EAAE;QACrD,MAAMD,KAAK;MACf;MACA,MAAM,IAAId,KAAK,CAACnF,SAAS,CAACuG,kBAAkB,CAAC;IACjD;EACJ,CAAC;EAAA,gBAvEY7B,8BAA8BA,CAAA8B,GAAA,EAAAC,GAAA;IAAA,OAAA9B,KAAA,CAAAvD,KAAA,OAAAC,SAAA;EAAA;AAAA,GAuE1C","ignoreList":[]}

package/lib/oidc/discovery.d.ts

@@ -0,0 +1,14 @@
+import { OidcClientConfig } from "./index.ts";
+/**
+ * @experimental
+ * Discover and validate delegated auth configuration
+ * - delegated auth issuer openid-configuration is reachable
+ * - delegated auth issuer openid-configuration is configured correctly for us
+ * Fetches https://oidc-issuer.example.com/.well-known/openid-configuration and other files linked therein.
+ * When successful, validated metadata is returned
+ * @param issuer - the OIDC issuer as returned by the /auth_issuer API
+ * @returns validated authentication metadata and optionally signing keys
+ * @throws when delegated auth config is invalid or unreachable
+ */
+export declare const discoverAndValidateOIDCIssuerWellKnown: (issuer: string) => Promise<OidcClientConfig>;
+//# sourceMappingURL=discovery.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../../src/oidc/discovery.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sCAAsC,WAAkB,MAAM,KAAG,OAAO,CAAC,gBAAgB,CA0BrG,CAAC"}

package/lib/oidc/discovery.js

@@ -0,0 +1,66 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+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 { MetadataService, OidcClientSettingsStore } from "oidc-client-ts";
+import { isValidatedIssuerMetadata, validateOIDCIssuerWellKnown } from "./validate.js";
+import { Method, timeoutSignal } from "../http-api/index.js";
+/**
+ * @experimental
+ * Discover and validate delegated auth configuration
+ * - delegated auth issuer openid-configuration is reachable
+ * - delegated auth issuer openid-configuration is configured correctly for us
+ * Fetches https://oidc-issuer.example.com/.well-known/openid-configuration and other files linked therein.
+ * When successful, validated metadata is returned
+ * @param issuer - the OIDC issuer as returned by the /auth_issuer API
+ * @returns validated authentication metadata and optionally signing keys
+ * @throws when delegated auth config is invalid or unreachable
+ */
+export var discoverAndValidateOIDCIssuerWellKnown = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator(function* (issuer) {
+    var _yield$metadataServic;
+    var issuerOpenIdConfigUrl = new URL(".well-known/openid-configuration", issuer);
+    var issuerWellKnownResponse = yield fetch(issuerOpenIdConfigUrl, {
+      method: Method.Get,
+      signal: timeoutSignal(5000)
+    });
+    var issuerWellKnown = yield issuerWellKnownResponse.json();
+    var validatedIssuerConfig = validateOIDCIssuerWellKnown(issuerWellKnown);
+
+    // create a temporary settings store, so we can use metadata service for discovery
+    var settings = new OidcClientSettingsStore({
+      authority: issuer,
+      redirect_uri: "",
+      // Not known yet, this is here to make the type checker happy
+      client_id: "" // Not known yet, this is here to make the type checker happy
+    });
+    var metadataService = new MetadataService(settings);
+    var metadata = yield metadataService.getMetadata();
+    var signingKeys = (_yield$metadataServic = yield metadataService.getSigningKeys()) !== null && _yield$metadataServic !== void 0 ? _yield$metadataServic : undefined;
+    isValidatedIssuerMetadata(metadata);
+    return _objectSpread(_objectSpread({}, validatedIssuerConfig), {}, {
+      metadata,
+      signingKeys
+    });
+  });
+  return function discoverAndValidateOIDCIssuerWellKnown(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+//# sourceMappingURL=discovery.js.map

package/lib/oidc/discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","names":["MetadataService","OidcClientSettingsStore","isValidatedIssuerMetadata","validateOIDCIssuerWellKnown","Method","timeoutSignal","discoverAndValidateOIDCIssuerWellKnown","_ref","_asyncToGenerator","issuer","_yield$metadataServic","issuerOpenIdConfigUrl","URL","issuerWellKnownResponse","fetch","method","Get","signal","issuerWellKnown","json","validatedIssuerConfig","settings","authority","redirect_uri","client_id","metadataService","metadata","getMetadata","signingKeys","getSigningKeys","undefined","_objectSpread","_x","apply","arguments"],"sources":["../../src/oidc/discovery.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { MetadataService, OidcClientSettingsStore } from \"oidc-client-ts\";\n\nimport { isValidatedIssuerMetadata, validateOIDCIssuerWellKnown } from \"./validate.ts\";\nimport { Method, timeoutSignal } from \"../http-api/index.ts\";\nimport { OidcClientConfig } from \"./index.ts\";\n\n/**\n * @experimental\n * Discover and validate delegated auth configuration\n * - delegated auth issuer openid-configuration is reachable\n * - delegated auth issuer openid-configuration is configured correctly for us\n * Fetches https://oidc-issuer.example.com/.well-known/openid-configuration and other files linked therein.\n * When successful, validated metadata is returned\n * @param issuer - the OIDC issuer as returned by the /auth_issuer API\n * @returns validated authentication metadata and optionally signing keys\n * @throws when delegated auth config is invalid or unreachable\n */\nexport const discoverAndValidateOIDCIssuerWellKnown = async (issuer: string): Promise<OidcClientConfig> => {\n    const issuerOpenIdConfigUrl = new URL(\".well-known/openid-configuration\", issuer);\n    const issuerWellKnownResponse = await fetch(issuerOpenIdConfigUrl, {\n        method: Method.Get,\n        signal: timeoutSignal(5000),\n    });\n    const issuerWellKnown = await issuerWellKnownResponse.json();\n    const validatedIssuerConfig = validateOIDCIssuerWellKnown(issuerWellKnown);\n\n    // create a temporary settings store, so we can use metadata service for discovery\n    const settings = new OidcClientSettingsStore({\n        authority: issuer,\n        redirect_uri: \"\", // Not known yet, this is here to make the type checker happy\n        client_id: \"\", // Not known yet, this is here to make the type checker happy\n    });\n    const metadataService = new MetadataService(settings);\n    const metadata = await metadataService.getMetadata();\n    const signingKeys = (await metadataService.getSigningKeys()) ?? undefined;\n\n    isValidatedIssuerMetadata(metadata);\n\n    return {\n        ...validatedIssuerConfig,\n        metadata,\n        signingKeys,\n    };\n};\n"],"mappings":";;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,eAAe,EAAEC,uBAAuB,QAAQ,gBAAgB;AAEzE,SAASC,yBAAyB,EAAEC,2BAA2B,QAAQ,eAAe;AACtF,SAASC,MAAM,EAAEC,aAAa,QAAQ,sBAAsB;AAG5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMC,sCAAsC;EAAA,IAAAC,IAAA,GAAAC,iBAAA,CAAG,WAAOC,MAAc,EAAgC;IAAA,IAAAC,qBAAA;IACvG,IAAMC,qBAAqB,GAAG,IAAIC,GAAG,CAAC,kCAAkC,EAAEH,MAAM,CAAC;IACjF,IAAMI,uBAAuB,SAASC,KAAK,CAACH,qBAAqB,EAAE;MAC/DI,MAAM,EAAEX,MAAM,CAACY,GAAG;MAClBC,MAAM,EAAEZ,aAAa,CAAC,IAAI;IAC9B,CAAC,CAAC;IACF,IAAMa,eAAe,SAASL,uBAAuB,CAACM,IAAI,CAAC,CAAC;IAC5D,IAAMC,qBAAqB,GAAGjB,2BAA2B,CAACe,eAAe,CAAC;;IAE1E;IACA,IAAMG,QAAQ,GAAG,IAAIpB,uBAAuB,CAAC;MACzCqB,SAAS,EAAEb,MAAM;MACjBc,YAAY,EAAE,EAAE;MAAE;MAClBC,SAAS,EAAE,EAAE,CAAE;IACnB,CAAC,CAAC;IACF,IAAMC,eAAe,GAAG,IAAIzB,eAAe,CAACqB,QAAQ,CAAC;IACrD,IAAMK,QAAQ,SAASD,eAAe,CAACE,WAAW,CAAC,CAAC;IACpD,IAAMC,WAAW,IAAAlB,qBAAA,SAAUe,eAAe,CAACI,cAAc,CAAC,CAAC,cAAAnB,qBAAA,cAAAA,qBAAA,GAAKoB,SAAS;IAEzE5B,yBAAyB,CAACwB,QAAQ,CAAC;IAEnC,OAAAK,aAAA,CAAAA,aAAA,KACOX,qBAAqB;MACxBM,QAAQ;MACRE;IAAW;EAEnB,CAAC;EAAA,gBA1BYtB,sCAAsCA,CAAA0B,EAAA;IAAA,OAAAzB,IAAA,CAAA0B,KAAA,OAAAC,SAAA;EAAA;AAAA,GA0BlD","ignoreList":[]}

package/lib/oidc/error.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Errors expected to be encountered during OIDC discovery, client registration, and authentication.
+ * Not intended to be displayed directly to the user.
+ */
+export declare enum OidcError {
+    NotSupported = "OIDC authentication not supported",
+    Misconfigured = "OIDC is misconfigured",
+    General = "Something went wrong with OIDC discovery",
+    OpSupport = "Configured OIDC OP does not support required functions",
+    DynamicRegistrationNotSupported = "Dynamic registration not supported",
+    DynamicRegistrationFailed = "Dynamic registration failed",
+    DynamicRegistrationInvalid = "Dynamic registration invalid response",
+    CodeExchangeFailed = "Failed to exchange code for token",
+    InvalidBearerTokenResponse = "Invalid bearer token response",
+    InvalidIdToken = "Invalid ID token",
+    MissingOrInvalidStoredState = "State required to finish logging in is not found in storage."
+}
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/oidc/error.ts"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,oBAAY,SAAS;IACjB,YAAY,sCAAsC;IAClD,aAAa,0BAA0B;IACvC,OAAO,6CAA6C;IACpD,SAAS,2DAA2D;IACpE,+BAA+B,uCAAuC;IACtE,yBAAyB,gCAAgC;IACzD,0BAA0B,0CAA0C;IACpE,kBAAkB,sCAAsC;IACxD,0BAA0B,kCAAkC;IAC5D,cAAc,qBAAqB;IACnC,2BAA2B,iEAAiE;CAC/F"}

package/lib/oidc/error.js

@@ -0,0 +1,35 @@
+/*
+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.
+*/
+
+/**
+ * Errors expected to be encountered during OIDC discovery, client registration, and authentication.
+ * Not intended to be displayed directly to the user.
+ */
+export var OidcError = /*#__PURE__*/function (OidcError) {
+  OidcError["NotSupported"] = "OIDC authentication not supported";
+  OidcError["Misconfigured"] = "OIDC is misconfigured";
+  OidcError["General"] = "Something went wrong with OIDC discovery";
+  OidcError["OpSupport"] = "Configured OIDC OP does not support required functions";
+  OidcError["DynamicRegistrationNotSupported"] = "Dynamic registration not supported";
+  OidcError["DynamicRegistrationFailed"] = "Dynamic registration failed";
+  OidcError["DynamicRegistrationInvalid"] = "Dynamic registration invalid response";
+  OidcError["CodeExchangeFailed"] = "Failed to exchange code for token";
+  OidcError["InvalidBearerTokenResponse"] = "Invalid bearer token response";
+  OidcError["InvalidIdToken"] = "Invalid ID token";
+  OidcError["MissingOrInvalidStoredState"] = "State required to finish logging in is not found in storage.";
+  return OidcError;
+}({});
+//# sourceMappingURL=error.js.map

package/lib/oidc/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","names":["OidcError"],"sources":["../../src/oidc/error.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n/**\n * Errors expected to be encountered during OIDC discovery, client registration, and authentication.\n * Not intended to be displayed directly to the user.\n */\nexport enum OidcError {\n    NotSupported = \"OIDC authentication not supported\",\n    Misconfigured = \"OIDC is misconfigured\",\n    General = \"Something went wrong with OIDC discovery\",\n    OpSupport = \"Configured OIDC OP does not support required functions\",\n    DynamicRegistrationNotSupported = \"Dynamic registration not supported\",\n    DynamicRegistrationFailed = \"Dynamic registration failed\",\n    DynamicRegistrationInvalid = \"Dynamic registration invalid response\",\n    CodeExchangeFailed = \"Failed to exchange code for token\",\n    InvalidBearerTokenResponse = \"Invalid bearer token response\",\n    InvalidIdToken = \"Invalid ID token\",\n    MissingOrInvalidStoredState = \"State required to finish logging in is not found in storage.\",\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA,WAAYA,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA","ignoreList":[]}

package/lib/oidc/index.d.ts

@@ -0,0 +1,17 @@
+import type { SigningKey } from "oidc-client-ts";
+import { ValidatedIssuerConfig, ValidatedIssuerMetadata } from "./validate.ts";
+export * from "./authorize.ts";
+export * from "./discovery.ts";
+export * from "./error.ts";
+export * from "./register.ts";
+export * from "./tokenRefresher.ts";
+export * from "./validate.ts";
+/**
+ * Validated config for native OIDC authentication, as returned by {@link discoverAndValidateOIDCIssuerWellKnown}.
+ * Contains metadata and signing keys from the issuer's well-known (https://oidc-issuer.example.com/.well-known/openid-configuration).
+ */
+export interface OidcClientConfig extends ValidatedIssuerConfig {
+    metadata: ValidatedIssuerMetadata;
+    signingKeys?: SigningKey[];
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/oidc/index.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAE/E,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,qBAAqB;IAC3D,QAAQ,EAAE,uBAAuB,CAAC;IAClC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC9B"}

package/lib/oidc/index.js

@@ -0,0 +1,29 @@
+/*
+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.
+*/
+
+export * from "./authorize.js";
+export * from "./discovery.js";
+export * from "./error.js";
+export * from "./register.js";
+export * from "./tokenRefresher.js";
+export * from "./validate.js";
+
+/**
+ * Validated config for native OIDC authentication, as returned by {@link discoverAndValidateOIDCIssuerWellKnown}.
+ * Contains metadata and signing keys from the issuer's well-known (https://oidc-issuer.example.com/.well-known/openid-configuration).
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/lib/oidc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/oidc/index.ts"],"sourcesContent":["/*\nCopyright 2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport type { SigningKey } from \"oidc-client-ts\";\nimport { ValidatedIssuerConfig, ValidatedIssuerMetadata } from \"./validate.ts\";\n\nexport * from \"./authorize.ts\";\nexport * from \"./discovery.ts\";\nexport * from \"./error.ts\";\nexport * from \"./register.ts\";\nexport * from \"./tokenRefresher.ts\";\nexport * from \"./validate.ts\";\n\n/**\n * Validated config for native OIDC authentication, as returned by {@link discoverAndValidateOIDCIssuerWellKnown}.\n * Contains metadata and signing keys from the issuer's well-known (https://oidc-issuer.example.com/.well-known/openid-configuration).\n */\nexport interface OidcClientConfig extends ValidatedIssuerConfig {\n    metadata: ValidatedIssuerMetadata;\n    signingKeys?: SigningKey[];\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,YAAY;AAC1B,cAAc,eAAe;AAC7B,cAAc,qBAAqB;AACnC,cAAc,eAAe;;AAE7B;AACA;AACA;AACA;AAHA","ignoreList":[]}

package/lib/oidc/register.d.ts

@@ -0,0 +1,43 @@
+import { OidcClientConfig } from "./index.ts";
+import { NonEmptyArray } from "../@types/common.ts";
+/**
+ * Client metadata passed to registration endpoint
+ */
+export type OidcRegistrationClientMetadata = {
+    clientName: OidcRegistrationRequestBody["client_name"];
+    clientUri: OidcRegistrationRequestBody["client_uri"];
+    logoUri?: OidcRegistrationRequestBody["logo_uri"];
+    applicationType: OidcRegistrationRequestBody["application_type"];
+    redirectUris: OidcRegistrationRequestBody["redirect_uris"];
+    contacts: OidcRegistrationRequestBody["contacts"];
+    tosUri: OidcRegistrationRequestBody["tos_uri"];
+    policyUri: OidcRegistrationRequestBody["policy_uri"];
+};
+/**
+ * Request body for dynamic registration as defined by https://github.com/matrix-org/matrix-spec-proposals/pull/2966
+ */
+interface OidcRegistrationRequestBody {
+    client_name?: string;
+    client_uri: string;
+    logo_uri?: string;
+    contacts?: string[];
+    tos_uri?: string;
+    policy_uri?: string;
+    redirect_uris?: NonEmptyArray<string>;
+    response_types?: NonEmptyArray<string>;
+    grant_types?: NonEmptyArray<string>;
+    id_token_signed_response_alg?: string;
+    token_endpoint_auth_method: string;
+    application_type: "web" | "native";
+}
+export declare const DEVICE_CODE_SCOPE = "urn:ietf:params:oauth:grant-type:device_code";
+/**
+ * Attempts dynamic registration against the configured registration endpoint
+ * @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 declare const registerOidcClient: (delegatedAuthConfig: OidcClientConfig, clientMetadata: OidcRegistrationClientMetadata) => Promise<string>;
+export {};
+//# sourceMappingURL=register.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/oidc/register.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAI9C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC,UAAU,EAAE,2BAA2B,CAAC,aAAa,CAAC,CAAC;IACvD,SAAS,EAAE,2BAA2B,CAAC,YAAY,CAAC,CAAC;IACrD,OAAO,CAAC,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAC;IAClD,eAAe,EAAE,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;IACjE,YAAY,EAAE,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAC3D,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,EAAE,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAC/C,SAAS,EAAE,2BAA2B,CAAC,YAAY,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,UAAU,2BAA2B;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACvC,WAAW,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACpC,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,0BAA0B,EAAE,MAAM,CAAC;IACnC,gBAAgB,EAAE,KAAK,GAAG,QAAQ,CAAC;CACtC;AAED,eAAO,MAAM,iBAAiB,iDAAiD,CAAC;AAEhF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,wBACN,gBAAgB,kBACrB,8BAA8B,KAC/C,OAAO,CAAC,MAAM,CAwDhB,CAAC"}