How owasp/offat works
OFFAT is an API security-testing tool: a CLI user or API client supplies an OpenAPI/Swagger specification and optional YAML test data; OFFAT parses the contract, builds and runs security tests against the target API, analyzes responses, and presents or saves results. The principal workflow is visible in the CLI, parser factory, test handler, runner, and report modules. The README also documents an automation API and Dockerized use; API internals are represented cautiously because their routing behavior was not excerpted.
Main entry points: handler.py Test orchestration · __main__.py CLI · __init__.py Parser factory · app.py Automation API
Components 20
User entry points
- CLI
src/offat/__main__.py - Automation API
src/offat/api/app.py - Test jobs
src/offat/api/jobs.py - API configuration
src/offat/api/config.py
Specification and configuration
- Parser factory
src/offat/parsers/__init__.py - Spec validation
src/offat/parsers/parser.py - OpenAPI v3 parser
src/offat/parsers/openapi.py - Swagger v2 parser
src/offat/parsers/swagger.py - User test data
src/offat/config_data_handler.py
Security testing
- Test orchestration
src/offat/tester/handler.py - Test generation
src/offat/tester/generator.py - Payload fuzzing
src/offat/tester/fuzzer.py - Request runner
src/offat/tester/runner.py - Async HTTP
src/offat/http.py
Analysis and reporting
- Response analysis
src/offat/tester/post_test_processor.py - Report generation
src/offat/report/generator.py - Table rendering
src/offat/report/templates/table.py - Result summary
src/offat/report/summary.py
Other components
- CLI user
- API client
Connections 20
- CLI user → CLI: runs
src/offat/__main__.py - API client → Automation API: submits tests
README.md - CLI → Parser factory: selects parser
src/offat/__main__.py - CLI → User test data: loads test data
src/offat/__main__.py - CLI → Test orchestration: starts tests
src/offat/__main__.py - Parser factory → Spec validation: validates spec
src/offat/parsers/__init__.py - Parser factory → OpenAPI v3 parser: creates parser
src/offat/parsers/__init__.py - Parser factory → Swagger v2 parser: creates parser
src/offat/parsers/__init__.py - Test orchestration → Test generation: generates tests
src/offat/tester/handler.py - Test orchestration → Request runner: runs requests
src/offat/tester/handler.py - Test orchestration → Response analysis: analyzes results
src/offat/tester/handler.py - Test orchestration → Report generation: generates reports
src/offat/tester/handler.py - Test generation → Payload fuzzing: uses payloads
src/offat/tester/generator.py - Test generation → User test data: populates inputs
src/offat/tester/generator.py - Request runner → Async HTTP: sends requests
src/offat/tester/runner.py - Report generation → Table rendering: renders tables
src/offat/report/generator.py - Automation API → Test jobs: dispatches jobs
src/offat/api/app.py - Automation API → API configuration: uses settings
src/offat/api/app.py - Test jobs → Test orchestration: starts tests
src/offat/api/jobs.py - Test orchestration → Result summary: summarizes results
src/offat/tester/handler.py