mirror of
https://github.com/hanzoai/bcrypt.js.git
synced 2026-10-30 19:37:55 +00:00
158 lines
5.5 KiB
TypeScript
158 lines
5.5 KiB
TypeScript
// Originally imported from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8b36dbdf95b624b8a7cd7f8416f06c15d274f9e6/types/bcryptjs/index.d.ts
|
|
// MIT license.
|
|
|
|
/** Called with an error on failure or a value of type `T` upon success. */
|
|
type Callback<T> = (err: Error | null, result?: T) => void;
|
|
/** Called with the percentage of rounds completed (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms. */
|
|
type ProgressCallback = (percentage: number) => void;
|
|
/** Called to obtain random bytes when both Web Crypto API and Node.js crypto are not available. */
|
|
type RandomFallback = (length: number) => number[];
|
|
|
|
/**
|
|
* Sets the pseudo random number generator to use as a fallback if neither node's crypto module nor the Web Crypto API is available.
|
|
* Please note: It is highly important that the PRNG used is cryptographically secure and that it is seeded properly!
|
|
* @param random Function taking the number of bytes to generate as its sole argument, returning the corresponding array of cryptographically secure random byte values.
|
|
*/
|
|
export declare function setRandomFallback(random: RandomFallback): void;
|
|
|
|
/**
|
|
* Synchronously generates a salt.
|
|
* @param rounds Number of rounds to use, defaults to 10 if omitted
|
|
* @return Resulting salt
|
|
* @throws If a random fallback is required but not set
|
|
*/
|
|
export declare function genSaltSync(rounds?: number): string;
|
|
|
|
/**
|
|
* Asynchronously generates a salt.
|
|
* @param rounds Number of rounds to use, defaults to 10 if omitted
|
|
* @return Promise with resulting salt, if callback has been omitted
|
|
*/
|
|
export declare function genSalt(rounds?: number): Promise<string>;
|
|
|
|
/**
|
|
* Asynchronously generates a salt.
|
|
* @param callback Callback receiving the error, if any, and the resulting salt
|
|
*/
|
|
export declare function genSalt(callback: Callback<string>): void;
|
|
|
|
/**
|
|
* Asynchronously generates a salt.
|
|
* @param rounds Number of rounds to use, defaults to 10 if omitted
|
|
* @param callback Callback receiving the error, if any, and the resulting salt
|
|
*/
|
|
export declare function genSalt(
|
|
rounds: number,
|
|
callback: Callback<string>,
|
|
): void;
|
|
|
|
/**
|
|
* Synchronously generates a hash for the given password.
|
|
* @param password Password to hash
|
|
* @param salt Salt length to generate or salt to use, default to 10
|
|
* @return Resulting hash
|
|
*/
|
|
export declare function hashSync(
|
|
password: string,
|
|
salt?: number | string,
|
|
): string;
|
|
|
|
/**
|
|
* Asynchronously generates a hash for the given password.
|
|
* @param password Password to hash
|
|
* @param salt Salt length to generate or salt to use
|
|
* @return Promise with resulting hash, if callback has been omitted
|
|
*/
|
|
export declare function hash(
|
|
password: string,
|
|
salt: number | string,
|
|
): Promise<string>;
|
|
|
|
/**
|
|
* Asynchronously generates a hash for the given password.
|
|
* @param password Password to hash
|
|
* @param salt Salt length to generate or salt to use
|
|
* @param callback Callback receiving the error, if any, and the resulting hash
|
|
* @param progressCallback Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per MAX_EXECUTION_TIME = 100 ms.
|
|
*/
|
|
export declare function hash(
|
|
password: string,
|
|
salt: number | string,
|
|
callback?: Callback<string>,
|
|
progressCallback?: ProgressCallback,
|
|
): void;
|
|
|
|
/**
|
|
* Synchronously tests a password against a hash.
|
|
* @param password Password to test
|
|
* @param hash Hash to test against
|
|
* @return true if matching, otherwise false
|
|
*/
|
|
export declare function compareSync(password: string, hash: string): boolean;
|
|
|
|
/**
|
|
* Asynchronously tests a password against a hash.
|
|
* @param password Password to test
|
|
* @param hash Hash to test against
|
|
* @return Promise, if callback has been omitted
|
|
*/
|
|
export declare function compare(
|
|
password: string,
|
|
hash: string,
|
|
): Promise<boolean>;
|
|
|
|
/**
|
|
* Asynchronously tests a password against a hash.
|
|
* @param password Password to test
|
|
* @param hash Hash to test against
|
|
* @param callback Callback receiving the error, if any, otherwise the result
|
|
* @param progressCallback Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per MAX_EXECUTION_TIME = 100 ms.
|
|
*/
|
|
export declare function compare(
|
|
password: string,
|
|
hash: string,
|
|
callback?: Callback<boolean>,
|
|
progressCallback?: ProgressCallback,
|
|
): void;
|
|
|
|
/**
|
|
* Gets the number of rounds used to encrypt the specified hash.
|
|
* @param hash Hash to extract the used number of rounds from
|
|
* @return Number of rounds used
|
|
*/
|
|
export declare function getRounds(hash: string): number;
|
|
|
|
/**
|
|
* Gets the salt portion from a hash. Does not validate the hash.
|
|
* @param hash Hash to extract the salt from
|
|
* @return Extracted salt part
|
|
*/
|
|
export declare function getSalt(hash: string): string;
|
|
|
|
/**
|
|
* Tests if a password will be truncated when hashed, that is its length is
|
|
* greater than 72 bytes when converted to UTF-8.
|
|
* @param password The password to test
|
|
* @returns `true` if truncated, otherwise `false`
|
|
*/
|
|
export declare function truncates(password: string): boolean;
|
|
|
|
/**
|
|
* Encodes a byte array to base64 with up to len bytes of input, using the custom bcrypt alphabet.
|
|
* @function
|
|
* @param b Byte array
|
|
* @param len Maximum input length
|
|
*/
|
|
export declare function encodeBase64(
|
|
b: Readonly<ArrayLike<number>>,
|
|
len: number,
|
|
): string;
|
|
|
|
/**
|
|
* Decodes a base64 encoded string to up to len bytes of output, using the custom bcrypt alphabet.
|
|
* @function
|
|
* @param s String to decode
|
|
* @param len Maximum output length
|
|
*/
|
|
export declare function decodeBase64(s: string, len: number): number[];
|