node-argon2-native

This is a fork of ranisalt/node-argon2 using node 24's crypto.argon2() instead of libargon2.

Differences from node-argon2

• Published as both cjs and mjs.
  • This means you can import argon2 instead of import * as argon2
• Written in typescript instead of javascript with jsdoc.
• Node's argon2 implementation does not expose version so this is not configurable. needsRehash will always return true if a version is specified in the digest.
• options.type is now a string instead of an enum:

hash('password', {
- type: argon2.argon2d
+ type: 'argon2d'
})

Usage

It's possible to hash using either Argon2i, Argon2d or Argon2id (default), and verify if a password matches a hash.

To hash a password:

import argon2 from 'argon2-native'

try {
  const hash = await argon2.hash('password')
} catch (err) {
  //...
}

To see how you can modify the output (hash length, encoding) and parameters (time cost, memory cost and parallelism), read the wiki

To verify a password:

try {
  if (await argon2.verify('<big long hash>', 'password')) {
    // password match
  } else {
    // password did not match
  }
} catch (err) {
  // internal failure
}

Migrating from another hash function

See this article on the wiki for steps on how to migrate your existing code to Argon2. It's easy!

TypeScript usage

A TypeScript type declaration file is published with this module. If you are using TypeScript 2.0.0 or later, that means you do not need to install any additional typings in order to get access to the strongly typed interface. Simply use the library as mentioned above.

import argon2 from 'argon2-native'

const hash = await argon2.hash(...)

Contributors

Code contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

Work licensed under the MIT License.