https://github.com/andy-goryachev/dircrypt
Command Line Utility for Encrypting Folders
https://github.com/andy-goryachev/dircrypt
backup cloud-security command-line encrypt-directories encrypted-backup encryption-decryption scrypt xsalsa20
Last synced: 2 months ago
JSON representation
Command Line Utility for Encrypting Folders
- Host: GitHub
- URL: https://github.com/andy-goryachev/dircrypt
- Owner: andy-goryachev
- License: apache-2.0
- Created: 2022-12-03T00:55:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-29T17:07:25.000Z (about 2 years ago)
- Last Synced: 2025-01-18T16:49:33.008Z (4 months ago)
- Topics: backup, cloud-security, command-line, encrypt-directories, encrypted-backup, encryption-decryption, scrypt, xsalsa20
- Language: Java
- Homepage:
- Size: 2.76 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DirCrypt
Command Line Utility for Encrypting Folders.
Uses [scrypt](https://en.wikipedia.org/wiki/Scrypt)
for password-based key derivation function and
[XSalsa20](https://en.wikipedia.org/wiki/Salsa20#XChaCha) cipher.
**Download:** [DirCrypt.jar](https://github.com/andy-goryachev/DirCrypt/raw/main/dist/DirCrypt.jar)
## Encrypt
```
java -jar DirCrypt.jar --enc --out FILE [options] DIR1 DIR2 ...
```
## Decrypt
```
java -jar DirCrypt.jar --dec --in FILE --dest OUTDIR [options]
```
## List Archive Contents
```
java -jar DirCrypt.jar --list --in FILE [options]
```
## Verify Archive Contents
```
java -jar DirCrypt.jar --verify --in FILE [options]
```
## Options
| Option | Argument | Description | Default Value | Required For |
|---|---|---|---|---|
|--dec| |Decrypts archive| |Decryption|
|--dest|Directory|Specifies the destination directory| |Decryption|
|--enc| |Encrypts file(s) or directories| |Encryption|
|--force| |Overwrites output file(s)| |Decryption|
|--help| |Prints usage| | |
|--ignoreErrors| |Ignore integrity errors, decrypt corrupt files| | |
|--in|File|Specifies input archive file name| |Encryption, Listing, Verify|
|--list| |Lists file contents| |Listing|
|--out|File|Specifies output archive file| |Encryption|
|--pass|Text|Passphrase| | |
|--scryptN|Integer|Scrypt N parameter|32768| |
|--scryptP|Integer|Scrypt P parameter|32| |
|--scryptR|Integer|Scrypt R parameter|16| |
|--verbose| |Logs diagnostic messages to stdout| | |
|--verify| |Verifies archive integrity| |Verify|
|--version| |Prints version string| | |
## Security
Please refer to the [File Format Specification](doc/FileFormatSpec.md).
## WARNING
The code has not been formally reviewed. Do not use in production.