Server.js 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  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 crawlerLogger = require('./CrawlerLogger')
  7. const expressLocals = require('./ExpressLocals')
  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 session = require('express-session')
  14. const RedisStore = require('connect-redis')(session)
  15. const bodyParser = require('body-parser')
  16. const methodOverride = require('method-override')
  17. const cookieParser = require('cookie-parser')
  18. const bearerToken = require('express-bearer-token')
  19. const passport = require('passport')
  20. const LocalStrategy = require('passport-local').Strategy
  21. const oneDayInMilliseconds = 86400000
  22. const ReferalConnect = require('../Features/Referal/ReferalConnect')
  23. const RedirectManager = require('./RedirectManager')
  24. const ProxyManager = require('./ProxyManager')
  25. const translations = require('translations-sharelatex').setup(Settings.i18n)
  26. const Modules = require('./Modules')
  27. const ErrorController = require('../Features/Errors/ErrorController')
  28. const HttpErrorController = require('../Features/Errors/HttpErrorController')
  29. const UserSessionsManager = require('../Features/User/UserSessionsManager')
  30. const AuthenticationController = require('../Features/Authentication/AuthenticationController')
  31. const STATIC_CACHE_AGE = Settings.cacheStaticAssets
  32. ? oneDayInMilliseconds * 365
  33. : 0
  34. // Init the session store
  35. const sessionStore = new RedisStore({ client: sessionsRedisClient })
  36. if (metrics.event_loop != null) {
  37. metrics.event_loop.monitor(logger)
  38. }
  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. // Make sure we can process twice the max doc length, to allow for
  75. // - the doc content
  76. // - text ranges spanning the whole doc
  77. // Also allow some overhead for JSON encoding
  78. app.use(bodyParser.json({ limit: 2 * Settings.max_doc_length + 64 * 1024 })) // 64kb overhead
  79. app.use(methodOverride())
  80. app.use(bearerToken())
  81. app.use(metrics.http.monitor(logger))
  82. RedirectManager.apply(webRouter)
  83. ProxyManager.apply(publicApiRouter)
  84. webRouter.use(cookieParser(Settings.security.sessionSecret))
  85. webRouter.use(
  86. session({
  87. resave: false,
  88. saveUninitialized: false,
  89. secret: Settings.security.sessionSecret,
  90. proxy: Settings.behindProxy,
  91. cookie: {
  92. domain: Settings.cookieDomain,
  93. maxAge: Settings.cookieSessionLength, // in milliseconds, see https://github.com/expressjs/session#cookiemaxage
  94. secure: Settings.secureCookie
  95. },
  96. store: sessionStore,
  97. key: Settings.cookieName,
  98. rolling: true
  99. })
  100. )
  101. // passport
  102. webRouter.use(passport.initialize())
  103. webRouter.use(passport.session())
  104. passport.use(
  105. new LocalStrategy(
  106. {
  107. passReqToCallback: true,
  108. usernameField: 'email',
  109. passwordField: 'password'
  110. },
  111. AuthenticationController.doPassportLogin
  112. )
  113. )
  114. passport.serializeUser(AuthenticationController.serializeUser)
  115. passport.deserializeUser(AuthenticationController.deserializeUser)
  116. Modules.hooks.fire('passportSetup', passport, function(err) {
  117. if (err != null) {
  118. logger.err({ err }, 'error setting up passport in modules')
  119. }
  120. })
  121. Modules.applyNonCsrfRouter(webRouter, privateApiRouter, publicApiRouter)
  122. webRouter.csrf = new Csrf()
  123. webRouter.use(webRouter.csrf.middleware)
  124. webRouter.use(translations.expressMiddlewear)
  125. webRouter.use(translations.setLangBasedOnDomainMiddlewear)
  126. // Measure expiry from last request, not last login
  127. webRouter.use(function(req, res, next) {
  128. req.session.touch()
  129. if (AuthenticationController.isUserLoggedIn(req)) {
  130. UserSessionsManager.touch(
  131. AuthenticationController.getSessionUser(req),
  132. err => {
  133. if (err) {
  134. logger.err({ err }, 'error extending user session')
  135. }
  136. }
  137. )
  138. }
  139. next()
  140. })
  141. webRouter.use(ReferalConnect.use)
  142. expressLocals(app, webRouter, privateApiRouter, publicApiRouter)
  143. if (app.get('env') === 'production') {
  144. logger.info('Production Enviroment')
  145. app.enable('view cache')
  146. }
  147. app.use(function(req, res, next) {
  148. metrics.inc('http-request')
  149. crawlerLogger.log(req)
  150. next()
  151. })
  152. webRouter.use(function(req, res, next) {
  153. if (Settings.siteIsOpen) {
  154. next()
  155. } else {
  156. res.status(503)
  157. res.render('general/closed', { title: 'maintenance' })
  158. }
  159. })
  160. webRouter.use(function(req, res, next) {
  161. if (Settings.editorIsOpen) {
  162. next()
  163. } else if (req.url.indexOf('/admin') === 0) {
  164. next()
  165. } else {
  166. res.status(503)
  167. res.render('general/closed', { title: 'maintenance' })
  168. }
  169. })
  170. // add security headers using Helmet
  171. webRouter.use(function(req, res, next) {
  172. const isLoggedIn = AuthenticationController.isUserLoggedIn(req)
  173. const isProjectPage = !!req.path.match('^/project/[a-f0-9]{24}$')
  174. helmet({
  175. // note that more headers are added by default
  176. dnsPrefetchControl: false,
  177. referrerPolicy: { policy: 'origin-when-cross-origin' },
  178. noCache: isLoggedIn || isProjectPage,
  179. hsts: false
  180. })(req, res, next)
  181. })
  182. const profiler = require('v8-profiler-node8')
  183. privateApiRouter.get('/profile', function(req, res) {
  184. const time = parseInt(req.query.time || '1000')
  185. profiler.startProfiling('test')
  186. setTimeout(function() {
  187. const profile = profiler.stopProfiling('test')
  188. res.json(profile)
  189. }, time)
  190. })
  191. privateApiRouter.get('/heapdump', (req, res, next) =>
  192. require('heapdump').writeSnapshot(
  193. `/tmp/${Date.now()}.web.heapsnapshot`,
  194. (err, filename) => {
  195. if (err != null) {
  196. return next(err)
  197. }
  198. res.send(filename)
  199. }
  200. )
  201. )
  202. logger.info('creating HTTP server'.yellow)
  203. const server = require('http').createServer(app)
  204. // provide settings for separate web and api processes
  205. // if enableApiRouter and enableWebRouter are not defined they default
  206. // to true.
  207. const notDefined = x => x == null
  208. const enableApiRouter =
  209. Settings.web != null ? Settings.web.enableApiRouter : undefined
  210. if (enableApiRouter || notDefined(enableApiRouter)) {
  211. logger.info('providing api router')
  212. app.use(privateApiRouter)
  213. app.use(HttpErrorController.handleError)
  214. app.use(ErrorController.handleApiError)
  215. }
  216. const enableWebRouter =
  217. Settings.web != null ? Settings.web.enableWebRouter : undefined
  218. if (enableWebRouter || notDefined(enableWebRouter)) {
  219. logger.info('providing web router')
  220. app.use(publicApiRouter) // public API goes with web router for public access
  221. app.use(HttpErrorController.handleError)
  222. app.use(ErrorController.handleApiError)
  223. app.use(webRouter)
  224. app.use(HttpErrorController.handleError)
  225. app.use(ErrorController.handleError)
  226. }
  227. metrics.injectMetricsRoute(webRouter)
  228. Router.initialize(webRouter, privateApiRouter, publicApiRouter)
  229. module.exports = {
  230. app,
  231. server
  232. }