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/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,
+      );
+    });
+  });
+});