Server.js 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  1. const Path = require('path')
  2. const express = require('express')
  3. const Settings = require('settings-sharelatex')
  4. const logger = require('logger-sharelatex')
  5. const metrics = require('metrics-sharelatex')
  6. const expressLocals = require('./ExpressLocals')
  7. const Validation = require('./Validation')
  8. const Router = require('../router')
  9. const helmet = require('helmet')
  10. const UserSessionsRedis = require('../Features/User/UserSessionsRedis')
  11. const Csrf = require('./Csrf')
  12. const sessionsRedisClient = UserSessionsRedis.client()
  13. const SessionAutostartMiddleware = require('./SessionAutostartMiddleware')
  14. const SessionStoreManager = require('./SessionStoreManager')
  15. const session = require('express-session')
  16. const RedisStore = require('connect-redis')(session)
  17. const bodyParser = require('./BodyParserWrapper')
  18. const methodOverride = require('method-override')
  19. const cookieParser = require('cookie-parser')
  20. const bearerToken = require('express-bearer-token')
  21. const passport = require('passport')
  22. const LocalStrategy = require('passport-local').Strategy
  23. const oneDayInMilliseconds = 86400000
  24. const ReferalConnect = require('../Features/Referal/ReferalConnect')
  25. const RedirectManager = require('./RedirectManager')
  26. const ProxyManager = require('./ProxyManager')
  27. const translations = require('translations-sharelatex').setup(Settings.i18n)
  28. const Modules = require('./Modules')
  29. const Views = require('./Views')
  30. const ErrorController = require('../Features/Errors/ErrorController')
  31. const HttpErrorController = require('../Features/Errors/HttpErrorController')
  32. const UserSessionsManager = require('../Features/User/UserSessionsManager')
  33. const AuthenticationController = require('../Features/Authentication/AuthenticationController')
  34. const STATIC_CACHE_AGE = Settings.cacheStaticAssets
  35. ? oneDayInMilliseconds * 365
  36. : 0
  37. // Init the session store
  38. const sessionStore = new RedisStore({ client: sessionsRedisClient })
  39. const app = express()
  40. const webRouter = express.Router()
  41. const privateApiRouter = express.Router()
  42. const publicApiRouter = express.Router()
  43. if (Settings.behindProxy) {
  44. app.set('trust proxy', Settings.trustedProxyIps || true)
  45. /**
  46. * Handle the X-Original-Forwarded-For header.
  47. *
  48. * The nginx ingress sends us the contents of X-Forwarded-For it received in
  49. * X-Original-Forwarded-For. Express expects all proxy IPs to be in a comma
  50. * separated list in X-Forwarded-For.
  51. */
  52. app.use((req, res, next) => {
  53. if (
  54. req.headers['x-original-forwarded-for'] &&
  55. req.headers['x-forwarded-for']
  56. ) {
  57. req.headers['x-forwarded-for'] =
  58. req.headers['x-original-forwarded-for'] +
  59. ', ' +
  60. req.headers['x-forwarded-for']
  61. }
  62. next()
  63. })
  64. }
  65. webRouter.use(
  66. express.static(Path.join(__dirname, '/../../../public'), {
  67. maxAge: STATIC_CACHE_AGE
  68. })
  69. )
  70. app.set('views', Path.join(__dirname, '/../../views'))
  71. app.set('view engine', 'pug')
  72. Modules.loadViewIncludes(app)
  73. app.use(bodyParser.urlencoded({ extended: true, limit: '2mb' }))
  74. app.use(bodyParser.json({ limit: Settings.max_json_request_size }))
  75. app.use(methodOverride())
  76. app.use(bearerToken())
  77. app.use(metrics.http.monitor(logger))
  78. RedirectManager.apply(webRouter)
  79. ProxyManager.apply(publicApiRouter)
  80. webRouter.use(cookieParser(Settings.security.sessionSecret))
  81. SessionAutostartMiddleware.applyInitialMiddleware(webRouter)
  82. webRouter.use(
  83. session({
  84. resave: false,
  85. saveUninitialized: false,
  86. secret: Settings.security.sessionSecret,
  87. proxy: Settings.behindProxy,
  88. cookie: {
  89. domain: Settings.cookieDomain,
  90. maxAge: Settings.cookieSessionLength, // in milliseconds, see https://github.com/expressjs/session#cookiemaxage
  91. secure: Settings.secureCookie,
  92. sameSite: Settings.sameSiteCookie
  93. },
  94. store: sessionStore,
  95. key: Settings.cookieName,
  96. rolling: true
  97. })
  98. )
  99. // patch the session store to generate a validation token for every new session
  100. SessionStoreManager.enableValidationToken(sessionStore)
  101. // use middleware to reject all requests with invalid tokens
  102. webRouter.use(SessionStoreManager.validationMiddleware)
  103. // passport
  104. webRouter.use(passport.initialize())
  105. webRouter.use(passport.session())
  106. passport.use(
  107. new LocalStrategy(
  108. {
  109. passReqToCallback: true,
  110. usernameField: 'email',
  111. passwordField: 'password'
  112. },
  113. AuthenticationController.doPassportLogin
  114. )
  115. )
  116. passport.serializeUser(AuthenticationController.serializeUser)
  117. passport.deserializeUser(AuthenticationController.deserializeUser)
  118. Modules.hooks.fire('passportSetup', passport, function(err) {
  119. if (err != null) {
  120. logger.err({ err }, 'error setting up passport in modules')
  121. }
  122. })
  123. Modules.applyNonCsrfRouter(webRouter, privateApiRouter, publicApiRouter)
  124. webRouter.csrf = new Csrf()
  125. webRouter.use(webRouter.csrf.middleware)
  126. webRouter.use(translations.expressMiddlewear)
  127. webRouter.use(translations.setLangBasedOnDomainMiddlewear)
  128. // Measure expiry from last request, not last login
  129. webRouter.use(function(req, res, next) {
  130. if (!req.session.noSessionCallback) {
  131. req.session.touch()
  132. if (AuthenticationController.isUserLoggedIn(req)) {
  133. UserSessionsManager.touch(
  134. AuthenticationController.getSessionUser(req),
  135. err => {
  136. if (err) {
  137. logger.err({ err }, 'error extending user session')
  138. }
  139. }
  140. )
  141. }
  142. }
  143. next()
  144. })
  145. webRouter.use(ReferalConnect.use)
  146. expressLocals(webRouter, privateApiRouter, publicApiRouter)
  147. webRouter.use(SessionAutostartMiddleware.invokeCallbackMiddleware)
  148. webRouter.use(function(req, res, next) {
  149. if (Settings.siteIsOpen) {
  150. next()
  151. } else if (
  152. AuthenticationController.getSessionUser(req) &&
  153. AuthenticationController.getSessionUser(req).isAdmin
  154. ) {
  155. next()
  156. } else {
  157. res.status(503)
  158. res.render('general/closed', { title: 'maintenance' })
  159. }
  160. })
  161. webRouter.use(function(req, res, next) {
  162. if (Settings.editorIsOpen) {
  163. next()
  164. } else if (req.url.indexOf('/admin') === 0) {
  165. next()
  166. } else {
  167. res.status(503)
  168. res.render('general/closed', { title: 'maintenance' })
  169. }
  170. })
  171. // add security headers using Helmet
  172. webRouter.use(function(req, res, next) {
  173. const isLoggedIn = AuthenticationController.isUserLoggedIn(req)
  174. const isProjectPage = !!req.path.match('^/project/[a-f0-9]{24}$')
  175. helmet({
  176. // note that more headers are added by default
  177. dnsPrefetchControl: false,
  178. referrerPolicy: { policy: 'origin-when-cross-origin' },
  179. noCache: isLoggedIn || isProjectPage,
  180. hsts: false
  181. })(req, res, next)
  182. })
  183. logger.info('creating HTTP server'.yellow)
  184. const server = require('http').createServer(app)
  185. // provide settings for separate web and api processes
  186. // if enableApiRouter and enableWebRouter are not defined they default
  187. // to true.
  188. const notDefined = x => x == null
  189. const enableApiRouter =
  190. Settings.web != null ? Settings.web.enableApiRouter : undefined
  191. if (enableApiRouter || notDefined(enableApiRouter)) {
  192. logger.info('providing api router')
  193. app.use(privateApiRouter)
  194. app.use(Validation.errorMiddleware)
  195. app.use(HttpErrorController.handleError)
  196. app.use(ErrorController.handleApiError)
  197. }
  198. const enableWebRouter =
  199. Settings.web != null ? Settings.web.enableWebRouter : undefined
  200. if (enableWebRouter || notDefined(enableWebRouter)) {
  201. logger.info('providing web router')
  202. if (app.get('env') === 'production') {
  203. logger.info('precompiling views for web in production environment')
  204. Views.precompileViews(app)
  205. }
  206. app.use(publicApiRouter) // public API goes with web router for public access
  207. app.use(Validation.errorMiddleware)
  208. app.use(HttpErrorController.handleError)
  209. app.use(ErrorController.handleApiError)
  210. app.use(webRouter)
  211. app.use(Validation.errorMiddleware)
  212. app.use(HttpErrorController.handleError)
  213. app.use(ErrorController.handleError)
  214. }
  215. metrics.injectMetricsRoute(webRouter)
  216. Router.initialize(webRouter, privateApiRouter, publicApiRouter)
  217. module.exports = {
  218. app,
  219. server
  220. }