https://github.com/zozs/filecryptify

Simple file and stream encryption tool based on libsodium
https://github.com/zozs/filecryptify

cryptography libsodium unix

Last synced: about 1 month ago
JSON representation

Simple file and stream encryption tool based on libsodium

• Host: GitHub
• URL: https://github.com/zozs/filecryptify
• Owner: zozs
• License: isc
• Created: 2018-04-29T11:42:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-09T12:34:27.000Z (8 months ago)
• Last Synced: 2024-06-09T13:47:56.260Z (8 months ago)
• Topics: cryptography, libsodium, unix
• Language: C
• Homepage: https://sr.ht/~zozs/filecryptify/
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# filecryptify

Simple application that uses `libsodium` to encrypt files using symmetric encryption.

Uses default `libsodium` algorithms, which is the ChaCha20 stream cipher combined with Poly1305 as MAC.

(To be exact, the XChaCha20-Poly1305 construction from `libsodium` is used.)

## Installation

### Prerequisites

 - libsodium >= 1.0.14

 - BSD make

 - Tested on Linux, FreeBSD, and OpenBSD

### Commands

Run `make` in the directory (on Linux, run `bmake` to use BSD make).

Optionally, run `make install` to install to `/usr/local` (default, can be changed by setting `PREFIX`)

### FreeBSD

Assuming you have a copy of the ports tree in `/usr/ports`

```sh

cd /usr/ports

fetch https://git.sr.ht/~zozs/filecryptify/blob/main/misc/freebsd_port.patch

git am freebsd_port.patch

cd security/filecryptify

make install clean

```

## Usage

`usage: ./filecryptify -G -k keyfile`

Generates a new random symmetric key and stores it in the file `keyfile`.

`usage: ./filecryptify -E -k keyfile [-p plaintextfile] [-c ciphertextfile]`

Encrypts the file `plaintextfile` (or reads from `stdin` if no file is given), using the symmetric key in `keyfile`.

Stores the encrypted ciphertext in `ciphertextfile` (or writes to `stdout` if no file is given).

`usage: ./filecryptify -D -k keyfile [-p plaintextfile] [-c ciphertextfile]`

Decrypts the file `ciphertextfile` (or reads from `stdin` if no file is given), using the symmetric key in `keyfile`.

Stores the decrypted plaintext in `plaintextfile` (or writes to `stdout` if no file is given).

## License

```

Copyright 2018, 2019, Linus Karlsson

Permission to use, copy, modify, and/or distribute this software for any

purpose with or without fee is hereby granted, provided that the above

copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

```