Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/tall-timers-swim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@rocket.chat/meteor': patch
---

Fixes workspace statistics deployment data not updating on server version changes.
5 changes: 5 additions & 0 deletions .changeset/tiny-candles-hang.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@rocket.chat/meteor": patch
---

Ensures SAML respects blank custom Authn Context
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ import {
defaultAuthnContextTemplate,
} from '../constants';

function resolveCustomAuthnContext(serviceProviderOptions: IServiceProviderOptions): string | undefined;
function resolveCustomAuthnContext(serviceProviderOptions: IServiceProviderOptions, defaultValue: string): string;
function resolveCustomAuthnContext(serviceProviderOptions: IServiceProviderOptions, defaultValue?: string): string | undefined {
const value = serviceProviderOptions.customAuthnContext.trim();
return value.length > 0 ? value : defaultValue;
}

/*
An Authorize Request is used to show the Identity Provider login form when the user clicks on the Rocket.Chat SAML login button
*/
Expand Down Expand Up @@ -46,7 +53,7 @@ export class AuthorizeRequest {
}

private static authnContextTagTemplate(serviceProviderOptions: IServiceProviderOptions): string {
if (!serviceProviderOptions.customAuthnContext) {
if (!resolveCustomAuthnContext(serviceProviderOptions)) {
return '';
}

Expand All @@ -68,7 +75,7 @@ export class AuthorizeRequest {
issuer: serviceProviderOptions.issuer,
identifierFormat: serviceProviderOptions.identifierFormat || defaultIdentifierFormat,
authnContextComparison: serviceProviderOptions.authnContextComparison || 'exact',
authnContext: serviceProviderOptions.customAuthnContext || defaultAuthnContext,
authnContext: resolveCustomAuthnContext(serviceProviderOptions, defaultAuthnContext),
};
}
}
5 changes: 4 additions & 1 deletion apps/meteor/app/meteor-accounts-saml/server/lib/settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@ const getSamlConfigs = function (service: string): SAMLConfiguration {
const configureSamlService = function (samlConfigs: Record<string, any>): IServiceProviderOptions {
let privateCert = null;
let privateKey = null;
const rawCustomAuthnContext = samlConfigs.customAuthnContext;
const normalizedCustomAuthnContext = typeof rawCustomAuthnContext === 'string' ? rawCustomAuthnContext.trim() : rawCustomAuthnContext;
const customAuthnContext = typeof normalizedCustomAuthnContext === 'string' ? normalizedCustomAuthnContext : defaultAuthnContext;

if (samlConfigs.secret.privateKey && samlConfigs.secret.publicCert) {
privateKey = samlConfigs.secret.privateKey;
Expand All @@ -91,7 +94,7 @@ const configureSamlService = function (samlConfigs: Record<string, any>): IServi
privateCert,
privateKey,
signatureAlgorithm: samlConfigs.secret.algorithm,
customAuthnContext: samlConfigs.customAuthnContext,
customAuthnContext,
authnContextComparison: samlConfigs.authnContextComparison,
defaultUserRole: samlConfigs.defaultUserRole,
allowedClockDrift: parseInt(samlConfigs.allowedClockDrift) || 0,
Expand Down
55 changes: 55 additions & 0 deletions apps/meteor/app/statistics/server/lib/statistics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import { getImporterStatistics } from './getImporterStatistics';
import { getServicesStatistics } from './getServicesStatistics';
import { readSecondaryPreferred } from '../../../../server/database/readSecondaryPreferred';
import { isRunningMs } from '../../../../server/lib/isRunningMs';
import { SystemLogger } from '../../../../server/lib/logger/system';
import { getControl } from '../../../../server/lib/migrations';
import { getSettingsStatistics } from '../../../../server/lib/statistics/getSettingsStatistics';
import { getMatrixFederationStatistics } from '../../../../server/services/federation/infrastructure/rocket-chat/adapters/Statistics';
Expand Down Expand Up @@ -599,4 +600,58 @@ export const statistics = {

return rcStatistics;
},
async updateDeploymentData(): Promise<void> {
try {
const lastStatistics = await Statistics.findLast();

if (!lastStatistics) {
return;
}

const { mongoVersion, mongoStorageEngine } = await getMongoInfo();

const deploymentInfo: Partial<IStats> = {
os: {
type: os.type(),
platform: os.platform(),
arch: os.arch(),
release: os.release(),
uptime: os.uptime(),
loadavg: os.loadavg(),
totalmem: os.totalmem(),
freemem: os.freemem(),
cpus: os.cpus(),
},
process: {
nodeVersion: process.version,
pid: process.pid,
uptime: process.uptime(),
},
deploy: {
method: process.env.DEPLOY_METHOD || 'tar',
platform: process.env.DEPLOY_PLATFORM || 'selfinstall',
},
msEnabled: isRunningMs(),
mongoVersion,
mongoStorageEngine: mongoStorageEngine || '',
migration: await getControl(),
};

if (Info) {
deploymentInfo.version = Info.version;
}

const { _id, ...baseStatistics } = lastStatistics;

const newStatistics: Omit<IStats, '_id'> = {
...baseStatistics,
...deploymentInfo,
createdAt: new Date(),
};

await Statistics.insertOne(newStatistics);
} catch (error) {
SystemLogger.error({ msg: 'Error saving statistics with new deployment data', err: error });
}
},
};
5 changes: 4 additions & 1 deletion apps/meteor/ee/server/configuration/saml.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ await License.onLicense('saml-enterprise', () => {

SAMLUtils.events.on('loadConfigs', (service: string, configs: Record<string, any>): void => {
// Include ee settings on the configs object so that they can be copied to the login service too
const rawCustomAuthnContext = settings.get(`${service}_custom_authn_context`);
const customAuthnContext = typeof rawCustomAuthnContext === 'string' ? rawCustomAuthnContext.trim() : undefined;

Object.assign(configs, {
customAuthnContext: settings.get(`${service}_custom_authn_context`),
...(customAuthnContext !== undefined && { customAuthnContext }),
authnContextComparison: settings.get(`${service}_authn_context_comparison`),
identifierFormat: settings.get(`${service}_identifier_format`),
nameIDPolicyTemplate: settings.get(`${service}_NameId_template`),
Expand Down
2 changes: 2 additions & 0 deletions apps/meteor/server/startup/migrations/xrun.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import type { UpdateResult } from 'mongodb';

import { upsertPermissions } from '../../../app/authorization/server/functions/upsertPermissions';
import { settings } from '../../../app/settings/server';
import { statistics } from '../../../app/statistics/server/lib/statistics';
import { migrateDatabase, onServerVersionChange } from '../../lib/migrations';
import { ensureCloudWorkspaceRegistered } from '../cloudRegistration';

Expand Down Expand Up @@ -62,5 +63,6 @@ export const performMigrationProcedure = async (): Promise<void> => {
await upsertPermissions();
await ensureCloudWorkspaceRegistered();
await moveRetentionSetting();
await statistics.updateDeploymentData();
});
};
22 changes: 22 additions & 0 deletions apps/meteor/tests/unit/app/meteor-accounts-saml/server.tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,28 @@ describe('SAML', () => {
expect(authorizeRequest.id).to.be.equal(credentialToken);
expect(authorizeRequest.request).to.be.equal('[callback-url] [entry-point] [issuer]');
});

it('should omit the authn context block when the customAuthnContext setting is empty', () => {
const credentialToken = '__credentialToken__';
const customOptions = {
...serviceProviderOptions,
customAuthnContext: '',
};

const authorizeRequest = AuthorizeRequest.generate(customOptions, credentialToken);
expect(authorizeRequest.request).to.not.include('<authnContext');
});

it('should treat whitespace-only values as empty custom authn contexts', () => {
const credentialToken = '__credentialToken__';
const customOptions = {
...serviceProviderOptions,
customAuthnContext: ' ',
};

const authorizeRequest = AuthorizeRequest.generate(customOptions, credentialToken);
expect(authorizeRequest.request).to.not.include('<authnContext');
});
});
});

Expand Down
Loading