Overleaf/services/web/app/coffee/Features/Authentication/AuthenticationController.coffee

AuthenticationManager = require ("./AuthenticationManager")
LoginRateLimiter = require("../Security/LoginRateLimiter")
UserGetter = require "../User/UserGetter"
UserUpdater = require "../User/UserUpdater"
Metrics = require('../../infrastructure/Metrics')
logger = require("logger-sharelatex")
querystring = require('querystring')
Url = require("url")
Settings = require "settings-sharelatex"
basicAuth = require('basic-auth-connect')
UserHandler = require("../User/UserHandler")
UserSessionsManager = require("../User/UserSessionsManager")
Analytics = require "../Analytics/AnalyticsManager"

module.exports = AuthenticationController =

	# login: (req, res, next = (error) ->) ->
	# 	AuthenticationController.doLogin req.body, req, res, next

	serializeUser: (user, callback) ->
		lightUser =
			_id: user._id
			first_name: user.first_name
			last_name: user.last_name
			isAdmin: user.isAdmin
			email: user.email
			referal_id: user.referal_id
			session_created: (new Date()).toISOString()
			ip_address: user._login_req_ip
		callback(null, lightUser)

	deserializeUser: (user, cb) ->
		cb(null, user)

	doPassportLogin: (req, username, password, done) ->
		email = username.toLowerCase()
		redir = Url.parse(req?.body?.redir or "/project").path
		LoginRateLimiter.processLoginRequest email, (err, isAllowed)->
			return done(err) if err?
			if !isAllowed
				logger.log email:email, "too many login requests"
				return done(null, null, {message: req.i18n.translate("to_many_login_requests_2_mins"), type: 'error'})
			AuthenticationManager.authenticate email: email, password, (error, user) ->
				return done(error) if error?
				if user?
					# async actions
					UserHandler.setupLoginData(user, ()->)
					LoginRateLimiter.recordSuccessfulLogin(email)
					AuthenticationController._recordSuccessfulLogin(user._id)
					Analytics.recordEvent(user._id, "user-logged-in")
					UserSessionsManager.trackSession(user, req.sessionID, () ->)
					req.session.justLoggedIn = true
					logger.log email: email, user_id: user._id.toString(), "successful log in"
					# capture the request ip for use when creating the session
					user._login_req_ip = req.ip
					req._redir = redir
					return done(null, user)
				else
					AuthenticationController._recordFailedLogin()
					logger.log email: email, "failed log in"
					return done(null, false, {message: req.i18n.translate("email_or_password_wrong_try_again"), type: 'error'})

	isUserLoggedIn: (req) ->
		user_id = AuthenticationController.getLoggedInUserId(req)
		return user_id?

	# TODO: perhaps should produce an error if the current user is not present
	getLoggedInUserId: (req) ->
		user = AuthenticationController.getSessionUser(req)
		if user?
			return user._id
		else
			return null

	getSessionUser: (req) ->
		# old sessions
		if req?.session?.user?._id?
			return req.session.user
		# new passport sessions
		else if req?.session?.passport?.user?._id?
			return req.session.passport.user
		# neither
		else
			return null

	# TODO: perhaps should produce an error if the current user is not present
	getLoggedInUser: (req, callback = (error, user) ->) ->
		user_id = AuthenticationController.getLoggedInUserId(req)
		if !user_id?
			return callback(null, null)
		# omit sensitive information
		UserGetter.getUser user_id, {hashedPassword: false, refProviders: false}, callback

	requireLogin: () ->
		doRequest = (req, res, next = (error) ->) ->
			if !AuthenticationController.isUserLoggedIn(req)
				AuthenticationController._redirectToLoginOrRegisterPage(req, res)
			else
				next()

		return doRequest

	_globalLoginWhitelist: []
	addEndpointToLoginWhitelist: (endpoint) ->
		AuthenticationController._globalLoginWhitelist.push endpoint

	requireGlobalLogin: (req, res, next) ->
		if req._parsedUrl.pathname in AuthenticationController._globalLoginWhitelist
			return next()

		if req.headers['authorization']?
			return AuthenticationController.httpAuth(req, res, next)
		else if AuthenticationController.isUserLoggedIn()?
			return next()
		else
			logger.log url:req.url, "user trying to access endpoint not in global whitelist"
			return res.redirect "/login"

	httpAuth: basicAuth (user, pass)->
		isValid = Settings.httpAuthUsers[user] == pass
		if !isValid
			logger.err user:user, pass:pass, "invalid login details"
		return isValid

	_redirectToLoginOrRegisterPage: (req, res)->
		if req.query.zipUrl? or req.query.project_name?
			return AuthenticationController._redirectToRegisterPage(req, res)
		else
			AuthenticationController._redirectToLoginPage(req, res)


	_redirectToLoginPage: (req, res) ->
		logger.log url: req.url, "user not logged in so redirecting to login page"
		req.query.redir = req.path
		url = "/login?#{querystring.stringify(req.query)}"
		res.redirect url
		Metrics.inc "security.login-redirect"

	_redirectToRegisterPage: (req, res) ->
		logger.log url: req.url, "user not logged in so redirecting to register page"
		req.query.redir = req.path
		url = "/register?#{querystring.stringify(req.query)}"
		res.redirect url
		Metrics.inc "security.login-redirect"

	_recordSuccessfulLogin: (user_id, callback = (error) ->) ->
		UserUpdater.updateUser user_id.toString(), {
			$set: { "lastLoggedIn": new Date() },
			$inc: { "loginCount": 1 }
		}, (error) ->
			callback(error) if error?
			Metrics.inc "user.login.success"
			callback()

	_recordFailedLogin: (callback = (error) ->) ->
		Metrics.inc "user.login.failed"
		callback()

	# establishUserSession: (req, user, callback = (error) ->) ->
	# 	dienow
	# 	lightUser =
	# 		_id: user._id
	# 		first_name: user.first_name
	# 		last_name: user.last_name
	# 		isAdmin: user.isAdmin
	# 		email: user.email
	# 		referal_id: user.referal_id
	# 		session_created: (new Date()).toISOString()
	# 		ip_address: req.ip
	# 	# Regenerate the session to get a new sessionID (cookie value) to
	# 	# protect against session fixation attacks
	# 	oldSession = req.session
	# 	req.session.destroy()
	# 	req.sessionStore.generate(req)
	# 	for key, value of oldSession
	# 		req.session[key] = value

	# 	req.session.user = lightUser

	# 	UserSessionsManager.trackSession(user, req.sessionID, () ->)
	# 	callback()


	# doLogin: (options, req, res, next) ->
	# 	dienow
	# 	email = options.email?.toLowerCase()
	# 	password = options.password
	# 	redir = Url.parse(options.redir or "/project").path
	# 	LoginRateLimiter.processLoginRequest email, (err, isAllowed)->
	# 		if !isAllowed
	# 			logger.log email:email, "too many login requests"
	# 			res.statusCode = 429
	# 			return res.send
	# 				message:
	# 					text: req.i18n.translate("to_many_login_requests_2_mins"),
	# 					type: 'error'
	# 		AuthenticationManager.authenticate email: email, password, (error, user) ->
	# 			return next(error) if error?
	# 			if user?
	# 				UserHandler.setupLoginData user, ->
	# 				LoginRateLimiter.recordSuccessfulLogin email
	# 				AuthenticationController._recordSuccessfulLogin user._id
	# 				AuthenticationController.establishUserSession req, user, (error) ->
	# 					return next(error) if error?
	# 					req.session.justLoggedIn = true
	# 					logger.log email: email, user_id: user._id.toString(), "successful log in"
	# 					Analytics.recordEvent user._id, "user-logged-in"
	# 					res.json redir: redir
	# 			else
	# 				AuthenticationController._recordFailedLogin()
	# 				logger.log email: email, "failed log in"
	# 				res.json message:
	# 					text: req.i18n.translate("email_or_password_wrong_try_again"),
	# 					type: 'error'