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, zstd, zlib, bz2, lzma)
  • Custom encodings:
    • Base10 (Decimal)
    • Base26 (Latin)
    • Base31 (Cyrillic)
    • Base32 (RFC 4648)
    • Base36 (Latin with numbers)
    • Base64 (RFC 4648)
    • Base94 (ASCII printable)
    • Binary

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.5.0
% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.5.0-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 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
TA2HmPTPbxSXy5o7Kn9ADXreTMMOtdAEkh0JkqfPrSI=

% soda genkey | tee bob | soda pubkey - | tee bob_pub
9NFjEFqBa6uWpy0JuLHdSgaOIvKux9RI4CYF34z0Wik=

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

  Generate Private Key.

Options:
  -s, --key-passphrase TEXT  Private 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
aWsx1GWUyMUuCqhthKQTVn7btZGvlSDXevGBn8nWl21o8TFMBlC3AEcKShCNtMfPGQBcQpMvIewSxfYu

% 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 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. It accepts different profiles: interactive, moderate, and sensitive.

% 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 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
5TH9B DBC9X OOQT2 DTWR7 7RU2A K7ITN 7N11B 2JY8X XGFPT 6UISU YNLQD 12IAW D1LD9
NZNLN 2VYL7 YD657 SE2WR 2NXV7 A9MRE 8FZNM XT2Z6 9OT73 RALD4 J64EC 5S032 WSWML
6ESBX Q78L1 U6I9X UTXTA 6ANS1 K93EG K82MG E4J5Y C8AKH 0QJ6T MVBDQ 27U6B WISAE
8ACNF H0AR4 2AVVP O0GYP 3ZV7T X198W 201EF WILB7 09XWU PHRJE PAE

Environment variables

Common options can be set in the environment variables:

% cat ~/.soda/example.env
SODA_TEXT=0
SODA_KEY_PASSPHRASE="Speed has never killed anyone. Suddenly becoming stationary, that's what gets you."
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 private key is automatically encrypted or decrypted using the same parameters as the following command:

soda encrypt-password <passphrase> <key> --kdf-profile sensitive

This process is slow, and there is limited room for making it faster. RFC 9106 recommends using Argon2id with 2 GiB of memory and 1 pass, while soda uses half that memory (1 GiB) and compensates with 4 passes.

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
    K7M6LD5KFFQD52FKFMC4ZWKI6CSYJ6USG7SDAOOYAJKTYXCH4S7A====
    % soda ga totp_key
    766 042 (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.5.0.tar.gz (14.2 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.5.0-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rtty_soda-0.5.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.5.0.tar.gz
Algorithm Hash digest
SHA256 6377f9abab8c8f73541b60598be07fba4b0b2253e423d4565723142143cd4407
MD5 be1a8f31e437243802e220d220a4f6ad
BLAKE2b-256 19e0d1f213488bf6a5a60fff93d66fc09bb9d581d61461d4de422ce072f01802

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rtty_soda-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c98f73075ce502187c2e7f0b8f56ecb02bc3a78524440461b9a577e33b13853
MD5 ab5234740eaa1fd97d7475fcb8a8e7a4
BLAKE2b-256 5bac101bd486f599bada4d8523056977d4e316a86af0d235bc65163f5008e1bb

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