[SG-536] Implement bw-generate-password

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

@@ -8,7 +8,8 @@
     "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"
+    "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"
   },
   "author": "Bitwarden Inc. <hello@bitwarden.com> (https://bitwarden.com)",
   "license": "GPL-3.0",

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

@@ -3,6 +3,8 @@ import "module-alias/register";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
+import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
+
 import { CredentialCreatePayload } from "../../src/models/nativeMessaging/credentialCreatePayload";
 
 import { LogUtils } from "./logUtils";
@@ -19,9 +21,9 @@ const argv: any = yargs(hideBin(process.argv)).option("name", {
 const { name } = argv;
 
 (async () => {
-  const nativeMessageService = new NativeMessageService(1.0);
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
   // Handshake
-  LogUtils.logWarning("Sending Handshake");
+  LogUtils.logInfo("Sending Handshake");
   const handshakeResponse = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
 
   if (handshakeResponse.status !== "success") {
@@ -37,7 +39,7 @@ const { name } = argv;
   if (activeUser === undefined) {
     LogUtils.logError("No active or unlocked user");
   }
-  LogUtils.logWarning("Active userId: " + activeUser.id);
+  LogUtils.logInfo("Active userId: " + activeUser.id);
 
   LogUtils.logSuccess("Handshake success response");
   const response = await nativeMessageService.credentialCreation(handshakeResponse.sharedKey, {

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

@@ -1,10 +1,10 @@
-/* eslint-disable no-console */
-
 import "module-alias/register";
 
 import yargs from "yargs";
 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";
@@ -19,9 +19,9 @@ const argv: any = yargs(hideBin(process.argv)).option("uri", {
 const { uri } = argv;
 
 (async () => {
-  const nativeMessageService = new NativeMessageService(1.0);
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
   // Handshake
-  LogUtils.logWarning("Sending Handshake");
+  LogUtils.logInfo("Sending Handshake");
   const handshakeResponse = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
 
   if (handshakeResponse.status !== "success") {

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

@@ -3,6 +3,8 @@ import "module-alias/register";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
+import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
+
 import { CredentialUpdatePayload } from "../../src/models/nativeMessaging/credentialUpdatePayload";
 
 import { LogUtils } from "./logUtils";
@@ -38,9 +40,9 @@ const argv: any = yargs(hideBin(process.argv))
 const { name, username, password, uri } = argv;
 
 (async () => {
-  const nativeMessageService = new NativeMessageService(1.0);
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
   // Handshake
-  LogUtils.logWarning("Sending Handshake");
+  LogUtils.logInfo("Sending Handshake");
   const handshakeResponse = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
 
   if (handshakeResponse.status !== "success") {
@@ -57,7 +59,7 @@ const { name, username, password, uri } = argv;
   if (activeUser === undefined) {
     LogUtils.logError("No active or unlocked user");
   }
-  LogUtils.logWarning("Active userId: " + activeUser.id);
+  LogUtils.logInfo("Active userId: " + activeUser.id);
 
   const response = await nativeMessageService.credentialUpdate(handshakeResponse.sharedKey, {
     name: name,

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

@@ -0,0 +1,43 @@
+import "module-alias/register";
+
+import yargs from "yargs";
+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";
+
+const argv: any = yargs(hideBin(process.argv)).option("userId", {
+  alias: "u",
+  demand: true,
+  describe: "UserId to generate password for",
+  type: "string",
+}).argv;
+
+const { userId } = argv;
+
+(async () => {
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
+  // Handshake
+  LogUtils.logInfo("Sending Handshake");
+  const handshakeResponse = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
+
+  if (handshakeResponse.status !== "success") {
+    LogUtils.logError("Handshake failed. Status was:", handshakeResponse.status);
+    nativeMessageService.disconnect();
+    return;
+  }
+
+  LogUtils.logSuccess("Handshake success response");
+  const response = await nativeMessageService.generatePassword(handshakeResponse.sharedKey, userId);
+
+  if (response.payload.error != null) {
+    LogUtils.logError("Error response returned: ", response.payload.error);
+  } else {
+    LogUtils.logSuccess("Response: ", response);
+  }
+
+  nativeMessageService.disconnect();
+})();

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

@@ -1,9 +1,13 @@
+import "module-alias/register";
+
+import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
+
 import { LogUtils } from "./logUtils";
 import NativeMessageService from "./nativeMessageService";
 import * as config from "./variables";
 
 (async () => {
-  const nativeMessageService = new NativeMessageService(1.0);
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
 
   const response = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
   LogUtils.logSuccess("Received response to handshake request");

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

@@ -1,12 +1,15 @@
 import "module-alias/register";
+
+import { NativeMessagingVersion } from "@bitwarden/common/enums/nativeMessagingVersion";
+
 import { LogUtils } from "./logUtils";
 import NativeMessageService from "./nativeMessageService";
 import * as config from "./variables";
 
 (async () => {
-  const nativeMessageService = new NativeMessageService(1.0);
+  const nativeMessageService = new NativeMessageService(NativeMessagingVersion.One);
 
-  LogUtils.logWarning("Sending Handshake");
+  LogUtils.logInfo("Sending Handshake");
   const handshakeResponse = await nativeMessageService.sendHandshake(config.testRsaPublicKey);
   LogUtils.logSuccess("Received response to handshake request");
 

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

@@ -1,28 +1,29 @@
 /* eslint-disable no-console */
 
-// Class for logging messages with colors for ease of readin important info
+// Class for logging messages with colors for ease of reading important info
+// Reference: https://stackoverflow.com/a/41407246
 export class LogUtils {
   static logSuccess(message: string, payload?: any): void {
-    if (payload) {
-      console.log(`\x1b[32m ${message} \x1b[0m`, payload);
-    } else {
-      console.log(`\x1b[32m ${message} \x1b[0m`);
-    }
+    this.logFormat(message, "32", payload);
   }
 
   static logWarning(message: string, payload?: any): void {
-    if (payload) {
-      console.log(`\x1b[33m ${message} \x1b[0m`, payload);
-    } else {
-      console.log(`\x1b[33m ${message} \x1b[0m`);
-    }
+    this.logFormat(message, "33", payload);
   }
 
   static logError(message: string, payload?: any): void {
+    this.logFormat(message, "31", payload);
+  }
+
+  static logInfo(message: string, payload?: any): void {
+    this.logFormat(message, "36", payload);
+  }
+
+  private static logFormat(message: string, color: string, payload?: any) {
     if (payload) {
-      console.log(`\x1b[31m ${message} \x1b[0m`, payload);
+      console.log(`\x1b[${color}m ${message} \x1b[0m`, payload);
     } else {
-      console.log(`\x1b[31m ${message} \x1b[0m`);
+      console.log(`\x1b[${color}m ${message} \x1b[0m`);
     }
   }
 }

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

@@ -22,7 +22,7 @@ import IPCService from "./ipcService";
 import * as config from "./variables";
 
 type HandshakePayload = {
-  status: "success" | "cancelled";
+  status: "success" | "canceled";
   sharedKey?: string;
 };
 
@@ -125,6 +125,23 @@ export default class NativeMessageService {
     return this.decryptResponsePayload(response.encryptedPayload, key);
   }
 
+  async generatePassword(key: string, userId: string): Promise<DecryptedCommandData> {
+    const encryptedCommand = await this.encryptCommandData(
+      {
+        command: "bw-generate-password",
+        payload: {
+          userId: userId,
+        },
+      },
+      key
+    );
+    const response = await this.sendEncryptedMessage({
+      encryptedCommand,
+    });
+
+    return this.decryptResponsePayload(response.encryptedPayload, key);
+  }
+
   // Private message sending
 
   private async sendEncryptedMessage(

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

@@ -24,6 +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 { 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";
@@ -161,6 +162,7 @@ const RELOAD_CALLBACK = new InjectionToken<() => any>("RELOAD_CALLBACK");
         CipherServiceAbstraction,
         PolicyServiceAbstraction,
         MessagingServiceAbstraction,
+        PasswordGenerationService,
       ],
     },
   ],

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

@@ -4,7 +4,7 @@ export type UnencryptedMessageResponse = MessageCommon &
   (
     | {
         payload: {
-          status: "cancelled";
+          status: "canceled";
         };
       }
     | {
@@ -15,7 +15,7 @@ export type UnencryptedMessageResponse = MessageCommon &
       }
     | {
         payload: {
-          error: "locked" | "cannot-decrypt";
+          error: "locked" | "cannot-decrypt" | "version-discrepancy";
         };
       }
   );