rtty-soda 0.2.0__tar.gz → 0.2.1__tar.gz

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rtty-soda
-Version: 0.2.0
+Version: 0.2.1
 Summary: A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl
 Keywords: cli,encryption,libsodium,nacl,rtty
 Author: Theo Saveliev
@@ -57,8 +57,8 @@ A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl.
 #### Docker
 
 ```
-% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.0
-% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.0-tools
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.1
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.1-tools
 ```
 
 
@@ -180,7 +180,6 @@ Options:
   -e, --data-encoding TEXT  [default: base64]
   -c, --compression TEXT    [default: zstd]
   -o, --output-file FILE    Write output to file.
-  --padding INTEGER         [default: 0]
   -v, --verbose             Show verbose output.
   -h, --help                Show this message and exit.
 ```

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/README.md

@@ -34,8 +34,8 @@ A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl.
 #### Docker
 
 ```
-% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.0
-% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.0-tools
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.1
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.1-tools
 ```
 
 
@@ -157,7 +157,6 @@ Options:
   -e, --data-encoding TEXT  [default: base64]
   -c, --compression TEXT    [default: zstd]
   -o, --output-file FILE    Write output to file.
-  --padding INTEGER         [default: 0]
   -v, --verbose             Show verbose output.
   -h, --help                Show this message and exit.
 ```

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rtty-soda"
-version = "0.2.0"
+version = "0.2.1"
 description = "A CLI tool for Unix-like environments to encrypt a RTTY session using NaCl"
 readme = "README.md"
 license = { text = "MIT" }

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/cli_io.py

