@sphereon/ssi-sdk-ext.key-manager 0.34.1-feature.SSISDK.78.280 → 0.34.1-feature.SSISDK.82.linkedVP.325

package/plugin.schema.json

@@ -22,12 +22,23 @@
               "description": "Optional. Key meta data"
             }
           },
-          "required": ["type"],
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
           "description": "Input arguments for  {@link ISphereonKeyManager.keyManagerCreate | keyManagerCreate }"
         },
         "TKeyType": {
           "type": "string",
-          "enum": ["Ed25519", "Secp256k1", "Secp256r1", "X25519", "Bls12381G1", "Bls12381G2", "RSA"],
+          "enum": [
+            "Ed25519",
+            "Secp256k1",
+            "Secp256r1",
+            "X25519",
+            "Bls12381G1",
+            "Bls12381G2",
+            "RSA"
+          ],
           "description": "Cryptographic key type."
         },
         "IkeyOptions": {
@@ -49,9 +60,11 @@
                   "format": "date-time"
                 }
               },
+              "additionalProperties": false,
               "description": "Expiration and remove the key"
             }
-          }
+          },
+          "additionalProperties": false
         },
         "KeyMetadata": {
           "type": "object",
@@ -67,6 +80,7 @@
         },
         "PartialKey": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "privateKeyHex": {
               "type": "string"
@@ -99,7 +113,13 @@
               "description": "Optional. Key metadata. This should be used to determine which algorithms are supported."
             }
           },
-          "required": ["kid", "kms", "privateKeyHex", "publicKeyHex", "type"]
+          "required": [
+            "kid",
+            "kms",
+            "privateKeyHex",
+            "publicKeyHex",
+            "type"
+          ]
         },
         "ISphereonKeyManagerHandleExpirationsArgs": {
           "type": "object",
@@ -107,9 +127,17 @@
             "skipRemovals": {
               "type": "boolean"
             }
-          }
+          },
+          "additionalProperties": false
         },
         "ManagedKeyInfo": {
+          "$ref": "#/components/schemas/Omit<IKey,\"privateKeyHex\">",
+          "description": "Represents information about a managed key. Private or secret key material is NOT present."
+        },
+        "Omit<IKey,\"privateKeyHex\">": {
+          "$ref": "#/components/schemas/Pick<IKey,Exclude<(\"kid\"|\"kms\"|\"type\"|\"publicKeyHex\"|\"privateKeyHex\"|\"meta\"),\"privateKeyHex\">>"
+        },
+        "Pick<IKey,Exclude<(\"kid\"|\"kms\"|\"type\"|\"publicKeyHex\"|\"privateKeyHex\"|\"meta\"),\"privateKeyHex\">>": {
           "type": "object",
           "properties": {
             "kid": {
@@ -140,8 +168,13 @@
               "description": "Optional. Key metadata. This should be used to determine which algorithms are supported."
             }
           },
-          "required": ["kid", "kms", "type", "publicKeyHex"],
-          "description": "Represents information about a managed key. Private or secret key material is NOT present."
+          "required": [
+            "kid",
+            "kms",
+            "type",
+            "publicKeyHex"
+          ],
+          "additionalProperties": false
         },
         "MinimalImportableKey": {
           "$ref": "#/components/schemas/RequireOnly<IKey,(\"privateKeyHex\"|\"type\"|\"kms\")>",
@@ -149,6 +182,7 @@
         },
         "RequireOnly<IKey,(\"privateKeyHex\"|\"type\"|\"kms\")>": {
           "type": "object",
+          "additionalProperties": false,
           "properties": {
             "kid": {
               "type": "string",
@@ -201,52 +235,73 @@
                   "type": "string"
                 },
                 {
-                  "type": "object",
-                  "properties": {
-                    "BYTES_PER_ELEMENT": {
-                      "type": "number"
-                    },
-                    "buffer": {
-                      "anyOf": [
-                        {
-                          "type": "object",
-                          "properties": {
-                            "byteLength": {
-                              "type": "number"
-                            }
-                          },
-                          "required": ["byteLength"]
-                        },
-                        {}
-                      ]
-                    },
-                    "byteLength": {
-                      "type": "number"
-                    },
-                    "byteOffset": {
-                      "type": "number"
-                    },
-                    "length": {
-                      "type": "number"
-                    }
-                  },
-                  "required": ["BYTES_PER_ELEMENT", "buffer", "byteLength", "byteOffset", "length"],
-                  "additionalProperties": {
-                    "type": "number"
-                  }
+                  "$ref": "#/components/schemas/Uint8Array"
                 }
               ],
               "description": "Data to sign"
             },
             "encoding": {
               "type": "string",
-              "enum": ["utf-8", "base16", "base64", "hex"],
+              "enum": [
+                "utf-8",
+                "base16",
+                "base64",
+                "hex"
+              ],
               "description": "If the data is a \"string\" then you can specify which encoding is used. Default is \"utf-8\""
             }
           },
-          "required": ["data", "keyRef"],
+          "required": [
+            "data",
+            "keyRef"
+          ],
           "description": "Input arguments for  {@link ISphereonKeyManagerSignArgs.keyManagerSign | keyManagerSign }"
         },
