snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/server/lib/auth/startup.js

@@ -0,0 +1,531 @@
+import { Apps, AppEvents } from '@rocket.chat/apps';
+import { User } from '@rocket.chat/core-services';
+import { Roles, Settings, Users } from '@rocket.chat/models';
+import { escapeRegExp, escapeHTML, getLoginExpirationInDays, removeEmpty } from '@rocket.chat/tools';
+import { Accounts } from 'meteor/accounts-base';
+import { Match } from 'meteor/check';
+import { Meteor } from 'meteor/meteor';
+import _ from 'underscore';
+
+import { isValidAttemptByUser, isValidLoginAttemptByIp } from './restrictLoginAttempts';
+import { parseCSV } from '../../../lib/utils/parseCSV';
+import { safeHtmlDots } from '../../../lib/utils/safeHtmlDots';
+import { getNewUserRoles } from '../../services/user/lib/getNewUserRoles';
+import { settings } from '../../settings';
+import { callbacks } from '../callbacks';
+import { beforeCreateUserCallback } from '../callbacks/beforeCreateUserCallback';
+import { getClientAddress } from '../getClientAddress';
+import { getMaxLoginTokens } from '../getMaxLoginTokens';
+import { i18n } from '../i18n';
+import * as Mailer from '../notifications/email/api';
+import { notifyOnSettingChangedById } from '../notifyListener';
+import { addUserRolesAsync } from '../roles/addUserRoles';
+import { joinDefaultChannels } from '../rooms/joinDefaultChannels';
+import { getAvatarSuggestionForUser } from '../users/getAvatarSuggestionForUser';
+import { setAvatarFromServiceWithValidation } from '../users/setUserAvatar';
+import { getBaseUserFields } from '../utils/functions/getBaseUserFields';
+
+Accounts.config({
+	forbidClientAccountCreation: true,
+});
+/**
+ * Accounts calls `_initServerPublications` and holds the `_defaultPublishFields`, without Object.assign its not possible
+ * to extend the projection
+ *
+ * the idea is to send all required fields to the client during login
+ * we tried `defaultFieldsSelector` , but it changes all Meteor.userAsync projections which is undesirable
+ *
+ *
+ * we are removing the status here because meteor send 'offline'
+ */
+Object.assign(Accounts._defaultPublishFields.projection, (({ status, ...rest }) => rest)(getBaseUserFields(true)));
+
+// Override Meteor's _expireTokens to ensure the correct login expiration is used.
+// If loginExpirationInDays is not set (e.g., startup was disrupted before settings watcher fired),
+// read the setting directly from MongoDB before proceeding with token cleanup.
+// This prevents tokens from being incorrectly deleted using Meteor's 90-day default.
+const { _expireTokens } = Accounts;
+Accounts._expireTokens = async function (oldestValidDate, userId) {
+	if (!Accounts._options.loginExpirationInDays) {
+		const loginExpiration = await Settings.getValueById('Accounts_LoginExpiration');
+		Accounts._options.loginExpirationInDays = getLoginExpirationInDays(loginExpiration);
+	}
+	return _expireTokens.call(Accounts, oldestValidDate, userId);
+};
+
+Meteor.startup(() => {
+	settings.watchMultiple(['Accounts_LoginExpiration', 'Site_Name', 'From_Email'], () => {
+		Accounts._options.loginExpirationInDays = getLoginExpirationInDays(settings.get('Accounts_LoginExpiration'));
+
+		Accounts.emailTemplates.siteName = settings.get('Site_Name');
+
+		Accounts.emailTemplates.from = `${settings.get('Site_Name')} <${settings.get('From_Email')}>`;
+	});
+});
+
+Accounts.emailTemplates.userToActivate = {
+	subject() {
+		const subject = i18n.t('Accounts_Admin_Email_Approval_Needed_Subject_Default');
+		const siteName = settings.get('Site_Name');
+
+		return `[${siteName}] ${subject}`;
+	},
+
+	html(options = {}) {
+		const email = options.reason
+			? 'Accounts_Admin_Email_Approval_Needed_With_Reason_Default'
+			: 'Accounts_Admin_Email_Approval_Needed_Default';
+
+		return Mailer.replace(i18n.t(email), {
+			name: escapeHTML(options.name),
+			email: escapeHTML(options.email),
+			reason: escapeHTML(options.reason),
+		});
+	},
+};
+
+Accounts.emailTemplates.userActivated = {
+	subject({ active, username }) {
+		const activated = username ? 'Activated' : 'Approved';
+		const action = active ? activated : 'Deactivated';
+		const subject = `Accounts_Email_${action}_Subject`;
+		const siteName = settings.get('Site_Name');
+
+		return `[${siteName}] ${i18n.t(subject)}`;
+	},
+
+	html({ active, name, username }) {
+		const activated = username ? 'Activated' : 'Approved';
+		const action = active ? activated : 'Deactivated';
+
+		return Mailer.replace(i18n.t(`Accounts_Email_${action}`), {
+			name: escapeHTML(name),
+		});
+	},
+};
+
+let verifyEmailTemplate = '';
+let enrollAccountTemplate = '';
+let resetPasswordTemplate = '';
+Meteor.startup(() => {
+	Mailer.getTemplateWrapped('Verification_Email', (value) => {
+		verifyEmailTemplate = value;
+	});
+	Mailer.getTemplateWrapped('Accounts_Enrollment_Email', (value) => {
+		enrollAccountTemplate = value;
+	});
+	Mailer.getTemplateWrapped('Forgot_Password_Email', (value) => {
+		resetPasswordTemplate = value;
+	});
+});
+
+Accounts.emailTemplates.verifyEmail.html = function (userModel, url) {
+	const name = safeHtmlDots(userModel.name);
+
+	return Mailer.replace(verifyEmailTemplate, { Verification_Url: url, name });
+};
+
+Accounts.emailTemplates.verifyEmail.subject = function () {
+	const subject = settings.get('Verification_Email_Subject');
+	return Mailer.replace(subject || '');
+};
+
+Accounts.urls.resetPassword = function (token) {
+	return Meteor.absoluteUrl(`reset-password/${token}`);
+};
+
+Accounts.emailTemplates.resetPassword.subject = function (userModel) {
+	return Mailer.replace(settings.get('Forgot_Password_Email_Subject') || '', {
+		name: userModel.name,
+	});
+};
+
+Accounts.emailTemplates.resetPassword.html = function (userModel, url) {
+	return Mailer.replacekey(
+		Mailer.replace(resetPasswordTemplate, {
+			name: userModel.name,
+		}),
+		'Forgot_Password_Url',
+		url,
+	);
+};
+
+Accounts.emailTemplates.enrollAccount.subject = function (user) {
+	const subject = settings.get('Accounts_Enrollment_Email_Subject');
+	return Mailer.replace(subject, user);
+};
+
+Accounts.emailTemplates.enrollAccount.html = function (user = {} /* , url*/) {
+	return Mailer.replace(enrollAccountTemplate, {
+		name: escapeHTML(user.name),
+		email: user.emails && user.emails[0] && escapeHTML(user.emails[0].address),
+	});
+};
+
+const getLinkedInName = ({ firstName, lastName }) => {
+	const { preferredLocale, localized: firstNameLocalized } = firstName;
+	const { localized: lastNameLocalized } = lastName;
+
+	// LinkedIn new format
+	if (preferredLocale && firstNameLocalized && preferredLocale.language && preferredLocale.country) {
+		const locale = `${preferredLocale.language}_${preferredLocale.country}`;
+
+		if (firstNameLocalized[locale] && lastNameLocalized[locale]) {
+			return `${firstNameLocalized[locale]} ${lastNameLocalized[locale]}`;
+		}
+		if (firstNameLocalized[locale]) {
+			return firstNameLocalized[locale];
+		}
+	}
+
+	// LinkedIn old format
+	if (!lastName) {
+		return firstName;
+	}
+	return `${firstName} ${lastName}`;
+};
+
+const validateEmailDomain = (user) => {
+	if (user.type === 'visitor') {
+		return true;
+	}
+
+	let domainWhiteList = settings.get('Accounts_AllowedDomainsList');
+	if (_.isEmpty(domainWhiteList?.trim())) {
+		return true;
+	}
+
+	domainWhiteList = domainWhiteList.split(',').map((domain) => domain.trim());
+
+	if (user.emails && user.emails.length > 0) {
+		const email = user.emails[0].address;
+		const inWhiteList = domainWhiteList.some((domain) => email.match(`@${escapeRegExp(domain)}$`));
+
+		if (!inWhiteList) {
+			throw new Meteor.Error('error-invalid-domain');
+		}
+	}
+
+	return true;
+};
+
+const onCreateUserAsync = async function (options, user = {}) {
+	if (!options.skipBeforeCreateUserCallback) {
+		await beforeCreateUserCallback.run(options, user);
+	}
+	user.status = 'offline';
+
+	user.active = user.active !== undefined ? user.active : !settings.get('Accounts_ManuallyApproveNewUsers');
+	if (settings.get('Accounts_ManuallyApproveNewUsers') && !user.active) {
+		user.inactiveReason = 'pending_approval';
+	}
+
+	if (!user.name) {
+		if (options.profile) {
+			if (options.profile.name) {
+				user.name = options.profile.name;
+			} else if (options.profile.firstName) {
+				// LinkedIn format
+				user.name = getLinkedInName(options.profile);
+			}
+		}
+	}
+
+	if (user.services) {
+		const verified = settings.get('Accounts_Verify_Email_For_External_Accounts');
+
+		for (const service of Object.values(user.services)) {
+			const suggestedName = service.name || service.username;
+			if (!user.name && suggestedName) {
+				user.name = suggestedName;
+			}
+
+			if (!user.emails && service.email) {
+				user.emails = [
+					{
+						address: service.email,
+						verified,
+					},
+				];
+			}
+		}
+	}
+
+	if (!options.skipAdminEmail && !user.active) {
+		const destinations = [];
+		const usersInRole = await Roles.findUsersInRole('admin');
+		await usersInRole.forEach((adminUser) => {
+			if (Array.isArray(adminUser.emails)) {
+				adminUser.emails.forEach((email) => {
+					destinations.push(`${adminUser.name}<${email.address}>`);
+				});
+			}
+		});
+
+		const email = {
+			to: destinations,
+			from: settings.get('From_Email'),
+			subject: Accounts.emailTemplates.userToActivate.subject(),
+			html: Accounts.emailTemplates.userToActivate.html({
+				...options,
+				name: options.name || options.profile?.name,
+				email: options.email || user.emails[0].address,
+			}),
+		};
+
+		await Mailer.send(email);
+	}
+
+	if (!options.skipOnCreateUserCallback) {
+		await callbacks.run('onCreateUser', options, user);
+	}
+
+	if (!options.skipEmailValidation && !validateEmailDomain(user)) {
+		throw new Meteor.Error(403, 'User validation failed');
+	}
+
+	return removeEmpty(user);
+};
+
+Accounts.onCreateUser(function (...args) {
+	// Depends on meteor support for Async
+	return onCreateUserAsync.call(this, ...args);
+});
+
+const { insertUserDoc } = Accounts;
+
+Accounts.insertUserDoc = async function (options, user) {
+	const globalRoles = new Set();
+
+	if (Match.test(options.globalRoles, [String]) && options.globalRoles.length > 0) {
+		options.globalRoles.map((role) => globalRoles.add(role));
+	}
+
+	if (Match.test(user.globalRoles, [String]) && user.globalRoles.length > 0) {
+		user.globalRoles.map((role) => globalRoles.add(role));
+	}
+
+	delete user.globalRoles;
+
+	// for some reason, the name is not being set in the user object but is being set in the options object
+	if (options.name && typeof options.name === 'string') {
+		user.name = options.name;
+	}
+
+	if (user.services && !user.services.password && !options.skipAuthServiceDefaultRoles) {
+		const defaultAuthServiceRoles = parseCSV(settings.get('Accounts_Registration_AuthenticationServices_Default_Roles') || '');
+
+		if (defaultAuthServiceRoles.length > 0) {
+			defaultAuthServiceRoles.map((role) => globalRoles.add(role));
+		}
+	}
+
+	const arrayGlobalRoles = [...globalRoles];
+	const roles = options.skipNewUserRolesSetting ? arrayGlobalRoles : getNewUserRoles(arrayGlobalRoles);
+
+	if (!user.type) {
+		user.type = 'user';
+	}
+
+	if (
+		settings.get('Accounts_TwoFactorAuthentication_Enabled') &&
+		settings.get('Accounts_TwoFactorAuthentication_By_Email_Enabled') &&
+		settings.get('Accounts_TwoFactorAuthentication_By_Email_Auto_Opt_In')
+	) {
+		user.services = user.services || {};
+		user.services.email2fa = {
+			enabled: true,
+			changedAt: new Date(),
+		};
+	}
+
+	// Make sure that the user has the field 'roles'
+	if (!user.roles) {
+		user.roles = [];
+	}
+
+	const _id = await insertUserDoc.call(Accounts, options, user);
+
+	user = await Users.findOne({
+		_id,
+	});
+
+	/**
+	 * if settings shows setup wizard to be pending
+	 * and no admin's been found,
+	 * and existing role list doesn't include admin
+	 * create this user admin.
+	 * count this as the completion of setup wizard step 1.
+	 */
+	if (!options.skipAdminCheck) {
+		const hasAdmin = await Users.findOneByRolesAndType('admin', 'user', { projection: { _id: 1 } });
+		if (!roles.includes('admin') && !hasAdmin) {
+			roles.push('admin');
+			if (settings.get('Show_Setup_Wizard') === 'pending') {
+				// TODO: audit
+				(await Settings.updateValueById('Show_Setup_Wizard', 'in_progress')).modifiedCount &&
+					void notifyOnSettingChangedById('Show_Setup_Wizard');
+			}
+		}
+	}
+
+	await addUserRolesAsync(_id, roles);
+
+	// Make user's roles to be present on callback
+	user = await Users.findOneById(_id, { projection: { username: 1, type: 1, roles: 1 } });
+
+	if (user.username) {
+		if (options.joinDefaultChannels !== false) {
+			await joinDefaultChannels(_id, options.joinDefaultChannelsSilenced);
+		}
+
+		if (!options.skipAfterCreateUserCallback && user.type !== 'visitor') {
+			setImmediate(() => {
+				return callbacks.run('afterCreateUser', user);
+			});
+		}
+		if (!options.skipDefaultAvatar && settings.get('Accounts_SetDefaultAvatar') === true) {
+			const avatarSuggestions = await getAvatarSuggestionForUser(user);
+			for (const service of Object.keys(avatarSuggestions)) {
+				const avatarData = avatarSuggestions[service];
+				if (service !== 'gravatar') {
+					await setAvatarFromServiceWithValidation(_id, avatarData.blob, '', service);
+					break;
+				}
+			}
+		}
+	}
+
+	if (!options.skipAppsEngineEvent) {
+		// `post` triggered events don't need to wait for the promise to resolve
+		Apps.self?.triggerEvent(AppEvents.IPostUserCreated, { user, performedBy: options.performedBy }).catch((e) => {
+			Apps.self?.getRocketChatLogger().error({ msg: 'Error while executing post user created event', err: e });
+		});
+	}
+
+	return _id;
+};
+
+const validateLoginAttemptAsync = async function (login) {
+	login = await callbacks.run('beforeValidateLogin', login);
+
+	if (!(await isValidLoginAttemptByIp(getClientAddress(login.connection)))) {
+		throw new Meteor.Error('error-login-blocked-for-ip', 'Login has been temporarily blocked For IP', {
+			function: 'Accounts.validateLoginAttempt',
+		});
+	}
+
+	if (!(await isValidAttemptByUser(login))) {
+		throw new Meteor.Error('error-login-blocked-for-user', 'Login has been temporarily blocked For User', {
+			function: 'Accounts.validateLoginAttempt',
+		});
+	}
+
+	if (login.allowed !== true) {
+		return login.allowed;
+	}
+
+	if (login.user.type === 'visitor') {
+		return true;
+	}
+
+	if (login.user.type === 'app') {
+		throw new Meteor.Error('error-app-user-is-not-allowed-to-login', 'App user is not allowed to login', {
+			function: 'Accounts.validateLoginAttempt',
+		});
+	}
+
+	if (!!login.user.active !== true) {
+		throw new Meteor.Error('error-user-is-not-activated', 'User is not activated', {
+			function: 'Accounts.validateLoginAttempt',
+		});
+	}
+
+	if (!login.user.roles || !Array.isArray(login.user.roles)) {
+		throw new Meteor.Error('error-user-has-no-roles', 'User has no roles', {
+			function: 'Accounts.validateLoginAttempt',
+		});
+	}
+
+	if (login.user.roles.includes('admin') === false && login.type === 'password' && settings.get('Accounts_EmailVerification') === true) {
+		const validEmail = login.user.emails.filter((email) => email.verified === true);
+		if (validEmail.length === 0) {
+			throw new Meteor.Error('error-invalid-email', 'Invalid email __email__');
+		}
+	}
+
+	login = await callbacks.run('onValidateLogin', login);
+
+	await Users.updateLastLoginById(login.user._id);
+	setImmediate(() => {
+		return callbacks.run('afterValidateLogin', login);
+	});
+
+	/**
+	 * Trigger the event only when the
+	 * user does login in Rocket.chat
+	 */
+	if (login.type !== 'resume') {
+		// App IPostUserLoggedIn event hook
+		await Apps.self?.triggerEvent(AppEvents.IPostUserLoggedIn, login.user);
+	}
+
+	return true;
+};
+
+Accounts.validateLoginAttempt(function (...args) {
+	// Depends on meteor support for Async
+	return validateLoginAttemptAsync.call(this, ...args);
+});
+
+Accounts.validateNewUser((user) => {
+	if (user.type === 'visitor') {
+		return true;
+	}
+
+	if (
+		settings.get('Accounts_Registration_AuthenticationServices_Enabled') === false &&
+		settings.get('LDAP_Enable') === false &&
+		!(user.services && user.services.password)
+	) {
+		throw new Meteor.Error('registration-disabled-authentication-services', 'User registration is disabled for authentication services');
+	}
+
+	return true;
+});
+
+Accounts.validateNewUser((user) => {
+	if (user.type === 'visitor') {
+		return true;
+	}
+
+	let domainWhiteList = settings.get('Accounts_AllowedDomainsList');
+	if (_.isEmpty(domainWhiteList?.trim())) {
+		return true;
+	}
+
+	domainWhiteList = domainWhiteList.split(',').map((domain) => domain.trim());
+
+	if (user.emails && user.emails.length > 0) {
+		const email = user.emails[0].address;
+		const inWhiteList = domainWhiteList.some((domain) => email.match(`@${escapeRegExp(domain)}$`));
+
+		if (inWhiteList === false) {
+			throw new Meteor.Error('error-invalid-domain');
+		}
+	}
+
+	return true;
+});
+
+Accounts.onLogin(async ({ user }) => {
+	if (!user || !user.services || !user.services.resume || !user.services.resume.loginTokens || !user._id) {
+		return;
+	}
+
+	if (user.services.resume.loginTokens.length < getMaxLoginTokens()) {
+		return;
+	}
+
+	await User.ensureLoginTokensLimit(user._id);
+});