Files
dvs dd49043171 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
2026-09-27 22:06:34 +08:00

128 lines
3.8 KiB
TOML

[build-system]
requires = ["setuptools>=77", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "chaoscrypt"
version = "4.2.6"
description = "A chaos-based obfuscation cipher with a bilingual TUI, a full CLI and a clean Python API."
readme = "README.md"
requires-python = ">=3.8"
license = "MIT"
license-files = ["LICENSE"]
authors = [
{ name = "Dvs (DvsXT)", email = "dvs6666@163.com" },
]
maintainers = [
{ name = "Dvs (DvsXT)", email = "dvs6666@163.com" },
]
keywords = [
"encryption",
"cipher",
"obfuscation",
"chaos",
"xor",
"keystream",
"tui",
"cli",
"education",
]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: End Users/Desktop",
"Natural Language :: Chinese (Simplified)",
"Natural Language :: English",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Education",
"Topic :: Security :: Cryptography",
"Topic :: Utilities",
]
# No third-party runtime dependencies: works immediately after `pip install`.
dependencies = []
[project.optional-dependencies]
dev = [
"build>=1.0",
"twine>=4.0",
"pytest>=7.0",
"pytest-cov>=4.0",
]
[project.urls]
Homepage = "https://git.dvscloud.net/dvs/ChaosCrypt"
Documentation = "https://git.dvscloud.net/dvs/ChaosCrypt/src/branch/main/docs"
Source = "https://git.dvscloud.net/dvs/ChaosCrypt"
Changelog = "https://git.dvscloud.net/dvs/ChaosCrypt/src/branch/main/CHANGELOG.md"
"Security Policy" = "https://git.dvscloud.net/dvs/ChaosCrypt/src/branch/main/SECURITY.md"
"Issue Tracker" = "https://git.dvscloud.net/dvs/ChaosCrypt/issues"
[project.scripts]
chaoscrypt = "chaoscrypt.cli:cli_main"
# ---------------------------------------------------------------------------
# Layout
# ---------------------------------------------------------------------------
# ChaosCrypt/ repository root: docs and build artefacts
# ├── README.md SECURITY.md LICENSE CHANGELOG.md
# ├── docs/
# ├── pyproject.toml
# ├── dist/
# └── chaoscrypt/ source tree
# ├── __init__.py the importable package
# ├── _core.py cli.py tui.py errors.py i18n.py
# ├── tests/
# ├── examples/
# └── legacy/
#
# The package sits alongside tests/, examples/ and legacy/ in the same
# directory, so the distribution contents are stated explicitly. Automatic
# discovery would treat those directories as namespace packages and ship them
# in the wheel.
# ---------------------------------------------------------------------------
[tool.setuptools]
py-modules = []
# Listed module by module. Automatic discovery would pick up chaoscrypt.tests,
# which has an __init__.py and would otherwise be installed as part of the
# package; the development directories must stay in the source tree only.
packages = ["chaoscrypt"]
[tool.setuptools.exclude-package-data]
chaoscrypt = [
"tests/*",
"examples/*",
"legacy/*",
]
[tool.setuptools.package-data]
chaoscrypt = ["py.typed"]
[tool.pytest.ini_options]
testpaths = ["chaoscrypt/tests"]
addopts = "-q"
filterwarnings = [
"error::DeprecationWarning:chaoscrypt.*",
]
[tool.coverage.run]
source = ["chaoscrypt"]
[tool.coverage.report]
exclude_lines = [
"pragma: no cover",
"if TYPE_CHECKING:",
"if __name__ == .__main__.:",
]