Nobody's Perfect, Man

    passwordjs

    0.1.1 • Public • Published

    Passwordjs

    forthebadge forthebadge forthebadge

    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

    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

    var pwd = require('passwordjs')
     
    pwd.encrypt('stringToEncrypt', 'sha256').then(hash => {
        console.log(hash)
    }).catch(err => {
        throw err
    })

    Compare Example

        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

    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

        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, Licensed Under MIT 2017.

    Install

    npm i passwordjs

    DownloadsWeekly Downloads

    3

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • dakshmiglani