feature(set-change-password): [Auth/PM-17648] Create MasterPasswordApiService (#13552)

Creates a MasterPasswordApiService to house our API calls related to setting and changing a master password.

libs/common/src/abstractions/api.service.ts

@@ -49,17 +49,13 @@ import { UserApiTokenRequest } from "../auth/models/request/identity-token/user-
 import { WebAuthnLoginTokenRequest } from "../auth/models/request/identity-token/webauthn-login-token.request";
 import { KeyConnectorUserKeyRequest } from "../auth/models/request/key-connector-user-key.request";
 import { PasswordHintRequest } from "../auth/models/request/password-hint.request";
-import { PasswordRequest } from "../auth/models/request/password.request";
 import { PasswordlessAuthRequest } from "../auth/models/request/passwordless-auth.request";
 import { SecretVerificationRequest } from "../auth/models/request/secret-verification.request";
 import { SetKeyConnectorKeyRequest } from "../auth/models/request/set-key-connector-key.request";
-import { SetPasswordRequest } from "../auth/models/request/set-password.request";
 import { TwoFactorEmailRequest } from "../auth/models/request/two-factor-email.request";
 import { TwoFactorProviderRequest } from "../auth/models/request/two-factor-provider.request";
 import { TwoFactorRecoveryRequest } from "../auth/models/request/two-factor-recovery.request";
 import { UpdateProfileRequest } from "../auth/models/request/update-profile.request";
-import { UpdateTdeOffboardingPasswordRequest } from "../auth/models/request/update-tde-offboarding-password.request";
-import { UpdateTempPasswordRequest } from "../auth/models/request/update-temp-password.request";
 import { UpdateTwoFactorAuthenticatorRequest } from "../auth/models/request/update-two-factor-authenticator.request";
 import { UpdateTwoFactorDuoRequest } from "../auth/models/request/update-two-factor-duo.request";
 import { UpdateTwoFactorEmailRequest } from "../auth/models/request/update-two-factor-email.request";
@@ -169,8 +165,6 @@ export abstract class ApiService {
   postPrelogin: (request: PreloginRequest) => Promise<PreloginResponse>;
   postEmailToken: (request: EmailTokenRequest) => Promise<any>;
   postEmail: (request: EmailRequest) => Promise<any>;
-  postPassword: (request: PasswordRequest) => Promise<any>;
-  setPassword: (request: SetPasswordRequest) => Promise<any>;
   postSetKeyConnectorKey: (request: SetKeyConnectorKeyRequest) => Promise<any>;
   postSecurityStamp: (request: SecretVerificationRequest) => Promise<any>;
   getAccountRevisionDate: () => Promise<number>;
@@ -189,8 +183,6 @@ export abstract class ApiService {
   postAccountKdf: (request: KdfRequest) => Promise<any>;
   postUserApiKey: (id: string, request: SecretVerificationRequest) => Promise<ApiKeyResponse>;
   postUserRotateApiKey: (id: string, request: SecretVerificationRequest) => Promise<ApiKeyResponse>;
-  putUpdateTempPassword: (request: UpdateTempPasswordRequest) => Promise<any>;
-  putUpdateTdeOffboardingPassword: (request: UpdateTdeOffboardingPasswordRequest) => Promise<any>;
   postConvertToKeyConnector: () => Promise<void>;
   //passwordless
   postAuthRequest: (request: AuthRequest) => Promise<AuthRequestResponse>;

libs/common/src/auth/abstractions/master-password-api.service.abstraction.ts

@@ -0,0 +1,28 @@
+import { PasswordRequest } from "../models/request/password.request";
+import { SetPasswordRequest } from "../models/request/set-password.request";
+import { UpdateTdeOffboardingPasswordRequest } from "../models/request/update-tde-offboarding-password.request";
+import { UpdateTempPasswordRequest } from "../models/request/update-temp-password.request";
+
+export abstract class MasterPasswordApiService {
+  /**
+   * POSTs a SetPasswordRequest to "/accounts/set-password"
+   */
+  abstract setPassword: (request: SetPasswordRequest) => Promise<any>;
+
+  /**
+   * POSTs a PasswordRequest to "/accounts/password"
+   */
+  abstract postPassword: (request: PasswordRequest) => Promise<any>;
+
+  /**
+   * PUTs an UpdateTempPasswordRequest to "/accounts/update-temp-password"
+   */
+  abstract putUpdateTempPassword: (request: UpdateTempPasswordRequest) => Promise<any>;
+
+  /**
+   * PUTs an UpdateTdeOffboardingPasswordRequest to "/accounts/update-tde-offboarding-password"
+   */
+  abstract putUpdateTdeOffboardingPassword: (
+    request: UpdateTdeOffboardingPasswordRequest,
+  ) => Promise<any>;
+}

libs/common/src/auth/services/master-password/master-password-api.service.implementation.ts

@@ -0,0 +1,85 @@
+import { ApiService } from "@bitwarden/common/abstractions/api.service";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+
+import { MasterPasswordApiService as MasterPasswordApiServiceAbstraction } from "../../abstractions/master-password-api.service.abstraction";
+import { PasswordRequest } from "../../models/request/password.request";
+import { SetPasswordRequest } from "../../models/request/set-password.request";
+import { UpdateTdeOffboardingPasswordRequest } from "../../models/request/update-tde-offboarding-password.request";
+import { UpdateTempPasswordRequest } from "../../models/request/update-temp-password.request";
+
+export class MasterPasswordApiService implements MasterPasswordApiServiceAbstraction {
+  constructor(
+    private apiService: ApiService,
+    private logService: LogService,
+  ) {}
+
+  async setPassword(request: SetPasswordRequest): Promise<any> {
+    try {
+      const response = await this.apiService.send(
+        "POST",
+        "/accounts/set-password",
+        request,
+        true,
+        false,
+      );
+
+      return response;
+    } catch (e: unknown) {
+      this.logService.error(e);
+      throw e;
+    }
+  }
+
+  async postPassword(request: PasswordRequest): Promise<any> {
+    try {
+      const response = await this.apiService.send(
+        "POST",
+        "/accounts/password",
+        request,
+        true,
+        false,
+      );
+
+      return response;
+    } catch (e: unknown) {
+      this.logService.error(e);
+      throw e;
+    }
+  }
+
+  async putUpdateTempPassword(request: UpdateTempPasswordRequest): Promise<any> {
+    try {
+      const response = await this.apiService.send(
+        "PUT",
+        "/accounts/update-temp-password",
+        request,
+        true,
+        false,
+      );
+
+      return response;
+    } catch (e: unknown) {
+      this.logService.error(e);
+      throw e;
+    }
+  }
+
+  async putUpdateTdeOffboardingPassword(
+    request: UpdateTdeOffboardingPasswordRequest,
+  ): Promise<any> {
+    try {
+      const response = await this.apiService.send(
+        "PUT",
+        "/accounts/update-tde-offboarding-password",
+        request,
+        true,
+        false,
+      );
+
+      return response;
+    } catch (e: unknown) {
+      this.logService.error(e);
+      throw e;
+    }
+  }
+}

libs/common/src/auth/services/master-password/master-password-api.service.spec.ts

@@ -0,0 +1,130 @@
+import { mock, MockProxy } from "jest-mock-extended";
+
+import { ApiService } from "@bitwarden/common/abstractions/api.service";
+import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
+import { KdfType } from "@bitwarden/key-management";
+
+import { PasswordRequest } from "../../models/request/password.request";
+import { SetPasswordRequest } from "../../models/request/set-password.request";
+import { UpdateTdeOffboardingPasswordRequest } from "../../models/request/update-tde-offboarding-password.request";
+import { UpdateTempPasswordRequest } from "../../models/request/update-temp-password.request";
+
+import { MasterPasswordApiService } from "./master-password-api.service.implementation";
+
+describe("MasterPasswordApiService", () => {
+  let apiService: MockProxy<ApiService>;
+  let logService: MockProxy<LogService>;
+
+  let sut: MasterPasswordApiService;
+
+  beforeEach(() => {
+    apiService = mock<ApiService>();
+    logService = mock<LogService>();
+
+    sut = new MasterPasswordApiService(apiService, logService);
+  });
+
+  it("should instantiate", () => {
+    expect(sut).not.toBeFalsy();
+  });
+
+  describe("setPassword", () => {
+    it("should call apiService.send with the correct parameters", async () => {
+      // Arrange
+      const request = new SetPasswordRequest(
+        "masterPasswordHash",
+        "key",
+        "masterPasswordHint",
+        "orgIdentifier",
+        {
+          publicKey: "publicKey",
+          encryptedPrivateKey: "encryptedPrivateKey",
+        },
+        KdfType.PBKDF2_SHA256,
+        600_000,
+      );
+
+      // Act
+      await sut.setPassword(request);
+
+      // Assert
+      expect(apiService.send).toHaveBeenCalledWith(
+        "POST",
+        "/accounts/set-password",
+        request,
+        true,
+        false,
+      );
+    });
+  });
+
+  describe("postPassword", () => {
+    it("should call apiService.send with the correct parameters", async () => {
+      // Arrange
+      const request = {
+        newMasterPasswordHash: "newMasterPasswordHash",
+        masterPasswordHint: "masterPasswordHint",
+        key: "key",
+        masterPasswordHash: "masterPasswordHash",
+      } as PasswordRequest;
+
+      // Act
+      await sut.postPassword(request);
+
+      // Assert
+      expect(apiService.send).toHaveBeenCalledWith(
+        "POST",
+        "/accounts/password",
+        request,
+        true,
+        false,
+      );
+    });
+  });
+
+  describe("putUpdateTempPassword", () => {
+    it("should call apiService.send with the correct parameters", async () => {
+      // Arrange
+      const request = {
+        masterPasswordHint: "masterPasswordHint",
+        newMasterPasswordHash: "newMasterPasswordHash",
+        key: "key",
+      } as UpdateTempPasswordRequest;
+
+      // Act
+      await sut.putUpdateTempPassword(request);
+
+      // Assert
+      expect(apiService.send).toHaveBeenCalledWith(
+        "PUT",
+        "/accounts/update-temp-password",
+        request,
+        true,
+        false,
+      );
+    });
+  });
+
+  describe("putUpdateTdeOffboardingPassword", () => {
+    it("should call apiService.send with the correct parameters", async () => {
+      // Arrange
+      const request = {
+        masterPasswordHint: "masterPasswordHint",
+        newMasterPasswordHash: "newMasterPasswordHash",
+        key: "key",
+      } as UpdateTdeOffboardingPasswordRequest;
+
+      // Act
+      await sut.putUpdateTdeOffboardingPassword(request);
+
+      // Assert
+      expect(apiService.send).toHaveBeenCalledWith(
+        "PUT",
+        "/accounts/update-tde-offboarding-password",
+        request,
+        true,
+        false,
+      );
+    });
+  });
+});

libs/common/src/services/api.service.ts

@@ -56,17 +56,13 @@ import { UserApiTokenRequest } from "../auth/models/request/identity-token/user-
 import { WebAuthnLoginTokenRequest } from "../auth/models/request/identity-token/webauthn-login-token.request";
 import { KeyConnectorUserKeyRequest } from "../auth/models/request/key-connector-user-key.request";
 import { PasswordHintRequest } from "../auth/models/request/password-hint.request";
-import { PasswordRequest } from "../auth/models/request/password.request";
 import { PasswordlessAuthRequest } from "../auth/models/request/passwordless-auth.request";
 import { SecretVerificationRequest } from "../auth/models/request/secret-verification.request";
 import { SetKeyConnectorKeyRequest } from "../auth/models/request/set-key-connector-key.request";
-import { SetPasswordRequest } from "../auth/models/request/set-password.request";
 import { TwoFactorEmailRequest } from "../auth/models/request/two-factor-email.request";
 import { TwoFactorProviderRequest } from "../auth/models/request/two-factor-provider.request";
 import { TwoFactorRecoveryRequest } from "../auth/models/request/two-factor-recovery.request";
 import { UpdateProfileRequest } from "../auth/models/request/update-profile.request";
-import { UpdateTdeOffboardingPasswordRequest } from "../auth/models/request/update-tde-offboarding-password.request";
-import { UpdateTempPasswordRequest } from "../auth/models/request/update-temp-password.request";
 import { UpdateTwoFactorAuthenticatorRequest } from "../auth/models/request/update-two-factor-authenticator.request";
 import { UpdateTwoFactorDuoRequest } from "../auth/models/request/update-two-factor-duo.request";
 import { UpdateTwoFactorEmailRequest } from "../auth/models/request/update-two-factor-email.request";
@@ -374,14 +370,6 @@ export class ApiService implements ApiServiceAbstraction {
     return this.send("POST", "/accounts/email", request, true, false);
   }
 
-  postPassword(request: PasswordRequest): Promise<any> {
-    return this.send("POST", "/accounts/password", request, true, false);
-  }
-
-  setPassword(request: SetPasswordRequest): Promise<any> {
-    return this.send("POST", "/accounts/set-password", request, true, false);
-  }
-
   postSetKeyConnectorKey(request: SetKeyConnectorKeyRequest): Promise<any> {
     return this.send("POST", "/accounts/set-key-connector-key", request, true, false);
   }
@@ -479,14 +467,6 @@ export class ApiService implements ApiServiceAbstraction {
     return new ApiKeyResponse(r);
   }
 
-  putUpdateTempPassword(request: UpdateTempPasswordRequest): Promise<any> {
-    return this.send("PUT", "/accounts/update-temp-password", request, true, false);
-  }
-
-  putUpdateTdeOffboardingPassword(request: UpdateTdeOffboardingPasswordRequest): Promise<void> {
-    return this.send("PUT", "/accounts/update-tde-offboarding-password", request, true, false);
-  }
-
   postConvertToKeyConnector(): Promise<void> {
     return this.send("POST", "/accounts/convert-to-key-connector", null, true, false);
   }