codext 1.16.2__tar.gz → 1.16.3__tar.gz

{codext-1.16.2 → codext-1.16.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codext
-Version: 1.16.2
+Version: 1.16.3
 Summary: Native codecs extension
 Author-email: Alexandre D'Hondt <alexandre.dhondt@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -1041,6 +1041,7 @@ This category also contains `ascii85`, `adobe`, `[x]btoa`, `zeromq` with the `ba
 - [X] `scytaleN`: encrypts using the number of letters on the rod (*N* belongs to [1,[)
 - [X] `shiftN`: shift ordinals (*N* belongs to [1,255])
 - [X] `trithemius`: aka Trithemius Cipher (variant of Vigenere Cipher)
+- [X] `vic`: aka VIC Cipher
 - [X] `vigenere`: aka Vigenere Cipher
 - [X] `xorN`: XOR with a single byte (*N* belongs to [1,255])
 

{codext-1.16.2 → codext-1.16.3}/README.md

@@ -343,6 +343,7 @@ This category also contains `ascii85`, `adobe`, `[x]btoa`, `zeromq` with the `ba
 - [X] `scytaleN`: encrypts using the number of letters on the rod (*N* belongs to [1,[)
 - [X] `shiftN`: shift ordinals (*N* belongs to [1,255])
 - [X] `trithemius`: aka Trithemius Cipher (variant of Vigenere Cipher)
+- [X] `vic`: aka VIC Cipher
 - [X] `vigenere`: aka Vigenere Cipher
 - [X] `xorN`: XOR with a single byte (*N* belongs to [1,255])
 

{codext-1.16.2 → codext-1.16.3}/docs/pages/enc/crypto.md

@@ -274,6 +274,30 @@ This is a variant of the [Vigenere Cipher](#vigenere-cipher) with key `"ABCDEFGH
 
 -----
 
+### VIC Cipher
+
+The VIC cipher combines a straddling checkerboard substitution (converting letters to a stream of digits) and an over-encryption based on a modulo-10 sum with eventually a conversion from digits to text.
+
+**Codec** | **Conversions** | **Aliases** | **Comment**
+:---: | :---: | --- | ---
+`vic` | text <-> VIC digit/text ciphertext | `vic-keyword`, `vic-key-12`, `vic-^-26-0248`, `vic-*-73-534T` | optional checkerboard keyword or alphabet marker, blank positions (exactly 2 distinct digits), over-encryption key (digits), "`T`" marker for text conversion
+
+Alphabet markers:
+- `*`: uses "`ABC[...]XYZ./`" (uppercase letters + "`./`")
+- `^`: uses "`./ZYX[...]CBA`" ("`./`" + reversed uppercase letters)
+
+```python
+>>> import codext
+>>> codext.encode("VICTOR", "vic-^-26-0248T")
+'VVXYWYY.XYJ'
+>>> codext.decode("VVXYWYY.XYJ", "vic-^-26-0248T")
+'VICTOR2'  # trailing superfluous letter because of text conversion
+>>> codext.encode("LONGTESTSTRING", "vic-^-85-72564")
+'5031237844273727064454072378'
+```
+
+-----
+
 ### Vigenere Cipher
 
 This is a dynamic encoding, that is, it holds the key. There is no default key, meaning that `vigenere` as the encoding scheme throws a `LookupError` indicating that the _key must be a non-empty alphabetic string_.

codext-1.16.3/src/codext/VERSION.txt

@@ -0,0 +1 @@
+1.16.3

{codext-1.16.2 → codext-1.16.3}/src/codext/crypto/__init__.py

@@ -10,6 +10,7 @@ from .railfence import *
 from .rot import *
 from .scytale import *
 from .shift import *
+from .vic import *
 from .vigenere import *
 from .xor import *
 

codext-1.16.3/src/codext/crypto/phillips.py

@@ -0,0 +1,130 @@
+# -*- coding: UTF-8 -*-
+"""Phillips Cipher Codec - phillips content encoding.
+
+The Phillips cipher is a polyalphabetic substitution cipher using 8 key squares.  The first square is a 5×5 grid built
+ from a keyword (I and J share one cell).  Seven additional squares are derived by sequentially swapping adjacent rows
+ in a descending bubble pattern.  Plaintext is divided into blocks of T letters (default 5); each letter is individually
+ enciphered by shifting its grid position right by DH columns and down by DV rows (both default to 1), wrapping
+ around with toroidal topology.  J is treated as I.
+
+Parameters:
+  key        -- keyword used to seed the initial 5×5 grid (required)
+  block_size -- number of letters per grid-cycle block, 1–25 (default 5)
+  dh         -- horizontal (column) shift for encryption, 1–4 (default 1)
+  dv         -- vertical (row) shift for encryption, 1–4 (default 1)
+
+This codec:
+- en/decodes strings from str to str
+- en/decodes strings from bytes to bytes
+- decodes file content to str (read)
+- encodes file content from str to bytes (write)
+
+Reference: https://www.dcode.fr/phillips-cipher
+"""
+from ..__common__ import *
+
+
+__examples__ = {
+    'enc(phillips)':               None,
+    'enc(phillips-key)':           {'ATTACK': "HUUHLL", 'TESTME': "UFZUSM", 'ABCDEF': "HCLMFA"},
+    'enc(phillips-key-5-1-2)':     {'This is a Test String': "KPVBVHTCRHCHCGQBT"},
+    'dec(phillips-key-5-1-2)':     {'KPVBVHTCRHCHCGQBT': "THISISATESTSTRING"},
+    'enc-dec(phillips-key)':       ["ATTACK", "TESTME", "ABCDEF"],
+    'enc-dec(phillips-secret)':    ["HELLOWORLD", "ATTACKATDAWN"],
+    'enc-dec(phillips-key-2)':     ["ATTACK", "TESTME"],
+    'enc-dec(phillips-key-5-2)':   ["ATTACK"],
+    'enc-dec(phillips-key-5-1-2)': ["ATTACK"],
+}
+__guess__ = ["phillips-key", "phillips-secret", "phillips-password"]
+
+
+_ALPHABET = "ABCDEFGHIKLMNOPQRSTUVWXYZ"
+
+
+def __make_grids(key):
+    """Return all 8 grids built by a descending bubble-swap row permutation."""
+    seen, letters = set(), []
+    for c in key.upper().replace("J", "I") + _ALPHABET:
+        if c in set(_ALPHABET) and c not in seen:
+            letters.append(c)
+            seen.add(c)
+    grid = [letters[i * 5:(i + 1) * 5] for i in range(5)]
+    grids = [grid]
+    for k in range(7):
+        r = k % 4
+        grid = [row[:] for row in grid]
+        grid[r], grid[r + 1] = grid[r + 1], grid[r]
+        grids.append(grid)
+    return grids
+
+
+def _shift_text(text, grids, block_size, dh, dv, errors, decode=False):
+    t = ensure_str(text).upper().replace("J", "I")
+    pos_maps = [
+        {ch: (r, c) for r, row in enumerate(grid) for c, ch in enumerate(row)}
+        for grid in grids
+    ]
+    _h = handle_error("phillips", errors, decode=decode)
+    r, i = "", 0
+    for pos, c in enumerate(t):
+        if c == " ":
+            continue
+        if c not in set(_ALPHABET):
+            r += _h(c, pos, r)
+            continue
+        grid_idx = (i // block_size) % 8
+        grid = grids[grid_idx]
+        s, col = pos_maps[grid_idx][c]
+        r += grid[(s + dv) % 5][(col + dh) % 5]
+        i += 1
+    return r, len(text)
+
+
+def _make_cipher(key, block_size, dh, dv):
+    _key = (key or "").strip()
+    try:
+        block_size = int(block_size) if block_size else 5
+    except (ValueError, TypeError):
+        raise LookupError(f"Bad parameter for encoding 'phillips': block_size must be an integer, got {block_size}")
+    if not (1 <= block_size <= 25):
+        raise LookupError("Bad parameter for encoding 'phillips': block_size must be between 1 and 25, got "
+                          f"{block_size}")
+    try:
+        dh = int(dh) if dh else 1
+    except (ValueError, TypeError):
+        raise LookupError(f"Bad parameter for encoding 'phillips': dh must be an integer, got {dh}")
+    if not (1 <= dh <= 4):
+        raise LookupError(f"Bad parameter for encoding 'phillips': dh must be between 1 and 4, got {dh}")
+    try:
+        dv = int(dv) if dv else 1
+    except (ValueError, TypeError):
+        raise LookupError(f"Bad parameter for encoding 'phillips': dv must be an integer, got {dv}")
+    if not (1 <= dv <= 4):
+        raise LookupError(f"Bad parameter for encoding 'phillips': dv must be between 1 and 4, got {dv}")
+    return _key, block_size, dh, dv, __make_grids(_key) if _key and _key.isalpha() else None
+
+
+def phillips_encode(key, block_size=None, dh=None, dv=None):
+    _key, block_size, dh, dv, grids = _make_cipher(key, block_size, dh, dv)
+    def encode(text, errors="strict"):
+        if grids is None:
+            raise LookupError("Bad parameter for encoding 'phillips': "
+                              "key must be a non-empty alphabetic string")
+        return _shift_text(text, grids, block_size, dh, dv, errors)
+    return encode
+
+
+def phillips_decode(key, block_size=None, dh=None, dv=None):
+    _key, block_size, dh, dv, grids = _make_cipher(key, block_size, dh, dv)
+    def decode(text, errors="strict"):
+        if grids is None:
+            raise LookupError("Bad parameter for decoding 'phillips': "
+                              "key must be a non-empty alphabetic string")
+        return _shift_text(text, grids, block_size, -dh, -dv, errors, True)
+    return decode
+
+
+add("phillips", phillips_encode, phillips_decode,
+    r"^phillips(?:[-_]cipher)?(?:[-_]([a-zA-Z]+))?(?:[-_]([1-9]|1[0-9]|2[0-5]))?(?:[-_]([1-4]))?(?:[-_]([1-4]))?$",
+    printables_rate=1., penalty=.1)
+

codext-1.16.3/src/codext/crypto/vic.py

@@ -0,0 +1,142 @@
+# -*- coding: UTF-8 -*-
+"""Vic Cipher Codec - vic content encoding.
+
+This codec:
+- en/decodes strings from str to str
+- en/decodes strings from bytes to bytes
+- decodes file content to str (read)
+- encodes file content from str to bytes (write)
+"""
+from itertools import cycle
+from string import ascii_uppercase as UC
+
+from ..__common__ import *
+
+
+__examples__ = {
+    'dec(vic-test-33)':         None,
+    'dec(vic-*-12-1234T':       {'BBXMBDMBCBBHEMC': "THISISATEST"},
+    'dec(vic-^-26-0248T)':      {'VVXYWYY.XYJ': "VICTOR2"},  # '2' because of superfluous extra letter from substitution
+    'enc(vic-test-12-ABC)':     None,
+    'enc(vic-*-12-1234T':       {'This is a Test': "BBXMBDMBCBBHEMC"},
+    'enc(vic-^-26-0248)':       {'VICTOR': "88547440546"},
+    'enc(vic-^-26-0248T)':      {'VICTOR': "VVXYWYY.XYJ"},
+    'enc-dec(vic-^-26)':        ["TEST", "LONGTESTSTRING", "VICTOR"],
+    'enc-dec(vic-^-85-72564)':  ["TEST", "LONGTESTSTRING", "VICTOR"],
+    'enc-dec(vic-^-85-54321T)': ["TEST", "LONGTESTSTRING", "VICTOR"],
+}
+__guess__ = ["vic"]
+
+
+def __build_alphabet(key, alphabet=UC, reverse=False):
+    """Return the 28-letter alphabet derived from the input key."""
+    seen, result = set(), ""
+    for c in (key or "").upper():
+        if c.isalpha() and c not in seen:
+            result += c
+            seen.add(c)
+    for c in (alphabet[::-1] if reverse else alphabet):
+        if c not in seen:
+            result += c
+    return "./" + result if reverse else result + "./"
+
+
+def __build_checkerboard(alphabet, blank1=1, blank2=2):
+    """Build encode/decode lookup tables for the straddling checkerboard.
+
+    Layout with digit1=2 and digit2=6:
+         0  1 [2] 3  4  5 [6] 7  8  9
+      0: *  *     *  *  *     *  *  *
+      2: *  *  *  *  *  *  *  *  *  *
+      6: *  *  *  *  *  *  *  *  *  *
+    """
+    if blank1 == blank2:
+        raise LookupError(f"Bad parameter for encoding 'vic': blank1 and blank2 cannot be identical")
+    enc, dec, i = {}, {}, 0
+    # top row
+    for col in range(10):
+        if col not in (blank1, blank2):
+            enc[alphabet[i]] = str(col)
+            i += 1
+    # second row ; header digit is 'blank1'
+    for col in range(10):
+        enc[alphabet[i]] = str(blank1) + str(col)
+        i += 1
+    # third row ; header digit is 'blank2'
+    for col in range(10):
+        enc[alphabet[i]] = str(blank2) + str(col)
+        i += 1
+    return enc, {v: k for k, v in enc.items()}
+
+
+def __set_params(key, blanks, numeric_key):
+    return (UC if key == "*" else UC[::-1] if key == "^" else key).upper(), \
+           tuple(map(int, str(blanks) or "12")), \
+           str(numeric_key or "").rstrip("T"), \
+           key == "^", \
+           str(numeric_key or " ")[-1] == "T"
+
+
+def vic_encode(key=None, blanks=None, numeric_key=None):
+    key, blanks, numeric_key, rev, txt = __set_params(key, blanks, numeric_key)
+    enc_map, dec_map = __build_checkerboard(__build_alphabet(key, reverse=rev), blanks[0], blanks[1])
+    def _encode(text, errors="strict"):
+        _h = handle_error("vic", errors)
+        digits, nk_i, nk_l = [], 0, len(numeric_key or "")
+        for pos, c in enumerate(ensure_str(text).upper().replace(" ", "")):
+            # 1) encode with the straddling checkerboard
+            c = enc_map[c] if c in enc_map else _h(c, pos, "".join(digits))
+            # 2) if numeric_key is defined, over-encrypt digits
+            if numeric_key and c.isdigit():
+                for ci in c:
+                    digits.append(str((int(ci) + int(numeric_key[nk_i % nk_l])) % 10))
+                    nk_i += 1
+            else:
+                digits.append(c)
+        r = "".join(d for d in digits if d)
+        # 3) if text mode, convert digits to text
+        if txt:
+            i, r0, l, r = 0, r, len(r), ""
+            while i < len(r0):
+                if int(r0[i]) in blanks:
+                    r += dec_map[r0[i] + ("0" if i == l - 1 else r0[i+1])]
+                    i += 1
+                else:
+                    r += dec_map[r0[i]]
+                i += 1
+        return r, len(r)
+    return _encode
+
+
+def vic_decode(key=None, blanks=None, numeric_key=None):
+    key, blanks, numeric_key, rev, txt = __set_params(key, blanks, numeric_key)
+    enc_map, dec_map = __build_checkerboard(__build_alphabet(key, reverse=rev), blanks[0], blanks[1])
+    def _decode(text, errors="strict"):
+        _h = handle_error("vic", errors, decode=True)
+        # 1) if text mode, convert text to digits
+        text = "".join(enc_map[c] for c in ensure_str(text)) if txt else ensure_str(text)
+        # 2) if numeric_key is defined, over-decrypt
+        digits, nk_i, nk_l = [], 0, len(numeric_key or "")
+        for pos, c in enumerate(text):
+            if numeric_key and c.isdigit():
+                for ci in c:
+                    digits.append(str((int(c) - int(numeric_key[nk_i % nk_l])) % 10))
+                    nk_i += 1
+            else:
+                digits.append(c if c.isdigit() else _h(c, pos, "".join(digits)))
+        # 3) decode with the straddling checkerboard
+        i, r, r0 = 0, "", "".join(d for d in digits if d)
+        while i < (l := len(r0)):
+            if int(r0[i]) in blanks:
+                r += r0[i] if i == l - 1 else dec_map[r0[i] + r0[i+1]]
+                i += 1
+            else:
+                r += dec_map[r0[i]] if r0[i] in dec_map else _h(r0[i], i, r)
+            i += 1
+        return r, len(r)
+    return _decode
+
+
+add("vic", vic_encode, vic_decode, r"vic(?:[-_]([\^*./a-zA-Z]+))?(?:[-_]([0-9]{2}))?(?:[-_]([0-9]+T?))?$",
+    printables_rate=1., penalty=.1)
+

{codext-1.16.2 → codext-1.16.3}/src/codext.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codext
-Version: 1.16.2
+Version: 1.16.3
 Summary: Native codecs extension
 Author-email: Alexandre D'Hondt <alexandre.dhondt@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -1041,6 +1041,7 @@ This category also contains `ascii85`, `adobe`, `[x]btoa`, `zeromq` with the `ba
 - [X] `scytaleN`: encrypts using the number of letters on the rod (*N* belongs to [1,[)
 - [X] `shiftN`: shift ordinals (*N* belongs to [1,255])
 - [X] `trithemius`: aka Trithemius Cipher (variant of Vigenere Cipher)
+- [X] `vic`: aka VIC Cipher
 - [X] `vigenere`: aka Vigenere Cipher
 - [X] `xorN`: XOR with a single byte (*N* belongs to [1,255])
 

{codext-1.16.2 → codext-1.16.3}/src/codext.egg-info/SOURCES.txt

@@ -91,6 +91,7 @@ src/codext/crypto/railfence.py
 src/codext/crypto/rot.py
 src/codext/crypto/scytale.py
 src/codext/crypto/shift.py
+src/codext/crypto/vic.py
 src/codext/crypto/vigenere.py
 src/codext/crypto/xor.py
 src/codext/hashing/__init__.py

codext-1.16.2/src/codext/VERSION.txt

@@ -1 +0,0 @@
-1.16.2

codext-1.16.2/src/codext/crypto/phillips.py

@@ -1,128 +0,0 @@
-# -*- coding: UTF-8 -*-
-"""Phillips Cipher Codec - phillips content encoding.
-
-The Phillips cipher is a polyalphabetic substitution cipher using 8 key
-squares.  The first square is a 5×5 grid built from a keyword (I and J share
-one cell).  Seven additional squares are derived by rotating every row of the
-previous square one step to the left.  Plaintext is enciphered in bigrams,
-each pair using the next square in a cycle of 8.  Non-alphabetic characters
-are passed through unchanged; J is treated as I.
-
-This codec:
-- en/decodes strings from str to str
-- en/decodes strings from bytes to bytes
-- decodes file content to str (read)
-- encodes file content from str to bytes (write)
-
-Reference: https://www.dcode.fr/phillips-cipher
-"""
-from ..__common__ import *
-
-
-__examples__ = {
-    'enc(phillips)':             None,
-    'enc(phillips-key)':         {'ATTACK': 'BSSBIC', 'TESTME': 'QBTPLY', 'ABCDEF': 'BKDFYD'},
-    'enc-dec(phillips-key)':     ['ATTACK', 'TESTME', 'ABCDEF'],
-    'enc-dec(phillips-secret)':  ['HELLOWORLD', 'ATTACKATDAWN'],
-}
-__guess__ = ["phillips-key", "phillips-secret", "phillips-password"]
-
-
-_ALPHABET = "ABCDEFGHIKLMNOPQRSTUVWXYZ"
-
-
-def __make_grids(key):
-    """Return all 8 grids: the initial grid plus 7 row-rotated variants."""
-    # build the initial 5×5 grid from a keyword (J treated as I)
-    seen, letters = set(), []
-    for c in key.upper().replace("J", "I") + _ALPHABET:
-        if c in set(_ALPHABET) and c not in seen:
-            letters.append(c)
-            seen.add(c)
-    grid = [letters[i * 5:(i + 1) * 5] for i in range(5)]
-    # now build the other 7 row-rotated variant grids
-    grids = [grid]
-    for _ in range(7):
-        grid = [row[1:] + [row[0]] for row in grid]
-        grids.append(grid)
-    return grids
-
-
-def __process_pair(a, b, grid, decode=False):
-    """Encode or decode a letter pair using Playfair substitution rules.
-
-    Same row   → each letter shifts one step right (encode) / left (decode).
-    Same col   → each letter shifts one step down  (encode) / up   (decode).
-    Rectangle  → each letter moves to the other's column (self-inverse).
-    """
-    pos = {ch: (r, c) for r, row in enumerate(grid) for c, ch in enumerate(row)}
-    r1, c1 = pos[a]
-    r2, c2 = pos[b]
-    d = -1 if decode else 1
-    if r1 == r2:
-        return grid[r1][(c1 + d) % 5], grid[r2][(c2 + d) % 5]
-    if c1 == c2:
-        return grid[(r1 + d) % 5][c1], grid[(r2 + d) % 5][c2]
-    return grid[r1][c2], grid[r2][c1]  # rectangle rule is its own inverse
-
-
-def phillips_encode(key):
-    _key = (key or "").strip()
-    # Compute grids eagerly if key is valid; otherwise defer error to call time
-    _grids = __make_grids(_key) if _key and _key.isalpha() else None
-    def encode(text, errors="strict"):
-        if _grids is None:
-            raise LookupError("Bad parameter for encoding 'phillips': "
-                              "key must be a non-empty alphabetic string")
-        t = ensure_str(text).upper().replace("J", "I")
-        alpha = [(i, c) for i, c in enumerate(t) if c in set(_ALPHABET)]
-        # Pad to an even count with a trailing X
-        padding_char = None
-        if len(alpha) % 2 == 1:
-            alpha.append((-1, "X"))
-        enc_map = {}
-        for pair_num, k in enumerate(range(0, len(alpha), 2)):
-            pos1, a = alpha[k]
-            pos2, b = alpha[k + 1]
-            e1, e2 = __process_pair(a, b, _grids[pair_num % 8])
-            enc_map[pos1] = e1
-            if pos2 >= 0:
-                enc_map[pos2] = e2
-            else:
-                padding_char = e2
-        result = [enc_map.get(i, c) for i, c in enumerate(t)]
-        if padding_char is not None:
-            result.append(padding_char)
-        return "".join(result), len(text)
-    return encode
-
-
-def phillips_decode(key):
-    _key = (key or "").strip()
-    # Compute grids eagerly if key is valid; otherwise defer error to call time
-    _grids = __make_grids(_key) if _key and _key.isalpha() else None
-    def decode(text, errors="strict"):
-        if _grids is None:
-            raise LookupError("Bad parameter for decoding 'phillips': "
-                              "key must be a non-empty alphabetic string")
-        t = ensure_str(text).upper().replace("J", "I")
-        alpha = [(i, c) for i, c in enumerate(t) if c in set(_ALPHABET)]
-        if len(alpha) % 2 == 1:
-            if errors == "strict":
-                raise ValueError("phillips: encoded text must contain an even "
-                                 "number of alphabetic characters")
-            alpha = alpha[:-1]
-        dec_map = {}
-        for pair_num, k in enumerate(range(0, len(alpha), 2)):
-            pos1, a = alpha[k]
-            pos2, b = alpha[k + 1]
-            d1, d2 = __process_pair(a, b, _grids[pair_num % 8], decode=True)
-            dec_map[pos1] = d1
-            dec_map[pos2] = d2
-        return "".join(dec_map.get(i, c) for i, c in enumerate(t)), len(text)
-    return decode
-
-
-add("phillips", phillips_encode, phillips_decode, r"^phillips(?:[-_]cipher)?(?:[-_]([a-zA-Z]+))?$", printables_rate=1.,
-    penalty=.1)
-