promauth

Documentation

Index

• type Authorization
• type BasicAuthConfig
  • func (ba *BasicAuthConfig) NewConfig(baseDir string) (*Config, error)
• type Config
  • func (ac *Config) GetAuthHeader() (string, error)
  • func (ac *Config) HeadersNoAuthString() string
  • func (ac *Config) NewRoundTripper(trBase *http.Transport) http.RoundTripper
  • func (ac *Config) SetHeaders(req *http.Request, setAuthHeader bool) error
  • func (ac *Config) String() string
• type HTTPClientConfig
  • func (hcc *HTTPClientConfig) NewConfig(baseDir string) (*Config, error)
• type OAuth2Config
• type Options
  • func (opts *Options) NewConfig() (*Config, error)
• type ProxyClientConfig
  • func (pcc *ProxyClientConfig) NewConfig(baseDir string) (*Config, error)
• type Secret
  • func NewSecret(s string) *Secret
  • func (s *Secret) MarshalYAML() (any, error)
  • func (s *Secret) String() string
  • func (s *Secret) UnmarshalYAML(f func(any) error) error
• type TLSConfig

Types

type Authorization

type Authorization struct {
	Type            string  `yaml:"type,omitempty"`
	Credentials     *Secret `yaml:"credentials,omitempty"`
	CredentialsFile string  `yaml:"credentials_file,omitempty"`
}

Authorization represents generic authorization config.

See https://prometheus.io/docs/prometheus/latest/configuration/configuration/

type BasicAuthConfig

type BasicAuthConfig struct {
	Username     string  `yaml:"username,omitempty"`
	UsernameFile string  `yaml:"username_file,omitempty"`
	Password     *Secret `yaml:"password,omitempty"`
	PasswordFile string  `yaml:"password_file,omitempty"`
}

BasicAuthConfig represents basic auth config.

func (*BasicAuthConfig) NewConfig

func (ba *BasicAuthConfig) NewConfig(baseDir string) (*Config, error)

NewConfig creates auth config for the given ba.

type Config

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

Config is auth config.

func (*Config) GetAuthHeader

func (ac *Config) GetAuthHeader() (string, error)

GetAuthHeader returns optional `Authorization: ...` http header.

func (*Config) HeadersNoAuthString

func (ac *Config) HeadersNoAuthString() string

HeadersNoAuthString returns string representation of ac headers

func (*Config) NewRoundTripper

func (ac *Config) NewRoundTripper(trBase *http.Transport) http.RoundTripper

NewRoundTripper returns new http.RoundTripper for the given ac, which uses the given trBase as base transport.

The caller shouldn't change the trBase, since the returned RoundTripper owns it.

func (*Config) SetHeaders

func (ac *Config) SetHeaders(req *http.Request, setAuthHeader bool) error

SetHeaders sets the configured ac headers to req.

func (*Config) String

func (ac *Config) String() string

String returns human-readable representation for ac.

It is also used for comparing Config objects for equality. If two Config objects have the same string representation, then they are considered equal.

type HTTPClientConfig

type HTTPClientConfig struct {
	Authorization   *Authorization   `yaml:"authorization,omitempty"`
	BasicAuth       *BasicAuthConfig `yaml:"basic_auth,omitempty"`
	BearerToken     *Secret          `yaml:"bearer_token,omitempty"`
	BearerTokenFile string           `yaml:"bearer_token_file,omitempty"`
	OAuth2          *OAuth2Config    `yaml:"oauth2,omitempty"`
	TLSConfig       *TLSConfig       `yaml:"tls_config,omitempty"`

	// Headers contains optional HTTP headers, which must be sent in the request to the server
	Headers []string `yaml:"headers,omitempty"`

	// FollowRedirects specifies whether the client should follow HTTP 3xx redirects.
	FollowRedirects *bool `yaml:"follow_redirects,omitempty"`
}

HTTPClientConfig represents http client config.

func (*HTTPClientConfig) NewConfig

func (hcc *HTTPClientConfig) NewConfig(baseDir string) (*Config, error)

