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