scrypt.js

scrypt.js

This purpose of this library is to provide a single interface to both a C and a pure Javascript based scrypt implementation. Supports browserify and will select the best option when running under Node or in the browser.

It is using the following two underlying implementations:

• scryptsy for the pure Javascript implementation
• scrypt for the C version

It only supports hashing. Doesn't offer an async option and doesn't implement the HMAC format. If you are looking for those, please use the Node scrypt library.

API

There is only one method returned for hashing using scrypt. All parameters are mandatory except the progress callback:

• key - The key/passphrase. Although it accepts a String, please use a Buffer to avoid problems later.
• salt - The salt. Same as with the key, please try to use a Buffer.
• n - Iteration count.
• r - Block size for the underlying hash.
• p - Parallelization factor.
• dklen - The derived key length aka. output size.

Example usage

// Load default implementation
var scrypt = require('scrypt.js')

// Load specific version
var scrypt = require('scrypt.js/js') // pure Javascript
var scrypt = require('scrypt.js/node') // C on Node

scrypt(key, salt, n, r, p, dklen, progressCb) // returns Buffer

The progress callback

This callback (progressCb in the above example) is not available on Node.

Every 1000 iterations it will return an object with the following properties:

• current - Current iteration number.
• total - Total iterations.
• percent - Progress in percentage (double).

Other scrypt implementations

• https://www.npmjs.com/package/scrypt: Uses the C implementation (version 1.2.0), both async and async.
• https://www.npmjs.com/package/scrypt-hash: Uses the C implementation and offers only an async option.
• https://www.npmjs.com/package/scryptsy: A pure Javacript implementation. Offers a progress callback.
• https://www.npmjs.com/package/scrypt256-hash: Another C implementation. Doesn't seem to be maintained.
• https://www.npmjs.com/package/scrypt-jane-hash: Uses an alternative C implementation (called scrypt-jane). Doesn't seem to be maintained.
• https://www.npmjs.com/package/js-scrypt-em: Emscripten-compiled scrypt 1.1.6. Doesn't seem to be maintained.
• https://www.npmjs.com/package/js-scrypt: Wraps js-scrypt-em and offers sync and async options. Doesn't seem to be maintained.