@sphereon/ssi-sdk.kms-rest-client 0.34.1-feature.IDK.11.49 → 0.34.1-feature.IDK.11.51

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 (10) hide show
  1. package/dist/index.cjs +948 -958
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +1177 -57
  4. package/dist/index.d.ts +1177 -57
  5. package/dist/index.js +941 -952
  6. package/dist/index.js.map +1 -1
  7. package/package.json +3 -3
  8. package/src/agent/KmsRestClient.ts +58 -58
  9. package/src/index.ts +1 -1
  10. package/src/types/IKmsRestClient.ts +34 -34
package/dist/index.d.ts CHANGED
@@ -1,6 +1,1131 @@
1
1
  import { IPluginMethodMap, IAgentContext, IAgentPlugin } from '@veramo/core';
2
2
  import { BearerTokenArg } from '@sphereon/ssi-types';
3
3
 
4
+ var IKmsRestClient$1 = {
5
+ components: {
6
+ schemas: {
7
+ KmsCreateRawSignatureArgs: {
8
+ type: "object",
9
+ additionalProperties: false,
10
+ properties: {
11
+ keyInfo: {
12
+ $ref: "#/components/schemas/KeyInfo"
13
+ },
14
+ input: {
15
+ type: "string"
16
+ },
17
+ baseUrl: {
18
+ type: "string"
19
+ }
20
+ },
21
+ required: [
22
+ "input",
23
+ "keyInfo"
24
+ ]
25
+ },
26
+ KeyInfo: {
27
+ type: "object",
28
+ properties: {
29
+ kid: {
30
+ type: "string",
31
+ description: "Unique identifier for the cryptographic key. Can be null if the key identifier is not provided."
32
+ },
33
+ key: {
34
+ $ref: "#/components/schemas/Jwk"
35
+ },
36
+ signatureAlgorithm: {
37
+ $ref: "#/components/schemas/SignatureAlgorithm"
38
+ },
39
+ keyVisibility: {
40
+ $ref: "#/components/schemas/KeyVisibility"
41
+ },
42
+ x5c: {
43
+ type: "array",
44
+ items: {
45
+ type: "string"
46
+ },
47
+ description: "X.509 certificate chain associated with the key."
48
+ },
49
+ alias: {
50
+ type: "string",
51
+ description: "A reference or alias to the key in the Key Management Service (KMS)."
52
+ },
53
+ providerId: {
54
+ type: "string",
55
+ description: "The Key Management System (KMS) identifier associated with the key."
56
+ },
57
+ keyType: {
58
+ $ref: "#/components/schemas/KeyType"
59
+ },
60
+ keyEncoding: {
61
+ $ref: "#/components/schemas/KeyEncoding"
62
+ },
63
+ opts: {
64
+ type: "object",
65
+ additionalProperties: {
66
+ type: "string"
67
+ },
68
+ description: "Additional configuration options as key-value pairs."
69
+ }
70
+ },
71
+ additionalProperties: false,
72
+ description: "Information about a cryptographic key, providing metadata and configuration details necessary for cryptographic operations."
73
+ },
74
+ Jwk: {
75
+ type: "object",
76
+ properties: {
77
+ kty: {
78
+ $ref: "#/components/schemas/JwkKeyType"
79
+ },
80
+ kid: {
81
+ type: "string",
82
+ description: "Key identifier used to uniquely identify the key."
83
+ },
84
+ alg: {
85
+ type: "string",
86
+ description: "The algorithm intended for use with the key (JWA algorithm name)."
87
+ },
88
+ use: {
89
+ $ref: "#/components/schemas/JwkUse"
90
+ },
91
+ keyOps: {
92
+ type: "array",
93
+ items: {
94
+ $ref: "#/components/schemas/KeyOperations"
95
+ },
96
+ description: "The allowed cryptographic operations for the key."
97
+ },
98
+ crv: {
99
+ $ref: "#/components/schemas/Curve"
100
+ },
101
+ x: {
102
+ type: "string",
103
+ description: "The x coordinate for elliptic curve keys (base64url-encoded)."
104
+ },
105
+ y: {
106
+ type: "string",
107
+ description: "The y coordinate for elliptic curve keys (base64url-encoded)."
108
+ },
109
+ d: {
110
+ type: "string",
111
+ description: "The private key parameter (base64url-encoded)."
112
+ },
113
+ n: {
114
+ type: "string",
115
+ description: "The modulus value for RSA keys (base64url-encoded)."
116
+ },
117
+ e: {
118
+ type: "string",
119
+ description: "The public exponent for RSA keys (base64url-encoded)."
120
+ },
121
+ p: {
122
+ type: "string",
123
+ description: "The first prime factor for RSA private keys (base64url-encoded)."
124
+ },
125
+ q: {
126
+ type: "string",
127
+ description: "The second prime factor for RSA private keys (base64url-encoded)."
128
+ },
129
+ dp: {
130
+ type: "string",
131
+ description: "The first factor CRT exponent for RSA private keys (base64url-encoded)."
132
+ },
133
+ dq: {
134
+ type: "string",
135
+ description: "The second factor CRT exponent for RSA private keys (base64url-encoded)."
136
+ },
137
+ qi: {
138
+ type: "string",
139
+ description: "The first CRT coefficient for RSA private keys (base64url-encoded)."
140
+ },
141
+ k: {
142
+ type: "string",
143
+ description: "The symmetric key value (base64url-encoded)."
144
+ },
145
+ x5c: {
146
+ type: "array",
147
+ items: {
148
+ type: "string"
149
+ },
150
+ description: "X.509 certificate chain as base64-encoded DER certificates."
151
+ },
152
+ x5t: {
153
+ type: "string",
154
+ description: "X.509 certificate SHA-1 thumbprint (base64url-encoded)."
155
+ },
156
+ x5u: {
157
+ type: "string",
158
+ description: "URL pointing to X.509 certificate or certificate chain."
159
+ },
160
+ x5tS256: {
161
+ type: "string",
162
+ description: "X.509 certificate SHA-256 thumbprint (base64url-encoded)."
163
+ }
164
+ },
165
+ required: [
166
+ "kty"
167
+ ],
168
+ additionalProperties: false,
169
+ description: "Represents a JSON Web Key (JWK) as defined by the JSON Web Key specification."
170
+ },
171
+ JwkKeyType: {
172
+ type: "string",
173
+ "enum": [
174
+ "EC",
175
+ "RSA",
176
+ "OKP",
177
+ "oct"
178
+ ],
179
+ description: "JSON Web Key (JWK) key type parameter identifying the cryptographic algorithm family."
180
+ },
181
+ JwkUse: {
182
+ type: "string",
183
+ "enum": [
184
+ "sig",
185
+ "enc"
186
+ ],
187
+ description: "Intended use of the key (signing or encryption)."
188
+ },
189
+ KeyOperations: {
190
+ type: "string",
191
+ "enum": [
192
+ "sign",
193
+ "verify",
194
+ "encrypt",
195
+ "decrypt",
196
+ "wrapKey",
197
+ "unwrapKey",
198
+ "deriveKey",
199
+ "deriveBits"
200
+ ],
201
+ description: "Specific operations the key is intended for."
202
+ },
203
+ Curve: {
204
+ type: "string",
205
+ "enum": [
206
+ "P-256",
207
+ "P-384",
208
+ "P-521",
209
+ "secp256k1",
210
+ "Ed25519",
211
+ "Ed448",
212
+ "X25519",
213
+ "X448"
214
+ ],
215
+ description: "Elliptic curve identifier."
216
+ },
217
+ SignatureAlgorithm: {
218
+ type: "string",
219
+ "enum": [
220
+ "ED25519",
221
+ "ECDSA_SHA256",
222
+ "ECDSA_SHA384",
223
+ "ECDSA_SHA512",
224
+ "ES256K",
225
+ "ECKA_DH_SHA256",
226
+ "HMAC_SHA256",
227
+ "HMAC_SHA384",
228
+ "HMAC_SHA512",
229
+ "RSA_SSA_PSS_SHA256_MGF1",
230
+ "RSA_SSA_PSS_SHA384_MGF1",
231
+ "RSA_SSA_PSS_SHA512_MGF1"
232
+ ],
233
+ description: "Cryptographic signature algorithm identifier."
234
+ },
235
+ KeyVisibility: {
236
+ type: "string",
237
+ "enum": [
238
+ "PUBLIC",
239
+ "PRIVATE"
240
+ ],
241
+ description: "Indicates the visibility status of a cryptographic key."
242
+ },
243
+ KeyType: {
244
+ type: "string",
245
+ "enum": [
246
+ "OKP",
247
+ "EC",
248
+ "RSA"
249
+ ],
250
+ description: "Cryptographic key type identifier."
251
+ },
252
+ KeyEncoding: {
253
+ type: "string",
254
+ "enum": [
255
+ "COSE",
256
+ "JOSE"
257
+ ],
258
+ description: "The encoding format of the cryptographic key."
259
+ },
260
+ CreateRawSignatureResponse: {
261
+ type: "object",
262
+ properties: {
263
+ signature: {
264
+ type: "string",
265
+ description: "The created signature encoded as a base64 string."
266
+ }
267
+ },
268
+ required: [
269
+ "signature"
270
+ ],
271
+ additionalProperties: false,
272
+ description: "Response body containing the created signature."
273
+ },
274
+ KmsDeleteKeyArgs: {
275
+ type: "object",
276
+ properties: {
277
+ baseUrl: {
278
+ type: "string"
279
+ },
280
+ aliasOrKid: {
281
+ type: "string"
282
+ }
283
+ },
284
+ additionalProperties: false
285
+ },
286
+ KmsGenerateKeyArgs: {
287
+ type: "object",
288
+ additionalProperties: false,
289
+ properties: {
290
+ alias: {
291
+ type: "string",
292
+ description: "Alias for the generated key."
293
+ },
294
+ use: {
295
+ $ref: "#/components/schemas/JwkUse"
296
+ },
297
+ keyOperations: {
298
+ type: "array",
299
+ items: {
300
+ $ref: "#/components/schemas/KeyOperations"
301
+ }
302
+ },
303
+ alg: {
304
+ $ref: "#/components/schemas/SignatureAlgorithm"
305
+ },
306
+ providerId: {
307
+ type: "string",
308
+ description: "Optional provider ID. If not specified, the default provider will be used."
309
+ },
310
+ baseUrl: {
311
+ type: "string"
312
+ }
313
+ }
314
+ },
315
+ ManagedKeyPair: {
316
+ type: "object",
317
+ properties: {
318
+ kid: {
319
+ type: "string",
320
+ description: "Key identifier, may be null."
321
+ },
322
+ providerId: {
323
+ type: "string",
324
+ description: "Key Management System identifier."
325
+ },
326
+ alias: {
327
+ type: "string",
328
+ description: "Reference to the key in the KMS."
329
+ },
330
+ cose: {
331
+ $ref: "#/components/schemas/CoseKeyPair"
332
+ },
333
+ jose: {
334
+ $ref: "#/components/schemas/JoseKeyPair"
335
+ }
336
+ },
337
+ required: [
338
+ "providerId",
339
+ "alias",
340
+ "cose",
341
+ "jose"
342
+ ],
343
+ additionalProperties: false,
344
+ description: "Represents a key pair used by a crypto provider, encapsulating both JOSE and COSE key pairs."
345
+ },
346
+ CoseKeyPair: {
347
+ type: "object",
348
+ properties: {
349
+ privateCoseKey: {
350
+ $ref: "#/components/schemas/CoseKey"
351
+ },
352
+ publicCoseKey: {
353
+ $ref: "#/components/schemas/CoseKey"
354
+ }
355
+ },
356
+ required: [
357
+ "publicCoseKey"
358
+ ],
359
+ additionalProperties: false,
360
+ description: "Represents a cryptographic key pair for COSE (CBOR Object Signing and Encryption) operations."
361
+ },
362
+ CoseKey: {
363
+ type: "object",
364
+ properties: {
365
+ kty: {
366
+ $ref: "#/components/schemas/CoseKeyType"
367
+ },
368
+ kid: {
369
+ type: "string",
370
+ description: "Key identifier (base64url-encoded byte string)."
371
+ },
372
+ alg: {
373
+ type: "number",
374
+ description: "The COSE algorithm identifier (e.g., -7=ES256, -35=ES384, -36=ES512, -8=EdDSA)."
375
+ },
376
+ keyOps: {
377
+ type: "array",
378
+ items: {
379
+ type: "number"
380
+ },
381
+ description: "The allowed COSE key operations (1=sign, 2=verify, 3=encrypt, 4=decrypt, etc.)."
382
+ },
383
+ baseIV: {
384
+ type: "string",
385
+ description: "Base initialization vector (base64url-encoded)."
386
+ },
387
+ crv: {
388
+ type: "number",
389
+ description: "The COSE curve identifier (1=P-256, 2=P-384, 3=P-521, 8=secp256k1, 6=Ed25519, etc.)."
390
+ },
391
+ x: {
392
+ type: "string",
393
+ description: "The x coordinate (base64url-encoded byte string)."
394
+ },
395
+ y: {
396
+ type: "string",
397
+ description: "The y coordinate (base64url-encoded byte string)."
398
+ },
399
+ d: {
400
+ type: "string",
401
+ description: "The private key parameter (base64url-encoded byte string)."
402
+ },
403
+ x5chain: {
404
+ type: "array",
405
+ items: {
406
+ type: "string"
407
+ },
408
+ description: "X.509 certificate chain as base64-encoded certificates."
409
+ }
410
+ },
411
+ required: [
412
+ "kty"
413
+ ],
414
+ additionalProperties: false,
415
+ description: "Represents a COSE (CBOR Object Signing and Encryption) key in JSON format."
416
+ },
417
+ CoseKeyType: {
418
+ type: "number",
419
+ "enum": [
420
+ 1,
421
+ 2,
422
+ 3,
423
+ 4
424
+ ],
425
+ description: "COSE key type parameter. 1=OKP (Octet Key Pair), 2=EC2 (Elliptic Curve), 3=RSA, 4=Symmetric."
426
+ },
427
+ JoseKeyPair: {
428
+ type: "object",
429
+ properties: {
430
+ privateJwk: {
431
+ $ref: "#/components/schemas/Jwk"
432
+ },
433
+ publicJwk: {
434
+ $ref: "#/components/schemas/Jwk"
435
+ }
436
+ },
437
+ required: [
438
+ "publicJwk"
439
+ ],
440
+ additionalProperties: false,
441
+ description: "Data class representing a cryptographic key pair used with JOSE (JSON Object Signing and Encryption)."
442
+ },
443
+ KmsGetKeyArgs: {
444
+ type: "object",
445
+ properties: {
446
+ baseUrl: {
447
+ type: "string"
448
+ },
449
+ aliasOrKid: {
450
+ type: "string"
451
+ }
452
+ },
453
+ required: [
454
+ "aliasOrKid"
455
+ ],
456
+ additionalProperties: false
457
+ },
458
+ ManagedKeyInfo: {
459
+ type: "object",
460
+ properties: {
461
+ kid: {
462
+ type: "string",
463
+ description: "Unique identifier for the cryptographic key. Can be null if the key identifier is not provided."
464
+ },
465
+ key: {
466
+ $ref: "#/components/schemas/Jwk"
467
+ },
468
+ signatureAlgorithm: {
469
+ $ref: "#/components/schemas/SignatureAlgorithm"
470
+ },
471
+ keyVisibility: {
472
+ $ref: "#/components/schemas/KeyVisibility"
473
+ },
474
+ x5c: {
475
+ type: "array",
476
+ items: {
477
+ type: "string"
478
+ },
479
+ description: "X.509 certificate chain associated with the key."
480
+ },
481
+ alias: {
482
+ type: "string",
483
+ description: "A reference or alias to the key in the Key Management Service (KMS)."
484
+ },
485
+ providerId: {
486
+ type: "string",
487
+ description: "The Key Management System (KMS) identifier associated with the key."
488
+ },
489
+ keyType: {
490
+ $ref: "#/components/schemas/KeyType"
491
+ },
492
+ keyEncoding: {
493
+ $ref: "#/components/schemas/KeyEncoding"
494
+ },
495
+ opts: {
496
+ type: "object",
497
+ additionalProperties: {
498
+ type: "string"
499
+ },
500
+ description: "Additional configuration options as key-value pairs."
501
+ }
502
+ },
503
+ required: [
504
+ "key",
505
+ "alias",
506
+ "providerId"
507
+ ],
508
+ additionalProperties: false,
509
+ description: "Represents a managed cryptographic key information that is guaranteed to be present and resolved, part of a KMS providing concrete access to the key."
510
+ },
511
+ KmsGetKeyProviderArgs: {
512
+ type: "object",
513
+ properties: {
514
+ baseUrl: {
515
+ type: "string"
516
+ },
517
+ providerId: {
518
+ type: "string"
519
+ }
520
+ },
521
+ additionalProperties: false
522
+ },
523
+ KeyProviderResponse: {
524
+ type: "object",
525
+ properties: {
526
+ providerId: {
527
+ type: "string",
528
+ description: "The unique identifier assigned to the Key Provider instance upon creation."
529
+ },
530
+ type: {
531
+ $ref: "#/components/schemas/KeyProviderType"
532
+ }
533
+ },
534
+ required: [
535
+ "providerId",
536
+ "type"
537
+ ],
538
+ additionalProperties: false,
539
+ description: "Response body containing the details of a Key Provider instance."
540
+ },
541
+ KeyProviderType: {
542
+ type: "string",
543
+ "enum": [
544
+ "SOFTWARE",
545
+ "AZURE_KEYVAULT",
546
+ "AWS_KMS"
547
+ ],
548
+ description: "The type of Key Provider. Determines the required configuration settings. - AZURE_KEYVAULT: Microsoft Azure Key Vault or Managed HSM. - AWS_KMS: Amazon Web Services Key Management Service."
549
+ },
550
+ kmsGetResolverArgs: {
551
+ type: "object",
552
+ properties: {
553
+ baseUrl: {
554
+ type: "string"
555
+ },
556
+ resolverId: {
557
+ type: "string"
558
+ }
559
+ },
560
+ required: [
561
+ "resolverId"
562
+ ],
563
+ additionalProperties: false
564
+ },
565
+ Resolver: {
566
+ type: "object",
567
+ properties: {
568
+ resolverId: {
569
+ type: "string",
570
+ description: "Unique identifier for the resolver."
571
+ },
572
+ supportedIdentifierMethods: {
573
+ type: "array",
574
+ items: {
575
+ $ref: "#/components/schemas/IdentifierMethod"
576
+ },
577
+ description: "List of identifier methods supported by this resolver."
578
+ },
579
+ supportedKeyTypes: {
580
+ type: "array",
581
+ items: {
582
+ $ref: "#/components/schemas/KeyType"
583
+ },
584
+ description: "List of key types supported by this resolver."
585
+ }
586
+ },
587
+ required: [
588
+ "resolverId"
589
+ ],
590
+ additionalProperties: false,
591
+ description: "Represents a key resolver configuration."
592
+ },
593
+ IdentifierMethod: {
594
+ type: "string",
595
+ "enum": [
596
+ "JWK",
597
+ "KID",
598
+ "COSE_KEY",
599
+ "X5C",
600
+ "DID"
601
+ ],
602
+ description: "Method used to identify cryptographic keys."
603
+ },
604
+ KmsIsValidRawSignatureArgs: {
605
+ type: "object",
606
+ additionalProperties: false,
607
+ properties: {
608
+ keyInfo: {
609
+ $ref: "#/components/schemas/KeyInfo"
610
+ },
611
+ input: {
612
+ type: "string"
613
+ },
614
+ signature: {
615
+ type: "string"
616
+ },
617
+ baseUrl: {
618
+ type: "string"
619
+ }
620
+ },
621
+ required: [
622
+ "input",
623
+ "keyInfo",
624
+ "signature"
625
+ ]
626
+ },
627
+ VerifyRawSignatureResponse: {
628
+ type: "object",
629
+ properties: {
630
+ isValid: {
631
+ type: "boolean",
632
+ description: "Indicates whether the signature is valid or not."
633
+ }
634
+ },
635
+ required: [
636
+ "isValid"
637
+ ],
638
+ additionalProperties: false,
639
+ description: "Response body containing the details of the signature verification."
640
+ },
641
+ KmsListKeyProvidersArgs: {
642
+ type: "object",
643
+ properties: {
644
+ baseUrl: {
645
+ type: "string"
646
+ }
647
+ },
648
+ additionalProperties: false
649
+ },
650
+ ListKeyProvidersResponse: {
651
+ type: "object",
652
+ properties: {
653
+ providers: {
654
+ type: "array",
655
+ items: {
656
+ $ref: "#/components/schemas/KeyProvider"
657
+ }
658
+ }
659
+ },
660
+ required: [
661
+ "providers"
662
+ ],
663
+ additionalProperties: false,
664
+ description: "Response body containing the details of a Key Provider instance."
665
+ },
666
+ KeyProvider: {
667
+ type: "object",
668
+ properties: {
669
+ providerId: {
670
+ type: "string",
671
+ description: "The unique identifier assigned to the Key Provider instance upon creation."
672
+ },
673
+ type: {
674
+ $ref: "#/components/schemas/KeyProviderType"
675
+ }
676
+ },
677
+ required: [
678
+ "providerId",
679
+ "type"
680
+ ],
681
+ additionalProperties: false,
682
+ description: "Response body containing the details of a Key Provider instance."
683
+ },
684
+ KmsListKeysArgs: {
685
+ type: "object",
686
+ properties: {
687
+ baseUrl: {
688
+ type: "string"
689
+ },
690
+ providerId: {
691
+ type: "string"
692
+ }
693
+ },
694
+ additionalProperties: false
695
+ },
696
+ ListKeysResponse: {
697
+ type: "object",
698
+ properties: {
699
+ keyInfos: {
700
+ type: "array",
701
+ items: {
702
+ $ref: "#/components/schemas/ManagedKeyInfo"
703
+ }
704
+ }
705
+ },
706
+ required: [
707
+ "keyInfos"
708
+ ],
709
+ additionalProperties: false,
710
+ description: "Response body containing all the managed keys."
711
+ },
712
+ KmsListResolversArgs: {
713
+ type: "object",
714
+ properties: {
715
+ baseUrl: {
716
+ type: "string"
717
+ }
718
+ },
719
+ additionalProperties: false
720
+ },
721
+ ListResolversResponse: {
722
+ type: "object",
723
+ properties: {
724
+ resolvers: {
725
+ type: "array",
726
+ items: {
727
+ $ref: "#/components/schemas/Resolver"
728
+ }
729
+ }
730
+ },
731
+ required: [
732
+ "resolvers"
733
+ ],
734
+ additionalProperties: false,
735
+ description: "Response body containing all the resolvers."
736
+ },
737
+ KmsProviderDeleteKeyArgs: {
738
+ type: "object",
739
+ properties: {
740
+ baseUrl: {
741
+ type: "string"
742
+ },
743
+ providerId: {
744
+ type: "string"
745
+ },
746
+ aliasOrKid: {
747
+ type: "string"
748
+ }
749
+ },
750
+ required: [
751
+ "providerId",
752
+ "aliasOrKid"
753
+ ],
754
+ additionalProperties: false
755
+ },
756
+ KmsProviderGenerateKey: {
757
+ type: "object",
758
+ additionalProperties: false,
759
+ properties: {
760
+ alias: {
761
+ type: "string",
762
+ description: "Alias for the generated key."
763
+ },
764
+ use: {
765
+ $ref: "#/components/schemas/JwkUse"
766
+ },
767
+ keyOperations: {
768
+ type: "array",
769
+ items: {
770
+ $ref: "#/components/schemas/KeyOperations"
771
+ }
772
+ },
773
+ alg: {
774
+ $ref: "#/components/schemas/SignatureAlgorithm"
775
+ },
776
+ baseUrl: {
777
+ type: "string"
778
+ },
779
+ providerId: {
780
+ type: "string"
781
+ }
782
+ },
783
+ required: [
784
+ "providerId"
785
+ ]
786
+ },
787
+ KmsProviderGetKeyArgs: {
788
+ type: "object",
789
+ properties: {
790
+ baseUrl: {
791
+ type: "string"
792
+ },
793
+ providerId: {
794
+ type: "string"
795
+ },
796
+ aliasOrKid: {
797
+ type: "string"
798
+ }
799
+ },
800
+ required: [
801
+ "providerId",
802
+ "aliasOrKid"
803
+ ],
804
+ additionalProperties: false
805
+ },
806
+ KmsProviderListKeysArgs: {
807
+ type: "object",
808
+ properties: {
809
+ baseUrl: {
810
+ type: "string"
811
+ },
812
+ providerId: {
813
+ type: "string"
814
+ }
815
+ },
816
+ required: [
817
+ "providerId"
818
+ ],
819
+ additionalProperties: false
820
+ },
821
+ KmsProviderStoreKey: {
822
+ type: "object",
823
+ additionalProperties: false,
824
+ properties: {
825
+ keyInfo: {
826
+ $ref: "#/components/schemas/ResolvedKeyInfo"
827
+ },
828
+ certChain: {
829
+ type: "array",
830
+ items: {
831
+ type: "string"
832
+ },
833
+ description: "X.509 certificate chain as base64-encoded DER certificates."
834
+ },
835
+ baseUrl: {
836
+ type: "string"
837
+ },
838
+ providerId: {
839
+ type: "string"
840
+ }
841
+ },
842
+ required: [
843
+ "keyInfo",
844
+ "providerId"
845
+ ]
846
+ },
847
+ ResolvedKeyInfo: {
848
+ type: "object",
849
+ properties: {
850
+ kid: {
851
+ type: "string",
852
+ description: "Unique identifier for the cryptographic key. Can be null if the key identifier is not provided."
853
+ },
854
+ key: {
855
+ $ref: "#/components/schemas/Jwk"
856
+ },
857
+ signatureAlgorithm: {
858
+ $ref: "#/components/schemas/SignatureAlgorithm"
859
+ },
860
+ keyVisibility: {
861
+ $ref: "#/components/schemas/KeyVisibility"
862
+ },
863
+ x5c: {
864
+ type: "array",
865
+ items: {
866
+ type: "string"
867
+ },
868
+ description: "X.509 certificate chain associated with the key."
869
+ },
870
+ alias: {
871
+ type: "string",
872
+ description: "A reference or alias to the key in the Key Management Service (KMS)."
873
+ },
874
+ providerId: {
875
+ type: "string",
876
+ description: "The Key Management System (KMS) identifier associated with the key."
877
+ },
878
+ keyType: {
879
+ $ref: "#/components/schemas/KeyType"
880
+ },
881
+ keyEncoding: {
882
+ $ref: "#/components/schemas/KeyEncoding"
883
+ },
884
+ opts: {
885
+ type: "object",
886
+ additionalProperties: {
887
+ type: "string"
888
+ },
889
+ description: "Additional configuration options as key-value pairs."
890
+ }
891
+ },
892
+ required: [
893
+ "key"
894
+ ],
895
+ additionalProperties: false,
896
+ description: "Represents a resolved cryptographic key information where the key is guaranteed to be present and resolved, providing concrete access to the key."
897
+ },
898
+ KmsResolveKeyArgs: {
899
+ type: "object",
900
+ additionalProperties: false,
901
+ properties: {
902
+ keyInfo: {
903
+ $ref: "#/components/schemas/KeyInfo"
904
+ },
905
+ identifierMethod: {
906
+ $ref: "#/components/schemas/IdentifierMethod"
907
+ },
908
+ trustedCerts: {
909
+ type: "array",
910
+ items: {
911
+ type: "string"
912
+ },
913
+ description: "Optional array of trusted certificates (base64-encoded) that may be used in the resolution process."
914
+ },
915
+ verifyX509CertificateChain: {
916
+ type: "boolean",
917
+ description: "Optional boolean indicating whether the X.509 certificate chain should be verified."
918
+ },
919
+ baseUrl: {
920
+ type: "string"
921
+ },
922
+ resolverId: {
923
+ $ref: "#/components/schemas/String"
924
+ }
925
+ },
926
+ required: [
927
+ "keyInfo",
928
+ "resolverId"
929
+ ]
930
+ },
931
+ "String": {
932
+ type: "object",
933
+ properties: {
934
+ length: {
935
+ type: "number"
936
+ }
937
+ },
938
+ required: [
939
+ "length"
940
+ ],
941
+ additionalProperties: {
942
+ type: "string"
943
+ }
944
+ },
945
+ KmsStoreKeyArgs: {
946
+ type: "object",
947
+ additionalProperties: false,
948
+ properties: {
949
+ keyInfo: {
950
+ $ref: "#/components/schemas/ResolvedKeyInfo"
951
+ },
952
+ certChain: {
953
+ type: "array",
954
+ items: {
955
+ type: "string"
956
+ },
957
+ description: "X.509 certificate chain as base64-encoded DER certificates."
958
+ },
959
+ baseUrl: {
960
+ type: "string"
961
+ }
962
+ },
963
+ required: [
964
+ "keyInfo"
965
+ ]
966
+ }
967
+ },
968
+ methods: {
969
+ kmsCreateRawSignature: {
970
+ description: "",
971
+ "arguments": {
972
+ $ref: "#/components/schemas/KmsCreateRawSignatureArgs"
973
+ },
974
+ returnType: {
975
+ $ref: "#/components/schemas/CreateRawSignatureResponse"
976
+ }
977
+ },
978
+ kmsDeleteKey: {
979
+ description: "",
980
+ "arguments": {
981
+ $ref: "#/components/schemas/KmsDeleteKeyArgs"
982
+ },
983
+ returnType: {
984
+ type: "boolean"
985
+ }
986
+ },
987
+ kmsGenerateKey: {
988
+ description: "",
989
+ "arguments": {
990
+ $ref: "#/components/schemas/KmsGenerateKeyArgs"
991
+ },
992
+ returnType: {
993
+ $ref: "#/components/schemas/ManagedKeyPair"
994
+ }
995
+ },
996
+ kmsGetKey: {
997
+ description: "",
998
+ "arguments": {
999
+ $ref: "#/components/schemas/KmsGetKeyArgs"
1000
+ },
1001
+ returnType: {
1002
+ $ref: "#/components/schemas/ManagedKeyInfo"
1003
+ }
1004
+ },
1005
+ kmsGetKeyProvider: {
1006
+ description: "",
1007
+ "arguments": {
1008
+ $ref: "#/components/schemas/KmsGetKeyProviderArgs"
1009
+ },
1010
+ returnType: {
1011
+ $ref: "#/components/schemas/KeyProviderResponse"
1012
+ }
1013
+ },
1014
+ kmsGetResolver: {
1015
+ description: "",
1016
+ "arguments": {
1017
+ $ref: "#/components/schemas/kmsGetResolverArgs"
1018
+ },
1019
+ returnType: {
1020
+ $ref: "#/components/schemas/Resolver"
1021
+ }
1022
+ },
1023
+ kmsIsValidRawSignature: {
1024
+ description: "",
1025
+ "arguments": {
1026
+ $ref: "#/components/schemas/KmsIsValidRawSignatureArgs"
1027
+ },
1028
+ returnType: {
1029
+ $ref: "#/components/schemas/VerifyRawSignatureResponse"
1030
+ }
1031
+ },
1032
+ kmsListKeyProviders: {
1033
+ description: "",
1034
+ "arguments": {
1035
+ $ref: "#/components/schemas/KmsListKeyProvidersArgs"
1036
+ },
1037
+ returnType: {
1038
+ $ref: "#/components/schemas/ListKeyProvidersResponse"
1039
+ }
1040
+ },
1041
+ kmsListKeys: {
1042
+ description: "",
1043
+ "arguments": {
1044
+ $ref: "#/components/schemas/KmsListKeysArgs"
1045
+ },
1046
+ returnType: {
1047
+ $ref: "#/components/schemas/ListKeysResponse"
1048
+ }
1049
+ },
1050
+ kmsListResolvers: {
1051
+ description: "",
1052
+ "arguments": {
1053
+ $ref: "#/components/schemas/KmsListResolversArgs"
1054
+ },
1055
+ returnType: {
1056
+ $ref: "#/components/schemas/ListResolversResponse"
1057
+ }
1058
+ },
1059
+ kmsProviderDeleteKey: {
1060
+ description: "",
1061
+ "arguments": {
1062
+ $ref: "#/components/schemas/KmsProviderDeleteKeyArgs"
1063
+ },
1064
+ returnType: {
1065
+ type: "boolean"
1066
+ }
1067
+ },
1068
+ kmsProviderGenerateKey: {
1069
+ description: "",
1070
+ "arguments": {
1071
+ $ref: "#/components/schemas/KmsProviderGenerateKey"
1072
+ },
1073
+ returnType: {
1074
+ $ref: "#/components/schemas/ManagedKeyPair"
1075
+ }
1076
+ },
1077
+ kmsProviderGetKey: {
1078
+ description: "",
1079
+ "arguments": {
1080
+ $ref: "#/components/schemas/KmsProviderGetKeyArgs"
1081
+ },
1082
+ returnType: {
1083
+ $ref: "#/components/schemas/ManagedKeyInfo"
1084
+ }
1085
+ },
1086
+ kmsProviderListKeys: {
1087
+ description: "",
1088
+ "arguments": {
1089
+ $ref: "#/components/schemas/KmsProviderListKeysArgs"
1090
+ },
1091
+ returnType: {
1092
+ $ref: "#/components/schemas/ListKeysResponse"
1093
+ }
1094
+ },
1095
+ kmsProviderStoreKey: {
1096
+ description: "",
1097
+ "arguments": {
1098
+ $ref: "#/components/schemas/KmsProviderStoreKey"
1099
+ },
1100
+ returnType: {
1101
+ $ref: "#/components/schemas/ManagedKeyInfo"
1102
+ }
1103
+ },
1104
+ kmsResolveKey: {
1105
+ description: "",
1106
+ "arguments": {
1107
+ $ref: "#/components/schemas/KmsResolveKeyArgs"
1108
+ },
1109
+ returnType: {
1110
+ $ref: "#/components/schemas/ResolvedKeyInfo"
1111
+ }
1112
+ },
1113
+ kmsStoreKey: {
1114
+ description: "",
1115
+ "arguments": {
1116
+ $ref: "#/components/schemas/KmsStoreKeyArgs"
1117
+ },
1118
+ returnType: {
1119
+ $ref: "#/components/schemas/ManagedKeyInfo"
1120
+ }
1121
+ }
1122
+ }
1123
+ }
1124
+ };
1125
+ var plugin_schema = {
1126
+ IKmsRestClient: IKmsRestClient$1
1127
+ };
1128
+
4
1129
  /**
5
1130
  * KMS REST Server API
6
1131
  * A REST API for managing cryptographic keys and performing signing and verification operations.
@@ -1320,84 +2445,84 @@ interface VerifyRawSignatureResponse {
1320
2445
  }
1321
2446
 
1322
2447
  interface IKmsRestClient extends IPluginMethodMap {
1323
- kmsGetResolver(args: kmsGetResolverArgs): Promise<Resolver>;
1324
- kmsListResolvers(args: KmsListResolversArgs): Promise<ListResolversResponse>;
1325
- kmsResolveKey(args: KmsResolveKeyArgs): Promise<ResolvedKeyInfo>;
1326
- kmsCreateRawSignature(args: KmsCreateRawSignatureArgs): Promise<CreateRawSignatureResponse>;
1327
- kmsIsValidRawSignature(args: KmsIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse>;
1328
- kmsGetKey(args: KmsGetKeyArgs): Promise<ManagedKeyInfo>;
1329
- kmsListKeys(args: KmsListKeysArgs): Promise<ListKeysResponse>;
1330
- kmsStoreKey(args: KmsStoreKeyArgs): Promise<ManagedKeyInfo>;
1331
- kmsGenerateKey(args: KmsGenerateKeyArgs): Promise<ManagedKeyPair>;
1332
- kmsDeleteKey(args: KmsDeleteKeyArgs): Promise<boolean>;
1333
- kmsGetKeyProvider(args: KmsGetKeyProviderArgs): Promise<KeyProviderResponse>;
1334
- kmsListKeyProviders(args: KmsListKeyProvidersArgs): Promise<ListKeyProvidersResponse>;
1335
- kmsProviderListKeys(args: KmsProviderListKeysArgs): Promise<ListKeysResponse>;
1336
- kmsProviderStoreKey(args: KmsProviderStoreKey): Promise<ManagedKeyInfo>;
1337
- kmsProviderGenerateKey(args: KmsProviderGenerateKey): Promise<ManagedKeyPair>;
1338
- kmsProviderGetKey(args: KmsProviderGetKeyArgs): Promise<ManagedKeyInfo>;
1339
- kmsProviderDeleteKey(args: KmsProviderDeleteKeyArgs): Promise<boolean>;
2448
+ kmsClientGetResolver(args: kmsClientGetResolverArgs): Promise<Resolver>;
2449
+ kmsClientListResolvers(args: KmsClientListResolversArgs): Promise<ListResolversResponse>;
2450
+ kmsClientResolveKey(args: KmsClientResolveKeyArgs): Promise<ResolvedKeyInfo>;
2451
+ kmsClientCreateRawSignature(args: KmsClientCreateRawSignatureArgs): Promise<CreateRawSignatureResponse>;
2452
+ kmsClientIsValidRawSignature(args: KmsClientIsValidRawSignatureArgs): Promise<VerifyRawSignatureResponse>;
2453
+ kmsClientGetKey(args: KmsClientGetKeyArgs): Promise<ManagedKeyInfo>;
2454
+ kmsClientListKeys(args: KmsClientListKeysArgs): Promise<ListKeysResponse>;
2455
+ kmsClientStoreKey(args: KmsClientStoreKeyArgs): Promise<ManagedKeyInfo>;
2456
+ kmsClientGenerateKey(args: KmsClientGenerateKeyArgs): Promise<ManagedKeyPair>;
2457
+ kmsClientDeleteKey(args: KmsClientDeleteKeyArgs): Promise<boolean>;
2458
+ kmsClientGetKeyProvider(args: KmsClientGetKeyProviderArgs): Promise<KeyProviderResponse>;
2459
+ kmsClientListKeyProviders(args: KmsClientListKeyProvidersArgs): Promise<ListKeyProvidersResponse>;
2460
+ kmsClientProviderListKeys(args: KmsClientProviderListKeysArgs): Promise<ListKeysResponse>;
2461
+ kmsClientProviderStoreKey(args: KmsClientProviderStoreKey): Promise<ManagedKeyInfo>;
2462
+ kmsClientProviderGenerateKey(args: KmsClientProviderGenerateKey): Promise<ManagedKeyPair>;
2463
+ kmsClientProviderGetKey(args: KmsClientProviderGetKeyArgs): Promise<ManagedKeyInfo>;
2464
+ kmsClientProviderDeleteKey(args: KmsClientProviderDeleteKeyArgs): Promise<boolean>;
1340
2465
  }
1341
- type KmsListResolversArgs = {
2466
+ type KmsClientListResolversArgs = {
1342
2467
  baseUrl?: string;
1343
2468
  };
1344
- type kmsGetResolverArgs = {
2469
+ type kmsClientGetResolverArgs = {
1345
2470
  baseUrl?: string;
1346
2471
  resolverId: string;
1347
2472
  };
1348
- type KmsResolveKeyArgs = {
2473
+ type KmsClientResolveKeyArgs = {
1349
2474
  baseUrl?: string;
1350
2475
  resolverId: String;
1351
2476
  } & ResolvePublicKey;
1352
- type KmsCreateRawSignatureArgs = {
2477
+ type KmsClientCreateRawSignatureArgs = {
1353
2478
  baseUrl?: string;
1354
2479
  } & CreateRawSignature;
1355
- type KmsIsValidRawSignatureArgs = {
2480
+ type KmsClientIsValidRawSignatureArgs = {
1356
2481
  baseUrl?: string;
1357
2482
  } & VerifyRawSignature;
1358
- type KmsGetKeyArgs = {
2483
+ type KmsClientGetKeyArgs = {
1359
2484
  baseUrl?: string;
1360
2485
  aliasOrKid: string;
1361
2486
  };
1362
- type KmsListKeysArgs = {
2487
+ type KmsClientListKeysArgs = {
1363
2488
  baseUrl?: string;
1364
2489
  providerId?: string;
1365
2490
  };
1366
- type KmsStoreKeyArgs = {
2491
+ type KmsClientStoreKeyArgs = {
1367
2492
  baseUrl?: string;
1368
2493
  } & StoreKey;
1369
- type KmsGenerateKeyArgs = {
2494
+ type KmsClientGenerateKeyArgs = {
1370
2495
  baseUrl?: string;
1371
2496
  } & GenerateKeyGlobal;
1372
- type KmsDeleteKeyArgs = {
2497
+ type KmsClientDeleteKeyArgs = {
1373
2498
  baseUrl?: string;
1374
2499
  aliasOrKid?: string;
1375
2500
  };
1376
- type KmsGetKeyProviderArgs = {
2501
+ type KmsClientGetKeyProviderArgs = {
1377
2502
  baseUrl?: string;
1378
2503
  providerId?: string;
1379
2504
  };
1380
- type KmsListKeyProvidersArgs = {
2505
+ type KmsClientListKeyProvidersArgs = {
1381
2506
  baseUrl?: string;
1382
2507
  };
1383
- type KmsProviderListKeysArgs = {
2508
+ type KmsClientProviderListKeysArgs = {
1384
2509
  baseUrl?: string;
1385
2510
  providerId: string;
1386
2511
  };
1387
- type KmsProviderStoreKey = {
2512
+ type KmsClientProviderStoreKey = {
1388
2513
  baseUrl?: string;
1389
2514
  providerId: string;
1390
2515
  } & StoreKey;
1391
- type KmsProviderGenerateKey = {
2516
+ type KmsClientProviderGenerateKey = {
1392
2517
  baseUrl?: string;
1393
2518
  providerId: string;
1394
2519
  } & GenerateKey;
1395
- type KmsProviderGetKeyArgs = {
2520
+ type KmsClientProviderGetKeyArgs = {
1396
2521
  baseUrl?: string;
1397
2522
  providerId: string;
1398
2523
  aliasOrKid: string;
1399
2524
  };
1400
- type KmsProviderDeleteKeyArgs = {
2525
+ type KmsClientProviderDeleteKeyArgs = {
1401
2526
  baseUrl?: string;
1402
2527
  providerId: string;
1403
2528
  aliasOrKid: string;
@@ -1422,47 +2547,42 @@ declare class KmsRestClient implements IAgentPlugin {
1422
2547
  constructor(args?: KmsRestClientArgs);
1423
2548
  private static urlWithBase;
1424
2549
  /** {@inheritDoc IKmsRestClient.kmsGetResolver} */
