generateBCryptHash

It is a password-hashing cryptographic function that takes an input and hashes it into a fixed size output./nNOTE: BCrypt input is limited to 72 bytes.

generateBCryptHash(plaintext,options); → returns string

This function requires Adobe ColdFusion 2021 and up. Not supported on Lucee, etc.

Argument Reference

plaintext string
Required

The input string to hash.

options struct
Default: `{"version":"$2a","rounds":10}`

A struct containing the optional values:
--version - Version of BCrypt hash to generate ($2a,$2y or $2b). (Default is "$2a". The most current version is "$2b")
--rounds - Number of rounds to run the hash functions. (Default is 10.)

Values:

version
rounds

Links more information about generateBCryptHash

OWASP Password Storage Cheat Sheet - General advice from OWASP about how to work with passwords.
Using Password4j And The BCrypt, SCrypt, And Argon2 Password Hashing Algorithms In Lucee CFML 5.3.7.47 - Blog by Ben Nadel about using hashing algorithms.
Best practices for password hashing and storage - IETF info on password hashing best practices.
Hashing Passwords: One-Way Road to Security - Blog by Dan Arias on password hashing strategies.
bcrypt - Wikipedia article about BCrypt.
Using BCrypt in Lucee - As of Lucee 5, this function has not been added yet. But this is a discussion of how to implement BCrypt in Lucee.
CFPASSPhrase - Related project to help other engines utilize hashing functions.

Examples
Sample code invoking the generateBCryptHash function

Example of BCrypt Hashing - No Options

This is an example of using the function with no options.

secretMsg=generateBCryptHash("My voice is my passport. Verify me.");writeDump(secretMsg)

Expected Result: $2a$10$.jQX1KnwPzhvVet0vEENnOlO8C70oM8GQhu0MQnCgcIlWhguWb3q.

Example of BCrypt Hashing - With Version Option

This is an example of using the function with optional version specified.

secretMsg=generateBCryptHash("My voice is my passport. Verify me.",{"version":"$2b"});
writeDump(secretMsg)

Expected Result: $2b$10$wkfNE0B2hP/GMqQPWRvTte87F/PlEZwetaDPnVwW5OjBRAPiGKZp.

Example of BCrypt Hashing - With Rounds Option

This is an example of using the function with optional rounds specified.

secretMsg=generateBCryptHash("Setec Astronomy",{"rounds":15});writeDump(secretMsg)

Expected Result: $2a$15$yBUewN8dYFd9QawytI5SO.MIq0hO65TXEoVyUAZRlK.oTHZ4Dwa0i

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.