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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sphereon/ssi-sdk.kms-rest-client",
   "description": "contains the client side to call REST endpoints of a KMS server",
-  "version": "0.34.1-feature.IDK.11.48+640da718",
+  "version": "0.34.1-feature.IDK.11.49+19dd3372",
   "source": "src/index.ts",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -28,7 +28,7 @@
     "generate-plugin-schema": "tsx ../../packages/dev/bin/sphereon.js dev generate-plugin-schema"
   },
   "dependencies": {
-    "@sphereon/ssi-types": "0.34.1-feature.IDK.11.48+640da718",
+    "@sphereon/ssi-types": "0.34.1-feature.IDK.11.49+19dd3372",
     "cross-fetch": "^3.1.8"
   },
   "devDependencies": {
@@ -56,5 +56,5 @@
     "KMS",
     "REST"
   ],
-  "gitHead": "640da718d6ce394653ae6ef0276b584b2b7456df"
+  "gitHead": "19dd33727e96d37a7b9c9ff3dadcbfd2d1885d09"
 }

package/plugin.schema.json

@@ -16,10 +16,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "input",
-            "keyInfo"
-          ]
+          "required": ["input", "keyInfo"]
         },
         "KeyInfo": {
           "type": "object",
@@ -160,56 +157,28 @@
               "description": "X.509 certificate SHA-256 thumbprint (base64url-encoded)."
             }
           },
-          "required": [
-            "kty"
-          ],
+          "required": ["kty"],
           "additionalProperties": false,
           "description": "Represents a JSON Web Key (JWK) as defined by the JSON Web Key specification."
         },
         "JwkKeyType": {
           "type": "string",
-          "enum": [
-            "EC",
-            "RSA",
-            "OKP",
-            "oct"
-          ],
+          "enum": ["EC", "RSA", "OKP", "oct"],
           "description": "JSON Web Key (JWK) key type parameter identifying the cryptographic algorithm family."
         },
         "JwkUse": {
           "type": "string",
-          "enum": [
-            "sig",
-            "enc"
-          ],
+          "enum": ["sig", "enc"],
           "description": "Intended use of the key (signing or encryption)."
         },
         "KeyOperations": {
           "type": "string",
-          "enum": [
-            "sign",
-            "verify",
-            "encrypt",
-            "decrypt",
-            "wrapKey",
-            "unwrapKey",
-            "deriveKey",
-            "deriveBits"
-          ],
+          "enum": ["sign", "verify", "encrypt", "decrypt", "wrapKey", "unwrapKey", "deriveKey", "deriveBits"],
           "description": "Specific operations the key is intended for."
         },
         "Curve": {
           "type": "string",
-          "enum": [
-            "P-256",
-            "P-384",
-            "P-521",
-            "secp256k1",
-            "Ed25519",
-            "Ed448",
-            "X25519",
-            "X448"
-          ],
+          "enum": ["P-256", "P-384", "P-521", "secp256k1", "Ed25519", "Ed448", "X25519", "X448"],
           "description": "Elliptic curve identifier."
         },
         "SignatureAlgorithm": {
@@ -232,27 +201,17 @@
         },
         "KeyVisibility": {
           "type": "string",
-          "enum": [
-            "PUBLIC",
-            "PRIVATE"
-          ],
+          "enum": ["PUBLIC", "PRIVATE"],
           "description": "Indicates the visibility status of a cryptographic key."
         },
         "KeyType": {
           "type": "string",
-          "enum": [
-            "OKP",
-            "EC",
-            "RSA"
-          ],
+          "enum": ["OKP", "EC", "RSA"],
           "description": "Cryptographic key type identifier."
         },
         "KeyEncoding": {
           "type": "string",
-          "enum": [
-            "COSE",
-            "JOSE"
-          ],
+          "enum": ["COSE", "JOSE"],
           "description": "The encoding format of the cryptographic key."
         },
         "CreateRawSignatureResponse": {
@@ -263,9 +222,7 @@
               "description": "The created signature encoded as a base64 string."
             }
           },
-          "required": [
-            "signature"
-          ],
+          "required": ["signature"],
           "additionalProperties": false,
           "description": "Response body containing the created signature."
         },
@@ -332,12 +289,7 @@
               "$ref": "#/components/schemas/JoseKeyPair"
             }
           },
-          "required": [
-            "providerId",
-            "alias",
-            "cose",
-            "jose"
-          ],
+          "required": ["providerId", "alias", "cose", "jose"],
           "additionalProperties": false,
           "description": "Represents a key pair used by a crypto provider, encapsulating both JOSE and COSE key pairs."
         },
@@ -351,9 +303,7 @@
               "$ref": "#/components/schemas/CoseKey"
             }
           },
-          "required": [
-            "publicCoseKey"
-          ],
+          "required": ["publicCoseKey"],
           "additionalProperties": false,
           "description": "Represents a cryptographic key pair for COSE (CBOR Object Signing and Encryption) operations."
         },
@@ -406,20 +356,13 @@
               "description": "X.509 certificate chain as base64-encoded certificates."
             }
           },
