heimdall

Documentation

Index

• Variables
• type Context
• type JWTSigner
• type RedirectError
  • func (e *RedirectError) Error() string
  • func (e *RedirectError) Is(target error) bool
• type Request
• type RequestFunctions

Variables

var (
	ErrArgument             = errors.New("argument error")
	ErrAuthentication       = errors.New("authentication error")
	ErrAuthorization        = errors.New("authorization error")
	ErrCommunication        = errors.New("communication error")
	ErrCommunicationTimeout = errors.New("communication timeout error")
	ErrConfiguration        = errors.New("configuration error")
	ErrInternal             = errors.New("internal error")
	ErrMethodNotAllowed     = errors.New("method not allowed")
	ErrNoRuleFound          = errors.New("no rule found")
)

Types

type Context

type Context interface {
	Request() *Request

	AddHeaderForUpstream(name, value string)
	AddCookieForUpstream(name, value string)

	AppContext() context.Context

	SetPipelineError(err error)

	Signer() JWTSigner
}

type JWTSigner

type JWTSigner interface {
	Sign(sub string, ttl time.Duration, claims map[string]any) (string, error)
	Hash() []byte
	Keys() []jose.JSONWebKey
}

type RedirectError

type RedirectError struct {
	Message    string
	Code       int
	RedirectTo string
}

func (*RedirectError) Error

func (e *RedirectError) Error() string

func (*RedirectError) Is

func (e *RedirectError) Is(target error) bool

type Request

type Request struct {
	RequestFunctions

	Method   string
	URL      *url.URL
	ClientIP []string
}

type RequestFunctions

type RequestFunctions interface {
	Header(name string) string
	Cookie(name string) string
	Headers() map[string]string
	Body() []byte
}