httpconfig

package
v0.0.0-...-385b71e Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2025 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// DefaultHTTPClientConfig is the default HTTP client configuration.
	DefaultHTTPClientConfig = HTTPClientConfig{
		FollowRedirects: true,
		EnableHTTP2:     true,
	}
)
View Source 
var MarshalSecretValue bool = false

MarshalSecretValue if set to true will expose Secret type through the marshal interfaces. Useful for outside projects that load and marshal the Prometheus config.

View Source 
var TLSVersions = map[string]TLSVersion{
	"TLS13": (TLSVersion)(tls.VersionTLS13),
	"TLS12": (TLSVersion)(tls.VersionTLS12),
	"TLS11": (TLSVersion)(tls.VersionTLS11),
	"TLS10": (TLSVersion)(tls.VersionTLS10),
}

Functions

func JoinDir 

func JoinDir(dir, path string) string

JoinDir joins dir and path if path is relative. If path is empty or absolute, it is returned unchanged.

func NewAuthorizationCredentialsRoundTripper 

func NewAuthorizationCredentialsRoundTripper(authType string, authCredentials SecretReader, rt http.RoundTripper) http.RoundTripper

NewAuthorizationCredentialsRoundTripper adds the authorization credentials read from the provided SecretReader to a request unless the authorization header has already been set.

func NewBasicAuthRoundTripper 

func NewBasicAuthRoundTripper(username SecretReader, password SecretReader, rt http.RoundTripper) http.RoundTripper

NewBasicAuthRoundTripper will apply a BASIC auth authorization header to a request unless it has already been set.

func NewClientFromConfig 

func NewClientFromConfig(cfg HTTPClientConfig, name string, optFuncs ...HTTPClientOption) (*http.Client, error)

NewClientFromConfig returns a new HTTP client configured for the given config.HTTPClientConfig and config.HTTPClientOption. The name is used as go-conntrack metric label.

func NewHeadersRoundTripper 

func NewHeadersRoundTripper(config *Headers, next http.RoundTripper) http.RoundTripper

NewHeadersRoundTripper returns a RoundTripper that sets HTTP headers on requests as configured.

func NewHostRoundTripper 

func NewHostRoundTripper(host string, rt http.RoundTripper) http.RoundTripper

NewHostRoundTripper sets the http.Request.Host of every request.

func NewOAuth2RoundTripper 

func NewOAuth2RoundTripper(clientSecret SecretReader, config *OAuth2, next http.RoundTripper, opts *httpClientOptions) http.RoundTripper

func NewRoundTripperFromConfig 

func NewRoundTripperFromConfig(cfg HTTPClientConfig, name string, optFuncs ...HTTPClientOption) (http.RoundTripper, error)

NewRoundTripperFromConfig returns a new HTTP RoundTripper configured for the given config.HTTPClientConfig and config.HTTPClientOption. The name is used as go-conntrack metric label.

func NewRoundTripperFromConfigWithContext 

func NewRoundTripperFromConfigWithContext(ctx context.Context, cfg HTTPClientConfig, name string, optFuncs ...HTTPClientOption) (http.RoundTripper, error)

NewRoundTripperFromConfigWithContext returns a new HTTP RoundTripper configured for the given config.HTTPClientConfig and config.HTTPClientOption. The name is used as go-conntrack metric label.

func NewTLSConfig 

func NewTLSConfig(cfg *TLSConfig, optFuncs ...TLSConfigOption) (*tls.Config, error)

NewTLSConfig creates a new tls.Config from the given TLSConfig.

func NewTLSConfigWithContext 

func NewTLSConfigWithContext(ctx context.Context, cfg *TLSConfig, optFuncs ...TLSConfigOption) (*tls.Config, error)

NewTLSConfigWithContext creates a new tls.Config from the given TLSConfig.

func NewTLSRoundTripper 

func NewTLSRoundTripper(
	cfg *tls.Config,
	settings TLSRoundTripperSettings,
	newRT func(*tls.Config) (http.RoundTripper, error),
) (http.RoundTripper, error)