1425
- private kmsGetResolver;
2550
+ private kmsClientGetResolver;
1426
2551
  /** {@inheritDoc IKmsRestClient.kmsListResolvers} */
1427
- private kmsListResolvers;
2552
+ private kmsClientListResolvers;
1428
2553
  /** {@inheritDoc IKmsRestClient.kmsResolveKey} */
1429
- private kmsResolveKey;
2554
+ private kmsClientResolveKey;
1430
2555
  /** {@inheritDoc IKmsRestClient.kmsCreateRawSignature} */
1431
- private kmsCreateRawSignature;
2556
+ private kmsClientCreateRawSignature;
1432
2557
  /** {@inheritDoc IKmsRestClient.kmsIsValidRawSignature} */
1433
- private kmsIsValidRawSignature;
2558
+ private kmsClientIsValidRawSignature;
1434
2559
  /** {@inheritDoc IKmsRestClient.kmsGetKey} */
1435
- private kmsGetKey;
2560
+ private kmsClientGetKey;
1436
2561
  /** {@inheritDoc IKmsRestClient.kmsListKeys} */
1437
- private kmsListKeys;
2562
+ private kmsClientListKeys;
1438
2563
  /** {@inheritDoc IKmsRestClient.kmsStoreKey} */
1439
- private kmsStoreKey;
2564
+ private kmsClientStoreKey;
1440
2565
  /** {@inheritDoc IKmsRestClient.kmsGenerateKey} */
