From bc2b0753636286759ba5901e5d69994aa8e01a4c Mon Sep 17 00:00:00 2001 From: Bernd Schoolmann Date: Fri, 18 Jul 2025 00:09:09 +0200 Subject: [PATCH] Fix comments --- .../master-password.service.abstraction.ts | 2 +- .../services/master-password.service.ts | 20 ++++++------------- libs/key-management/src/key.service.ts | 8 ++++---- 3 files changed, 11 insertions(+), 19 deletions(-) diff --git a/libs/common/src/key-management/master-password/abstractions/master-password.service.abstraction.ts b/libs/common/src/key-management/master-password/abstractions/master-password.service.abstraction.ts index ec0bf83c4bb..b33374fbb5a 100644 --- a/libs/common/src/key-management/master-password/abstractions/master-password.service.abstraction.ts +++ b/libs/common/src/key-management/master-password/abstractions/master-password.service.abstraction.ts @@ -22,7 +22,7 @@ export abstract class MasterPasswordServiceAbstraction { abstract forceSetPasswordReason$: (userId: UserId) => Observable; /** * An observable that emits the master key for the user. - * @deprecated Interacting with the master-key directly is deprecated. Please use {@link makeMasterPasswordUnlockData} and {@link makeMasterPasswordAuthenticationData}, {@link unwrapUserKeyFromMasterPasswordUnlockData}, or {@link makeMasterKeyWrappedUserKey} instead. + * @deprecated Interacting with the master-key directly is deprecated. Please use {@link makeMasterPasswordUnlockData} and {@link makeMasterPasswordAuthenticationData}, {@link unwrapUserKeyFromMasterPasswordUnlockData} instead. * @param userId The user ID. * @throws If the user ID is missing. */ diff --git a/libs/common/src/key-management/master-password/services/master-password.service.ts b/libs/common/src/key-management/master-password/services/master-password.service.ts index 727ef44628c..f9d3a44558e 100644 --- a/libs/common/src/key-management/master-password/services/master-password.service.ts +++ b/libs/common/src/key-management/master-password/services/master-password.service.ts @@ -260,21 +260,8 @@ export class MasterPasswordService implements InternalMasterPasswordServiceAbstr salt: MasterPasswordSalt, userKey: UserKey, ): Promise { - return { - salt, - kdf, - masterKeyWrappedUserKey: await this.makeMasterKeyWrappedUserKey(password, kdf, salt, userKey), - }; - } - - async makeMasterKeyWrappedUserKey( - password: string, - kdf: KdfConfig, - salt: MasterPasswordSalt, - userKey: UserKey, - ): Promise { await SdkLoadService.Ready; - return new EncString( + const masterKeyWrappedUserKey = new EncString( PureCrypto.encrypt_user_key_with_master_password( userKey.toEncoded(), password, @@ -282,6 +269,11 @@ export class MasterPasswordService implements InternalMasterPasswordServiceAbstr kdf.toSdkConfig(), ), ) as MasterKeyWrappedUserKey; + return { + salt, + kdf, + masterKeyWrappedUserKey, + }; } async unwrapUserKeyFromMasterPasswordUnlockData( diff --git a/libs/key-management/src/key.service.ts b/libs/key-management/src/key.service.ts index 8478c42cb90..7c1041a42f5 100644 --- a/libs/key-management/src/key.service.ts +++ b/libs/key-management/src/key.service.ts @@ -210,7 +210,7 @@ export class DefaultKeyService implements KeyServiceAbstraction { } /** - * @deprecated Please use `makeMasterKeyWrappedUserKey` in {@link MasterPasswordService} instead. + * @deprecated Please use `makeMasterPasswordUnlockData` in {@link MasterPasswordService} instead. */ async makeUserKey(masterKey: MasterKey | null): Promise<[UserKey, EncString]> { if (masterKey == null) { @@ -258,7 +258,7 @@ export class DefaultKeyService implements KeyServiceAbstraction { // TODO: Move to MasterPasswordService /** - * @deprecated Please use `makeMasterPasswordAuthenticationData`, `unwrapMasterKeyWrappedUserKey` or `makeMasterKeyWrappedUserKey` in @link MasterPasswordService instead. + * @deprecated Please use `makeMasterPasswordAuthenticationData`, `unwrapUserKeyFromMasterPasswordUnlockData` or `makeMasterPasswordUnlockData` in @link MasterPasswordService instead. */ async getOrDeriveMasterKey(password: string, userId?: UserId) { const [resolvedUserId, email] = await firstValueFrom( @@ -287,7 +287,7 @@ export class DefaultKeyService implements KeyServiceAbstraction { /** * Derive a master key from a password and email. * - * @deprecated Please use `makeMasterPasswordAuthenticationData`, `unwrapMasterKeyWrappedUserKey` or `makeMasterKeyWrappedUserKey` in @link MasterPasswordService instead. + * @deprecated Please use `makeMasterPasswordAuthenticationData`, `makeMasterPasswordAuthenticationData`, `unwrapUserKeyFromMasterPasswordUnlockData` in @link MasterPasswordService instead. * * @remarks * Does not validate the kdf config to ensure it satisfies the minimum requirements for the given kdf type. @@ -307,7 +307,7 @@ export class DefaultKeyService implements KeyServiceAbstraction { } /** - * @deprecated Please use `makeMasterKeyWrappedUserKey` in {@link MasterPasswordService} instead. + * @deprecated Please use `makeMasterPasswordUnlockData` in {@link MasterPasswordService} instead. */ async encryptUserKeyWithMasterKey( masterKey: MasterKey,