61 lines
2.4 KiB
TypeScript
61 lines
2.4 KiB
TypeScript
  
|
/*
|
||
|
|
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 { logger } from "matrix-js-sdk/src/logger";
|
||
|
|
|
||
|
|
import { ValidatedDelegatedAuthConfig } from "../ValidatedServerConfig";
|
||
|
|
import { OidcClientError } from "./error";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the statically configured clientId for the issuer
|
||
|
|
* @param issuer delegated auth OIDC issuer
|
||
|
|
* @param staticOidcClients static client config from config.json
|
||
|
|
* @returns clientId if found, otherwise undefined
|
||
|
|
*/
|
||
|
|
const getStaticOidcClientId = (issuer: string, staticOidcClients?: Record<string, string>): string | undefined => {
|
||
|
|
// static_oidc_clients are configured with a trailing slash
|
||
|
|
const issuerWithTrailingSlash = issuer.endsWith("/") ? issuer : issuer + "/";
|
||
|
|
return staticOidcClients?.[issuerWithTrailingSlash];
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the clientId for an OIDC OP
|
||
|
|
* Checks statically configured clientIds first
|
||
|
|
* @param delegatedAuthConfig Auth config from ValidatedServerConfig
|
||
|
|
* @param clientName Client name to register with the OP, eg 'Element'
|
||
|
|
* @param baseUrl URL of the home page of the Client, eg 'https://app.element.io/'
|
||
|
|
* @param staticOidcClients static client config from config.json
|
||
|
|
* @returns Promise<string> resolves with clientId
|
||
|
|
* @throws if no clientId is found
|
||
|
|
*/
|
||
|
|
export const getOidcClientId = async (
|
||
|
|
delegatedAuthConfig: ValidatedDelegatedAuthConfig,
|
||
|
|
// these are used in the following PR
|
||
|
|
_clientName: string,
|
||
|
|
_baseUrl: string,
|
||
|
|
staticOidcClients?: Record<string, string>,
|
||
|
|
): Promise<string> => {
|
||
|
|
const staticClientId = getStaticOidcClientId(delegatedAuthConfig.issuer, staticOidcClients);
|
||
|
|
if (staticClientId) {
|
||
|
|
logger.debug(`Using static clientId for issuer ${delegatedAuthConfig.issuer}`);
|
||
|
|
return staticClientId;
|
||
|
|
}
|
||
|
|
|
||
|
|
// TODO attempt dynamic registration
|
||
|
|
logger.error("Dynamic registration not yet implemented.");
|
||
|
|
throw new Error(OidcClientError.DynamicRegistrationNotSupported);
|
||
|
|
};
|