httpserver

Documentation

Index

• func BasicAuthFieldSpec() docs.FieldSpec
• func ServerCORSFieldSpec() docs.FieldSpec
• type BasicAuthConfig
  • func BasicAuthConfigFromParsed(pConf *docs.ParsedConfig) (conf BasicAuthConfig, err error)
  • func NewBasicAuthConfig() BasicAuthConfig
  • func (b BasicAuthConfig) Validate() error
  • func (b BasicAuthConfig) WrapHandler(next http.HandlerFunc) http.HandlerFunc
• type CORSConfig
  • func CORSConfigFromParsed(pConf *docs.ParsedConfig) (conf CORSConfig, err error)
  • func NewServerCORSConfig() CORSConfig
  • func (conf CORSConfig) WrapHandler(handler http.Handler) (http.Handler, error)

Functions

func BasicAuthFieldSpec

func BasicAuthFieldSpec() docs.FieldSpec

BasicAuthFieldSpec returns the spec for an HTTP BasicAuth component.

func ServerCORSFieldSpec

func ServerCORSFieldSpec() docs.FieldSpec

ServerCORSFieldSpec returns a field spec for an http server CORS component.

Types

type BasicAuthConfig

type BasicAuthConfig struct {
	Enabled      bool   `json:"enabled" yaml:"enabled"`
	Username     string `json:"username" yaml:"username"`
	PasswordHash string `json:"password_hash" yaml:"password_hash"`
	Realm        string `json:"realm" yaml:"realm"`
	Algorithm    string `json:"algorithm" yaml:"algorithm"`
	Salt         string `json:"salt" yaml:"salt"`
}

BasicAuthConfig contains struct based fields for basic authentication.

func BasicAuthConfigFromParsed

func BasicAuthConfigFromParsed(pConf *docs.ParsedConfig) (conf BasicAuthConfig, err error)

BasicAuthConfigFromParsed extracts the auth fields from the parsed config and returns a BasicAuth config.

func NewBasicAuthConfig

func NewBasicAuthConfig() BasicAuthConfig

NewBasicAuthConfig returns a BasicAuthConfig with default values.

func (BasicAuthConfig) Validate

func (b BasicAuthConfig) Validate() error

Validate confirms that the BasicAuth is properly configured.

func (BasicAuthConfig) WrapHandler

func (b BasicAuthConfig) WrapHandler(next http.HandlerFunc) http.HandlerFunc

WrapHandler wraps the provided HTTP handler with middleware that enforces BasicAuth if it's enabled.

type CORSConfig

type CORSConfig struct {
	Enabled        bool     `json:"enabled" yaml:"enabled"`
	AllowedOrigins []string `json:"allowed_origins" yaml:"allowed_origins"`
}

CORSConfig contains struct configuration for allowing CORS headers.

func CORSConfigFromParsed

func CORSConfigFromParsed(pConf *docs.ParsedConfig) (conf CORSConfig, err error)

CORSConfigFromParsed extracts the CORS fields from the parsed config and returns a CORS config.

func NewServerCORSConfig

func NewServerCORSConfig() CORSConfig

NewServerCORSConfig returns a new server CORS config with default fields.

func (CORSConfig) WrapHandler

func (conf CORSConfig) WrapHandler(handler http.Handler) (http.Handler, error)

WrapHandler wraps a provided HTTP handler with middleware that enables CORS requests (when configured).