Some checks failed
Create issues from TODOs / todos (push) Failing after 3s
Close inactive issues / close-issues (push) Has been cancelled
Deploy GitHub Pages / deploy-preview (push) Has been cancelled
CI / ⚙️ Variables Setup (push) Has been cancelled
CI / ⚙️ Test Guard (push) Has been cancelled
CI / 🚀 Notify external services - draft (push) Has been cancelled
CI / 📦 Build Packages (push) Has been cancelled
CI / 📦 Meteor Build (coverage) (push) Has been cancelled
CI / 📦 Meteor Build (production) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [account-service presence-service omnichannel-transcript-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [authorization-service queue-worker-service ddp-streamer-service], fips) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Build Docker (amd64, [rocketchat], fips) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [account-service presence-service omnichannel-transcript-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [authorization-service queue-worker-service ddp-streamer-service], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], ${{ (github.event_name != 'release' && github.ref != 'refs/heads/develop') && 'coverage' || 'production' }}) (push) Has been cancelled
CI / 🚢 Build Docker (arm64, [rocketchat], coverage) (push) Has been cancelled
CI / 🚢 Publish Docker Images (ghcr.io) (push) Has been cancelled
CI / 📦 Track Image Sizes (push) Has been cancelled
CI / 🔎 Code Check - Action Lint (push) Has been cancelled
CI / 🔎 Code Check (push) Has been cancelled
CI / 🔨 Test Storybook (push) Has been cancelled
CI / 🔨 Test Unit (push) Has been cancelled
CI / 🔨 Test API (CE) (push) Has been cancelled
CI / 🔨 Test API Livechat (CE) (push) Has been cancelled
CI / 🔨 Test UI (CE) (push) Has been cancelled
CI / 🔨 Test API (EE) (push) Has been cancelled
CI / 🔨 Test API Livechat (EE) (push) Has been cancelled
CI / 🔨 Test API Apps (deno-runtime - EE) (push) Has been cancelled
CI / 🔨 Test UI (EE) (push) Has been cancelled
CI / 🔨 Test API (FIPS) (push) Has been cancelled
CI / 🔨 Test API Livechat (FIPS) (push) Has been cancelled
CI / 🔨 Test UI (FIPS) (push) Has been cancelled
CI / 🔨 Test Federation Matrix (push) Has been cancelled
CI / 📊 Report Coverage (push) Has been cancelled
CI / ✅ Tests Done (push) Has been cancelled
CI / 🚀 Publish build assets (push) Has been cancelled
CI / 🚀 Publish Docker Images (DockerHub) (push) Has been cancelled
CI / 🚀 Notify external services (push) Has been cancelled
CI / Update Version Durability (push) Has been cancelled
Release / Release (push) Has been cancelled
Auto-close duplicate issues / auto-close-duplicates (push) Failing after 1s
Code scanning - action / CodeQL-Build (push) Failing after 2s
142 lines
4.9 KiB
TypeScript
142 lines
4.9 KiB
TypeScript
import type { OAuthConfiguration, OauthConfig } from '@rocket.chat/core-typings';
|
|
import { Random } from '@rocket.chat/random';
|
|
import { capitalize, isAbsoluteURL } from '@rocket.chat/tools';
|
|
import { Accounts } from 'meteor/accounts-base';
|
|
import { Meteor } from 'meteor/meteor';
|
|
import { OAuth } from 'meteor/oauth';
|
|
|
|
import { CustomOAuthError } from './CustomOAuthError';
|
|
import type { IOAuthProvider } from '../../definitions/IOAuthProvider';
|
|
import { createOAuthTotpLoginMethod } from '../../meteor/login/oauth';
|
|
import { overrideLoginMethod, type LoginCallback } from '../2fa/overrideLoginMethod';
|
|
import { loginServices } from '../loginServices';
|
|
|
|
const configuredOAuthServices = new Map<string, CustomOAuth>();
|
|
|
|
export class CustomOAuth<TServiceName extends string = string> implements IOAuthProvider {
|
|
public serverURL: string;
|
|
|
|
public authorizePath: string;
|
|
|
|
public scope: string;
|
|
|
|
public responseType: string;
|
|
|
|
constructor(
|
|
public readonly name: TServiceName,
|
|
options: Readonly<OauthConfig>,
|
|
) {
|
|
this.configure(options);
|
|
|
|
Accounts.oauth.registerService(this.name);
|
|
|
|
this.configureLogin();
|
|
}
|
|
|
|
configure(options: Readonly<OauthConfig>) {
|
|
if (typeof options !== 'object' || !options) {
|
|
throw new CustomOAuthError('options is required and must be object');
|
|
}
|
|
|
|
if (typeof options.serverURL !== 'string') {
|
|
throw new CustomOAuthError('options.serverURL is required and must be string');
|
|
}
|
|
|
|
this.serverURL = options.serverURL;
|
|
this.authorizePath = options.authorizePath ?? '/oauth/authorize';
|
|
this.scope = options.scope ?? 'openid';
|
|
this.responseType = options.responseType || 'code';
|
|
|
|
if (!isAbsoluteURL(this.authorizePath)) {
|
|
this.authorizePath = this.serverURL + this.authorizePath;
|
|
}
|
|
}
|
|
|
|
configureLogin() {
|
|
const loginWithService = `loginWith${capitalize(this.name)}` as const;
|
|
|
|
const loginWithOAuthTokenAndTOTP = createOAuthTotpLoginMethod(this);
|
|
|
|
const loginWithOAuthToken = async (options?: Meteor.LoginWithExternalServiceOptions, callback?: LoginCallback) => {
|
|
const credentialRequestCompleteCallback = Accounts.oauth.credentialRequestCompleteHandler(callback);
|
|
await this.requestCredential(options, credentialRequestCompleteCallback);
|
|
};
|
|
|
|
(Meteor as any)[loginWithService] = (options: Meteor.LoginWithExternalServiceOptions, callback: LoginCallback) => {
|
|
overrideLoginMethod(loginWithOAuthToken, [options], callback, loginWithOAuthTokenAndTOTP);
|
|
};
|
|
}
|
|
|
|
async requestCredential(
|
|
options: Meteor.LoginWithExternalServiceOptions = {},
|
|
credentialRequestCompleteCallback: (credentialTokenOrError?: string | Error) => void,
|
|
) {
|
|
const config = await loginServices.loadLoginService<OAuthConfiguration>(this.name);
|
|
if (!config) {
|
|
if (credentialRequestCompleteCallback) {
|
|
credentialRequestCompleteCallback(new Accounts.ConfigError());
|
|
}
|
|
return;
|
|
}
|
|
|
|
const credentialToken = Random.secret();
|
|
const loginStyle = OAuth._loginStyle(this.name, config);
|
|
|
|
const separator = this.authorizePath.indexOf('?') !== -1 ? '&' : '?';
|
|
|
|
const loginUrl =
|
|
`${this.authorizePath}${separator}client_id=${config.clientId}&redirect_uri=${encodeURIComponent(
|
|
OAuth._redirectUri(this.name, config),
|
|
)}&response_type=${encodeURIComponent(this.responseType)}` +
|
|
`&state=${encodeURIComponent(OAuth._stateParam(loginStyle, credentialToken, options.redirectUrl))}&scope=${encodeURIComponent(
|
|
this.scope,
|
|
)}`;
|
|
|
|
OAuth.launchLogin({
|
|
loginService: this.name,
|
|
loginStyle,
|
|
loginUrl,
|
|
credentialRequestCompleteCallback,
|
|
credentialToken,
|
|
popupOptions: {
|
|
width: 900,
|
|
height: 450,
|
|
},
|
|
});
|
|
}
|
|
|
|
static configureOAuthService<TServiceName extends string = string>(
|
|
serviceName: TServiceName,
|
|
options: Readonly<OauthConfig>,
|
|
): CustomOAuth<TServiceName> {
|
|
const existingInstance = configuredOAuthServices.get(serviceName);
|
|
if (existingInstance) {
|
|
existingInstance.configure(options);
|
|
return existingInstance as CustomOAuth<TServiceName>;
|
|
}
|
|
|
|
// If we don't have a reference to the instance for this service and it was already registered on meteor,
|
|
// then there's nothing we can do to update it
|
|
if (Accounts.oauth.serviceNames().includes(serviceName)) {
|
|
throw new CustomOAuthError('service already registered, skipping new configuration', { service: serviceName });
|
|
}
|
|
|
|
const instance = new CustomOAuth(serviceName, options);
|
|
configuredOAuthServices.set(serviceName, instance);
|
|
return instance;
|
|
}
|
|
|
|
static configureCustomOAuthService<TServiceName extends string = string>(
|
|
serviceName: TServiceName,
|
|
options: Readonly<OauthConfig>,
|
|
): CustomOAuth<TServiceName> | undefined {
|
|
// Custom OAuth services are configured based on the login service list, so if this ends up being called multiple times, simply ignore it
|
|
// Non-Custom OAuth services are configured based on code, so if configureOAuthService is called multiple times for them, it's a bug and it should throw.
|
|
try {
|
|
return this.configureOAuthService(serviceName, options);
|
|
} catch (e) {
|
|
console.error(e);
|
|
}
|
|
}
|
|
}
|