https://github.com/quantumsheep/warshield

Warshield is a file encryption and decryption CLI using AES 256 algorithm
https://github.com/quantumsheep/warshield

aes-256 aes-256-gcm cli decryption encryption file-encryption protection security sha512

Last synced: 6 months ago
JSON representation

Warshield is a file encryption and decryption CLI using AES 256 algorithm

• Host: GitHub
• URL: https://github.com/quantumsheep/warshield
• Owner: quantumsheep
• License: mit
• Created: 2018-10-15T22:13:54.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-13T14:52:00.000Z (about 2 years ago)
• Last Synced: 2024-10-14T06:10:05.780Z (12 months ago)
• Topics: aes-256, aes-256-gcm, cli, decryption, encryption, file-encryption, protection, security, sha512
• Language: JavaScript
• Homepage:
• Size: 117 KB
• Stars: 34
• Watchers: 5
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Warshield](https://i.imgur.com/hmaHsmi.png)

![license](https://img.shields.io/github/license/quantumsheep/warshield.svg)

[![npm](https://img.shields.io/npm/v/warshield/latest.svg)](https://www.npmjs.com/package/warshield)

[WarShield](https://warshield.qtmsheep.com) is a CLI tool made to encrypt and decrypt your files with a password using AES-256. It was made to ensure a full files protection inside a storage device. If those are lost or stolen, malicious peoples can take over your data.

It uses AES-256 GCM (Galois/Counter Mode) with random 16 bytes initialization vector.

Key is hash in a 256 bits key with SHA-512 using random 64 bytes salt and rounds (between 3000 and 9000 rounds).

# How to install

NodeJS minimal required version is `v10.0.0`.  

To install as a CLI tool, launch `npm install -g warshield`.

# How to use

```

Usage: warshield [options]  

Options:

  -V, --version             output the version number

  -v, --verbose             enable verbosity

  -t, --trace               enable stacktrace

  -p, --tmp      change temporary directory

  -h, --help                output usage information

Commands:

  encrypt [options]   encrypt a file or all files in a directory

  decrypt [options]   decrypt a file or all files in a directory

```