http

Documentation

Index

• Constants
• func GetDigestAuth(resp *http.Response, method, requestPath, user, password string) string
• func GzipFunc(f http.HandlerFunc) http.HandlerFunc
• func GzipHandler(handler http.Handler) http.Handler
• func NewHTTPLogHandler(h http.Handler) http.Handler
• func NewHTTPLogHandlerWithLogger(h http.Handler, l logrus.StdLogger) http.Handler
• type CSP
  • func (c CSP) Add(directive string, value CSPSourceValue)
  • func (c CSP) Clone() CSP
  • func (c CSP) Set(directive string, value CSPSourceValue)
  • func (c CSP) ToHeaderValue() string
• type CSPHashAlgo
• type CSPSourceValue
  • func CSPSrcHash(algo CSPHashAlgo, sum []byte) CSPSourceValue
  • func CSPSrcNonce(b64Value string) CSPSourceValue
• type HTTPLogHandler
  • func (l HTTPLogHandler) ServeHTTP(res http.ResponseWriter, r *http.Request)
• type LogRoundTripper
  • func NewLogRoundTripper(next http.RoundTripper, out io.Writer) LogRoundTripper
  • func (l LogRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type NoListFS
  • func (n NoListFS) Open(name string) (http.File, error)

Constants

const (
	CSPHashSHA256 CSPHashAlgo = "sha256"
	CSPHashSHA384 CSPHashAlgo = "sha384"
	CSPHashSHA512 CSPHashAlgo = "sha512"

	CSPSrcNone           CSPSourceValue = "'none'"
	CSPSrcReportSample   CSPSourceValue = "'report-sample'"
	CSPSrcSelf           CSPSourceValue = "'self'"
	CSPSrcStrictDynamic  CSPSourceValue = "'strict-dynamic'"
	CSPSrcUnsafeEval     CSPSourceValue = "'unsafe-eval'"
	CSPSrcUnsafeHashes   CSPSourceValue = "'unsafe-hashes'"
	CSPSrcUnsafeInline   CSPSourceValue = "'unsafe-inline'"
	CSPSrcWASMUnsafeEval CSPSourceValue = "'wasm-unsafe-eval'"

	CSPSrcSchemeData        CSPSourceValue = "data:"
	CSPSrcSchemeMediastream CSPSourceValue = "mediastream:"
	CSPSrcSchemeBlob        CSPSourceValue = "blob:"
	CSPSrcSchemeFilesystem  CSPSourceValue = "filesystem:"
)

Collection of pre-defined values. For documentation see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources

Functions

func GetDigestAuth

func GetDigestAuth(resp *http.Response, method, requestPath, user, password string) string

func GzipFunc

func GzipFunc(f http.HandlerFunc) http.HandlerFunc

GzipFunc wraps an http.HandlerFunc and gzips responses if the client supports it

func GzipHandler

func GzipHandler(handler http.Handler) http.Handler

GzipHandler wraps an http.Handler and gzips responses if the client supports it

func NewHTTPLogHandler

func NewHTTPLogHandler(h http.Handler) http.Handler

func NewHTTPLogHandlerWithLogger

func NewHTTPLogHandlerWithLogger(h http.Handler, l logrus.StdLogger) http.Handler

Types

type CSP

type CSP map[string][]CSPSourceValue

CSP is a non-concurrency-safe map to hold a Content-Security-Policy and manipulate it afterwards to eventually render it into its header-representation

func (CSP) Add

func (c CSP) Add(directive string, value CSPSourceValue)

Add adds a single CSPSourceValue to the given directive

func (CSP) Clone

func (c CSP) Clone() CSP

Clone copies the CSP into a new one for manipulation

func (CSP) Set

func (c CSP) Set(directive string, value CSPSourceValue)

Set replaces all present values for the given directive

func (CSP) ToHeaderValue

func (c CSP) ToHeaderValue() string

ToHeaderValue encodes the policy into the format expected in the `Content-Security-Policy` header.

type CSPHashAlgo

type CSPHashAlgo string

CSPHashAlgo defines the available hash algorithms

type CSPSourceValue

type CSPSourceValue string

CSPSourceValue represents an value in the map for a given directive

func CSPSrcHash

func CSPSrcHash(algo CSPHashAlgo, sum []byte) CSPSourceValue

CSPSrcHash takes an algo (sha256, sha384 or sha512) and the sum value and converts it into the right representation for the header

func CSPSrcNonce

func CSPSrcNonce(b64Value string) CSPSourceValue

CSPSrcNonce takes a base64 encoded nonce value and converts it into the right representation for the header

type HTTPLogHandler

type HTTPLogHandler struct {
	Handler          http.Handler
	TrustedIPHeaders []string
	// contains filtered or unexported fields
}

func (HTTPLogHandler) ServeHTTP

func (l HTTPLogHandler) ServeHTTP(res http.ResponseWriter, r *http.Request)

type LogRoundTripper

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

LogRoundTripper is a drop-in for the Transport of a http.Client which then will log requests and responses to the given writer (os.Stdout / os.Stderr / logrus writer / ...)

func NewLogRoundTripper

func NewLogRoundTripper(next http.RoundTripper, out io.Writer) LogRoundTripper

NewLogRoundTripper creates a new LogRoundTripper with the given next transport and output writer. If no next transport is given (next == nil) the http.DefaultTransport is used. If no writer is given the io.Discard writer is used.

func (LogRoundTripper) RoundTrip

func (l LogRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper interface

type NoListFS

type NoListFS struct{ Next http.FileSystem }

NoListFS wraps an http.FileSystem and ensures no directory listings are printed out in order not to expose the contents of the directory in a listing.

func (NoListFS) Open

func (n NoListFS) Open(name string) (http.File, error)

Open wraps the Open of the inner http.FileSystem and returns an os.ErrNotExist in case a directory should be opened. This will result in a HTTP 404 when trying to open a directory causing the contents to be conceiled in an effective manner (zero exposure of known paths)