-
-
Notifications
You must be signed in to change notification settings - Fork 65
/
Session.js
415 lines (381 loc) · 9.41 KB
/
Session.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
'use strict'
/*
* adonis-auth
*
* (c) Harminder Virk <virk@adonisjs.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
const Resetable = require('resetable')
const ms = require('ms')
const uuid = require('uuid')
const GE = require('@adonisjs/generic-exceptions')
const BaseScheme = require('./Base')
const CE = require('../Exceptions')
/**
* This scheme allows to make use of `sessions` to authenticate
* a user.
*
* The authentication is stateful and logged in user `id` is saved inside
* cookies to maintain the state across multiple requests.
*
* @class SessionScheme
* @extends BaseScheme
*/
class SessionScheme extends BaseScheme {
constructor (Config) {
super()
this._cookieOptions = Config.get('session.cookie', {})
this._rememberTokenDuration = new Resetable(0)
}
/**
* Injections via IoC container
*
* @method inject
*
* @return {Array}
*/
static get inject () {
return ['Adonis/Src/Config']
}
/**
* Reference to the value of `sessionKey` inside the config block.
* Defaults to `adonis-auth`
*
* @attribute sessionKey
* @readOnly
* @return {String}
*/
get sessionKey () {
return this._config.sessionKey || 'adonis-auth'
}
/**
* Reference to the value of `rememberMeToken` inside the config block.
* Defaults to `adonis-remember-token`
*
* @attribute rememberTokenKey
* @readOnly
* @return {String}
*/
get rememberTokenKey () {
return this._config.rememberMeToken || 'adonis-remember-token'
}
/**
* Set authentication session on user instance. Remember me cookie
* will be saved if `rememberToken` and `duration` are provided.
*
* @method _setSession
*
* @param {Number|String} primaryKeyValue
* @param {String} [rememberToken]
* @param {Number} [duration]
*
* @returns {void}
*
* @private
*/
_setSession (primaryKeyValue, rememberToken, duration) {
this._ctx.session.put(this.sessionKey, primaryKeyValue)
/**
* Set remember me cookie when token and duration is
* defined
*/
if (rememberToken && duration) {
this._ctx.response.cookie(this.rememberTokenKey, rememberToken, Object.assign(this._cookieOptions, {
expires: new Date(Date.now() + duration)
}))
}
}
/**
* Removes the login session and remember me cookie.
*
* @method _removeSession
*
* @return {void}
*
* @private
*/
_removeSession () {
this._ctx.session.forget(this.sessionKey)
this._ctx.response.clearCookie(this.rememberTokenKey)
}
/**
* Instruct login API to remember the user for a given
* duration. Defaults to `5years`.
*
* This method must be called before `login`, `loginViaId` or
* `attempt` method.
*
* @method remember
*
* @param {String|Number} [duration = 5y]
*
* @chainable
*
* @example
* ```js
* await auth.remember(true).login()
*
* // custom durating
* await auth.remember('2y').login()
* ```
*/
remember (duration) {
if (duration === true || duration === 1) {
this._rememberTokenDuration.set(ms('5y'))
} else if (typeof (duration) === 'string') {
this._rememberTokenDuration.set(ms(duration))
} else if (duration !== 0 && duration !== false) {
this._rememberTokenDuration.set(duration)
}
return this
}
/**
* Attempt to login the user using `username` and `password`. An
* exception will be raised when unable to find the user or
* if password mis-matches.
*
* @method attempt
* @async
*
* @param {String} uid
* @param {String} password
*
* @return {Object}
*
* @throws {UserNotFoundException} If unable to find user with uid
* @throws {PasswordMisMatchException} If password mismatches
*
* @example
* ```js
* try {
* await auth.attempt(username, password)
* } catch (error) {
* // Invalid credentials
* }
* ```
*/
async attempt (uid, password) {
const user = await this.validate(uid, password, true)
return this.login(user)
}
/**
* Login the user using the user object. An exception will be
* raised if the same user is already logged in.
*
* The exception is raised to improve your code flow, since your code
* should never try to login a same user twice.
*
* @method login
*
* @param {Object} user
* @async
*
* @return {Object}
*
* @example
* ```js
* try {
* await auth.login(user)
* } catch (error) {
* // Unexpected error
* }
* ```
*/
async login (user) {
if (this.user) {
throw GE
.RuntimeException
.invoke('Cannot login multiple users at once, since a user is already logged in', 500, 'E_CANNOT_LOGIN')
}
this.user = user
/**
* Make sure primary key value exists.
*/
if (!this.primaryKeyValue) {
throw GE
.RuntimeException
.invoke('Cannot login user, since user id is not defined', 500, 'E_CANNOT_LOGIN')
}
/**
* Set user remember token when remember token
* duration is defined.
*/
const duration = this._rememberTokenDuration.pull()
const rememberToken = duration ? uuid.v4() : null
if (rememberToken) {
await this._serializerInstance.saveToken(user, rememberToken, 'remember_token')
}
this._setSession(this.primaryKeyValue, rememberToken, duration)
return user
}
/**
* Login a user with their unique id.
*
* @method loginViaId
* @async
*
* @param {Number|String} id
*
* @return {Object}
*
* @throws {UserNotFoundException} If unable to find user with id
*
* @example
* ```js
* try {
* await auth.loginViaId(1)
* } catch (error) {
* // Unexpected error
* }
* ```
*/
async loginViaId (id) {
const user = await this._serializerInstance.findById(id)
if (!user) {
throw this.missingUserFor(id, this.primaryKey)
}
return this.login(user)
}
/**
* Logout a user by removing the required cookies. Also remember
* me token will be deleted from the tokens table.
*
* @method logout
* @async
*
* @return {void}
*
* @example
* ```js
* await auth.logout()
* ```
*/
async logout () {
if (this.user) {
const rememberMeToken = this._ctx.request.cookie(this.rememberTokenKey)
if (rememberMeToken) {
await this._serializerInstance.deleteTokens(this.user, [rememberMeToken])
}
this.user = null
}
this._removeSession()
}
/**
* Check whether the user is logged in or not. If the user session
* has been expired, but a valid `rememberMe` token exists, this
* method will re-login the user.
*
* @method check
* @async
*
* @return {Boolean}
*
* @throws {InvalidSessionException} If session is not valid anymore
*
* @example
* ```js
* try {
* await auth.check()
* } catch (error) {
* // user is not logged
* }
* ```
*/
async check () {
if (this.user) {
return true
}
const sessionValue = this._ctx.session.get(this.sessionKey)
const rememberMeToken = this._ctx.request.cookie(this.rememberTokenKey)
/**
* Look for user only when there is a session
* cookie
*/
if (sessionValue) {
this.user = await this._serializerInstance.findById(sessionValue)
}
/**
* If got user then return
*/
if (this.user) {
return true
}
/**
* Attempt to login the user when remeber me
* token exists
*/
if (rememberMeToken) {
const user = await this._serializerInstance.findByToken(rememberMeToken, 'remember_token')
if (user) {
await this.login(user)
return true
}
}
throw CE.InvalidSessionException.invoke()
}
/**
* Same as {{#crossLink "SessionScheme/check:method"}}{{/crossLink}},
* but doesn't throw any exceptions. This method is useful for
* routes, where login is optional.
*
* @method loginIfCan
* @async
*
* @return {Boolean}
*
* @example
* ```js
* await auth.loginIfCan()
* ```
*/
async loginIfCan () {
if (this.user) {
return true
}
/**
* Don't do anything when there is no session
*/
const sessionValue = this._ctx.session.get(this.sessionKey)
const rememberMeToken = this._ctx.request.cookie(this.rememberTokenKey)
/**
* Don't attempt for anything when there is no session
* value and no remember token
*/
if (!sessionValue && !rememberMeToken) {
return false
}
try {
return await this.check()
} catch (error) {
return false
}
}
/**
* Login a user as a client. This is required when
* you want to set the session on a request that
* will reach the Adonis server.
*
* Adonis testing engine uses this method.
*
* @method clientLogin
* @async
*
* @param {Function} headerFn - Method to set the header
* @param {Function} sessionFn - Method to set the session
* @param {Object} user - User to login
*
* @return {void}
*/
clientLogin (headerFn, sessionFn, user) {
if (!user[this.primaryKey]) {
throw new Error(`Cannot login user, since value for ${this.primaryKey} is missing`)
}
/**
* Call the client method to set the session
*/
sessionFn(this.sessionKey, user[this.primaryKey])
}
}
module.exports = SessionScheme