func NewTLSRoundTripperWithContext 

func NewTLSRoundTripperWithContext(
	ctx context.Context,
	cfg *tls.Config,
	settings TLSRoundTripperSettings,
	newRT func(*tls.Config) (http.RoundTripper, error),
) (http.RoundTripper, error)

func NewUserAgentRoundTripper 

func NewUserAgentRoundTripper(userAgent string, rt http.RoundTripper) http.RoundTripper

NewUserAgentRoundTripper adds the user agent every request header.

func WithSecretManager 

func WithSecretManager(manager SecretManager) *secretManagerOption

WithSecretManager allows setting the secret manager.

Types

type Authorization 

type Authorization struct {
	Type            string `yaml:"type,omitempty" json:"type,omitempty"`
	Credentials     Secret `yaml:"credentials,omitempty" json:"credentials,omitempty"`
	CredentialsFile string `yaml:"credentials_file,omitempty" json:"credentialsFile,omitempty"`
	// CredentialsRef is the name of the secret within the secret manager to use as credentials.
	CredentialsRef string `yaml:"credentials_ref,omitempty" json:"credentialsRef,omitempty"`
}

Authorization contains HTTP authorization credentials.

func (*Authorization) SetDirectory 

func (a *Authorization) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

type BasicAuth 

type BasicAuth struct {
	Username     string `yaml:"username" json:"username"`
	UsernameFile string `yaml:"username_file,omitempty" json:"usernameFile,omitempty"`
	// UsernameRef is the name of the secret within the secret manager to use as the username.
	UsernameRef  string `yaml:"username_ref,omitempty" json:"usernameRef,omitempty"`
	Password     Secret `yaml:"password,omitempty" json:"password,omitempty"`
	PasswordFile string `yaml:"password_file,omitempty" json:"passwordFile,omitempty"`
	// PasswordRef is the name of the secret within the secret manager to use as the password.
	PasswordRef string `yaml:"password_ref,omitempty" json:"passwordRef,omitempty"`
}

BasicAuth contains basic HTTP authentication credentials.

func (*BasicAuth) SetDirectory 

func (a *BasicAuth) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (*BasicAuth) UnmarshalYAML 

func (a *BasicAuth) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type DialContextFunc 

type DialContextFunc func(context.Context, string, string) (net.Conn, error)

DialContextFunc defines the signature of the DialContext() function implemented by net.Dialer.

type DirectorySetter 

type DirectorySetter interface {
	// SetDirectory joins any relative file paths with dir.
	// Any paths that are empty or absolute remain unchanged.
	SetDirectory(dir string)
}

DirectorySetter is a config type that contains file paths that may be relative to the file containing the config.

type FileSecret 

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

func NewFileSecret 

func NewFileSecret(file string) *FileSecret

func (*FileSecret) Description 

func (s *FileSecret) Description() string

func (*FileSecret) Fetch 

func (s *FileSecret) Fetch(ctx context.Context) (string, error)

func (*FileSecret) Immutable 

func (s *FileSecret) Immutable() bool

type HTTPClientConfig 

