rtty-soda 0.3.2__py3-none-any.whl

rtty_soda/services/key_service.py

@@ -0,0 +1,43 @@
+from typing import TYPE_CHECKING
+
+from nacl.public import PrivateKey
+
+from rtty_soda.cryptography import kdf
+from rtty_soda.encoders import ENCODERS, encode_str
+
+from .service import Service
+
+if TYPE_CHECKING:
+    from rtty_soda.formatters import Formatter
+    from rtty_soda.interfaces import Reader, Writer
+
+__all__ = ["KeyService"]
+
+
+class KeyService(Service):
+    def __init__(
+        self, encoding: str, formatter: Formatter, writer: Writer, verbose: bool
+    ) -> None:
+        super().__init__(formatter, writer, verbose)
+        self.encoder = ENCODERS.get(encoding)
+
+    def genkey(self) -> None:
+        key = bytes(PrivateKey.generate())
+        self.write_output(key, self.encoder)
+
+    def pubkey(self, priv_key: Reader) -> None:
+        priv_seed = self.read_input(priv_key, self.encoder)
+        priv = PrivateKey(private_key=priv_seed)
+        pub = bytes(priv.public_key)
+        self.write_output(pub, self.encoder)
+
+    @staticmethod
+    def derive_key(password: Reader, kdf_profile: str) -> bytes:
+        prof = kdf.KDF_PROFILES[kdf_profile]
+        pw_str = password.read_str().strip()
+        pw = encode_str(pw_str)
+        return kdf.kdf(password=pw, profile=prof)
+
+    def kdf(self, password: Reader, kdf_profile: str) -> None:
+        key = self.derive_key(password, kdf_profile)
+        self.write_output(key, self.encoder)

rtty_soda/services/service.py

@@ -0,0 +1,52 @@
+from typing import TYPE_CHECKING, NamedTuple
+
+from rtty_soda.encoders import Encoder, encode_str
+from rtty_soda.formatters import remove_whitespace
+
+if TYPE_CHECKING:
+    from rtty_soda.formatters import Formatter
+    from rtty_soda.interfaces import Reader, Writer
+
+__all__ = ["FormattedOutput", "Service"]
+
+
+class FormattedOutput(NamedTuple):
+    data: bytes
+    chars: int
+    groups: int
+
+
+class Service:
+    def __init__(
+        self, formatter: Formatter | None, writer: Writer, verbose: bool
+    ) -> None:
+        self.formatter = formatter
+        self.writer = writer
+        self.verbose = verbose
+
+    @staticmethod
+    def read_input(source: Reader, encoder: Encoder | None) -> bytes:
+        if encoder is None:
+            return source.read_bytes()
+
+        data = source.read_str()
+        data = remove_whitespace(data)
+        return encoder.decode(data)
+
+    def format_data(self, data: bytes, encoder: Encoder | None) -> FormattedOutput:
+        chars = 0
+        groups = 0
+        if encoder is not None and self.formatter is not None:
+            data_str = encoder.encode(data)
+            chars = len(data_str)
+            data_str, groups = self.formatter.format(data_str)
+            data = encode_str(data_str)
+
+        return FormattedOutput(data, chars, groups)
+
+    def write_output(self, data: bytes, encoder: Encoder | None) -> None:
+        buff = self.format_data(data, encoder)
+        self.writer.write_bytes(buff.data)
+        if self.verbose:
+            self.writer.write_diag(f"Length: {buff.chars}")
+            self.writer.write_diag(f"Groups: {buff.groups}")

rtty_soda-0.3.2.dist-info/METADATA