@@ -11,6 +11,7 @@ import click
 from rtty_soda.encoders import Encoder, decode_bytes, encode_str
 
 __all__ = [
+    "format_output",
     "pad_newlines",
     "print_stats",
     "read_bytes",
@@ -40,15 +41,15 @@ def read_encoded_stripped(source: Path) -> bytes:
     return encode_str(data)
 
 
-def read_bytes(source: Path, is_binary: bool) -> bytes:
-    if is_binary:
+def read_bytes(source: Path, encoder: Encoder) -> bytes:
+    if encoder.is_binary:
         return source.read_bytes()
 
     return read_encoded_stripped(source)
 
 
-def read_key_bytes(source: Path, is_binary: bool, encoder: Encoder) -> bytes:
-    key = read_bytes(source, is_binary)
+def read_key_bytes(source: Path, encoder: Encoder) -> bytes:
+    key = read_bytes(source, encoder)
     return encoder.decode(key)
 
 
@@ -84,27 +85,23 @@ def split_groups(data: str, group_len: int, line_len: int) -> str:
     return "\n".join(result)
 
 
-def pad_newlines(data: bytes, count: int) -> bytes:
-    padding = b"\n" * count
-    return padding + data + padding
+def pad_newlines(data: str, count: int) -> str:
+    padding = "\n" * count
+    return padding + data.strip() + "\n" + padding
 
 
-def write_output(
-    target: Path | None,
-    data: bytes,
-    is_binary: bool,
-    group_len: int,
-    line_len: int,
-    padding: int,
-) -> None:
-    if not is_binary and (group_len > 0 or line_len > 0):
-        text = decode_bytes(data)
+def format_output(data: bytes, group_len: int, line_len: int, padding: int) -> bytes:
+    text = decode_bytes(data)
+    if group_len > 0 or line_len > 0:
         text = split_groups(text, group_len, line_len)
-        data = encode_str(text)
 
     if padding > 0:
-        data = pad_newlines(data, padding)
+        text = pad_newlines(text, padding)
 
+    return encode_str(text)
+
+
+def write_output(target: Path | None, data: bytes) -> None:
     if target is None or target.stem == "-":
         add_nl = not data.endswith(b"\n")
         click.echo(data, nl=add_nl)

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/base26_encoder.py

@@ -1,6 +1,6 @@
 import string
+from typing import ClassVar
 
-from .encoder import Encoder
 from .functions import base_to_bytes, bytes_to_base, decode_bytes, encode_str
 
 __all__ = ["ALPHABET", "Base26Encoder"]
@@ -8,7 +8,9 @@ __all__ = ["ALPHABET", "Base26Encoder"]
 ALPHABET = string.ascii_uppercase
 
 
-class Base26Encoder(Encoder):
+class Base26Encoder:
+    is_binary: ClassVar = False
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return encode_str(bytes_to_base(data, ALPHABET))

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/base31_encoder.py

@@ -1,4 +1,5 @@
-from .encoder import Encoder
+from typing import ClassVar
+
 from .functions import base_to_bytes, bytes_to_base, decode_bytes, encode_str
 
 __all__ = ["ALPHABET", "Base31Encoder"]
@@ -6,7 +7,9 @@ __all__ = ["ALPHABET", "Base31Encoder"]
 ALPHABET = "АБВГДЕЖЗИЙКЛМНОПРСТУФХЦЧШЩЬЫЭЮЯ"
 
 
-class Base31Encoder(Encoder):
+class Base31Encoder:
+    is_binary: ClassVar = False
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return encode_str(bytes_to_base(data, ALPHABET))

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/base36_encoder.py

@@ -1,6 +1,6 @@
 import string
+from typing import ClassVar
 
-from .encoder import Encoder
 from .functions import base_to_bytes, bytes_to_base, decode_bytes, encode_str
 
 __all__ = ["ALPHABET", "Base36Encoder"]
@@ -8,7 +8,9 @@ __all__ = ["ALPHABET", "Base36Encoder"]
 ALPHABET = string.digits + string.ascii_uppercase
 
 
-class Base36Encoder(Encoder):
+class Base36Encoder:
+    is_binary: ClassVar = False
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return encode_str(bytes_to_base(data, ALPHABET))

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/base64_encoder.py

@@ -1,11 +1,12 @@
 import base64
-
-from .encoder import Encoder
+from typing import ClassVar
 
 __all__ = ["Base64Encoder"]
 
 
-class Base64Encoder(Encoder):
+class Base64Encoder:
+    is_binary: ClassVar = False
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return base64.b64encode(data)

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/base94_encoder.py

@@ -1,4 +1,5 @@
-from .encoder import Encoder
+from typing import ClassVar
+
 from .functions import base_to_bytes, bytes_to_base, decode_bytes, encode_str
 
 __all__ = ["ALPHABET", "Base94Encoder"]
@@ -6,7 +7,9 @@ __all__ = ["ALPHABET", "Base94Encoder"]
 ALPHABET = "".join([chr(i) for i in range(33, 127)])
 
 
-class Base94Encoder(Encoder):
+class Base94Encoder:
+    is_binary: ClassVar = False
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return encode_str(bytes_to_base(data, ALPHABET))

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/encoder.py

@@ -4,6 +4,8 @@ __all__ = ["Encoder"]
 
 
 class Encoder(Protocol):
+    is_binary: bool
+
     @staticmethod
     def encode(data: bytes) -> bytes: ...
 

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/encoders/raw_encoder.py

@@ -1,9 +1,11 @@
-from .encoder import Encoder
+from typing import ClassVar
 
 __all__ = ["RawEncoder"]
 
 
-class RawEncoder(Encoder):
+class RawEncoder:
+    is_binary: ClassVar = True
+
     @staticmethod
     def encode(data: bytes) -> bytes:
         return data

{rtty_soda-0.2.0 → rtty_soda-0.2.1}/src/rtty_soda/main.py

@@ -6,6 +6,7 @@ from nacl.public import PrivateKey, PublicKey
 
 from rtty_soda.archivers import ARCHIVERS, UNARCHIVERS
 from rtty_soda.cli_io import (
+    format_output,
     print_stats,
     read_bytes,
     read_key_bytes,
@@ -52,19 +53,14 @@ def genkey_cmd(
     Encoding: base26 | base31 | base36 | base64 | base94 | binary
     """
     enc = ENCODERS[encoding]
-    is_bin = encoding == "binary"
 
     key = bytes(PrivateKey.generate())
     key = enc.encode(key)
 
-    write_output(
-        target=output_file,
-        data=key,
-        is_binary=is_bin,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not enc.is_binary:
+        key = format_output(key, group_len, line_len, padding)
+
+    write_output(target=output_file, data=key)
 
 
 @cli.command()  # pyright: ignore[reportAny]
@@ -87,21 +83,16 @@ def pubkey_cmd(
     Encoding: base26 | base31 | base36 | base64 | base94 | binary
     """
     enc = ENCODERS[encoding]
-    is_bin = encoding == "binary"
 
-    priv = read_key_bytes(source=private_key_file, is_binary=is_bin, encoder=enc)
+    priv = read_key_bytes(source=private_key_file, encoder=enc)
     priv = PrivateKey(private_key=priv)
     pub = bytes(priv.public_key)
     pub = enc.encode(pub)
 
-    write_output(
-        target=output_file,
-        data=pub,
-        is_binary=is_bin,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not enc.is_binary:
+        pub = format_output(pub, group_len, line_len, padding)
+
+    write_output(target=output_file, data=pub)
 
 
 @cli.command()  # pyright: ignore[reportAny]
@@ -129,20 +120,15 @@ def kdf_cmd(
     """
     enc = ENCODERS[encoding]
     prof = KDF_PROFILES[profile]
-    is_bin = encoding == "binary"
 
     pw = read_password_bytes(password_file)
     key = kdf(password=pw, profile=prof)
     key = enc.encode(key)
 
-    write_output(
-        target=output_file,
-        data=key,
-        is_binary=is_bin,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not enc.is_binary:
+        key = format_output(key, group_len, line_len, padding)
+
+    write_output(target=output_file, data=key)
 
 
 @cli.command(aliases=["e"])  # pyright: ignore[reportAny]
@@ -179,28 +165,20 @@ def encrypt_public_cmd(
     key_enc = ENCODERS[key_encoding]
     data_enc = ENCODERS[data_encoding]
     archiver = ARCHIVERS[compression]
-    is_bin_key = key_encoding == "binary"
-    is_bin_data = data_encoding == "binary"
 
-    priv = read_key_bytes(
-        source=private_key_file, is_binary=is_bin_key, encoder=key_enc
-    )
+    priv = read_key_bytes(source=private_key_file, encoder=key_enc)
     priv = PrivateKey(private_key=priv)
-    pub = read_key_bytes(source=public_key_file, is_binary=is_bin_key, encoder=key_enc)
+    pub = read_key_bytes(source=public_key_file, encoder=key_enc)
     pub = PublicKey(public_key=pub)
     data = stats = message_file.read_bytes()
     data = archiver(data)
     data = public.encrypt(private=priv, public=pub, data=data)
     data = data_enc.encode(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=is_bin_data,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not data_enc.is_binary:
+        data = format_output(data, group_len, line_len, padding)
+
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=stats, ciphertext=data)
 
@@ -237,23 +215,17 @@ def encrypt_secret_cmd(
     key_enc = ENCODERS[key_encoding]
     data_enc = ENCODERS[data_encoding]
     archiver = ARCHIVERS[compression]
-    is_bin_key = key_encoding == "binary"
-    is_bin_data = data_encoding == "binary"
 
-    key = read_key_bytes(source=key_file, is_binary=is_bin_key, encoder=key_enc)
+    key = read_key_bytes(source=key_file, encoder=key_enc)
     data = stats = message_file.read_bytes()
     data = archiver(data)
     data = secret.encrypt(key=key, data=data)
     data = data_enc.encode(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=is_bin_data,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not data_enc.is_binary:
+        data = format_output(data, group_len, line_len, padding)
+
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=stats, ciphertext=data)
 
@@ -292,7 +264,6 @@ def encrypt_password_cmd(
     prof = KDF_PROFILES[kdf_profile]
     data_enc = ENCODERS[data_encoding]
     archiver = ARCHIVERS[compression]
-    is_bin_data = data_encoding == "binary"
 
     pw = read_password_bytes(password_file)
     key = kdf(password=pw, profile=prof)
@@ -301,14 +272,10 @@ def encrypt_password_cmd(
     data = secret.encrypt(key=key, data=data)
     data = data_enc.encode(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=is_bin_data,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not data_enc.is_binary:
+        data = format_output(data, group_len, line_len, padding)
+
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=stats, ciphertext=data)
 
@@ -321,7 +288,6 @@ def encrypt_password_cmd(
 @click.option("--data-encoding", "-e", default="base64", show_default=True)
 @click.option("--compression", "-c", default="zstd", show_default=True)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--padding", default=0, show_default=True)
 @click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
 def decrypt_public_cmd(
     private_key_file: Path,
@@ -331,7 +297,6 @@ def decrypt_public_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None:
     """Decrypt Message (Public).
@@ -343,28 +308,17 @@ def decrypt_public_cmd(
     key_enc = ENCODERS[key_encoding]
     data_enc = ENCODERS[data_encoding]
     unarchiver = UNARCHIVERS[compression]
-    is_bin_key = key_encoding == "binary"
-    is_bin_data = data_encoding == "binary"
 
-    priv = read_key_bytes(
-        source=private_key_file, is_binary=is_bin_key, encoder=key_enc
-    )
+    priv = read_key_bytes(source=private_key_file, encoder=key_enc)
     priv = PrivateKey(private_key=priv)
-    pub = read_key_bytes(source=public_key_file, is_binary=is_bin_key, encoder=key_enc)
+    pub = read_key_bytes(source=public_key_file, encoder=key_enc)
     pub = PublicKey(public_key=pub)
-    data = stats = read_bytes(source=message_file, is_binary=is_bin_data)
+    data = stats = read_bytes(source=message_file, encoder=data_enc)
     data = data_enc.decode(data)
     data = public.decrypt(private=priv, public=pub, data=data)
     data = unarchiver(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=True,
-        group_len=0,
-        line_len=0,
-        padding=padding,
-    )
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=data, ciphertext=stats)
 
@@ -376,7 +330,6 @@ def decrypt_public_cmd(
 @click.option("--data-encoding", "-e", default="base64", show_default=True)
 @click.option("--compression", "-c", default="zstd", show_default=True)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--padding", default=0, show_default=True)
 @click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
 def decrypt_secret_cmd(
     key_file: Path,
@@ -385,7 +338,6 @@ def decrypt_secret_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None:
     """Decrypt Message (Secret).
@@ -397,23 +349,14 @@ def decrypt_secret_cmd(
     key_enc = ENCODERS[key_encoding]
     data_enc = ENCODERS[data_encoding]
     unarchiver = UNARCHIVERS[compression]
-    is_bin_key = key_encoding == "binary"
-    is_bin_data = data_encoding == "binary"
 
-    key = read_key_bytes(source=key_file, is_binary=is_bin_key, encoder=key_enc)
-    data = stats = read_bytes(source=message_file, is_binary=is_bin_data)
+    key = read_key_bytes(source=key_file, encoder=key_enc)
+    data = stats = read_bytes(source=message_file, encoder=data_enc)
     data = data_enc.decode(data)
     data = secret.decrypt(key=key, data=data)
     data = unarchiver(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=True,
-        group_len=0,
-        line_len=0,
-        padding=padding,
-    )
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=data, ciphertext=stats)
 
@@ -425,7 +368,6 @@ def decrypt_secret_cmd(
 @click.option("--data-encoding", "-e", default="base64", show_default=True)
 @click.option("--compression", "-c", default="zstd", show_default=True)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--padding", default=0, show_default=True)
 @click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
 def decrypt_password_cmd(
     password_file: Path,
@@ -434,7 +376,6 @@ def decrypt_password_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None:
     """Decrypt Message (Password).
@@ -448,23 +389,15 @@ def decrypt_password_cmd(
     prof = KDF_PROFILES[kdf_profile]
     data_enc = ENCODERS[data_encoding]
     unarchiver = UNARCHIVERS[compression]
-    is_bin_data = data_encoding == "binary"
 
     pw = read_password_bytes(password_file)
     key = kdf(password=pw, profile=prof)
-    data = stats = read_bytes(source=message_file, is_binary=is_bin_data)
+    data = stats = read_bytes(source=message_file, encoder=data_enc)
     data = data_enc.decode(data)
     data = secret.decrypt(key=key, data=data)
     data = unarchiver(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=True,
-        group_len=0,
-        line_len=0,
-        padding=padding,
-    )
+    write_output(target=output_file, data=data)
     if verbose:
         print_stats(plaintext=data, ciphertext=stats)
 
@@ -492,21 +425,15 @@ def encode_cmd(
     """
     in_enc = ENCODERS[in_encoding]
     out_enc = ENCODERS[out_encoding]
-    in_bin = in_encoding == "binary"
-    out_bin = out_encoding == "binary"
 
-    data = read_bytes(source=file, is_binary=in_bin)
+    data = read_bytes(source=file, encoder=in_enc)
     data = in_enc.decode(data)
     data = out_enc.encode(data)
 
-    write_output(
-        target=output_file,
-        data=data,
-        is_binary=out_bin,
-        group_len=group_len,
-        line_len=line_len,
-        padding=padding,
-    )
+    if not out_enc.is_binary:
+        data = format_output(data, group_len, line_len, padding)
+
+    write_output(target=output_file, data=data)
 
 
 if __name__ == "__main__":