-          "required": [
-            "kty"
-          ],
+          "required": ["kty"],
           "additionalProperties": false,
           "description": "Represents a COSE (CBOR Object Signing and Encryption) key in JSON format."
         },
         "CoseKeyType": {
           "type": "number",
-          "enum": [
-            1,
-            2,
-            3,
-            4
-          ],
+          "enum": [1, 2, 3, 4],
           "description": "COSE key type parameter. 1=OKP (Octet Key Pair), 2=EC2 (Elliptic Curve), 3=RSA, 4=Symmetric."
         },
         "JoseKeyPair": {
@@ -432,9 +375,7 @@
               "$ref": "#/components/schemas/Jwk"
             }
           },
-          "required": [
-            "publicJwk"
-          ],
+          "required": ["publicJwk"],
           "additionalProperties": false,
           "description": "Data class representing a cryptographic key pair used with JOSE (JSON Object Signing and Encryption)."
         },
@@ -448,9 +389,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "aliasOrKid"
-          ],
+          "required": ["aliasOrKid"],
           "additionalProperties": false
         },
         "ManagedKeyInfo": {
@@ -498,11 +437,7 @@
               "description": "Additional configuration options as key-value pairs."
             }
           },
-          "required": [
-            "key",
-            "alias",
-            "providerId"
-          ],
+          "required": ["key", "alias", "providerId"],
           "additionalProperties": false,
           "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."
         },
@@ -529,20 +464,13 @@
               "$ref": "#/components/schemas/KeyProviderType"
             }
           },
-          "required": [
-            "providerId",
-            "type"
-          ],
+          "required": ["providerId", "type"],
           "additionalProperties": false,
           "description": "Response body containing the details of a Key Provider instance."
         },
         "KeyProviderType": {
           "type": "string",
-          "enum": [
-            "SOFTWARE",
-            "AZURE_KEYVAULT",
-            "AWS_KMS"
-          ],
+          "enum": ["SOFTWARE", "AZURE_KEYVAULT", "AWS_KMS"],
           "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."
         },
         "kmsGetResolverArgs": {
@@ -555,9 +483,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "resolverId"
-          ],
+          "required": ["resolverId"],
           "additionalProperties": false
         },
         "Resolver": {
@@ -582,21 +508,13 @@
               "description": "List of key types supported by this resolver."
             }
           },
-          "required": [
-            "resolverId"
-          ],
+          "required": ["resolverId"],
           "additionalProperties": false,
           "description": "Represents a key resolver configuration."
         },
         "IdentifierMethod": {
           "type": "string",
-          "enum": [
-            "JWK",
-            "KID",
-            "COSE_KEY",
-            "X5C",
-            "DID"
-          ],
+          "enum": ["JWK", "KID", "COSE_KEY", "X5C", "DID"],
           "description": "Method used to identify cryptographic keys."
         },
         "KmsIsValidRawSignatureArgs": {
@@ -616,11 +534,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "input",
-            "keyInfo",
-            "signature"
-          ]
+          "required": ["input", "keyInfo", "signature"]
         },
         "VerifyRawSignatureResponse": {
           "type": "object",
@@ -630,9 +544,7 @@
               "description": "Indicates whether the signature is valid or not."
             }
           },
-          "required": [
-            "isValid"
-          ],
+          "required": ["isValid"],
           "additionalProperties": false,
           "description": "Response body containing the details of the signature verification."
         },
@@ -655,9 +567,7 @@
               }
             }
           },
-          "required": [
-            "providers"
-          ],
+          "required": ["providers"],
           "additionalProperties": false,
           "description": "Response body containing the details of a Key Provider instance."
         },
@@ -672,10 +582,7 @@
               "$ref": "#/components/schemas/KeyProviderType"
             }
           },
-          "required": [
-            "providerId",
-            "type"
-          ],
+          "required": ["providerId", "type"],
           "additionalProperties": false,
           "description": "Response body containing the details of a Key Provider instance."
         },
@@ -701,9 +608,7 @@
               }
             }
           },
-          "required": [
-            "keyInfos"
-          ],
+          "required": ["keyInfos"],
           "additionalProperties": false,
           "description": "Response body containing all the managed keys."
         },
@@ -726,9 +631,7 @@
               }
             }
           },
-          "required": [
-            "resolvers"
-          ],
+          "required": ["resolvers"],
           "additionalProperties": false,
           "description": "Response body containing all the resolvers."
         },
@@ -745,10 +648,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "providerId",
-            "aliasOrKid"
-          ],
+          "required": ["providerId", "aliasOrKid"],
           "additionalProperties": false
         },
         "KmsProviderGenerateKey": {
@@ -778,9 +678,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "providerId"
-          ]
+          "required": ["providerId"]
         },
         "KmsProviderGetKeyArgs": {
           "type": "object",
@@ -795,10 +693,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "providerId",
-            "aliasOrKid"
-          ],
+          "required": ["providerId", "aliasOrKid"],
           "additionalProperties": false
         },
         "KmsProviderListKeysArgs": {
@@ -811,9 +706,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "providerId"
-          ],
+          "required": ["providerId"],
           "additionalProperties": false
         },
         "KmsProviderStoreKey": {
@@ -837,10 +730,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "keyInfo",
-            "providerId"
-          ]
+          "required": ["keyInfo", "providerId"]
         },
         "ResolvedKeyInfo": {
           "type": "object",
@@ -887,9 +777,7 @@
               "description": "Additional configuration options as key-value pairs."
             }
           },