1441
- private kmsGenerateKey;
2566
+ private kmsClientGenerateKey;
1442
2567
  /** {@inheritDoc IKmsRestClient.kmsDeleteKey} */
1443
- private kmsDeleteKey;
2568
+ private kmsClientDeleteKey;
1444
2569
  /** {@inheritDoc IKmsRestClient.kmsGetKeyProvider} */
1445
- private kmsGetKeyProvider;
2570
+ private kmsClientGetKeyProvider;
1446
2571
  /** {@inheritDoc IKmsRestClient.kmsListKeyProviders} */
1447
- private kmsListKeyProviders;
2572
+ private kmsClientListKeyProviders;
1448
2573
  /** {@inheritDoc IKmsRestClient.kmsProviderListKeys} */
1449
- private kmsProviderListKeys;
2574
+ private kmsClientProviderListKeys;
1450
2575
  /** {@inheritDoc IKmsRestClient.kmsProviderStoreKey} */
1451
- private kmsProviderStoreKey;
2576
+ private kmsClientProviderStoreKey;
1452
2577
  /** {@inheritDoc IKmsRestClient.kmsProviderGenerateKey} */
1453
- private kmsProviderGenerateKey;
2578
+ private kmsClientProviderGenerateKey;
1454
2579
  /** {@inheritDoc IKmsRestClient.kmsProviderGetKey} */
