config.go

package config

import (
	"fmt"
	"net"
	"time"
)

// Config is the configuration object for the commands in
// github.com/quay/clair/v4/cmd/...
type Config struct {
	// TLS configures HTTPS support.
	//
	// Note that any non-trivial deployment means the certificate provided here
	// will need to be for the name the load balancer uses to connect to a given
	// Clair instance.
	//
	// This is not used for outgoing requests; setting the SSL_CERT_DIR
	// environment variable is the recommended way to do that. The release
	// container has `/var/run/certs` added to the list already.
	TLS *TLS `yaml:"tls,omitempty" json:"tls,omitempty"`
	// Sets which mode the clair instance will run.
	Mode Mode `yaml:"-" json:"-"`
	// A string in <host>:<port> format where <host> can be an empty string.
	//
	// exposes Clair node's functionality to the network.
	// see /openapi/v1 for api spec.
	HTTPListenAddr string `yaml:"http_listen_addr" json:"http_listen_addr"`
	// A string in <host>:<port> format where <host> can be an empty string.
	//
	// exposes Clair's metrics and health endpoints.
	IntrospectionAddr string `yaml:"introspection_addr" json:"introspection_addr"`
	// Set the logging level.
	LogLevel LogLevel `yaml:"log_level" json:"log_level"`
	Indexer  Indexer  `yaml:"indexer,omitempty" json:"indexer,omitempty"`
	Matcher  Matcher  `yaml:"matcher,omitempty" json:"matcher,omitempty"`
	Matchers Matchers `yaml:"matchers,omitempty" json:"matchers,omitempty"`
	Updaters Updaters `yaml:"updaters,omitempty" json:"updaters,omitempty"`
	Notifier Notifier `yaml:"notifier,omitempty" json:"notifier,omitempty"`
	Auth     Auth     `yaml:"auth,omitempty" json:"auth,omitempty"`
	Trace    Trace    `yaml:"trace,omitempty" json:"trace,omitempty"`
	Metrics  Metrics  `yaml:"metrics,omitempty" json:"metrics,omitempty"`
}

func (c *Config) validate(mode Mode) ([]Warning, error) {
	if c.HTTPListenAddr == "" {
		c.HTTPListenAddr = DefaultAddress
	}
	if c.Matcher.DisableUpdaters {
		c.Updaters.Sets = []string{}
	}
	switch mode {
	case ComboMode, IndexerMode, MatcherMode, NotifierMode:
		// OK
	default:
		return nil, fmt.Errorf("unknown mode: %q", mode)
	}
	if _, _, err := net.SplitHostPort(c.HTTPListenAddr); err != nil {
		return nil, err
	}
	return c.lint()
}

func (c *Config) lint() (ws []Warning, err error) {
	if c.HTTPListenAddr == "" {
		ws = append(ws, Warning{
			path: ".http_listen_addr",
			msg:  `http listen address not provided, default will be used`,
		})
	}
	if c.IntrospectionAddr == "" {
		ws = append(ws, Warning{
			path: ".introspection_addr",
			msg:  `introspection address not provided, default will be used`,
		})
	}
	return ws, nil
}

// Duration is a serializeable [time.Duration].
type Duration time.Duration

// UnmarshalText implements [encoding.TextUnmarshaler].
func (d *Duration) UnmarshalText(b []byte) error {
	dur, err := time.ParseDuration(string(b))
	if err != nil {
		return err
	}
	*d = Duration(dur)
	return nil
}

// MarshalText implements [encoding.TextMarshaler].
func (d *Duration) MarshalText() ([]byte, error) {
	return []byte(time.Duration(*d).String()), nil
}