[PM-5363] PinService State Providers (#8244)

* move pinKeyEncryptedUserKey

* move pinKeyEncryptedUserKeyEphemeral

* remove comments, move docs

* cleanup

* use UserKeyDefinition

* refactor methods

* add migration

* fix browser dependency

* add tests for migration

* rename to pinService

* move state to PinService

* add PinService dep to CryptoService

* move protectedPin to state provider

* update service deps

* renaming

* move decryptUserKeyWithPin to pinService

* update service injection

* move more methods our of crypto service

* remove CryptoService dep from PinService and update service injection

* remove cryptoService reference

* add method to FakeMasterPasswordService

* fix circular dependency

* fix desktop service injection

* update browser dependencies

* add protectedPin to migrations

* move storePinKey to pinService

* update and clarify documentation

* more jsdoc updates

* update import paths

* refactor isPinLockSet method

* update state definitions

* initialize service before injecting into other services

* initialize service before injecting into other services (bw.ts)

* update clearOn and do additional cleanup

* clarify docs and naming

* assign abstract & private methods, add clarity to decryptAndMigrateOldPinKeyEncryptedMasterKey() method

* derived state (attempt)

* fix typos

* use accountService to get active user email

* use constant userId

* add derived state

* add get and clear for oldPinKeyEncryptedMasterKey

* require userId

* move pinProtected

* add clear methods

* remove pinProtected from account.ts and replace methods

* add methods to create and store pinKeyEncryptedUserKey

* add pinProtected/oldPinKeyEncrypterMasterKey to migration

* update migration tests

* update migration rollback tests

* update to systemService and decryptAndMigrate... method

* remove old test

* increase length of state definition name to meet test requirements

* rename 'TRANSIENT' to 'EPHEMERAL' for consistency

* fix tests for login strategies, vault-export, and fake MP service

* more updates to login-strategy tests

* write new tests for core pinKeyEncrypterUserKey methods and isPinSet

* write new tests for pinProtected and oldPinKeyEncryptedMasterKey methods

* minor test reformatting

* update test for decryptUserKeyWithPin()

* fix bug with oldPinKeyEncryptedMasterKey

* fix tests for vault-timeout-settings.service

* fix bitwarden-password-protected-importer test

* fix login strategy tests and auth-request.service test

* update pinService tests

* fix crypto service tests

* add jsdoc

* fix test file import

* update jsdocs for decryptAndMigrateOldPinKeyEncryptedMasterKey()

* update error messages and jsdocs

* add null checks, move userId retrievals

* update migration tests

* update stateService calls to require userId

* update test for decryptUserKeyWithPin()

* update oldPinKeyEncryptedMasterKey migration tests

* more test updates

* fix factory import

* update tests for isPinSet() and createProtectedPin()

* add test for makePinKey()

* add test for createPinKeyEncryptedUserKey()

* add tests for getPinLockType()

* consolidate userId verification tests

* add tests for storePinKeyEncryptedUserKey()

* fix service dep

* get email based on userId

* use MasterPasswordService instead of internal

* rename protectedPin to userKeyEncryptedPin

* rename to pinKeyEncryptedUserKeyPersistent

* update method params

* fix CryptoService tests

* jsdoc update

* use EncString for userKeyEncryptedPin

* remove comment

* use cryptoFunctionService.compareFast()

* update tests

* cleanup, remove comments

* resolve merge conflict

* fix DI of MasterPasswordService

* more DI fixes

libs/importer/spec/bitwarden-password-protected-importer.spec.ts

@@ -1,5 +1,6 @@
 import { mock, MockProxy } from "jest-mock-extended";
 
+import { PinServiceAbstraction } from "@bitwarden/auth/common";
 import { CryptoService } from "@bitwarden/common/platform/abstractions/crypto.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { KdfType } from "@bitwarden/common/platform/enums";
@@ -19,6 +20,7 @@ describe("BitwardenPasswordProtectedImporter", () => {
   let cryptoService: MockProxy<CryptoService>;
   let i18nService: MockProxy<I18nService>;
   let cipherService: MockProxy<CipherService>;
+  let pinService: MockProxy<PinServiceAbstraction>;
   const password = Utils.newGuid();
   const promptForPassword_callback = async () => {
     return password;
@@ -28,11 +30,13 @@ describe("BitwardenPasswordProtectedImporter", () => {
     cryptoService = mock<CryptoService>();
     i18nService = mock<I18nService>();
     cipherService = mock<CipherService>();
+    pinService = mock<PinServiceAbstraction>();
 
     importer = new BitwardenPasswordProtectedImporter(
       cryptoService,
       i18nService,
       cipherService,
+      pinService,
       promptForPassword_callback,
     );
   });

libs/importer/src/importers/bitwarden/bitwarden-json-importer.ts

@@ -1,3 +1,4 @@
+import { PinServiceAbstraction } from "@bitwarden/auth/common";
 import {
   CipherWithIdExport,
   CollectionWithIdExport,
@@ -28,6 +29,7 @@ export class BitwardenJsonImporter extends BaseImporter implements Importer {
     protected cryptoService: CryptoService,
     protected i18nService: I18nService,
     protected cipherService: CipherService,
+    protected pinService: PinServiceAbstraction,
   ) {
     super();
   }

libs/importer/src/importers/bitwarden/bitwarden-password-protected-importer.ts

@@ -1,3 +1,4 @@
+import { PinServiceAbstraction } from "@bitwarden/auth/common";
 import {
   Argon2KdfConfig,
   KdfConfig,
@@ -23,9 +24,10 @@ export class BitwardenPasswordProtectedImporter extends BitwardenJsonImporter im
     cryptoService: CryptoService,
     i18nService: I18nService,
     cipherService: CipherService,
+    pinService: PinServiceAbstraction,
     private promptForPassword_callback: () => Promise<string>,
   ) {
-    super(cryptoService, i18nService, cipherService);
+    super(cryptoService, i18nService, cipherService, pinService);
   }
 
   async parse(data: string): Promise<ImportResult> {
@@ -78,7 +80,7 @@ export class BitwardenPasswordProtectedImporter extends BitwardenJsonImporter im
         ? new PBKDF2KdfConfig(jdoc.kdfIterations)
         : new Argon2KdfConfig(jdoc.kdfIterations, jdoc.kdfMemory, jdoc.kdfParallelism);
 
-    this.key = await this.cryptoService.makePinKey(password, jdoc.salt, kdfConfig);
+    this.key = await this.pinService.makePinKey(password, jdoc.salt, kdfConfig);
 
     const encKeyValidation = new EncString(jdoc.encKeyValidation_DO_NOT_EDIT);
 

libs/importer/src/services/import.service.spec.ts

@@ -1,5 +1,6 @@
 import { mock, MockProxy } from "jest-mock-extended";
 
+import { PinServiceAbstraction } from "@bitwarden/auth/common";
 import { CryptoService } from "@bitwarden/common/platform/abstractions/crypto.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { Utils } from "@bitwarden/common/platform/misc/utils";
@@ -25,6 +26,7 @@ describe("ImportService", () => {
   let i18nService: MockProxy<I18nService>;
   let collectionService: MockProxy<CollectionService>;
   let cryptoService: MockProxy<CryptoService>;
+  let pinService: MockProxy<PinServiceAbstraction>;
 
   beforeEach(() => {
     cipherService = mock<CipherService>();
@@ -33,6 +35,7 @@ describe("ImportService", () => {
     i18nService = mock<I18nService>();
     collectionService = mock<CollectionService>();
     cryptoService = mock<CryptoService>();
+    pinService = mock<PinServiceAbstraction>();
 
     importService = new ImportService(
       cipherService,
@@ -41,6 +44,7 @@ describe("ImportService", () => {
       i18nService,
       collectionService,
       cryptoService,
+      pinService,
     );
   });
 

libs/importer/src/services/import.service.ts

@@ -1,3 +1,4 @@
+import { PinServiceAbstraction } from "@bitwarden/auth/common";
 import { ImportCiphersRequest } from "@bitwarden/common/models/request/import-ciphers.request";
 import { ImportOrganizationCiphersRequest } from "@bitwarden/common/models/request/import-organization-ciphers.request";
 import { KvpRequest } from "@bitwarden/common/models/request/kvp.request";
@@ -100,6 +101,7 @@ export class ImportService implements ImportServiceAbstraction {
     private i18nService: I18nService,
     private collectionService: CollectionService,
     private cryptoService: CryptoService,
+    private pinService: PinServiceAbstraction,
   ) {}
 
   getImportOptions(): ImportOption[] {
@@ -203,6 +205,7 @@ export class ImportService implements ImportServiceAbstraction {
           this.cryptoService,
           this.i18nService,
           this.cipherService,
+          this.pinService,
           promptForPassword_callback,
         );
       case "lastpasscsv":