'use strict'; const Joi = require('../joi'); const MongoPaging = require('mongo-cursor-pagination-node6'); const ObjectID = require('mongodb').ObjectID; module.exports = (db, server, userHandler) => { /** * @api {post} /authenticate Authenticate an User * @apiName PostAuth * @apiGroup Authentication * @apiHeader {String} X-Access-Token Optional access token if authentication is enabled * @apiHeaderExample {json} Header-Example: * { * "X-Access-Token": "59fc66a03e54454869460e45" * } * * @apiParam {String} username Username or E-mail address * @apiParam {String} password Password * @apiParam {String} [protocol] Application identifier for security logs * @apiParam {String} [scope="master"] Required scope. One of master, imap, smtp, pop3 * @apiParam {String} [sess] Session identifier for the logs * @apiParam {String} [ip] IP address for the logs * * @apiSuccess {Boolean} success Indicates successful response * @apiSuccess {String} id ID of authenticated User * @apiSuccess {String} username Username of authenticated User * @apiSuccess {String} scope The scope this authentication is valid for * @apiSuccess {String[]} require2fa List of enabled 2FA mechanisms * @apiSuccess {Boolean} requirePasswordChange Indicates if account hassword has been reset and should be replaced * * @apiError error Description of the error * * @apiExample {curl} Example usage: * curl -i -XPOST http://localhost:8080/authenticate \ * -H 'Content-type: application/json' \ * -d '{ * "username": "myuser", * "password": "secretpass", * "scope": "master" * }' * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK * { * "success": true, * "id": "5a12914c350c183bd0d331f0", * "username": "myuser", * "scope": "master", * "require2fa": [ * "totp" * ], * "requirePasswordChange": false * } * * @apiErrorExample {json} Error-Response: * HTTP/1.1 200 OK * { * "error": "Authentication failed. Invalid scope" * } */ server.post('/authenticate', (req, res, next) => { res.charSet('utf-8'); const schema = Joi.object().keys({ username: Joi.alternatives() .try( Joi.string() .lowercase() .regex(/^[a-z](?:\.?[a-z0-9]+)*$/, 'username') .min(3) .max(30), Joi.string().email() ) .required(), password: Joi.string() .max(256) .required(), protocol: Joi.string().default('API'), scope: Joi.string().default('master'), sess: Joi.string().max(255), ip: Joi.string().ip({ version: ['ipv4', 'ipv6'], cidr: 'forbidden' }) }); const result = Joi.validate(req.params, schema, { abortEarly: false, convert: true }); if (result.error) { res.json({ error: result.error.message }); return next(); } let meta = { protocol: result.value.protocol, sess: result.value.sess, ip: result.value.ip }; userHandler.authenticate(result.value.username, result.value.password, result.value.scope, meta, (err, authData) => { if (err) { res.json({ error: err.message }); return next(); } if (!authData) { res.json({ error: 'Authentication failed' }); return next(); } let authResponse = { success: true, id: authData.user, username: authData.username, scope: authData.scope, require2fa: authData.require2fa, requirePasswordChange: authData.requirePasswordChange }; if (authData.u2fAuthRequest) { authResponse.u2fAuthRequest = authData.u2fAuthRequest; } res.json(authResponse); return next(); }); }); /** * @api {get} /users/:user/authlog List authentication Events * @apiName GetAuthlog * @apiGroup Authentication * @apiHeader {String} X-Access-Token Optional access token if authentication is enabled * @apiHeaderExample {json} Header-Example: * { * "X-Access-Token": "59fc66a03e54454869460e45" * } * * @apiParam {String} user ID of the User * @apiParam {String} [action] Limit listing only to values with specific action value * @apiParam {String} [sess] Limit listing only to values with specific session identifier * @apiParam {String} [ip Limit listing only to values with specific IP address * @apiParam {Number} [limit=20] How many records to return * @apiParam {Number} [page=1] Current page number. Informational only, page numbers start from 1 * @apiParam {Number} [next] Cursor value for next page, retrieved from nextCursor response value * @apiParam {Number} [previous] Cursor value for previous page, retrieved from previousCursor response value * * @apiSuccess {Boolean} success Indicates successful response * @apiSuccess {Number} total How many results were found * @apiSuccess {Number} page Current page number. Derived from page query argument * @apiSuccess {String} previousCursor Either a cursor string or false if there are not any previous results * @apiSuccess {String} nextCursor Either a cursor string or false if there are not any next results * @apiSuccess {Object[]} results Event listing * @apiSuccess {String} results.id ID of the Event * @apiSuccess {String} results.action Action identifier * @apiSuccess {String} results.result Did the action succeed * @apiSuccess {String} results.sess Session identifier * @apiSuccess {String} results.ip IP address of the Event * @apiSuccess {String} results.created Datestring of the Event time * * @apiError error Description of the error * * @apiExample {curl} Example usage: * curl -i "http://localhost:8080/users/59fc66a03e54454869460e45/authlog?action=account+created" * * @apiSuccessExample {json} Success-Response: * HTTP/1.1 200 OK * { * "success": true, * "action": "account created", * "total": 1, * "page": 1, * "previousCursor": false, * "nextCursor": false, * "results": [ * { * "id": "59fc66a03e54454869460e4d", * "action": "account created", * "result": "success", * "sess": null, * "ip": null, * "created": "2017-11-03T12:52:48.792Z", * "expires": "2017-12-03T12:52:48.792Z" * } * ] * } * * @apiErrorExample {json} Error-Response: * HTTP/1.1 200 OK * { * "error": "Database error" * } */ server.get({ name: 'authlog', path: '/users/:user/authlog' }, (req, res, next) => { res.charSet('utf-8'); const schema = Joi.object().keys({ user: Joi.string() .hex() .lowercase() .length(24) .required(), action: Joi.string() .trim() .lowercase() .empty('') .max(100), sess: Joi.string() .trim() .lowercase() .empty('') .max(100), ip: Joi.string().ip({ version: ['ipv4', 'ipv6'], cidr: 'forbidden' }), limit: Joi.number() .default(20) .min(1) .max(250), next: Joi.string() .empty('') .mongoCursor() .max(1024), previous: Joi.string() .empty('') .mongoCursor() .max(1024), page: Joi.number() .empty('') .default(1) }); req.query.user = req.params.user; const result = Joi.validate(req.query, schema, { abortEarly: false, convert: true, allowUnknown: false }); if (result.error) { res.json({ error: result.error.message }); return next(); } let user = new ObjectID(result.value.user); let limit = result.value.limit; let action = result.value.action; let sess = result.value.sess; let ip = result.value.ip; let page = result.value.page; let pageNext = result.value.next; let pagePrevious = result.value.previous; db.users.collection('users').findOne( { _id: user }, { fields: { _id: true } }, (err, userData) => { if (err) { res.json({ error: 'MongoDB Error: ' + err.message }); return next(); } if (!userData) { res.json({ error: 'This user does not exist' }); return next(); } let filter = { user }; if (action) { filter.action = action; } if (sess) { filter.sess = sess; } if (ip) { filter.ip = ip; } db.database.collection('authlog').count(filter, (err, total) => { if (err) { res.json({ error: err.message }); return next(); } let opts = { limit, query: filter, sortAscending: false }; if (pageNext) { opts.next = pageNext; } else if (pagePrevious) { opts.previous = pagePrevious; } MongoPaging.find(db.users.collection('authlog'), opts, (err, result) => { if (err) { res.json({ error: result.error.message }); return next(); } if (!result.hasPrevious) { page = 1; } let response = { success: true, action, total, page, previousCursor: result.hasPrevious ? result.previous : false, nextCursor: result.hasNext ? result.next : false, results: (result.results || []).map(resultData => { let response = { id: resultData._id }; Object.keys(resultData).forEach(key => { if (!['_id', 'user'].includes(key)) { response[key] = resultData[key]; } }); return response; }) }; res.json(response); return next(); }); }); } ); }); };