UserSessionsManager.js 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. const OError = require('@overleaf/o-error')
  2. const Settings = require('@overleaf/settings')
  3. const logger = require('@overleaf/logger')
  4. const Async = require('async')
  5. const _ = require('underscore')
  6. const { promisify } = require('util')
  7. const UserSessionsRedis = require('./UserSessionsRedis')
  8. const rclient = UserSessionsRedis.client()
  9. const UserSessionsManager = {
  10. // mimic the key used by the express sessions
  11. _sessionKey(sessionId) {
  12. return `sess:${sessionId}`
  13. },
  14. trackSession(user, sessionId, callback) {
  15. if (!user) {
  16. return callback(null)
  17. }
  18. if (!sessionId) {
  19. return callback(null)
  20. }
  21. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  22. const value = UserSessionsManager._sessionKey(sessionId)
  23. rclient
  24. .multi()
  25. .sadd(sessionSetKey, value)
  26. .pexpire(sessionSetKey, `${Settings.cookieSessionLength}`) // in milliseconds
  27. .exec(function (err, response) {
  28. if (err) {
  29. OError.tag(
  30. err,
  31. 'error while adding session key to UserSessions set',
  32. {
  33. user_id: user._id,
  34. sessionSetKey,
  35. }
  36. )
  37. return callback(err)
  38. }
  39. UserSessionsManager._checkSessions(user, function () {})
  40. callback()
  41. })
  42. },
  43. untrackSession(user, sessionId, callback) {
  44. if (!callback) {
  45. callback = function () {}
  46. }
  47. if (!user) {
  48. return callback(null)
  49. }
  50. if (!sessionId) {
  51. return callback(null)
  52. }
  53. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  54. const value = UserSessionsManager._sessionKey(sessionId)
  55. rclient
  56. .multi()
  57. .srem(sessionSetKey, value)
  58. .pexpire(sessionSetKey, `${Settings.cookieSessionLength}`) // in milliseconds
  59. .exec(function (err, response) {
  60. if (err) {
  61. OError.tag(
  62. err,
  63. 'error while removing session key from UserSessions set',
  64. {
  65. user_id: user._id,
  66. sessionSetKey,
  67. }
  68. )
  69. return callback(err)
  70. }
  71. UserSessionsManager._checkSessions(user, function () {})
  72. callback()
  73. })
  74. },
  75. getAllUserSessions(user, exclude, callback) {
  76. exclude = _.map(exclude, UserSessionsManager._sessionKey)
  77. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  78. rclient.smembers(sessionSetKey, function (err, sessionKeys) {
  79. if (err) {
  80. OError.tag(err, 'error getting all session keys for user from redis', {
  81. user_id: user._id,
  82. })
  83. return callback(err)
  84. }
  85. sessionKeys = _.filter(sessionKeys, k => !_.contains(exclude, k))
  86. if (sessionKeys.length === 0) {
  87. logger.debug(
  88. { user_id: user._id },
  89. 'no other sessions found, returning'
  90. )
  91. return callback(null, [])
  92. }
  93. Async.mapSeries(
  94. sessionKeys,
  95. (k, cb) => rclient.get(k, cb),
  96. function (err, sessions) {
  97. if (err) {
  98. OError.tag(err, 'error getting all sessions for user from redis', {
  99. user_id: user._id,
  100. })
  101. return callback(err)
  102. }
  103. const result = []
  104. for (let session of Array.from(sessions)) {
  105. if (!session) {
  106. continue
  107. }
  108. session = JSON.parse(session)
  109. let sessionUser = session.passport && session.passport.user
  110. if (!sessionUser) {
  111. sessionUser = session.user
  112. }
  113. result.push({
  114. ip_address: sessionUser.ip_address,
  115. session_created: sessionUser.session_created,
  116. })
  117. }
  118. callback(null, result)
  119. }
  120. )
  121. })
  122. },
  123. revokeAllUserSessions(user, retain, callback) {
  124. if (!retain) {
  125. retain = []
  126. }
  127. retain = retain.map(i => UserSessionsManager._sessionKey(i))
  128. if (!user) {
  129. return callback(null)
  130. }
  131. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  132. rclient.smembers(sessionSetKey, function (err, sessionKeys) {
  133. if (err) {
  134. OError.tag(err, 'error getting contents of UserSessions set', {
  135. user_id: user._id,
  136. sessionSetKey,
  137. })
  138. return callback(err)
  139. }
  140. const keysToDelete = _.filter(
  141. sessionKeys,
  142. k => !Array.from(retain).includes(k)
  143. )
  144. if (keysToDelete.length === 0) {
  145. logger.debug(
  146. { user_id: user._id },
  147. 'no sessions in UserSessions set to delete, returning'
  148. )
  149. return callback(null)
  150. }
  151. logger.debug(
  152. { user_id: user._id, count: keysToDelete.length },
  153. 'deleting sessions for user'
  154. )
  155. const deletions = keysToDelete.map(k => cb => rclient.del(k, cb))
  156. Async.series(deletions, function (err, _result) {
  157. if (err) {
  158. OError.tag(err, 'error revoking all sessions for user', {
  159. user_id: user._id,
  160. sessionSetKey,
  161. })
  162. return callback(err)
  163. }
  164. rclient.srem(sessionSetKey, keysToDelete, function (err) {
  165. if (err) {
  166. OError.tag(err, 'error removing session set for user', {
  167. user_id: user._id,
  168. sessionSetKey,
  169. })
  170. return callback(err)
  171. }
  172. callback(null)
  173. })
  174. })
  175. })
  176. },
  177. touch(user, callback) {
  178. if (!user) {
  179. return callback(null)
  180. }
  181. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  182. rclient.pexpire(
  183. sessionSetKey,
  184. `${Settings.cookieSessionLength}`, // in milliseconds
  185. function (err, response) {
  186. if (err) {
  187. OError.tag(err, 'error while updating ttl on UserSessions set', {
  188. user_id: user._id,
  189. })
  190. return callback(err)
  191. }
  192. callback(null)
  193. }
  194. )
  195. },
  196. _checkSessions(user, callback) {
  197. if (!user) {
  198. return callback(null)
  199. }
  200. const sessionSetKey = UserSessionsRedis.sessionSetKey(user)
  201. rclient.smembers(sessionSetKey, function (err, sessionKeys) {
  202. if (err) {
  203. OError.tag(err, 'error getting contents of UserSessions set', {
  204. user_id: user._id,
  205. sessionSetKey,
  206. })
  207. return callback(err)
  208. }
  209. Async.series(
  210. sessionKeys.map(
  211. key => next =>
  212. rclient.get(key, function (err, val) {
  213. if (err) {
  214. return next(err)
  215. }
  216. if (!val) {
  217. rclient.srem(sessionSetKey, key, function (err, result) {
  218. return next(err)
  219. })
  220. } else {
  221. next()
  222. }
  223. })
  224. ),
  225. function (err, results) {
  226. callback(err)
  227. }
  228. )
  229. })
  230. },
  231. }
  232. UserSessionsManager.promises = {
  233. getAllUserSessions: promisify(UserSessionsManager.getAllUserSessions),
  234. revokeAllUserSessions: promisify(UserSessionsManager.revokeAllUserSessions),
  235. }
  236. module.exports = UserSessionsManager