bcryptjs

What is bcryptjs?

The bcryptjs npm package is a library that allows developers to hash and compare passwords securely in Node.js applications. It is a pure JavaScript implementation of the bcrypt password hashing algorithm and is compatible with the C++ bcrypt binding on npm. It's designed to be a reliable and secure way to handle password storage and verification.

What are bcryptjs's main functionalities?

Hashing Passwords

This feature allows you to securely hash passwords using bcrypt. The `genSalt` function generates a salt, and the `hash` function applies the bcrypt hashing algorithm to the password along with the salt.

const bcrypt = require('bcryptjs');
const password = 'myPassword123';
bcrypt.genSalt(10, function(err, salt) {
  bcrypt.hash(password, salt, function(err, hash) {
    // Store hash in your password DB.
  });
});

Comparing Passwords

This feature is used to compare a plaintext password with a previously hashed one to check if they match. It is commonly used during the login process to verify user credentials.

const bcrypt = require('bcryptjs');
const password = 'myPassword123';
const hash = '$2a$10$N9qo8uLOickgx2ZMRZoMye';
bcrypt.compare(password, hash, function(err, isMatch) {
  if (err) throw err;
  console.log('Password match:', isMatch);
});

Other packages similar to bcryptjs

argon2

Argon2 is another password hashing library that won the Password Hashing Competition and is considered one of the most secure options. It is different from bcryptjs in that it provides resistance to GPU cracking attacks and can be configured for additional memory hardness.

scrypt

Scrypt is a password-based key derivation function that is designed to be costly computationally and memory-wise, making it difficult to perform large-scale custom hardware attacks. It is similar to bcryptjs in its goals but uses a different approach to achieve them.

pbkdf2

PBKDF2 (Password-Based Key Derivation Function 2) is part of RSA Laboratories' Public-Key Cryptography Standards series, and it's widely used for password hashing. Unlike bcryptjs, PBKDF2 can be used not only for password hashing but also for deriving cryptographic keys from passwords.

README

Optimized bcrypt in plain JavaScript with zero dependencies. Compatible to the C++ bcrypt binding and also working in the browser.

Features

• CommonJS compatible (via crypto), also available via npm
• Browser compatible (via WebCryptoAPI)
• AMD compatible
• Zero production dependencies
• Small footprint
• ISAAC PRNG as default fallback with bcrypt-isaac.js
• Compiled with Closure Compiler using advanced optimizations, externs included

Security considerations

Besides incorporating a salt to protect against rainbow table attacks, bcrypt is an adaptive function: over time, the iteration count can be increased to make it slower, so it remains resistant to brute-force search attacks even with increasing computation power. (see)

While bcrypt.js is compatible to the C++ bcrypt binding, it is written in pure JavaScript and thus slower, effectively reducing the number of iterations that can be processed in an equal time span.

Usage

node.js

npm install bcryptjs

var bcrypt = require('bcryptjs');
...

RequireJS/AMD

require.config({
    "paths": {
        "bcrypt": "/path/to/bcrypt.js"
    }
});
require(["bcrypt"], function(bcrypt) {
    ...
});

Shim/browser

<script src="//raw.github.com/dcodeIO/bcrypt.js/master/bcrypt.min.js"></script>

var bcrypt = dcodeIO.bcrypt;
...

Usage - Sync

To hash a password:

var bcrypt = require('bcryptjs');
var salt = bcrypt.genSaltSync(10);
var hash = bcrypt.hashSync("B4c0/\/", salt);
// Store hash in your password DB.

To check a password:

// Load hash from your password DB.
bcrypt.compareSync("B4c0/\/", hash); // true
bcrypt.compareSync("not_bacon", hash); // false

Auto-gen a salt and hash:

var hash = bcrypt.hashSync('bacon', 8);

Usage - Async

To hash a password:

var bcrypt = require('bcryptjs');
bcrypt.genSalt(10, function(err, salt) {
    bcrypt.hash("B4c0/\/", salt, function(err, hash) {
        // Store hash in your password DB.
    });
});

To check a password:

// Load hash from your password DB.
bcrypt.compare("B4c0/\/", hash, function(err, res) {
    // res == true
});
bcrypt.compare("not_bacon", hash, function(err, res) {
    // res = false
});

Auto-gen a salt and hash:

bcrypt.hash('bacon', 8, function(err, hash) {
});

API

setRandomFallback(random)

Sets the random number generator to use as a fallback if neither node's crypto module nor the Web Crypto API is available.

Parameter	Type	Description
random	function(number):!Array.<number>	Function taking the number of bytes to generate as its sole argument, returning the corresponding array of cryptographically secure random byte values.
@see		http://nodejs.org/api/crypto.html
@see		http://www.w3.org/TR/WebCryptoAPI/

genSaltSync(rounds=, seed_length=)

Synchronously generates a salt.

Parameter	Type	Description
rounds	number	Number of rounds to use, defaults to 10 if omitted
seed_length	number	Not supported.
@returns	string	Resulting salt
@throws	Error	If a random fallback is required but not set

genSalt(rounds=, seed_length=, callback)

Asynchronously generates a salt.

Parameter	Type	Description
rounds	number | function(Error, string=)	Number of rounds to use, defaults to 10 if omitted
seed_length	number | function(Error, string=)	Not supported.
callback	function(Error, string=)	Callback receiving the error, if any, and the resulting salt

hashSync(s, salt=)

Synchronously generates a hash for the given string.

Parameter	Type	Description
s	string	String to hash
salt	number | string	Salt length to generate or salt to use, default to 10
@returns	string	Resulting hash

hash(s, salt, callback, progressCallback=)

Asynchronously generates a hash for the given string.

Parameter	Type	Description
s	string	String to hash
salt	number | string	Salt length to generate or salt to use
callback	function(Error, string=)	Callback receiving the error, if any, and the resulting hash
progressCallback	function(number)	Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per MAX_EXECUTION_TIME = 100 ms.

compareSync(s, hash)

Synchronously tests a string against a hash.

Parameter	Type	Description
s	string	String to compare
hash	string	Hash to test against
@returns	boolean	true if matching, otherwise false
@throws	Error	If an argument is illegal

compare(s, hash, callback, progressCallback=)

Asynchronously compares the given data against the given hash.

Parameter	Type	Description
s	string	Data to compare
hash	string	Data to be compared to
callback	function(Error, boolean)	Callback receiving the error, if any, otherwise the result
progressCallback	function(number)	Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per MAX_EXECUTION_TIME = 100 ms.
@throws	Error	If the callback argument is invalid

getRounds(hash)

Gets the number of rounds used to encrypt the specified hash.

Parameter	Type	Description
hash	string	Hash to extract the used number of rounds from
@returns	number	Number of rounds used
@throws	Error	If hash is not a string

getSalt(hash)

Gets the salt portion from a hash. Does not validate the hash.

Parameter	Type	Description
hash	string	Hash to extract the salt from
@returns	string	Extracted salt part
@throws	Error	If hash is not a string or otherwise invalid

Command line

Usage: bcrypt <input> [salt]

If the input has spaces inside, simply surround it with quotes.

Downloads

• Distributions
• ZIP-Archive
• Tarball

Credits

Based on work started by Shane Girish at bcrypt-nodejs (MIT-licensed), which is itself based on javascript-bcrypt (New BSD-licensed).

License

Apache License, Version 2.0 if not stated otherwise