Merge pull request #91 from BitGo/WP-5319/hide-recovery-api-ebe-v2

feat(ebe): hide recovery api under non recovery mode

Author: pranavjain97

src/__tests__/api/enclaved/nonRecovery.test.ts

@@ -0,0 +1,72 @@
+import 'should';
+import * as request from 'supertest';
+import nock from 'nock';
+import { app as expressApp } from '../../../enclavedApp';
+import { AppMode, EnclavedConfig, TlsMode } from '../../../shared/types';
+import sinon from 'sinon';
+import * as middleware from '../../../shared/middleware';
+import { BitGoRequest } from '../../../types/request';
+import { BitGoAPI as BitGo } from '@bitgo-beta/sdk-api';
+
+describe('Non Recovery', () => {
+  let agent: request.SuperAgentTest;
+  const coin = 'tbtc';
+  const config: EnclavedConfig = {
+    appMode: AppMode.ENCLAVED,
+    port: 0,
+    bind: 'localhost',
+    timeout: 60000,
+    tlsMode: TlsMode.DISABLED,
+    httpLoggerFile: '',
+    allowSelfSigned: true,
+    kmsUrl: 'kms.example.com',
+  };
+
+  beforeEach(() => {
+    nock.disableNetConnect();
+    nock.enableNetConnect('127.0.0.1');
+
+    // Initialize BitGo with test environment
+    const bitgo = new BitGo({
+      env: 'test',
+      accessToken: 'test_token',
+    });
+
+    // Setup middleware stubs before creating app
+    sinon.stub(middleware, 'prepareBitGo').callsFake(() => (req, res, next) => {
+      (req as BitGoRequest<EnclavedConfig>).bitgo = bitgo;
+      (req as BitGoRequest<EnclavedConfig>).config = config;
+      next();
+    });
+
+    // Create app after middleware is stubbed
+    const app = expressApp(config);
+    agent = request.agent(app);
+  });
+
+  afterEach(() => {
+    nock.cleanAll();
+    sinon.restore();
+  });
+
+  it('should fail to run ebe recovery if not in recovery mode', async () => {
+    const userPub = 'xpub_user';
+    const backupPub = 'xpub_backup';
+    const bitgoPub = 'xpub_bitgo';
+
+    const response = await agent.post(`/api/${coin}/multisig/recovery`).send({
+      userPub,
+      backupPub,
+      bitgoPub,
+      unsignedSweepPrebuildTx: {},
+      walletContractAddress: '',
+      coin,
+    });
+    response.status.should.equal(500);
+    response.body.should.have.property('error');
+    response.body.should.have.property('details');
+    response.body.details.should.containEql(
+      'Recovery operations are not enabled. The server must be in recovery mode to perform this action.',
+    );
+  });
+});

src/__tests__/api/enclaved/recoveryMultisigTransaction.test.ts

@@ -22,6 +22,7 @@ describe('UTXO recovery', () => {
     tlsMode: TlsMode.DISABLED,
     allowSelfSigned: true,
     kmsUrl: 'kms.example.com',
+    recoveryMode: true,
   };
 
   beforeEach(() => {

src/__tests__/api/enclaved/recoveryMusigEth.test.ts

@@ -40,6 +40,7 @@ describe('recoveryMultisigTransaction', () => {
       kmsUrl: kmsUrl,
       tlsMode: TlsMode.DISABLED,
       allowSelfSigned: true,
+      recoveryMode: true,
     };
 
     configStub = sinon.stub(configModule, 'initConfig').returns(cfg);

src/__tests__/api/enclaved/signMpcRecoveryTransaction.test.ts

@@ -18,6 +18,7 @@ describe('EdDSA Recovery Signing', () => {
     httpLoggerFile: '',
     tlsMode: TlsMode.DISABLED,
     allowSelfSigned: true,
+    recoveryMode: true,
   };
 
   const commonKeychain =

src/api/enclaved/handlers/recoveryMultisigTransaction.ts

@@ -6,7 +6,7 @@ import {
   TransactionRecipient,
 } from '@bitgo-beta/sdk-core';
 import { EnclavedApiSpecRouteRequest } from '../../../enclavedBitgoExpress/routers/enclavedApiSpec';
-import { EnvironmentName } from '../../../initConfig';
+import { EnclavedConfig, EnvironmentName } from '../../../initConfig';
 import logger from '../../../logger';
 import {
   isEthLikeCoin,
@@ -19,12 +19,14 @@ import {
   getReplayProtectionOptions,
 } from '../../../shared/recoveryUtils';
 import { SignedEthLikeRecoveryTx } from '../../../types/transaction';
-import { retrieveKmsPrvKey } from '../utils';
+import { checkRecoveryMode, retrieveKmsPrvKey } from '../utils';
 import coinFactory from '../../../shared/coinFactory';
 
 export async function recoveryMultisigTransaction(
   req: EnclavedApiSpecRouteRequest<'v1.multisig.recovery', 'post'>,
 ): Promise<any> {
+  checkRecoveryMode(req.config as EnclavedConfig);
+
   const { userPub, backupPub, bitgoPub, unsignedSweepPrebuildTx, walletContractAddress, coin } =
     req.decoded;
 

src/api/enclaved/handlers/signEddsaRecoveryTransaction.ts

@@ -10,7 +10,7 @@ import {
 import { Ed25519Bip32HdTree } from '@bitgo-beta/sdk-lib-mpc';
 import { CoinFamily, coins } from '@bitgo-beta/statics';
 import { type KeyPair as SolKeyPair } from '@bitgo-beta/sdk-coin-sol';
-import { retrieveKmsPrvKey } from '../utils';
+import { checkRecoveryMode, retrieveKmsPrvKey } from '../utils';
 import { EnclavedConfig } from '../../../shared/types';
 import logger from '../../../logger';
 
@@ -88,6 +88,8 @@ export async function signEddsaRecoveryTransaction({
   let publicKey = '';
   logger.info(`Received request ${JSON.stringify(request)}`);
 
+  checkRecoveryMode(cfg);
+
   const hdTree = await Ed25519Bip32HdTree.initialize();
   const MPC = await Eddsa.initialize(hdTree);
 

src/api/enclaved/utils.ts

@@ -116,3 +116,11 @@ export async function decryptDataKey({
     };
   }
 }
+
+export function checkRecoveryMode(config: EnclavedConfig) {
+  if (!config.recoveryMode) {
+    throw new Error(
+      'Recovery operations are not enabled. The server must be in recovery mode to perform this action.',
+    );
+  }
+}