@sd-jwt/core 0.2.1 → 0.3.2-next.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +27 -82
  3. package/dist/index.d.mts +118 -0
  4. package/dist/index.d.ts +118 -0
  5. package/dist/index.js +675 -0
  6. package/dist/index.mjs +654 -0
  7. package/package.json +62 -48
  8. package/src/decoy.ts +15 -0
  9. package/src/index.ts +313 -0
  10. package/src/jwt.ts +107 -0
  11. package/src/kbjwt.ts +61 -0
  12. package/src/sdjwt.ts +337 -0
  13. package/src/test/decoy.spec.ts +30 -0
  14. package/src/test/index.spec.ts +528 -0
  15. package/src/test/jwt.spec.ts +141 -0
  16. package/src/test/kbjwt.spec.ts +341 -0
  17. package/src/test/pass.spec.ts +6 -0
  18. package/src/test/sdjwt.spec.ts +382 -0
  19. package/test/app-e2e.spec.ts +248 -0
  20. package/test/array_data_types.json +29 -0
  21. package/test/array_full_sd.json +21 -0
  22. package/test/array_in_sd.json +13 -0
  23. package/test/array_nested_in_plain.json +20 -0
  24. package/test/array_none_disclosed.json +17 -0
  25. package/test/array_of_nulls.json +15 -0
  26. package/test/array_of_objects.json +58 -0
  27. package/test/array_of_scalars.json +15 -0
  28. package/test/array_recursive_sd.json +35 -0
  29. package/test/array_recursive_sd_some_disclosed.json +55 -0
  30. package/test/complex.json +43 -0
  31. package/test/header_mod.json +44 -0
  32. package/test/json_serialization.json +44 -0
  33. package/test/key_binding.json +44 -0
  34. package/test/no_sd.json +36 -0
  35. package/test/object_data_types.json +60 -0
  36. package/test/recursions.json +98 -0
  37. package/tsconfig.json +7 -0
  38. package/vitest.config.mts +4 -0
  39. package/build/base64url.d.ts +0 -28
  40. package/build/base64url.js +0 -40
  41. package/build/base64url.js.map +0 -1
  42. package/build/hasherAlgorithm.d.ts +0 -70
  43. package/build/hasherAlgorithm.js +0 -75
  44. package/build/hasherAlgorithm.js.map +0 -1
  45. package/build/index.d.ts +0 -13
  46. package/build/index.js +0 -20
  47. package/build/index.js.map +0 -1
  48. package/build/jwt/compact.d.ts +0 -6
  49. package/build/jwt/compact.js +0 -27
  50. package/build/jwt/compact.js.map +0 -1
  51. package/build/jwt/error.d.ts +0 -2
  52. package/build/jwt/error.js +0 -7
  53. package/build/jwt/error.js.map +0 -1
  54. package/build/jwt/index.d.ts +0 -2
  55. package/build/jwt/index.js +0 -19
  56. package/build/jwt/index.js.map +0 -1
  57. package/build/jwt/jwt.d.ts +0 -208
  58. package/build/jwt/jwt.js +0 -325
  59. package/build/jwt/jwt.js.map +0 -1
  60. package/build/keyBinding/index.d.ts +0 -1
  61. package/build/keyBinding/index.js +0 -18
  62. package/build/keyBinding/index.js.map +0 -1
  63. package/build/keyBinding/keyBinding.d.ts +0 -64
  64. package/build/keyBinding/keyBinding.js +0 -119
  65. package/build/keyBinding/keyBinding.js.map +0 -1
  66. package/build/sdJwt/compact.d.ts +0 -8
  67. package/build/sdJwt/compact.js +0 -39
  68. package/build/sdJwt/compact.js.map +0 -1
  69. package/build/sdJwt/decoys.d.ts +0 -3
  70. package/build/sdJwt/decoys.js +0 -35
  71. package/build/sdJwt/decoys.js.map +0 -1
  72. package/build/sdJwt/disclosureFrame.d.ts +0 -8
  73. package/build/sdJwt/disclosureFrame.js +0 -87
  74. package/build/sdJwt/disclosureFrame.js.map +0 -1
  75. package/build/sdJwt/disclosureMapping.d.ts +0 -43
  76. package/build/sdJwt/disclosureMapping.js +0 -278
  77. package/build/sdJwt/disclosureMapping.js.map +0 -1
  78. package/build/sdJwt/disclosures.d.ts +0 -33
  79. package/build/sdJwt/disclosures.js +0 -114
  80. package/build/sdJwt/disclosures.js.map +0 -1
  81. package/build/sdJwt/error.d.ts +0 -2
  82. package/build/sdJwt/error.js +0 -7
  83. package/build/sdJwt/error.js.map +0 -1
  84. package/build/sdJwt/index.d.ts +0 -6
  85. package/build/sdJwt/index.js +0 -23
  86. package/build/sdJwt/index.js.map +0 -1
  87. package/build/sdJwt/presentationFrame.d.ts +0 -3
  88. package/build/sdJwt/presentationFrame.js +0 -64
  89. package/build/sdJwt/presentationFrame.js.map +0 -1
  90. package/build/sdJwt/sdJwt.d.ts +0 -206
  91. package/build/sdJwt/sdJwt.js +0 -442
  92. package/build/sdJwt/sdJwt.js.map +0 -1
  93. package/build/sdJwt/swapClaim.d.ts +0 -2
  94. package/build/sdJwt/swapClaim.js +0 -79
  95. package/build/sdJwt/swapClaim.js.map +0 -1
  96. package/build/sdJwt/types.d.ts +0 -5
  97. package/build/sdJwt/types.js +0 -3
  98. package/build/sdJwt/types.js.map +0 -1
  99. package/build/sdJwtVc/error.d.ts +0 -2
  100. package/build/sdJwtVc/error.js +0 -7
  101. package/build/sdJwtVc/error.js.map +0 -1
  102. package/build/sdJwtVc/index.d.ts +0 -2
  103. package/build/sdJwtVc/index.js +0 -19
  104. package/build/sdJwtVc/index.js.map +0 -1
  105. package/build/sdJwtVc/sdJwtVc.d.ts +0 -47
  106. package/build/sdJwtVc/sdJwtVc.js +0 -149
  107. package/build/sdJwtVc/sdJwtVc.js.map +0 -1
  108. package/build/signatureAndEncryptionAlgorithm.d.ts +0 -105
  109. package/build/signatureAndEncryptionAlgorithm.js +0 -110
  110. package/build/signatureAndEncryptionAlgorithm.js.map +0 -1
  111. package/build/types/disclosure.d.ts +0 -5
  112. package/build/types/disclosure.js +0 -3
  113. package/build/types/disclosure.js.map +0 -1
  114. package/build/types/frame.d.ts +0 -5
  115. package/build/types/frame.js +0 -3
  116. package/build/types/frame.js.map +0 -1
  117. package/build/types/hasher.d.ts +0 -14
  118. package/build/types/hasher.js +0 -3
  119. package/build/types/hasher.js.map +0 -1
  120. package/build/types/index.d.ts +0 -5
  121. package/build/types/index.js +0 -22
  122. package/build/types/index.js.map +0 -1
  123. package/build/types/present.d.ts +0 -2
  124. package/build/types/present.js +0 -3
  125. package/build/types/present.js.map +0 -1
  126. package/build/types/saltGenerator.d.ts +0 -17
  127. package/build/types/saltGenerator.js +0 -3
  128. package/build/types/saltGenerator.js.map +0 -1
  129. package/build/types/signer.d.ts +0 -2
  130. package/build/types/signer.js +0 -3
  131. package/build/types/signer.js.map +0 -1
  132. package/build/types/utils.d.ts +0 -2
  133. package/build/types/utils.js +0 -3
  134. package/build/types/utils.js.map +0 -1
  135. package/build/types/verifier.d.ts +0 -14
  136. package/build/types/verifier.js +0 -3
  137. package/build/types/verifier.js.map +0 -1
  138. package/build/utils/index.d.ts +0 -2
  139. package/build/utils/index.js +0 -19
  140. package/build/utils/index.js.map +0 -1
  141. package/build/utils/traverse.d.ts +0 -8
  142. package/build/utils/traverse.js +0 -29
  143. package/build/utils/traverse.js.map +0 -1
  144. package/build/utils/utils.d.ts +0 -8
  145. package/build/utils/utils.js +0 -118
  146. package/build/utils/utils.js.map +0 -1
