@sphereon/ssi-sdk.kms-rest-client 0.34.1-next.299 → 0.34.1-next.322

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-next.299+9e9f5a50",
+  "version": "0.34.1-next.322+78f8dd31",
   "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-next.299+9e9f5a50",
+    "@sphereon/ssi-types": "0.34.1-next.322+78f8dd31",
     "cross-fetch": "^3.1.8"
   },
   "devDependencies": {
@@ -56,5 +56,5 @@
     "KMS",
     "REST"
   ],
-  "gitHead": "9e9f5a50ead9373a078cb5291cbc4fb1e7865dc2"
+  "gitHead": "78f8dd3157066ae8cf11d2ae50c8c3d8f43b8ed0"
 }

package/plugin.schema.json

@@ -2,7 +2,7 @@
   "IKmsRestClient": {
     "components": {
       "schemas": {
-        "KmsCreateRawSignatureArgs": {
+        "KmsClientCreateRawSignatureArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -226,7 +226,7 @@
           "additionalProperties": false,
           "description": "Response body containing the created signature."
         },
-        "KmsDeleteKeyArgs": {
+        "KmsClientDeleteKeyArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -236,9 +236,10 @@
               "type": "string"
             }
           },
+          "required": ["aliasOrKid"],
           "additionalProperties": false
         },
-        "KmsGenerateKeyArgs": {
+        "KmsClientGenerateKeyArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -267,6 +268,17 @@
             }
           }
         },
+        "GenerateKeyResponse": {
+          "type": "object",
+          "properties": {
+            "keyPair": {
+              "$ref": "#/components/schemas/ManagedKeyPair"
+            }
+          },
+          "required": ["keyPair"],
+          "additionalProperties": false,
+          "description": "Response body containing a generated key pair."
+        },
         "ManagedKeyPair": {
           "type": "object",
           "properties": {
@@ -379,7 +391,7 @@
           "additionalProperties": false,
           "description": "Data class representing a cryptographic key pair used with JOSE (JSON Object Signing and Encryption)."
         },
-        "KmsGetKeyArgs": {
+        "KmsClientGetKeyArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -392,6 +404,17 @@
           "required": ["aliasOrKid"],
           "additionalProperties": false
         },
+        "GetKeyResponse": {
+          "type": "object",
+          "properties": {
+            "keyInfo": {
+              "$ref": "#/components/schemas/ManagedKeyInfo"
+            }
+          },
+          "required": ["keyInfo"],
+          "additionalProperties": false,
+          "description": "Response body containing a managed key."
+        },
         "ManagedKeyInfo": {
           "type": "object",
           "properties": {
@@ -441,7 +464,7 @@
           "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."
         },
-        "KmsGetKeyProviderArgs": {
+        "KmsClientGetKeyProviderArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -451,6 +474,7 @@
               "type": "string"
             }
           },
+          "required": ["providerId"],
           "additionalProperties": false
         },
         "KeyProviderResponse": {
@@ -473,7 +497,7 @@
           "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": {
+        "kmsClientGetResolverArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -517,7 +541,7 @@
           "enum": ["JWK", "KID", "COSE_KEY", "X5C", "DID"],
           "description": "Method used to identify cryptographic keys."
         },
-        "KmsIsValidRawSignatureArgs": {
+        "KmsClientIsValidRawSignatureArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -548,7 +572,7 @@
           "additionalProperties": false,
           "description": "Response body containing the details of the signature verification."
         },
-        "KmsListKeyProvidersArgs": {
+        "KmsClientListKeyProvidersArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -586,7 +610,7 @@
           "additionalProperties": false,
           "description": "Response body containing the details of a Key Provider instance."
         },
-        "KmsListKeysArgs": {
+        "KmsClientListKeysArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -612,7 +636,7 @@
           "additionalProperties": false,
           "description": "Response body containing all the managed keys."
         },
-        "KmsListResolversArgs": {
+        "KmsClientListResolversArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -635,7 +659,7 @@
           "additionalProperties": false,
           "description": "Response body containing all the resolvers."
         },
-        "KmsProviderDeleteKeyArgs": {
+        "KmsClientProviderDeleteKeyArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -651,7 +675,7 @@
           "required": ["providerId", "aliasOrKid"],
           "additionalProperties": false
         },
-        "KmsProviderGenerateKey": {
+        "KmsClientProviderGenerateKeyArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -680,7 +704,7 @@
           },
           "required": ["providerId"]
         },
