Document the upper and lower bounds for the rounds parameter in genSaltSync #898

nomuna · 2021-11-05T05:44:55Z

Apparently the rounds parameter for the method bcrypt.genSaltSync() has an upper bound of 31.
According to the encode_salt in bcrypt.cc.

/**
 * @param rounds The cost of processing the data. Default 10.
 * @param minor The minor version of bcrypt to use. Either 'a' or 'b'. Default 'b'.
 *
 * @example
 * import * as bcrypt from 'bcrypt';
 * const saltRounds = 10;
 *
 * const salt = bcrypt.genSaltSync(saltRounds);
 */
export declare function genSaltSync(rounds?: number, minor?: "a" | "b"): string;

For higher numbers a cryptic error message is created which misleads people to thinking that they may have passed in an argument of wrong type or format.

Error: Invalid salt. Salt must be in the form of: $Vers$log2(NumRounds)$saltvalue

The text was updated successfully, but these errors were encountered:

recrsn added the bug label Oct 6, 2022

Document the upper and lower bounds for the rounds parameter in genSaltSync #898

Document the upper and lower bounds for the rounds parameter in genSaltSync #898

Comments

nomuna commented Nov 5, 2021