Compare performance to native bcrypt, fixes #14

Author: dcodeIO

.gitignore

@@ -2,4 +2,3 @@ node_modules/
 npm-debug.log
 .idea/
 doco/
-tests/bench.js

README.md

@@ -1,59 +1,61 @@
-![bcrypt.js - bcrypt in plain JavaScript](https://raw.github.com/dcodeIO/bcrypt.js/master/bcrypt.png)
+![bcrypt.js - Optimized bcrypt in JavaScript with zero dependencies](https://raw.github.com/dcodeIO/bcrypt.js/master/bcrypt.png)
 ===========
-Optimized bcrypt in plain JavaScript with zero dependencies. Compatible to the C++ [bcrypt](https://npmjs.org/package/bcrypt)
-binding and also working in the browser.
-
-Features ![Build Status](https://travis-ci.org/dcodeIO/bcrypt.js.png?branch=master)
---------
-* CommonJS compatible (via [crypto](http://nodejs.org/api/crypto.html)), also available via [npm](https://npmjs.org/package/bcryptjs) 
-* Browser compatible (via [WebCryptoAPI](http://www.w3.org/TR/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](https://github.com/dcodeIO/bcrypt.js/blob/master/externs/bcrypt.js)
+Optimized bcrypt in JavaScript with zero dependencies. Compatible to the C++ [bcrypt](https://npmjs.org/package/bcrypt)
+binding on node.js and also working in the browser.
+
+[![Build Status](https://travis-ci.org/dcodeIO/bcrypt.js.svg?branch=master)](https://travis-ci.org/dcodeIO/bcrypt.js)
+[![Donate](https://raw.githubusercontent.com/dcodeIO/bcrypt.js/master/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=info%40code-emitter.com&item_name=Open%20Source%3A%20bcrypt.js)
 
 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](http://en.wikipedia.org/wiki/Bcrypt))
 
-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.
+While bcrypt.js is compatible to the C++ bcrypt binding, it is written in pure JavaScript and thus slower ([about 2.7
+times](https://github.com/dcodeIO/bcrypt.js/wiki/Benchmark)), effectively reducing the number of iterations that can be
+processed in an equal time span.
 
 Usage
 -----
+The library is compatible with CommonJS and AMD loaders and is exposed globally as `dcodeIO.bcrypt` if neither is
+available.
+
+### node.js
+
+On node.js, the inbuilt [crypto module](http://nodejs.org/api/crypto.html)'s randomBytes interface is used to obtain
+secure random numbers.
 
-#### node.js
 `npm install bcryptjs`
 
-```javascript
+```js
 var bcrypt = require('bcryptjs');
 ...
 ```
 
-#### RequireJS/AMD
-```javascript
+### Browser
+
+In the browser, bcrypt.js by default relies on [Web Crypto API](http://www.w3.org/TR/WebCryptoAPI)'s getRandomValues
+interface to obtain secure random numbers. bcrypt-isaac.js additionally ships with the ISAACs PRNG used as the default
+fallback if the former is not available. See [bcrypt.setRandomFallback](https://github.com/dcodeIO/bcrypt.js#setrandomfallbackrandom)
+to set a custom fallback.
+
+```js
+var bcrypt = dcodeIO.bcrypt;
+...
+```
+
+or
+
+```js
 require.config({
-    "paths": {
-        "bcrypt": "/path/to/bcrypt.js"
-    }
+    paths: { "bcrypt": "/path/to/bcrypt.js" }
 });
 require(["bcrypt"], function(bcrypt) {
     ...
 });
 ```
 
-#### Shim/browser
-```html
-<script src="//raw.github.com/dcodeIO/bcrypt.js/master/bcrypt.min.js"></script>
-```
-```javascript
-var bcrypt = dcodeIO.bcrypt;
-...
-```
-
 Usage - Sync
 ------------
 To hash a password: 
@@ -229,4 +231,4 @@ which is itself based on [javascript-bcrypt](http://code.google.com/p/javascript
 
 License
 -------
-Apache License, Version 2.0 if not stated otherwise
+New-BSD / MIT ([see](https://github.com/dcodeIO/bcrypt.js/blob/master/LICENSE))

dist/bcrypt-isaac.js

@@ -1018,7 +1018,7 @@
             if (progressCallback)
                 progressCallback(i/rounds);
             if (i < rounds) {
-                var start = new Date();
+                var start = Date.now();
                 for (; i < rounds;) {
                     i = i + 1;
                     _key(b, P, S);

dist/bcrypt-isaac.min.js

@@ -1014,7 +1014,7 @@
             if (progressCallback)
                 progressCallback(i/rounds);
             if (i < rounds) {
-                var start = new Date();
+                var start = Date.now();
                 for (; i < rounds;) {
                     i = i + 1;
                     _key(b, P, S);

dist/bcrypt.js

@@ -421,7 +421,7 @@ function _crypt(b, salt, rounds, callback, progressCallback) {
         if (progressCallback)
             progressCallback(i/rounds);
         if (i < rounds) {
-            var start = new Date();
+            var start = Date.now();
             for (; i < rounds;) {
                 i = i + 1;
                 _key(b, P, S);

dist/bcrypt.min.js

@@ -0,0 +1,42 @@
+var bcrypt = require("bcrypt"),
+    bcryptjs = require("../index.js"),
+    pass = "ä☺𠜎️☁",
+    testRounds = [8, 9, 10, 11, 12, 13, 14, 15];
+
+function testSync(name, salt, impl) {
+    var res;
+    console.time(name);
+    res = impl.hashSync(pass, salt);
+    console.timeEnd(name);
+    console.log("`"+res+"`  ");
+}
+
+function testAsync(name, salt, impl, cb) {
+    console.time(name);
+    impl.hash(pass, salt, function(err, res) {
+        console.timeEnd(name);
+        console.log("`"+res+"`  ");
+        if (cb) cb();
+    });
+}
+
+console.log("## Comparing bcryptjs with bcrypt\n");
+
+function next() {
+    if (testRounds.length === 0)
+        return;
+    (function(rounds) {
+        var salt = bcryptjs.genSaltSync(rounds);
+        console.log("#### Using "+rounds+" rounds");
+        console.log("Salt: `"+salt+"`  ");
+        testSync("* **bcrypt** sync", salt, bcrypt);
+        testSync("* **bcrypt.js** sync", salt, bcryptjs);
+        testAsync("* **bcrypt** async", salt, bcrypt, function() {
+            testAsync("* **bcrypt.js** async", salt, bcryptjs, function() {
+                console.log("");
+                next();
+            });
+        });
+    })(testRounds.shift());
+}
+next();