Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elomagic/spps-npm
Simple Password Protection Solution for Node.js
https://github.com/elomagic/spps-npm
aes aes-256 aes-256-gcm decryption encryption nodejs password secret
Last synced: 10 days ago
JSON representation
Simple Password Protection Solution for Node.js
- Host: GitHub
- URL: https://github.com/elomagic/spps-npm
- Owner: elomagic
- License: apache-2.0
- Created: 2021-02-01T17:16:58.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-09T16:49:35.000Z (almost 4 years ago)
- Last Synced: 2024-11-06T02:42:42.603Z (about 2 months ago)
- Topics: aes, aes-256, aes-256-gcm, decryption, encryption, nodejs, password, secret
- Language: JavaScript
- Homepage:
- Size: 182 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# spps-npm
Simple Password Protection Solution for Node.js
---
[](https://opensource.org/licenses/Apache-2.0)
[](https://travis-ci.com/elomagic/spps-npm)
[](https://coveralls.io/github/elomagic/spps-npm?branch=main)
[](https://github.com/elomagic/spps-npm/issues)
The SPPS is a lightweight solution to protect / hide your password or anything else from your code.
## Features
* AES 256 GCM en-/decryption
* Cross programming languages support ([Java](https://github.com/elomagic/spps-jbc), [Python](https://github.com/elomagic/spps-py), [Node.js](https://github.com/elomagic/spps-npm))
## Concept
This solution helps one to accidentally publish secrets unintentionally by splitting the secret into an encrypted part and a private key.
The private key is kept separately from the rest, in a secure location for the authorized user only.
The private key is randomized for each user on each system and is therefore unique. This means that if someone has the encrypted secret,
they can only read it if they also have the private key. You can check this by trying to decrypt the encrypted secret with another user or another system. You will not succeed.
A symmetrical encryption based on the AES-GCM 256 method is used. See also https://en.wikipedia.org/wiki/Galois/Counter_Mode
The private key is stored in a file ```"/.spps/settings"``` of the user home folder.
Keep in mind that anyone who has access to the user home or relocation folder also has access to the private key !!!!
## Example
``` javascript
const spps = require('spps');
let encryptedSecret = spps.encrypt("My Secret");
console.log("My encrypted secret is " + encryptedSecret);
let secret = spps.decryptString(encryptedSecret)
console.log("...and my secret is " + secret);
```
## How to create a private key
### Create a private in your home folder:
Enter following command in your terminal:
```bash
node ...
```
The settings file ```'~/.spps/settings'``` in your home folder will look like:
```properties
key=5C/Yi6+hbgRwIBhXT9PQGi83EVw2Oe6uttRSl4/kLzc=
relocation=
```
### Alternative, create a private key on a removable device:
Enter following command in your terminal:
```bash
node ...
```
The settings file ```'~/.spps/settings'``` in your home folder will look like:
```properties
key=
relocation=/Volumes/usb-stick
```
...and in the relocation folder look like:
```properties
key=5C/Yi6+hbgRwIBhXT9PQGi83EVw2Oe6uttRSl4/kLzc=
relocation=
```
## How to create an encrypted password
Enter following command in your terminal:
```bash
node ...
```
Output should look like:
```
{MLaFzwpNyKJbJSCg4xY5g70WDAKnOhVe3oaaDAGWtH4KXR4=}
```
##