tREADME - cream - Stream encryption utility
 (HTM) git clone git://git.z3bra.org/cream.git
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
       ---
       tREADME (1288B)
       ---
            1 cream
            2 =====
            3 Bring crypto to your stream !
            4 
            5 Encrypt and decrypt streams of data with only a master password.  
            6 The key is derivated from the password + salt combo, and used to encrypt
            7 data byte per byte.
            8 
            9 Features
           10 -----
           11 - No key files involved
           12 - Handle arbitrary chunks of data
           13 - Modern algorithms ([XChaCha20-Poly1305][0] + [Argon2id][1])
           14 - Decryption parameters discovery
           15 
           16 Usage
           17 -----
           18 Refer to cream(1) manual page for details and examples.
           19 The below commands are provided as a quick introduction.
           20 
           21 Send an encrypted file over the network
           22 
           23         # Sender side, send encrypted data to remote.lan
           24         cream -e < file.jpg | nc remote.lan 1337
           25 
           26         # Receiver side, receive data on port 1337
           27         nc -l 1337 | cream -d > file.jpg
           28 
           29 Format
           30 ------
           31 For convenience, encryption parameters are included at the beginning of
           32 the stream. This header can be parsed using the file(1) command:
           33 
           34         % file -m cream.magic cipher.cream
           35         cipher.cream: CREAM encrypted data, version 16,
           36                 xchachapoly1305 bs=4096, argon2id m=65536 t=3 p=4
           37 
           38 The header format and magic pattern are detailed in cream(5) manual page.
           39 
           40 Installation
           41 -----
           42 Edit config.mk as needed, then build/install with the following commands:
           43 
           44         make
           45         make install
           46 
           47 [0]: https://en.wikipedia.org/wiki/ChaCha20-Poly1305
           48 [1]: https://en.wikipedia.org/wiki/Argon2