security

Documentation

Index

• type Credentials
  • func (c *Credentials) GetHTTPAuthHeader() (headerName string, headerValue string, err error)
  • func (c *Credentials) ValidateCredentials() error
• type Identity
• type TLS

Types

type Credentials

type Credentials struct {
	Username string `yaml:",omitempty"`
	Password string `yaml:",omitempty"`
	Token    string `yaml:",omitempty"`
}

Credentials provides information when needing to authenticate to remote endpoints. Credentials are either a username/password or a bearer token, but not both.

func (*Credentials) GetHTTPAuthHeader

func (c *Credentials) GetHTTPAuthHeader() (headerName string, headerValue string, err error)

GetHTTPAuthHeader provides the authentication ehader name and value (can be empty), or an error

func (*Credentials) ValidateCredentials

func (c *Credentials) ValidateCredentials() error

ValidateCredentials makes sure that if username is provided, so is password (and vice versa) and also makes sure if username/password is provided that token is not (and vice versa). It is valid to have nothing defined (no username, password, nor token).

type Identity

type Identity struct {
	CertFile       string `yaml:"cert_file"`
	PrivateKeyFile string `yaml:"private_key_file"`
}

Identity security details about a client.

type TLS

type TLS struct {
	SkipCertificateValidation bool `yaml:"skip_certificate_validation,omitempty"`
}

TLS options - SkipCertificateValidation will disable server certificate verification - the client will accept any certificate presented by the server and any host name in that certificate.