# drk1wi/modlishka architecture

> Architecture diagram of the GitHub repository drk1wi/modlishka, 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/drk1wi/modlishka
- Repository: https://github.com/drk1wi/modlishka

## Overview

Modlishka is a configurable, plugin-extensible HTTP(S) reverse proxy for authorized security testing and related proxy use cases. Its main workflow loads configuration and plugins, starts HTTP/TLS listeners, routes browser traffic to target domains, and rewrites responses for the proxy domain. The documented credential collection/control panel, dynamic client-domain hooking, and automatic certificate generation are represented as capability branches; some of their wiring is not visible in the sampled excerpts, so those links are marked unverified.

Main entry points: [`plugin/core_plugin.go`](https://github.com/drk1wi/modlishka/blob/master/plugin/core_plugin.go) (Plugin Hooks), [`main.go`](https://github.com/drk1wi/modlishka/blob/master/main.go) (Application Startup), [`core/proxy.go`](https://github.com/drk1wi/modlishka/blob/master/core/proxy.go) (Proxy Transformation), [`core/server.go`](https://github.com/drk1wi/modlishka/blob/master/core/server.go) (Request Routing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Startup and Config"]
  node_entrypoint["Application Startup<br/>[main.go]"]
  node_configuration["Configuration<br/>[config.go]"]
  node_runtime["Runtime Rules<br/>[vars.go]"]
end

subgraph group_proxy["Proxy Runtime"]
  node_listeners["HTTP/TLS Listeners<br/>[server.go]"]
  node_requestrouting["Request Routing<br/>[server.go]"]
  node_proxytransform["Proxy Transformation<br/>[proxy.go]"]
  node_security["Host and SSRF Checks<br/>[security.go]"]
  node_urltranslation["Domain Translation<br/>[func.go]"]
end

subgraph group_plugins["Plugin Capabilities"]
  node_pluginregistry["Plugin Hooks<br/>[core_plugin.go]"]
  node_credentialcapture["Credential Capture<br/>[control.go]"]
  node_controlpanel["Credential Control Panel<br/>[control.go]"]
  node_credentialstore[("Credential Store<br/>[control.go]")]
  node_autocert["TLS Certificate Generation<br/>[autocert.go]"]
  node_hijack["Domain Hook Diagnostics<br/>[hijack.go]"]
  node_templateplugin["Target Templates<br/>[template.go]"]
end

subgraph group_ops["Observability"]
  node_logging["Request Logging<br/>[log.go]"]
end

node_operator(("Operator"))
node_browser(("Browser Client"))
node_origin(("Target Websites"))

node_operator -->|"configures and starts"| node_entrypoint
node_entrypoint -->|"parses options"| node_configuration
node_entrypoint -->|"enables plugins"| node_pluginregistry
node_entrypoint -->|"sets runtime config"| node_runtime
node_entrypoint -->|"starts server"| node_listeners
node_configuration -->|"configures logging"| node_logging
node_browser -->|"sends HTTP&#40;S&#41;"| node_listeners
node_listeners -->|"routes requests"| node_requestrouting
node_requestrouting -->|"checks host and target"| node_security
node_requestrouting -->|"creates and serves proxy"| node_proxytransform
node_requestrouting -.->|"resolves target domains"| node_urltranslation
node_proxytransform -->|"forwards traffic"| node_origin
node_proxytransform -->|"rewrites URLs"| node_runtime
node_proxytransform -->|"invokes response hooks"| node_pluginregistry
node_pluginregistry -.->|"dispatches capture hooks"| node_credentialcapture
node_credentialcapture -.->|"stores captured data"| node_credentialstore
node_controlpanel -.->|"reads and manages entries"| node_credentialstore
node_pluginregistry -.->|"enables certificate plugin"| node_autocert
node_pluginregistry -.->|"dispatches diagnostics"| node_hijack
node_pluginregistry -.->|"enables template support"| node_templateplugin
node_proxytransform -->|"logs proxy activity"| node_logging
node_listeners -->|"registers plugin handlers"| node_pluginregistry

click node_entrypoint "https://github.com/drk1wi/modlishka/blob/master/main.go"
click node_configuration "https://github.com/drk1wi/modlishka/blob/master/config/config.go"
click node_runtime "https://github.com/drk1wi/modlishka/blob/master/runtime/vars.go"
click node_listeners "https://github.com/drk1wi/modlishka/blob/master/core/server.go"
click node_requestrouting "https://github.com/drk1wi/modlishka/blob/master/core/server.go"
click node_proxytransform "https://github.com/drk1wi/modlishka/blob/master/core/proxy.go"
click node_security "https://github.com/drk1wi/modlishka/blob/master/runtime/security.go"
click node_urltranslation "https://github.com/drk1wi/modlishka/blob/master/runtime/func.go"
click node_pluginregistry "https://github.com/drk1wi/modlishka/blob/master/plugin/core_plugin.go"
click node_credentialcapture "https://github.com/drk1wi/modlishka/blob/master/plugin/control.go"
click node_controlpanel "https://github.com/drk1wi/modlishka/blob/master/plugin/control.go"
click node_credentialstore "https://github.com/drk1wi/modlishka/blob/master/plugin/control.go"
click node_autocert "https://github.com/drk1wi/modlishka/blob/master/plugin/autocert.go"
click node_hijack "https://github.com/drk1wi/modlishka/blob/master/plugin/hijack.go"
click node_templateplugin "https://github.com/drk1wi/modlishka/blob/master/plugin/template.go"
click node_logging "https://github.com/drk1wi/modlishka/blob/master/log/log.go"

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_entrypoint,node_configuration,node_runtime,node_browser toneBlue
class node_listeners,node_requestrouting,node_proxytransform,node_security,node_urltranslation toneAmber
class node_pluginregistry,node_credentialcapture,node_controlpanel,node_credentialstore,node_autocert,node_hijack,node_templateplugin toneMint
class node_logging toneRose
class node_operator,node_origin toneIndigo
```

## Components

### Startup and Config

- [Application Startup](https://github.com/drk1wi/modlishka/blob/master/main.go): `main.go`
- [Configuration](https://github.com/drk1wi/modlishka/blob/master/config/config.go): `config/config.go`
- [Runtime Rules](https://github.com/drk1wi/modlishka/blob/master/runtime/vars.go): `runtime/vars.go`

### Proxy Runtime

- [HTTP/TLS Listeners](https://github.com/drk1wi/modlishka/blob/master/core/server.go): `core/server.go`
- [Request Routing](https://github.com/drk1wi/modlishka/blob/master/core/server.go): `core/server.go`
- [Proxy Transformation](https://github.com/drk1wi/modlishka/blob/master/core/proxy.go): `core/proxy.go`
- [Host and SSRF Checks](https://github.com/drk1wi/modlishka/blob/master/runtime/security.go): `runtime/security.go`
- [Domain Translation](https://github.com/drk1wi/modlishka/blob/master/runtime/func.go): `runtime/func.go`

### Plugin Capabilities

- [Plugin Hooks](https://github.com/drk1wi/modlishka/blob/master/plugin/core_plugin.go): `plugin/core_plugin.go`
- [Credential Capture](https://github.com/drk1wi/modlishka/blob/master/plugin/control.go): `plugin/control.go`
- [Credential Control Panel](https://github.com/drk1wi/modlishka/blob/master/plugin/control.go): `plugin/control.go`
- [Credential Store](https://github.com/drk1wi/modlishka/blob/master/plugin/control.go): `plugin/control.go`
- [TLS Certificate Generation](https://github.com/drk1wi/modlishka/blob/master/plugin/autocert.go): `plugin/autocert.go`
- [Domain Hook Diagnostics](https://github.com/drk1wi/modlishka/blob/master/plugin/hijack.go): `plugin/hijack.go`
- [Target Templates](https://github.com/drk1wi/modlishka/blob/master/plugin/template.go): `plugin/template.go`

### Observability

- [Request Logging](https://github.com/drk1wi/modlishka/blob/master/log/log.go): `log/log.go`

### Other components

- **Operator**
- **Browser Client**
- **Target Websites**

## Connections

- Operator → Application Startup: configures and starts (evidence: `README.md`)
- Application Startup → Configuration: parses options (evidence: `main.go`)
- Application Startup → Plugin Hooks: enables plugins (evidence: `main.go`)
- Application Startup → Runtime Rules: sets runtime config (evidence: `main.go`)
- Application Startup → HTTP/TLS Listeners: starts server (evidence: `main.go`)
- Configuration → Request Logging: configures logging (evidence: `config/config.go`)
- Browser Client → HTTP/TLS Listeners: sends HTTP(S) (evidence: `README.md`)
- HTTP/TLS Listeners → Request Routing: routes requests (evidence: `core/server.go`)
- Request Routing → Host and SSRF Checks: checks host and target (evidence: `core/server.go`)
- Request Routing → Proxy Transformation: creates and serves proxy (evidence: `core/server.go`)
- Request Routing → Domain Translation: resolves target domains
- Proxy Transformation → Target Websites: forwards traffic (evidence: `README.md`)
- Proxy Transformation → Runtime Rules: rewrites URLs (evidence: `core/proxy.go`)
- Proxy Transformation → Plugin Hooks: invokes response hooks (evidence: `core/proxy.go`)
- Plugin Hooks → Credential Capture: dispatches capture hooks
- Credential Capture → Credential Store: stores captured data (evidence: `plugin/control.go`)
- Credential Control Panel → Credential Store: reads and manages entries (evidence: `plugin/control.go`)
- Plugin Hooks → TLS Certificate Generation: enables certificate plugin
- Plugin Hooks → Domain Hook Diagnostics: dispatches diagnostics
- Plugin Hooks → Target Templates: enables template support
- Proxy Transformation → Request Logging: logs proxy activity (evidence: `core/proxy.go`)
- HTTP/TLS Listeners → Plugin Hooks: registers plugin handlers (evidence: `core/server.go`)