@@ -0,0 +1,341 @@
1
+ import { SDJWTException } from '@sd-jwt/utils';
2
+ import { KBJwt } from '../kbjwt';
3
+ import {
4
+ JwtPayload,
5
+ KB_JWT_TYP,
6
+ KbVerifier,
7
+ Signer,
8
+ Verifier,
9
+ } from '@sd-jwt/types';
10
+ import Crypto, { KeyLike } from 'node:crypto';
11
+ import { describe, expect, test } from 'vitest';
12
+ import { JWK, exportJWK, importJWK } from 'jose';
13
+
14
+ describe('KB JWT', () => {
15
+ test('create', async () => {
16
+ const kbJwt = new KBJwt({
17
+ header: {
18
+ typ: KB_JWT_TYP,
19
+ alg: 'EdDSA',
20
+ },
21
+ payload: {
22
+ iat: 1,
23
+ aud: 'aud',
24
+ nonce: 'nonce',
25
+ sd_hash: 'hash',
26
+ },
27
+ });
28
+
29
+ expect(kbJwt.header).toEqual({
30
+ typ: KB_JWT_TYP,
31
+ alg: 'EdDSA',
32
+ });
33
+ expect(kbJwt.payload).toEqual({
34
+ iat: 1,
35
+ aud: 'aud',
36
+ nonce: 'nonce',
37
+ sd_hash: 'hash',
38
+ });
39
+ });
40
+
41
+ test('decode', async () => {
42
+ const { privateKey } = Crypto.generateKeyPairSync('ed25519');
43
+ const testSigner: Signer = async (data: string) => {
44
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
45
+ return Buffer.from(sig).toString('base64url');
46
+ };
47
+ const kbJwt = new KBJwt({
48
+ header: {
49
+ typ: KB_JWT_TYP,
50
+ alg: 'EdDSA',
51
+ },
52
+ payload: {
53
+ iat: 1,
54
+ aud: 'aud',
55
+ nonce: 'nonce',
56
+ sd_hash: 'hash',
57
+ },
58
+ });
59
+ const encodedKbJwt = await kbJwt.sign(testSigner);
60
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
61
+ expect(decoded.header).toEqual({
62
+ typ: KB_JWT_TYP,
63
+ alg: 'EdDSA',
64
+ });
65
+ expect(decoded.payload).toEqual({
66
+ iat: 1,
67
+ aud: 'aud',
68
+ nonce: 'nonce',
69
+ sd_hash: 'hash',
70
+ });
71
+ });
72
+
73
+ test('verify', async () => {
74
+ const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
75
+ const testSigner: Signer = async (data: string) => {
76
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
77
+ return Buffer.from(sig).toString('base64url');
78
+ };
79
+
80
+ const payload = {
81
+ cnf: {
82
+ jwk: await exportJWK(publicKey),
83
+ },
84
+ };
85
+
86
+ const testVerifier: KbVerifier = async (
87
+ data: string,
88
+ sig: string,
89
+ payload: JwtPayload,
90
+ ) => {
91
+ expect(payload).toStrictEqual(payload);
92
+ expect(payload.cnf?.jwk).toBeDefined();
93
+
94
+ const publicKey = payload.cnf?.jwk;
95
+
96
+ return Crypto.verify(
97
+ null,
98
+ Buffer.from(data),
99
+ (await importJWK(publicKey as JWK, 'EdDSA')) as KeyLike,
100
+ Buffer.from(sig, 'base64url'),
101
+ );
102
+ };
103
+ const kbJwt = new KBJwt({
104
+ header: {
105
+ typ: KB_JWT_TYP,
106
+ alg: 'EdDSA',
107
+ },
108
+ payload: {
109
+ iat: 1,
110
+ aud: 'aud',
111
+ nonce: 'nonce',
112
+ sd_hash: 'hash',
113
+ },
114
+ });
115
+ const encodedKbJwt = await kbJwt.sign(testSigner);
116
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
117
+ const verified = await decoded.verifyKB({
118
+ verifier: testVerifier,
119
+ payload,
120
+ });
121
+ expect(verified).toStrictEqual({
122
+ header: {
123
+ typ: KB_JWT_TYP,
124
+ alg: 'EdDSA',
125
+ },
126
+ payload: {
127
+ iat: 1,
128
+ aud: 'aud',
129
+ nonce: 'nonce',
130
+ sd_hash: 'hash',
131
+ },
132
+ });
133
+ });
134
+
135
+ test('verify failed', async () => {
136
+ const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
137
+ const testSigner: Signer = async (data: string) => {
138
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
139
+ return Buffer.from(sig).toString('base64url');
140
+ };
141
+
142
+ const payload = {
143
+ cnf: {
144
+ jwk: await exportJWK(publicKey),
145
+ },
146
+ };
147
+ const testVerifier: KbVerifier = async (
148
+ data: string,
149
+ sig: string,
150
+ payload: JwtPayload,
151
+ ) => {
152
+ expect(payload).toStrictEqual(payload);
153
+ expect(payload.cnf?.jwk).toBeDefined();
154
+
155
+ const publicKey = payload.cnf?.jwk;
156
+
157
+ return Crypto.verify(
158
+ null,
159
+ Buffer.from(data),
160
+ (await importJWK(publicKey as JWK, 'EdDSA')) as KeyLike,
161
+ Buffer.from(sig, 'base64url'),
162
+ );
163
+ };
164
+
165
+ const kbJwt = new KBJwt({
166
+ header: {
167
+ typ: KB_JWT_TYP,
168
+ alg: 'EdDSA',
169
+ },
170
+ payload: {
171
+ iat: 1,
172
+ aud: 'aud',
173
+ nonce: 'nonce',
174
+ sd_hash: '',
175
+ },
176
+ });
177
+ const encodedKbJwt = await kbJwt.sign(testSigner);
178
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
179
+ try {
180
+ await decoded.verifyKB({ verifier: testVerifier, payload });
181
+ } catch (e: unknown) {
182
+ const error = e as SDJWTException;
183
+ expect(error.message).toBe('Invalid Key Binding Jwt');
184
+ }
185
+ });
186
+
187
+ test('verify failed with verifier return false', async () => {
188
+ const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
189
+ const testSigner: Signer = async (data: string) => {
190
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
191
+ return Buffer.from(sig).toString('base64url');
192
+ };
193
+
194
+ const payload = {
195
+ cnf: {
196
+ jwk: await exportJWK(publicKey),
197
+ },
198
+ };
199
+ const testVerifier: KbVerifier = async (
200
+ data: string,
201
+ sig: string,
202
+ payload: JwtPayload,
203
+ ) => {
204
+ expect(payload).toStrictEqual(payload);
205
+ expect(payload.cnf?.jwk).toBeDefined();
206
+
207
+ return false;
208
+ };
209
+
210
+ const kbJwt = new KBJwt({
211
+ header: {
212
+ typ: KB_JWT_TYP,
213
+ alg: 'EdDSA',
214
+ },
215
+ payload: {
216
+ iat: 1,
217
+ aud: 'aud',
218
+ nonce: 'nonce',
219
+ sd_hash: 'hash',
220
+ },
221
+ });
222
+ const encodedKbJwt = await kbJwt.sign(testSigner);
223
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
224
+ try {
225
+ await decoded.verifyKB({ verifier: testVerifier, payload });
226
+ } catch (e: unknown) {
227
+ const error = e as SDJWTException;
228
+ expect(error.message).toBe('Verify Error: Invalid JWT Signature');
229
+ }
230
+ });
231
+
232
+ test('verify failed with invalid jwt', async () => {
233
+ const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
234
+ const testSigner: Signer = async (data: string) => {
235
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
236
+ return Buffer.from(sig).toString('base64url');
237
+ };
238
+
239
+ const payload = {
240
+ cnf: {
241
+ jwk: await exportJWK(publicKey),
242
+ },
243
+ };
244
+ const testVerifier: KbVerifier = async (
245
+ data: string,
246
+ sig: string,
247
+ payload: JwtPayload,
248
+ ) => {
249
+ expect(payload).toStrictEqual(payload);
250
+ expect(payload.cnf?.jwk).toBeDefined();
251
+
252
+ return false;
253
+ };
254
+
255
+ const kbJwt = new KBJwt({
256
+ header: {
257
+ typ: KB_JWT_TYP,
258
+ alg: 'EdDSA',
259
+ },
260
+ payload: {
261
+ iat: 1,
262
+ aud: 'aud',
263
+ nonce: 'nonce',
264
+ sd_hash: 'hash',
265
+ },
266
+ });
267
+ const encodedKbJwt = await kbJwt.sign(testSigner);
268
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
269
+ decoded.signature = undefined;
270
+ try {
271
+ await decoded.verifyKB({ verifier: testVerifier, payload });
272
+ } catch (e: unknown) {
273
+ const error = e as SDJWTException;
274
+ expect(error.message).toBe('Verify Error: Invalid JWT');
275
+ }
276
+ });
277
+
278
+ test('compatibility test for version 06', async () => {
279
+ const { privateKey, publicKey } = Crypto.generateKeyPairSync('ed25519');
280
+ const testSigner: Signer = async (data: string) => {
281
+ const sig = Crypto.sign(null, Buffer.from(data), privateKey);
282
+ return Buffer.from(sig).toString('base64url');
283
+ };
284
+ const payload = {
285
+ cnf: {
286
+ jwk: await exportJWK(publicKey),
287
+ },
288
+ };
289
+ const testVerifier: KbVerifier = async (
290
+ data: string,
291
+ sig: string,
292
+ payload: JwtPayload,
293
+ ) => {
294
+ expect(payload).toStrictEqual(payload);
295
+ expect(payload.cnf?.jwk).toBeDefined();
296
+
297
+ const publicKey = payload.cnf?.jwk;
298
+
299
+ return Crypto.verify(
300
+ null,
301
+ Buffer.from(data),
302
+ (await importJWK(publicKey as JWK, 'EdDSA')) as KeyLike,
303
+ Buffer.from(sig, 'base64url'),
304
+ );
305
+ };
306
+ const kbJwt = new KBJwt({
307
+ header: {
308
+ typ: KB_JWT_TYP,
309
+ alg: 'EdDSA',
310
+ },
311
+ payload: {
312
+ iat: 1,
313
+ aud: 'aud',
314
+ nonce: 'nonce',
315
+ sd_hash: 'hash',
316
+ },
317
+ });
318
+
319
+ (kbJwt.payload as Record<string, unknown>)._sd_hash = 'hash';
320
+ (kbJwt.payload as Record<string, unknown>).sd_hash = undefined;
321
+
322
+ const encodedKbJwt = await kbJwt.sign(testSigner);
323
+ const decoded = KBJwt.fromKBEncode(encodedKbJwt);
324
+ const verified = await decoded.verifyKB({
325
+ verifier: testVerifier,
326
+ payload,
327
+ });
328
+ expect(verified).toStrictEqual({
329
+ header: {
330
+ typ: KB_JWT_TYP,
331
+ alg: 'EdDSA',
332
+ },
333
+ payload: {
334
+ iat: 1,
335
+ aud: 'aud',
336
+ nonce: 'nonce',
337
+ _sd_hash: 'hash',
338
+ },
339
+ });
340
+ });
341
+ });
@@ -0,0 +1,6 @@
1
+ import { describe, expect, test } from 'vitest';
2
+ describe('Should always pass', () => {
3
+ test('adds 1 + 2 to equal 3', () => {
4
+ expect(1 + 2).toBe(3);
5
+ });
6
+ });