common

Documentation

Index

• Constants
• func Decode(hash string) ([]byte, error)
• func Generate(keysize int) string
• func GetUsername(ctx context.Context) string
• func JSONResponse(w http.ResponseWriter, o interface{})
• func JSONStatusResponse(code int, w http.ResponseWriter, o interface{})
• func MatchingFiles(dir string, extensions ...string) []string
• func NewStaticFileHandler(filenames ...string) http.Handler
• func NewTemplateHandler(filenames ...string) http.Handler
• func QueryParamKeys(v url.Values) []string
• func Redirect(w http.ResponseWriter, r *http.Request, targetURL string, ...)
• func SetUsername(ctx context.Context, username string) context.Context
• type KeyProvider
  • func DefaultKeyProvider() (KeyProvider, error)
  • func NewKeyProvider(hash string, block string) (KeyProvider, error)
• type Middleware
  • func NewDebugMiddleware(w io.Writer, verbose bool) Middleware
• type PasswordChecker
  • func PasswordCheckers(checkers ...PasswordChecker) PasswordChecker
• type RequestChecker
  • func RequestCheckers(checkers ...RequestChecker) RequestChecker

Constants

const (
	// HashKeySize is optimally 64 bytes
	HashKeySize = 64
	// BlockKeySize is optimally 32 bytes
	BlockKeySize = 32
)

Functions

func Decode

func Decode(hash string) ([]byte, error)

Decode extracts a byte slice from a base64 encoded string.

func Generate

func Generate(keysize int) string

Generate creates a random key of keysize length, and returns it in base64 encoded text.

func GetUsername

func GetUsername(ctx context.Context) string

GetUsername retrieves authenticated username from Context

func JSONResponse

func JSONResponse(w http.ResponseWriter, o interface{})

JSONResponse writes the interface{} o as a JSON object response body.

func JSONStatusResponse

func JSONStatusResponse(code int, w http.ResponseWriter, o interface{})

JSONStatusResponse writes the interface{} o as a JSON object response body with the givent http status code.

func MatchingFiles

func MatchingFiles(dir string, extensions ...string) []string

MatchingFiles returns the names of all the files in dir with (case insensitive) extension matching one of extensions.

func NewStaticFileHandler

func NewStaticFileHandler(filenames ...string) http.Handler

NewStaticFileHandler tries each filename parameter and serves the first one successfully read, or returns 404 if none are found.

func NewTemplateHandler

func NewTemplateHandler(filenames ...string) http.Handler

NewTemplateHandler loads each filename parameter as a template, and serves the first one to match, or returns 404 if one is not found.

func QueryParamKeys

func QueryParamKeys(v url.Values) []string

QueryParamKeys gets the keys from a url.Values collection.

func Redirect

func Redirect(w http.ResponseWriter, r *http.Request, targetURL string, additionalParams map[string]string)

Redirect initiates an http redirect response.

func SetUsername

func SetUsername(ctx context.Context, username string) context.Context

SetUsername returns a context with the given username set

Types

type KeyProvider

type KeyProvider interface {
	Hash() []byte
	Block() []byte
}

KeyProvider describes functions needed for encrypted cookies.

func DefaultKeyProvider

func DefaultKeyProvider() (KeyProvider, error)

DefaultKeyProvider creates random default values for the provider. This is only good for one execution run, unless the generated keys are persisted.

func NewKeyProvider

func NewKeyProvider(hash string, block string) (KeyProvider, error)

NewKeyProvider creates a default provider from base64 encoded values.

type Middleware

type Middleware interface {
	ServeHTTP(http.ResponseWriter, *http.Request, http.HandlerFunc)
}

Middleware describes common middleware

func NewDebugMiddleware

func NewDebugMiddleware(w io.Writer, verbose bool) Middleware

NewDebugMiddleware provides middleware suitable for exhaustive request/response logging.

type PasswordChecker

type PasswordChecker interface {
	IsAuthenticated(username string, password string) bool
}

PasswordChecker describes functionality to verify passwords

func PasswordCheckers

func PasswordCheckers(checkers ...PasswordChecker) PasswordChecker

PasswordCheckers combines multiple PasswordCheckers

type RequestChecker

type RequestChecker interface {
	IsAuthenticated(r *http.Request) string
}

RequestChecker describes functionality to verify requests

func RequestCheckers

func RequestCheckers(checkers ...RequestChecker) RequestChecker

RequestCheckers combines multiple RequestCheckers