argon2-pass

Introduction

SecurePass is a module for the creation of hashes from passwords, allowing you to store passwords securely. The module also provides a facility for the generation and verification of one time use password reset tokens for use in your own password reset flows. This module is a wrapper for libsodium's implementation of the Argon2ID password hashing algorithm.

Features

• Uses the state of the art, secure modern password hashing algorithm Argon2ID.
• Uses Buffer's for safer memory management.
• Allows for generation of one time use password reset tokens to be used in your own password reset flow.
• Easily configurable work factors, allowing you to increase the security of your hashes over time.
• Three default difficulty configurations for password hashing, as defined in libsodium's implementation. Allowing you to configure your security level based on some recommended predefined values.
• Simple rehashing of passwords you are already storing. Allowing you to improve the security of your hashes over time.
• The module is written in typescript and ships with a type definition file by default.

Installation

To install the package you need to use a package manager such as npm or yarn.

yarn add secure-pass
npm install secure-pass

Usage

Coming Soon

Testing

This package is configured with [jest] tests, these tests ensure that the module is working correctly and as specified as well as generating code coverage reports.

yarn test
or
npm test

Acknowledgements

• Special thanks to the creators of libsodium and sodium-native both of which are used extensively in this package, and without which the creation of this module wouldn't have been possible.

Licence

Licensed under MIT.

Copyright (C) 2018 DrBarnabus

Changelog

0.1.0 - 2018-09-06

Added

• Added constants for all recommended, minium, maxium and default configuration values.
• Added get functions for the currently configured memory limit and operations limit.
• Added a custom error class SecurePassOptionsError that is thrown if an error occurs during options validation.
• Added hashPassword() function, the function takes a password in as a buffer and provides the hashed output. The function can work with any of the following return methods; async/await, promise or callback.
• Added VerificationResult enumeration to serve as the response to the hash verification function.
• Added verifyHash() function, the function takes a password and a hash as buffers and provides a VerificationResult as an output. The function can work with any of the following return methods; async/await, promise or callback.

<!-- Links -->