type HTTPClientConfig struct {
	// The HTTP basic authentication credentials for the targets.
	BasicAuth *BasicAuth `yaml:"basic_auth,omitempty" json:"basicAuth,omitempty"`
	// The HTTP authorization credentials for the targets.
	Authorization *Authorization `yaml:"authorization,omitempty" json:"authorization,omitempty"`
	// The OAuth2 client credentials used to fetch a token for the targets.
	OAuth2 *OAuth2 `yaml:"oauth2,omitempty" json:"oauth2,omitempty"`
	// The bearer token for the targets. Deprecated in favour of
	// Authorization.Credentials.
	BearerToken Secret `yaml:"bearer_token,omitempty" json:"bearerToken,omitempty"`
	// The bearer token file for the targets. Deprecated in favour of
	// Authorization.CredentialsFile.
	BearerTokenFile string `yaml:"bearer_token_file,omitempty" json:"bearerTokenFile,omitempty"`
	// TLSConfig to use to connect to the targets.
	TLSConfig TLSConfig `yaml:"tls_config,omitempty" json:"tlsConfig,omitempty"`
	// FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
	// The omitempty flag is not set, because it would be hidden from the
	// marshalled configuration when set to false.
	FollowRedirects bool `yaml:"follow_redirects" json:"followRedirects"`
	// EnableHTTP2 specifies whether the client should configure HTTP2.
	// The omitempty flag is not set, because it would be hidden from the
	// marshalled configuration when set to false.
	EnableHTTP2 bool `yaml:"enable_http2" json:"enableHttp2"`
	// Proxy configuration.
	ProxyConfig `yaml:",inline"`
	// HTTPHeaders specify headers to inject in the requests. Those headers
	// could be marshalled back to the users.
	HTTPHeaders *Headers `yaml:"http_headers,omitempty" json:"httpHeaders,omitempty"`
}

HTTPClientConfig configures an HTTP client.

func LoadHTTPConfig 

func LoadHTTPConfig(s string) (*HTTPClientConfig, error)

LoadHTTPConfig parses the YAML input s into a HTTPClientConfig.

func LoadHTTPConfigFile 

func LoadHTTPConfigFile(filename string) (*HTTPClientConfig, []byte, error)

LoadHTTPConfigFile parses the given YAML file into a HTTPClientConfig.

func (*HTTPClientConfig) SetDirectory 

func (c *HTTPClientConfig) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (HTTPClientConfig) String 

func (c HTTPClientConfig) String() string

func (*HTTPClientConfig) UnmarshalJSON 

