| 1 | # rfc_exchange.py DOX |
| 2 | |
| 3 | ## Purpose |
| 4 | |
| 5 | - Own the `rfc_exchange.py` helper module. |
| 6 | - This module handles privileged RFC exchange data such as root password provisioning. |
| 7 | - Keep this file-level DOX profile synchronized with `rfc_exchange.py` because this directory is intentionally flat. |
| 8 | |
| 9 | ## Ownership |
| 10 | |
| 11 | - `rfc_exchange.py` owns the runtime implementation. |
| 12 | - `rfc_exchange.py.dox.md` owns durable notes about responsibilities, contracts, side effects, and verification for that implementation. |
| 13 | - Top-level functions: |
| 14 | - `async get_root_password()` |
| 15 | - `_provide_root_password(public_key_pem: str)` |
| 16 | - `_get_root_password()` |
| 17 | |
| 18 | ## Runtime Contracts |
| 19 | |
| 20 | - Helper modules own reusable framework APIs and must preserve public callers unless all callers, tests, and docs are updated together. |
| 21 | - Update this file whenever public functions, classes, persistence behavior, path/security assumptions, side effects, or cross-module contracts change. |
| 22 | - Imported dependency areas include: `helpers`. |
| 23 | |
| 24 | ## Key Concepts |
| 25 | |
| 26 | - Important called helpers/classes observed in the source: `runtime.is_dockerized`, `_get_root_password`, `crypto.encrypt_data`, `crypto._generate_private_key`, `crypto._generate_public_key`, `crypto.decrypt_data`, `dotenv.get_dotenv_value`, `runtime.call_development_function`. |
| 27 | - Keep request/response, tool, or helper semantics documented here at the same time as source changes. |
| 28 | |
| 29 | ## Work Guidance |
| 30 | |
| 31 | - Preserve public helper APIs used by core code and plugins unless every caller is updated. |
| 32 | - Keep path, auth, secret, persistence, network, and subprocess behavior explicit and bounded. |
| 33 | - Prefer adding cohesive helper functions here only when behavior is reused across modules. |
| 34 | |
| 35 | ## Verification |
| 36 | |
| 37 | - Run targeted tests for changed helper behavior; run security regressions for auth, filesystem, WebSocket, tunnel, upload, or secret-handling helpers. |
| 38 | - No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check. |
| 39 | |
| 40 | ## Child DOX Index |
| 41 | |
| 42 | No child DOX files. |