-          "required": [
-            "key"
-          ],
+          "required": ["key"],
           "additionalProperties": false,
           "description": "Represents a resolved cryptographic key information where the key is guaranteed to be present and resolved, providing concrete access to the key."
         },
@@ -921,10 +809,7 @@
               "$ref": "#/components/schemas/String"
             }
           },
-          "required": [
-            "keyInfo",
-            "resolverId"
-          ]
+          "required": ["keyInfo", "resolverId"]
         },
         "String": {
           "type": "object",
@@ -933,9 +818,7 @@
               "type": "number"
             }
           },
-          "required": [
-            "length"
-          ],
+          "required": ["length"],
           "additionalProperties": {
             "type": "string"
           }
@@ -958,9 +841,7 @@
               "type": "string"
             }
           },
-          "required": [
-            "keyInfo"
-          ]
+          "required": ["keyInfo"]
         }
       },
       "methods": {
@@ -1120,4 +1001,4 @@
       }
     }
   }
-}
+}

package/src/agent/KmsRestClient.ts

@@ -21,7 +21,7 @@ import type {
   KmsProviderDeleteKeyArgs,
   RestClientAuthenticationOpts,
   KmsRestClientArgs,
-  KmsIsValidRawSignatureArgs
+  KmsIsValidRawSignatureArgs,
 } from '../types/IKmsRestClient'
 import type {
   CreateRawSignature,
@@ -57,7 +57,7 @@ import {
   VerifyRawSignatureResponseFromJSONTyped,
   StoreKeyToJSONTyped,
   VerifyRawSignatureToJSONTyped,
-  KeyProviderResponseFromJSONTyped
+  KeyProviderResponseFromJSONTyped,
 } from '../models'
 
 const logger = Loggers.DEFAULT.get('sphereon:ssi-sdk:kms:rest-client')
@@ -86,7 +86,7 @@ export class KmsRestClient implements IAgentPlugin {
     kmsResolveKey: this.kmsResolveKey.bind(this),
 
     kmsCreateRawSignature: this.kmsCreateRawSignature.bind(this),
-    kmsIsValidRawSignature: this.kmsIsValidRawSignature.bind(this)
+    kmsIsValidRawSignature: this.kmsIsValidRawSignature.bind(this),
   }
 
   private readonly agentBaseUrl?: string
@@ -109,7 +109,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/resolvers/${args.resolverId}`, baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`get resolver response: ${response}`)
 
@@ -126,7 +126,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase('/resolvers', baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`list resolvers response: ${response}`)
 
@@ -146,7 +146,7 @@ export class KmsRestClient implements IAgentPlugin {
       keyInfo: args.keyInfo,
       identifierMethod: args.identifierMethod,
       trustedCerts: args.trustedCerts,
-      verifyX509CertificateChain: args.verifyX509CertificateChain
+      verifyX509CertificateChain: args.verifyX509CertificateChain,
     } satisfies ResolvePublicKey
     const response = await fetch(url, {
       method: 'POST',
@@ -215,7 +215,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/keys/${args.aliasOrKid}`, baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`get key response: ${response}`)
 
@@ -297,7 +297,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/keys/${args.aliasOrKid}`, baseUrl)
 
     await fetch(url, {
-      method: 'DELETE'
+      method: 'DELETE',
     })
 
     return true
@@ -309,7 +309,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}`, baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`get provider response: ${response}`)
 
@@ -326,7 +326,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase('/providers', baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`list providers response: ${response}`)
 
@@ -343,7 +343,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys`, baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`list provider keys response: ${response}`)
 
@@ -407,7 +407,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`/providers/${args.providerId}/keys/${args.aliasOrKid}`, baseUrl)
 
     const response = await fetch(url, {
-      method: 'GET'
+      method: 'GET',
     })
     logger.debug(`get provider key response: ${response}`)
 
@@ -424,7 +424,7 @@ export class KmsRestClient implements IAgentPlugin {
     const url = KmsRestClient.urlWithBase(`providers/${args.providerId}/keys/${args.aliasOrKid}`, baseUrl)
 
     await fetch(url, {
-      method: 'DELETE'
+      method: 'DELETE',
     })
 
     return true
@@ -456,13 +456,12 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   private addSearchParams(baseUrl: string, params: Record<string, string | number | boolean>): URL {
-    const url = new URL(baseUrl);
+    const url = new URL(baseUrl)
 
     for (const [key, value] of Object.entries(params)) {
-      url.searchParams.set(key, String(value));
+      url.searchParams.set(key, String(value))
     }
 
-    return url;
+    return url
   }
-
 }