-
-
Notifications
You must be signed in to change notification settings - Fork 299
/
verify.test.mjs
443 lines (390 loc) · 11.9 KB
/
verify.test.mjs
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
import test from 'ava'
import timekeeper from 'timekeeper'
const { SignJWT, jwtVerify, CompactSign } = await import('#dist')
const now = 1604416038
test.before(async (t) => {
t.context.secret = new Uint8Array(32)
t.context.payload = { 'urn:example:claim': true }
timekeeper.freeze(now * 1000)
})
test.after(timekeeper.reset)
test('Basic JWT Claims Set verification', async (t) => {
const issuer = 'urn:example:issuer'
const subject = 'urn:example:subject'
const audience = 'urn:example:audience'
const jti = 'urn:example:jti'
const nbf = now - 10
const iat = now - 20
const exp = now + 10
const typ = 'urn:example:typ'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256', typ })
.setIssuer(issuer)
.setSubject(subject)
.setAudience(audience)
.setJti(jti)
.setNotBefore(nbf)
.setExpirationTime(exp)
.setIssuedAt(iat)
.sign(t.context.secret)
t.deepEqual(
await jwtVerify(jwt, t.context.secret, {
issuer,
subject,
audience,
jti,
typ,
maxTokenAge: '30s',
}),
{
payload: {
aud: 'urn:example:audience',
exp: 1604416048,
iat: 1604416018,
iss: 'urn:example:issuer',
jti: 'urn:example:jti',
nbf: 1604416028,
sub: 'urn:example:subject',
'urn:example:claim': true,
},
protectedHeader: {
alg: 'HS256',
typ: 'urn:example:typ',
},
},
)
await t.notThrowsAsync(jwtVerify(new TextEncoder().encode(jwt), t.context.secret))
})
test('Payload must be an object', async (t) => {
const encode = TextEncoder.prototype.encode.bind(new TextEncoder())
for (const value of [0, 1, -1, true, false, null, [], '']) {
const token = await new CompactSign(encode(JSON.stringify(value)))
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(jwtVerify(token, t.context.secret), {
code: 'ERR_JWT_INVALID',
message: 'JWT Claims Set must be a top-level JSON object',
})
}
})
test('incorrect hmac signature lengths', async (t) => {
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(jwtVerify(jwt.slice(0, -3), t.context.secret), {
code: 'ERR_JWS_SIGNATURE_VERIFICATION_FAILED',
message: 'signature verification failed',
})
})
test('Payload must JSON parseable', async (t) => {
const encode = TextEncoder.prototype.encode.bind(new TextEncoder())
const token = await new CompactSign(encode('{'))
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(jwtVerify(token, t.context.secret), {
code: 'ERR_JWT_INVALID',
message: 'JWT Claims Set must be a top-level JSON object',
})
})
test('algorithms options', async (t) => {
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
algorithms: ['PS256'],
}),
{
code: 'ERR_JOSE_ALG_NOT_ALLOWED',
message: '"alg" (Algorithm) Header Parameter not allowed',
},
)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
algorithms: [null],
}),
{
instanceOf: TypeError,
message: '"algorithms" option must be an array of strings',
},
)
})
test('typ verification', async (t) => {
{
const typ = 'urn:example:typ'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256', typ })
.sign(t.context.secret)
await t.notThrowsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'application/urn:example:typ',
}),
)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'urn:example:typ:2',
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "typ" JWT header value' },
)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'application/urn:example:typ:2',
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "typ" JWT header value' },
)
}
{
const typ = 'application/urn:example:typ'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256', typ })
.sign(t.context.secret)
await t.notThrowsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'urn:example:typ',
}),
)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'application/urn:example:typ:2',
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "typ" JWT header value' },
)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
typ: 'urn:example:typ:2',
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "typ" JWT header value' },
)
}
})
test('Issuer[] verification', async (t) => {
const issuer = 'urn:example:issuer'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setIssuer(issuer)
.sign(t.context.secret)
await t.notThrowsAsync(
jwtVerify(jwt, t.context.secret, {
issuer: [issuer],
}),
)
})
test('Issuer[] verification failed', async (t) => {
const issuer = 'urn:example:issuer'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setIssuer(issuer)
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
issuer: [],
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "iss" claim value' },
)
})
test('Issuer[] verification failed []', async (t) => {
const issuer = 'urn:example:issuer'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setIssuer([issuer])
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
issuer: [],
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "iss" claim value' },
)
})
test('Audience[] verification', async (t) => {
const audience = 'urn:example:audience'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setAudience(audience)
.sign(t.context.secret)
await t.notThrowsAsync(
jwtVerify(jwt, t.context.secret, {
audience: [audience],
}),
)
})
test('Audience[] verification failed', async (t) => {
const audience = 'urn:example:audience'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setAudience(audience)
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
audience: [],
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "aud" claim value' },
)
})
test('Audience[] verification failed []', async (t) => {
const audience = 'urn:example:audience'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setAudience([audience])
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
audience: [],
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "aud" claim value' },
)
})
test('Subject verification failed', async (t) => {
const subject = 'urn:example:subject'
const jwt = await new SignJWT(t.context.payload)
.setProtectedHeader({ alg: 'HS256' })
.setSubject(subject)
.sign(t.context.secret)
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, {
subject: 'urn:example:subject:2',
}),
{ code: 'ERR_JWT_CLAIM_VALIDATION_FAILED', message: 'unexpected "sub" claim value' },
)
})
async function numericDateNumber(t, claim) {
const jwt = await new SignJWT({ [claim]: null })
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(jwtVerify(jwt, t.context.secret), {
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: `"${claim}" claim must be a number`,
})
}
numericDateNumber.title = (t, claim) => `${claim} must be a number`
test('clockTolerance num', async (t) => {
const jwt = await new SignJWT({ exp: now })
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.notThrowsAsync(jwtVerify(jwt, t.context.secret, { clockTolerance: 1 }))
await t.notThrowsAsync(jwtVerify(jwt, t.context.secret, { clockTolerance: '1s' }))
})
async function failingNumericDate(t, claims, assertion, verifyOptions) {
const jwt = await new SignJWT({ ...claims })
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
await t.throwsAsync(jwtVerify(jwt, t.context.secret, { ...verifyOptions }), assertion)
}
test(
'exp must be in the future',
failingNumericDate,
{ exp: now },
{
code: 'ERR_JWT_EXPIRED',
message: '"exp" claim timestamp check failed',
},
)
test(
'nbf must be at least now',
failingNumericDate,
{ nbf: now + 1 },
{
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: '"nbf" claim timestamp check failed',
},
)
test(
'iat must be in the past (maxTokenAge, no exp)',
failingNumericDate,
{ iat: now + 1 },
{
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: '"iat" claim timestamp check failed (it should be in the past)',
},
{
maxTokenAge: 5,
},
)
test(
'iat must be in the past (maxTokenAge, with exp)',
failingNumericDate,
{ iat: now + 1, exp: now + 10 },
{
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: '"iat" claim timestamp check failed (it should be in the past)',
},
{
maxTokenAge: 5,
},
)
test(
'iat must be in the past (maxTokenAge, with exp, as a string)',
failingNumericDate,
{ iat: now + 1, exp: now + 10 },
{
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: '"iat" claim timestamp check failed (it should be in the past)',
},
{
maxTokenAge: '5s',
},
)
test(
'maxTokenAge option',
failingNumericDate,
{ iat: now - 31 },
{
code: 'ERR_JWT_EXPIRED',
message: '"iat" claim timestamp check failed (too far in the past)',
},
{
maxTokenAge: '30s',
},
)
for (const claim of ['iat', 'nbf', 'exp']) {
test(numericDateNumber, claim)
}
test('Signed JWTs cannot use unencoded payload', async (t) => {
await t.throwsAsync(
jwtVerify(
'eyJhbGciOiJIUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19.foo.VklKdp4tVYD61VNPDBTqxqdEQcUL3JK-D4dGXu9NvWs',
t.context.secret,
),
{ code: 'ERR_JWT_INVALID', message: 'JWTs MUST NOT use unencoded payload' },
)
})
test('signatures are compared before claim set', async (t) => {
// https://github.com/panva/jose/discussions/447
const jwt = await new SignJWT({ exp: 0 })
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
// with valid secret should throw exp failing to verify
await t.throwsAsync(jwtVerify(jwt, t.context.secret), { code: 'ERR_JWT_EXPIRED' })
// with invalid secret should throw signature failing to verify
await t.throwsAsync(jwtVerify(jwt, new Uint8Array([0x00, 0x01])), {
code: 'ERR_JWS_SIGNATURE_VERIFICATION_FAILED',
})
})
test('requiredClaims claims check', async (t) => {
const jwt = await new SignJWT({
...t.context.payload,
})
.setProtectedHeader({ alg: 'HS256' })
.sign(t.context.secret)
for (const [claim, option] of [
['iss', 'issuer'],
['aud', 'audience'],
['iat', 'maxTokenAge'],
['sub', 'subject'],
]) {
await t.throwsAsync(jwtVerify(jwt, t.context.secret, { [option]: 'foo' }), {
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: `missing required "${claim}" claim`,
})
await t.throwsAsync(
jwtVerify(jwt, t.context.secret, { [option]: 'foo', requiredClaims: ['nbf'] }),
{
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: `missing required "${claim}" claim`,
},
)
}
await t.throwsAsync(jwtVerify(jwt, t.context.secret, { requiredClaims: ['nbf'] }), {
code: 'ERR_JWT_CLAIM_VALIDATION_FAILED',
message: `missing required "nbf" claim`,
})
})