# owasp/offat architecture

> Architecture diagram of the GitHub repository owasp/offat, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/owasp/offat
- Repository: https://github.com/owasp/offat

## Overview

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: [`src/offat/tester/handler.py`](https://github.com/owasp/offat/blob/dev/src/offat/tester/handler.py) (Test orchestration), [`src/offat/__main__.py`](https://github.com/owasp/offat/blob/dev/src/offat/__main__.py) (CLI), [`src/offat/parsers/__init__.py`](https://github.com/owasp/offat/blob/dev/src/offat/parsers/__init__.py) (Parser factory), [`src/offat/api/app.py`](https://github.com/owasp/offat/blob/dev/src/offat/api/app.py) (Automation API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_cli["CLI<br/>[__main__.py]"]
  node_api["Automation API<br/>[app.py]"]
  node_api_jobs["Test jobs<br/>[jobs.py]"]
  node_api_config["API configuration<br/>[config.py]"]
end

subgraph group_spec["Specification and configuration"]
  node_spec_factory["Parser factory<br/>[__init__.py]"]
  node_base_parser["Spec validation<br/>[parser.py]"]
  node_oas3_parser["OpenAPI v3 parser<br/>[openapi.py]"]
  node_swagger_parser["Swagger v2 parser<br/>[swagger.py]"]
  node_user_config["User test data"]
end

subgraph group_testing["Security testing"]
  node_test_handler["Test orchestration<br/>[handler.py]"]
  node_test_generator["Test generation<br/>[generator.py]"]
  node_fuzzer["Payload fuzzing<br/>[fuzzer.py]"]
  node_runner["Request runner<br/>[runner.py]"]
  node_http["Async HTTP<br/>[http.py]"]
end

subgraph group_results["Analysis and reporting"]
  node_post_processor["Response analysis"]
  node_report["Report generation<br/>[generator.py]"]
  node_table["Table rendering<br/>[table.py]"]
  node_summary["Result summary<br/>[summary.py]"]
end

node_cli_user(("CLI user"))
node_api_client(("API client"))

node_cli_user -->|"runs"| node_cli
node_api_client -.->|"submits tests"| node_api
node_cli -->|"selects parser"| node_spec_factory
node_cli -->|"loads test data"| node_user_config
node_cli -->|"starts tests"| node_test_handler
node_spec_factory -->|"validates spec"| node_base_parser
node_spec_factory -->|"creates parser"| node_oas3_parser
node_spec_factory -->|"creates parser"| node_swagger_parser
node_test_handler -->|"generates tests"| node_test_generator
node_test_handler -->|"runs requests"| node_runner
node_test_handler -->|"analyzes results"| node_post_processor
node_test_handler -->|"generates reports"| node_report
node_test_generator -->|"uses payloads"| node_fuzzer
node_test_generator -->|"populates inputs"| node_user_config
node_runner -->|"sends requests"| node_http
node_report -->|"renders tables"| node_table
node_api -.->|"dispatches jobs"| node_api_jobs
node_api -.->|"uses settings"| node_api_config
node_api_jobs -.->|"starts tests"| node_test_handler
node_test_handler -.->|"summarizes results"| node_summary

click node_cli "https://github.com/owasp/offat/blob/dev/src/offat/__main__.py"
click node_api "https://github.com/owasp/offat/blob/dev/src/offat/api/app.py"
click node_api_jobs "https://github.com/owasp/offat/blob/dev/src/offat/api/jobs.py"
click node_api_config "https://github.com/owasp/offat/blob/dev/src/offat/api/config.py"
click node_spec_factory "https://github.com/owasp/offat/blob/dev/src/offat/parsers/__init__.py"
click node_base_parser "https://github.com/owasp/offat/blob/dev/src/offat/parsers/parser.py"
click node_oas3_parser "https://github.com/owasp/offat/blob/dev/src/offat/parsers/openapi.py"
click node_swagger_parser "https://github.com/owasp/offat/blob/dev/src/offat/parsers/swagger.py"
click node_user_config "https://github.com/owasp/offat/blob/dev/src/offat/config_data_handler.py"
click node_test_handler "https://github.com/owasp/offat/blob/dev/src/offat/tester/handler.py"
click node_test_generator "https://github.com/owasp/offat/blob/dev/src/offat/tester/generator.py"
click node_fuzzer "https://github.com/owasp/offat/blob/dev/src/offat/tester/fuzzer.py"
click node_runner "https://github.com/owasp/offat/blob/dev/src/offat/tester/runner.py"
click node_http "https://github.com/owasp/offat/blob/dev/src/offat/http.py"
click node_post_processor "https://github.com/owasp/offat/blob/dev/src/offat/tester/post_test_processor.py"
click node_report "https://github.com/owasp/offat/blob/dev/src/offat/report/generator.py"
click node_table "https://github.com/owasp/offat/blob/dev/src/offat/report/templates/table.py"
click node_summary "https://github.com/owasp/offat/blob/dev/src/offat/report/summary.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_api,node_api_jobs,node_api_config,node_cli_user,node_api_client toneBlue
class node_spec_factory,node_base_parser,node_oas3_parser,node_swagger_parser,node_user_config toneAmber
class node_test_handler,node_test_generator,node_fuzzer,node_runner,node_http toneMint
class node_post_processor,node_report,node_table,node_summary toneRose
```

## Components

### User entry points

- [CLI](https://github.com/owasp/offat/blob/dev/src/offat/__main__.py): `src/offat/__main__.py`
- [Automation API](https://github.com/owasp/offat/blob/dev/src/offat/api/app.py): `src/offat/api/app.py`
- [Test jobs](https://github.com/owasp/offat/blob/dev/src/offat/api/jobs.py): `src/offat/api/jobs.py`
- [API configuration](https://github.com/owasp/offat/blob/dev/src/offat/api/config.py): `src/offat/api/config.py`

### Specification and configuration

- [Parser factory](https://github.com/owasp/offat/blob/dev/src/offat/parsers/__init__.py): `src/offat/parsers/__init__.py`
- [Spec validation](https://github.com/owasp/offat/blob/dev/src/offat/parsers/parser.py): `src/offat/parsers/parser.py`
- [OpenAPI v3 parser](https://github.com/owasp/offat/blob/dev/src/offat/parsers/openapi.py): `src/offat/parsers/openapi.py`
- [Swagger v2 parser](https://github.com/owasp/offat/blob/dev/src/offat/parsers/swagger.py): `src/offat/parsers/swagger.py`
- [User test data](https://github.com/owasp/offat/blob/dev/src/offat/config_data_handler.py): `src/offat/config_data_handler.py`

### Security testing

- [Test orchestration](https://github.com/owasp/offat/blob/dev/src/offat/tester/handler.py): `src/offat/tester/handler.py`
- [Test generation](https://github.com/owasp/offat/blob/dev/src/offat/tester/generator.py): `src/offat/tester/generator.py`
- [Payload fuzzing](https://github.com/owasp/offat/blob/dev/src/offat/tester/fuzzer.py): `src/offat/tester/fuzzer.py`
- [Request runner](https://github.com/owasp/offat/blob/dev/src/offat/tester/runner.py): `src/offat/tester/runner.py`
- [Async HTTP](https://github.com/owasp/offat/blob/dev/src/offat/http.py): `src/offat/http.py`

### Analysis and reporting

- [Response analysis](https://github.com/owasp/offat/blob/dev/src/offat/tester/post_test_processor.py): `src/offat/tester/post_test_processor.py`
- [Report generation](https://github.com/owasp/offat/blob/dev/src/offat/report/generator.py): `src/offat/report/generator.py`
- [Table rendering](https://github.com/owasp/offat/blob/dev/src/offat/report/templates/table.py): `src/offat/report/templates/table.py`
- [Result summary](https://github.com/owasp/offat/blob/dev/src/offat/report/summary.py): `src/offat/report/summary.py`

### Other components

- **CLI user**
- **API client**

## Connections

- CLI user → CLI: runs (evidence: `src/offat/__main__.py`)
- API client → Automation API: submits tests (evidence: `README.md`)
- CLI → Parser factory: selects parser (evidence: `src/offat/__main__.py`)
- CLI → User test data: loads test data (evidence: `src/offat/__main__.py`)
- CLI → Test orchestration: starts tests (evidence: `src/offat/__main__.py`)
- Parser factory → Spec validation: validates spec (evidence: `src/offat/parsers/__init__.py`)
- Parser factory → OpenAPI v3 parser: creates parser (evidence: `src/offat/parsers/__init__.py`)
- Parser factory → Swagger v2 parser: creates parser (evidence: `src/offat/parsers/__init__.py`)
- Test orchestration → Test generation: generates tests (evidence: `src/offat/tester/handler.py`)
- Test orchestration → Request runner: runs requests (evidence: `src/offat/tester/handler.py`)
- Test orchestration → Response analysis: analyzes results (evidence: `src/offat/tester/handler.py`)
- Test orchestration → Report generation: generates reports (evidence: `src/offat/tester/handler.py`)
- Test generation → Payload fuzzing: uses payloads (evidence: `src/offat/tester/generator.py`)
- Test generation → User test data: populates inputs (evidence: `src/offat/tester/generator.py`)
- Request runner → Async HTTP: sends requests (evidence: `src/offat/tester/runner.py`)
- Report generation → Table rendering: renders tables (evidence: `src/offat/report/generator.py`)
- Automation API → Test jobs: dispatches jobs (evidence: `src/offat/api/app.py`)
- Automation API → API configuration: uses settings (evidence: `src/offat/api/app.py`)
- Test jobs → Test orchestration: starts tests (evidence: `src/offat/api/jobs.py`)
- Test orchestration → Result summary: summarizes results (evidence: `src/offat/tester/handler.py`)
