Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erueri/oangou
A content encryptor
https://github.com/erueri/oangou
cli diffie-hellman encryption-decryption ocaml
Last synced: 3 months ago
JSON representation
A content encryptor
- Host: GitHub
- URL: https://github.com/erueri/oangou
- Owner: EruEri
- License: gpl-3.0
- Created: 2024-03-27T21:58:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-11T21:51:51.000Z (6 months ago)
- Last Synced: 2024-09-30T06:40:15.076Z (4 months ago)
- Topics: cli, diffie-hellman, encryption-decryption, ocaml
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Oangou
The code source is now hosted on [Codeberg](https://codeberg.org/EruEri/oangou)
A program to encrypt data, send it over an channel, and decrypt it on the other side.
`oangou` works by using public and private keys and the **Diffie–Hellman** key-exchange protocol.
## Installation
First you will need to install those opam packages.
```sh
$ opam install dune xdg yojson cmdliner ppx_deriving_yojson mirage_crypto_ec
```
By default the prefix install is `/usr/local`. So oangou binary is installed in `/usr/local/bin` and the man pages in `/usr/local/share/man`.
But the `make install` rule reacts to 3 variables:
- `PREFIX`:
- default: `/usr/local`
- `BINDIR`:
- default: `$(PREFIX)/bin`
- `MANDIR`:
- default: `$(PREFIX)/share/man`
```sh
$ git clone https://github.com/EruEri/oangou
$ cd oangou
$ make
$ make install
```
## Initialization
To start with oangou, you first need to initialize it
```
$ oangou init --help
NAME
oangou-init - Initialize oangou
SYNOPSIS
oangou init [--force] [OPTION]…
DESCRIPTION
Initialize oangou by creating XDG_DATA_HOME/oangou/.oangourc file
If oangou has already been initialized, oangou init will raise an
exception unless the --force option is given which will delete the
existing oangou installation
OPTIONS
-f, --force
Force the initialisation
```
## Add
To add a peer to oangou, you need to get it public key. Once you have it, use `oangou-add`
```
$ oangou add --help
NAME
oangou-add - Add peers
SYNOPSIS
oangou add [-k ] [-p ] [-x] [OPTION]…
OPTIONS
-k (absent=stdin)
Associate to
-p (required)
Add to known peers
-x Treat the input key as a hexadecimal string
```
Once a peer is added, a secret is generated by combining your private key with the peer's public key based on the Elliptic curve Diffie–Hellman.
The peer will also need of your public key to decrypt your message.
## Export
To export keys from `oangou` use `oangou export keys` command.
## Encrypt
Once you have the public key targeted peer, you can encrypt a message from stdin or from a file using `oangou encrypt`
```
$ oangou encrypt --help
NAME
oangou-encrypt - Encrypt data
SYNOPSIS
oangou encrypt [OPTION]…
OPTIONS
-i (absent=stdin)
Encrypt a specific file
-o (absent=stdout)
Output the encrypt file to
-p (required)
Encrypt the file for
-x Output as a hexadecimal string
```
## Decrypt
After receiving the receiving the encrypted message or file, you can decrypt it using `oangou decrypt`
```
NAME
oangou-decrypt - Decrypt data
SYNOPSIS
oangou decrypt [OPTION]…
OPTIONS
-i (absent=stdin)
Decrypt a specific file
-o (absent=stdout)
Output the encrypt file to
-p (required)
Decrypt the file for
-x Treat input as a hexadecimal string
```
## Exemple
Alice wants to send the message "Hello bob from alice" to Bob.
This exemple assumes that Alice and Bob know the public key of the other one.
```
# Alice
$ echo "Hello bob from alice" | oangou encrypt -x -p bob
```
```
# Bob
$ echo "" | oangou decrypt -x -p alice
"Hello bob from alice"
```
## Warning
My knownledge on cryptographic is quite limited and don't know if what I do is really that safe or useful so use it at your own risk.