+        "Uint8Array": {
+          "type": "object",
+          "properties": {
+            "BYTES_PER_ELEMENT": {
+              "type": "number"
+            },
+            "buffer": {
+              "$ref": "#/components/schemas/ArrayBufferLike"
+            },
+            "byteLength": {
+              "type": "number"
+            },
+            "byteOffset": {
+              "type": "number"
+            },
+            "length": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "BYTES_PER_ELEMENT",
+            "buffer",
+            "byteLength",
+            "byteOffset",
+            "length"
+          ],
+          "additionalProperties": {
+            "type": "number"
+          }
+        },
+        "ArrayBufferLike": {
+          "$ref": "#/components/schemas/ArrayBuffer"
+        },
+        "ArrayBuffer": {
+          "type": "object",
+          "properties": {
+            "byteLength": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "byteLength"
+          ],
+          "additionalProperties": false
+        },
         "ISphereonKeyManagerVerifyArgs": {
           "type": "object",
           "properties": {
@@ -263,45 +318,19 @@
               "type": "string"
             },
             "data": {
-              "type": "object",
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "anyOf": [
-                    {
-                      "type": "object",
-                      "properties": {
-                        "byteLength": {
-                          "type": "number"
-                        }
-                      },
-                      "required": ["byteLength"]
-                    },
-                    {}
-                  ]
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                }
-              },
-              "required": ["BYTES_PER_ELEMENT", "buffer", "byteLength", "byteOffset", "length"],
-              "additionalProperties": {
-                "type": "number"
-              }
+              "$ref": "#/components/schemas/Uint8Array"
             },
             "signature": {
               "type": "string"
             }
           },
-          "required": ["publicKeyHex", "type", "data", "signature"]
+          "required": [
+            "publicKeyHex",
+            "type",
+            "data",
+            "signature"
+          ],
+          "additionalProperties": false
         }
       },
       "methods": {
@@ -377,4 +406,4 @@
       }
     }
   }
-}
+}

package/src/agent/SphereonKeyManager.ts

@@ -46,6 +46,64 @@ export class SphereonKeyManager extends VeramoKeyManager {
     methods.keyManagerListKeys = this.keyManagerListKeys.bind(this)
     methods.keyManagerGetDefaultKeyManagementSystem = this.keyManagerGetDefaultKeyManagementSystem.bind(this)
     this.kmsMethods = <ISphereonKeyManager>(<unknown>methods)
+
+    this.syncPreProvisionedKeys()
+  }
+
+  private syncPreProvisionedKeys() {
+    Object.keys(this.availableKmses).forEach((kmsId) => {
+      const kms = this.availableKmses[kmsId]
+      if (kms.constructor.name === 'RestKeyManagementSystem') {
+        this.syncPreProvisionedKeysForKms(kmsId, kms)
+      }
+    })
+  }
+
+  private syncPreProvisionedKeysForKms(kmsId: string, kms: AbstractKeyManagementSystem) {
+    kms
+      .listKeys()
+      .then(async (remoteKeys: ManagedKeyInfo[]) => {
+        try {
+          const storedKeys: ManagedKeyInfo[] = await this.keyManagerListKeys()
+
+          await Promise.all(
+            remoteKeys.map(async (remoteKey) => {
+              const storedKey = storedKeys.find((k) => k.kid === remoteKey.kid)
+
+              const needsUpdate =
+                !storedKey ||
+                storedKey.publicKeyHex !== remoteKey.publicKeyHex ||
+                storedKey.type !== remoteKey.type ||
+                storedKey.kms !== remoteKey.kms ||
+                (remoteKey.meta && 'alias' in remoteKey.meta && storedKey.meta && storedKey.meta.keyAlias !== remoteKey.meta.alias)
+              if (needsUpdate) {
+                try {
+                  if (storedKey) {
+                    await this.kmsStore.delete({ kid: remoteKey.kid })
+                  }
+                  const keyToImport: IKey = {
+                    ...remoteKey,
+                    meta: remoteKey.meta && 'alias' in remoteKey.meta ? { ...remoteKey.meta, keyAlias: remoteKey.meta.alias } : remoteKey.meta,
+                  } as IKey
+
+                  if (keyToImport.meta && 'alias' in keyToImport.meta) {
+                    delete keyToImport.meta.alias
+                  }
+
+                  await this.kmsStore.import(keyToImport)
+                } catch (error) {
+                  console.error(`Failed to sync key ${remoteKey.kid} from kms ${kmsId}:`, error)
+                }
+              }
+            }),
+          )
+        } catch (error) {
+          console.error(`Failed to sync keys for kms ${kmsId}:`, error)
+        }
+      })
+      .catch((error) => {
+        console.error(`Failed to list remote keys for kms ${kmsId}:`, error)
+      })
   }
 
   keyManagerGetDefaultKeyManagementSystem(): Promise<string> {
@@ -142,7 +200,7 @@ export class SphereonKeyManager extends VeramoKeyManager {
         (key) =>
           key.publicKeyHex === kid ||
           key.meta?.jwkThumbprint === kid ||
-          (key.meta?.jwkThumbprint == null && calculateJwkThumbprintForKey({ key }) === kid)
+          (key.meta?.jwkThumbprint == null && calculateJwkThumbprintForKey({ key }) === kid),
       )
       if (foundKey) {
         return foundKey as IKey
@@ -165,5 +223,9 @@ export class SphereonKeyManager extends VeramoKeyManager {
 
   setKms(name: string, kms: AbstractKeyManagementSystem): void {
     this.availableKmses[name] = kms
+
+    if (kms.constructor.name === 'RestKeyManagementSystem') {
+      this.syncPreProvisionedKeysForKms(name, kms)
+    }
   }
 }