Contributions are welcome. This project values clarity, safety, and honest reporting over feature count.
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"
pytest- Checks return findings; they never print or exit. The numbered scripts and the orchestrator are the only places that touch I/O and process exit codes.
- Separate observation from proof. Use
statushonestly:confirmedonly for reproducible, in-scope demonstrations; otherwisesuspected/inconclusivewith amanual_verificationnote. - Safety first. All network traffic goes through
HttpClient, which enforces scope and the request budget. Do not bypass it. - No secrets, ever. Never log or serialise raw credentials. Use
authentication.redactandIdentity.safe_summary. - Offline tests. Tests must not depend on the public internet. Use
httpx.MockTransportand the bundledapi_pentesting.demo.LabApp.
- Add a module under
src/api_pentesting/checks/exposing arun_*/auditfunction that returnslist[Finding]. - Cite OWASP references via
checks/_common.py. - Add unit tests covering a secure posture (quiet) and a vulnerable posture (fires) using the lab target.
- To expose it in the orchestrator, register a category runner in
orchestrator.py(CATEGORY_RUNNERS). - If it warrants a standalone entry point, add a numbered script and a guide in
docs/scripts/.
- Python 3.10+, type hints where they add clarity.
- Short functions, explicit names, docstrings stating purpose/params/returns/limits.
- Keep dependencies minimal and justified.
pytestpasses.- New behaviour has tests.
- No secrets, no real target URLs, no committed reports.
- Docs updated if behaviour or CLI changed.