feat: (wip) added list keys functionality. the kms-local function wor…

…ks but we face error on key-manager level
Sphereon-Opensource · May 2, 2024 · bde93d3 · bde93d3
1 parent 836d046
commit bde93d3
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 1 deletion.
diff --git a/packages/key-manager/src/__tests__/sphereon-key-manager.test.ts b/packages/key-manager/src/__tests__/sphereon-key-manager.test.ts
@@ -82,6 +82,23 @@ describe('@sphereon/ssi-sdk-ext.kms-local', () => {
     await expect(kms.keyManagerDelete({ kid: Buffer.from(bls.publicKey).toString('hex') })).resolves.toBeTruthy()
   })
 
+  it('should get all the keys in the sphereon key manager', async () => {
+    const myKey = {
+      type: 'Bls12381G2',
+      privateKeyHex: Buffer.from(bls.secretKey).toString('hex'),
+      publicKeyHex: Buffer.from(bls.publicKey).toString('hex'),
+    }
+    await kms.keyManagerImport({
+      kid: myKey.publicKeyHex,
+      privateKeyHex: myKey.privateKeyHex,
+      publicKeyHex: myKey.publicKeyHex,
+      kms: 'local',
+      type: 'Bls12381G2',
+    })
+    const keys = await kms.keyManagerListKeys({})
+    console.log('should get all the keys in the sphereon key manager:\n', keys)
+  })
+
   afterAll(async () => {
     await new Promise((resolve) => setTimeout((v: void) => resolve(v), 500))
   })

diff --git a/packages/key-manager/src/agent/SphereonKeyManager.ts b/packages/key-manager/src/agent/SphereonKeyManager.ts
@@ -1,6 +1,6 @@
 import { KeyManager as VeramoKeyManager, AbstractKeyManagementSystem, AbstractKeyStore } from '@veramo/key-manager'
 
-import { IKey, TKeyType } from '@veramo/core'
+import {IKey, ManagedKeyInfo, TKeyType} from '@veramo/core'
 import { KeyType, SphereonKeyManagementSystem } from '@sphereon/ssi-sdk-ext.kms-local'
 import { ISphereonKeyManager, ISphereonKeyManagerSignArgs, ISphereonKeyManagerVerifyArgs } from '../types/ISphereonKeyManager'
 
@@ -45,4 +45,14 @@ export class SphereonKeyManager extends VeramoKeyManager {
     }
     throw Error(`KMS ${kms} does not support verification`)
   }
+
+  async keyManagerListKeys({}): Promise<ManagedKeyInfo[]> {
+    const kmsNames = await this.keyManagerGetKeyManagementSystems()
+    const keys: ManagedKeyInfo[] = []
+    for (let i = 0; i < kmsNames.length; i++) {
+      const kms = this.getLocalKms(kmsNames[i])
+      keys.push(...await kms.listKeys())
+    }
+    return keys
+  }
 }
diff --git a/packages/kms-local/src/SphereonKeyManagementSystem.ts b/packages/kms-local/src/SphereonKeyManagementSystem.ts
@@ -268,4 +268,8 @@ export class SphereonKeyManagementSystem extends KeyManagementSystem {
     const signer = new RSASigner(PEMToJwk(hexToPEM(publicKeyHex, 'public'), 'public'), { hashAlgorithm, scheme })
     return await signer.verify(data, signature)
   }
+
+  public async listKeys(): Promise<ManagedKeyInfo[]> {
+    return (await this.privateKeyStore.list({})).map(privateKey=>this.asSphereonManagedKeyInfo(privateKey))
+  }
 }
diff --git a/packages/kms-local/src/__tests__/bls-kms-local.test.ts b/packages/kms-local/src/__tests__/bls-kms-local.test.ts
@@ -67,4 +67,14 @@ describe('@veramo/kms-local x509 support', () => {
       'RJfBIpGscKKrWNNVau5zNWwQHOKCOWnh5f1VH7H7rwJcwrroHBpqNnf1EqA51nzpSlzynsQ69BLQkcUX3Yq2VeRPUVazOWAJ_xa9EIRcbpIjxi33zH_DjDdOQnre8WB1KNCg_Nkql5KjCmwGRTjCqBDRkNXPmfRoUoG3XKTSSW4'
     )
   })
+
+  it('should get all the keys', async () => {
+    const kms = new SphereonKeyManagementSystem(new MemoryPrivateKeyStore())
+    const privateKeyHex =
+      '3082025b020100028181008f46d01b91eeb6fe7933b5426d82d08e725ebadfeb5b9897504c4e6d589a0f9dba88092343391ea05849f46f11d2f956c46824445ab2b8b019d9e54a3497dac562252ce57f2e698773ff12e6f930bebe1a2e0465bbaca5a3b5ed4775a013f472e5b49ab2987c5413143c4d414be07ce63a0b0e93a8de138bd46c340368cf305f0203010001028180712a896d7d52838f73c3f7c3442432fe902f6a833aaeda5389c4fb9d3a82551b4c1deeb9bf7afa49c3f285f2c4ad52ebc9ae4817055c6cac0b7f23affce2849473bb27a112362965bb4630258de3fe35a5ed8bed26ef79e5d0e0a01b925b8f2043c53b1d621a633ab027f32bf04227bdd3fbb518bfd87d559213b60c77d16b81024100f33a2ea9e6563ab67cf618a3fe4e8798dce66cd530dc4d1cb91c9a208a66898ed2b132471731ce82e0975320d99ccd150e0201af6fcb6ad01a400bdd1783cdaf02410096ccf2803b569cb4cfcebdf28424d74b0ad1cce23f75f5138b9c26987855c17a5d3f82ea3e2bee99d1a184bd89e9d627a410c2916403800d18083b6081d9a451024017ee318925d076165e5518378a5dcf998aa26132d88bd44a6f2c113e025ff448c91206105887ddf9a27f40fe8a6a9302ef4de33c8f9343ff15961794b92b8ea10240412f5c4fd3d68fac94fb701e29c2e711781ed26aa635edf741ed00bdfd9e4c2101b7d7763be3afa2ebfbdeae33b451af16fb6baf7f45081020e8460a6476d8d10240640511541bf370d6d1b3723d49ea6e7193eea225f1c8400c6e50efb75bda9a56f3569b6abd031eaa9c037d4aa934c97888c2c93eca6fc640525dd3d50d087897'
+    // @ts-ignore
+    const key = await kms.importKey({ kid: 'test', privateKeyHex, type: 'RSA' })
+    const keys = await kms.listKeys()
+    console.log('should get all the keys result:\nkeys:', keys)
+  })
 })