[SG-663] RefactorNativeMessagingHandlerService and strengthen typing

apps/desktop/native-messaging-test-runner/package.json

@@ -4,12 +4,12 @@
   "description": "Test runner for Desktop native messaging",
   "main": "dist/bw-handshake.ts",
   "scripts": {
-    "handshake": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-handshake.js",
-    "status": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-status.js",
-    "retrieve": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-credential-retrieval.js",
-    "create": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-credential-create.js",
-    "update": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-credential-update.js",
-    "generate": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/bw-generate-password.js"
+    "handshake": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-handshake.js",
+    "status": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-status.js",
+    "retrieve": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-credential-retrieval.js",
+    "create": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-credential-create.js",
+    "update": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-credential-update.js",
+    "generate": "tsc && node dist/apps/desktop/native-messaging-test-runner/src/commands/bw-generate-password.js"
   },
   "author": "Bitwarden Inc. <hello@bitwarden.com> (https://bitwarden.com)",
   "license": "GPL-3.0",

apps/desktop/native-messaging-test-runner/src/bw-credential-create.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-credential-create.ts

@@ -5,11 +5,10 @@ import { hideBin } from "yargs/helpers";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { CredentialCreatePayload } from "../../src/models/nativeMessaging/credentialCreatePayload";
-
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { CredentialCreatePayload } from "../../../src/models/nativeMessaging/encryptedMessagePayloads/credentialCreatePayload";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 const argv: any = yargs(hideBin(process.argv)).option("name", {
   alias: "n",

apps/desktop/native-messaging-test-runner/src/bw-credential-retrieval.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-credential-retrieval.ts

@@ -5,9 +5,9 @@ import { hideBin } from "yargs/helpers";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 const argv: any = yargs(hideBin(process.argv)).option("uri", {
   alias: "u",

apps/desktop/native-messaging-test-runner/src/bw-credential-update.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-credential-update.ts

@@ -5,11 +5,10 @@ import { hideBin } from "yargs/helpers";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { CredentialUpdatePayload } from "../../src/models/nativeMessaging/credentialUpdatePayload";
-
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { CredentialUpdatePayload } from "../../../src/models/nativeMessaging/encryptedMessagePayloads/credentialUpdatePayload";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 // Command line arguments
 const argv: any = yargs(hideBin(process.argv))

apps/desktop/native-messaging-test-runner/src/bw-generate-password.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-generate-password.ts

@@ -5,9 +5,9 @@ import { hideBin } from "yargs/helpers";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 const argv: any = yargs(hideBin(process.argv)).option("userId", {
   alias: "u",

apps/desktop/native-messaging-test-runner/src/bw-handshake.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-handshake.ts

@@ -2,9 +2,9 @@ import "module-alias/register";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 (async () => {
   const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);

apps/desktop/native-messaging-test-runner/src/bw-status.ts → apps/desktop/native-messaging-test-runner/src/commands/bw-status.ts

@@ -2,9 +2,9 @@ import "module-alias/register";
 
 import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
 
-import { LogUtils } from "./logUtils";
-import NativeMessageService from "./nativeMessageService";
-import * as config from "./variables";
+import { LogUtils } from "../logUtils";
+import NativeMessageService from "../nativeMessageService";
+import * as config from "../variables";
 
 (async () => {
   const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);

apps/desktop/native-messaging-test-runner/src/nativeMessageService.ts

@@ -9,10 +9,10 @@ import { ConsoleLogService } from "@bitwarden/common/services/consoleLog.service
 import { EncryptService } from "@bitwarden/common/services/encrypt.service";
 import { NodeCryptoFunctionService } from "@bitwarden/node/services/nodeCryptoFunction.service";
 
-import { CredentialCreatePayload } from "../../src/models/nativeMessaging/credentialCreatePayload";
-import { CredentialUpdatePayload } from "../../src/models/nativeMessaging/credentialUpdatePayload";
 import { DecryptedCommandData } from "../../src/models/nativeMessaging/decryptedCommandData";
 import { EncryptedMessage } from "../../src/models/nativeMessaging/encryptedMessage";
+import { CredentialCreatePayload } from "../../src/models/nativeMessaging/encryptedMessagePayloads/credentialCreatePayload";
+import { CredentialUpdatePayload } from "../../src/models/nativeMessaging/encryptedMessagePayloads/credentialUpdatePayload";
 import { EncryptedMessageResponse } from "../../src/models/nativeMessaging/encryptedMessageResponse";
 import { MessageCommon } from "../../src/models/nativeMessaging/messageCommon";
 import { UnencryptedMessage } from "../../src/models/nativeMessaging/unencryptedMessage";

apps/desktop/src/app/services/services.module.ts

@@ -24,7 +24,7 @@ import {
   LogService as LogServiceAbstraction,
 } from "@bitwarden/common/abstractions/log.service";
 import { MessagingService as MessagingServiceAbstraction } from "@bitwarden/common/abstractions/messaging.service";
-import { PasswordGenerationService } from "@bitwarden/common/abstractions/passwordGeneration.service";
+import { PasswordGenerationService as PasswordGenerationServiceAbstraction } from "@bitwarden/common/abstractions/passwordGeneration.service";
 import { PasswordRepromptService as PasswordRepromptServiceAbstraction } from "@bitwarden/common/abstractions/passwordReprompt.service";
 import { PlatformUtilsService as PlatformUtilsServiceAbstraction } from "@bitwarden/common/abstractions/platformUtils.service";
 import { PolicyService as PolicyServiceAbstraction } from "@bitwarden/common/abstractions/policy/policy.service.abstraction";
@@ -45,8 +45,9 @@ import { ElectronRendererSecureStorageService } from "@bitwarden/electron/servic
 import { ElectronRendererStorageService } from "@bitwarden/electron/services/electronRendererStorage.service";
 
 import { Account } from "../../models/account";
+import { EncryptedMessageHandlerService } from "../../services/encryptedMessageHandlerService";
 import { I18nService } from "../../services/i18n.service";
-import { NativeMessageHandler } from "../../services/nativeMessageHandler.service";
+import { NativeMessageHandlerService } from "../../services/nativeMessageHandler.service";
 import { NativeMessagingService } from "../../services/nativeMessaging.service";
 import { PasswordRepromptService } from "../../services/passwordReprompt.service";
 import { StateService } from "../../services/state.service";
@@ -153,17 +154,25 @@ const RELOAD_CALLBACK = new InjectionToken<() => any>("RELOAD_CALLBACK");
       useClass: DesktopThemingService,
     },
     {
-      provide: NativeMessageHandler,
+      provide: EncryptedMessageHandlerService,
       deps: [
         StateServiceAbstraction,
         AuthServiceAbstraction,
-        CryptoServiceAbstraction,
-        CryptoFunctionServiceAbstraction,
         CipherServiceAbstraction,
         PolicyServiceAbstraction,
         MessagingServiceAbstraction,
-        PasswordGenerationService,
+        PasswordGenerationServiceAbstraction,
+      ],
+    },
+    {
+      provide: NativeMessageHandlerService,
+      deps: [
+        StateServiceAbstraction,
+        CryptoServiceAbstraction,
+        CryptoFunctionServiceAbstraction,
+        MessagingServiceAbstraction,
         I18nServiceAbstraction,
+        EncryptedMessageHandlerService,
       ],
     },
   ],

apps/desktop/src/models/nativeMessaging/encryptedMessagePayloads/credentialRetrievePayload.ts

@@ -0,0 +1,4 @@
+export type CredentialRetrievePayload = {
+  userId: string;
+  uri: string;
+};

apps/desktop/src/models/nativeMessaging/encryptedMessagePayloads/passwordGeneratePayload.ts

@@ -0,0 +1,3 @@
+export type PasswordGeneratePayload = {
+  userId: string;
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/accountStatusResponse.ts

@@ -0,0 +1,6 @@
+export type AccountStatusResponse = {
+  id: string;
+  email: string;
+  status: "locked" | "unlocked";
+  active: boolean;
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/cannotDecryptErrorResponse.ts

@@ -0,0 +1,3 @@
+export type CannotDecryptErrorResponse = {
+  error: "cannot-decrypt";
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/encryptedMessageResponse.ts

@@ -0,0 +1,16 @@
+import { AccountStatusResponse } from "./accountStatusResponse";
+import { CannotDecryptErrorResponse } from "./cannotDecryptErrorResponse";
+import { CipherResponse } from "./cipherResponse";
+import { FailureStatusResponse } from "./failureStatusResponse";
+import { GenerateResponse } from "./generateResponse";
+import { SuccessStatusResponse } from "./successStatusResponse";
+import { UserStatusErrorResponse } from "./userStatusErrorResponse";
+
+export type EncyptedMessageResponse =
+  | AccountStatusResponse[]
+  | CannotDecryptErrorResponse
+  | CipherResponse[]
+  | FailureStatusResponse
+  | GenerateResponse
+  | SuccessStatusResponse
+  | UserStatusErrorResponse;

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/failureStatusResponse.ts

@@ -0,0 +1,3 @@
+export type FailureStatusResponse = {
+  status: "failure";
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/generateResponse.ts

@@ -0,0 +1,3 @@
+export type GenerateResponse = {
+  password: string;
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/successStatusResponse.ts

@@ -0,0 +1,3 @@
+export type SuccessStatusResponse = {
+  status: "success";
+};

apps/desktop/src/models/nativeMessaging/encryptedMessageResponses/userStatusErrorResponse.ts

@@ -0,0 +1,3 @@
+export type UserStatusErrorResponse = {
+  error: "locked" | "not-active-user";
+};

apps/desktop/src/models/nativeMessaging/index.ts

@@ -1,6 +1,17 @@
-export * from "./cipherResponse";
-export * from "./credentialCreatePayload";
-export * from "./credentialUpdatePayload";
+export * from "./encryptedMessagePayloads/credentialCreatePayload";
+export * from "./encryptedMessagePayloads/credentialRetrievePayload";
+export * from "./encryptedMessagePayloads/credentialUpdatePayload";
+export * from "./encryptedMessagePayloads/passwordGeneratePayload";
+
+export * from "./encryptedMessageResponses/accountStatusResponse";
+export * from "./encryptedMessageResponses/cannotDecryptErrorResponse";
+export * from "./encryptedMessageResponses/cipherResponse";
+export * from "./encryptedMessageResponses/encryptedMessageResponse";
+export * from "./encryptedMessageResponses/failureStatusResponse";
+export * from "./encryptedMessageResponses/generateResponse";
+export * from "./encryptedMessageResponses/successStatusResponse";
+export * from "./encryptedMessageResponses/userStatusErrorResponse";
+
 export * from "./decryptedCommandData";
 export * from "./encryptedCommand";
 export * from "./encryptedMessage";