@metamask-previews/keyring-controller 22.0.2-preview-2873423 → 22.0.2-preview-a272c5e1

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add support for envelope encryption ([#5940](https://github.com/MetaMask/core/pull/5940))
+
+### Changed
+
+- Upgrade mock encryptor to support multiple ciphertexts ([#5943](https://github.com/MetaMask/core/pull/5943))
+
 ## [22.0.2]
 
 ### Fixed

package/dist/KeyringController.cjs

@@ -36,7 +36,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringByIdOrDefault, _KeyringController_getKeyringMetadata, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_getSessionState, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_isNewEncryptionAvailable, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_createKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_assertNoDuplicateAccounts, _KeyringController_setUnlocked, _KeyringController_assertIsUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
+var _KeyringController_instances, _KeyringController_controllerOperationMutex, _KeyringController_vaultOperationMutex, _KeyringController_keyringBuilders, _KeyringController_encryptor, _KeyringController_cacheEncryptionKey, _KeyringController_keyrings, _KeyringController_unsupportedKeyrings, _KeyringController_password, _KeyringController_encryptionKey, _KeyringController_qrKeyringStateListener, _KeyringController_registerMessageHandlers, _KeyringController_getKeyringById, _KeyringController_getKeyringByIdOrDefault, _KeyringController_getKeyringMetadata, _KeyringController_getKeyringBuilderForType, _KeyringController_addQRKeyring, _KeyringController_subscribeToQRKeyringEvents, _KeyringController_unsubscribeFromQRKeyringsEvents, _KeyringController_createNewVaultWithKeyring, _KeyringController_updateCachedEncryptionKey, _KeyringController_verifySeedPhrase, _KeyringController_getUpdatedKeyrings, _KeyringController_getSerializedKeyrings, _KeyringController_getSessionState, _KeyringController_restoreSerializedKeyrings, _KeyringController_unlockKeyrings, _KeyringController_updateVault, _KeyringController_isNewEncryptionAvailable, _KeyringController_isEnvelopeEncryptionEnabled, _KeyringController_getAccountsFromKeyrings, _KeyringController_createKeyringWithFirstAccount, _KeyringController_newKeyring, _KeyringController_createKeyring, _KeyringController_clearKeyrings, _KeyringController_restoreKeyring, _KeyringController_destroyKeyring, _KeyringController_removeEmptyKeyrings, _KeyringController_assertNoDuplicateAccounts, _KeyringController_setUnlocked, _KeyringController_assertIsUnlocked, _KeyringController_persistOrRollback, _KeyringController_withRollback, _KeyringController_assertControllerMutexIsLocked, _KeyringController_withControllerLock, _KeyringController_withVaultLock;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyringController = exports.getDefaultKeyringState = exports.keyringBuilderFactory = exports.SignTypedDataVersion = exports.AccountImportStrategy = exports.isCustodyKeyring = exports.KeyringTypes = void 0;
 const util_1 = require("@ethereumjs/util");
@@ -168,6 +168,17 @@ function assertIsValidPassword(password) {
         throw new Error(constants_1.KeyringControllerError.InvalidEmptyPassword);
     }
 }
+/**
+ * Assert that the provided cacheEncryptionKey is true.
+ *
+ * @param cacheEncryptionKey - The cacheEncryptionKey to check.
+ * @throws If the cacheEncryptionKey is not true.
+ */
+function assertIsCacheEncryptionKeyTrue(cacheEncryptionKey) {
+    if (!cacheEncryptionKey) {
+        throw new Error(constants_1.KeyringControllerError.CacheEncryptionKeyDisabled);
+    }
+}
 /**
  * Checks if the provided value is a serialized keyrings array.
  *
@@ -258,6 +269,7 @@ class KeyringController extends base_controller_1.BaseController {
                 keyrings: { persist: false, anonymous: false },
                 encryptionKey: { persist: false, anonymous: false },
                 encryptionSalt: { persist: false, anonymous: false },
+                encryptedEncryptionKey: { persist: true, anonymous: false },
             },
             messenger,
             state: {
@@ -274,6 +286,7 @@ class KeyringController extends base_controller_1.BaseController {
         _KeyringController_keyrings.set(this, void 0);
         _KeyringController_unsupportedKeyrings.set(this, void 0);
         _KeyringController_password.set(this, void 0);
+        _KeyringController_encryptionKey.set(this, void 0);
         _KeyringController_qrKeyringStateListener.set(this, void 0);
         __classPrivateFieldSet(this, _KeyringController_keyringBuilders, keyringBuilders
             ? keyringBuilders.concat(defaultKeyringBuilders)
@@ -373,19 +386,22 @@ class KeyringController extends base_controller_1.BaseController {
     /**
      * Create a new vault and primary keyring.
      *
-     * This only works if keyrings are empty. If there is a pre-existing unlocked vault, calling this will have no effect.
-     * If there is a pre-existing locked vault, it will be replaced.
+     * This only works if keyrings are empty. If there is a pre-existing unlocked
+     * vault, calling this will have no effect. If there is a pre-existing locked
+     * vault, it will be replaced.
      *
      * @param password - Password to unlock the new vault.
+     * @param encryptionKey - Optional encryption key to encrypt the new vault. If
+     * set, envelope encryption will be used.
      * @returns Promise resolving when the operation ends successfully.
      */
-    async createNewVaultAndKeychain(password) {
+    async createNewVaultAndKeychain(password, encryptionKey) {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             const accounts = await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getAccountsFromKeyrings).call(this);
             if (!accounts.length) {
                 await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createNewVaultWithKeyring).call(this, password, {
                     type: KeyringTypes.hd,
-                });
+                }, encryptionKey);
             }
         });
     }
