Standalone-OceanKeyak

An cross-platform file encryption tool with AE scheme extracted from XKCP(eXtended Keccak Code Package)

• Keyak, the authenticated encryption schemes River, Lake, Sea, Ocean and Lunar Keyak.This repo only extracts the OceanKeyak

Dependencies

CMake

Keyak requires CMake 3.10.0 or newer in order to take advantage of improved support. If you're using Ubuntu 18.04 or newer you should already have a suitable version. If you're using an older distribution (e.g. 16.04) you will need to install a compatible version of CMake yourself.

libsodium

Also, Keyak utilizes the libsodium api to generate unpredictable data, suitable for creating secret keys, so you should install libsodium into your system path if you are using linux distribution, or if you are using windows, you can type the following commad to set the sodium_DIR environment variable to point at the directory of pre-built libsodium from official website.

set sodium_DIR path_to_pre-built_lib

To install libsodium on Linux:

sudo apt install libsodium-dev

Build

Clone the code and change into the source code directory

git clone https://github.com/qnfm/Standalone-OceanKeyak && cd Standalone-OceanKeyak

If you have downloaded the ninja_build binary on Windows, the build command is:

cmake "-DCMAKE_MAKE_PROGRAM=C:/path_to_ninja/ninja.exe" -G Ninja -S . -B build

Or run build without ninja:

cmake -S . -B build

Final step: link the program:

cmake --build build --target Keyak -j 8

The binary is located in the build/ directory

Usage

To encrypt, you simply need to provide the path to the filename, remember to keep the generated two files (one with .key surfix is the secret key and the other with .Keyak surfix is the encrypted file) safely and secretly. If you lose these two file , the original file will be lost forever!

Keyak file_to_be_encrypted

To decrypt, put the two output files at the same directory and simply call:

Keyak path_to_key.key path_to_ciphertext.Keyak