https://github.com/mcollina/pbkdf2-password

Easy salt/password creation for Node.js, extracted from Mosca
https://github.com/mcollina/pbkdf2-password

Last synced: 12 days ago
JSON representation

Easy salt/password creation for Node.js, extracted from Mosca

• Host: GitHub
• URL: https://github.com/mcollina/pbkdf2-password
• Owner: mcollina
• License: mit
• Created: 2015-01-29T11:33:54.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-30T15:53:46.000Z (over 1 year ago)
• Last Synced: 2024-12-15T10:36:59.568Z (25 days ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 24
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pbkdf2-password [![Build Status](https://travis-ci.org/mcollina/pbkdf2-password.svg?branch=master)](https://travis-ci.org/mcollina/pbkdf2-password)

Easy salt/password creation for Node.js, extracted from

[Mosca](http://npm.im/mosca).

Installation

------------

You can install `pbkdf2-password` via npm or yarn.

### Using npm

```bash

npm install pbkdf2-password

```

### Using Yarn

```bash

yarn add pbkdf2-password

```

Usage

-----

```js

var bkfd2Password = require("pbkdf2-password");

var hasher = bkfd2Password();

var assert = require("assert");

var opts = {

  password: "helloworld"

};

hasher(opts, function(err, pass, salt, hash) {

  opts.salt = salt;

  hasher(opts, function(err, pass, salt, hash2) {

    assert.deepEqual(hash2, hash);

    // password mismatch

    opts.password = "aaa";

    hasher(opts, function(err, pass, salt, hash2) {

      assert.notDeepEqual(hash2, hash);

      console.log("OK");

    });

  });

});

```

API

---

* bkfd2Password

* hasher()



### bkfd2Password(options)


Creates a new [hasher](#hasher) functions, with the specified options.

Options:

 * `saltLength`, the length of the random salt

 * `iterations`, number of pbkdf2 iterations

 * `keyLength`, the length of the generated keys

 * `digest`, the digest algorithm, default `'sha1'`



### hasher(opts, function(err, pass, salt, hash))


Hash a password, using a hash and the pbkd2

crypto module.

Options:

 - `password`, the password to hash.

 - `salt`, the salt to use, as a base64 string.

If the `password` is left undefined, a new

10-bytes password will be generated, and converted

to base64.

If the `salt` is left undefined, a new salt is generated.

The callback will be called with the following arguments:

 - the error, if something when wrong.

 - the password.

 - the salt, encoded in base64.

 - the hash, encoded in base64.

License

-------

MIT