| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256 |
- const Path = require('path')
- const express = require('express')
- const Settings = require('settings-sharelatex')
- const logger = require('logger-sharelatex')
- const metrics = require('metrics-sharelatex')
- const expressLocals = require('./ExpressLocals')
- const Validation = require('./Validation')
- const Router = require('../router')
- const helmet = require('helmet')
- const UserSessionsRedis = require('../Features/User/UserSessionsRedis')
- const Csrf = require('./Csrf')
- const sessionsRedisClient = UserSessionsRedis.client()
- const SessionAutostartMiddleware = require('./SessionAutostartMiddleware')
- const SessionStoreManager = require('./SessionStoreManager')
- const session = require('express-session')
- const RedisStore = require('connect-redis')(session)
- const bodyParser = require('./BodyParserWrapper')
- const methodOverride = require('method-override')
- const cookieParser = require('cookie-parser')
- const bearerToken = require('express-bearer-token')
- const passport = require('passport')
- const LocalStrategy = require('passport-local').Strategy
- const oneDayInMilliseconds = 86400000
- const ReferalConnect = require('../Features/Referal/ReferalConnect')
- const RedirectManager = require('./RedirectManager')
- const ProxyManager = require('./ProxyManager')
- const translations = require('translations-sharelatex').setup(Settings.i18n)
- const Modules = require('./Modules')
- const Views = require('./Views')
- const ErrorController = require('../Features/Errors/ErrorController')
- const HttpErrorController = require('../Features/Errors/HttpErrorController')
- const UserSessionsManager = require('../Features/User/UserSessionsManager')
- const AuthenticationController = require('../Features/Authentication/AuthenticationController')
- const STATIC_CACHE_AGE = Settings.cacheStaticAssets
- ? oneDayInMilliseconds * 365
- : 0
- // Init the session store
- const sessionStore = new RedisStore({ client: sessionsRedisClient })
- const app = express()
- const webRouter = express.Router()
- const privateApiRouter = express.Router()
- const publicApiRouter = express.Router()
- if (Settings.behindProxy) {
- app.set('trust proxy', Settings.trustedProxyIps || true)
- /**
- * Handle the X-Original-Forwarded-For header.
- *
- * The nginx ingress sends us the contents of X-Forwarded-For it received in
- * X-Original-Forwarded-For. Express expects all proxy IPs to be in a comma
- * separated list in X-Forwarded-For.
- */
- app.use((req, res, next) => {
- if (
- req.headers['x-original-forwarded-for'] &&
- req.headers['x-forwarded-for']
- ) {
- req.headers['x-forwarded-for'] =
- req.headers['x-original-forwarded-for'] +
- ', ' +
- req.headers['x-forwarded-for']
- }
- next()
- })
- }
- webRouter.use(
- express.static(Path.join(__dirname, '/../../../public'), {
- maxAge: STATIC_CACHE_AGE
- })
- )
- app.set('views', Path.join(__dirname, '/../../views'))
- app.set('view engine', 'pug')
- Modules.loadViewIncludes(app)
- app.use(bodyParser.urlencoded({ extended: true, limit: '2mb' }))
- app.use(bodyParser.json({ limit: Settings.max_json_request_size }))
- app.use(methodOverride())
- app.use(bearerToken())
- app.use(metrics.http.monitor(logger))
- RedirectManager.apply(webRouter)
- ProxyManager.apply(publicApiRouter)
- webRouter.use(cookieParser(Settings.security.sessionSecret))
- SessionAutostartMiddleware.applyInitialMiddleware(webRouter)
- webRouter.use(
- session({
- resave: false,
- saveUninitialized: false,
- secret: Settings.security.sessionSecret,
- proxy: Settings.behindProxy,
- cookie: {
- domain: Settings.cookieDomain,
- maxAge: Settings.cookieSessionLength, // in milliseconds, see https://github.com/expressjs/session#cookiemaxage
- secure: Settings.secureCookie,
- sameSite: Settings.sameSiteCookie
- },
- store: sessionStore,
- key: Settings.cookieName,
- rolling: true
- })
- )
- // patch the session store to generate a validation token for every new session
- SessionStoreManager.enableValidationToken(sessionStore)
- // use middleware to reject all requests with invalid tokens
- webRouter.use(SessionStoreManager.validationMiddleware)
- // passport
- webRouter.use(passport.initialize())
- webRouter.use(passport.session())
- passport.use(
- new LocalStrategy(
- {
- passReqToCallback: true,
- usernameField: 'email',
- passwordField: 'password'
- },
- AuthenticationController.doPassportLogin
- )
- )
- passport.serializeUser(AuthenticationController.serializeUser)
- passport.deserializeUser(AuthenticationController.deserializeUser)
- Modules.hooks.fire('passportSetup', passport, function(err) {
- if (err != null) {
- logger.err({ err }, 'error setting up passport in modules')
- }
- })
- Modules.applyNonCsrfRouter(webRouter, privateApiRouter, publicApiRouter)
- webRouter.csrf = new Csrf()
- webRouter.use(webRouter.csrf.middleware)
- webRouter.use(translations.expressMiddlewear)
- webRouter.use(translations.setLangBasedOnDomainMiddlewear)
- // Measure expiry from last request, not last login
- webRouter.use(function(req, res, next) {
- if (!req.session.noSessionCallback) {
- req.session.touch()
- if (AuthenticationController.isUserLoggedIn(req)) {
- UserSessionsManager.touch(
- AuthenticationController.getSessionUser(req),
- err => {
- if (err) {
- logger.err({ err }, 'error extending user session')
- }
- }
- )
- }
- }
- next()
- })
- webRouter.use(ReferalConnect.use)
- expressLocals(webRouter, privateApiRouter, publicApiRouter)
- webRouter.use(SessionAutostartMiddleware.invokeCallbackMiddleware)
- webRouter.use(function(req, res, next) {
- if (Settings.siteIsOpen) {
- next()
- } else if (
- AuthenticationController.getSessionUser(req) &&
- AuthenticationController.getSessionUser(req).isAdmin
- ) {
- next()
- } else {
- res.status(503)
- res.render('general/closed', { title: 'maintenance' })
- }
- })
- webRouter.use(function(req, res, next) {
- if (Settings.editorIsOpen) {
- next()
- } else if (req.url.indexOf('/admin') === 0) {
- next()
- } else {
- res.status(503)
- res.render('general/closed', { title: 'maintenance' })
- }
- })
- // add security headers using Helmet
- webRouter.use(function(req, res, next) {
- const isLoggedIn = AuthenticationController.isUserLoggedIn(req)
- const isProjectPage = !!req.path.match('^/project/[a-f0-9]{24}$')
- helmet({
- // note that more headers are added by default
- dnsPrefetchControl: false,
- referrerPolicy: { policy: 'origin-when-cross-origin' },
- noCache: isLoggedIn || isProjectPage,
- hsts: false
- })(req, res, next)
- })
- logger.info('creating HTTP server'.yellow)
- const server = require('http').createServer(app)
- // provide settings for separate web and api processes
- // if enableApiRouter and enableWebRouter are not defined they default
- // to true.
- const notDefined = x => x == null
- const enableApiRouter =
- Settings.web != null ? Settings.web.enableApiRouter : undefined
- if (enableApiRouter || notDefined(enableApiRouter)) {
- logger.info('providing api router')
- app.use(privateApiRouter)
- app.use(Validation.errorMiddleware)
- app.use(HttpErrorController.handleError)
- app.use(ErrorController.handleApiError)
- }
- const enableWebRouter =
- Settings.web != null ? Settings.web.enableWebRouter : undefined
- if (enableWebRouter || notDefined(enableWebRouter)) {
- logger.info('providing web router')
- if (app.get('env') === 'production') {
- logger.info('precompiling views for web in production environment')
- Views.precompileViews(app)
- }
- app.use(publicApiRouter) // public API goes with web router for public access
- app.use(Validation.errorMiddleware)
- app.use(HttpErrorController.handleError)
- app.use(ErrorController.handleApiError)
- app.use(webRouter)
- app.use(Validation.errorMiddleware)
- app.use(HttpErrorController.handleError)
- app.use(ErrorController.handleError)
- }
- metrics.injectMetricsRoute(webRouter)
- Router.initialize(webRouter, privateApiRouter, publicApiRouter)
- module.exports = {
- app,
- server
- }
|