wwhttp

Documentation

Index

• func BasicAuthOptionalMiddleware(next http.Handler) http.Handler
• func CloudflareMiddleware(log zerolog.Logger) func(next http.Handler) http.Handler
• func ContextWithBasicAuth(ctx context.Context, basicAuth *BasicAuth) context.Context
• func ContextWithJwt(ctx context.Context, jwt interface{}) context.Context
• func ContextWithUserAgent(ctx context.Context, userAgent string) context.Context
• func CorsMiddleware(allowedOrigins []string) func(next http.Handler) http.Handler
• func IpContextMiddleware(next http.Handler) http.Handler
• func IpForContext(ctx context.Context) net.IP
• func JwtFromContext(ctx context.Context) string
• func JwtMiddleware(next http.Handler) http.Handler
• func LoggerMiddleware(logger zerolog.Logger, cloudflare bool, optSkipPaths ...[]string) func(next http.Handler) http.Handler
• func NewRouter(logger zerolog.Logger, serviceName string, cloudflare bool) *chi.Mux
• func RequestIDHeaderMiddleware(next http.Handler) http.Handler
• func RequireCloudflareMiddleware(log zerolog.Logger) func(next http.Handler) http.Handler
• func ServerWithAutoCert(domain string, httpServer *http.Server, httpsServer *http.Server)
• func UserAgentFromContext(ctx context.Context) string
• func UserAgentMiddleware(next http.Handler) http.Handler
• type BasicAuth
  • func BasicAuthFromContext(ctx context.Context) *BasicAuth
• type CloudflareContext
  • func CloudflareFromContext(ctx context.Context) CloudflareContext
• type Daemon
  • func RunDaemon(ctx context.Context, srv DaemonServer) *Daemon
  • func (d *Daemon) Wait()
• type DaemonServer
• type FcgiServer
  • func NewFcgiServerFromEnv(router http.Handler) *FcgiServer
  • func (srv *FcgiServer) Start(ctx context.Context) error
• type Getter
  • func NewGetter(config GetterConfig) *Getter
  • func (pg *Getter) GetJson(ctx context.Context, v interface{}) error
• type GetterConfig
• type ReCaptcha
  • func NewReCaptchaFromEnv(log zerolog.Logger) ReCaptcha
  • func (r ReCaptcha) PublicSettings() ReCaptchaPublicSettings
  • func (r ReCaptcha) ReCaptchaV2Verify(ctx context.Context, token string) (*ReCaptchaV2Response, error)
  • func (r ReCaptcha) ReCaptchaV3Verify(ctx context.Context, token string) (*ReCaptchaV3Response, error)
  • func (r ReCaptcha) VerifyReCaptchaTokensFromContext(ctx context.Context, action string, tokens ReCaptchaTokens) error
• type ReCaptchaPublicSettings
• type ReCaptchaTokens
• type ReCaptchaV2Response
• type ReCaptchaV3Response
• type Server
  • func (srv *Server) Start(ctx context.Context) error

Functions

func BasicAuthOptionalMiddleware

func BasicAuthOptionalMiddleware(next http.Handler) http.Handler

func CloudflareMiddleware

func CloudflareMiddleware(log zerolog.Logger) func(next http.Handler) http.Handler

func ContextWithBasicAuth

func ContextWithBasicAuth(ctx context.Context, basicAuth *BasicAuth) context.Context

func ContextWithJwt

func ContextWithJwt(ctx context.Context, jwt interface{}) context.Context

func ContextWithUserAgent

func ContextWithUserAgent(ctx context.Context, userAgent string) context.Context

func CorsMiddleware

func CorsMiddleware(allowedOrigins []string) func(next http.Handler) http.Handler

func IpContextMiddleware

func IpContextMiddleware(next http.Handler) http.Handler

func IpForContext

func IpForContext(ctx context.Context) net.IP

func JwtFromContext

func JwtFromContext(ctx context.Context) string

func JwtMiddleware

func JwtMiddleware(next http.Handler) http.Handler

func LoggerMiddleware

func LoggerMiddleware(logger zerolog.Logger, cloudflare bool, optSkipPaths ...[]string) func(next http.Handler) http.Handler

LoggerMiddleware is a copy of httplog.RequestLogger, but with Cloudflare header support.

func NewRouter

func NewRouter(logger zerolog.Logger, serviceName string, cloudflare bool) *chi.Mux

func RequestIDHeaderMiddleware

func RequestIDHeaderMiddleware(next http.Handler) http.Handler

