Skip to main content

A PyNaCl frontend with custom encodings, compression, and key derivation

Project description

rtty-soda

A PyNaCl frontend with custom encodings, compression, and key derivation.

Features

  • Public key encryption (Curve25519-XSalsa20-Poly1305)
  • Secret key encryption (XSalsa20-Poly1305)
  • Key derivation (Argon2id-Blake2b)
  • Text compression:
    • brotli (Brotli, best ratio, default)
    • zstd (Zstandard, fast, good ratio)
    • zlib (Deflate, used by gzip)
    • bz2 (Bzip2, used in tar.bz2)
    • lzma (LZMA, good ratio on large data)
    • raw (No compression, improves security)
  • Custom encodings:
    • base10 (Decimal)
    • base26 (Latin)
    • base31 (Cyrillic)
    • base32 (RFC 4648)
    • base36 (Latin with digits)
    • base64 (RFC 4648)
    • base94 (ASCII printable)
    • binary (Raw bytes)

Installation

Package manager

  1. Install uv
  2. Install rtty-soda:
    % uv tool install "rtty-soda[cli]"
    
  3. Remove rtty-soda:
    % uv tool uninstall rtty-soda
    

Docker

% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.7.3
% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.7.3-tools

Getting help

All commands have [-h | --help] option.

% soda
Usage: soda [OPTIONS] COMMAND [ARGS]...

Options:
  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Commands:
  compression            List supported compression libs.
  decrypt-password (dp)  Decrypt message (password).
  decrypt-public (d)     Decrypt message (public).
  decrypt-secret (ds)    Decrypt message (secret).
  encode                 Encode file.
  encodings              List supported encodings.
  encrypt-password (ep)  Encrypt message (password).
  encrypt-public (e)     Encrypt message (public).
  encrypt-secret (es)    Encrypt message (secret).
  genkey                 Generate private/secret key.
  google-auth (ga)       Google Authenticator TOTP.
  kdf                    Key derivation function.
  kdf-profiles           List supported KDF profiles.
  pubkey                 Get public key.

Some commands have aliases, so % soda encrypt-password ... and % soda ep ... are equivalent.

Public key encryption

Key generation

% soda genkey | tee alice | soda pubkey - | tee alice_pub
ygWRMoE336samW9N8/vM2eUX+0Y2AwWGWTJDQdQ3WDQ=

% soda genkey | tee bob | soda pubkey - | tee bob_pub
rLv7pWR5Yh8eymnFXGDsyzcVEI03QPusF0tlsb9GDiY=

% soda genkey -h
Usage: soda genkey [OPTIONS]

  Generate private/secret key.

Options:
  -s, --key-passphrase TEXT  Private/secret key passphrase.
  -e, --encoding ENCODING    See `soda encodings`.  [default: base64]
  -o, --output-file FILE     Write output to file.
  -g, --group-len INTEGER    [default: 0]
  --line-len INTEGER         [default: 80]
  --padding INTEGER          [default: 0]
  -v, --verbose              Show verbose output.
  -h, --help                 Show this message and exit.

Encryption

Alice sends the message to Bob:

% cat message
A telegraph key is a specialized electrical switch used by a trained operator to
transmit text messages in Morse code in a telegraphy system.
The first telegraph key was invented by Alfred Vail, an associate of Samuel Morse.
(c) Wikipedia

% soda encrypt-public alice bob_pub message | tee encrypted | cut -c 1-80
WyPRox/lUIFsGWK2bGq1JaKjLqFfXrHPCr8QIBBhA+1okT5TfOZLCjR9dJgyt17uVoswJfkVRDPuDY2I

% soda encrypt-public -h
Usage: soda encrypt-public [OPTIONS] PRIVATE_KEY_FILE PUBLIC_KEY_FILE
                           MESSAGE_FILE

  Encrypt message (public).

Options:
  -t, --text                     Treat message as text (binary if not
                                 specified).
  -s, --key-passphrase TEXT      Private/secret key passphrase.
  --key-encoding ENCODING        See `soda encodings`.  [default: base64]
  -e, --data-encoding ENCODING   See `soda encodings`.  [default: base64]
  -c, --compression COMPRESSION  See `soda compression`.  [default: brotli]
  -o, --output-file FILE         Write output to file.
  -g, --group-len INTEGER        [default: 0]
  --line-len INTEGER             [default: 80]
  --padding INTEGER              [default: 0]
  -v, --verbose                  Show verbose output.
  -h, --help                     Show this message and exit.