-        "KmsProviderGetKeyArgs": {
+        "KmsClientProviderGetKeyArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -696,7 +720,7 @@
           "required": ["providerId", "aliasOrKid"],
           "additionalProperties": false
         },
-        "KmsProviderListKeysArgs": {
+        "KmsClientProviderListKeysArgs": {
           "type": "object",
           "properties": {
             "baseUrl": {
@@ -709,7 +733,7 @@
           "required": ["providerId"],
           "additionalProperties": false
         },
-        "KmsProviderStoreKey": {
+        "KmsClientProviderStoreKeyArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -781,7 +805,18 @@
           "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."
         },
-        "KmsResolveKeyArgs": {
+        "StoreKeyResponse": {
+          "type": "object",
+          "properties": {
+            "keyInfo": {
+              "$ref": "#/components/schemas/ManagedKeyInfo"
+            }
+          },
+          "required": ["keyInfo"],
+          "additionalProperties": false,
+          "description": "Response body containing a stored key."
+        },
+        "KmsClientResolveKeyArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -823,7 +858,7 @@
             "type": "string"
           }
         },
-        "KmsStoreKeyArgs": {
+        "KmsClientStoreKeyArgs": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
@@ -845,157 +880,157 @@
         }
       },
       "methods": {
-        "kmsCreateRawSignature": {
+        "kmsClientCreateRawSignature": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsCreateRawSignatureArgs"
+            "$ref": "#/components/schemas/KmsClientCreateRawSignatureArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/CreateRawSignatureResponse"
           }
         },
-        "kmsDeleteKey": {
+        "kmsClientDeleteKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsDeleteKeyArgs"
+            "$ref": "#/components/schemas/KmsClientDeleteKeyArgs"
           },
           "returnType": {
             "type": "boolean"
           }
         },
-        "kmsGenerateKey": {
+        "kmsClientGenerateKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsGenerateKeyArgs"
+            "$ref": "#/components/schemas/KmsClientGenerateKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyPair"
+            "$ref": "#/components/schemas/GenerateKeyResponse"
           }
         },
-        "kmsGetKey": {
+        "kmsClientGetKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsGetKeyArgs"
+            "$ref": "#/components/schemas/KmsClientGetKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyInfo"
+            "$ref": "#/components/schemas/GetKeyResponse"
           }
         },
-        "kmsGetKeyProvider": {
+        "kmsClientGetKeyProvider": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsGetKeyProviderArgs"
+            "$ref": "#/components/schemas/KmsClientGetKeyProviderArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/KeyProviderResponse"
           }
         },
-        "kmsGetResolver": {
+        "kmsClientGetResolver": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/kmsGetResolverArgs"
+            "$ref": "#/components/schemas/kmsClientGetResolverArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/Resolver"
           }
         },
-        "kmsIsValidRawSignature": {
+        "kmsClientIsValidRawSignature": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsIsValidRawSignatureArgs"
+            "$ref": "#/components/schemas/KmsClientIsValidRawSignatureArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/VerifyRawSignatureResponse"
           }
         },
-        "kmsListKeyProviders": {
+        "kmsClientListKeyProviders": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsListKeyProvidersArgs"
+            "$ref": "#/components/schemas/KmsClientListKeyProvidersArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/ListKeyProvidersResponse"
           }
         },
-        "kmsListKeys": {
+        "kmsClientListKeys": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsListKeysArgs"
+            "$ref": "#/components/schemas/KmsClientListKeysArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/ListKeysResponse"
           }
         },
-        "kmsListResolvers": {
+        "kmsClientListResolvers": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsListResolversArgs"
+            "$ref": "#/components/schemas/KmsClientListResolversArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/ListResolversResponse"
           }
         },
