feat: support wallet key rotation

packages/core/package.json

@@ -26,7 +26,7 @@
     "@multiformats/base-x": "^4.0.1",
     "@stablelib/ed25519": "^1.0.2",
     "@stablelib/sha256": "^1.0.1",
-    "@types/indy-sdk": "^1.16.12",
+    "@types/indy-sdk": "^1.16.15",
     "@types/node-fetch": "^2.5.10",
     "@types/ws": "^7.4.4",
     "abort-controller": "^3.0.0",

packages/core/src/types.ts

@@ -22,6 +22,14 @@ export interface WalletConfig {
   keyDerivationMethod?: KeyDerivationMethod
 }
 
+export interface WalletConfigRekey {
+  id: string
+  key: string
+  rekey: string
+  keyDerivationMethod?: KeyDerivationMethod
+  rekeyDerivationMethod?: KeyDerivationMethod
+}
+
 export interface WalletExportImportConfig {
   key: string
   path: string

packages/core/src/wallet/IndyWallet.ts

@@ -1,5 +1,12 @@
 import type { Logger } from '../logger'
-import type { EncryptedMessage, DecryptedMessageContext, WalletConfig, WalletExportImportConfig } from '../types'
+import type {
+  EncryptedMessage,
+  DecryptedMessageContext,
+  WalletConfig,
+  WalletExportImportConfig,
+  WalletConfigRekey,
+  KeyDerivationMethod,
+} from '../types'
 import type { Buffer } from '../utils/buffer'
 import type { Wallet, DidInfo, DidConfig } from './Wallet'
 import type { default as Indy } from 'indy-sdk'
@@ -120,6 +127,33 @@ export class IndyWallet implements Wallet {
    * @throws {WalletError} if another error occurs
    */
   public async open(walletConfig: WalletConfig): Promise<void> {
+    await this._open(walletConfig)
+  }
+
+  /**
+   * @throws {WalletNotFoundError} if the wallet does not exist
+   * @throws {WalletError} if another error occurs
+   */
+  public async rotateKey(walletConfig: WalletConfigRekey): Promise<void> {
+    if (!walletConfig.rekey) {
+      throw new WalletError('Wallet rekey undefined!. Please specify the new wallet key')
+    }
+    await this._open(
+      { id: walletConfig.id, key: walletConfig.key, keyDerivationMethod: walletConfig.keyDerivationMethod },
+      walletConfig.rekey,
+      walletConfig.rekeyDerivationMethod
+    )
+  }
+
+  /**
+   * @throws {WalletNotFoundError} if the wallet does not exist
+   * @throws {WalletError} if another error occurs
+   */
+  private async _open(
+    walletConfig: WalletConfig,
+    rekey?: string,
+    rekeyDerivation?: KeyDerivationMethod
+  ): Promise<void> {
     if (this.walletHandle) {
       throw new WalletError(
         'Wallet instance already opened. Close the currently opened wallet before re-opening the wallet'
@@ -129,9 +163,18 @@ export class IndyWallet implements Wallet {
     try {
       this.walletHandle = await this.indy.openWallet(
         { id: walletConfig.id },
-        { key: walletConfig.key, key_derivation_method: walletConfig.keyDerivationMethod }
+        {
+          key: walletConfig.key,
+          rekey: rekey,
+          key_derivation_method: walletConfig.keyDerivationMethod,
+          rekey_derivation_method: rekeyDerivation,
+        }
       )
-      this.walletConfig = walletConfig
+      if (rekey) {
+        this.walletConfig = { ...walletConfig, key: rekey, keyDerivationMethod: rekeyDerivation }
+      } else {
+        this.walletConfig = walletConfig
+      }
     } catch (error) {
       if (isIndyError(error, 'WalletNotFoundError')) {
         const errorMessage = `Wallet '${walletConfig.id}' not found`

packages/core/src/wallet/Wallet.ts

@@ -1,4 +1,10 @@
-import type { EncryptedMessage, DecryptedMessageContext, WalletConfig, WalletExportImportConfig } from '../types'
+import type {
+  EncryptedMessage,
+  DecryptedMessageContext,
+  WalletConfig,
+  WalletExportImportConfig,
+  WalletConfigRekey,
+} from '../types'
 import type { Buffer } from '../utils/buffer'
 
 export interface Wallet {
@@ -9,6 +15,7 @@ export interface Wallet {
   create(walletConfig: WalletConfig): Promise<void>
   createAndOpen(walletConfig: WalletConfig): Promise<void>
   open(walletConfig: WalletConfig): Promise<void>
+  rotateKey(walletConfig: WalletConfigRekey): Promise<void>
   close(): Promise<void>
   delete(): Promise<void>
   export(exportConfig: WalletExportImportConfig): Promise<void>

packages/core/src/wallet/WalletModule.ts

@@ -1,5 +1,5 @@
 import type { Logger } from '../logger'
-import type { WalletConfig, WalletExportImportConfig } from '../types'
+import type { WalletConfig, WalletConfigRekey, WalletExportImportConfig } from '../types'
 
 import { inject, Lifecycle, scoped } from 'tsyringe'
 
@@ -68,6 +68,10 @@ export class WalletModule {
     await this.wallet.close()
   }
 
+  public async rotateKey(walletConfig: WalletConfigRekey): Promise<void> {
+    await this.wallet.rotateKey(walletConfig)
+  }
+
   public async delete(): Promise<void> {
     await this.wallet.delete()
   }

packages/core/tests/wallet.test.ts

@@ -157,4 +157,27 @@ describe('wallet', () => {
     // Expect same basic message record to exist in new wallet
     expect(await bobBasicMessageRepository.getById(basicMessageRecord.id)).toMatchObject(basicMessageRecord)
   })
+
+  test('changing wallet key', async () => {
+    const walletConfig = {
+      id: 'mywallet',
+      key: 'mysecretwalletkey',
+    }
+
+    await aliceAgent.wallet.createAndOpen(walletConfig)
+    await aliceAgent.initialize()
+
+    //Close agent
+    const walletConfigRekey = {
+      id: 'mywallet',
+      key: 'mysecretwalletkey',
+      rekey: '123',
+    }
+
+    await aliceAgent.shutdown()
+    await aliceAgent.wallet.rotateKey(walletConfigRekey)
+    await aliceAgent.initialize()
+
+    expect(aliceAgent.isInitialized).toBe(true)
+  })
 })

packages/react-native/package.json

@@ -29,7 +29,7 @@
     "events": "^3.3.0"
   },
   "devDependencies": {
-    "@types/indy-sdk-react-native": "npm:@types/indy-sdk@^1.16.12",
+    "@types/indy-sdk-react-native": "npm:@types/indy-sdk@^1.16.15",
     "@types/react-native": "^0.64.10",
     "indy-sdk-react-native": "^0.1.16",
     "react": "17.0.1",

yarn.lock

@@ -2242,10 +2242,10 @@
   dependencies:
     "@types/node" "*"
 
-"@types/indy-sdk-react-native@npm:@types/indy-sdk@^1.16.12", "@types/indy-sdk@^1.16.12":
-  version "1.16.12"
-  resolved "https://registry.npmjs.org/@types/indy-sdk/-/indy-sdk-1.16.12.tgz#7b6ad4e4ebf11125bd77f0ef98cf727d0262c4b7"
-  integrity sha512-6uyHSSAoM+eKQD4XF+KohAjbkDN6D9DnriYWlGi/pLCWkd74kCcEMlm7/REqfMkAgxL52wh7Cyzir+cnIi342g==
+"@types/indy-sdk-react-native@npm:@types/indy-sdk@^1.16.15", "@types/indy-sdk@^1.16.15":
+  version "1.16.16"
+  resolved "https://registry.yarnpkg.com/@types/indy-sdk/-/indy-sdk-1.16.16.tgz#dc9e51c61c266eff616991fa7df88309975d9f1e"
+  integrity sha512-bSWG56bAFvjTTLHJoGEXylbbN533g9XEtOTPS9G1EvIv5AsVcy/OIZOkXXElbzvYdZ1Q+qCxZDD5T0OqMYNmjg==
   dependencies:
     buffer "^6.0.0"