func (c *HTTPClientConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Marshaler interface for URL.

func (*HTTPClientConfig) UnmarshalYAML 

func (c *HTTPClientConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface

func (*HTTPClientConfig) Validate 

func (c *HTTPClientConfig) Validate() error

Validate validates the HTTPClientConfig to check only one of BearerToken, BasicAuth and BearerTokenFile is configured. It also validates that ProxyURL is set if ProxyConnectHeader is set.

type HTTPClientOption 

type HTTPClientOption interface {
	// contains filtered or unexported methods
}

HTTPClientOption defines an option that can be applied to the HTTP client.

func WithDialContextFunc 

func WithDialContextFunc(fn DialContextFunc) HTTPClientOption

WithDialContextFunc allows you to override func gets used for the actual dialing. The default is `net.Dialer.DialContext`.

func WithHTTP2Disabled 

func WithHTTP2Disabled() HTTPClientOption

WithHTTP2Disabled allows to disable HTTP2.

func WithHost 

func WithHost(host string) HTTPClientOption

WithHost allows setting the host header.

func WithIdleConnTimeout 

func WithIdleConnTimeout(timeout time.Duration) HTTPClientOption

WithIdleConnTimeout allows setting the idle connection timeout.

func WithKeepAlivesDisabled 

func WithKeepAlivesDisabled() HTTPClientOption

WithKeepAlivesDisabled allows to disable HTTP keepalive.

func WithUserAgent 

func WithUserAgent(ua string) HTTPClientOption

WithUserAgent allows setting the user agent. 

type Header struct {
	Values  []string `yaml:"values,omitempty" json:"values,omitempty"`
	Secrets []Secret `yaml:"secrets,omitempty" json:"secrets,omitempty"`
	Files   []string `yaml:"files,omitempty" json:"files,omitempty"`
}

Header represents the configuration for a single HTTP header.

type Headers 

type Headers struct {
	Headers map[string]Header `yaml:",inline"`
	// contains filtered or unexported fields
}

Headers represents the configuration for HTTP headers.

func (Headers) MarshalJSON 

func (h Headers) MarshalJSON() ([]byte, error)

func (*Headers) SetDirectory 

func (h *Headers) SetDirectory(dir string)

SetDirectory records the directory to make headers file relative to the configuration file.

func (*Headers) UnmarshalJSON 

func (h *Headers) UnmarshalJSON(data []byte) error

func (*Headers) Validate 

func (h *Headers) Validate() error

Validate validates the Headers config.

type InlineSecret 

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

func NewInlineSecret 

func NewInlineSecret(text string) *InlineSecret

func (*InlineSecret) Description 

func (s *InlineSecret) Description() string

func (*InlineSecret) Fetch 

func (s *InlineSecret) Fetch(context.Context) (string, error)

func (*InlineSecret) Immutable 

func (s *InlineSecret) Immutable() bool

type OAuth2 

type OAuth2 struct {
	ClientID         string `yaml:"client_id" json:"clientId"`
	ClientSecret     Secret `yaml:"client_secret" json:"clientSecret"`
	ClientSecretFile string `yaml:"client_secret_file" json:"clientSecretFile"`
	// ClientSecretRef is the name of the secret within the secret manager to use as the client
	// secret.
	ClientSecretRef string            `yaml:"client_secret_ref" json:"clientSecretRef"`
	Scopes          []string          `yaml:"scopes,omitempty" json:"scopes,omitempty"`
	TokenURL        string            `yaml:"token_url" json:"tokenUrl"`
	EndpointParams  map[string]string `yaml:"endpoint_params,omitempty" json:"endpointParams,omitempty"`
	TLSConfig       TLSConfig         `yaml:"tls_config,omitempty"`
	ProxyConfig     `yaml:",inline"`
}

OAuth2 is the oauth2 client configuration.

func (*OAuth2) SetDirectory 

func (o *OAuth2) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (*OAuth2) UnmarshalJSON 

func (o *OAuth2) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Marshaler interface for URL.

func (*OAuth2) UnmarshalYAML 

func (o *OAuth2) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface

type ProxyConfig 

type ProxyConfig struct {
	// HTTP proxy server to use to connect to the targets.
	ProxyURL URL `yaml:"proxy_url,omitempty" json:"proxyUrl,omitempty"`
	// NoProxy contains addresses that should not use a proxy.
	NoProxy string `yaml:"no_proxy,omitempty" json:"noProxy,omitempty"`
	// ProxyFromEnvironment makes use of net/http ProxyFromEnvironment function
	// to determine proxies.
	ProxyFromEnvironment bool `yaml:"proxy_from_environment,omitempty" json:"proxyFromEnvironment,omitempty"`
	// ProxyConnectHeader optionally specifies headers to send to
	// proxies during CONNECT requests. Assume that at least _some_ of
	// these headers are going to contain secrets and use Secret as the
	// value type instead of string.
	ProxyConnectHeader ProxyHeader `yaml:"proxy_connect_header,omitempty" json:"proxyConnectHeader,omitempty"`
	// contains filtered or unexported fields
}

func (*ProxyConfig) GetProxyConnectHeader 

func (c *ProxyConfig) GetProxyConnectHeader() http.Header

ProxyConnectHeader() return the Proxy Connext Headers.

func (*ProxyConfig) Proxy 

func (c *ProxyConfig) Proxy() (fn func(*http.Request) (*url.URL, error))

Proxy returns the Proxy URL for a request.

func (*ProxyConfig) Validate 

func (c *ProxyConfig) Validate() error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type ProxyHeader 

type ProxyHeader map[string][]Secret

func (*ProxyHeader) HTTPHeader 

func (h *ProxyHeader) HTTPHeader() http.Header

type Secret 

type Secret string

Secret special type for storing secrets.

type SecretManager 

type SecretManager interface {
	// Fetch returns the secret data given a secret name indicated by `secretRef`.
	Fetch(ctx context.Context, secretRef string) (string, error)
}

SecretManager manages secret data mapped to names known as "references" or "refs".

type SecretReader 

type SecretReader interface {
	Fetch(ctx context.Context) (string, error)
	Description() string
	Immutable() bool
}

type TLSConfig 

type TLSConfig struct {
	// Text of the CA cert to use for the targets.
	CA string `yaml:"ca,omitempty" json:"ca,omitempty"`
	// Text of the client cert file for the targets.
	Cert string `yaml:"cert,omitempty" json:"cert,omitempty"`
	// Text of the client key file for the targets.
	Key Secret `yaml:"key,omitempty" json:"key,omitempty"`
	// The CA cert to use for the targets.
	CAFile string `yaml:"ca_file,omitempty" json:"caFile,omitempty"`
	// The client cert file for the targets.
	CertFile string `yaml:"cert_file,omitempty" json:"certFile,omitempty"`
	// The client key file for the targets.
	KeyFile string `yaml:"key_file,omitempty" json:"keyFile,omitempty"`
	// CARef is the name of the secret within the secret manager to use as the CA cert for the
	// targets.
	CARef string `yaml:"ca_ref,omitempty" json:"caRef,omitempty"`
	// CertRef is the name of the secret within the secret manager to use as the client cert for
	// the targets.
	CertRef string `yaml:"cert_ref,omitempty" json:"certRef,omitempty"`
	// KeyRef is the name of the secret within the secret manager to use as the client key for
	// the targets.
	KeyRef string `yaml:"key_ref,omitempty" json:"keyRef,omitempty"`
	// Used to verify the hostname for the targets.
	ServerName string `yaml:"server_name,omitempty" json:"serverName,omitempty"`
	// Disable target certificate validation.
	InsecureSkipVerify bool `yaml:"insecure_skip_verify" json:"insecureSkipVerify"`
	// Minimum TLS version.
	MinVersion TLSVersion `yaml:"min_version,omitempty" json:"minVersion,omitempty"`
	// Maximum TLS version.
	MaxVersion TLSVersion `yaml:"max_version,omitempty" json:"maxVersion,omitempty"`
}

TLSConfig configures the options for TLS connections.

func (*TLSConfig) SetDirectory 

func (c *TLSConfig) SetDirectory(dir string)

SetDirectory joins any relative file paths with dir.

func (*TLSConfig) UnmarshalYAML 

func (c *TLSConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*TLSConfig) Validate 

func (c *TLSConfig) Validate() error

Validate validates the TLSConfig to check that only one of the inlined or file-based fields for the TLS CA, client certificate, and client key are used.

type TLSConfigOption 

type TLSConfigOption interface {
	// contains filtered or unexported methods
}

TLSConfigOption defines an option that can be applied to the HTTP client.

type TLSRoundTripperSettings 

type TLSRoundTripperSettings struct {
	CA   SecretReader
	Cert SecretReader
	Key  SecretReader
}

type TLSVersion 

type TLSVersion uint16

func (TLSVersion) MarshalJSON 

func (tv TLSVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for TLSVersion.

func (TLSVersion) MarshalYAML 

func (tv TLSVersion) MarshalYAML() (interface{}, error)

func (*TLSVersion) String 

func (tv *TLSVersion) String() string

String implements the fmt.Stringer interface for TLSVersion.

func (*TLSVersion) UnmarshalJSON 

func (tv *TLSVersion) UnmarshalJSON(data []byte) error

MarshalJSON implements the json.Unmarshaler interface for TLSVersion.

func (*TLSVersion) UnmarshalYAML 

func (tv *TLSVersion) UnmarshalYAML(unmarshal func(interface{}) error) error

type URL 

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

URL is a custom URL type that allows validation at configuration load time.

func (URL) MarshalJSON 

func (u URL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for URL.

func (URL) MarshalYAML 

func (u URL) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Marshaler interface for URLs.

func (URL) Redacted 

func (u URL) Redacted() string

Redacted returns the URL but replaces any password with "xxxxx".

func (*URL) UnmarshalJSON 

func (u *URL) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Marshaler interface for URL.

func (*URL) UnmarshalYAML 

func (u *URL) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface for URLs.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.