fix: Confirmation bridge verify backend

app/scripts/lib/tx-verification/tx-verification-middleware.test.ts

@@ -1,14 +1,22 @@
 import { NetworkController } from '@metamask/network-controller';
 import { JsonRpcParams, jsonrpc2 } from '@metamask/utils';
-import { FIRST_PARTY_CONTRACT_NAMES } from '../../../../shared/constants/first-party-contracts';
 import {
-  BridgeTxParams,
+  EXPERIENCES_TYPE,
+  FIRST_PARTY_CONTRACT_NAMES,
+} from '../../../../shared/constants/first-party-contracts';
+import {
   createTxVerificationMiddleware,
+  TxParams,
 } from './tx-verification-middleware';
 
 const getMockNetworkController = (chainId: `0x${string}` = '0x1') =>
   ({ state: { providerConfig: { chainId } } } as unknown as NetworkController);
 
+const mockTrustedSigners = {
+  [EXPERIENCES_TYPE.METAMASK_BRIDGE]:
+    '0xe672B534ccf9876a7554a1dD1685a2a5C2Cc8e8C',
+};
+
 const jsonRpcTemplate = { jsonrpc: jsonrpc2, id: 1 };
 
 const getMiddlewareParams = (method: string, params: JsonRpcParams = []) => {
@@ -19,9 +27,7 @@ const getMiddlewareParams = (method: string, params: JsonRpcParams = []) => {
   return { req, res, next, end };
 };
 
-const getBridgeTxParams = (
-  txParams: Partial<BridgeTxParams> = {},
-): [BridgeTxParams] => {
+const getBridgeTxParams = (txParams: Partial<TxParams> = {}): [TxParams] => {
   return [
     {
       data: '0x1',
@@ -37,6 +43,7 @@ describe('tx verification middleware', () => {
   it('ignores methods other than eth_sendTransaction', () => {
     const middleware = createTxVerificationMiddleware(
       getMockNetworkController(),
+      mockTrustedSigners,
     );
     const { req, res, next, end } = getMiddlewareParams('foo');
     middleware(req, res, next, end);
@@ -72,6 +79,7 @@ describe('tx verification middleware', () => {
     (_: string, invalidParams: JsonRpcParams) => {
       const middleware = createTxVerificationMiddleware(
         getMockNetworkController(),
+        mockTrustedSigners,
       );
 
       const { req, res, next, end } = getMiddlewareParams(
@@ -91,6 +99,7 @@ describe('tx verification middleware', () => {
     (chainId: `0x${string}`) => {
       const middleware = createTxVerificationMiddleware(
         getMockNetworkController(),
+        mockTrustedSigners,
       );
 
       const { req, res, next, end } = getMiddlewareParams(
@@ -110,6 +119,7 @@ describe('tx verification middleware', () => {
     (chainId: `0x${string}`) => {
       const middleware = createTxVerificationMiddleware(
         getMockNetworkController(),
+        mockTrustedSigners,
       );
 
       const { req, res, next, end } = getMiddlewareParams(
@@ -123,9 +133,58 @@ describe('tx verification middleware', () => {
     },
   );
 
+  it('calls next() if reverse address mapping look up is undefined', () => {
+    const middleware = createTxVerificationMiddleware(
+      getMockNetworkController(),
+      mockTrustedSigners,
+    );
+
+    const { req, res, next, end } = getMiddlewareParams(
+      'eth_sendTransaction',
+      getBridgeTxParams({ ...getFixtures().mapUndefined }),
+    );
+    middleware(req, res, next, end);
+
+    expect(next).toHaveBeenCalledTimes(1);
+    expect(end).not.toHaveBeenCalled();
+  });
+
+  it('calls next() if chainId for `to` address does not match', () => {
+    const middleware = createTxVerificationMiddleware(
+      getMockNetworkController(),
+      mockTrustedSigners,
+    );
+
+    const { req, res, next, end } = getMiddlewareParams(
+      'eth_sendTransaction',
+      getBridgeTxParams({ ...getFixtures().mapIncorrectChain }),
+    );
+    middleware(req, res, next, end);
+
+    expect(next).toHaveBeenCalledTimes(1);
+    expect(end).not.toHaveBeenCalled();
+  });
+
+  it('calls next() if experience type for `to` address is not an experience to verify', () => {
+    const middleware = createTxVerificationMiddleware(
+      getMockNetworkController(),
+      mockTrustedSigners,
+    );
+
+    const { req, res, next, end } = getMiddlewareParams(
+      'eth_sendTransaction',
+      getBridgeTxParams({ ...getFixtures().mapIncorrectExp }),
+    );
+    middleware(req, res, next, end);
+
+    expect(next).toHaveBeenCalledTimes(1);
+    expect(end).not.toHaveBeenCalled();
+  });
+
   it('passes through a valid bridge transaction', () => {
     const middleware = createTxVerificationMiddleware(
       getMockNetworkController(),
+      mockTrustedSigners,
     );
 
     const { req, res, next, end } = getMiddlewareParams(
@@ -141,6 +200,7 @@ describe('tx verification middleware', () => {
   it('rejects modified bridge transactions', () => {
     const middleware = createTxVerificationMiddleware(
       getMockNetworkController(),
+      mockTrustedSigners,
     );
 
     const { req, res, next, end } = getMiddlewareParams(
@@ -161,6 +221,24 @@ describe('tx verification middleware', () => {
  */
 function getFixtures() {
   return {
+    mapIncorrectExp: {
+      data: '0x3ce33bff0000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000470de4df82000000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000000f736f636b6574416461707465725632000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002800000000000000000000000003a23f943181408eac424116af7b7790c94cb97a50000000000000000000000003a23f943181408eac424116af7b7790c94cb97a5000000000000000000000000000000000000000000000000000000000000a4b10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000009f295cd5f000000000000000000000000000e6b738da243e8fa2a0ed5915645789add5de515200000000000000000000000000000000000000000000000000000000000001280000019fd025dec0000000000000000000000000e672b534ccf9876a7554a1dd1685a2a5c2cc8e8c000000000000000000000000b8901acb165ed027e32754e0ffe830802919727f000000000000000000000000710bda329b2a6224e4b44833de30f38e7f81d564000000000000000000000000000000000000000000000000000000000000a4b100000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000004614942c423e000000000000000000000000000000000000000000000000000000886c98b760000000000000000000000000000000000000000000000000000000019012a41ba800000000000000000000000000000000000000000000000000000000000000c40000000000000000000000000000000000000000000000005dedaf7e04c3f5c842c30ed9a4a19baceb915cdd3e865f0dad99ffca277743a20bac00e0f366e7265f1fcad502791ff49e9c5c98e1841a090df23ce5555051da1c',
+      from: '0xe672b534ccf9876a7554a1dd1685a2a5c2cc8e8c',
+      to: '0xc7bE520a13dC023A1b34C03F4Abdab8A43653F7B',
+      value: '0x470de4df820000',
+    },
+    mapIncorrectChain: {
+      data: '0x3ce33bff0000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000470de4df82000000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000000f736f636b6574416461707465725632000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002800000000000000000000000003a23f943181408eac424116af7b7790c94cb97a50000000000000000000000003a23f943181408eac424116af7b7790c94cb97a5000000000000000000000000000000000000000000000000000000000000a4b10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000009f295cd5f000000000000000000000000000e6b738da243e8fa2a0ed5915645789add5de515200000000000000000000000000000000000000000000000000000000000001280000019fd025dec0000000000000000000000000e672b534ccf9876a7554a1dd1685a2a5c2cc8e8c000000000000000000000000b8901acb165ed027e32754e0ffe830802919727f000000000000000000000000710bda329b2a6224e4b44833de30f38e7f81d564000000000000000000000000000000000000000000000000000000000000a4b100000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000004614942c423e000000000000000000000000000000000000000000000000000000886c98b760000000000000000000000000000000000000000000000000000000019012a41ba800000000000000000000000000000000000000000000000000000000000000c40000000000000000000000000000000000000000000000005dedaf7e04c3f5c842c30ed9a4a19baceb915cdd3e865f0dad99ffca277743a20bac00e0f366e7265f1fcad502791ff49e9c5c98e1841a090df23ce5555051da1c',
+      from: '0xe672b534ccf9876a7554a1dd1685a2a5c2cc8e8c',
+      to: `0xaEc23140408534b378bf5832defc426dF8604B59`,
+      value: '0x470de4df820000',
+    },
+    mapUndefined: {
+      data: '0x3ce33bff0000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000470de4df82000000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000000f736f636b6574416461707465725632000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002800000000000000000000000003a23f943181408eac424116af7b7790c94cb97a50000000000000000000000003a23f943181408eac424116af7b7790c94cb97a5000000000000000000000000000000000000000000000000000000000000a4b10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000009f295cd5f000000000000000000000000000e6b738da243e8fa2a0ed5915645789add5de515200000000000000000000000000000000000000000000000000000000000001280000019fd025dec0000000000000000000000000e672b534ccf9876a7554a1dd1685a2a5c2cc8e8c000000000000000000000000b8901acb165ed027e32754e0ffe830802919727f000000000000000000000000710bda329b2a6224e4b44833de30f38e7f81d564000000000000000000000000000000000000000000000000000000000000a4b100000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000004614942c423e000000000000000000000000000000000000000000000000000000886c98b760000000000000000000000000000000000000000000000000000000019012a41ba800000000000000000000000000000000000000000000000000000000000000c40000000000000000000000000000000000000000000000005dedaf7e04c3f5c842c30ed9a4a19baceb915cdd3e865f0dad99ffca277743a20bac00e0f366e7265f1fcad502791ff49e9c5c98e1841a090df23ce5555051da1c',
+      from: '0xe672b534ccf9876a7554a1dd1685a2a5c2cc8e8c',
+      to: '0x0439e60F02a8900a951603950d8D4527f400C3f9',
+      value: '0x470de4df820000',
+    },
     valid: {
       data: '0x3ce33bff0000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000470de4df82000000000000000000000000000000000000000000000000000000000000000000c0000000000000000000000000000000000000000000000000000000000000000f736f636b6574416461707465725632000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002800000000000000000000000003a23f943181408eac424116af7b7790c94cb97a50000000000000000000000003a23f943181408eac424116af7b7790c94cb97a5000000000000000000000000000000000000000000000000000000000000a4b10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000009f295cd5f000000000000000000000000000e6b738da243e8fa2a0ed5915645789add5de515200000000000000000000000000000000000000000000000000000000000001280000019fd025dec0000000000000000000000000e672b534ccf9876a7554a1dd1685a2a5c2cc8e8c000000000000000000000000b8901acb165ed027e32754e0ffe830802919727f000000000000000000000000710bda329b2a6224e4b44833de30f38e7f81d564000000000000000000000000000000000000000000000000000000000000a4b100000000000000000000000000000000000000000000000000466ebb82ac1000000000000000000000000000000000000000000000000000004614942c423e000000000000000000000000000000000000000000000000000000886c98b760000000000000000000000000000000000000000000000000000000019012a41ba800000000000000000000000000000000000000000000000000000000000000c40000000000000000000000000000000000000000000000005dedaf7e04c3f5c842c30ed9a4a19baceb915cdd3e865f0dad99ffca277743a20bac00e0f366e7265f1fcad502791ff49e9c5c98e1841a090df23ce5555051da1c',
       from: '0xe672b534ccf9876a7554a1dd1685a2a5c2cc8e8c',

app/scripts/lib/tx-verification/tx-verification-middleware.ts

@@ -2,20 +2,29 @@ import { hashMessage } from '@ethersproject/hash';
 import { verifyMessage } from '@ethersproject/wallet';
 import type { NetworkController } from '@metamask/network-controller';
 import { rpcErrors } from '@metamask/rpc-errors';
-import { Json, JsonRpcParams, hasProperty, isObject } from '@metamask/utils';
+import {
+  Json,
+  JsonRpcParams,
+  hasProperty,
+  isObject,
+  Hex,
+} from '@metamask/utils';
 import {
   JsonRpcRequest,
   JsonRpcResponse,
   JsonRpcEngineEndCallback,
   JsonRpcEngineNextCallback,
 } from 'json-rpc-engine';
 import {
-  SIG_LEN,
-  TRUSTED_BRIDGE_SIGNER,
-} from '../../../../shared/constants/bridge';
-import { FIRST_PARTY_CONTRACT_NAMES } from '../../../../shared/constants/first-party-contracts';
+  EXPERIENCES_TO_VERIFY,
+  addrToExpMap,
+  TX_SIG_LEN,
+  TRUSTED_SIGNERS,
+} from '../../../../shared/constants/verification';
+import { EXPERIENCES_TYPE } from '../../../../shared/constants/first-party-contracts';
+import { MESSAGE_TYPE } from '../../../../shared/constants/app';
 
-export type BridgeTxParams = {
+export type TxParams = {
   chainId?: `0x${string}`;
   data: string;
   from: string;
@@ -28,10 +37,12 @@ export type BridgeTxParams = {
  * Portfolio.
  *
  * @param networkController - The network controller instance.
+ * @param trustedSigners
  * @returns The middleware function.
  */
 export function createTxVerificationMiddleware(
   networkController: NetworkController,
+  trustedSigners = TRUSTED_SIGNERS,
 ) {
   return function txVerificationMiddleware(
     req: JsonRpcRequest<JsonRpcParams>,
@@ -40,7 +51,7 @@ export function createTxVerificationMiddleware(
     end: JsonRpcEngineEndCallback,
   ) {
     if (
-      req.method !== 'eth_sendTransaction' ||
+      req.method !== MESSAGE_TYPE.ETH_SEND_TRANSACTION ||
       !Array.isArray(req.params) ||
       !isValidParams(req.params)
     ) {
@@ -49,55 +60,55 @@ export function createTxVerificationMiddleware(
 
     // the tx object is the first element
     const params = req.params[0];
-
     const chainId =
       typeof params.chainId === 'string'
-        ? (params.chainId.toLowerCase() as `0x${string}`)
+        ? (params.chainId.toLowerCase() as Hex)
         : networkController.state.providerConfig.chainId;
 
-    // skip verification if bridge is not deployed on the specified chain.
-    // skip verification to address is not the bridge contract
-    if (
-      !Object.keys(FIRST_PARTY_CONTRACT_NAMES['MetaMask Bridge']).includes(
-        chainId,
-      ) ||
-      params.to.toLowerCase() !==
-        FIRST_PARTY_CONTRACT_NAMES['MetaMask Bridge'][chainId].toLowerCase()
-    ) {
+    const r = addrToExpMap[params.to.toLowerCase()];
+    // if undefined then no address matched
+    if (!r) {
+      return next();
+    }
+    const { experienceType, chainId: experienceChainId } = r;
+    // skip if chainId is different
+    if (experienceChainId !== chainId) {
+      return next();
+    }
+    // skip if experience is not one we want to verify against
+    if (!EXPERIENCES_TO_VERIFY.includes(experienceType as EXPERIENCES_TYPE)) {
       return next();
     }
 
-    const paramsToVerify = {
-      to: hashMessage(params.to.toLowerCase()),
-      from: hashMessage(params.from.toLowerCase()),
-      data: hashMessage(
-        params.data.toLowerCase().slice(0, params.data.length - SIG_LEN),
-      ),
-      value: hashMessage(params.value.toLowerCase()),
-    };
-    const hashedParams = hashMessage(JSON.stringify(paramsToVerify));
-
-    // signature is 130 chars in length at the end
-    const signature = `0x${params.data.slice(-SIG_LEN)}`;
-    const addressToVerify = verifyMessage(hashedParams, signature);
-
-    if (addressToVerify.toLowerCase() !== TRUSTED_BRIDGE_SIGNER.toLowerCase()) {
-      return end(
-        rpcErrors.invalidParams('Invalid bridge transaction signature.'),
-      );
+    const signature = `0x${params.data.slice(-TX_SIG_LEN)}`;
+    const addressToVerify = verifyMessage(hashedParams(params), signature);
+    if (addressToVerify !== trustedSigners[experienceType]) {
+      return end(rpcErrors.invalidParams('Invalid transaction signature.'));
     }
     return next();
   };
 }
 
+function hashedParams(params: TxParams): string {
+  const paramsToVerify = {
+    to: hashMessage(params.to.toLowerCase()),
+    from: hashMessage(params.from.toLowerCase()),
+    data: hashMessage(
+      params.data.toLowerCase().slice(0, params.data.length - TX_SIG_LEN),
+    ),
+    value: hashMessage(params.value.toLowerCase()),
+  };
+  return hashMessage(JSON.stringify(paramsToVerify));
+}
+
 /**
  * Checks if the params of a JSON-RPC request are valid `eth_sendTransaction`
  * params.
  *
  * @param params - The params to validate.
  * @returns Whether the params are valid.
  */
-function isValidParams(params: Json[]): params is [BridgeTxParams] {
+function isValidParams(params: Json[]): params is [TxParams] {
   return (
     isObject(params[0]) &&
     typeof params[0].data === 'string' &&

shared/constants/app.ts

@@ -34,6 +34,8 @@ export const MESSAGE_TYPE = {
   ETH_GET_ENCRYPTION_PUBLIC_KEY: 'eth_getEncryptionPublicKey',
   ETH_GET_BLOCK_BY_NUMBER: 'eth_getBlockByNumber',
   ETH_REQUEST_ACCOUNTS: 'eth_requestAccounts',
+  ETH_SEND_TRANSACTION: 'eth_sendTransaction',
+  ETH_SEND_RAW_TRANSACTION: 'eth_sendRawTransaction',
   ETH_SIGN: 'eth_sign',
   ETH_SIGN_TRANSACTION: 'eth_signTransaction',
   ETH_SIGN_TYPED_DATA: 'eth_signTypedData',

shared/constants/bridge.ts

@@ -11,8 +11,3 @@ export const ALLOWED_BRIDGE_CHAIN_IDS = [
   CHAIN_IDS.LINEA_MAINNET,
   CHAIN_IDS.BASE,
 ];
-
-export const TRUSTED_BRIDGE_SIGNER =
-  '0x533FbF047Ed13C20e263e2576e41c747206d1348';
-
-export const SIG_LEN = 130;