@@ -414,7 +430,16 @@ class KeyringController extends base_controller_1.BaseController {
         if (!this.state.vault) {
             throw new Error(constants_1.KeyringControllerError.VaultError);
         }
-        await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decrypt(password, this.state.vault);
+        if (this.state.encryptedEncryptionKey) {
+            // Envelope encryption mode.
+            assertIsExportableKeyEncryptor(__classPrivateFieldGet(this, _KeyringController_encryptor, "f"));
+            const key = (await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decrypt(password, this.state.encryptedEncryptionKey));
+            const importedKey = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").importKey(key);
+            await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decryptWithKey(importedKey, this.state.vault);
+        }
+        else {
+            await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decrypt(password, this.state.vault);
+        }
     }
     /**
      * Returns the status of the vault.
@@ -603,7 +628,7 @@ class KeyringController extends base_controller_1.BaseController {
                     try {
                         wallet = ethereumjs_wallet_1.thirdparty.fromEtherWallet(input, password);
                     }
-                    catch (e) {
+                    catch {
                         wallet = wallet || (await ethereumjs_wallet_1.default.fromV3(input, password, true));
                     }
                     privateKey = (0, utils_1.bytesToHex)(wallet.getPrivateKey());
@@ -662,6 +687,7 @@ class KeyringController extends base_controller_1.BaseController {
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withRollback).call(this, async () => {
             __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_unsubscribeFromQRKeyringsEvents).call(this);
             __classPrivateFieldSet(this, _KeyringController_password, undefined, "f");
+            __classPrivateFieldSet(this, _KeyringController_encryptionKey, undefined, "f");
             await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
             this.update((state) => {
                 state.isUnlocked = false;
@@ -842,10 +868,24 @@ class KeyringController extends base_controller_1.BaseController {
      * @returns Promise resolving when the operation completes.
      */
     changePassword(password) {
+        return this.changePasswordAndEncryptionKey(password);
+    }
+    /**
+     * Changes the password and encryption key used to encrypt the vault.
+     *
+     * @param password - The new password.
+     * @param encryptionKey - The new encryption key. If omitted, the encryption
+     * key will not be changed.
+     * @returns Promise resolving when the operation completes.
+     */
+    changePasswordAndEncryptionKey(password, encryptionKey) {
         __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertIsUnlocked).call(this);
         return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_persistOrRollback).call(this, async () => {
             assertIsValidPassword(password);
+            // Update password.
             __classPrivateFieldSet(this, _KeyringController_password, password, "f");
+            // Update encryption key.
+            __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateCachedEncryptionKey).call(this, encryptionKey);
             // We need to clear encryption key and salt from state
             // to force the controller to re-encrypt the vault using
             // the new password.
@@ -1159,7 +1199,7 @@ class KeyringController extends base_controller_1.BaseController {
     }
 }
 exports.KeyringController = KeyringController;
