Package Exports
- bcrypt
- bcrypt/bcrypt
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bcrypt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
bcrypt-node
Lib to help you hash passwords.
bcrypt on wikipedia
Catalyst: How To Safely Store A Password
Dependencies
- NodeJS
- OpenSSL
From NPM
npm install bcrypt
From Source
Assuming you've already built node, you can run the waf script:
node-waf configure
node-waf build
npm link
Usage - Sync
To hash a password:
var bcrypt = require('bcrypt');
var salt = bcrypt.gen_salt_sync(10);
var hash = bcrypt.encrypt_sync("B4c0//", salt);
To check a password:
var bcrypt = require('bcrypt');
var salt = bcrypt.gen_salt_sync(10);
var hash = bcrypt.encrypt_sync("B4c0//", salt);
bcrypt.compare_sync("B4c0//", hash); // true
bcrypt.compare_sync("not_bacon", hash); // false
Usage - Async
To hash a password:
var bcrypt = require('bcrypt');
bcrypt.gen_salt(10, function(err, salt) {
bcrypt.encrypt("B4c0//", salt, function(err, hash) {
//something
});
});
To check a password:
var bcrypt = require('bcrypt');
bcrypt.gen_salt(10, function(err, salt) {
bcrypt.encrypt("B4c0//", salt, function(err, hash) {
bcrypt.compare("B4c0//", hash, function(err, res) {
// res == true
});
bcrypt.compare("not_bacon", hash, function(err, res) {
// res = false
});
});
});
API
- BCrypt
- gen_salt_sync(rounds, seed_length)
- rounds - [OPTIONAL] - the number of rounds to process the data for. (default - 10)
- seed_length - [OPTIONAL] - RAND_bytes wants a length. to make that a bit flexible, you can specify a seed_length. (default - 20)
- gen_salt(rounds, seed_length, cb)
- rounds - [OPTIONAL] - the number of rounds to process the data for. (default - 10)
- seed_length - [OPTIONAL] - RAND_bytes wants a length. to make that a bit flexible, you can specify a seed_length. (default - 20)
- cb - [REQUIRED] - a callback to be fired once the salt has been generated. uses eio making it asynchronous.
- encrypt_sync(data, salt)
- data - [REQUIRED] - the data to be encrypted.
- salt - [REQUIRED] - the salt to be used in encryption.
- encrypt(data, salt, cb)
- data - [REQUIRED] - the data to be encrypted.
- salt - [REQUIRED] - the salt to be used in encryption.
- cb - [REQUIRED] - a callback to be fired once the data has been encrypted. uses eio making it asynchronous.
- compare_sync(data, encrypted)
- data - [REQUIRED] - data to compare.
- encrypted - [REQUIRED] - data to be compared to.
- compare(data, encrypted, cb)
- data - [REQUIRED] - data to compare.
- encrypted - [REQUIRED] - data to be compared to.
- cb - [REQUIRED] - a callback to be fired once the data has been compared. uses eio making it asynchronous.
- gen_salt_sync(rounds, seed_length)
Hash Info
The characters that comprise passwords are ./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$.
Testing
I am using nodeunit. I like the way you write tests with it and I like the default output. As such you'll need it to run the tests. I suspect my tests would run on an older version, but these were written and worked against 0.5.1 npm install nodeunit@0.5.1 nodeunit test/
Credits
The code for this comes from a few sources:
- blowfish.cc - OpenBSD
- bcrypt.cc - OpenBSD
- bcrypt::gen_salt - gen_salt inclusion to bcrypt
- bcrypt_node.cc - me
Contributors
License
Unless stated elsewhere, file headers or otherwise, the license as stated in the LICENSE file.