https://github.com/abumq/encr
🔒 Simple promise based encryption library and CLI using Node.js crypto module
https://github.com/abumq/encr
crypto-cli crypto-js encryption-cli nodejs-crypto
Last synced: 7 months ago
JSON representation
🔒 Simple promise based encryption library and CLI using Node.js crypto module
- Host: GitHub
- URL: https://github.com/abumq/encr
- Owner: abumq
- License: other
- Created: 2020-01-23T05:55:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T01:16:52.000Z (over 2 years ago)
- Last Synced: 2025-07-04T21:23:29.235Z (8 months ago)
- Topics: crypto-cli, crypto-js, encryption-cli, nodejs-crypto
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# encr
Simple promise based encryption wrapper for Node.js and CLI based on crypto module
• • •
• • •
## Installation
```bash
npm i encr -S
```
```bash
yarn add encr
```
## CLI
```bash
## Encrypt
encr -i -o [--force] [--key ] [--alg ]
## Decrypt
encr -d -i -o [--force] [--key ] [--alg ]
## Random generator of length (default = 32)
encr -g
```
### Arguments
| **Arg** | **Description** |
|--|--|
| `-i` | Input file - this can be encrypted or plain data file |
| `-o` | Output file. If this option is `stdout` it is output as string. Do not use this option to store to file as this will corrupt the encoding of buffer |
| `-d` | Use this option to decrypt the input|
| `-g` | Generate nonce|
| `--key` | The secret key to use for encryption. Alternatively you can provide environment variable `ENCR_SECRET`. If none of these options are provided then you will be securely asked for the key |
Optional arguments
| **Arg** | **Description** |
|--|--|
| `--force` | If output file already exists, use this option to overwrite. |
| `--alg` | Encryption algorithm to use. List depends upon OpenSSL (as per Node.js docs) Run `openssl list -cipher-algorithms` to choose the possible option. You must choose 256 bit option for correct key length. **It defaults to AES-256 CBC** |
| `-h` | Display this list of options for convenience |
| `-v` | Display version information |
## API
```
const Encr = require('encr');
const encr = new Encr('MySecret');
const plain = Buffer.from('Hello world');
encr.encrypt(plain).then(encrypted => {
console.log('Encrypted:', encrypted.toString('base64'));
return encr.decrypt(encrypted);
}).then(decrypted => {
console.log('Decrypted:', decrypted.toString());
})
```
## License
```
Copyright (c) 2020 @abumq
https://github.com/abumq/
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```