-_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_qrKeyringStateListener = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
+_KeyringController_controllerOperationMutex = new WeakMap(), _KeyringController_vaultOperationMutex = new WeakMap(), _KeyringController_keyringBuilders = new WeakMap(), _KeyringController_encryptor = new WeakMap(), _KeyringController_cacheEncryptionKey = new WeakMap(), _KeyringController_keyrings = new WeakMap(), _KeyringController_unsupportedKeyrings = new WeakMap(), _KeyringController_password = new WeakMap(), _KeyringController_encryptionKey = new WeakMap(), _KeyringController_qrKeyringStateListener = new WeakMap(), _KeyringController_instances = new WeakSet(), _KeyringController_registerMessageHandlers = function _KeyringController_registerMessageHandlers() {
     this.messagingSystem.registerActionHandler(`${name}:signMessage`, this.signMessage.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signEip7702Authorization`, this.signEip7702Authorization.bind(this));
     this.messagingSystem.registerActionHandler(`${name}:signPersonalMessage`, this.signPersonalMessage.bind(this));
@@ -1228,9 +1268,10 @@ async function _KeyringController_addQRKeyring() {
  * @param keyring - A object containing the params to instantiate a new keyring.
  * @param keyring.type - The keyring type.
  * @param keyring.opts - Optional parameters required to instantiate the keyring.
+ * @param encryptionKey - Optional encryption key to encrypt the vault.
  * @returns A promise that resolves to the state.
  */
-async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
+async function _KeyringController_createNewVaultWithKeyring(password, keyring, encryptionKey) {
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_assertControllerMutexIsLocked).call(this);
     if (typeof password !== 'string') {
         throw new TypeError(constants_1.KeyringControllerError.WrongPasswordType);
@@ -1240,9 +1281,17 @@ async function _KeyringController_createNewVaultWithKeyring(password, keyring) {
         delete state.encryptionSalt;
     });
     __classPrivateFieldSet(this, _KeyringController_password, password, "f");
+    __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_updateCachedEncryptionKey).call(this, encryptionKey);
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_clearKeyrings).call(this);
     await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_createKeyringWithFirstAccount).call(this, keyring.type, keyring.opts);
     __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_setUnlocked).call(this);
+}, _KeyringController_updateCachedEncryptionKey = function _KeyringController_updateCachedEncryptionKey(encryptionKey) {
+    if (!encryptionKey && this.state.encryptedEncryptionKey) {
+        __classPrivateFieldSet(this, _KeyringController_encryptionKey, this.state.encryptionKey, "f");
+    }
+    else {
+        __classPrivateFieldSet(this, _KeyringController_encryptionKey, encryptionKey, "f");
+    }
 }, _KeyringController_verifySeedPhrase = 
 /**
  * Internal non-exclusive method to verify the seed phrase.
@@ -1332,6 +1381,7 @@ async function _KeyringController_getSessionState() {
     return {
         keyrings: await __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_getSerializedKeyrings).call(this),
         password: __classPrivateFieldGet(this, _KeyringController_password, "f"),
+        encryptionKey: __classPrivateFieldGet(this, _KeyringController_encryptionKey, "f"),
     };
 }, _KeyringController_restoreSerializedKeyrings = 
 /**
@@ -1367,7 +1417,7 @@ async function _KeyringController_restoreSerializedKeyrings(serializedKeyrings)
  */
 async function _KeyringController_unlockKeyrings(password, encryptionKey, encryptionSalt) {
     return __classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_withVaultLock).call(this, async () => {
-        const encryptedVault = this.state.vault;
+        const { vault: encryptedVault, encryptedEncryptionKey } = this.state;
         if (!encryptedVault) {
             throw new Error(constants_1.KeyringControllerError.VaultError);
         }
@@ -1376,11 +1426,20 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
         if (__classPrivateFieldGet(this, _KeyringController_cacheEncryptionKey, "f")) {
             assertIsExportableKeyEncryptor(__classPrivateFieldGet(this, _KeyringController_encryptor, "f"));
             if (password) {
-                const result = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decryptWithDetail(password, encryptedVault);
-                vault = result.vault;
-                __classPrivateFieldSet(this, _KeyringController_password, password, "f");
-                updatedState.encryptionKey = result.exportedKeyString;
-                updatedState.encryptionSalt = result.salt;
+                if (encryptedEncryptionKey) {
+                    const key = (await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decrypt(password, encryptedEncryptionKey));
+                    const importedKey = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").importKey(key);
+                    vault = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decryptWithKey(importedKey, encryptedVault);
+                    __classPrivateFieldSet(this, _KeyringController_password, password, "f");
+                    updatedState.encryptionKey = key;
+                }
+                else {
+                    const result = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").decryptWithDetail(password, encryptedVault);
+                    vault = result.vault;
+                    __classPrivateFieldSet(this, _KeyringController_password, password, "f");
+                    updatedState.encryptionKey = result.exportedKeyString;
+                    updatedState.encryptionSalt = result.salt;
+                }
             }
             else {
                 const parsedEncryptedVault = JSON.parse(encryptedVault);
@@ -1451,15 +1510,31 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
                 updatedState.vault = JSON.stringify(vaultJSON);
             }
             else if (__classPrivateFieldGet(this, _KeyringController_password, "f")) {
-                const { vault: newVault, exportedKeyString } = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").encryptWithDetail(__classPrivateFieldGet(this, _KeyringController_password, "f"), serializedKeyrings);
-                updatedState.vault = newVault;
-                updatedState.encryptionKey = exportedKeyString;
+                if (__classPrivateFieldGet(this, _KeyringController_encryptionKey, "f")) {
+                    // Update cached key.
+                    updatedState.encryptionKey = __classPrivateFieldGet(this, _KeyringController_encryptionKey, "f");
+                    // Encrypt key and update encrypted key.
+                    const encryptedKey = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").encrypt(__classPrivateFieldGet(this, _KeyringController_password, "f"), __classPrivateFieldGet(this, _KeyringController_encryptionKey, "f"));
+                    updatedState.encryptedEncryptionKey = encryptedKey;
+                    // Encrypt and update vault.
+                    const importedKey = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").importKey(__classPrivateFieldGet(this, _KeyringController_encryptionKey, "f"));
+                    const vaultJSON = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").encryptWithKey(importedKey, serializedKeyrings);
+                    updatedState.vault = JSON.stringify(vaultJSON);
+                }
+                else {
+                    const { vault: newVault, exportedKeyString } = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").encryptWithDetail(__classPrivateFieldGet(this, _KeyringController_password, "f"), serializedKeyrings);
+                    updatedState.vault = newVault;
+                    updatedState.encryptionKey = exportedKeyString;
+                }
             }
         }
         else {
             assertIsValidPassword(__classPrivateFieldGet(this, _KeyringController_password, "f"));
             updatedState.vault = await __classPrivateFieldGet(this, _KeyringController_encryptor, "f").encrypt(__classPrivateFieldGet(this, _KeyringController_password, "f"), serializedKeyrings);
         }
+        if (__classPrivateFieldGet(this, _KeyringController_instances, "m", _KeyringController_isEnvelopeEncryptionEnabled).call(this)) {
+            assertIsCacheEncryptionKeyTrue(__classPrivateFieldGet(this, _KeyringController_cacheEncryptionKey, "f"));
+        }
         if (!updatedState.vault) {
             throw new Error(constants_1.KeyringControllerError.MissingVaultData);
         }
@@ -1471,6 +1546,9 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
                 state.encryptionKey = updatedState.encryptionKey;
                 state.encryptionSalt = JSON.parse(updatedState.vault).salt;
             }
+            if (updatedState.encryptedEncryptionKey) {
+                state.encryptedEncryptionKey = updatedState.encryptedEncryptionKey;
+            }
         });
         return true;
     });
@@ -1480,6 +1558,8 @@ async function _KeyringController_unlockKeyrings(password, encryptionKey, encryp
         return false;
     }
     return !__classPrivateFieldGet(this, _KeyringController_encryptor, "f").isVaultUpdated(vault);
+}, _KeyringController_isEnvelopeEncryptionEnabled = function _KeyringController_isEnvelopeEncryptionEnabled() {
+    return this.state.encryptedEncryptionKey || __classPrivateFieldGet(this, _KeyringController_encryptionKey, "f");
 }, _KeyringController_getAccountsFromKeyrings = 
 /**
  * Retrieves all the accounts from keyrings instances
@@ -1564,7 +1644,8 @@ async function _KeyringController_createKeyring(type, data) {
     if (keyring.init) {
         await keyring.init();
     }
-    if (type === KeyringTypes.hd && (!(0, utils_1.isObject)(data) || !data.mnemonic)) {
+    if (type === KeyringTypes.hd &&
+        (!(0, utils_1.isObject)(data) || !data.mnemonic)) {
         if (!keyring.generateRandomMnemonic) {
             throw new Error(constants_1.KeyringControllerError.UnsupportedGenerateRandomMnemonic);
         }
@@ -1686,11 +1767,16 @@ async function _KeyringController_assertNoDuplicateAccounts(additionalKeyrings =
     }
 }, _KeyringController_persistOrRollback = 
 /**
- * Execute the given function after acquiring the controller lock
- * and save the vault to state after it (only if needed), or rollback to their
- * previous state in case of error.
+ * Execute the given function after acquiring the controller lock and save the
+ * vault to state after it (only if needed), or rollback to their previous
+ * state in case of error.
+ *
+ * ATTENTION: The callback must **not** alter `controller.state`. Any state
+ * change performed by the callback will not be rolled back on error.
  *
- * @param callback - The function to execute.
+ * @param callback - The function to execute. This callback must **not** alter
+ * `controller.state`. Any state change performed by the callback will not be
+ * rolled back on error.
  * @returns The result of the function.
  */
 async function _KeyringController_persistOrRollback(callback) {