npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

credential-plus

v2.0.7

Published

Password hashing and verification made easy!

Downloads

266

Readme

Background

Over the past several years, we've seen major breaches exposing numerous usernames and passwords. With every password breach comes the inevitable question: Were the passwords stored securely?

This package aim to provide secure, well configured and ready to use password hashing algorithms for your application.

Install

$ npm install --save credential-plus

Hash functions

This package is build with modularity in mind and supports multiple hash functions. In order to use this package you need to pick at least one of them from this list:

Hash function name | Package to install -------------------|------------------- pbkdf2 | credential-plus-pbkdf2 bcrypt | credential-plus-bcrypt scrypt | credential-plus-scrypt argon2 | credential-plus-argon2

Currently the most vetted hashing algorithm providing most security is BCrypt. PBKDF2 isn't bad either, but if you can use BCrypt you should.

In the next section we will use pbkdf2 for examples, replace it with your choice if differs.

$ npm install --save credential-plus-pbkdf2

Usage

const credential = require('credential-plus');

// Installs the plugin.
credential.install(require('credential-plus-pbkdf2'));

// Hash and verify with default configs.
credential.hash('We are all humans', {func: 'pbkdf2'})
  .then(hash) => {

    console.log(hash);
    //=> '{"hash":"generated hash", "func":"pbkdf2"}'

    credential.verify(hash, 'We are all humans')
      .then(match) => {
        console.log(match);
        //=> true
      });

    credential.verify(hash, 'We are all unicorns')
      .then(match) => {
        console.log(match);
        //=> false
      });

  });

You can find more detailed usage examples in the usage section of each plugin:

Migration

If your not building a new application, possibilities that you have already implemented some hash/verify logic for your passwords are high. This wiki page aim to help you migrating to this package.

API TOC

API

hash(password, options) ⇒ Promise.<string>

Creates a new 'unique' hash from a password.

Kind: global function
Returns: Promise.<string> - A promise that contains a stringified object that holds the generated hash string, the name of the function used to hash it.
Access: public

| Param | Type | Description | | --- | --- | --- | | password | string | The password to hash. | | options | object | Options to configure the hash function. | | options.func | string | The name of the hash function to use. |

Options available are different for each hash function. See the API section of the plugin you choose for more details:

verify(hash, input) ⇒ Promise.<boolean>

Determines whether or not the user's input matches the stored password.

Kind: global function
Returns: Promise.<boolean> - A promise that contains a boolean that is true if if the hash computed for the input matches.
Access: public

| Param | Type | Description | | --- | --- | --- | | hash | string | Stringified hash object generated from this package. | | input | string | User's password input. |

install(hashFunction)

Installs an hash function hashFunction.

Kind: global function
Access: public

| Param | Type | Description | | --- | --- | --- | | hashFunction | object | An hash function compatible with this package. |

list() ⇒ array

Kind: global function
Returns: array - The array of the available hash functions.
Access: public

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.