| 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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526 |
1x
1x
1x
1x
48x
48x
48x
49x
49x
6x
6x
1x
5x
1x
4x
1x
3x
1x
2x
1x
1x
7x
7x
7x
7x
9x
9x
3x
9x
3x
1x
2x
8x
5x
5x
2x
3x
1x
2x
1x
1x
4x
1x
3x
6x
6x
6x
6x
6x
6x
1x
5x
1x
4x
1x
3x
3x
1x
2x
1x
1x
1x
5x
5x
2x
3x
3x
3x
1x
2x
1x
1x
4x
4x
1x
3x
1x
2x
1x
1x
3x
3x
3x
3x
1x
1x
3x
3x
3x
3x
3x
3x
3x
1x
3x
7x
7x
6x
6x
1x
5x
1x
4x
1x
3x
1x
2x
1x
1x
1x
1x
1x
| 'use strict'
/**
* Dependencies
* @ignore
*/
const BaseRequest = require('./BaseRequest')
const AccessToken = require('../AccessToken')
const AuthorizationCode = require('../AuthorizationCode')
const IDToken = require('../IDToken')
/**
* TokenRequest
*/
class TokenRequest extends BaseRequest {
/**
* Request Handler
*
* @param {HTTPRequest} req
* @param {HTTPResponse} res
* @param {Provider} provider
*/
static handle (req, res, provider) {
let request = new TokenRequest(req, res, provider)
Promise
.resolve(request)
.then(request.validate)
.then(request.authenticateClient)
.then(request.verifyAuthorizationCode)
.then(request.grant)
.catch(err => request.error(err))
}
/**
* Constructor
*/
constructor (req, res, provider) {
super(req, res, provider)
this.params = TokenRequest.getParams(this)
this.grantType = TokenRequest.getGrantType(this)
}
/**
* Get Grant Type
*
* @param {TokenRequest} request
* @return {string}
*/
static getGrantType (request) {
let {params} = request
return params.grant_type
}
/**
* Validate Request
*
* @param request {TokenRequest}
* @returns {Promise<TokenRequest>}
*/
validate (request) {
let {params} = request
// MISSING GRANT TYPE
if (!params.grant_type) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Missing grant type'
})
}
// UNSUPPORTED GRANT TYPE
if (!request.supportedGrantType()) {
return request.badRequest({
error: 'unsupported_grant_type',
error_description: 'Unsupported grant type'
})
}
// MISSING AUTHORIZATION CODE
if (params.grant_type === 'authorization_code' && !params.code) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Missing authorization code'
})
}
// MISSING REDIRECT URI
if (params.grant_type === 'authorization_code' && !params.redirect_uri) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Missing redirect uri'
})
}
// MISSING REFRESH TOKEN
if (params.grant_type === 'refresh_token' && !params.refresh_token) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Missing refresh token'
})
}
return Promise.resolve(request)
}
/**
* Supported Grant Type
* @returns {Boolean}
*/
supportedGrantType () {
let {params,provider} = this
let supportedGrantTypes = provider.grant_types_supported
let requestedGrantType = params.grant_type
return supportedGrantTypes.includes(requestedGrantType)
}
/**
* Authenticate Client
*
* @param request {TokenRequest}
* @returns {Promise<TokenRequest>}
*/
authenticateClient (request) {
let method
let {req} = request
// Use HTTP Basic Authentication Method
if (req.headers && req.headers.authorization) {
method = 'clientSecretBasic'
}
// Use HTTP Post Authentication Method
if (req.body && req.body.client_secret) {
// Fail if multiple authentication methods are attempted
if (method) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Must use only one authentication method'
})
}
method = 'clientSecretPost'
}
// Use Client JWT Authentication Method
if (req.body && req.body.client_assertion_type) {
var type = 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer'
// Fail if multiple authentication methods are attempted
if (method) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Must use only one authentication method'
})
}
// Invalid client assertion type
if (req.body.client_assertion_type !== type) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Invalid client assertion type'
})
}
// Missing client assertion
if (!req.body.client_assertion) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Missing client assertion'
})
}
method = 'clientSecretJWT'
}
// Missing authentication parameters
if (!method) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Missing client credentials'
})
}
// Apply the appropriate authentication method
return request[method](request)
}
/**
* Client Secret Basic Authentication
*
* @description
* HTTP Basic Authentication of client using client_id and client_secret as
* username and password.
* @param {TokenRequest} request
* @returns {Promise<TokenRequest>}
*/
clientSecretBasic (request) {
let {req:{headers},provider} = request
let authorization = headers.authorization.split(' ')
let scheme = authorization[0]
let credentials = new Buffer(authorization[1], 'base64')
.toString('ascii')
.split(':')
let [id, secret] = credentials
// MALFORMED CREDENTIALS
if (credentials.length !== 2) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Malformed HTTP Basic credentials'
})
}
// INVALID AUTHORIZATION SCHEME
if (!/^Basic$/i.test(scheme)) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Invalid authorization scheme'
})
}
// MISSING CREDENTIALS
if (!id || !secret) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Missing client credentials'
})
}
return provider.backend.get('clients', id).then(client => {
// UNKNOWN CLIENT
if (!client) {
return request.unauthorized({
error: 'unauthorized_client',
error_description: 'Unknown client identifier'
})
}
// MISMATCHING SECRET
if (client.client_secret !== secret) {
return request.unauthorized({
error: 'unauthorized_client',
error_description: 'Mismatching client secret'
})
}
request.client = client
return request
})
}
/**
* Client Secret Post
*
* @description
* Authentication of client using client_id and client_secret as HTTP POST
* body parameters.
* @param {TokenRequest} request
* @returns {Promise<TokenRequest>}
*/
clientSecretPost (request) {
let {params: {client_id: id, client_secret: secret}, provider} = request
// MISSING CREDENTIALS
if (!id || !secret) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Missing client credentials'
})
}
return new Promise((resolve, reject) => {
provider.backend.get(id).then(client => {
// UNKNOWN CLIENT
if (!client) {
return request.unauthorized({
error: 'unauthorized_client',
error_description: 'Unknown client identifier'
})
}
// MISMATCHING SECRET
if (client.client_secret !== secret) {
return request.unauthorized({
error: 'unauthorized_client',
error_description: 'Mismatching client secret'
})
}
resolve(request)
})
})
}
/**
* Client Secret JWT Authentication
*
* TODO RTFS
* @param request {TokenRequest}
* @returns {Promise<TokenRequest>}
*/
clientSecretJWT (request) {
let { req: { body: { client_assertion: jwt } }, provider} = request
let payloadB64u = jwt.split('.')[1]
let payload = JSON.parse(base64url.decode(payloadB64u))
if (!payload || !payload.sub) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Cannot extract client id from JWT'
})
}
return provider.backend.get('clients', payload.sub)
.then(client => {
if (!client) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Unknown client'
})
}
if (!client.client_secret) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Missing client secret'
})
}
let token = JWT.decode(jwt, client.client_secret)
if (!token || token instanceof Error) {
return request.badRequest({
error: 'unauthorized_client',
error_description: 'Invalid client JWT'
})
}
// TODO validate the payload
return request
})
}
/**
* Private Key JWT Authentication
*/
// privateKeyJWT () {}
/**
* None Authentication
*/
// none () {}
/**
* Grant
*
* @param {TokenRequest} request
* @returns {Promise<Null>}
*/
grant (request) {
let {grantType} = request
if (grantType === 'authorization_code') {
return request.authorizationCodeGrant(request)
}
if (grantType === 'refresh_token') {
return request.refreshTokenGrant(request)
}
if (grantType === 'client_credentials') {
return request.clientCredentialsGrant(request)
}
// THIS IS SERIOUS TROUBLE
// REQUEST VALIDATION SHOULD FILTER OUT
// UNSUPPORTED GRANT TYPES BEFORE WE ARRIVE
// HERE.
throw new Error('Unsupported response type')
}
/**
* Authorization Code Grant
*
* @param {TokenRequest} request
* @returns {Promise<Null>}
*/
authorizationCodeGrant (request) {
return Promise.resolve({})
.then(response => request.includeAccessToken(response))
.then(response => request.includeIDToken(response))
.then(response => {
request.res.json(response)
})
}
/**
* includeAccessToken
*/
includeAccessToken (response) {
return AccessToken.issueForRequest(this, response)
}
/**
* includeIDToken
*/
includeIDToken (response) {
return IDToken.issueForRequest(this, response)
}
/**
* Refresh Grant
*
* @param {TokenRequest} request
* @returns {Promise<Object>} Resolves to response object
*/
refreshTokenGrant (request) {
// TODO: I don't think this.tokenResponse is implemented..
return AccessToken.refresh(request).then(this.tokenResponse)
}
/**
* OAuth 2.0 Client Credentials Grant
*
* @param {TokenRequest} request
* @returns {Promise<Null>}
*/
clientCredentialsGrant (request) {
let {res, client: { default_max_age: expires } } = request
return AccessToken.issueForRequest(request, res).then(token => {
let response = {}
res.set({
'Cache-Control': 'no-store',
'Pragma': 'no-cache'
})
response.access_token = token
response.token_type = 'Bearer'
if (expires) {
response.expires_in = expires
}
res.json(response)
})
}
/**
* Verify Authorization Code
* @param request {TokenRequest}
* @returns {TokenRequest}
*/
verifyAuthorizationCode (request) {
let {params, client, provider, grantType} = request
if (grantType === 'authorization_code') {
return provider.backend.get('codes', params.code).then(authorizationCode => {
// UNKNOWN AUTHORIZATION CODE
if (!authorizationCode) {
return request.badRequest({
error: 'invalid_grant',
error_description: 'Authorization not found'
})
}
// AUTHORIZATION CODE HAS BEEN PREVIOUSLY USED
if (authorizationCode.used === true) {
return request.badRequest({
error: 'invalid_grant',
error_description: 'Authorization code invalid'
})
}
// AUTHORIZATION CODE IS EXPIRED
if (authorizationCode.exp < Math.floor(Date.now() / 1000)) {
return request.badRequest({
error: 'invalid_grant',
error_description: 'Authorization code expired'
})
}
// MISMATCHING REDIRECT URI
if (authorizationCode.redirect_uri !== params.redirect_uri) {
return request.badRequest({
error: 'invalid_grant',
error_description: 'Mismatching redirect uri'
})
}
// MISMATCHING CLIENT ID
if (authorizationCode.aud !== client.client_id) {
return request.badRequest({
error: 'invalid_grant',
error_description: 'Mismatching client id'
})
}
// TODO mismatching user id?
request.code = authorizationCode
// TODO UPDATE AUTHORIZATION CODE TO REFLECT THAT IT'S BEEN USED
//authorizationCode.use().then(() => Promise.resolve(request))
return request
})
}
return Promise.resolve(request)
}
}
/**
* Export
*/
module.exports = TokenRequest
|