@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth 0.34.1-feature.SSISDK.50.type.refactor.148 → 0.34.1-feature.SSISDK.57.uni.client.167
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.
- package/dist/index.cjs +323 -329
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +716 -25
- package/dist/index.d.ts +716 -25
- package/dist/index.js +315 -322
- package/dist/index.js.map +1 -1
- package/package.json +17 -17
- package/src/RPInstance.ts +6 -4
- package/src/agent/SIOPv2RP.ts +27 -25
- package/src/functions.ts +4 -4
- package/src/index.ts +1 -1
- package/src/types/ISIOPv2RP.ts +15 -17
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { IPluginMethodMap, IAgentContext, IResolver, IDIDManager, IKeyManager, ICredentialIssuer, ICredentialVerifier, IAgentPlugin } from '@veramo/core';
|
|
2
|
-
import { ResponseURIType, ClaimPayloadCommonOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState,
|
|
2
|
+
import { ResponseURIType, ClaimPayloadCommonOpts, CallbackOpts, AuthorizationRequestPayload, RequestObjectPayload, AuthorizationRequestState, AuthorizationResponseStateWithVerifiedData, AuthorizationResponsePayload, VerifiedAuthorizationResponse, ResponseMode, SupportedVersion, IRPSessionManager, ClientMetadataOpts, VerifyJwtCallback, PresentationVerificationCallback, RP, URI, AuthorizationRequest } from '@sphereon/did-auth-siop';
|
|
3
3
|
import { CheckLinkedDomain } from '@sphereon/did-auth-siop-adapter';
|
|
4
4
|
import { DIDDocument } from '@sphereon/did-uni-client';
|
|
5
5
|
import { JwtIssuer } from '@sphereon/oid4vc-common';
|
|
@@ -13,12 +13,383 @@ import { IPDManager, ImportDcqlQueryItem, VersionControlMode } from '@sphereon/s
|
|
|
13
13
|
import { IPresentationExchange } from '@sphereon/ssi-sdk.presentation-exchange';
|
|
14
14
|
import { ISDJwtPlugin } from '@sphereon/ssi-sdk.sd-jwt';
|
|
15
15
|
import { AuthorizationRequestStateStatus } from '@sphereon/ssi-sdk.siopv2-oid4vp-common';
|
|
16
|
-
import {
|
|
16
|
+
import { HasherSync } from '@sphereon/ssi-types';
|
|
17
17
|
import { VerifyCallback } from '@sphereon/wellknown-dids-client';
|
|
18
18
|
import { DcqlQuery } from 'dcql';
|
|
19
19
|
import { Resolvable } from 'did-resolver';
|
|
20
20
|
import { EventEmitter } from 'events';
|
|
21
21
|
|
|
22
|
+
var IDidAuthSiopOpAuthenticator = {
|
|
23
|
+
components: {
|
|
24
|
+
schemas: {
|
|
25
|
+
IGetSiopSessionArgs: {
|
|
26
|
+
type: "object",
|
|
27
|
+
properties: {
|
|
28
|
+
sessionId: {
|
|
29
|
+
type: "string"
|
|
30
|
+
},
|
|
31
|
+
additionalProperties: false
|
|
32
|
+
},
|
|
33
|
+
required: [
|
|
34
|
+
"sessionId"
|
|
35
|
+
],
|
|
36
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSessionForSiop } "
|
|
37
|
+
},
|
|
38
|
+
IRegisterSiopSessionArgs: {
|
|
39
|
+
type: "object",
|
|
40
|
+
properties: {
|
|
41
|
+
identifier: {
|
|
42
|
+
type: "object",
|
|
43
|
+
properties: {
|
|
44
|
+
did: {
|
|
45
|
+
type: "string"
|
|
46
|
+
},
|
|
47
|
+
alias: {
|
|
48
|
+
type: "string"
|
|
49
|
+
},
|
|
50
|
+
provider: {
|
|
51
|
+
type: "string"
|
|
52
|
+
},
|
|
53
|
+
controllerKeyId: {
|
|
54
|
+
type: "string"
|
|
55
|
+
},
|
|
56
|
+
keys: {
|
|
57
|
+
type: "array",
|
|
58
|
+
items: {
|
|
59
|
+
type: "object",
|
|
60
|
+
properties: {
|
|
61
|
+
additionalProperties: true
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
services: {
|
|
66
|
+
type: "array",
|
|
67
|
+
items: {
|
|
68
|
+
type: "object",
|
|
69
|
+
properties: {
|
|
70
|
+
additionalProperties: true
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
additionalProperties: false,
|
|
76
|
+
required: [
|
|
77
|
+
"did",
|
|
78
|
+
"provider",
|
|
79
|
+
"keys",
|
|
80
|
+
"services"
|
|
81
|
+
]
|
|
82
|
+
},
|
|
83
|
+
sessionId: {
|
|
84
|
+
type: "string"
|
|
85
|
+
},
|
|
86
|
+
expiresIn: {
|
|
87
|
+
type: "number"
|
|
88
|
+
},
|
|
89
|
+
additionalProperties: false
|
|
90
|
+
},
|
|
91
|
+
required: [
|
|
92
|
+
"identifier"
|
|
93
|
+
],
|
|
94
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.registerSessionForSiop } "
|
|
95
|
+
},
|
|
96
|
+
IRemoveSiopSessionArgs: {
|
|
97
|
+
type: "object",
|
|
98
|
+
properties: {
|
|
99
|
+
sessionId: {
|
|
100
|
+
type: "string"
|
|
101
|
+
},
|
|
102
|
+
additionalProperties: false
|
|
103
|
+
},
|
|
104
|
+
required: [
|
|
105
|
+
"sessionId"
|
|
106
|
+
],
|
|
107
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.removeSessionForSiop } "
|
|
108
|
+
},
|
|
109
|
+
IAuthenticateWithSiopArgs: {
|
|
110
|
+
type: "object",
|
|
111
|
+
properties: {
|
|
112
|
+
sessionId: {
|
|
113
|
+
type: "string"
|
|
114
|
+
},
|
|
115
|
+
stateId: {
|
|
116
|
+
type: "string"
|
|
117
|
+
},
|
|
118
|
+
redirectUrl: {
|
|
119
|
+
type: "string"
|
|
120
|
+
},
|
|
121
|
+
additionalProperties: false
|
|
122
|
+
},
|
|
123
|
+
required: [
|
|
124
|
+
"sessionId",
|
|
125
|
+
"stateId",
|
|
126
|
+
"redirectUrl"
|
|
127
|
+
],
|
|
128
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.authenticateWithSiop } "
|
|
129
|
+
},
|
|
130
|
+
IResponse: {
|
|
131
|
+
type: "object",
|
|
132
|
+
properties: {
|
|
133
|
+
status: {
|
|
134
|
+
type: "number"
|
|
135
|
+
},
|
|
136
|
+
additionalProperties: true
|
|
137
|
+
},
|
|
138
|
+
required: [
|
|
139
|
+
"status"
|
|
140
|
+
],
|
|
141
|
+
description: "Result of {@link DidAuthSiopOpAuthenticator.authenticateWithSiop & DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
|
|
142
|
+
},
|
|
143
|
+
IGetSiopAuthenticationRequestFromRpArgs: {
|
|
144
|
+
type: "object",
|
|
145
|
+
properties: {
|
|
146
|
+
sessionId: {
|
|
147
|
+
type: "string"
|
|
148
|
+
},
|
|
149
|
+
stateId: {
|
|
150
|
+
type: "string"
|
|
151
|
+
},
|
|
152
|
+
redirectUrl: {
|
|
153
|
+
type: "string"
|
|
154
|
+
},
|
|
155
|
+
additionalProperties: false
|
|
156
|
+
},
|
|
157
|
+
required: [
|
|
158
|
+
"sessionId",
|
|
159
|
+
"stateId",
|
|
160
|
+
"redirectUrl"
|
|
161
|
+
],
|
|
162
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
|
|
163
|
+
},
|
|
164
|
+
ParsedAuthenticationRequestURI: {
|
|
165
|
+
type: "object",
|
|
166
|
+
properties: {
|
|
167
|
+
jwt: {
|
|
168
|
+
type: "string"
|
|
169
|
+
},
|
|
170
|
+
requestPayload: {
|
|
171
|
+
type: "object",
|
|
172
|
+
properties: {
|
|
173
|
+
additionalProperties: true
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
registration: {
|
|
177
|
+
type: "object",
|
|
178
|
+
properties: {
|
|
179
|
+
additionalProperties: true
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
additionalProperties: false
|
|
183
|
+
},
|
|
184
|
+
required: [
|
|
185
|
+
"jwt",
|
|
186
|
+
"requestPayload",
|
|
187
|
+
"registration"
|
|
188
|
+
],
|
|
189
|
+
description: "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestFromRP } "
|
|
190
|
+
},
|
|
191
|
+
IGetSiopAuthenticationRequestDetailsArgs: {
|
|
192
|
+
type: "object",
|
|
193
|
+
properties: {
|
|
194
|
+
sessionId: {
|
|
195
|
+
type: "string"
|
|
196
|
+
},
|
|
197
|
+
verifiedAuthenticationRequest: {
|
|
198
|
+
type: "object",
|
|
199
|
+
properties: {
|
|
200
|
+
additionalProperties: true
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
credentialFilter: {
|
|
204
|
+
type: "object",
|
|
205
|
+
properties: {
|
|
206
|
+
additionalProperties: true
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
additionalProperties: false
|
|
210
|
+
},
|
|
211
|
+
required: [
|
|
212
|
+
"sessionId",
|
|
213
|
+
"verifiedAuthenticationRequest"
|
|
214
|
+
],
|
|
215
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
|
|
216
|
+
},
|
|
217
|
+
IAuthRequestDetails: {
|
|
218
|
+
type: "object",
|
|
219
|
+
properties: {
|
|
220
|
+
id: {
|
|
221
|
+
type: "string"
|
|
222
|
+
},
|
|
223
|
+
alsoKnownAs: {
|
|
224
|
+
type: "array",
|
|
225
|
+
items: {
|
|
226
|
+
type: "string"
|
|
227
|
+
}
|
|
228
|
+
},
|
|
229
|
+
vpResponseOpts: {
|
|
230
|
+
type: "object",
|
|
231
|
+
properties: {
|
|
232
|
+
additionalProperties: true
|
|
233
|
+
}
|
|
234
|
+
},
|
|
235
|
+
additionalProperties: false
|
|
236
|
+
},
|
|
237
|
+
required: [
|
|
238
|
+
"id",
|
|
239
|
+
"vpResponseOpts"
|
|
240
|
+
],
|
|
241
|
+
description: "Result of {@link DidAuthSiopOpAuthenticator.getSiopAuthenticationRequestDetails } "
|
|
242
|
+
},
|
|
243
|
+
IVerifySiopAuthenticationRequestUriArgs: {
|
|
244
|
+
type: "object",
|
|
245
|
+
properties: {
|
|
246
|
+
sessionId: {
|
|
247
|
+
type: "string"
|
|
248
|
+
},
|
|
249
|
+
ParsedAuthenticationRequestURI: {
|
|
250
|
+
type: "object",
|
|
251
|
+
properties: {
|
|
252
|
+
additionalProperties: true
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
additionalProperties: false
|
|
256
|
+
},
|
|
257
|
+
required: [
|
|
258
|
+
"sessionId",
|
|
259
|
+
"ParsedAuthenticationRequestURI"
|
|
260
|
+
],
|
|
261
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
|
|
262
|
+
},
|
|
263
|
+
VerifiedAuthorizationRequest: {
|
|
264
|
+
type: "object",
|
|
265
|
+
properties: {
|
|
266
|
+
payload: {
|
|
267
|
+
type: "object",
|
|
268
|
+
properties: {
|
|
269
|
+
additionalProperties: true
|
|
270
|
+
}
|
|
271
|
+
},
|
|
272
|
+
presentationDefinitions: {
|
|
273
|
+
type: "object",
|
|
274
|
+
properties: {
|
|
275
|
+
additionalProperties: true
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
verifyOpts: {
|
|
279
|
+
type: "object",
|
|
280
|
+
properties: {
|
|
281
|
+
additionalProperties: true
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
additionalProperties: false
|
|
285
|
+
},
|
|
286
|
+
required: [
|
|
287
|
+
"payload",
|
|
288
|
+
"verifyOpts"
|
|
289
|
+
],
|
|
290
|
+
description: "Result of {@link DidAuthSiopOpAuthenticator.verifySiopAuthenticationRequestURI } "
|
|
291
|
+
},
|
|
292
|
+
ISendSiopAuthenticationResponseArgs: {
|
|
293
|
+
type: "object",
|
|
294
|
+
properties: {
|
|
295
|
+
sessionId: {
|
|
296
|
+
type: "string"
|
|
297
|
+
},
|
|
298
|
+
verifiedAuthenticationRequest: {
|
|
299
|
+
type: "object",
|
|
300
|
+
properties: {
|
|
301
|
+
additionalProperties: true
|
|
302
|
+
}
|
|
303
|
+
},
|
|
304
|
+
verifiablePresentationResponse: {
|
|
305
|
+
type: "object",
|
|
306
|
+
properties: {
|
|
307
|
+
additionalProperties: true
|
|
308
|
+
}
|
|
309
|
+
},
|
|
310
|
+
additionalProperties: false
|
|
311
|
+
},
|
|
312
|
+
required: [
|
|
313
|
+
"sessionId",
|
|
314
|
+
"verifiedAuthenticationRequest"
|
|
315
|
+
],
|
|
316
|
+
description: "Arguments needed for {@link DidAuthSiopOpAuthenticator.sendSiopAuthenticationResponse } "
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
methods: {
|
|
320
|
+
getSessionForSiop: {
|
|
321
|
+
description: "Get SIOP session",
|
|
322
|
+
"arguments": {
|
|
323
|
+
$ref: "#/components/schemas/IGetSiopSessionArgs"
|
|
324
|
+
},
|
|
325
|
+
returnType: "object"
|
|
326
|
+
},
|
|
327
|
+
registerSessionForSiop: {
|
|
328
|
+
description: "Register SIOP session",
|
|
329
|
+
"arguments": {
|
|
330
|
+
$ref: "#/components/schemas/IRegisterSiopSessionArgs"
|
|
331
|
+
},
|
|
332
|
+
returnType: "object"
|
|
333
|
+
},
|
|
334
|
+
removeSessionForSiop: {
|
|
335
|
+
description: "Remove SIOP session",
|
|
336
|
+
"arguments": {
|
|
337
|
+
$ref: "#/components/schemas/IRemoveSiopSessionArgs"
|
|
338
|
+
},
|
|
339
|
+
returnType: "boolean"
|
|
340
|
+
},
|
|
341
|
+
authenticateWithSiop: {
|
|
342
|
+
description: "Authenticate using DID Auth SIOP",
|
|
343
|
+
"arguments": {
|
|
344
|
+
$ref: "#/components/schemas/IAuthenticateWithSiopArgs"
|
|
345
|
+
},
|
|
346
|
+
returnType: {
|
|
347
|
+
$ref: "#/components/schemas/Response"
|
|
348
|
+
}
|
|
349
|
+
},
|
|
350
|
+
getSiopAuthenticationRequestFromRP: {
|
|
351
|
+
description: "Get authentication request from RP",
|
|
352
|
+
"arguments": {
|
|
353
|
+
$ref: "#/components/schemas/IGetSiopAuthenticationRequestFromRpArgs"
|
|
354
|
+
},
|
|
355
|
+
returnType: {
|
|
356
|
+
$ref: "#/components/schemas/ParsedAuthenticationRequestURI"
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
getSiopAuthenticationRequestDetails: {
|
|
360
|
+
description: "Get authentication request details",
|
|
361
|
+
"arguments": {
|
|
362
|
+
$ref: "#/components/schemas/IGetSiopAuthenticationRequestDetailsArgs"
|
|
363
|
+
},
|
|
364
|
+
returnType: {
|
|
365
|
+
$ref: "#/components/schemas/IAuthRequestDetails"
|
|
366
|
+
}
|
|
367
|
+
},
|
|
368
|
+
verifySiopAuthenticationRequestURI: {
|
|
369
|
+
description: "Verify authentication request URI",
|
|
370
|
+
"arguments": {
|
|
371
|
+
$ref: "#/components/schemas/IVerifySiopAuthenticationRequestUriArgs"
|
|
372
|
+
},
|
|
373
|
+
returnType: {
|
|
374
|
+
$ref: "#/components/schemas/VerifiedAuthorizationRequest"
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
sendSiopAuthenticationResponse: {
|
|
378
|
+
description: "Send authentication response",
|
|
379
|
+
"arguments": {
|
|
380
|
+
$ref: "#/components/schemas/ISendSiopAuthenticationResponseArgs"
|
|
381
|
+
},
|
|
382
|
+
returnType: {
|
|
383
|
+
$ref: "#/components/schemas/IRequiredContext"
|
|
384
|
+
}
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
};
|
|
389
|
+
var plugin_schema = {
|
|
390
|
+
IDidAuthSiopOpAuthenticator: IDidAuthSiopOpAuthenticator
|
|
391
|
+
};
|
|
392
|
+
|
|
22
393
|
declare enum VerifiedDataMode {
|
|
23
394
|
NONE = "none",
|
|
24
395
|
VERIFIED_PRESENTATION = "vp",
|
|
@@ -42,8 +413,9 @@ interface ISiopv2RPOpts {
|
|
|
42
413
|
interface IRPDefaultOpts extends IRPOptions {
|
|
43
414
|
}
|
|
44
415
|
interface ICreateAuthRequestArgs {
|
|
45
|
-
|
|
416
|
+
queryId: string;
|
|
46
417
|
correlationId: string;
|
|
418
|
+
useQueryIdInstance?: boolean;
|
|
47
419
|
responseURIType: ResponseURIType;
|
|
48
420
|
responseURI: string;
|
|
49
421
|
responseRedirectURI?: string;
|
|
@@ -52,32 +424,33 @@ interface ICreateAuthRequestArgs {
|
|
|
52
424
|
nonce?: string;
|
|
53
425
|
state?: string;
|
|
54
426
|
claims?: ClaimPayloadCommonOpts;
|
|
427
|
+
callback?: CallbackOpts;
|
|
55
428
|
}
|
|
56
429
|
interface IGetAuthRequestStateArgs {
|
|
57
430
|
correlationId: string;
|
|
58
|
-
|
|
431
|
+
queryId?: string;
|
|
59
432
|
errorOnNotFound?: boolean;
|
|
60
433
|
}
|
|
61
434
|
interface IGetAuthResponseStateArgs {
|
|
62
435
|
correlationId: string;
|
|
63
|
-
|
|
436
|
+
queryId?: string;
|
|
64
437
|
errorOnNotFound?: boolean;
|
|
65
438
|
progressRequestStateTo?: AuthorizationRequestStateStatus;
|
|
66
439
|
includeVerifiedData?: VerifiedDataMode;
|
|
67
440
|
}
|
|
68
441
|
interface IUpdateRequestStateArgs {
|
|
69
|
-
|
|
442
|
+
queryId: string;
|
|
70
443
|
correlationId: string;
|
|
71
444
|
state: AuthorizationRequestStateStatus;
|
|
72
445
|
error?: string;
|
|
73
446
|
}
|
|
74
447
|
interface IDeleteAuthStateArgs {
|
|
75
448
|
correlationId: string;
|
|
76
|
-
|
|
449
|
+
queryId?: string;
|
|
77
450
|
}
|
|
78
451
|
interface IVerifyAuthResponseStateArgs {
|
|
79
452
|
authorizationResponse: string | AuthorizationResponsePayload;
|
|
80
|
-
|
|
453
|
+
queryId?: string;
|
|
81
454
|
correlationId: string;
|
|
82
455
|
audience?: string;
|
|
83
456
|
dcqlQuery?: DcqlQuery;
|
|
@@ -90,7 +463,7 @@ interface ImportDefinitionsArgs {
|
|
|
90
463
|
}
|
|
91
464
|
interface IGetRedirectUriArgs {
|
|
92
465
|
correlationId: string;
|
|
93
|
-
|
|
466
|
+
queryId?: string;
|
|
94
467
|
state?: string;
|
|
95
468
|
}
|
|
96
469
|
interface IAuthorizationRequestPayloads {
|
|
@@ -103,7 +476,7 @@ interface IPEXDefinitionPersistArgs extends IPEXInstanceOptions {
|
|
|
103
476
|
ttl?: number;
|
|
104
477
|
}
|
|
105
478
|
interface ISiopRPInstanceArgs {
|
|
106
|
-
|
|
479
|
+
queryId?: string;
|
|
107
480
|
responseRedirectURI?: string;
|
|
108
481
|
}
|
|
109
482
|
interface IPEXInstanceOptions extends IPEXOptions {
|
|
@@ -124,7 +497,7 @@ interface IRPOptions {
|
|
|
124
497
|
}
|
|
125
498
|
interface IPEXOptions {
|
|
126
499
|
presentationVerifyCallback?: PresentationVerificationCallback;
|
|
127
|
-
|
|
500
|
+
queryId: string;
|
|
128
501
|
version?: string;
|
|
129
502
|
tenantId?: string;
|
|
130
503
|
}
|
|
@@ -149,9 +522,6 @@ interface ISIOPIdentifierOptions extends Omit<IDIDOptions, 'idOpts'> {
|
|
|
149
522
|
type CredentialOpts = {
|
|
150
523
|
hasher?: HasherSync;
|
|
151
524
|
};
|
|
152
|
-
interface AuthorizationResponseStateWithVerifiedData extends AuthorizationResponseState {
|
|
153
|
-
verifiedData?: AdditionalClaims;
|
|
154
|
-
}
|
|
155
525
|
type IRequiredContext = IAgentContext<IResolver & IDIDManager & IKeyManager & IIdentifierResolution & ICredentialIssuer & ICredentialValidation & ICredentialVerifier & IPresentationExchange & IPDManager & ISDJwtPlugin & IJwtService & ImDLMdoc>;
|
|
156
526
|
|
|
157
527
|
declare class RPInstance {
|
|
@@ -168,15 +538,341 @@ declare class RPInstance {
|
|
|
168
538
|
hasDefinition(): boolean;
|
|
169
539
|
get definitionId(): string | undefined;
|
|
170
540
|
getPresentationDefinition(context: IRequiredContext): Promise<IPresentationDefinition | undefined>;
|
|
171
|
-
createAuthorizationRequestURI(createArgs:
|
|
172
|
-
createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, '
|
|
541
|
+
createAuthorizationRequestURI(createArgs: ICreateAuthRequestArgs, context: IRequiredContext): Promise<URI>;
|
|
542
|
+
createAuthorizationRequest(createArgs: Omit<ICreateAuthRequestArgs, 'queryId'>, context: IRequiredContext): Promise<AuthorizationRequest>;
|
|
173
543
|
}
|
|
174
544
|
|
|
175
545
|
declare class SIOPv2RP implements IAgentPlugin {
|
|
176
546
|
private readonly opts;
|
|
177
547
|
private static readonly _DEFAULT_OPTS_KEY;
|
|
178
548
|
private readonly instances;
|
|
179
|
-
readonly schema:
|
|
549
|
+
readonly schema: {
|
|
550
|
+
components: {
|
|
551
|
+
schemas: {
|
|
552
|
+
IGetSiopSessionArgs: {
|
|
553
|
+
type: string;
|
|
554
|
+
properties: {
|
|
555
|
+
sessionId: {
|
|
556
|
+
type: string;
|
|
557
|
+
};
|
|
558
|
+
additionalProperties: boolean;
|
|
559
|
+
};
|
|
560
|
+
required: string[];
|
|
561
|
+
description: string;
|
|
562
|
+
};
|
|
563
|
+
IRegisterSiopSessionArgs: {
|
|
564
|
+
type: string;
|
|
565
|
+
properties: {
|
|
566
|
+
identifier: {
|
|
567
|
+
type: string;
|
|
568
|
+
properties: {
|
|
569
|
+
did: {
|
|
570
|
+
type: string;
|
|
571
|
+
};
|
|
572
|
+
alias: {
|
|
573
|
+
type: string;
|
|
574
|
+
};
|
|
575
|
+
provider: {
|
|
576
|
+
type: string;
|
|
577
|
+
};
|
|
578
|
+
controllerKeyId: {
|
|
579
|
+
type: string;
|
|
580
|
+
};
|
|
581
|
+
keys: {
|
|
582
|
+
type: string;
|
|
583
|
+
items: {
|
|
584
|
+
type: string;
|
|
585
|
+
properties: {
|
|
586
|
+
additionalProperties: boolean;
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
services: {
|
|
591
|
+
type: string;
|
|
592
|
+
items: {
|
|
593
|
+
type: string;
|
|
594
|
+
properties: {
|
|
595
|
+
additionalProperties: boolean;
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
};
|
|
600
|
+
additionalProperties: boolean;
|
|
601
|
+
required: string[];
|
|
602
|
+
};
|
|
603
|
+
sessionId: {
|
|
604
|
+
type: string;
|
|
605
|
+
};
|
|
606
|
+
expiresIn: {
|
|
607
|
+
type: string;
|
|
608
|
+
};
|
|
609
|
+
additionalProperties: boolean;
|
|
610
|
+
};
|
|
611
|
+
required: string[];
|
|
612
|
+
description: string;
|
|
613
|
+
};
|
|
614
|
+
IRemoveSiopSessionArgs: {
|
|
615
|
+
type: string;
|
|
616
|
+
properties: {
|
|
617
|
+
sessionId: {
|
|
618
|
+
type: string;
|
|
619
|
+
};
|
|
620
|
+
additionalProperties: boolean;
|
|
621
|
+
};
|
|
622
|
+
required: string[];
|
|
623
|
+
description: string;
|
|
624
|
+
};
|
|
625
|
+
IAuthenticateWithSiopArgs: {
|
|
626
|
+
type: string;
|
|
627
|
+
properties: {
|
|
628
|
+
sessionId: {
|
|
629
|
+
type: string;
|
|
630
|
+
};
|
|
631
|
+
stateId: {
|
|
632
|
+
type: string;
|
|
633
|
+
};
|
|
634
|
+
redirectUrl: {
|
|
635
|
+
type: string;
|
|
636
|
+
};
|
|
637
|
+
additionalProperties: boolean;
|
|
638
|
+
};
|
|
639
|
+
required: string[];
|
|
640
|
+
description: string;
|
|
641
|
+
};
|
|
642
|
+
IResponse: {
|
|
643
|
+
type: string;
|
|
644
|
+
properties: {
|
|
645
|
+
status: {
|
|
646
|
+
type: string;
|
|
647
|
+
};
|
|
648
|
+
additionalProperties: boolean;
|
|
649
|
+
};
|
|
650
|
+
required: string[];
|
|
651
|
+
description: string;
|
|
652
|
+
};
|
|
653
|
+
IGetSiopAuthenticationRequestFromRpArgs: {
|
|
654
|
+
type: string;
|
|
655
|
+
properties: {
|
|
656
|
+
sessionId: {
|
|
657
|
+
type: string;
|
|
658
|
+
};
|
|
659
|
+
stateId: {
|
|
660
|
+
type: string;
|
|
661
|
+
};
|
|
662
|
+
redirectUrl: {
|
|
663
|
+
type: string;
|
|
664
|
+
};
|
|
665
|
+
additionalProperties: boolean;
|
|
666
|
+
};
|
|
667
|
+
required: string[];
|
|
668
|
+
description: string;
|
|
669
|
+
};
|
|
670
|
+
ParsedAuthenticationRequestURI: {
|
|
671
|
+
type: string;
|
|
672
|
+
properties: {
|
|
673
|
+
jwt: {
|
|
674
|
+
type: string;
|
|
675
|
+
};
|
|
676
|
+
requestPayload: {
|
|
677
|
+
type: string;
|
|
678
|
+
properties: {
|
|
679
|
+
additionalProperties: boolean;
|
|
680
|
+
};
|
|
681
|
+
};
|
|
682
|
+
registration: {
|
|
683
|
+
type: string;
|
|
684
|
+
properties: {
|
|
685
|
+
additionalProperties: boolean;
|
|
686
|
+
};
|
|
687
|
+
};
|
|
688
|
+
additionalProperties: boolean;
|
|
689
|
+
};
|
|
690
|
+
required: string[];
|
|
691
|
+
description: string;
|
|
692
|
+
};
|
|
693
|
+
IGetSiopAuthenticationRequestDetailsArgs: {
|
|
694
|
+
type: string;
|
|
695
|
+
properties: {
|
|
696
|
+
sessionId: {
|
|
697
|
+
type: string;
|
|
698
|
+
};
|
|
699
|
+
verifiedAuthenticationRequest: {
|
|
700
|
+
type: string;
|
|
701
|
+
properties: {
|
|
702
|
+
additionalProperties: boolean;
|
|
703
|
+
};
|
|
704
|
+
};
|
|
705
|
+
credentialFilter: {
|
|
706
|
+
type: string;
|
|
707
|
+
properties: {
|
|
708
|
+
additionalProperties: boolean;
|
|
709
|
+
};
|
|
710
|
+
};
|
|
711
|
+
additionalProperties: boolean;
|
|
712
|
+
};
|
|
713
|
+
required: string[];
|
|
714
|
+
description: string;
|
|
715
|
+
};
|
|
716
|
+
IAuthRequestDetails: {
|
|
717
|
+
type: string;
|
|
718
|
+
properties: {
|
|
719
|
+
id: {
|
|
720
|
+
type: string;
|
|
721
|
+
};
|
|
722
|
+
alsoKnownAs: {
|
|
723
|
+
type: string;
|
|
724
|
+
items: {
|
|
725
|
+
type: string;
|
|
726
|
+
};
|
|
727
|
+
};
|
|
728
|
+
vpResponseOpts: {
|
|
729
|
+
type: string;
|
|
730
|
+
properties: {
|
|
731
|
+
additionalProperties: boolean;
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
additionalProperties: boolean;
|
|
735
|
+
};
|
|
736
|
+
required: string[];
|
|
737
|
+
description: string;
|
|
738
|
+
};
|
|
739
|
+
IVerifySiopAuthenticationRequestUriArgs: {
|
|
740
|
+
type: string;
|
|
741
|
+
properties: {
|
|
742
|
+
sessionId: {
|
|
743
|
+
type: string;
|
|
744
|
+
};
|
|
745
|
+
ParsedAuthenticationRequestURI: {
|
|
746
|
+
type: string;
|
|
747
|
+
properties: {
|
|
748
|
+
additionalProperties: boolean;
|
|
749
|
+
};
|
|
750
|
+
};
|
|
751
|
+
additionalProperties: boolean;
|
|
752
|
+
};
|
|
753
|
+
required: string[];
|
|
754
|
+
description: string;
|
|
755
|
+
};
|
|
756
|
+
VerifiedAuthorizationRequest: {
|
|
757
|
+
type: string;
|
|
758
|
+
properties: {
|
|
759
|
+
payload: {
|
|
760
|
+
type: string;
|
|
761
|
+
properties: {
|
|
762
|
+
additionalProperties: boolean;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
presentationDefinitions: {
|
|
766
|
+
type: string;
|
|
767
|
+
properties: {
|
|
768
|
+
additionalProperties: boolean;
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
verifyOpts: {
|
|
772
|
+
type: string;
|
|
773
|
+
properties: {
|
|
774
|
+
additionalProperties: boolean;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
additionalProperties: boolean;
|
|
778
|
+
};
|
|
779
|
+
required: string[];
|
|
780
|
+
description: string;
|
|
781
|
+
};
|
|
782
|
+
ISendSiopAuthenticationResponseArgs: {
|
|
783
|
+
type: string;
|
|
784
|
+
properties: {
|
|
785
|
+
sessionId: {
|
|
786
|
+
type: string;
|
|
787
|
+
};
|
|
788
|
+
verifiedAuthenticationRequest: {
|
|
789
|
+
type: string;
|
|
790
|
+
properties: {
|
|
791
|
+
additionalProperties: boolean;
|
|
792
|
+
};
|
|
793
|
+
};
|
|
794
|
+
verifiablePresentationResponse: {
|
|
795
|
+
type: string;
|
|
796
|
+
properties: {
|
|
797
|
+
additionalProperties: boolean;
|
|
798
|
+
};
|
|
799
|
+
};
|
|
800
|
+
additionalProperties: boolean;
|
|
801
|
+
};
|
|
802
|
+
required: string[];
|
|
803
|
+
description: string;
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
methods: {
|
|
807
|
+
getSessionForSiop: {
|
|
808
|
+
description: string;
|
|
809
|
+
arguments: {
|
|
810
|
+
$ref: string;
|
|
811
|
+
};
|
|
812
|
+
returnType: string;
|
|
813
|
+
};
|
|
814
|
+
registerSessionForSiop: {
|
|
815
|
+
description: string;
|
|
816
|
+
arguments: {
|
|
817
|
+
$ref: string;
|
|
818
|
+
};
|
|
819
|
+
returnType: string;
|
|
820
|
+
};
|
|
821
|
+
removeSessionForSiop: {
|
|
822
|
+
description: string;
|
|
823
|
+
arguments: {
|
|
824
|
+
$ref: string;
|
|
825
|
+
};
|
|
826
|
+
returnType: string;
|
|
827
|
+
};
|
|
828
|
+
authenticateWithSiop: {
|
|
829
|
+
description: string;
|
|
830
|
+
arguments: {
|
|
831
|
+
$ref: string;
|
|
832
|
+
};
|
|
833
|
+
returnType: {
|
|
834
|
+
$ref: string;
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
getSiopAuthenticationRequestFromRP: {
|
|
838
|
+
description: string;
|
|
839
|
+
arguments: {
|
|
840
|
+
$ref: string;
|
|
841
|
+
};
|
|
842
|
+
returnType: {
|
|
843
|
+
$ref: string;
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
getSiopAuthenticationRequestDetails: {
|
|
847
|
+
description: string;
|
|
848
|
+
arguments: {
|
|
849
|
+
$ref: string;
|
|
850
|
+
};
|
|
851
|
+
returnType: {
|
|
852
|
+
$ref: string;
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
verifySiopAuthenticationRequestURI: {
|
|
856
|
+
description: string;
|
|
857
|
+
arguments: {
|
|
858
|
+
$ref: string;
|
|
859
|
+
};
|
|
860
|
+
returnType: {
|
|
861
|
+
$ref: string;
|
|
862
|
+
};
|
|
863
|
+
};
|
|
864
|
+
sendSiopAuthenticationResponse: {
|
|
865
|
+
description: string;
|
|
866
|
+
arguments: {
|
|
867
|
+
$ref: string;
|
|
868
|
+
};
|
|
869
|
+
returnType: {
|
|
870
|
+
$ref: string;
|
|
871
|
+
};
|
|
872
|
+
};
|
|
873
|
+
};
|
|
874
|
+
};
|
|
875
|
+
};
|
|
180
876
|
readonly methods: ISIOPv2RP;
|
|
181
877
|
constructor(opts: ISiopv2RPOpts);
|
|
182
878
|
setDefaultOpts(rpDefaultOpts: IRPDefaultOpts, context: IRequiredContext): void;
|
|
@@ -190,18 +886,13 @@ declare class SIOPv2RP implements IAgentPlugin {
|
|
|
190
886
|
private siopVerifyAuthResponse;
|
|
191
887
|
private siopImportDefinitions;
|
|
192
888
|
private siopGetRedirectURI;
|
|
193
|
-
getRPInstance({
|
|
889
|
+
getRPInstance({ queryId, responseRedirectURI }: ISiopRPInstanceArgs, context: IRequiredContext): Promise<RPInstance>;
|
|
194
890
|
getRPOptions(context: IRequiredContext, opts: {
|
|
195
|
-
|
|
891
|
+
queryId?: string;
|
|
196
892
|
responseRedirectURI?: string;
|
|
197
893
|
}): Promise<IRPOptions>;
|
|
198
894
|
getInstanceOpts(definitionId?: string): IPEXInstanceOptions | undefined;
|
|
199
895
|
private getDefaultOptions;
|
|
200
896
|
}
|
|
201
897
|
|
|
202
|
-
|
|
203
|
-
* @public
|
|
204
|
-
*/
|
|
205
|
-
declare const schema: any;
|
|
206
|
-
|
|
207
|
-
export { type AuthorizationResponseStateWithVerifiedData, type CredentialOpts, type IAuthRequestDetails, type IAuthorizationRequestPayloads, type ICreateAuthRequestArgs, type IDeleteAuthStateArgs, type IGetAuthRequestStateArgs, type IGetAuthResponseStateArgs, type IGetRedirectUriArgs, type IPEXDefinitionPersistArgs, type IPEXInstanceOptions, type IPEXOptions, type IRPDefaultOpts, type IRPOptions, type IRequiredContext, type ISIOPIdentifierOptions, type ISIOPv2RP, type ISiopRPInstanceArgs, type ISiopv2RPOpts, type IUpdateRequestStateArgs, type IVerifyAuthResponseStateArgs, type ImportDefinitionsArgs, type PerDidResolver, SIOPv2RP, type VerificationPolicies, VerifiedDataMode, schema };
|
|
898
|
+
export { type CredentialOpts, type IAuthRequestDetails, type IAuthorizationRequestPayloads, type ICreateAuthRequestArgs, type IDeleteAuthStateArgs, type IGetAuthRequestStateArgs, type IGetAuthResponseStateArgs, type IGetRedirectUriArgs, type IPEXDefinitionPersistArgs, type IPEXInstanceOptions, type IPEXOptions, type IRPDefaultOpts, type IRPOptions, type IRequiredContext, type ISIOPIdentifierOptions, type ISIOPv2RP, type ISiopRPInstanceArgs, type ISiopv2RPOpts, type IUpdateRequestStateArgs, type IVerifyAuthResponseStateArgs, type ImportDefinitionsArgs, type PerDidResolver, SIOPv2RP, type VerificationPolicies, VerifiedDataMode, plugin_schema as schema };
|