func RequireCloudflareMiddleware

func RequireCloudflareMiddleware(log zerolog.Logger) func(next http.Handler) http.Handler

func ServerWithAutoCert

func ServerWithAutoCert(
	domain string,
	httpServer *http.Server,
	httpsServer *http.Server,
)

func UserAgentFromContext

func UserAgentFromContext(ctx context.Context) string

func UserAgentMiddleware

func UserAgentMiddleware(next http.Handler) http.Handler

Types

type BasicAuth

type BasicAuth struct {
	Username string
	Password string
}

func BasicAuthFromContext

func BasicAuthFromContext(ctx context.Context) *BasicAuth

type CloudflareContext

type CloudflareContext struct {
	ClientIp         net.IP
	IsFromCloudflare bool
}

func CloudflareFromContext

func CloudflareFromContext(ctx context.Context) CloudflareContext

type Daemon

type Daemon struct {
	// contains filtered or unexported fields
}

func RunDaemon

func RunDaemon(ctx context.Context, srv DaemonServer) *Daemon

RunDaemon runs the given server in the background and automatically attempts graceful shutdown on interrupt.

func (*Daemon) Wait

func (d *Daemon) Wait()

Wait will block until the context is cancelled and will exit/panic or return.

type DaemonServer

type DaemonServer interface {
	Start(ctx context.Context) error
}

type FcgiServer

type FcgiServer struct {
	Router     http.Handler
	SocketPath string
	// Dev only, should not be used in production.
	GlobalRwx bool
}

func NewFcgiServerFromEnv

func NewFcgiServerFromEnv(router http.Handler) *FcgiServer

func (*FcgiServer) Start

func (srv *FcgiServer) Start(ctx context.Context) error

type Getter

type Getter struct {
	// contains filtered or unexported fields
}

Getter is a helper for retrieving & caching an ETagged http response.

func NewGetter

func NewGetter(config GetterConfig) *Getter

func (*Getter) GetJson

func (pg *Getter) GetJson(ctx context.Context, v interface{}) error

type GetterConfig

type GetterConfig struct {
	Log           zerolog.Logger
	Url           string
	CheckInterval time.Duration
}

type ReCaptcha

type ReCaptcha struct {
	Log         zerolog.Logger
	SecretKeyV2 string
	SiteKeyV2   string
	SecretKeyV3 string
	SiteKeyV3   string
	MinScoreV3  float32
}

func NewReCaptchaFromEnv

func NewReCaptchaFromEnv(log zerolog.Logger) ReCaptcha

func (ReCaptcha) PublicSettings

func (r ReCaptcha) PublicSettings() ReCaptchaPublicSettings

func (ReCaptcha) ReCaptchaV2Verify

func (r ReCaptcha) ReCaptchaV2Verify(ctx context.Context, token string) (*ReCaptchaV2Response, error)

func (ReCaptcha) ReCaptchaV3Verify

func (r ReCaptcha) ReCaptchaV3Verify(ctx context.Context, token string) (*ReCaptchaV3Response, error)

func (ReCaptcha) VerifyReCaptchaTokensFromContext

func (r ReCaptcha) VerifyReCaptchaTokensFromContext(ctx context.Context, action string, tokens ReCaptchaTokens) error

type ReCaptchaPublicSettings

type ReCaptchaPublicSettings struct {
	SiteKeyV2 string `json:"siteKeyV2"`
	SiteKeyV3 string `json:"siteKeyV3"`
}

type ReCaptchaTokens

type ReCaptchaTokens struct {
	ReCaptchaV3token *string
	ReCaptchaV2token *string
}

type ReCaptchaV2Response

type ReCaptchaV2Response struct {
	Success     bool     `json:"success"`
	ChallengeTs string   `json:"challenge_ts"`
	Hostname    string   `json:"hostname"`
	ErrorCodes  []string `json:"error-codes"`
}

type ReCaptchaV3Response

type ReCaptchaV3Response struct {
	Success     bool     `json:"success"`
	Score       float32  `json:"score"`
	Action      string   `json:"action"`
	ChallengeTs string   `json:"challenge_ts"`
	Hostname    string   `json:"hostname"`
	ErrorCodes  []string `json:"error-codes"`
}

type Server

type Server struct {
	Domain    string
	Router    http.Handler
	AutoCert  bool
	CertFile  string
	CertKey   string
	HttpPort  string
	HttpsPort string
}

func (*Server) Start

func (srv *Server) Start(ctx context.Context) error