From c2234f2cc7e96eaf6d03a92811ae70887829bafc Mon Sep 17 00:00:00 2001 From: soumalyabhanja Date: Mon, 16 Sep 2024 16:32:31 +0530 Subject: [PATCH] feat(sdk-core): add utility function for get sharing keys API Utility function to be used by both bulk and non-bulk version of the API Ticket: CSI-107 --- commitlint.config.js | 1 + modules/bitgo/test/v2/unit/wallets.ts | 1 + modules/sdk-core/src/bitgo/errors.ts | 6 + modules/sdk-core/src/bitgo/wallet/iWallet.ts | 8 + modules/sdk-core/src/bitgo/wallet/wallet.ts | 166 +++++++++---------- 5 files changed, 98 insertions(+), 84 deletions(-) diff --git a/commitlint.config.js b/commitlint.config.js index 39052c8545..358dab4a9b 100644 --- a/commitlint.config.js +++ b/commitlint.config.js @@ -26,6 +26,7 @@ module.exports = { 'CP-', 'CR-', 'CS-', + 'CSI-', 'DES-', 'DO-', 'DOS-', diff --git a/modules/bitgo/test/v2/unit/wallets.ts b/modules/bitgo/test/v2/unit/wallets.ts index 6d79ae8706..2b12844399 100644 --- a/modules/bitgo/test/v2/unit/wallets.ts +++ b/modules/bitgo/test/v2/unit/wallets.ts @@ -1805,6 +1805,7 @@ describe('V2 Wallets:', function () { sinon.stub(wallet, 'getEncryptedUserKeychain').resolves({ encryptedPrv: keychainTest.encryptedPrv, + pub, } as KeychainWithEncryptedPrv); sinon.stub(moduleBitgo, 'getSharedSecret').resolves('fakeSharedSecret'); diff --git a/modules/sdk-core/src/bitgo/errors.ts b/modules/sdk-core/src/bitgo/errors.ts index de795c59a7..81fc54f162 100644 --- a/modules/sdk-core/src/bitgo/errors.ts +++ b/modules/sdk-core/src/bitgo/errors.ts @@ -157,6 +157,12 @@ export class InvalidTransactionError extends BitGoJsError { } } +export class MissingEncryptedKeychainError extends Error { + public constructor(message?: string) { + super(message || 'No encrypted keychains on this wallet.'); + } +} + export class ApiResponseError extends BitGoJsError { message: string; status: number; diff --git a/modules/sdk-core/src/bitgo/wallet/iWallet.ts b/modules/sdk-core/src/bitgo/wallet/iWallet.ts index c361879c79..d7d11ca8ba 100644 --- a/modules/sdk-core/src/bitgo/wallet/iWallet.ts +++ b/modules/sdk-core/src/bitgo/wallet/iWallet.ts @@ -450,6 +450,14 @@ export interface GetPrvOptions { walletPassphrase?: string; } +export interface SharedKeyChain { + pub?: string; + encryptedPrv?: string; + fromPubKey?: string; + toPubKey?: string; + path?: string; +} + export interface CreateShareOptions { user?: string; permissions?: string; diff --git a/modules/sdk-core/src/bitgo/wallet/wallet.ts b/modules/sdk-core/src/bitgo/wallet/wallet.ts index c07b329dba..40d6c73755 100644 --- a/modules/sdk-core/src/bitgo/wallet/wallet.ts +++ b/modules/sdk-core/src/bitgo/wallet/wallet.ts @@ -17,7 +17,7 @@ import { import { makeRandomKey } from '../bitcoin'; import { BitGoBase } from '../bitgoBase'; import { getSharedSecret } from '../ecdh'; -import { AddressGenerationError, MethodNotImplementedError } from '../errors'; +import { AddressGenerationError, MethodNotImplementedError, MissingEncryptedKeychainError } from '../errors'; import * as internal from '../internal/internal'; import { drawKeycard } from '../internal'; import { decryptKeychainPrivateKey, Keychain, KeychainWithEncryptedPrv } from '../keychain'; @@ -94,6 +94,8 @@ import { WalletSignTypedDataOptions, WalletType, CreateBulkWalletShareListResponse, + SharedKeyChain, + BulkWalletShareKeychain, } from './iWallet'; import { StakingWallet } from '../staking'; import { Lightning } from '../lightning/custodial'; @@ -1391,7 +1393,7 @@ export class Wallet implements IWallet { async getEncryptedUserKeychain(): Promise { const tryKeyChain = async (index: number): Promise => { if (!this._wallet.keys || index >= this._wallet.keys.length) { - throw new Error('No encrypted keychains on this wallet.'); + throw new MissingEncryptedKeychainError(); } const params = { id: this._wallet.keys[index] }; @@ -1483,7 +1485,7 @@ export class Wallet implements IWallet { * @returns {Promise} A promise that resolves with the response of the bulk wallet share creation. */ async createBulkWalletShare(params: BulkWalletShareOptions): Promise { - if (!params.keyShareOptions || Object.keys(params.keyShareOptions).length === 0) { + if (params.keyShareOptions.length === 0) { throw new Error('shareOptions cannot be empty'); } const bulkCreateShareOptions: BulkCreateShareOption[] = []; @@ -1492,54 +1494,33 @@ export class Wallet implements IWallet { common.validateParams(shareOption, ['userId', 'pubKey', 'path'], []); const needsKeychain = shareOption.permissions && shareOption.permissions.includes('spend'); - let sharedKeychain; if (needsKeychain) { - try { - const keychain = await this.getEncryptedUserKeychain(); - - if (keychain.encryptedPrv) { - const userPrv = decryptKeychainPrivateKey(this.bitgo, keychain, params.walletPassphrase); - if (!userPrv) { - throw new Error('Unable to decrypt user keychain.'); - } - - const ecdhkey = makeRandomKey(); - assert(shareOption.pubKey, 'pubKey must be defined for sharing'); - - const secret = getSharedSecret(ecdhkey, Buffer.from(shareOption.pubKey, 'hex')).toString('hex'); - const newEncryptedPrv = this.bitgo.encrypt({ password: secret, input: userPrv }); - - let pub = keychain.pub ?? keychain.commonPub; - if (keychain.commonKeychain) { - pub = - this.baseCoin.getMPCAlgorithm() === 'eddsa' - ? EddsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain) - : EcdsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain); - } - - sharedKeychain = { - pub, - encryptedPrv: newEncryptedPrv, - fromPubKey: ecdhkey.publicKey.toString('hex'), - toPubKey: shareOption.pubKey, - path: shareOption.path, - }; - } - } catch (e) { - if (e.message === 'No encrypted keychains on this wallet.') { - sharedKeychain = {}; - // ignore this error because this looks like a cold wallet - } else { - throw e; - } - } + const sharedKeychain = await this.prepareSharedKeychain( + params.walletPassphrase, + shareOption.pubKey, + shareOption.path + ); const keychain = Object.keys(sharedKeychain ?? {}).length === 0 ? undefined : sharedKeychain; if (keychain) { + assert(keychain.pub, 'pub must be defined for sharing'); + assert(keychain.encryptedPrv, 'encryptedPrv must be defined for sharing'); + assert(keychain.fromPubKey, 'fromPubKey must be defined for sharing'); + assert(keychain.toPubKey, 'toPubKey must be defined for sharing'); + assert(keychain.path, 'path must be defined for sharing'); + + const bulkKeychain: BulkWalletShareKeychain = { + pub: keychain.pub, + encryptedPrv: keychain.encryptedPrv, + fromPubKey: keychain.fromPubKey, + toPubKey: keychain.toPubKey, + path: keychain.path, + }; + bulkCreateShareOptions.push({ user: shareOption.userId, permissions: shareOption.permissions, - keychain: keychain, + keychain: bulkKeychain, }); } } @@ -1578,6 +1559,61 @@ export class Wallet implements IWallet { return this.bitgo.post(url).send({ shareOptions: params }).result(); } + async prepareSharedKeychain( + walletPassphrase: string | undefined, + pubkey: string, + path: string + ): Promise { + let sharedKeychain: SharedKeyChain = {}; + + try { + const keychain = await this.getEncryptedUserKeychain(); + + // Decrypt the user key with a passphrase + if (keychain.encryptedPrv) { + if (!walletPassphrase) { + throw new Error('Missing walletPassphrase argument'); + } + + const userPrv = decryptKeychainPrivateKey(this.bitgo, keychain, walletPassphrase); + if (!userPrv) { + throw new Error('Unable to decrypt user keychain'); + } + + keychain.prv = userPrv; + const eckey = makeRandomKey(); + const secret = getSharedSecret(eckey, Buffer.from(pubkey, 'hex')).toString('hex'); + const newEncryptedPrv = this.bitgo.encrypt({ password: secret, input: keychain.prv }); + + // Only one of pub/commonPub/commonKeychain should be present in the keychain + let pub = keychain.pub ?? keychain.commonPub; + if (keychain.commonKeychain) { + pub = + this.baseCoin.getMPCAlgorithm() === 'eddsa' + ? EddsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain) + : EcdsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain); + } + + sharedKeychain = { + pub, + encryptedPrv: newEncryptedPrv, + fromPubKey: eckey.publicKey.toString('hex'), + toPubKey: pubkey, + path: path, + }; + } + } catch (e) { + if (e instanceof MissingEncryptedKeychainError) { + sharedKeychain = {}; + // ignore this error because this looks like a cold wallet + } else { + throw e; + } + } + + return sharedKeychain; + } + /** * Share this wallet with another BitGo user. * @param params @@ -1605,47 +1641,9 @@ export class Wallet implements IWallet { const sharing = (await this.bitgo.getSharingKey({ email: params.email.toLowerCase() })) as any; let sharedKeychain; if (needsKeychain) { - try { - const keychain = await this.getEncryptedUserKeychain(); - // Decrypt the user key with a passphrase - if (keychain.encryptedPrv) { - if (!params.walletPassphrase) { - throw new Error('Missing walletPassphrase argument'); - } - const userPrv = decryptKeychainPrivateKey(this.bitgo, keychain, params.walletPassphrase); - if (!userPrv) { - throw new Error('Unable to decrypt user keychain'); - } - keychain.prv = userPrv; - - const eckey = makeRandomKey(); - const secret = getSharedSecret(eckey, Buffer.from(sharing.pubkey, 'hex')).toString('hex'); - const newEncryptedPrv = this.bitgo.encrypt({ password: secret, input: keychain.prv }); - // Only one of pub/commonPub/commonKeychain should be present in the keychain - let pub = keychain.pub ?? keychain.commonPub; - if (keychain.commonKeychain) { - pub = - this.baseCoin.getMPCAlgorithm() === 'eddsa' - ? EddsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain) - : EcdsaUtils.getPublicKeyFromCommonKeychain(keychain.commonKeychain); - } - sharedKeychain = { - pub, - encryptedPrv: newEncryptedPrv, - fromPubKey: eckey.publicKey.toString('hex'), - toPubKey: sharing.pubkey, - path: sharing.path, - }; - } - } catch (e) { - if (e.message === 'No encrypted keychains on this wallet.') { - sharedKeychain = {}; - // ignore this error because this looks like a cold wallet - } else { - throw e; - } - } + sharedKeychain = await this.prepareSharedKeychain(params.walletPassphrase, sharing.pubkey, sharing.path); } + const options: CreateShareOptions = { user: sharing.userId, permissions: params.permissions,