httpkit

package
v0.14.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2026 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Package httpkit builds Bomly's proxy- and CA-aware outbound HTTP clients from explicit configuration or the BOMLY_HTTP_* environment, so hosts, embedded components, and managed plugins share one transport policy.

A ClientProvider owns one reusable transport; Client hands out per-timeout http.Clients over it. Standard HTTP_PROXY, HTTPS_PROXY, and NO_PROXY remain honored when the Bomly-specific settings are absent.

Index

Constants

View Source
const (
	// EnvHTTPProxy is Bomly's explicit outbound HTTP proxy environment variable.
	EnvHTTPProxy = "BOMLY_HTTP_PROXY"
	// EnvHTTPNoProxy is Bomly's explicit proxy bypass list environment variable.
	EnvHTTPNoProxy = "BOMLY_HTTP_NO_PROXY"
	// EnvHTTPProxyType is Bomly's explicit outbound proxy type.
	EnvHTTPProxyType = "BOMLY_HTTP_PROXY_TYPE"
	// EnvHTTPProxyHost is Bomly's explicit outbound proxy host.
	EnvHTTPProxyHost = "BOMLY_HTTP_PROXY_HOST"
	// EnvHTTPProxyPort is Bomly's explicit outbound proxy port.
	EnvHTTPProxyPort = "BOMLY_HTTP_PROXY_PORT"
	// EnvHTTPProxyUsername is Bomly's explicit outbound proxy username.
	EnvHTTPProxyUsername = "BOMLY_HTTP_PROXY_USERNAME"
	// EnvHTTPProxyPassword is Bomly's explicit outbound proxy password.
	EnvHTTPProxyPassword = "BOMLY_HTTP_PROXY_PASSWORD"
	// EnvHTTPCACertFile points to an additional PEM certificate chain for outbound HTTPS.
	EnvHTTPCACertFile = "BOMLY_HTTP_CA_CERT_FILE"
)

Variables

This section is empty.

Functions

func NewClient

func NewClient(config ClientConfig) (*http.Client, error)

NewClient creates an outbound HTTP client using Go's default transport behavior plus Bomly's proxy configuration.

Types

type ClientConfig

type ClientConfig struct {
	ProxyURL      string
	NoProxy       string
	ProxyType     string
	ProxyHost     string
	ProxyPort     int
	ProxyUsername string
	ProxyPassword string
	CACertFile    string
	Timeout       time.Duration
}

ClientConfig configures Bomly's shared outbound HTTP client. External plugins normally obtain this from ClientConfigFromEnv instead of building it by hand, so Bomly-managed proxy and CA settings are honored.

func ClientConfigFromEnv

func ClientConfigFromEnv() ClientConfig

ClientConfigFromEnv returns Bomly-specific HTTP client settings from environment variables. Standard HTTP_PROXY, HTTPS_PROXY, and NO_PROXY are still honored by NewClient when Bomly-specific values are absent.

func (ClientConfig) EffectiveProxyURL

func (config ClientConfig) EffectiveProxyURL() (string, error)

EffectiveProxyURL returns the effective proxy URL after applying Bomly's URL or decomposed proxy settings. It does not inspect standard proxy environment variables.

type ClientProvider

type ClientProvider struct {
	// contains filtered or unexported fields
}

ClientProvider owns reusable HTTP transport state for one Bomly execution or plugin process. Reuse one provider for repeated outbound calls so connection pools, proxy settings, and TLS configuration stay consistent.

func NewClientProvider

func NewClientProvider(config ClientConfig) (*ClientProvider, error)

NewClientProvider creates an HTTP client provider with a reusable transport. Call Client to create timeout-specific clients that share connection pools and TLS/proxy settings.

func NewClientProviderFromEnv

func NewClientProviderFromEnv() (*ClientProvider, error)

NewClientProviderFromEnv creates a provider from Bomly HTTP environment variables, with standard proxy environment variables honored as fallback. Use this in external plugins that make outbound HTTP calls.

func (*ClientProvider) Client

func (p *ClientProvider) Client(timeout time.Duration) *http.Client

Client returns an HTTP client with the requested timeout. A zero timeout uses the provider's configured default timeout.

func (*ClientProvider) CloseIdleConnections

func (p *ClientProvider) CloseIdleConnections()

CloseIdleConnections closes idle connections held by the provider transport.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL