options

Documentation

Index

• type Options
  • func NewOptions() *Options
  • func (o *Options) Clone() *Options
  • func (o *Options) Equal(o2 *Options) bool
  • func (o *Options) Validate() (bool, error)

Types

type Options

type Options struct {
	// FullChainCertPath specifies the path of the file containing the
	// concatenated server certification and the intermediate certification for the tls endpoint
	FullChainCertPath string `toml:"full_chain_cert_path"`
	// PrivateKeyPath specifies the path of the private key file for the tls endpoint
	PrivateKeyPath string `toml:"private_key_path"`
	// ServeTLS is set to true once the Cert and Key files have been validated,
	// indicating the consumer of this config can service requests over TLS
	ServeTLS bool `toml:"-"`
	// InsecureSkipVerify indicates that the HTTPS Client in Trickster should bypass
	// hostname verification for the origin's certificate when proxying requests
	InsecureSkipVerify bool `toml:"insecure_skip_verify"`
	// CertificateAuthorities provides a list of custom Certificate Authorities for the upstream origin
	// which are considered in addition to any system CA's by the Trickster HTTPS Client
	CertificateAuthorityPaths []string `toml:"certificate_authority_paths"`
	// ClientCertPath provides the path to the Client Certificate when using Mutual Authorization
	ClientCertPath string `toml:"client_cert_path"`
	// ClientKeyPath provides the path to the Client Key when using Mutual Authorization
	ClientKeyPath string `toml:"client_key_path"`
}

Options is a collection of TLS-related client and server configurations

func NewOptions

func NewOptions() *Options

NewOptions will return a *Options with the default settings

func (*Options) Clone

func (o *Options) Clone() *Options

Clone returns an exact copy of the subject *Options

func (*Options) Equal

func (o *Options) Equal(o2 *Options) bool

Equal returns true if all TOML-exposed option members are equal

func (*Options) Validate

func (o *Options) Validate() (bool, error)

Validate returns true if the TLS Options are validated