mirror of
https://github.com/TwiN/gatus.git
synced 2024-11-21 23:43:27 +01:00
124 lines
3.5 KiB
Go
124 lines
3.5 KiB
Go
package client
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"errors"
|
|
"net/http"
|
|
"time"
|
|
|
|
"golang.org/x/oauth2"
|
|
"golang.org/x/oauth2/clientcredentials"
|
|
)
|
|
|
|
const (
|
|
defaultHTTPTimeout = 10 * time.Second
|
|
)
|
|
|
|
var (
|
|
ErrInvalidClientOAuth2Config = errors.New("invalid OAuth2 configuration, all fields are required")
|
|
|
|
defaultConfig = Config{
|
|
Insecure: false,
|
|
IgnoreRedirect: false,
|
|
Timeout: defaultHTTPTimeout,
|
|
}
|
|
)
|
|
|
|
// GetDefaultConfig returns a copy of the default configuration
|
|
func GetDefaultConfig() *Config {
|
|
cfg := defaultConfig
|
|
return &cfg
|
|
}
|
|
|
|
// Config is the configuration for clients
|
|
type Config struct {
|
|
// Insecure determines whether to skip verifying the server's certificate chain and host name
|
|
Insecure bool `yaml:"insecure,omitempty"`
|
|
|
|
// IgnoreRedirect determines whether to ignore redirects (true) or follow them (false, default)
|
|
IgnoreRedirect bool `yaml:"ignore-redirect,omitempty"`
|
|
|
|
// Timeout for the client
|
|
Timeout time.Duration `yaml:"timeout"`
|
|
|
|
// OAuth2Config is the OAuth2 configuration used for the client.
|
|
//
|
|
// If non-nil, the http.Client returned by getHTTPClient will automatically retrieve a token if necessary.
|
|
// See configureOAuth2 for more details.
|
|
OAuth2Config *OAuth2Config `yaml:"oauth2,omitempty"`
|
|
|
|
httpClient *http.Client
|
|
}
|
|
|
|
// OAuth2Config is the configuration for the OAuth2 client credentials flow
|
|
type OAuth2Config struct {
|
|
TokenURL string `yaml:"token-url"` // e.g. https://dev-12345678.okta.com/token
|
|
ClientID string `yaml:"client-id"`
|
|
ClientSecret string `yaml:"client-secret"`
|
|
Scopes []string `yaml:"scopes"` // e.g. ["openid"]
|
|
}
|
|
|
|
// ValidateAndSetDefaults validates the client configuration and sets the default values if necessary
|
|
func (c *Config) ValidateAndSetDefaults() error {
|
|
if c.Timeout < time.Millisecond {
|
|
c.Timeout = 10 * time.Second
|
|
}
|
|
if c.HasOAuth2Config() && !c.OAuth2Config.isValid() {
|
|
return ErrInvalidClientOAuth2Config
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// HasOAuth2Config returns true if the client has OAuth2 configuration parameters
|
|
func (c *Config) HasOAuth2Config() bool {
|
|
return c.OAuth2Config != nil
|
|
}
|
|
|
|
// isValid() returns true if the OAuth2 configuration is valid
|
|
func (c *OAuth2Config) isValid() bool {
|
|
return len(c.TokenURL) > 0 && len(c.ClientID) > 0 && len(c.ClientSecret) > 0 && len(c.Scopes) > 0
|
|
}
|
|
|
|
// GetHTTPClient return an HTTP client matching the Config's parameters.
|
|
func (c *Config) getHTTPClient() *http.Client {
|
|
if c.httpClient == nil {
|
|
c.httpClient = &http.Client{
|
|
Timeout: c.Timeout,
|
|
Transport: &http.Transport{
|
|
MaxIdleConns: 100,
|
|
MaxIdleConnsPerHost: 20,
|
|
Proxy: http.ProxyFromEnvironment,
|
|
TLSClientConfig: &tls.Config{
|
|
InsecureSkipVerify: c.Insecure,
|
|
},
|
|
},
|
|
CheckRedirect: func(req *http.Request, via []*http.Request) error {
|
|
if c.IgnoreRedirect {
|
|
// Don't follow redirects
|
|
return http.ErrUseLastResponse
|
|
}
|
|
// Follow redirects
|
|
return nil
|
|
},
|
|
}
|
|
if c.HasOAuth2Config() {
|
|
c.httpClient = configureOAuth2(c.httpClient, *c.OAuth2Config)
|
|
}
|
|
}
|
|
return c.httpClient
|
|
}
|
|
|
|
// configureOAuth2 returns an HTTP client that will obtain and refresh tokens as necessary.
|
|
// The returned Client and its Transport should not be modified.
|
|
func configureOAuth2(httpClient *http.Client, c OAuth2Config) *http.Client {
|
|
oauth2cfg := clientcredentials.Config{
|
|
ClientID: c.ClientID,
|
|
ClientSecret: c.ClientSecret,
|
|
Scopes: c.Scopes,
|
|
TokenURL: c.TokenURL,
|
|
}
|
|
ctx := context.WithValue(context.Background(), oauth2.HTTPClient, httpClient)
|
|
return oauth2cfg.Client(ctx)
|
|
}
|