Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NEW] Options for SAML auth for individual organizations needs #14275

Merged
merged 4 commits into from
Aug 21, 2019
Merged

[NEW] Options for SAML auth for individual organizations needs #14275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ec9aaa
More options for SAML auth for individual organization needs. Fix #6481
Deltachaos Aug 5, 2019
ecdd0ed
Merge branch 'develop' into bugfix/6481
sampaiodiego Aug 8, 2019
a6557fb
Check if there is an username before using it on queries
Hudell Aug 21, 2019
b5c4b34
Only update user emails when it isn't the immutable property
Hudell Aug 21, 2019
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
40 changes: 40 additions & 0 deletions app/meteor-accounts-saml/server/saml_rocketchat.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,44 @@ Meteor.methods({
section: name,
i18nLabel: 'Accounts_OAuth_Custom_Button_Color',
});
settings.add(`SAML_Custom_${ name }_email_field`, 'email', {
type: 'string',
group: 'SAML',
section: name,
i18nLabel: 'SAML_Custom_EMail_Field',
});
settings.add(`SAML_Custom_${ name }_username_field`, 'username', {
type: 'string',
group: 'SAML',
section: name,
i18nLabel: 'SAML_Custom_Username_Field',
});
settings.add(`SAML_Custom_${ name }_generate_username`, false, {
type: 'boolean',
group: 'SAML',
section: name,
i18nLabel: 'SAML_Custom_Generate_Username',
});
settings.add(`SAML_Custom_${ name }_username_normalize`, 'None', {
type: 'select',
values: [
{ key: 'None', i18nLabel: 'SAML_Custom_Username_Normalize_None' },
{ key: 'Lowercase', i18nLabel: 'SAML_Custom_Username_Normalize_Lowercase' },
],
group: 'SAML',
section: name,
i18nLabel: 'SAML_Custom_Username_Normalize',
});
settings.add(`SAML_Custom_${ name }_immutable_property`, 'EMail', {
type: 'select',
values: [
{ key: 'Username', i18nLabel: 'SAML_Custom_Immutable_Property_Username' },
{ key: 'EMail', i18nLabel: 'SAML_Custom_Immutable_Property_EMail' },
],
group: 'SAML',
section: name,
i18nLabel: 'SAML_Custom_Immutable_Property',
});
settings.add(`SAML_Custom_${ name }_debug`, false, {
type: 'boolean',
group: 'SAML',
Expand Down Expand Up @@ -149,6 +181,10 @@ const getSamlConfigs = function(service) {
},
entryPoint: settings.get(`${ service.key }_entry_point`),
idpSLORedirectURL: settings.get(`${ service.key }_idp_slo_redirect_url`),
usernameField: settings.get(`${ service.key }_username_field`),
usernameNormalize: settings.get(`${ service.key }_username_normalize`),
emailField: settings.get(`${ service.key }_email_field`),
immutableProperty: settings.get(`${ service.key }_immutable_property`),
generateUsername: settings.get(`${ service.key }_generate_username`),
debug: settings.get(`${ service.key }_debug`),
nameOverwrite: settings.get(`${ service.key }_name_overwrite`),
Expand Down Expand Up @@ -190,6 +226,10 @@ const configureSamlService = function(samlConfigs) {
Accounts.saml.settings.generateUsername = samlConfigs.generateUsername;
Accounts.saml.settings.nameOverwrite = samlConfigs.nameOverwrite;
Accounts.saml.settings.mailOverwrite = samlConfigs.mailOverwrite;
Accounts.saml.settings.immutableProperty = samlConfigs.immutableProperty;
Accounts.saml.settings.emailField = samlConfigs.emailField;
Accounts.saml.settings.usernameField = samlConfigs.usernameField;
Accounts.saml.settings.usernameNormalize = samlConfigs.usernameNormalize;
Accounts.saml.settings.debug = samlConfigs.debug;

return {
Expand Down
73 changes: 55 additions & 18 deletions app/meteor-accounts-saml/server/saml_server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import _ from 'underscore';
import { SAML } from './saml_utils';
import { CredentialTokens } from '../../models';
import { generateUsernameSuggestion } from '../../lib';
import { _setUsername } from '../../lib/server/functions';

if (!Accounts.saml) {
Accounts.saml = {
Expand Down Expand Up @@ -94,6 +95,16 @@ Meteor.methods({
},
});

Accounts.normalizeUsername = function(name) {
switch (Accounts.saml.settings.usernameNormalize) {
case 'Lowercase':
name = name.toLowerCase();
break;
}

return name;
};

Accounts.registerLoginHandler(function(loginRequest) {
if (!loginRequest.saml || !loginRequest.credentialToken) {
return undefined;
Expand All @@ -111,8 +122,10 @@ Accounts.registerLoginHandler(function(loginRequest) {
};
}

const { emailField, usernameField } = Accounts.saml.settings;

if (loginResult && loginResult.profile && loginResult.profile.email) {
const emailList = Array.isArray(loginResult.profile.email) ? loginResult.profile.email : [loginResult.profile.email];
const emailList = Array.isArray(loginResult.profile[emailField]) ? loginResult.profile[emailField] : [loginResult.profile[emailField]];
const emailRegex = new RegExp(emailList.map((email) => `^${ RegExp.escape(email) }$`).join('|'), 'i');

const eduPersonPrincipalName = loginResult.profile.eppn;
Expand All @@ -132,32 +145,46 @@ Accounts.registerLoginHandler(function(loginRequest) {
}
}

let username;
if (loginResult.profile[usernameField]) {
username = Accounts.normalizeUsername(loginResult.profile[usernameField]);
}

// If eppn is not exist
if (!user) {
user = Meteor.users.findOne({
'emails.address': emailRegex,
});
if (Accounts.saml.settings.immutableProperty === 'Username') {
if (username) {
user = Meteor.users.findOne({
username,
});
}
} else {
user = Meteor.users.findOne({
'emails.address': emailRegex,
});
}
}

const emails = emailList.map((email) => ({
address: email,
verified: true,
}));

if (!user) {
const newUser = {
name: fullName,
active: true,
eppn: eduPersonPrincipalName,
globalRoles: ['user'],
emails: emailList.map((email) => ({
address: email,
verified: true,
})),
emails,
};

if (Accounts.saml.settings.generateUsername === true) {
const username = generateUsernameSuggestion(newUser);
if (username) {
newUser.username = username;
}
} else if (loginResult.profile.username) {
newUser.username = loginResult.profile.username;
username = generateUsernameSuggestion(newUser);
}

if (username) {
newUser.username = username;
}

const userId = Accounts.insertUserDoc({}, newUser);
Expand Down Expand Up @@ -190,15 +217,25 @@ Accounts.registerLoginHandler(function(loginRequest) {
nameID: loginResult.profile.nameID,
};

const updateData = {
// TBD this should be pushed, otherwise we're only able to SSO into a single IDP at a time
'services.saml': samlLogin,
};

if (Accounts.saml.settings.immutableProperty !== 'EMail') {
updateData.emails = emails;
}

Meteor.users.update({
_id: user._id,
}, {
$set: {
// TBD this should be pushed, otherwise we're only able to SSO into a single IDP at a time
'services.saml': samlLogin,
},
$set: updateData,
});

if (username) {
_setUsername(user._id, username);
}

// Overwrite fullname if needed
if (Accounts.saml.settings.nameOverwrite === true) {
Meteor.users.update({
Expand Down
8 changes: 8 additions & 0 deletions packages/rocketchat-i18n/i18n/de.i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2567,6 +2567,14 @@
"SAML_Custom_Logout_Behaviour_Terminate_SAML_Session": "SAML-Session beenden",
"SAML_Custom_Private_Key": "Privater Schlüssel",
"SAML_Custom_Provider": "Benutzerdefinierter Provider",
"SAML_Custom_EMail_Field": "E-Mail Feldname",
"SAML_Custom_Username_Field": "Username Feldname",
"SAML_Custom_Username_Normalize": "Benutzername normalisierung",
"SAML_Custom_Username_Normalize_None": "Keine normalisierung",
"SAML_Custom_Username_Normalize_Lowercase": "Zu Kleinschreibung",
"SAML_Custom_Immutable_Property": "Unveränderbares Feld",
"SAML_Custom_Immutable_Property_Username": "Benutzername",
"SAML_Custom_Immutable_Property_EMail": "E-Mail",
"SAML_Custom_Public_Cert": "Öffentliches Zertifikat",
"Saturday": "Samstag",
"Save": "Speichern",
Expand Down
8 changes: 8 additions & 0 deletions packages/rocketchat-i18n/i18n/en.i18n.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2603,6 +2603,14 @@
"SAML_Custom_Logout_Behaviour_Terminate_SAML_Session": "Terminate SAML-session",
"SAML_Custom_Private_Key": "Private Key Contents",
"SAML_Custom_Provider": "Custom Provider",
"SAML_Custom_EMail_Field": "E-Mail field name",
"SAML_Custom_Username_Field": "Username field name",
"SAML_Custom_Username_Normalize": "Normalize username",
"SAML_Custom_Username_Normalize_None": "No normalization",
"SAML_Custom_Username_Normalize_Lowercase": "To Lowercase",
"SAML_Custom_Immutable_Property": "Immutable field name",
"SAML_Custom_Immutable_Property_Username": "Username",
"SAML_Custom_Immutable_Property_EMail": "E-Mail",
"SAML_Custom_Public_Cert": "Public Cert Contents",
"Saturday": "Saturday",
"Save": "Save",
Expand Down