-        "kmsProviderDeleteKey": {
+        "kmsClientProviderDeleteKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsProviderDeleteKeyArgs"
+            "$ref": "#/components/schemas/KmsClientProviderDeleteKeyArgs"
           },
           "returnType": {
             "type": "boolean"
           }
         },
-        "kmsProviderGenerateKey": {
+        "kmsClientProviderGenerateKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsProviderGenerateKey"
+            "$ref": "#/components/schemas/KmsClientProviderGenerateKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyPair"
+            "$ref": "#/components/schemas/GenerateKeyResponse"
           }
         },
-        "kmsProviderGetKey": {
+        "kmsClientProviderGetKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsProviderGetKeyArgs"
+            "$ref": "#/components/schemas/KmsClientProviderGetKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyInfo"
+            "$ref": "#/components/schemas/GetKeyResponse"
           }
         },
-        "kmsProviderListKeys": {
+        "kmsClientProviderListKeys": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsProviderListKeysArgs"
+            "$ref": "#/components/schemas/KmsClientProviderListKeysArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/ListKeysResponse"
           }
         },
-        "kmsProviderStoreKey": {
+        "kmsClientProviderStoreKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsProviderStoreKey"
+            "$ref": "#/components/schemas/KmsClientProviderStoreKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyInfo"
+            "$ref": "#/components/schemas/StoreKeyResponse"
           }
         },
-        "kmsResolveKey": {
+        "kmsClientResolveKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsResolveKeyArgs"
+            "$ref": "#/components/schemas/KmsClientResolveKeyArgs"
           },
           "returnType": {
             "$ref": "#/components/schemas/ResolvedKeyInfo"
           }
         },
-        "kmsStoreKey": {
+        "kmsClientStoreKey": {
           "description": "",
           "arguments": {
-            "$ref": "#/components/schemas/KmsStoreKeyArgs"
+            "$ref": "#/components/schemas/KmsClientStoreKeyArgs"
           },
           "returnType": {
-            "$ref": "#/components/schemas/ManagedKeyInfo"
+            "$ref": "#/components/schemas/StoreKeyResponse"
           }
         }
       }

package/src/agent/KmsRestClient.ts

@@ -40,7 +40,7 @@ import type {
   KeyProviderResponse,
   GenerateKeyResponse,
   StoreKeyResponse,
-  GetKeyResponse
+  GetKeyResponse,
 } from '../models'
 import {
   CreateRawSignatureResponseFromJSONTyped,
@@ -59,7 +59,7 @@ import {
   StoreKeyToJSONTyped,
   StoreKeyResponseFromJSONTyped,
   VerifyRawSignatureResponseFromJSONTyped,
-  VerifyRawSignatureToJSONTyped
+  VerifyRawSignatureToJSONTyped,
 } from '../models'
 
 const logger = Loggers.DEFAULT.get('sphereon:ssi-sdk:kms:rest-client')
@@ -392,6 +392,7 @@ export class KmsRestClient implements IAgentPlugin {
       alg: args.alg,
       keyOperations: args.keyOperations,
       use: args.use,
+      alias: args.alias,
     } satisfies GenerateKey
     const response = await fetch(url, {
       method: 'POST',
@@ -477,11 +478,9 @@ export class KmsRestClient implements IAgentPlugin {
   }
 
   private async handleHttpError(url: string, response: Response): Promise<never> {
-    const contentType = response.headers.get("content-type")
-    const isJson = contentType?.includes("application/json")
-    const responseBody = isJson
-      ? JSON.stringify(await response.json())
-      : await response.text()
+    const contentType = response.headers.get('content-type')
+    const isJson = contentType?.includes('application/json')
+    const responseBody = isJson ? JSON.stringify(await response.json()) : await response.text()
 
     return Promise.reject(Error(`request to ${url} returned http error ${response.status} - ${responseBody}`))
   }

package/src/types/IKmsRestClient.ts

@@ -17,7 +17,7 @@ import {
   StoreKey,
   StoreKeyResponse,
   VerifyRawSignature,
-  VerifyRawSignatureResponse
+  VerifyRawSignatureResponse,
 } from '../models'
 
 export interface IKmsRestClient extends IPluginMethodMap {