https://github.com/0xdaksh/passwordjs
A Layer of Abstraction over Encryption Algorithms which allows easy generation of Hashes from Strings and Comparison of Passwords to Hashes.
https://github.com/0xdaksh/passwordjs
base64 bcrypt encryptions hashes javascript md5 node passwords salting salts sha256 sha512
Last synced: 7 months ago
JSON representation
A Layer of Abstraction over Encryption Algorithms which allows easy generation of Hashes from Strings and Comparison of Passwords to Hashes.
- Host: GitHub
- URL: https://github.com/0xdaksh/passwordjs
- Owner: 0xDaksh
- Created: 2017-06-09T11:39:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-19T09:00:53.000Z (almost 7 years ago)
- Last Synced: 2025-01-18T01:26:44.287Z (9 months ago)
- Topics: base64, bcrypt, encryptions, hashes, javascript, md5, node, passwords, salting, salts, sha256, sha512
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/passwordjs
- Size: 18.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Passwordjs
[](https://js.org/)
[](https://github.com/Dakssh/passwordjs)
[](https://www.npmjs.com/package/passwordjs)
#### A Layer of Abstraction over Encryption Algorithms which allows easy generation of Hashes from Strings and Comparison of Passwords to Hashes.
This Module basically contains Multiple Encryption Algorithms which you can then use directly with a single helper Function which Returns a Promise Object that contains either your hash or an error message. The API is pretty simple with just 1 Method that allows easy switching between algorithms and the CLI allows you to encrypt stuff easily often without writing code.
## Supported Algorithms
- Bcrypt
- Sha256
- Sha512
- MD5
## Cli Example
```bash
npm i --global passwordjs
encrypt
| _ \ __ _ ___ _____ _____ _ __ __| | | / ___|
| |_) / _` / __/ __\ \ /\ / / _ \| '__/ _` |_ | \___ \
| __/ (_| \__ \__ \\ V V / (_) | | | (_| | |_| |___) |
|_| \__,_|___/___/ \_/\_/ \___/|_| \__,_|\___/|____/
? Enter The String to Be Encrypted gg
? Choose The Algorithm to encrypt with. bcrypt
$2a$10$GzbDoVx64TCpqwMQDK1dA.x.veGVvZLGKON10zdBW690gpOxDuPwe
```
## Hash Example
```javascript
var pwd = require('passwordjs')
pwd.encrypt('stringToEncrypt', 'sha256').then(hash => {
console.log(hash)
}).catch(err => {
throw err
})
```
## Compare Example
```javascript
var pwd = require('passwordjs')
pwd.compare('gg', 'y9PPubn1G7v78IdZ4kP1s1Gcv27MIZ7pX+fGZ+MsCo0=', 'sha256').then(e => {
console.log(e) // true
}).catch(er => {
console.log(er)
})
```
# API
### Encrypt
The Encrypt Method allows you to easily encrypt the Password with the following parameters as Input
- Password String
- Algorithm
It Returns The Following
- Promise Object
- Hash
- Error
Example
```javascript
var pwd = require('passwordjs')
pwd.encrypt(string, algorithm).then(hash => {
console.log(hash)
}).catch(err => {
throw err // your hash
})
```
### Compare
The Compare Method allows you to easily compare the Password along all algorithms with the following parameters as Input
- Password String
- Hash
- Algorithm
It Returns The Following
- Promise Object
- Response (Boolean)
- Error
Example
```javascript
var pwd = require('passwordjs')
pwd.compare(string, hash, algorithm).then(e => {
console.log(e) // Boolean True / False
}).catch(er => {
console.log(er)
})
```
# License
Copyright [Daksh Miglani](https://dak.sh/), Licensed Under MIT 2017.