Decryption

% soda decrypt-public bob alice_pub encrypted
A telegraph key is a specialized electrical switch used by a trained operator to
transmit text messages in Morse code in a telegraphy system.
The first telegraph key was invented by Alfred Vail, an associate of Samuel Morse.
(c) Wikipedia

Secret key encryption

Alice and Bob share a key for symmetric encryption:

% soda genkey > shared
% soda encrypt-secret shared message -o encrypted
% soda decrypt-secret shared encrypted -o message

Another day, they share a password:

% echo qwerty | soda encrypt-password - message -p interactive -o encrypted
% echo qwerty | soda decrypt-password - encrypted -p interactive -o message

Key derivation

The KDF function derives the key from the password using Argon2id, a memory-hard algorithm that makes brute-force attacks expensive by requiring large amounts of memory.

It accepts different profiles:

  • interactive (64 MiB, 2 passes)
  • moderate (256 MiB, 3 passes)
  • sensitive (1 GiB, 4 passes)

The top profile uses 1 GiB - half the memory of the RFC 9106 recommendation for practical use. The profiles are defined by libsodium.

The KDF function is deterministic, so identical passwords produce identical keys. No metadata is stored or asked of the user to keep the interface simple. The trade-off is that password strength is critical.

% echo qwerty | soda kdf - -p interactive
HqbvUXflAG+no3YS9njezZ3leyr8IwERAyeNoG2l41U=

% soda kdf -h
Usage: soda kdf [OPTIONS] PASSWORD_FILE

  Key derivation function.

Options:
  -s, --key-passphrase TEXT  Private/secret key passphrase.
  -e, --encoding ENCODING    See `soda encodings`.  [default: base64]
  -p, --profile PROFILE      See `soda kdf-profiles`.  [default: sensitive]
  -o, --output-file FILE     Write output to file.
  -g, --group-len INTEGER    [default: 0]
  --line-len INTEGER         [default: 80]
  --padding INTEGER          [default: 0]
  -v, --verbose              Show verbose output.
  -h, --help                 Show this message and exit.

KDF diagram

Text compression

That works as follows:

  1. The plaintext is prepared:
    • In binary mode (default), the message is read as bytes
    • In text mode (-t, --text), the message is read as a string, stripped, and encoded with SCSU, reducing the size of Unicode messages by 15–50%
  2. The plaintext is compressed with the compression lib
  3. The 16-byte MAC and 24-byte nonce are added
  4. The result is encoded with Base64, which adds ~33% overhead
% soda es shared message -t -v -c brotli > /dev/null
Plaintext: 238
Ciphertext: 216
Overhead: 0.908
Groups: 1
% soda es shared message -t -v -c zstd > /dev/null
Plaintext: 238
Ciphertext: 276
Overhead: 1.160
Groups: 1
% soda es shared message -t -v -c zlib > /dev/null
Plaintext: 238
Ciphertext: 280
Overhead: 1.176
Groups: 1
% soda es shared message -t -v -c bz2 > /dev/null
Plaintext: 238
Ciphertext: 336
Overhead: 1.412
Groups: 1
% soda es shared message -t -v -c lzma > /dev/null
Plaintext: 238
Ciphertext: 320
Overhead: 1.345
Groups: 1
% soda es shared message -t -v -c raw > /dev/null
Plaintext: 238
Ciphertext: 372
Overhead: 1.563
Groups: 1

Encoding

The rtty-soda supports various encodings:

% soda encrypt-public alice bob_pub message --data-encoding base36 --group-len 5 --text
3N9BA PDM4B T4UPA ZR6FY MUXD4 ZL2V6 D8AFH 1LME0 E4DX5 8W9UR PH5TV ZD2DG QW680
JGU17 WRYJJ SK670 96UHH QCFPB 3U2D3 A6MJO VSX6I ABUSG 231CH XHAAY 4Y9H9 VY4QA
9R6V6 SAWVF XFG9N T7LS0 BKZC2 XO1RR WAX9M TVU6E X51GT SO91H 5C7NN EFS9T TOVG7
6AE8S 181LQ 6HUWW 8XX7R NOSQ7 FZE5E WUSF0 0RYD4 YIW97 SD619 SS4

