# credential-plus-argon2

> Argon2 password hashing function for credential-plus

Latest version **2.0.3** (published 2018-03-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install credential-plus-argon2
pnpm add credential-plus-argon2
yarn add credential-plus-argon2
bun add credential-plus-argon2
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2018-03-05 |
| First published | 2017-08-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 2 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Simone Primarosa |
| Maintainers | simonepri |
| Keywords | credential plus, credential, password, passwords, hashing, verification, hash function, hash, auth, authorization, authentication, security, login, sign in, salt, rainbow, brute, brute force, attack, stretching, timining attack, PBKDF, PBKDF2, bcrypt, scrypt, argon2 |

## Links

- npm: https://www.npmjs.com/package/credential-plus-argon2
- Repository: https://github.com/simonepri/credential-plus-argon2
- Homepage: https://github.com/simonepri/credential-plus-argon2#readme
- Issues: https://github.com/simonepri/credential-plus-argon2/issues
- npm.io page: https://npm.io/package/credential-plus-argon2

## Dependencies (2)

- [argon2](https://npm.io/package/argon2.md) ^0.16.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2018-03-05
- 2.0.1 — 2017-09-05
- 2.0.0 — 2017-09-05
- 1.0.2 — 2017-08-06
- 1.0.1 — 2017-08-05
- 1.0.0 — 2017-08-04

## README

<h1 align="center">
  <a href="https://github.com/simonepri/credential-plus"><img src="https://github.com/simonepri/credential-plus/blob/master/media/credential-plus.png?raw=true" alt="credential-plus-argon2" /></a>
</h1>
<div align="center">
  <a href="https://travis-ci.org/simonepri/credential-plus-argon2"> <img src="https://travis-ci.org/simonepri/credential-plus-argon2.svg?branch=master" alt="build status"></a>
  <a href="https://codecov.io/gh/simonepri/credential-plus-argon2"><img src="https://img.shields.io/codecov/c/github/simonepri/credential-plus-argon2/master.svg" alt="code coverage" /></a>
  <a href="https://github.com/sindresorhus/xo"><img src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg" alt="code style" /></a>
  <a href="https://www.npmjs.com/package/credential-plus-argon2"><img src="https://img.shields.io/npm/v/credential-plus-argon2.svg" alt="npm version" /></a>
  <a href="https://www.npmjs.com/package/credential-plus-argon2"><img src="https://img.shields.io/npm/dm/credential-plus-argon2.svg" alt="npm downloads" /></a>
  <a href="https://david-dm.org/simonepri/credential-plus-argon2"><img src="https://david-dm.org/simonepri/credential-plus-argon2.svg" alt="dependencies" /></a>
  <a href="https://david-dm.org/simonepri/credential-plus-argon2#info=devDependencies"><img src="https://david-dm.org/simonepri/credential-plus-argon2/dev-status.svg" alt="dev dependencies" /></a>
  <a href="LICENSE"><img src="https://img.shields.io/github/license/simonepri/credential-plus-argon2.svg" alt="license" /></a>
</div>
<br />
<div align="center">
  🛡 Argon2 password hashing function for <a href="https://github.com/simonepri/credential-plus">credential-plus</a>.
</div>
<div align="center">
  <sub>
    If you find a security flaw in this code, PLEASE <a href="https://github.com/simonepri/credential-plus-argon2/issues/new">report it</a>.
  </sub>
</div>

<hr/>
<p align="center">
  <strong>DEPRECATED!!! USE <a href="https://github.com/simonepri/upash">upash</a> INSTEAD</strong>
</p>
<hr/>

## Install

```
$ npm install --save credential-plus-argon2
```

## Usage
```js
const credential = require('credential-plus');
credential.install(require('credential-plus-argon2'));

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

    console.log(hash);
    //=> {"hash":"$argon2d$v=19$m=4096,t=3,p=1$i5VhaDYfYqSWWoG1uKVBbw$QHpzhFRYJZwIcogtSciXh0hbc8f91PyGBdtWSNocuiE","func":"argon2"}

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

  });
```

## Authors
* **Simone Primarosa** - [simonepri](https://github.com/simonepri)

See also the list of [contributors](https://github.com/simonepri/credential-plus-argon2/contributors) who participated in this project.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---
_Source: https://npm.io/package/credential-plus-argon2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._