Node Sodium Password Hash

Features

Fast sodium-based crypto for hashing password

• Support both sync and async hash and verify functions.
• Relies on sodium-native to perform crypto.
• Built with TypeScript for static type checking with exported types along the library.

Install

npm install @mgcrea/node-sodium-pwhash sodium-native --save
// -or-
pnpm add @mgcrea/node-sodium-pwhash sodium-native

Quickstart

import { hash, hashToString } from "@mgcrea/node-sodium-pwhash";

const hashed: Buffer = await hash("MyPassword");
// const hashedString: string = await hashToString("MyPassword");

const verify: boolean = await verify(hashed, "MyPassword");

Hash a password

Copy a freshly generated secretKey from the bundled cli:

npx node-sodium-pwhash hash MyPassword

Verify a password

npx node-sodium-pwhash hash MyPassword | npx node-sodium-pwhash verify MyPassword

Authors

• Olivier Louvignes <[email protected]>

License

The MIT License

Copyright (c) 2020 Olivier Louvignes <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.