@amigo-labs/argon2

Fast Argon2id password hashing powered by Rust via NAPI-RS. A native Node.js binding to the argon2 crate.

Installation

npm install @amigo-labs/argon2

Usage

import { hash, verify } from "@amigo-labs/argon2";

// Hash a password (async)
const hashed = await hash("my-password");

// Verify a password (async)
const valid = await verify(hashed, "my-password"); // true

// With custom options
const hashed2 = await hash("my-password", {
  memoryCost: 65536,
  timeCost: 3,
  parallelism: 4,
});

Synchronous variants hashSync and verifySync are also available.

API

hash(password, options?): Promise<string>

Hashes a password using Argon2id and returns a PHC-formatted string.

hashSync(password, options?): string

Synchronous version of hash.

verify(hash, password): Promise<boolean>

Verifies a password against an Argon2id hash.

verifySync(hash, password): boolean

Synchronous version of verify.

Options

| Option | Type | Description | | --- | --- | --- | | memoryCost | number | Memory size in KiB (default: 19456) | | timeCost | number | Number of iterations (default: 2) | | parallelism | number | Degree of parallelism (default: 1) | | outputLen | number | Length of the hash output in bytes |

Supported Platforms

| Platform | Architecture | | --- | --- | | Linux | x64 (glibc), x64 (musl), arm64 | | macOS | x64, arm64 | | Windows | x64 |

License

MIT