| 1 | # crypto.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `crypto.py` helper module. |
| 6 | - This module hashes, verifies, encrypts, and decrypts data for signed or protected payloads. |
| 7 | - Keep this file-level DOX profile synchronized with `crypto.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `crypto.py` owns the runtime implementation. |
| 12 | - `crypto.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Top-level functions: |
| 14 | - `hash_data(data: str, password: str)` |
| 15 | - `verify_data(data: str, hash: str, password: str)` |
| 16 | - `_generate_private_key()` |
| 17 | - `_generate_public_key(private_key: rsa.RSAPrivateKey)` |
| 18 | - `_decode_public_key(public_key: str) -> rsa.RSAPublicKey` |
| 19 | - `encrypt_data(data: str, public_key_pem: str)` |
| 20 | - `_encrypt_data(data: bytes, public_key: rsa.RSAPublicKey)` |
| 21 | - `decrypt_data(data: str, private_key: rsa.RSAPrivateKey)` |
| 22 | |
| 23 | ## Runtime Contracts |
| 24 | |
| 25 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 26 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 27 | - Observed side-effect areas: secret handling. |
| 28 | - Imported dependency areas include: `cryptography.hazmat.primitives`, `cryptography.hazmat.primitives.asymmetric`, `hashlib`, `hmac`, `os`. |
| 29 | |
| 30 | ## Key Concepts |
| 31 | |
| 32 | - Important called helpers/classes observed in the source: `hmac.new.hexdigest`, `rsa.generate_private_key`, `private_key.public_key.public_bytes.hex`, `bytes.fromhex`, `serialization.load_pem_public_key`, `_encrypt_data`, `public_key.encrypt`, `b.hex`, `private_key.decrypt`, `b.decode`, `hash_data`, `TypeError`, `data.encode`, `_decode_public_key`, `padding.OAEP`, `hmac.new`, `private_key.public_key.public_bytes`, `password.encode`, `padding.MGF1`, `hashes.SHA256`. |
| 33 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 34 | |
| 35 | ## Work Guidance |
| 36 | |
| 37 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 38 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 39 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 40 | |
| 41 | ## Verification |
| 42 | |
| 43 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 44 | - No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check. |
| 45 | |
| 46 | ## Child DOX Index |
| 47 | |
| 48 | No child DOX files. |