forked from bbstilson/node-encryption
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.md.unenc
41 lines (26 loc) · 1.18 KB
/
README.md.unenc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
![AES CLI Screenshot](Node-Encryption-CLI-Screenshot.jpg)
# AES CLI
An example of how one might encrypt/decrypt files using node.
Code for this companion article: [Encrypting Files With Node](http://brandonstilson.com/encrypting-files-with-node/).
## :exclamation: Important
This code is adapted from the original. The original repo can be found here: https://github.com/bbstilson/node-encryption
### Changelog
#### Added
- Add Node bin and Shebang to use as CLI tool. - [F1LT3R](https://f1lt3r.io)
- Add linting inputs and vscode settings. - [F1LT3R](https://f1lt3r.io)
- Add password, and password verification input. - [F1LT3R](https://f1lt3r.io)
## Installation
```shell
npm install
```
## Usage
### Encryption
1. From your shell: `aes encrypt test.txt`
2. You will be prompted for a password, and password verification.
3. You will now see `test.txt.enc`. This is the encrypted data.
4. You can delete the original file, if you like.
### Decryption
1. From your shell: `aes decrypt test.txt`
2. You will be prompted for a password, and password verification.
3. You will now see `test.txt.unenc`. This file will be identical to the original.
4. You can rename this file back to `test.txt`.