handler

Documentation

Index

• Constants
• Variables
• func CreateRestrictedToken(key string, identity string) (string, error)
• func CreateToken(key string, identity string) (string, error)
• func New(h Handler) func(events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)
• type Error
  • func ClientErr(format string, a ...interface{}) *Error
  • func InternalErr(format string, a ...interface{}) *Error
  • func ObfuscatedAuthErr() *Error
  • func (e *Error) Code() int
• type Handler
• type Request
  • func (r *Request) Authenticate(key, identity string) (*time.Time, error)
  • func (r *Request) Param(n string) (string, *Error)
• type Response
  • func (r *Response) ContentType(t string)

Constants

const (
	AuthHeader = "Authorization"
	AuthType   = "Targetblank"
)

Expected authorization header configuration.

const (
	ErrPageNotFound    = "page not found"
	ErrInvalidEmail    = "invalid email address"
	ErrInvalidPassword = "password is too short"
	ErrGeneric         = "something went wrong"
)

Common client error messages.

Variables

var (

	// ErrRestrictedToken is returned when authenticating restricted tokens.
	ErrRestrictedToken = fmt.Errorf("restricted token")
)

Functions

func CreateRestrictedToken

func CreateRestrictedToken(key string, identity string) (string, error)

CreateRestrictedToken creates a new authentication token that expires.

func CreateToken

func CreateToken(key string, identity string) (string, error)

CreateToken creates a new authentication token that never expires.

func New

func New(h Handler) func(events.APIGatewayProxyRequest) (events.APIGatewayProxyResponse, error)

New creates a lambda handler from a Handler and a Config.

Types

type Error

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

Error adds a status code to the error type.

func ClientErr

func ClientErr(format string, a ...interface{}) *Error

ClientErr creates a new 400 status function error.

func InternalErr

func InternalErr(format string, a ...interface{}) *Error

InternalErr creates a new function error with an encrypted message.

func ObfuscatedAuthErr

func ObfuscatedAuthErr() *Error

ObfuscatedAuthErr creates a 404 status function error. Should be used to hide the existence of pages.

func (*Error) Code

func (e *Error) Code() int

Code returns the error's http status code.

type Handler

type Handler func(*Request, *Response) *Error

Handler is a custom type representing a lambda handler.

type Request

type Request events.APIGatewayProxyRequest

Request replaces the api gateway request event.

func (*Request) Authenticate

func (r *Request) Authenticate(key, identity string) (*time.Time, error)

Authenticate validates the token in the request. Returns time at which token was issued and/or an authentication error. Returns ErrRestrictedToken if token is restricted.

func (*Request) Param

func (r *Request) Param(n string) (string, *Error)

Param reads a path parameter from the request.

type Response

type Response events.APIGatewayProxyResponse

Response replaces the api gateway response event.

func (*Response) ContentType

func (r *Response) ContentType(t string)

ContentType adds the content-type header to the request.