feat(key-manager): allow user defined kid on keyManagerCreate (#1426)

fixes #1353
decentralized-identity · Oct 30, 2024 · 0784df0 · 0784df0
1 parent 06882b9
commit 0784df0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/packages/core-types/src/plugin.schema.ts b/packages/core-types/src/plugin.schema.ts
@@ -540,6 +540,10 @@ export const schema = {
             "meta": {
               "$ref": "#/components/schemas/KeyMetadata",
               "description": "Optional. Key meta data"
+            },
+            "kid": {
+              "type": "string",
+              "description": "Key ID"
             }
           },
           "required": [

diff --git a/packages/core-types/src/types/IKeyManager.ts b/packages/core-types/src/types/IKeyManager.ts
@@ -42,6 +42,11 @@ export interface IKeyManagerCreateArgs {
    * Optional. Key meta data
    */
   meta?: KeyMetadata
+
+  /**
+   * Optional. Key ID
+   */
+  kid?: string;
 }
 
 /**

diff --git a/packages/key-manager/src/key-manager.ts b/packages/key-manager/src/key-manager.ts
@@ -87,7 +87,11 @@ export class KeyManager implements IAgentPlugin {
   async keyManagerCreate(args: IKeyManagerCreateArgs): Promise<ManagedKeyInfo> {
     const kms = this.getKms(args.kms)
     const partialKey = await kms.createKey({ type: args.type, meta: args.meta })
-    const key: IKey = { ...partialKey, kms: args.kms }
+    const key: IKey = {
+      ...partialKey,
+      kms: args.kms,
+      kid: args.kid ?? partialKey.kid
+    }
     if (args.meta || key.meta) {
       key.meta = { ...args.meta, ...key.meta }
     }