https://github.com/ryzokuken/easy-crypto
A WIP module aimed at providing a safer, easier to use and beginner friendly crypto API for Node.js
https://github.com/ryzokuken/easy-crypto
crypto easy-to-use nodejs openssl safe wip
Last synced: 6 months ago
JSON representation
A WIP module aimed at providing a safer, easier to use and beginner friendly crypto API for Node.js
- Host: GitHub
- URL: https://github.com/ryzokuken/easy-crypto
- Owner: ryzokuken
- License: mit
- Created: 2019-01-06T05:24:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T17:25:52.000Z (over 2 years ago)
- Last Synced: 2025-03-27T07:47:56.234Z (7 months ago)
- Topics: crypto, easy-to-use, nodejs, openssl, safe, wip
- Language: JavaScript
- Homepage: https://ryzokuken.github.io/easy-crypto/
- Size: 1.42 MB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# easy-crypto
> A WIP module aimed at providing a safer, easier to use and beginner friendly
> crypto API for Node.js
## Goals
1. Make `crypto` **easy** to use.
2. Make `crypto` **safe** to use.
3. Require as little crypto-specific knowledge as possible.
## Features/Roadmap
- [ ] Symmetric Encryption, Decryption and AEAD
- [ ] Asymmetric Encryption and Decryption
- [X] Asymmetric Signing and Verification of signatures
- [X] Cryptographic hashing
- [X] Password-based key derivation
- [X] Password hashing and verification
- [ ] Random number generation
## Installation
```
$ npm install easy-crypto
```
## Usage
Importing the module itself will return `undefined` since the behavior of the
entire module is broken down into a set of intent-based submodules.
```js
const password = require('easy-crypto/password');
const hashedPassword = password.hashPasswordSync('correct horse battery staple');
fs.writeFileSync('myfile', hashedPassword); // Ideally, store it in a database.
```
For an exhaustive list of all submodules and their members, check out the
[API docs](https://ryzokuken.github.io/easy-crypto)
## License
[MIT](LICENSE)
`Copyright (c) 2019 Ujjwal Sharma`
## Notice
This module is currently a work-in-progress. Please do not use it in production
until before the `1.0.0` release since the API may break or might as well be
outright unusable to unsafe.