rtty-soda 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

rtty_soda/cli_io.py

@@ -64,25 +64,11 @@ def write_bytes_atomic(target: Path, data: bytes) -> None:
     temp_path.replace(target)
 
 
-def split_groups(data: str, group_len: int, line_len: int) -> str:
-    step = group_len if group_len > 0 else line_len - 1
-    groups = (data[i : i + step] for i in range(0, len(data), step))
-    result: list[str] = []
-    line: list[str] = []
-    i = 0
-    gpl = line_len // (step + 1)
-    for group in groups:
-        line.append(group)
-        i += 1
-        if i == gpl:
-            result.append(" ".join(line))
-            i = 0
-            line = []
-
-    if line:
-        result.append(" ".join(line))
-
-    return "\n".join(result)
+def split_groups(data: str, group_len: int, line_len: int) -> tuple[str, int]:
+    step, gpl = group_len, line_len // (group_len + 1)
+    groups = [data[i : i + step] for i in range(0, len(data), step)]
+    lines = [" ".join(groups[i : i + gpl]) for i in range(0, len(groups), gpl)]
+    return "\n".join(lines), len(groups)
 
 
 def pad_newlines(data: str, count: int) -> str:
@@ -90,15 +76,21 @@ def pad_newlines(data: str, count: int) -> str:
     return padding + data.strip() + "\n" + padding
 
 
-def format_output(data: bytes, group_len: int, line_len: int, padding: int) -> bytes:
+def format_output(
+    data: bytes, encoder: Encoder, group_len: int, line_len: int, padding: int
+) -> tuple[bytes, int]:
+    groups = 1
+    if encoder.is_binary:
+        return data, groups
+
     text = decode_bytes(data)
-    if group_len > 0 or line_len > 0:
-        text = split_groups(text, group_len, line_len)
+    if 0 < group_len < line_len:
+        text, groups = split_groups(text, group_len, line_len)
 
     if padding > 0:
         text = pad_newlines(text, padding)
 
-    return encode_str(text)
+    return encode_str(text), groups
 
 
 def write_output(target: Path | None, data: bytes) -> None:
@@ -114,8 +106,8 @@ def write_output(target: Path | None, data: bytes) -> None:
         write_bytes_atomic(target, data)
 
 
-def print_stats(plaintext: bytes, ciphertext: bytes) -> None:
-    click.echo(f"Plaintext: {len(plaintext)}", err=True)
-    click.echo(f"Ciphertext: {len(ciphertext)}", err=True)
-    overhead = len(ciphertext) / len(plaintext)
+def print_stats(plaintext: int, ciphertext: int) -> None:
+    click.echo(f"Plaintext: {plaintext}", err=True)
+    click.echo(f"Ciphertext: {ciphertext}", err=True)
+    overhead = ciphertext / plaintext
     click.echo(f"Overhead: {overhead:.3f}", err=True)

rtty_soda/main.py

@@ -40,13 +40,23 @@ def cli() -> None:
 
 
 @cli.command()  # pyright: ignore[reportAny]
