@twin.org/crypto 0.0.3-next.9 → 0.0.4-next.1

package/dist/types/models/integrityAlgorithm.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The names of the integrity algorithms.
+ */
+export declare const IntegrityAlgorithm: {
+    /**
+     * Sha256.
+     */
+    readonly Sha256: "sha256";
+    /**
+     * Sha384.
+     */
+    readonly Sha384: "sha384";
+    /**
+     * Sha512.
+     */
+    readonly Sha512: "sha512";
+};
+/**
+ * Integrity algorithms.
+ */
+export type IntegrityAlgorithm = (typeof IntegrityAlgorithm)[keyof typeof IntegrityAlgorithm];

package/dist/types/passwords/passwordGenerator.d.ts

@@ -2,10 +2,21 @@
  * Generate random passwords.
  */
 export declare class PasswordGenerator {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Generate a password of given length.
-     * @param length The length of the password to generate.
+     * @param length The length of the password to generate, default to 15.
      * @returns The random password.
      */
-    static generate(length: number): string;
+    static generate(length?: number): string;
+    /**
+     * Hash the password for the user.
+     * @param passwordBytes The password bytes.
+     * @param saltBytes The salt bytes.
+     * @returns The hashed password.
+     */
+    static hashPassword(passwordBytes: Uint8Array, saltBytes: Uint8Array): Promise<string>;
 }

package/dist/types/passwords/passwordValidator.d.ts

@@ -1,16 +1,20 @@
 import { type IValidationFailure } from "@twin.org/core";
 /**
  * Test password strength.
- * Ref https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Password_Strength_Controls .
+ * @see https://www.owasp.org/index.php/Authentication_Cheat_Sheet#Implement_Proper_Password_Strength_Controls .
  */
 export declare class PasswordValidator {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Test the strength of the password.
      * @param property The name of the property.
      * @param password The password to test.
      * @param failures The list of failures to add to.
      * @param options Options to configure the testing.
-     * @param options.minLength The minimum length of the password, defaults to 8.
+     * @param options.minLength The minimum length of the password, defaults to 15, can be 8 if MFA is enabled.
      * @param options.maxLength The minimum length of the password, defaults to 128.
      * @param options.minPhraseLength The minimum length of the password for it to be considered a pass phrase.
      */
@@ -19,4 +23,32 @@ export declare class PasswordValidator {
         maxLength?: number;
         minPhraseLength?: number;
     }): void;
+    /**
+     * Validate the password against security policy.
+     * @param password The password to validate.
+     * @param options Options to configure the testing.
+     * @param options.minLength The minimum length of the password, defaults to 15.
+     * @param options.maxLength The minimum length of the password, defaults to 128.
+     * @param options.minPhraseLength The minimum length of the password for it to be considered a pass phrase.
+     * @throws Error if the password does not meet the requirements.
+     */
+    static validatePassword(password: string, options?: {
+        minLength?: number;
+        maxLength?: number;
+        minPhraseLength?: number;
+    }): void;
+    /**
+     * Compare two password byte arrays in constant time to prevent timing attacks.
+     * @param hashedPasswordBytes The computed password bytes to compare.
+     * @param storedPasswordBytes The stored password bytes to compare against.
+     * @returns True if the bytes match, false otherwise.
+     */
+    static comparePasswordBytes(hashedPasswordBytes: Uint8Array, storedPasswordBytes: Uint8Array): boolean;
+    /**
+     * Compare two hashed passwords in constant time to prevent timing attacks.
+     * @param hashedPassword The computed hash to compare.
+     * @param storedPassword The stored hash to compare against.
+     * @returns True if the hashes match, false otherwise.
+     */
+    static comparePasswordHashes(hashedPassword: string, storedPassword: string): boolean;
 }