mitm-core / ProxyConfig

Type Alias: ProxyConfig

ProxyConfig = object

Defined in: src/config.registry.ts:6

Configuration options for the proxy server, controlling caching, TLS certificate handling, default pipeline registration, and timeouts.

Properties

handshakeTimeoutMs?

optional handshakeTimeoutMs?: number

Defined in: src/config.registry.ts:56

Maximum time, in milliseconds, to wait for the client to complete the TLS ClientHello.

Default

10000

---

leafCacheDir?

optional leafCacheDir?: string

Defined in: src/config.registry.ts:19

Directory used to store cached TLS leaf certificates.

Default

"~/.mitm-core"

---

pluginTimeoutMs?

optional pluginTimeoutMs?: number

Defined in: src/config.registry.ts:72

Maximum time, in milliseconds, to wait for plugin execution to finish. Set to 0 to disable the timeout completely.

Default

10000

---

rootCa?

optional rootCa?: object

Defined in: src/config.registry.ts:42

Root Certificate Authority (CA) credentials used to sign generated TLS leaf certificates during HTTPS interception.

The certificate and private key must be compatible CA credentials.

cert

cert: string | Buffer

CA certificate, provided as a PEM string or Buffer.

key

key: string | Buffer

CA private key, provided as a PEM string or Buffer.

---

upstreamTimeoutMs?

optional upstreamTimeoutMs?: number

Defined in: src/config.registry.ts:64

Maximum time, in milliseconds, allowed for an upstream operation before the configured timeout is reached.

Default

30000

---

useCertificateCache?

optional useCertificateCache?: boolean

Defined in: src/config.registry.ts:12

Enables caching of generated TLS leaf certificates.

Default

true

---

useDefaultPipelines?

optional useDefaultPipelines?: boolean

Defined in: src/config.registry.ts:34

Determines whether the default request and response processing pipelines are registered.

Default

true

---

useResponseCache?

optional useResponseCache?: boolean

Defined in: src/config.registry.ts:26

Enables caching of proxy responses to improve performance.

Default

false