v4.2.6: Self-describing format, byte pipeline, and a performance pass
Every key file and ciphertext now carries a header that states how it was produced: magic, two fixed markers, and a complete JSON configuration record. A reader takes its parameters from the artefact rather than from the caller. This is an incompatible format change. Headerless input is rejected with E017; pre-4.2.6 material is read through a compatibility API that wraps it in a minimal header and then uses the ordinary path, so the strict path stays strict. Added - Self-describing header on all artefacts, with a normative specification in docs/FORMAT.md - E017 MissingMagicHeader and E018 MalformedHeader - Byte pipeline for turbo and raw: the XOR layers exchange raw bytes rather than hexadecimal text, cutting expansion from 5.33x to 2.00x and raising throughput about 4x. The old behaviour is available as mid="hex". - Selectable output encoding for turbo and raw: hex (2.00x) or base64 (1.33x) - Legacy compatibility API: wrap_legacy, decrypt_legacy, decrypt_legacy_auto, load_legacy_keys - Frozen reference vectors covering every mode, encoding and intermediate - docs/benchmark.md with measured throughput and the profiling behind it Changed - Default mode is fast: byte-for-byte compatible with the original algorithm, roughly 30x quicker - Substitution, case flipping and the printable fold use bytes.translate over precomputed tables - XOR layers use one big-integer operation instead of a per-byte loop - Keystream derivation caches length-independent base material; expansion uses cached translation tables and list accumulation rather than str += - _get_dynamic_key repeats by multiplication. The loop version was quadratic: covering a 5.6 MB intermediate took 866 ms, now 3 ms, output unchanged. - _derive_final_key decodes only the prefix the output consumes - The decrypt path no longer copies or scans the whole artefact: a redundant strip(), a full-string int(payload, 16), and three whole-string slices in strip_header were removed. Decryption at 512 KiB went from 34 to 87 MB/s. - Documentation rewritten for 4.2.6; all eleven markdown files are English Fixed 1. Key derivation is no longer quadratic (_get_dynamic_key and _expand_keystream_slow shared the str += pattern) 2. Two hex-intermediate pipelines were asymmetric, so a turbo or raw artefact written with mid="hex" could not be read back 3. change_key_password and export_key_text wrote artefacts without a header 4. The constructor accepted encoding="base64" while the header records out="base"; both spellings are now accepted 5. A payload that is not valid hexadecimal reports E010 (MalformedCiphertext) rather than E011 (DecryptionFailed) 6. The TUI encoding menu referenced a missing translation Security - Format break from pre-4.2.6 artefacts, documented rather than accidental - fast is not a weaker mode: the frozen vectors assert identical output - The header adds no secrecy and is not authenticated; an application that must detect header tampering should MAC the whole artefact Performance - raw with the default bt intermediate: ~60 MB/s encryption, ~70 MB/s decryption, ciphertext 2.00x the payload - Throughput holds steady from 64 KiB to 1 GiB - The original implementation managed 0.08 MB/s
This commit is contained in:
@@ -7,6 +7,7 @@ Reference material for ChaosCrypt.
|
||||
| [API.md](API.md) | Complete Python API reference |
|
||||
| [CLI.md](CLI.md) | Command line reference, pipelines, troubleshooting |
|
||||
| [ARCHITECTURE.md](ARCHITECTURE.md) | Module map, data flow, design decisions |
|
||||
| [benchmark.md](benchmark.md) | Performance measurements and mode comparison |
|
||||
| [BUILDING.md](BUILDING.md) | Building, testing and releasing |
|
||||
| [../SECURITY.md](../SECURITY.md) | Design, key space, threat model, attack analysis |
|
||||
| [../README.md](../README.md) | Project overview and quick start |
|
||||
@@ -26,6 +27,10 @@ Read the [Scope](../README.md#scope) section of the README, then
|
||||
**Using the command line**
|
||||
[CLI.md](CLI.md) — covers every subcommand, plus pipelines and shell aliases.
|
||||
|
||||
**Choosing a performance mode**
|
||||
[benchmark.md](benchmark.md) for the numbers, [SECURITY.md §4](../SECURITY.md)
|
||||
for what each mode costs in cryptographic margin.
|
||||
|
||||
**Understanding how it works**
|
||||
[ARCHITECTURE.md](ARCHITECTURE.md) for the code structure, and
|
||||
[SECURITY.md §3](../SECURITY.md) for the algorithm itself.
|
||||
|
||||
Reference in New Issue
Block a user