@@ -0,0 +1,362 @@
+Metadata-Version: 2.3
+Name: rtty-soda
+Version: 0.3.2
+Summary: A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl
+Keywords: cli,encryption,libsodium,nacl,rtty
+Author: Theo Saveliev
+Author-email: Theo Saveliev <89431871+theosaveliev@users.noreply.github.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: POSIX
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Utilities
+Requires-Dist: pynacl>=1.6.0,<2.0.0
+Requires-Dist: scsu>=1.1.1,<2.0.0
+Requires-Dist: click>=8.3.0,<9.0.0 ; extra == 'cli'
+Requires-Dist: click-aliases>=1.0.5,<2.0.0 ; extra == 'cli'
+Requires-Python: >=3.14, <4.0
+Project-URL: github, https://github.com/theosaveliev/rtty-soda
+Project-URL: issues, https://github.com/theosaveliev/rtty-soda/issues
+Provides-Extra: cli
+Description-Content-Type: text/markdown
+
+# rtty-soda
+
+A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl.
+
+
+#### Features
+
+- Public Key encryption (Curve25519-XSalsa20-Poly1305)
+- Secret Key encryption (XSalsa20-Poly1305)
+- Key derivation (Argon2id-Blake2b)
+- Text compression (zstd, zlib, bz2, lzma)
+- Custom encodings:
+  - Base26 (Latin)
+  - Base31 (Cyrillic)
+  - Base36 (Latin with numbers)
+  - Base64 (RFC 4648)
+  - Base94 (ASCII printable)
+  - Binary
+
+
+## Installation
+#### Package manager
+
+1. [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
+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.3.2
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.3.2-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:
+  decrypt-password (dp)  Decrypt Message (Password).
+  decrypt-public (d)     Decrypt Message (Public).
+  decrypt-secret (ds)    Decrypt Message (Secret).
+  encode                 Encode File.
+  encrypt-password (ep)  Encrypt Message (Password).
+  encrypt-public (e)     Encrypt Message (Public).
+  encrypt-secret (es)    Encrypt Message (Secret).
+  genkey                 Generate Private Key.
+  kdf                    Key Derivation Function.
+  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
+R5xUCEhvkRRwQD+iWo2hV65fIsWucUZtiFJGKy6pTyA=
+
+% soda genkey | tee bob | soda pubkey - | tee bob_pub
+woNtqALnGLzp8VBuzJ8T13E4OZRv5YZy6kXMBpV8/mI=
+
+% soda genkey -h
+Usage: soda genkey [OPTIONS]
+
+  Generate Private Key.
+
+  Encoding: base26 | base31 | base36 | base64 | base94 | binary
+
+Options:
+  -e, --encoding TEXT     [default: base64]
+  -o, --output-file FILE  Write output to file.
+  --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 --group-len 79 | tee encrypted
+q+zCgyCfHdlSHrcuyM/Yfw1+ZvqNRXgY0O7gGrauPyQlsI0MdPXoVlkfyKZUtg6Jcqn47d4BGLMBITo
+y3Wp9+9FvI1rolCd7JmyIxRIHHYWqxux+czh88aDdGjbDQ2pRNX68TU33PylBDw/H+VfYSZ6fyw1xdJ
+005pJeEXCzpOXljvXMgAElBIFJ/vsluunrRI9Sw6WcnrCsPYFxTFRZVOvsq6U8PJwnhnaDyLW0Z28Op
+dS71gNH/7xA7P1LbFwxSD0jAjDqPZdLYkPzd94=
+
+% soda encrypt-public -h
+Usage: soda encrypt-public [OPTIONS] PRIVATE_KEY_FILE PUBLIC_KEY_FILE
+                           MESSAGE_FILE
+
+  Encrypt Message (Public).
+
+  Encoding: base26 | base31 | base36 | base64 | base94 | binary
+
+  Compression: zstd | zlib | bz2 | lzma | raw
+
+Options:
+  -t, --text                Treat message as text (binary if not specified).
+  --key-encoding TEXT       [default: base64]
+  -e, --data-encoding TEXT  [default: base64]
+  -c, --compression TEXT    [default: zstd]
+  -o, --output-file FILE    Write output to file.
+  --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 --profile interactive -
+HqbvUXflAG+no3YS9njezZ3leyr8IwERAyeNoG2l41U=
+
+% soda kdf -h
+Usage: soda kdf [OPTIONS] PASSWORD_FILE
+
+  Key Derivation Function.
+
+  Encoding: base26 | base31 | base36 | base64 | base94 | binary
+
+  Profile: interactive | moderate | sensitive
+
+Options:
+  -e, --encoding TEXT     [default: base64]
+  -p, --profile TEXT      [default: sensitive]
+  -o, --output-file FILE  Write output to file.
+  --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.
+```
+
+
+## Text compression
+
+That works as follows:
+1. The plaintext is compressed with the compression lib
+2. The 16-byte MAC and 24-byte nonce are added
+3. The result is encoded with Base64, which adds ~25% overhead
+
+```
+% soda es shared message -c zstd -v > /dev/null
+Groups: 0
+Plaintext: 239
+Ciphertext: 276
+Overhead: 1.155
+% soda es shared message -c zlib -v > /dev/null
+Groups: 0
+Plaintext: 239
+Ciphertext: 280
+Overhead: 1.172
+% soda es shared message -c bz2 -v > /dev/null
+Groups: 0
+Plaintext: 239
+Ciphertext: 340
+Overhead: 1.423
+% soda es shared message -c lzma -v > /dev/null
+Groups: 0
+Plaintext: 239
+Ciphertext: 324
+Overhead: 1.356
+% soda es shared message -c raw -v > /dev/null
+Groups: 0
+Plaintext: 239
+Ciphertext: 372
+Overhead: 1.556
+```
+
+When working with Unicode messages, enabling SCSU encoding can save
+up to 15-50% of space. To achieve this, pass the `--text` flag to both
+encryption and decryption commands. This instructs rtty-soda to 
+read the message as text, applying SCSU automatically.
+
+
+## Encoding
+
+The rtty-soda supports various encodings:
+
+```
+% soda encrypt-public alice bob_pub message --data-encoding base36 --group-len 5
+9URCN ARRN8 MSE7G G9980 37D8S 568QP 16AZW TOHAI KYP5W VAK7R VZ6YO GZ38A QOIP7
+60P2E GWWOG DSHDD EG2TZ 7PSZM 7FKBX 50TAD RHS2E VM063 N297Y 753BP TLUX0 9K8BD
+DZF8O 7TPUG MJV4R T2C92 HU1G8 KGJCN URU1F 9COP9 EFLZO BSL2V 171DS 2HKPE JY2GY
+V86IT T0HBR 9B08H M9R2V IEM7A R91IF UWQYM ZV4JN 7YU3K ILPJY E8OMA NWQC5 Q6BG7
+PXM4I 9UU9E J9IRU HSZ41 RPZQG XTDC6 E5NMS B4HBQ 7QRI2 RRUYH HSHGQ 7USN
+```
+
+
+## Environment variables
+
+Common options can be set in the environment variables:
+
+```
+% cat ~/.soda/ru.env
+TEXT=1
+KEY_ENCODING=base31
+DATA_ENCODING=base31
+COMPRESSION=zlib
+KDF_PROFILE=sensitive
+GROUP_LEN=5
+LINE_LEN=69
+PADDING=0
+VERBOSE=0
+```
+
+
+## Tutorial for the Underground Moscow Museum
+
+```
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.3.2-tools
+% set -a
+% source ~/.soda/ru.env
+
+% soda genkey | tee 173-закрытый | soda pubkey - | tee 173-публичный
+ЖАЯГЭ ШЦДФР ТЮУОЮ ШМЕВР НЬИЛР ИЫФЧД БФГЫП КЮДЫЛ ОРЫКВ СБХЕЫ СУ
+% soda genkey | tee 305-закрытый | soda pubkey - | tee 305-публичный
+ЙОАРЫ РОЮЩЯ ШВМПФ ЛТЬТЕ ЫПКУС ДЧББЮ ЦХКХА РЖЯМС ХНТИУ ФЙСКВ ЙЛ
+
+% cat телеграмма
+Телетайп — стартстопный приёмно-передающий телеграфный аппарат с клавиатурой
+как у пищущей машинки, применявшийся также в качестве терминала устройств
+вычислительной техники.
+Наиболее совершенные телетайпы являются полностью электронными устройствами
+и используют дисплей вместо принтера.
+(c) Wikipedia
+
+% soda e 173-закрытый 305-публичный телеграмма -v
+КЭСМЗ ЛЖЧЧЮ ЧЛФРД ЩЦЛЮМ ГКЗФР ИРФНЗ ЧКАЗЛ РОМЩЮ БХМПФ ЧРТПМ ЙРЧМВ
+ЦТСМГ ХЛЯЯП УНИИХ УДЗГН ЙЧЭЙЕ ЛМХСШ ВЭЯКШ ЫРЯЯХ ШЖЫОЯ ХГТПЖ ШКСЛЛ
+ЖДЗЮИ ВФЭВЧ ЖГКЩШ ТЧТАД ЖАЭГР ДТЙЬЬ ЧАПБТ ЮРЬТА ЫШЦКБ ЗЛГГС ЙЮСЧБ
+АЙАЯФ ЦХРЯМ ЧТЮУТ ЭЕЙРШ УТКЛЯ УЫЧКЬ ЖСФЬЯ ЗХПЙС СЯМЗВ АЗСФЭ РФЦНХ
+ЖИТЗЕ ХЦГЛЗ ЗЭМЗК ОЯЦГЦ ВМОНР ЬЫДРВ ХПЭЭТ ИАШЯК ХРЮБС ЬЭВТМ ЛПФЦВ
+ЙЙИЖГ ЦЯАЩЦ ОЙФЯК ЕОЭЯЗ ЧЕПЖЗ КЕВЩИ ХОПЛХ ЖХЖЛМ ШАТЬФ ТШФЖУ ЩРСЛТ
+НРПСК ЯЮХЬЭ МВХХЭ ИИЗЙВ ВЯФДЬ УЗЫФИ ЛГХЩЬ СЯЛХА ХЭТАГ ВАЩЛГ ЖЦФБЕ
+ЖОБЮЗ ЛФЩЙЛ ОЩЦПЧ ЗЖИЙЭ ЫРШЭТ ОЯВРФ ХНКВС ЩЬХЭМ ЙЛЧТС ММЭДО ШЬНКР
+ВФСТ
+Groups: 89
+Plaintext: 302
+Ciphertext: 444
+Overhead: 1.470
+```
+
+
+## Alternative usage
+
+- Password source
+  ```
+  % echo 'A line from a book or a poem' | soda kdf - -e base94           
+  wN/K.@3Q#]Czn4kk3(negX=R|*xvvPQmk'XW$-s
+  ```
+
+- WireGuard keyer
+  ```
+  % echo 'A line from a book or a poem' | soda kdf - -o privkey
+  % cat privkey 
+  thyA4dlQgg93+rQj/evBbBymw82GTwQCh3RJ0I6GOsY=
+  % soda pubkey privkey 
+  ruIUMqbUtyqRVSIBLSGI7AOruE2DLWgTe9o+h7Yktkw=
+  % cat privkey | wg pubkey 
+  ruIUMqbUtyqRVSIBLSGI7AOruE2DLWgTe9o+h7Yktkw=
+  ```
+
+
+## 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.

rtty_soda-0.3.2.dist-info/RECORD

@@ -0,0 +1,34 @@
+rtty_soda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rtty_soda/archivers.py,sha256=HvruHvxtHeMeB1-kTBCFrA92NohIJSOTNQ4NdFWZOcM,1259
+rtty_soda/cli/__init__.py,sha256=hhemjt3-8eF3JXQ12HYTB_nL41TXTrMAdsMRYxarPOc,185
+rtty_soda/cli/cli_options.py,sha256=HiBLgJg0PbJV-Y8EiI_zDDg_Co_9P2kCs8OLlt-ta9A,3002
+rtty_soda/cli/cli_reader.py,sha256=iCcvWR2InWJ38gSgVXhM42zYYhypMMGterunYxyotqg,624
+rtty_soda/cli/cli_writer.py,sha256=tXAlE9-jzYj4pT-6QuegARg9a1TXnUqO5Zlzun0Kf-g,1155
+rtty_soda/cli/main.py,sha256=JxUrHafMPJ5vWyacodcvCha6lgrIGm6vkH9blA1HBRw,11028
+rtty_soda/cli/main.pyi,sha256=A8ytzT0AX9a-ARjUYrVIEeSusaKSdtRpm_QhdP2V0wg,2299
+rtty_soda/cryptography/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rtty_soda/cryptography/kdf.py,sha256=HymfTiK7BD7lhZu0OdtFW_i-v0r7e8XedT8_Q84ClJc,1529
+rtty_soda/cryptography/public.py,sha256=6gwsT4ilaMDHwtdYPOEYlX8IfwHPew8lMIbxRva1mLs,612
+rtty_soda/cryptography/secret.py,sha256=N5ytktC2oxYfTFew0utytEClWK2rMvcnxlqeppR7wDQ,529
+rtty_soda/encoders/__init__.py,sha256=SFKsywPyFURgwI9mQhC3cH8VE6sD2Wwm4ZK1mfoR-q0,748
+rtty_soda/encoders/base26_encoder.py,sha256=IJXYPtbx9YIhUJuIcT9U1FqtFb-NHc4SeinCq2XDQxM,403
+rtty_soda/encoders/base31_encoder.py,sha256=Xyfam773ouuXOeRfUCj4fUMmB2tzhrKVD0Phg_YbVxc,430
+rtty_soda/encoders/base36_encoder.py,sha256=nFchzvFmSNiqIZ0_HYJZzkSZNNfhiWRSQzYkZWOWrNE,419
+rtty_soda/encoders/base64_encoder.py,sha256=DzZkBxx3Lr9gr_jHEcNpGWaTyGDEntrrneaOCG6GT1I,364
+rtty_soda/encoders/base94_encoder.py,sha256=9sRGWVGB8No0hn3cig4k5P-ZY1VX3q-pmHf93U6SyEk,407
+rtty_soda/encoders/encoder.py,sha256=0nufik44s1g00MiB-TfwmgGA1WCe2CQJX1x6WZPvXlo,195
+rtty_soda/encoders/functions.py,sha256=JxtgbZg3kdbFqAhjm59QwJS6zEXYsR1m02k7cg_rFI4,1385
+rtty_soda/encoders/scsu.py,sha256=W7csQHRV9W62h3_F3VNFFAmWV0oZ2lhc6SxM-E3Kn7I,571
+rtty_soda/encoders/scsu_stubs.pyi,sha256=jmzY1Gm8etztGJXwHhjuQ7Uaf75PhNU7nvBo728pPi8,309
+rtty_soda/formatters.py,sha256=sECdQiQKpQe44S6T0VlkZFcqO_TSniC7mqjJoc4KuUI,1350
+rtty_soda/interfaces.py,sha256=7CB5EZI9ctvk6c4NJyRPWaw-ATMvt6cyRTs66B9jO2o,370
+rtty_soda/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rtty_soda/services/__init__.py,sha256=eDG9XvAGSiZzsTGOk_mhjVfwz1SOblpOx07ZaSVdaDs,339
+rtty_soda/services/encoding_service.py,sha256=O7qmR_D1eW6-lVSyvrTM8q3wXIwWmyti-6PeEpiqay8,772
+rtty_soda/services/encryption_service.py,sha256=6SW2yDT0l8AL5pre7Wk9xKcl8GWBylFpHk2_CQZ0D-Q,4558
+rtty_soda/services/key_service.py,sha256=plS-yL_mH3rveqQFMM8CJDenR4WcoklagCPvVSRdoeg,1354
+rtty_soda/services/service.py,sha256=5QykTVgYvoiC325knCSHV5yPIq7hToGylBLccqm4myM,1605
+rtty_soda-0.3.2.dist-info/WHEEL,sha256=DpNsHFUm_gffZe1FgzmqwuqiuPC6Y-uBCzibcJcdupM,78
+rtty_soda-0.3.2.dist-info/entry_points.txt,sha256=3a-nlDu4rktJdHzeVEWJMPUoEyybCBXmpz9FkVR878s,49
+rtty_soda-0.3.2.dist-info/METADATA,sha256=E4Wb-o8dLaSsx_piUsUlfu5Zt5gZdLIRfDpsUpPxA3A,11229
+rtty_soda-0.3.2.dist-info/RECORD,,

rtty_soda-0.3.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.8
+Root-Is-Purelib: true
+Tag: py3-none-any

rtty_soda-0.3.2.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+soda = rtty_soda.cli.main:cli
+