@metamask-previews/seedless-onboarding-controller 2.2.0-preview-fd1ef74 → 2.3.0-preview-3713f9f
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -3
- package/dist/SeedlessOnboardingController.cjs +61 -58
- package/dist/SeedlessOnboardingController.cjs.map +1 -1
- package/dist/SeedlessOnboardingController.d.cts +3 -8
- package/dist/SeedlessOnboardingController.d.cts.map +1 -1
- package/dist/SeedlessOnboardingController.d.mts +3 -8
- package/dist/SeedlessOnboardingController.d.mts.map +1 -1
- package/dist/SeedlessOnboardingController.mjs +61 -58
- package/dist/SeedlessOnboardingController.mjs.map +1 -1
- package/dist/assertions.cjs +32 -0
- package/dist/assertions.cjs.map +1 -0
- package/dist/assertions.d.cts +9 -0
- package/dist/assertions.d.cts.map +1 -0
- package/dist/assertions.d.mts +9 -0
- package/dist/assertions.d.mts.map +1 -0
- package/dist/assertions.mjs +28 -0
- package/dist/assertions.mjs.map +1 -0
- package/dist/constants.cjs +1 -0
- package/dist/constants.cjs.map +1 -1
- package/dist/constants.d.cts +2 -1
- package/dist/constants.d.cts.map +1 -1
- package/dist/constants.d.mts +2 -1
- package/dist/constants.d.mts.map +1 -1
- package/dist/constants.mjs +1 -0
- package/dist/constants.mjs.map +1 -1
- package/dist/types.cjs.map +1 -1
- package/dist/types.d.cts +2 -1
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +2 -1
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs.map +1 -1
- package/dist/utils.cjs +1 -1
- package/dist/utils.cjs.map +1 -1
- package/dist/utils.mjs +1 -1
- package/dist/utils.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
|
|
|
9
9
|
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
10
10
|
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
11
11
|
};
|
|
12
|
-
var _SeedlessOnboardingController_instances, _SeedlessOnboardingController_vaultEncryptor, _SeedlessOnboardingController_controllerOperationMutex, _SeedlessOnboardingController_vaultOperationMutex, _SeedlessOnboardingController_refreshJWTToken, _SeedlessOnboardingController_revokeRefreshToken, _SeedlessOnboardingController_isUnlocked, _SeedlessOnboardingController_submitGlobalPassword, _SeedlessOnboardingController_setUnlocked, _SeedlessOnboardingController_persistOprfKey, _SeedlessOnboardingController_persistAuthPubKey, _SeedlessOnboardingController_storeKeyringEncryptionKey, _SeedlessOnboardingController_loadKeyringEncryptionKey, _SeedlessOnboardingController_loadSeedlessEncryptionKey, _SeedlessOnboardingController_recoverAuthPubKey, _SeedlessOnboardingController_recoverEncKey, _SeedlessOnboardingController_fetchAllSecretDataFromMetadataStore, _SeedlessOnboardingController_changeEncryptionKey, _SeedlessOnboardingController_encryptAndStoreSecretData, _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey, _SeedlessOnboardingController_withPersistedSecretMetadataBackupsState, _SeedlessOnboardingController_filterDupesAndUpdateSocialBackupsMetadata, _SeedlessOnboardingController_createNewVaultWithAuthData, _SeedlessOnboardingController_updateVault, _SeedlessOnboardingController_withControllerLock, _SeedlessOnboardingController_withVaultLock, _SeedlessOnboardingController_serializeKeyData, _SeedlessOnboardingController_parseVaultData, _SeedlessOnboardingController_assertIsUnlocked, _SeedlessOnboardingController_assertIsAuthenticatedUser, _SeedlessOnboardingController_assertIsSRPBackedUpUser, _SeedlessOnboardingController_assertPasswordInSync, _SeedlessOnboardingController_resetPasswordOutdatedCache,
|
|
12
|
+
var _SeedlessOnboardingController_instances, _SeedlessOnboardingController_vaultEncryptor, _SeedlessOnboardingController_controllerOperationMutex, _SeedlessOnboardingController_vaultOperationMutex, _SeedlessOnboardingController_refreshJWTToken, _SeedlessOnboardingController_revokeRefreshToken, _SeedlessOnboardingController_isUnlocked, _SeedlessOnboardingController_submitGlobalPassword, _SeedlessOnboardingController_setUnlocked, _SeedlessOnboardingController_persistOprfKey, _SeedlessOnboardingController_persistAuthPubKey, _SeedlessOnboardingController_storeKeyringEncryptionKey, _SeedlessOnboardingController_loadKeyringEncryptionKey, _SeedlessOnboardingController_loadSeedlessEncryptionKey, _SeedlessOnboardingController_recoverAuthPubKey, _SeedlessOnboardingController_recoverEncKey, _SeedlessOnboardingController_fetchAllSecretDataFromMetadataStore, _SeedlessOnboardingController_changeEncryptionKey, _SeedlessOnboardingController_encryptAndStoreSecretData, _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey, _SeedlessOnboardingController_withPersistedSecretMetadataBackupsState, _SeedlessOnboardingController_filterDupesAndUpdateSocialBackupsMetadata, _SeedlessOnboardingController_createNewVaultWithAuthData, _SeedlessOnboardingController_updateVault, _SeedlessOnboardingController_withControllerLock, _SeedlessOnboardingController_withVaultLock, _SeedlessOnboardingController_serializeKeyData, _SeedlessOnboardingController_parseVaultData, _SeedlessOnboardingController_assertIsUnlocked, _SeedlessOnboardingController_assertIsAuthenticatedUser, _SeedlessOnboardingController_assertIsSRPBackedUpUser, _SeedlessOnboardingController_assertPasswordInSync, _SeedlessOnboardingController_resetPasswordOutdatedCache, _SeedlessOnboardingController_revokeRefreshTokenAndUpdateState, _SeedlessOnboardingController_isTokenExpiredError, _SeedlessOnboardingController_isMaxKeyChainLengthError, _SeedlessOnboardingController_executeWithTokenRefresh;
|
|
13
13
|
import { keccak256AndHexify } from "@metamask/auth-network-utils";
|
|
14
14
|
import { BaseController } from "@metamask/base-controller";
|
|
15
15
|
import { ToprfSecureBackup, TOPRFErrorCode, TOPRFError } from "@metamask/toprf-secure-backup";
|
|
@@ -19,6 +19,7 @@ import { bytesToUtf8, utf8ToBytes } from "@noble/ciphers/utils";
|
|
|
19
19
|
import { managedNonce } from "@noble/ciphers/webcrypto";
|
|
20
20
|
import { secp256k1 } from "@noble/curves/secp256k1";
|
|
21
21
|
import { Mutex } from "async-mutex";
|
|
22
|
+
import { assertIsValidVaultData } from "./assertions.mjs";
|
|
22
23
|
import { controllerName, PASSWORD_OUTDATED_CACHE_TTL_MS, SecretType, SeedlessOnboardingControllerErrorMessage, Web3AuthNetwork } from "./constants.mjs";
|
|
23
24
|
import { PasswordSyncError, RecoveryError } from "./errors.mjs";
|
|
24
25
|
import { projectLogger, createModuleLogger } from "./logger.mjs";
|
|
@@ -480,10 +481,18 @@ export class SeedlessOnboardingController extends BaseController {
|
|
|
480
481
|
*/
|
|
481
482
|
async submitPassword(password) {
|
|
482
483
|
return await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_withControllerLock).call(this, async () => {
|
|
483
|
-
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey).call(this, password);
|
|
484
|
+
const { toprfEncryptionKey, toprfPwEncryptionKey, toprfAuthKeyPair, revokeToken, } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey).call(this, password);
|
|
484
485
|
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_setUnlocked).call(this);
|
|
485
|
-
|
|
486
|
-
|
|
486
|
+
if (revokeToken) {
|
|
487
|
+
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_revokeRefreshTokenAndUpdateState).call(this, revokeToken);
|
|
488
|
+
// re-creating vault to persist the new revoke token
|
|
489
|
+
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_createNewVaultWithAuthData).call(this, {
|
|
490
|
+
password,
|
|
491
|
+
rawToprfEncryptionKey: toprfEncryptionKey,
|
|
492
|
+
rawToprfPwEncryptionKey: toprfPwEncryptionKey,
|
|
493
|
+
rawToprfAuthKeyPair: toprfAuthKeyPair,
|
|
494
|
+
});
|
|
495
|
+
}
|
|
487
496
|
});
|
|
488
497
|
}
|
|
489
498
|
/**
|
|
@@ -531,16 +540,18 @@ export class SeedlessOnboardingController extends BaseController {
|
|
|
531
540
|
* @description Unlock the controller with the latest global password.
|
|
532
541
|
*
|
|
533
542
|
* @param params - The parameters for unlocking the controller.
|
|
543
|
+
* @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.
|
|
534
544
|
* @param params.globalPassword - The latest global password.
|
|
535
545
|
* @returns A promise that resolves to the success of the operation.
|
|
536
546
|
*/
|
|
537
|
-
async submitGlobalPassword({ globalPassword, }) {
|
|
547
|
+
async submitGlobalPassword({ globalPassword, maxKeyChainLength = 5, }) {
|
|
538
548
|
return await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_withControllerLock).call(this, async () => {
|
|
539
549
|
return await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_executeWithTokenRefresh).call(this, async () => {
|
|
540
550
|
const currentDeviceAuthPubKey = __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_recoverAuthPubKey).call(this);
|
|
541
551
|
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_submitGlobalPassword).call(this, {
|
|
542
552
|
targetAuthPubKey: currentDeviceAuthPubKey,
|
|
543
553
|
globalPassword,
|
|
554
|
+
maxKeyChainLength,
|
|
544
555
|
});
|
|
545
556
|
}, 'submitGlobalPassword');
|
|
546
557
|
});
|
|
@@ -651,34 +662,6 @@ export class SeedlessOnboardingController extends BaseController {
|
|
|
651
662
|
throw new Error(SeedlessOnboardingControllerErrorMessage.AuthenticationError);
|
|
652
663
|
}
|
|
653
664
|
}
|
|
654
|
-
/**
|
|
655
|
-
* Revoke the refresh token and get new refresh token and new revoke token.
|
|
656
|
-
* This method is to be called after unlock
|
|
657
|
-
*
|
|
658
|
-
* @param password - The password to re-encrypt new token in the vault.
|
|
659
|
-
*/
|
|
660
|
-
async revokeRefreshToken(password) {
|
|
661
|
-
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_assertIsUnlocked).call(this);
|
|
662
|
-
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_assertIsAuthenticatedUser).call(this, this.state);
|
|
663
|
-
// get revoke token and backup encryption key from vault (should be unlocked already)
|
|
664
|
-
const { revokeToken, toprfEncryptionKey, toprfPwEncryptionKey, toprfAuthKeyPair, } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey).call(this);
|
|
665
|
-
const { newRevokeToken, newRefreshToken } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_revokeRefreshToken, "f").call(this, {
|
|
666
|
-
connection: this.state.authConnection,
|
|
667
|
-
revokeToken,
|
|
668
|
-
});
|
|
669
|
-
this.update((state) => {
|
|
670
|
-
// set new revoke token in state temporarily for persisting in vault
|
|
671
|
-
state.revokeToken = newRevokeToken;
|
|
672
|
-
// set new refresh token to persist in state
|
|
673
|
-
state.refreshToken = newRefreshToken;
|
|
674
|
-
});
|
|
675
|
-
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_createNewVaultWithAuthData).call(this, {
|
|
676
|
-
password,
|
|
677
|
-
rawToprfEncryptionKey: toprfEncryptionKey,
|
|
678
|
-
rawToprfPwEncryptionKey: toprfPwEncryptionKey,
|
|
679
|
-
rawToprfAuthKeyPair: toprfAuthKeyPair,
|
|
680
|
-
});
|
|
681
|
-
}
|
|
682
665
|
/**
|
|
683
666
|
* Check if the current node auth token is expired.
|
|
684
667
|
*
|
|
@@ -738,13 +721,14 @@ _SeedlessOnboardingController_vaultEncryptor = new WeakMap(), _SeedlessOnboardin
|
|
|
738
721
|
* password validity and unlock the controller.
|
|
739
722
|
*
|
|
740
723
|
* @param params - The parameters for submitting the global password.
|
|
724
|
+
* @param params.maxKeyChainLength - The maximum chain length of the pwd encryption keys.
|
|
741
725
|
* @param params.targetAuthPubKey - The target public key of the keyring
|
|
742
726
|
* encryption key to recover.
|
|
743
727
|
* @param params.globalPassword - The latest global password.
|
|
744
728
|
* @returns A promise that resolves to the keyring encryption key
|
|
745
729
|
* corresponding to the current authPubKey in state.
|
|
746
730
|
*/
|
|
747
|
-
async function _SeedlessOnboardingController_submitGlobalPassword({ targetAuthPubKey, globalPassword, }) {
|
|
731
|
+
async function _SeedlessOnboardingController_submitGlobalPassword({ targetAuthPubKey, globalPassword, maxKeyChainLength, }) {
|
|
748
732
|
const { pwEncKey: curPwEncKey, authKeyPair: curAuthKeyPair } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_recoverEncKey).call(this, globalPassword);
|
|
749
733
|
try {
|
|
750
734
|
// Recover vault encryption key.
|
|
@@ -752,19 +736,32 @@ async function _SeedlessOnboardingController_submitGlobalPassword({ targetAuthPu
|
|
|
752
736
|
targetAuthPubKey,
|
|
753
737
|
curPwEncKey,
|
|
754
738
|
curAuthKeyPair,
|
|
739
|
+
maxPwChainLength: maxKeyChainLength,
|
|
755
740
|
});
|
|
756
741
|
const { pwEncKey } = res;
|
|
757
742
|
const vaultKey = await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_loadSeedlessEncryptionKey).call(this, pwEncKey);
|
|
758
743
|
// Unlock the controller
|
|
759
|
-
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey).call(this, undefined, vaultKey);
|
|
744
|
+
const { revokeToken, toprfEncryptionKey, toprfPwEncryptionKey, toprfAuthKeyPair, } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_unlockVaultAndGetBackupEncKey).call(this, undefined, vaultKey);
|
|
760
745
|
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_setUnlocked).call(this);
|
|
761
|
-
|
|
762
|
-
|
|
746
|
+
if (revokeToken) {
|
|
747
|
+
// revoke and recyle refresh token after unlock to keep refresh token fresh, avoid malicious use of leaked refresh token
|
|
748
|
+
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_revokeRefreshTokenAndUpdateState).call(this, revokeToken);
|
|
749
|
+
// re-creating vault to persist the new revoke token
|
|
750
|
+
await __classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_createNewVaultWithAuthData).call(this, {
|
|
751
|
+
password: globalPassword,
|
|
752
|
+
rawToprfEncryptionKey: toprfEncryptionKey,
|
|
753
|
+
rawToprfPwEncryptionKey: toprfPwEncryptionKey,
|
|
754
|
+
rawToprfAuthKeyPair: toprfAuthKeyPair,
|
|
755
|
+
});
|
|
756
|
+
}
|
|
763
757
|
}
|
|
764
758
|
catch (error) {
|
|
765
759
|
if (__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_isTokenExpiredError).call(this, error)) {
|
|
766
760
|
throw error;
|
|
767
761
|
}
|
|
762
|
+
if (__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_isMaxKeyChainLengthError).call(this, error)) {
|
|
763
|
+
throw new Error(SeedlessOnboardingControllerErrorMessage.MaxKeyChainLengthExceeded);
|
|
764
|
+
}
|
|
768
765
|
throw PasswordSyncError.getInstance(error);
|
|
769
766
|
}
|
|
770
767
|
}, _SeedlessOnboardingController_setUnlocked = function _SeedlessOnboardingController_setUnlocked() {
|
|
@@ -1111,9 +1108,6 @@ async function _SeedlessOnboardingController_withPersistedSecretMetadataBackupsS
|
|
|
1111
1108
|
*/
|
|
1112
1109
|
async function _SeedlessOnboardingController_createNewVaultWithAuthData({ password, rawToprfEncryptionKey, rawToprfPwEncryptionKey, rawToprfAuthKeyPair, }) {
|
|
1113
1110
|
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_assertIsAuthenticatedUser).call(this, this.state);
|
|
1114
|
-
if (!this.state.revokeToken) {
|
|
1115
|
-
throw new Error(SeedlessOnboardingControllerErrorMessage.InvalidRevokeToken);
|
|
1116
|
-
}
|
|
1117
1111
|
if (!this.state.accessToken) {
|
|
1118
1112
|
throw new Error(SeedlessOnboardingControllerErrorMessage.InvalidAccessToken);
|
|
1119
1113
|
}
|
|
@@ -1214,7 +1208,7 @@ async function _SeedlessOnboardingController_withVaultLock(callback) {
|
|
|
1214
1208
|
catch {
|
|
1215
1209
|
throw new Error(SeedlessOnboardingControllerErrorMessage.InvalidVaultData);
|
|
1216
1210
|
}
|
|
1217
|
-
|
|
1211
|
+
assertIsValidVaultData(parsedVaultData);
|
|
1218
1212
|
const rawToprfEncryptionKey = base64ToBytes(parsedVaultData.toprfEncryptionKey);
|
|
1219
1213
|
const rawToprfPwEncryptionKey = base64ToBytes(parsedVaultData.toprfPwEncryptionKey);
|
|
1220
1214
|
const parsedToprfAuthKeyPair = JSON.parse(parsedVaultData.toprfAuthKeyPair);
|
|
@@ -1278,29 +1272,38 @@ async function _SeedlessOnboardingController_assertPasswordInSync(options) {
|
|
|
1278
1272
|
this.update((state) => {
|
|
1279
1273
|
delete state.passwordOutdatedCache;
|
|
1280
1274
|
});
|
|
1281
|
-
},
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1275
|
+
}, _SeedlessOnboardingController_revokeRefreshTokenAndUpdateState =
|
|
1276
|
+
/**
|
|
1277
|
+
* Revoke the refresh token and get new refresh token and new revoke token.
|
|
1278
|
+
* This method is to be called after user is authenticated.
|
|
1279
|
+
*
|
|
1280
|
+
* @param revokeToken - The revoke token to use for revoking the refresh token.
|
|
1281
|
+
*/
|
|
1282
|
+
async function _SeedlessOnboardingController_revokeRefreshTokenAndUpdateState(revokeToken) {
|
|
1283
|
+
__classPrivateFieldGet(this, _SeedlessOnboardingController_instances, "m", _SeedlessOnboardingController_assertIsAuthenticatedUser).call(this, this.state);
|
|
1284
|
+
const { newRevokeToken, newRefreshToken } = await __classPrivateFieldGet(this, _SeedlessOnboardingController_revokeRefreshToken, "f").call(this, {
|
|
1285
|
+
connection: this.state.authConnection,
|
|
1286
|
+
revokeToken,
|
|
1287
|
+
});
|
|
1288
|
+
this.update((state) => {
|
|
1289
|
+
// set new revoke token in state temporarily for persisting in vault
|
|
1290
|
+
state.revokeToken = newRevokeToken;
|
|
1291
|
+
// set new refresh token to persist in state
|
|
1292
|
+
state.refreshToken = newRefreshToken;
|
|
1293
|
+
});
|
|
1298
1294
|
}, _SeedlessOnboardingController_isTokenExpiredError = function _SeedlessOnboardingController_isTokenExpiredError(error) {
|
|
1299
1295
|
if (error instanceof TOPRFError) {
|
|
1300
1296
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
|
|
1301
1297
|
return error.code === TOPRFErrorCode.AuthTokenExpired;
|
|
1302
1298
|
}
|
|
1303
1299
|
return false;
|
|
1300
|
+
}, _SeedlessOnboardingController_isMaxKeyChainLengthError = function _SeedlessOnboardingController_isMaxKeyChainLengthError(error) {
|
|
1301
|
+
if (error instanceof TOPRFError) {
|
|
1302
|
+
// todo: update this when the error message to error code once toprf sdk is updated.
|
|
1303
|
+
return (error.message ===
|
|
1304
|
+
'Could not fetch password. Exceeded maximum password chain length');
|
|
1305
|
+
}
|
|
1306
|
+
return false;
|
|
1304
1307
|
}, _SeedlessOnboardingController_executeWithTokenRefresh =
|
|
1305
1308
|
/**
|
|
1306
1309
|
* Executes an operation with automatic token refresh on expiration.
|