Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simonepri/upash-cli

🌌 Hash password directly from your terminal
https://github.com/simonepri/upash-cli

argon2 bcrypt cli hashing nodejs password pbkdf2 scrypt secure unified universal upash

Last synced: 13 days ago
JSON representation

🌌 Hash password directly from your terminal

Awesome Lists containing this project

README

        



upash





Mac/Linux Build Status



Windows Build status



Codecov Coverage report



Known Vulnerabilities



Dependency Status




Mentioned in Awesome NodeJS



XO Code Style used



AVA Test Runner used



Istanbul Test Coverage used



NI Scaffolding System used



NP Release System used




Latest version on npm



Project license



🌌 Hash password directly from your terminal.



Coded with ❤️ by Simone Primarosa.

## Synopsis
upash cli

This package is part of the [upash][upash] project,
which aim is to provide a unified and user-friendly APIs for all the passwords
hashing algorithms out there.

In particular, this package allows you to use multiple password hashing
algorithms through a simple CLI.

Do you believe that this is useful? Has it saved you time? Or maybe you simply like it?
If so, [support my work with a Star ⭐️][start].

## Install
```bash
npm install -g upash-cli
```

## Help
```
Usage
$ upash hash
$ upash verify []

Algorithms available
argon2
scrypt
bcrypt
pbkdf2

Options for argon2 hashing
--variant Variant of argon2 to use.
Can be one of ['d', 'i', 'id'] for
argon2d, argon2i and argon2id respectively.
--iterations Number of iterations to use
--memory Amount of memory to use in kibibytes.
--parallelism Degree of parallelism to use.

Options for scrypt hashing
--blocksize Amount of memory to use in kibibytes.
--cost CPU/memory cost parameter.
--parallelism Degree of parallelism to use.

Options for bcrypt hashing
--rounds Number of iterations to use as as 2^rounds.

Options for pbkdf2 hashing
--iterations Number of iterations to use.
--digest Name of digest to use when applying the key
derivation function.
Can be one of ['sha1', 'sha256', 'sha512'].

Examples
$ upash hash argon2 'Hello World'
$ upash verify pbkdf2 'hash string' 'Hello World'
$ upash hash bcrypt 'Hello World' --rounds=10
```

## Supported password hashing algorithms
- [@phc/argon2][argon2] -
🔒 Node.JS argon2 password hashing algorithm following the PHC string format.
- [@phc/scrypt][scrypt] -
🔒 Node.JS scrypt password hashing algorithm following the PHC string format.
- [@phc/bcrypt][bcrypt] -
🔒 Node.JS bcrypt password hashing algorithm following the PHC string format.
- [@phc/pbkdf2][pbkdf2] -
🔒 Node.JS pbkdf2 password hashing algorithm following the PHC string format.

## Contributing
Contributions are REALLY welcome and if you find a security flaw in this code,
PLEASE [report it][new issue].

## Authors
- **Simone Primarosa** - *Github* ([@simonepri][github:simonepri]) • *Twitter* ([@simoneprimarosa][twitter:simoneprimarosa])

See also the list of [contributors][contributors] who participated in this project.

## License
This project is licensed under the MIT License - see the [license][license] file for details.

[upash]: https://github.com/simonepri/upash

[start]: https://github.com/simonepri/upash-cli#start-of-content
[new issue]: https://github.com/simonepri/upash-cli/issues/new
[contributors]: https://github.com/simonepri/upash-cli/contributors

[license]: https://github.com/simonepri/upash-cli/tree/master/license

[argon2]: https://github.com/simonepri/phc-argon2
[scrypt]: https://github.com/simonepri/phc-scrypt
[bcrypt]: https://github.com/simonepri/phc-bcrypt
[pbkdf2]: https://github.com/simonepri/phc-pbkdf2

[github:simonepri]: https://github.com/simonepri
[twitter:simoneprimarosa]: http://twitter.com/intent/user?screen_name=simoneprimarosa