Restructure ChaosCrypt from a single-file script into a complete, installable Python package with three interfaces: a typed Python API, an argument-driven CLI, and a bilingual interactive TUI. The algorithm itself is unchanged. Ciphertexts and key files remain fully interoperable with the original implementation in both directions, which is enforced by dedicated tests rather than merely documented. Added - Library API: ChaosCrypt facade plus ChaosCryptCore for the raw algorithm - Unified error hierarchy: 16 named types, all ChaosCryptError subclasses, rendering as ChaosCrypt_ERR_<Detail>_<Code> - CLI: keygen, encrypt, decrypt, file, info, chpwd, tui, with --json output, stdin/stdout piping, and three password sources per secret - Bilingual TUI: English default, runtime switch to Chinese, getpass password entry with a non-TTY fallback that keeps it scriptable - Binary and file support: encrypt_bytes/decrypt_bytes and encrypt_file/decrypt_file - Key management: change_key_password rewraps without altering key material; export_key_text/load_from_text move a key without touching disk - Documentation: SECURITY.md with the full design and threat analysis, plus docs/ covering the API, CLI, architecture and build process - Test suite: 92 tests across round-trips, binary safety, key management, error types, CLI, TUI, i18n and legacy interoperability - Packaging: pyproject.toml, setup.py compatibility shim, MANIFEST.in, py.typed, examples, MIT licence Fixed - Conflicting --pwd option between the -p and -P groups prevented the CLI from starting at all - Wrong key file password reported as file corruption (E002); structural validation now distinguishes it from a damaged file (E003) - export_key_text produced key material without loading it into the instance - Non-hexadecimal input was accepted as ciphertext and silently decrypted into garbage, making corruption indistinguishable from success; malformed input now raises E010 before any processing - TUI failed under piped input because getpass requires a TTY - TUI kept reading the default key file name after generating a new one Changed - Source tree reorganised: the package lives at chaoscrypt/, with tests, examples and legacy alongside it; documentation and build artefacts at the repository root - Code comments unified in English; public docstrings document parameters, return values and raised exceptions - English is now the default UI language - ChaosCryptChat removed from the repository - Attribution updated to Dvs (DvsXT); project URLs point to Gitea
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# Documentation
|
|
|
|
Reference material for ChaosCrypt.
|
|
|
|
| Document | Contents |
|
|
|---|---|
|
|
| [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 |
|
|
| [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 |
|
|
| [../CHANGELOG.md](../CHANGELOG.md) | Release history |
|
|
|
|
---
|
|
|
|
## Where to start
|
|
|
|
**Evaluating whether ChaosCrypt suits your use case**
|
|
Read the [Scope](../README.md#scope) section of the README, then
|
|
[SECURITY.md](../SECURITY.md) for the full analysis.
|
|
|
|
**Using the library in Python**
|
|
[API.md](API.md) — start with the `ChaosCrypt` facade and the error table.
|
|
|
|
**Using the command line**
|
|
[CLI.md](CLI.md) — covers every subcommand, plus pipelines and shell aliases.
|
|
|
|
**Understanding how it works**
|
|
[ARCHITECTURE.md](ARCHITECTURE.md) for the code structure, and
|
|
[SECURITY.md §3](../SECURITY.md) for the algorithm itself.
|
|
|
|
**Contributing or building a release**
|
|
[BUILDING.md](BUILDING.md).
|