lib/authentication.js

  1. /**
  2.  * @file Handle (pseudo-)authentication
  3.  * @author Antonio Olmo Titos <a@olmo-titos.info>
  4.  * @exports lib/authentication
  5.  */
  7. // External packages:
  8. const COOKIE_SESSION = require('cookie-session');
  10. // Internal packages:
  11. const LOGGING = require('./logging');
  13. // Variables:
  14. var ready = false;
  16. /**
  17.  * Set up authentication
  18.  * @param {Object} app - the <a href="http://expressjs.com/">Express</a> application
  19.  */
  21. const setUp = function(app) {
  22.     if (ready)
  23.         LOGGING.warn(`“authentication.setUp()” called more than once`);
  24.     else {
  25.         app.set('trust proxy', 1);
  26.         app.use(new COOKIE_SESSION({name: 'session', keys: ['key1', 'key2']}));
  27.         ready = true;
  28.         // Export more stuff:
  29.         exports.isKnownUser = isKnownUser;
  30.         exports.getUser = getUser;
  31.         exports.setUser = setUser;
  32.         exports.logOut = logOut;
  33.     }
  34. };
  36. /**
  37.  * Check if the user is authenticated
  38.  * @param {Object} req - Express request
  39.  * @returns {Boolean} whether the user is authenticated
  40.  */
  42. const isKnownUser = function(req) {
  43.     return !!(req && req.session && req.session.user);
  44. };
  46. /**
  47.  * Authenticate a user
  48.  * @param {Object} req - Express request
  49.  * @param {Object} user - user properties (a dictionary)
  50.  */
  52. const setUser = function(req, user) {
  53.     LOGGING.info(`authenticating user ${user.name}`);
  54.     if (req && req.session && req.session.user)
  55.         LOGGING.warn(`called “authentication.setUser()” for a session that is already authenticated`);
  56.     req.session.user = user;
  57. };
  59. /**
  60.  * Get the user that is currently authenticated (if any)
  61.  * @param {Object} req - Express request
  62.  * @returns {Object} user properties (dictionary) of the user, if any; <code>undefined</code> otherwise
  63.  */
  65. const getUser = function(req) {
  66.     LOGGING.dir(req.session.user);
  67.     return req.session.user;
  68. };
  70. /**
  71.  * De-authenticate a user (log them out)
  72.  * @param {Object} req - Express request
  73.  */
  75. const logOut = function(req) {
  76.     if (req && req.session && req.session.user)
  77.         delete req.session.user;
  78. };
  80. // Export stuff:
  81. exports.setUp = setUp;