1.0.2 • Published 3 years ago
password-hashing-jp v1.0.2
password-hasing
A simple package to hash passwords and verify if the password and the hash match the
Installation
yarns add password-hashing-jp
Usage
import { validatePassword, hashPassword } from "password-hashing-jp"
const { hash, salt } = hashPassword("YOUR PASSWORD")
const isValid = validatePassword("YOUR PASSWORD", salt, hash) // Is the password valid?
Functions
Typedefs
validatePassword(inputPassword, salt, storedHash) ⇒ boolean
Given an input password a salt ans a hash Does the given password match with the hash?
Kind: global function
Returns: boolean - does hash(inputPassword + salt) === storedHash?
Param | Type |
---|---|
inputPassword | string |
salt | string |
storedHash | string |
hashPassword(password) ⇒ HashAndSalt
Given a Password, hash it with salt, then return the hash and the salt
Kind: global function
Returns: HashAndSalt - object containing the hash and the salt
Param | Type |
---|---|
password | string |
HashAndSalt : Object
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
hash | string | The hash we got |
salt | string | The salt used for hashing |