NewConfig creates auth config for the given hcc.

type OAuth2Config

type OAuth2Config struct {
	ClientID         string            `yaml:"client_id"`
	ClientSecret     *Secret           `yaml:"client_secret,omitempty"`
	ClientSecretFile string            `yaml:"client_secret_file,omitempty"`
	Scopes           []string          `yaml:"scopes,omitempty"`
	TokenURL         string            `yaml:"token_url"`
	EndpointParams   map[string]string `yaml:"endpoint_params,omitempty"`
	TLSConfig        *TLSConfig        `yaml:"tls_config,omitempty"`
	ProxyURL         string            `yaml:"proxy_url,omitempty"`
}

OAuth2Config represent OAuth2 configuration

type Options

type Options struct {
	// BaseDir is an optional path to a base directory for resolving
	// relative filepaths in various config options.
	//
	// It is set to the current directory by default.
	BaseDir string

	// Authorization contains optional Authorization.
	Authorization *Authorization

	// BasicAuth contains optional BasicAuthConfig.
	BasicAuth *BasicAuthConfig

	// BearerToken contains optional bearer token.
	BearerToken string

	// BearerTokenFile contains optional path to a file with bearer token.
	BearerTokenFile string

	// OAuth2 contains optional OAuth2Config.
	OAuth2 *OAuth2Config

	// TLSconfig contains optional TLSConfig.
	TLSConfig *TLSConfig

	// Headers contains optional http request headers in the form 'Foo: bar'.
	Headers []string
}

Options contain options, which must be passed to NewConfig.

func (*Options) NewConfig

func (opts *Options) NewConfig() (*Config, error)

NewConfig creates auth config from the given opts.

type ProxyClientConfig

type ProxyClientConfig struct {
	Authorization   *Authorization   `yaml:"proxy_authorization,omitempty"`
	BasicAuth       *BasicAuthConfig `yaml:"proxy_basic_auth,omitempty"`
	BearerToken     *Secret          `yaml:"proxy_bearer_token,omitempty"`
	BearerTokenFile string           `yaml:"proxy_bearer_token_file,omitempty"`
	OAuth2          *OAuth2Config    `yaml:"proxy_oauth2,omitempty"`
	TLSConfig       *TLSConfig       `yaml:"proxy_tls_config,omitempty"`

	// Headers contains optional HTTP headers, which must be sent in the request to the proxy
	Headers []string `yaml:"proxy_headers,omitempty"`
}

ProxyClientConfig represents proxy client config.

func (*ProxyClientConfig) NewConfig

func (pcc *ProxyClientConfig) NewConfig(baseDir string) (*Config, error)

NewConfig creates auth config for the given pcc.

type Secret

type Secret struct {
	S string
}

Secret represents a string secret such as password or auth token.

It is marshaled to "<secret>" string in yaml.

This is needed for hiding secret strings in /config page output. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1764

func NewSecret

func NewSecret(s string) *Secret

NewSecret returns new secret for s.

func (*Secret) MarshalYAML

func (s *Secret) MarshalYAML() (any, error)

MarshalYAML implements yaml.Marshaler interface.

It substitutes the secret with "<secret>" string.

func (*Secret) String

func (s *Secret) String() string

String returns the secret in plaintext.

func (*Secret) UnmarshalYAML

func (s *Secret) UnmarshalYAML(f func(any) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type TLSConfig

type TLSConfig struct {
	CA                 string `yaml:"ca,omitempty"`
	CAFile             string `yaml:"ca_file,omitempty"`
	Cert               string `yaml:"cert,omitempty"`
	CertFile           string `yaml:"cert_file,omitempty"`
	Key                string `yaml:"key,omitempty"`
	KeyFile            string `yaml:"key_file,omitempty"`
	ServerName         string `yaml:"server_name,omitempty"`
	InsecureSkipVerify bool   `yaml:"insecure_skip_verify,omitempty"`
	MinVersion         string `yaml:"min_version,omitempty"`
}

TLSConfig represents TLS config.

See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#tls_config