| 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 |
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
48x
48x
48x
48x
6x
6x
2x
4x
4x
1x
3x
3x
3x
9x
9x
9x
1x
8x
1x
7x
1x
6x
1x
5x
1x
4x
12x
12x
1x
11x
1x
10x
10x
1x
9x
9x
1x
8x
1x
7x
1x
6x
1x
5x
1x
4x
1x
3x
1x
2x
6x
6x
6x
6x
6x
6x
6x
6x
3x
3x
8x
8x
8x
8x
2x
6x
3x
2x
1x
2x
2x
2x
2x
2x
1x
4x
4x
3x
1x
4x
4x
4x
4x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
2x
4x
4x
3x
1x
1x
| 'use strict'
/**
* Dependencies
* @ignore
*/
const BaseRequest = require('./BaseRequest')
const AccessToken = require('../AccessToken')
const AuthorizationCode = require('../AuthorizationCode')
const IDToken = require('../IDToken')
const { JWT } = require('@trust/jose')
/**
* AuthenticationRequest
*/
class AuthenticationRequest extends BaseRequest {
/**
* Request Handler
*
* @param {HTTPRequest} req
* @param {HTTPResponse} res
* @param {Provider} provider
*/
static handle (req, res, provider) {
let {host} = provider
let request = new AuthenticationRequest(req, res, provider)
return Promise
.resolve(request)
.then(request => request.decodeRequestParam(request))
.then(request.validate)
.then(host.authenticate)
.then(host.obtainConsent)
.then(request.authorize)
.catch(err => request.error(err))
}
/**
* Constructor
*
* @param {HTTPRequest} req
* @param {HTTPResponse} res
* @param {Provider} provider
*/
constructor (req, res, provider) {
super(req, res, provider)
this.params = AuthenticationRequest.getParams(this)
this.responseTypes = AuthenticationRequest.getResponseTypes(this)
this.responseMode = AuthenticationRequest.getResponseMode(this)
}
/**
* decodeRequestParam
*
* @description
* Decodes, validates and loads a Request Object (passed by value)
*
* @see https://openid.net/specs/openid-connect-core-1_0.html#RequestObject
*
* @param request {AuthenticationRequest}
*
* @returns {Promise<AuthenticationRequest>}
*/
decodeRequestParam (request) {
let { params } = request
if (!params['request']) {
return Promise.resolve(request) // Pass through, no request param present
}
return Promise.resolve()
.then(() => JWT.decode(params['request']))
.catch(err => {
request.redirect({
error: 'invalid_request_object',
error_description: err.message,
})
})
.then(requestJwt => request.validateRequestParam(requestJwt))
.then(requestJwt => {
this.params = Object.assign({}, params, requestJwt.payload)
})
.then(() => request)
}
/**
* validateRequestParam
*
* @description
* Validates the Request Object jwt (passed by value)
*
* @param jwt {JWT} Decoded request object
*
* @returns {Promise<JWT>} Resolves with the decoded request jwt
*/
validateRequestParam (jwt) {
let { params } = this
return Promise.resolve()
.then(() => {
// request and request_uri parameters MUST NOT be included in Request Objects
if (jwt.request) {
return this.redirect({
error: 'invalid_request_object',
error_description: 'Illegal request claim in payload'
})
}
if (jwt.request_uri) {
return this.redirect({
error: 'invalid_request_object',
error_description: 'Illegal request_uri claim in payload'
})
}
})
// TODO:
// Should an OP not support the request_parameter_supported parameter
// and an RP uses it, the OP MUST return the request_not_supported error.
.then(() => {
// So that the request is a valid OAuth 2.0 Authorization Request, values
// for the response_type and client_id parameters MUST be included using
// the OAuth 2.0 request syntax, since they are REQUIRED by OAuth 2.0.
// The values for these parameters MUST match those in the Request Object,
// if present.
if (jwt.client_id && jwt.client_id !== params.client_id) {
return this.forbidden({
error: 'unauthorized_client',
error_description: 'Mismatching client id in request object'
})
}
if (jwt.response_type && jwt.response_type !== params.response_type) {
return this.redirect({
error: 'invalid_request',
error_description: 'Mismatching response type in request object',
})
}
// Even if a scope parameter is present in the Request Object value, a scope
// parameter MUST always be passed using the OAuth 2.0 request syntax
// containing the openid scope value to indicate to the underlying OAuth 2.0
// logic that this is an OpenID Connect request.
if (jwt.scope && jwt.scope !== params.scope) {
return this.redirect({
error: 'invalid_scope',
error_description: 'Mismatching scope in request object',
})
}
})
// TODO:
// For Signature Validation, the alg Header Parameter in the JOSE Header
// MUST match the value of the request_object_signing_alg set during Client
// Registration or a value that was pre-registered by
// other means. The signature MUST be validated against the appropriate key
// for that client_id and algorithm.
.then(() => jwt)
}
/**
* Validate Request
*
* @param {AuthenticationRequest} request
* @returns {Promise}
*/
validate (request) {
let { params, provider } = request
// CLIENT ID IS REQUIRED
if (!params.client_id) {
return request.forbidden({
error: 'unauthorized_client',
error_description: 'Missing client id'
})
}
// REDIRECT URI IS REQUIRED
if (!params.redirect_uri) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Missing redirect uri',
})
}
// RETURN A PROMISE WHICH WILL BE RESOLVED
// IF THE REQUEST IS VALID. ALL ERROR CONDITIONS
// SHOULD BE HANDLED HERE (WITH AN ERROR RESPONSE),
// SO THERE'S NOTHING TO CATCH.
return provider.backend.get('clients', params.client_id)
.then(client => {
// UNKNOWN CLIENT
if (!client) {
return request.unauthorized({
error: 'unauthorized_client',
error_description: 'Unknown client'
})
}
// ADD CLIENT TO REQUEST
request.client = client
// REDIRECT_URI MUST MATCH
if (!client.redirect_uris.includes(params.redirect_uri)) {
return request.badRequest({
error: 'invalid_request',
error_description: 'Mismatching redirect uri'
})
}
// RESPONSE TYPE IS REQUIRED
if (!params.response_type) {
return request.redirect({
error: 'invalid_request',
error_description: 'Missing response type',
})
}
// SCOPE IS REQUIRED
if (!params.scope) {
return request.redirect({
error: 'invalid_scope',
error_description: 'Missing scope',
})
}
// OPENID SCOPE IS REQUIRED
if (!params.scope.includes('openid')) {
return request.redirect({
error: 'invalid_scope',
error_description: 'Missing openid scope'
})
}
// NONCE MAY BE REQUIRED
if (!request.requiredNonceProvided()) {
return request.redirect({
error: 'invalid_request',
error_description: 'Missing nonce'
})
}
// RESPONSE TYPE MUST BE SUPPORTED
// TODO is this something the client can configure too?
if (!request.supportedResponseType()) {
return request.redirect({
error: 'unsupported_response_type',
error_description: 'Unsupported response type'
})
}
// RESPONSE MODE MUST BE SUPPORTED
// TODO is this something the client can configure too?
if (!request.supportedResponseMode()) {
return request.redirect({
error: 'unsupported_response_mode',
error_description: 'Unsupported response mode'
})
}
// VALID REQUEST
return request
})
}
/**
* Supported Response Type
*
* @returns {bool}
*/
supportedResponseType () {
let {params, provider} = this
let supportedResponseTypes = provider.response_types_supported
let requestedResponseType = params.response_type
// TODO
// verify that the requested response types are permitted
// by client registration
//
// let registeredResponseTypes = client.response_types
return supportedResponseTypes.includes(requestedResponseType)
}
/**
* Supported Response Mode
*
* @returns {bool}
*/
supportedResponseMode () {
let {params, provider} = this
let supportedResponseModes = provider.response_modes_supported
let requestedResponseMode = params.response_mode
if (!requestedResponseMode) {
return true
} else {
return supportedResponseModes.indexOf(requestedResponseMode) !== -1
}
}
/**
* Required Nonce Provided
*
* @returns {bool}
*/
requiredNonceProvided () {
let {params} = this
let {nonce, response_type: responseType} = params
let requiring = ['id_token', 'token']
if (!nonce && requiring.some(type => responseType.indexOf(type) !== -1)) {
return false
} else {
return true
}
}
/**
* Authorize
*
* @param {AuthenticationRequest} request
* @returns {Promise}
*/
authorize (request) {
if (request.consent === true) {
return request.allow(request)
} else {
return request.deny(request)
}
}
/**
* Allow
*
* Given a completely validated request with an authenticated user and
* consent, build a response incorporating auth code, tokens, and session
* state.
*/
allow (request) {
return Promise.resolve({}) // initialize empty response
.then(response => request.includeAccessToken(response))
.then(response => request.includeAuthorizationCode(response))
.then(response => request.includeIDToken(response))
//.then(this.includeSessionState.bind(this))
.then(response => request.redirect(response))
// do some error handling here
}
/**
* Deny
*
* Handle user's rejection of the client.
*/
deny (request) {
this.redirect({
error: 'access_denied'
})
}
/**
* Include Access Token
*
* @returns {Promise}
*/
includeAccessToken (response) {
let {responseTypes} = this
if (responseTypes.includes('token')) {
return AccessToken.issueForRequest(this, response)
}
return Promise.resolve(response)
}
/**
* Include Authorization Code
*
* @returns {Promise}
*/
includeAuthorizationCode (response) {
let {responseTypes, params, scope} = this
let {provider, client, subject} = this
let {backend} = provider
if (responseTypes.includes('code')) {
let code = this.random(16)
let sub = subject['_id']
let aud = client['client_id']
let iat = Math.floor(Date.now() / 1000)
let exp = iat + 600
let max = params['max_age'] || client['default_max_age']
let nonce = params['nonce']
let redirect_uri = params['redirect_uri']
let ac = new AuthorizationCode({
code, sub, aud, exp, max, scope, nonce, redirect_uri
})
return backend.put('codes', code, ac)
.then(() => {
response['code'] = code
return response
})
}
return Promise.resolve(response)
}
/**
* Include ID Token
*
* @returns {Promise}
*/
includeIDToken (response) {
let {responseTypes} = this
if (responseTypes.includes('id_token')) {
return IDToken.issueForRequest(this, response)
}
return Promise.resolve(response)
}
/**
* Include Session State
*/
includeSessionState (response) {
// ...
}
}
/**
* Export
*/
module.exports = AuthenticationRequest
|