From ac9d530325f5f3eb1b335cc94c9aa9574b309c9d Mon Sep 17 00:00:00 2001
From: Michael Wedl <michael@syslifters.com>
Date: Mon, 16 Dec 2024 07:09:52 +0100
Subject: [PATCH] Add button to generate random password to password fields

---
 CHANGELOG.md                                  |  1 +
 .../frontend/src/components/LoginForm.vue     |  2 +-
 .../src/components/Notes/ShareInfoForm.vue    |  1 +
 .../pages/projects/[projectId]/publish.vue    | 12 ++---
 .../pages/users/[userId]/reset-password.vue   |  2 +-
 packages/frontend/src/pages/users/new.vue     |  2 +-
 .../src/pages/users/self/security.vue         |  2 +-
 .../src/components/S/PasswordField.vue        | 45 +++++++++++++------
 packages/nuxt-base-layer/src/utils/helpers.ts |  8 +++-
 9 files changed, 48 insertions(+), 27 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 07105480c..a5f7390e2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,7 @@
 * Update and optimize designs: demo, HTB and OffSec designs
 * Add design for HTB CAPE certification
 * Warn about relative URLs in PDFs during rendering
+* Add button to generate random password to password fields
 
 
 ## v2024.96 - 2024-12-04
diff --git a/packages/frontend/src/components/LoginForm.vue b/packages/frontend/src/components/LoginForm.vue
index 1e54557c8..8211d77da 100644
--- a/packages/frontend/src/components/LoginForm.vue
+++ b/packages/frontend/src/components/LoginForm.vue
@@ -136,7 +136,7 @@
         <v-card-text>
           <s-password-field
             v-model="formChangePassword.password"
-            confirm show-strength
+            confirm show-strength generate
             label="New Password"
           />
 
diff --git a/packages/frontend/src/components/Notes/ShareInfoForm.vue b/packages/frontend/src/components/Notes/ShareInfoForm.vue
index 6dae7d7c2..466c52812 100644
--- a/packages/frontend/src/components/Notes/ShareInfoForm.vue
+++ b/packages/frontend/src/components/Notes/ShareInfoForm.vue
@@ -29,6 +29,7 @@
           :model-value="modelValue.password"
           @update:model-value="updateProp('password', $event)"
           label="Password (optional)"
+          generate
           :disabled="props.disabled"
           :error-messages="props.error?.password"
         />
diff --git a/packages/frontend/src/pages/projects/[projectId]/publish.vue b/packages/frontend/src/pages/projects/[projectId]/publish.vue
index e6f07a706..73caaee12 100644
--- a/packages/frontend/src/pages/projects/[projectId]/publish.vue
+++ b/packages/frontend/src/pages/projects/[projectId]/publish.vue
@@ -47,7 +47,7 @@
             v-model="form.password"
             :error-messages="(localSettings.encryptPdfEnabled && form.password.length === 0) ? ['Password required'] : []"
             label="PDF password"
-            append-inner-icon="mdi-lock-reset" @click:append-inner="form.password = generateNewPassword()"
+            append-inner-icon="mdi-lock-reset" @click:append-inner="form.password = generateRandomPassword()"
             spellcheck="false"
             class="mt-4"
           />
@@ -106,8 +106,7 @@
 </template>
 
 <script setup lang="ts">