-@click.option("--encoding", "-e", default="base64", show_default=True)
+@click.option(
+    "--encoding", "-e", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def genkey_cmd(
-    encoding: str, output_file: Path | None, group_len: int, line_len: int, padding: int
+    encoding: str,
+    output_file: Path | None,
+    group_len: int,
+    line_len: int,
+    padding: int,
+    verbose: bool,
 ) -> None:
     """Generate Private Key.
 
@@ -57,19 +67,27 @@ def genkey_cmd(
     key = bytes(PrivateKey.generate())
     key = enc.encode(key)
 
-    if not enc.is_binary:
-        key = format_output(key, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=key, encoder=enc, group_len=group_len, line_len=line_len, padding=padding
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=key)
+    if verbose:
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command()  # pyright: ignore[reportAny]
 @click.argument("private_key_file", type=in_path)
-@click.option("--encoding", "-e", default="base64", show_default=True)
+@click.option(
+    "--encoding", "-e", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def pubkey_cmd(
     private_key_file: Path,
     encoding: str,
@@ -77,6 +95,7 @@ def pubkey_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None:
     """Get Public Key.
 
@@ -89,20 +108,30 @@ def pubkey_cmd(
     pub = bytes(priv.public_key)
     pub = enc.encode(pub)
 
-    if not enc.is_binary:
-        pub = format_output(pub, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=pub, encoder=enc, group_len=group_len, line_len=line_len, padding=padding
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=pub)
+    if verbose:
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command()  # pyright: ignore[reportAny]
 @click.argument("password_file", type=in_path)
-@click.option("--encoding", "-e", default="base64", show_default=True)
-@click.option("--profile", "-p", default="sensitive", show_default=True)
+@click.option(
+    "--encoding", "-e", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
+@click.option(
+    "--profile", "-p", default="sensitive", show_default=True, envvar="KDF_PROFILE"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def kdf_cmd(
     password_file: Path,
     encoding: str,
@@ -111,6 +140,7 @@ def kdf_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None:
     """Key Derivation Function.
 
@@ -125,24 +155,35 @@ def kdf_cmd(
     key = kdf(password=pw, profile=prof)
     key = enc.encode(key)
 
-    if not enc.is_binary:
-        key = format_output(key, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=key, encoder=enc, group_len=group_len, line_len=line_len, padding=padding
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=key)
+    if verbose:
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command(aliases=["e"])  # pyright: ignore[reportAny]
 @click.argument("private_key_file", type=in_path)
 @click.argument("public_key_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--key-encoding", default="base64", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--key-encoding", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def encrypt_public_cmd(
     private_key_file: Path,
     public_key_file: Path,
@@ -170,30 +211,44 @@ def encrypt_public_cmd(
     priv = PrivateKey(private_key=priv)
     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)
+    plaintext = message_file.read_bytes()
+    data = archiver(plaintext)
     data = public.encrypt(private=priv, public=pub, data=data)
-    data = data_enc.encode(data)
+    ciphertext = data_enc.encode(data)
 
-    if not data_enc.is_binary:
-        data = format_output(data, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=ciphertext,
+        encoder=data_enc,
+        group_len=group_len,
+        line_len=line_len,
+        padding=padding,
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=stats, ciphertext=data)
+        print_stats(len(plaintext), len(ciphertext))
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command(aliases=["es"])  # pyright: ignore[reportAny]
 @click.argument("key_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--key-encoding", default="base64", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--key-encoding", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def encrypt_secret_cmd(
     key_file: Path,
     message_file: Path,
@@ -217,30 +272,44 @@ def encrypt_secret_cmd(
     archiver = ARCHIVERS[compression]
 
     key = read_key_bytes(source=key_file, encoder=key_enc)
-    data = stats = message_file.read_bytes()
-    data = archiver(data)
+    plaintext = message_file.read_bytes()
+    data = archiver(plaintext)
     data = secret.encrypt(key=key, data=data)
-    data = data_enc.encode(data)
+    ciphertext = data_enc.encode(data)
 
-    if not data_enc.is_binary:
-        data = format_output(data, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=ciphertext,
+        encoder=data_enc,
+        group_len=group_len,
+        line_len=line_len,
+        padding=padding,
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=stats, ciphertext=data)
+        print_stats(len(plaintext), len(ciphertext))
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command(aliases=["ep"])  # pyright: ignore[reportAny]
 @click.argument("password_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--kdf-profile", "-p", default="sensitive", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--kdf-profile", "-p", default="sensitive", show_default=True, envvar="KDF_PROFILE"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def encrypt_password_cmd(
     password_file: Path,
     message_file: Path,
@@ -267,28 +336,42 @@ def encrypt_password_cmd(
 
     pw = read_password_bytes(password_file)
     key = kdf(password=pw, profile=prof)
-    data = stats = message_file.read_bytes()
-    data = archiver(data)
+    plaintext = message_file.read_bytes()
+    data = archiver(plaintext)
     data = secret.encrypt(key=key, data=data)
-    data = data_enc.encode(data)
+    ciphertext = data_enc.encode(data)
 
-    if not data_enc.is_binary:
-        data = format_output(data, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=ciphertext,
+        encoder=data_enc,
+        group_len=group_len,
+        line_len=line_len,
+        padding=padding,
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=stats, ciphertext=data)
+        print_stats(len(plaintext), len(ciphertext))
+        click.echo(f"Groups: {groups}", err=True)
 
 
 @cli.command(aliases=["d"])  # pyright: ignore[reportAny]
 @click.argument("private_key_file", type=in_path)
 @click.argument("public_key_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--key-encoding", default="base64", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--key-encoding", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def decrypt_public_cmd(
     private_key_file: Path,
     public_key_file: Path,
@@ -313,24 +396,33 @@ def decrypt_public_cmd(
     priv = PrivateKey(private_key=priv)
     pub = read_key_bytes(source=public_key_file, encoder=key_enc)
     pub = PublicKey(public_key=pub)
-    data = stats = read_bytes(source=message_file, encoder=data_enc)
-    data = data_enc.decode(data)
+    ciphertext = read_bytes(source=message_file, encoder=data_enc)
+    data = data_enc.decode(ciphertext)
     data = public.decrypt(private=priv, public=pub, data=data)
-    data = unarchiver(data)
+    plaintext = unarchiver(data)
+
+    write_output(target=output_file, data=plaintext)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=data, ciphertext=stats)
+        print_stats(len(plaintext), len(ciphertext))
 
 
 @cli.command(aliases=["ds"])  # pyright: ignore[reportAny]
 @click.argument("key_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--key-encoding", default="base64", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--key-encoding", default="base64", show_default=True, envvar="KEY_ENCODING"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def decrypt_secret_cmd(
     key_file: Path,
     message_file: Path,
@@ -351,24 +443,33 @@ def decrypt_secret_cmd(
     unarchiver = UNARCHIVERS[compression]
 
     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)
+    ciphertext = read_bytes(source=message_file, encoder=data_enc)
+    data = data_enc.decode(ciphertext)
     data = secret.decrypt(key=key, data=data)
-    data = unarchiver(data)
+    plaintext = unarchiver(data)
+
+    write_output(target=output_file, data=plaintext)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=data, ciphertext=stats)
+        print_stats(len(plaintext), len(ciphertext))
 
 
 @cli.command(aliases=["dp"])  # pyright: ignore[reportAny]
 @click.argument("password_file", type=in_path)
 @click.argument("message_file", type=in_path)
-@click.option("--kdf-profile", "-p", default="sensitive", show_default=True)
-@click.option("--data-encoding", "-e", default="base64", show_default=True)
-@click.option("--compression", "-c", default="zstd", show_default=True)
+@click.option(
+    "--kdf-profile", "-p", default="sensitive", show_default=True, envvar="KDF_PROFILE"
+)
+@click.option(
+    "--data-encoding", "-e", default="base64", show_default=True, envvar="DATA_ENCODING"
+)
+@click.option(
+    "--compression", "-c", default="zstd", show_default=True, envvar="COMPRESSION"
+)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--verbose", "-v", is_flag=True, help="Show verbose output.")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def decrypt_password_cmd(
     password_file: Path,
     message_file: Path,
@@ -392,14 +493,15 @@ def decrypt_password_cmd(
 
     pw = read_password_bytes(password_file)
     key = kdf(password=pw, profile=prof)
-    data = stats = read_bytes(source=message_file, encoder=data_enc)
-    data = data_enc.decode(data)
+    ciphertext = read_bytes(source=message_file, encoder=data_enc)
+    data = data_enc.decode(ciphertext)
     data = secret.decrypt(key=key, data=data)
-    data = unarchiver(data)
+    plaintext = unarchiver(data)
+
+    write_output(target=output_file, data=plaintext)
 
-    write_output(target=output_file, data=data)
     if verbose:
-        print_stats(plaintext=data, ciphertext=stats)
+        print_stats(len(plaintext), len(ciphertext))
 
 
 @cli.command()  # pyright: ignore[reportAny]
@@ -407,9 +509,12 @@ def decrypt_password_cmd(
 @click.argument("out_encoding")
 @click.argument("file", type=in_path)
 @click.option("--output-file", "-o", type=out_path, help="Write output to file.")
-@click.option("--group-len", default=0, show_default=True)
-@click.option("--line-len", default=0, show_default=True)
-@click.option("--padding", default=0, show_default=True)
+@click.option("--group-len", default=0, show_default=True, envvar="GROUP_LEN")
+@click.option("--line-len", default=80, show_default=True, envvar="LINE_LEN")
+@click.option("--padding", default=0, show_default=True, envvar="PADDING")
+@click.option(
+    "--verbose", "-v", is_flag=True, envvar="VERBOSE", help="Show verbose output."
+)
 def encode_cmd(
     in_encoding: str,
     out_encoding: str,
@@ -418,6 +523,7 @@ def encode_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None:
     """Encode File.
 
@@ -430,10 +536,17 @@ def encode_cmd(
     data = in_enc.decode(data)
     data = out_enc.encode(data)
 
-    if not out_enc.is_binary:
-        data = format_output(data, group_len, line_len, padding)
+    formatted, groups = format_output(
+        data=data,
+        encoder=out_enc,
+        group_len=group_len,
+        line_len=line_len,
+        padding=padding,
+    )
+    write_output(target=output_file, data=formatted)
 
-    write_output(target=output_file, data=data)
+    if verbose:
+        click.echo(f"Groups: {groups}", err=True)
 
 
 if __name__ == "__main__":

rtty_soda/main.pyi

@@ -2,7 +2,12 @@ from pathlib import Path
 
 def cli() -> None: ...
 def genkey_cmd(
-    encoding: str, output_file: Path | None, group_len: int, line_len: int, padding: int
+    encoding: str,
+    output_file: Path | None,
+    group_len: int,
+    line_len: int,
+    padding: int,
+    verbose: bool,
 ) -> None: ...
 def pubkey_cmd(
     private_key_file: Path,
@@ -11,6 +16,7 @@ def pubkey_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None: ...
 def kdf_cmd(
     password_file: Path,
@@ -20,6 +26,7 @@ def kdf_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None: ...
 def encrypt_public_cmd(
     private_key_file: Path,
@@ -66,7 +73,6 @@ def decrypt_public_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None: ...
 def decrypt_secret_cmd(
@@ -76,7 +82,6 @@ def decrypt_secret_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None: ...
 def decrypt_password_cmd(
@@ -86,7 +91,6 @@ def decrypt_password_cmd(
     data_encoding: str,
     compression: str,
     output_file: Path | None,
-    padding: int,
     verbose: bool,
 ) -> None: ...
 def encode_cmd(
@@ -97,4 +101,5 @@ def encode_cmd(
     group_len: int,
     line_len: int,
     padding: int,
+    verbose: bool,
 ) -> None: ...

{rtty_soda-0.2.1.dist-info → rtty_soda-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rtty-soda
-Version: 0.2.1
+Version: 0.2.3
 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.1
-% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.1-tools
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.3
+% docker run -it --rm -h rtty-soda -v .:/app/host nett/rtty-soda:0.2.3-tools
 ```
 
 
@@ -112,8 +112,9 @@ Options:
   -e, --encoding TEXT     [default: base64]
   -o, --output-file FILE  Write output to file.
   --group-len INTEGER     [default: 0]
-  --line-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.
 ```
 
@@ -128,11 +129,11 @@ 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 --line-len 80 | tee encrypted
-cCipniCmJVAb2mc3JLoDo/DAun7cMunWS5bMqtKRPc/e3d2vfRm8wnqTsYjOXVOCZRj78/GqcVweBV0
-mE43X7xO8B0OVyKKgqPAqnAJxwggTLPmWtKFrTwKi0utf7n6fIQuDaCths0qO6FF5rm0znc/3KYKP3D
-/WbgE/IBrTOAV6P+mLUnGlzO6U/HdtDCjk1ZB45EN0Q76dDzYav+bliCrVWiAUfZUCtEQ/6B4fi9Aqn
-KRDC4XSnd7nLs/ZkhL8hkM13xJ+1MBGbIvEjaY=
+% 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
@@ -150,7 +151,7 @@ Options:
   -c, --compression TEXT    [default: zstd]
   -o, --output-file FILE    Write output to file.
   --group-len INTEGER       [default: 0]
-  --line-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.
@@ -164,24 +165,6 @@ 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 decrypt-public -h
-Usage: soda decrypt-public [OPTIONS] PRIVATE_KEY_FILE PUBLIC_KEY_FILE
-                           MESSAGE_FILE
-
-  Decrypt Message (Public).
-
-  Encoding: base26 | base31 | base36 | base64 | base94 | binary
-
-  Compression: zstd | zlib | bz2 | lzma | raw
-
-Options:
-  --key-encoding TEXT       [default: base64]
-  -e, --data-encoding TEXT  [default: base64]
-  -c, --compression TEXT    [default: zstd]
-  -o, --output-file FILE    Write output to file.
-  -v, --verbose             Show verbose output.
-  -h, --help                Show this message and exit.
 ```
 
 
@@ -193,26 +176,6 @@ 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
-
-% soda encrypt-secret -h
-Usage: soda encrypt-secret [OPTIONS] KEY_FILE MESSAGE_FILE
-
-  Encrypt Message (Secret).
-
-  Encoding: base26 | base31 | base36 | base64 | base94 | binary
-
-  Compression: zstd | zlib | bz2 | lzma | raw
-
-Options:
-  --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: 0]
-  --padding INTEGER         [default: 0]
-  -v, --verbose             Show verbose output.
-  -h, --help                Show this message and exit.
 ```
 
 Another day, they share a password:
@@ -220,28 +183,6 @@ 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
-
-% soda encrypt-password -h
-Usage: soda encrypt-password [OPTIONS] PASSWORD_FILE MESSAGE_FILE
-
-  Encrypt Message (Password).
-
-  KDF profile: interactive | moderate | sensitive
-
-  Encoding: base26 | base31 | base36 | base64 | base94 | binary
-
-  Compression: zstd | zlib | bz2 | lzma | raw
-
-Options:
-  -p, --kdf-profile TEXT    [default: sensitive]
-  -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: 0]
-  --padding INTEGER         [default: 0]
-  -v, --verbose             Show verbose output.
-  -h, --help                Show this message and exit.
 ```
 
 
@@ -268,8 +209,9 @@ Options:
   -p, --profile TEXT      [default: sensitive]
   -o, --output-file FILE  Write output to file.
   --group-len INTEGER     [default: 0]
-  --line-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.
 ```
 
@@ -286,22 +228,27 @@ That works as follows:
 Plaintext: 239
 Ciphertext: 276
 Overhead: 1.155
+Groups: 1
 % soda es shared message -c zlib -v > /dev/null
 Plaintext: 239
 Ciphertext: 280
 Overhead: 1.172
+Groups: 1
 % soda es shared message -c bz2 -v > /dev/null
 Plaintext: 239
 Ciphertext: 340
 Overhead: 1.423
+Groups: 1
 % soda es shared message -c lzma -v > /dev/null
 Plaintext: 239
 Ciphertext: 324
 Overhead: 1.356
+Groups: 1
 % soda es shared message -c raw -v > /dev/null
 Plaintext: 239
 Ciphertext: 372
 Overhead: 1.556
+Groups: 1
 ```
 
 
@@ -310,15 +257,59 @@ Overhead: 1.556
 The rtty-soda supports various encodings:
 
 ```
-% soda encrypt-public alice bob_pub message --data-encoding base36 --group-len 5 --line-len 80
-9TPUZ T8OA3 PNC2Z XEH87 EPMCN NDQJJ GX0DE YW16D OJ2FC D3PCM B148K 6UZFN 9RQX7
-8C83X 6O8WS MQ4CX 26C7H 35EK5 CVSIX IFSVN KPV6A TRV1F 573WI JFFGE I7N3Z Z4N6D
-FSSOB DJUBK PC2YW Z6RG0 SUD2N OIYH8 WHJMN YYSKQ EBEVJ ZT0M1 DYJ7E NJ25J FMXNE
-7LHUQ N5UIH SK5O7 96LWM IZ7BA R8SIV 6G55R Q50L4 PJH5Z 2JQNX JZTPK BG140 AKXOB
-DKR4K POW9A HCQSQ JLSJ1 11AZY P8BM4 F3GUC SFX04 RMD0G 4V0PL RLRHN G8D8
+% soda encrypt-public alice bob_pub message --data-encoding base36 --group-len 5 --verbose
+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
+Plaintext: 239
+Ciphertext: 319
+Overhead: 1.335
+Groups: 64
+```
+
+
+## Environment variables
+
+Common options can be set in the environment variables:
+
+```
+% cat .env 
+KEY_ENCODING=base26
+DATA_ENCODING=base26
+COMPRESSION=bz2
+KDF_PROFILE=moderate
+VERBOSE=1
+GROUP_LEN=5
+LINE_LEN=80
+PADDING=1
+
+% set -a
+% source .env
 ```
 
 
+## 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),

{rtty_soda-0.2.1.dist-info → rtty_soda-0.2.3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 rtty_soda/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rtty_soda/archivers.py,sha256=b-qZ6-MAY1rm1Jsosi2XEfjNjkU7acAedHmnSzthf-A,1343
-rtty_soda/cli_io.py,sha256=01d0IWv2lpOBB13TKB0ZbiLpSXep9J53lXiOsy9HNEM,3162
+rtty_soda/cli_io.py,sha256=mkCYMp_Cm9pKvvS7OE2KSeXzRVjoHfTlfqVGjyCnCyY,3040
 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
@@ -14,10 +14,10 @@ rtty_soda/encoders/base94_encoder.py,sha256=Xbt0chbeAIM9_nRHVhRMVfMBUKS9q1gNSpg2
 rtty_soda/encoders/encoder.py,sha256=trHunjg0uNEQrQWTpRMY5nQEx5_jBrcvfUAcGIKpgms,220
 rtty_soda/encoders/functions.py,sha256=JxtgbZg3kdbFqAhjm59QwJS6zEXYsR1m02k7cg_rFI4,1385
 rtty_soda/encoders/raw_encoder.py,sha256=eJnUSsxf3jichdQ5LqwvBZAX7-qk67p5FMlfKOOGHp8,259
-rtty_soda/main.py,sha256=QPVvnNkZgMHZQQ7mQUOiHLDuVA1WFfEZVJqgZxp_6hs,14679
-rtty_soda/main.pyi,sha256=1_ahHQ89q7lC2cQ0Vgk4QXwsP0G9c10XYGvrVsO1U0s,2203
+rtty_soda/main.py,sha256=OEaefD5VxbL6P4NWWtNb9Am9wJegkesg29xzjYy1oxU,17319
+rtty_soda/main.pyi,sha256=SoTM1GXACRafCtwwLOI1X9YhvEo3DPoaPtKSgWacSS0,2242
 rtty_soda/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rtty_soda-0.2.1.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
-rtty_soda-0.2.1.dist-info/entry_points.txt,sha256=tFROKkaDoE_p5tM2ko7MoAjWBFurchcw3j-MdObxBU0,45
-rtty_soda-0.2.1.dist-info/METADATA,sha256=OXeQ9VdCEzSNtvDtY4dJNVrCR4jPxEVPl88ExekIxbM,9616
-rtty_soda-0.2.1.dist-info/RECORD,,
+rtty_soda-0.2.3.dist-info/WHEEL,sha256=M6du7VZflc4UPsGphmOXHANdgk8zessdJG0DBUuoA-U,78
+rtty_soda-0.2.3.dist-info/entry_points.txt,sha256=tFROKkaDoE_p5tM2ko7MoAjWBFurchcw3j-MdObxBU0,45
+rtty_soda-0.2.3.dist-info/METADATA,sha256=BZR-y-ilDaepE0j8RuckR-IHCK1nPeMUCq96ySPxnp0,8603
+rtty_soda-0.2.3.dist-info/RECORD,,