Environment variables

Common options can be set in the environment variables:

% cat ~/.soda/example.env
SODA_TEXT=0
SODA_KEY_PASSPHRASE="He in a few minutes ravished this fair creature, or at least would have ravished her, if she had not, by a timely compliance, prevented him."
SODA_KEY_ENCODING=binary
SODA_DATA_ENCODING=binary
SODA_COMPRESSION=brotli
SODA_KDF_PROFILE=sensitive
SODA_GROUP_LEN=0
SODA_LINE_LEN=0
SODA_PADDING=0
SODA_VERBOSE=0

Private/secret key passphrase

The key can be protected with an additional passphrase, similar to SSH keys. When --key-passphrase <passphrase> is used, the key is automatically encrypted or decrypted using the same parameters as the following command:

% soda encrypt-password <passphrase> <key> --kdf-profile sensitive --data-encoding binary --compression raw

Alternative usage

  • Password source

    % echo "A line from a book or a poem" | soda kdf - -e base94 -p interactive
    x\R9"~8Ujh^_uh:Ty<!t(ZNzK=5w^ukew~#-x!n
    
  • WireGuard keyer

    % echo "A line from a book or a poem" | soda kdf - -p interactive -o privkey
    % cat privkey
    uIoBJdgaz8ZP3/n/9KzdUNvFi7DxbUQdQ9t8ujwGnMk=
    % soda pubkey privkey
    F2B674kXVcTznnRPWCVasx1miCT+yUtXQ3P5Ecee4zI=
    % cat privkey | wg pubkey
    F2B674kXVcTznnRPWCVasx1miCT+yUtXQ3P5Ecee4zI=
    
  • Secure storage

    % echo "A remarkable example of misplaced confidence" > sensitive_data
    % echo "Blessed with opinions, cursed with thought" > data_password
    % soda ep data_password sensitive_data -e binary -p interactive -o encrypted_data
    % echo "Too serious to be wise" > offset_password
    % soda kdf offset_password -e base10 -p interactive -g 10 | head -1
    6174465709 4962164854 2541023297 3274271197 5950333784 2118297875 9632383288
    % sudo dd if=./encrypted_data of=/dev/sdb1 bs=1 seek=6174465709
    75+0 records in
    75+0 records out
    75 bytes transferred in 0.000769 secs (97529 bytes/sec)
    

    dd diagram

  • Google Authenticator keyer

    % soda genkey -e base32 | tee totp_key
    I2SY7OWIQVIFMMJEKWV3PCB6SX3543XRYZBNDBNYPL6RVKREPXRQ====
    % soda google-auth totp_key
    418 543 (expires in 19s)
    

Compatibility

During the initial development (versions prior to 1.0.0), I can break backwards compatibility.

Releases

This project follows a rolling release cycle. Each version bump represents where I completed a full test cycle. When testing passes successfully, I commit and release - so every release is a verified stable point.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rtty_soda-0.7.3.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rtty_soda-0.7.3-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file rtty_soda-0.7.3.tar.gz.

File metadata

  • Download URL: rtty_soda-0.7.3.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for rtty_soda-0.7.3.tar.gz
Algorithm Hash digest
SHA256 2a8c82cb369abeba004856ce769cbd6e2125cddedabd137cf8d1052319613c09
MD5 ecdb02f56ae85e1cd4064dfdc0d790de
BLAKE2b-256 517d1a896b0a757cae38ca8ac244c96211948f3ceed14005a5bd93d6b3e53682

See more details on using hashes here.

File details

Details for the file rtty_soda-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: rtty_soda-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for rtty_soda-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae2b3e066de481a0eab9299d5bf045c0c6e0918256d3b19c2e960ad4178a3a18
MD5 71325b258e87add476b8c009a0595685
BLAKE2b-256 9d345b314fbe594176726345ab7f6057f9177dc003e6d43ac30c7d26f90d1346

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page