1455
- private kmsProviderGetKey;
2580
+ private kmsClientProviderGetKey;
1456
2581
  /** {@inheritDoc IKmsRestClient.kmsProviderDeleteKey} */
1457
- private kmsProviderDeleteKey;
2582
+ private kmsClientProviderDeleteKey;
1458
2583
  private assertedAgentBaseUrl;
1459
2584
  private createHeaders;
1460
2585
  private addSearchParams;
1461
2586
  }
1462
2587
 
1463
- /**
1464
- * @public
1465
- */
1466
- declare const schema: any;
1467
-
1468
- export { type IKmsRestClient, type IRequiredContext, type KmsCreateRawSignatureArgs, type KmsDeleteKeyArgs, type KmsGenerateKeyArgs, type KmsGetKeyArgs, type KmsGetKeyProviderArgs, type KmsIsValidRawSignatureArgs, type KmsListKeyProvidersArgs, type KmsListKeysArgs, type KmsListResolversArgs, type KmsProviderDeleteKeyArgs, type KmsProviderGenerateKey, type KmsProviderGetKeyArgs, type KmsProviderListKeysArgs, type KmsProviderStoreKey, type KmsResolveKeyArgs, KmsRestClient, type KmsRestClientArgs, type KmsStoreKeyArgs, type RestClientAuthenticationOpts, type kmsGetResolverArgs, schema };
2588
+ export { type IKmsRestClient, type IRequiredContext, type KmsClientCreateRawSignatureArgs, type KmsClientDeleteKeyArgs, type KmsClientGenerateKeyArgs, type KmsClientGetKeyArgs, type KmsClientGetKeyProviderArgs, type KmsClientIsValidRawSignatureArgs, type KmsClientListKeyProvidersArgs, type KmsClientListKeysArgs, type KmsClientListResolversArgs, type KmsClientProviderDeleteKeyArgs, type KmsClientProviderGenerateKey, type KmsClientProviderGetKeyArgs, type KmsClientProviderListKeysArgs, type KmsClientProviderStoreKey, type KmsClientResolveKeyArgs, type KmsClientStoreKeyArgs, KmsRestClient, type KmsRestClientArgs, type RestClientAuthenticationOpts, type kmsClientGetResolverArgs, plugin_schema as schema };