-import { sampleSize } from "lodash-es"
-import { fileDownload } from "@base/utils/helpers";
+import { fileDownload, generateRandomPassword } from "@base/utils/helpers";
 
 definePageMeta({
   title: 'Publish',
@@ -142,13 +141,8 @@ const allMessages = computed(() => {
 });
 const hasErrors = computed(() => allMessages.value.some(m => m.level === MessageLevel.ERROR));
 
-function generateNewPassword() {
-  // Charset does not contain similar-looking characters and numbers; removed: 0,O, 1,l,I
-  const charset = '23456789' + 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ' + '!#%&+-_';
-  return sampleSize(charset, 20).join('');
-}
 const form = ref({
-  password: generateNewPassword(),
+  password: generateRandomPassword(),
   filename: (project.value.name + '_report.pdf').replaceAll(/[\\/]/g, '').replaceAll(/\s+/g, ' '),
 });
 const rules = {
diff --git a/packages/frontend/src/pages/users/[userId]/reset-password.vue b/packages/frontend/src/pages/users/[userId]/reset-password.vue
index 562c1af7a..08805c78a 100644
--- a/packages/frontend/src/pages/users/[userId]/reset-password.vue
+++ b/packages/frontend/src/pages/users/[userId]/reset-password.vue
@@ -10,7 +10,7 @@
       v-model="form.password"
       label="New password"
       :error-messages="serverErrors?.password || []"
-      confirm show-strength
+      confirm show-strength generate
       :disabled="!canEdit"
     />
 
diff --git a/packages/frontend/src/pages/users/new.vue b/packages/frontend/src/pages/users/new.vue
index 47cf57cdd..357029bdf 100644
--- a/packages/frontend/src/pages/users/new.vue
+++ b/packages/frontend/src/pages/users/new.vue
@@ -15,7 +15,7 @@
           <div v-if="apiSettings.isLocalUserAuthEnabled">
             <s-password-field
               v-model="userForm.password"
-              confirm show-strength
+              confirm show-strength generate
               :error-messages="serverErrors?.password || []"
             />
             <s-checkbox
diff --git a/packages/frontend/src/pages/users/self/security.vue b/packages/frontend/src/pages/users/self/security.vue
index 1b7b9c573..cfe2cd9a4 100644
--- a/packages/frontend/src/pages/users/self/security.vue
+++ b/packages/frontend/src/pages/users/self/security.vue
@@ -38,7 +38,7 @@
                   v-model="changePasswordWizard.password"
                   label="New Password"
                   :error-messages="changePasswordWizard.errors?.password"
-                  confirm show-strength
+                  confirm show-strength generate
                 />
               </v-card-text>
               <v-card-actions>
diff --git a/packages/nuxt-base-layer/src/components/S/PasswordField.vue b/packages/nuxt-base-layer/src/components/S/PasswordField.vue
index 10296f687..485ae2a48 100644
--- a/packages/nuxt-base-layer/src/components/S/PasswordField.vue
+++ b/packages/nuxt-base-layer/src/components/S/PasswordField.vue
@@ -5,21 +5,33 @@
       :model-value="modelValue" @update:model-value="passwordChanged"
       :type="showPassword ? 'text' : 'password'"
       :label="label"
-      :disabled="disabled"
+      :disabled="props.disabled"
       :append-inner-icon="showPassword ? 'mdi-eye' : 'mdi-eye-off'"
       @click:append-inner="showPassword = !showPassword"
-      :loading="showStrength"
+      :loading="props.showStrength"
+      :variant="props.variant"
       autocomplete="off"
       spellcheck="false"
       class="mt-4"
     >
-      <template #loader>
+      <template #loader v-if="props.showStrength">
         <v-progress-linear
           v-model="passwordStrengthLevel"
           :color="passwordStrengthColor"
           height="7"
         />
       </template>
+      <template #append v-if="props.generate">
+        <s-btn 
+          @click="generateNewPassword"
+          icon 
+          density="compact"
+          :disabled="props.disabled"
+        >
+          <v-icon icon="mdi-lock-reset" />
+          <s-tooltip activator="parent" text="Generate random password" />
+        </s-btn>
+      </template>
     </s-text-field>
     <s-text-field
       v-if="confirm"
@@ -27,10 +39,11 @@
       v-model="passwordConfirmValue"
       :type="showPassword ? 'text' : 'password'"
       :label="label + ' (confirm)'"
-      :disabled="disabled"
+      :disabled="props.disabled"
       :append-innner-icon="showPassword ? 'mdi-eye' : 'mdi-eye-off'"
       @click:append-inner="showPassword = !showPassword"
       :rules="rules.confirmMatches"
+      :variant="props.variant"
       autocomplete="off"
       spellcheck="false"
       class="mt-6"
@@ -42,47 +55,53 @@
 import type { VForm } from "vuetify/lib/components/index.mjs";
 import zxcvbn from 'zxcvbn';
 
+const modelValue = defineModel<string|null>();
 const props = withDefaults(defineProps<{
-  modelValue: string | null,
   label?: string,
+  variant?: string,
   disabled?: boolean,
   confirm?: boolean,
   showStrength?: boolean,
+  generate?: boolean,
 }>(), {
   label: 'Password',
+  variant: undefined,
   disabled: false,
   confirm: false,
   showStrength: false,
 });
-const emit = defineEmits<{
-  (e: 'update:modelValue', value: string): void,
-}>();
 
 const confirmField = ref<VForm|null>(null);
 async function passwordChanged(val: string) {
   if (props.confirm && confirmField.value) {
     await confirmField.value.validate();
   }
-  emit('update:modelValue', val);
+  modelValue.value = val;
 }
 
 const showPassword = ref(false);
 const passwordConfirmValue = ref('');
 const rules = {
-  confirmMatches: [(p: string) => p === props.modelValue || (!p && !props.modelValue) || 'Passwords do not match'],
+  confirmMatches: [(p: string) => p === modelValue.value || (!p && !modelValue.value) || 'Passwords do not match'],
 };
 
-const passwordStrengthCheckResult = computed(() => zxcvbn(props.modelValue || ''));
+const passwordStrengthCheckResult = computed(() => zxcvbn(modelValue.value || ''));
 const passwordStrengthLevel = computed(() => {
-  if (!props.modelValue) {
+  if (!modelValue.value) {
     return 0;
   }
   return [10, 30, 50, 80, 100][passwordStrengthCheckResult.value.score];
 });
 const passwordStrengthColor = computed(() => {
-  if (!props.modelValue) {
+  if (!modelValue.value) {
     return 'error';
   }
   return ['error', 'amber-darken-4', 'warning', 'lime-darken-1', 'success'][passwordStrengthCheckResult.value.score];
 });
+
+function generateNewPassword() {
+  modelValue.value = generateRandomPassword()
+  passwordConfirmValue.value = '';
+  showPassword.value = true;
+}
 </script>
diff --git a/packages/nuxt-base-layer/src/utils/helpers.ts b/packages/nuxt-base-layer/src/utils/helpers.ts
index caf62bcd7..95b0f4820 100644
--- a/packages/nuxt-base-layer/src/utils/helpers.ts
+++ b/packages/nuxt-base-layer/src/utils/helpers.ts
@@ -1,4 +1,4 @@
-import { setWith, clone, cloneDeep } from "lodash-es";
+import { setWith, clone, cloneDeep, sampleSize } from "lodash-es";
 export { decode as base64decode, encode as base64encode } from 'base64-arraybuffer';
 export { default as fileDownload } from 'js-file-download';
 export { default as urlJoin } from 'url-join';
@@ -180,3 +180,9 @@ export function useAbortController<T>(performFetch: (fetchOptions: { signal: Abo
     pending,
   }
 }
+
+export function generateRandomPassword() {
+  // Charset does not contain similar-looking characters and numbers; removed: 0,O, 1,l,I
+  const charset = '23456789' + 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ' + '!#%&+-_';
+  return sampleSize(charset, 20).join('');
+}