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.

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] add failed login audit log writing #13387

Closed
wants to merge 11 commits into from
Closed
1 change: 1 addition & 0 deletions .meteor/packages
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,4 @@ webapp
webapp-hashing
rocketchat:oauth2-server
rocketchat:i18n
rocketchat:failed-login-audit
16 changes: 16 additions & 0 deletions packages/rocketchat-failed-login-audit/package.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Package.describe({
name: 'rocketchat:failed-login-audit',
version: '0.0.1',
summary: '',
git: '',
documentation: 'README.md',
});

Package.onUse(function(api) {
api.use([
'ecmascript',
'rocketchat:lib',
'rocketchat:settings',
]);
api.mainModule('server/index.js', 'server');
});
97 changes: 97 additions & 0 deletions packages/rocketchat-failed-login-audit/server/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
import { Meteor } from 'meteor/meteor';
import { RocketChat } from 'meteor/rocketchat:lib';

RocketChat.FailedLoginAudit = {
enabled: false,
log_useragent: false,
log_clientip: false,
log_username: false,
log_forwarded_for_ip: false,
};

Meteor.startup(function() {
RocketChat.settings.addGroup('Failed Login Audit', function() {
this.add('FailedLoginAudit_Enabled', false, {
type: 'boolean',
i18nLabel: 'Enabled',
});
this.add('FailedLoginAudit_Log_Username', false, {
type: 'boolean',
i18nLabel: 'Write user name to logfile',
enableQuery: { _id: 'FailedLoginAudit_Enabled', value: true },
}
);

this.add('FailedLoginAudit_Log_UserAgent', false, {
type: 'boolean',
i18nLabel: 'Write user agent to logfile',
enableQuery: { _id: 'FailedLoginAudit_Enabled', value: true },
}
);

this.add('FailedLoginAudit_Log_ClientIp', false, {
type: 'boolean',
i18nLabel: 'Write client ip to logfile',
enableQuery: { _id: 'FailedLoginAudit_Enabled', value: true },
}
);

this.add('FailedLoginAudit_Log_ForwardedForIp', false, {
type: 'boolean',
i18nLabel: 'Write forwared for ip to logfile',
enableQuery: { _id: 'FailedLoginAudit_Enabled', value: true },
}
);

});
});

RocketChat.settings.get('FailedLoginAudit_Enabled', function(key, value) {
RocketChat.FailedLoginAudit.enabled = value;
});

RocketChat.settings.get('FailedLoginAudit_Log_Username', function(key, value) {
RocketChat.FailedLoginAudit.log_username = value;
});

RocketChat.settings.get('FailedLoginAudit_Log_UserAgent', function(key, value) {
RocketChat.FailedLoginAudit.log_useragent = value;
});

RocketChat.settings.get('FailedLoginAudit_Log_ClientIp', function(key, value) {
RocketChat.FailedLoginAudit.log_clientip = value;
});

RocketChat.settings.get('FailedLoginAudit_Log_ForwardedForIp', function(key, value) {
RocketChat.FailedLoginAudit.log_forwarded_for_ip = value;
});

RocketChat.callbacks.add('beforeValidateLogin', (login) => {

if (RocketChat.FailedLoginAudit.enabled !== true) {
return login;
}

if (login.allowed !== true) {
let user = 'unknown';
if (login.user !== undefined && RocketChat.FailedLoginAudit.log_username === true) {
user = login.user.username;
}
const { connection } = login;
let { clientAddress } = connection.clientAddress;
if (RocketChat.FailedLoginAudit.log_clientip !== true) {
clientAddress = '-';
}
let forwardedFor = connection.httpHeaders['x-forwarded-for'];
if (RocketChat.FailedLoginAudit.log_forwarded_for_ip !== true) {
forwardedFor = '-';
}
let userAgent = connection.httpHeaders['user-agent'];
if (RocketChat.FailedLoginAudit.log_useragent !== true) {
userAgent = '-';
}
console.log('Failed login detected - Username[%s] ClientAddress[%s] ForwardedFor[%s] UserAgent[%s]', user, clientAddress, forwardedFor, userAgent);
}

return login;
});