auth

Documentation

Overview

Package auth provides filtering support for a martian.Proxy based on ctx.Auth.ID.

Index

• Variables
• type Filter
  • func NewFilter() *Filter
  • func (f *Filter) ModifyRequest(ctx *martian.Context, req *http.Request) error
  • func (f *Filter) ModifyResponse(ctx *martian.Context, res *http.Response) error
  • func (f *Filter) RequestModifier(id string) martian.RequestModifier
  • func (f *Filter) ResponseModifier(id string) martian.ResponseModifier
  • func (f *Filter) SetAuthRequired(required bool)
  • func (f *Filter) SetRequestModifier(id string, reqmod martian.RequestModifier) error
  • func (f *Filter) SetResponseModifier(id string, resmod martian.ResponseModifier) error

Variables

var ErrIDRequired = errors.New("ID required")

ErrIDRequired indicates that the filter must have an ID.

Types

type Filter

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

Filter filters RequestModifiers and ResponseModifiers by ctx.Auth.ID.

func NewFilter

func NewFilter() *Filter

NewFilter returns a new auth.Filter.

func (*Filter) ModifyRequest

func (f *Filter) ModifyRequest(ctx *martian.Context, req *http.Request) error

ModifyRequest runs the RequestModifier for the associated ctx.Auth.ID. If no modifier is found for ctx.Auth.ID then ctx.Auth.Error is set.

func (*Filter) ModifyResponse

func (f *Filter) ModifyResponse(ctx *martian.Context, res *http.Response) error

ModifyResponse runs the ResponseModifier for the associated ctx.Auth.ID. If no modifier is found for ctx.Auth.ID then ctx.Auth.Error is set.

func (*Filter) RequestModifier

func (f *Filter) RequestModifier(id string) martian.RequestModifier

RequestModifier retrieves the RequestModifier for the given ID. Returns nil if no modifier exists for the given ID.

func (*Filter) ResponseModifier

func (f *Filter) ResponseModifier(id string) martian.ResponseModifier

ResponseModifier retrieves the ResponseModifier for the given ID. Returns nil if no modifier exists for the given ID.

func (*Filter) SetAuthRequired

func (f *Filter) SetAuthRequired(required bool)

SetAuthRequired determines whether the ctx.Auth.ID must have an associated RequestModifier or ResponseModifier. If true, it will set ctx.Auth.Error.

func (*Filter) SetRequestModifier

func (f *Filter) SetRequestModifier(id string, reqmod martian.RequestModifier) error

SetRequestModifier sets the RequestModifier for the given ID. It will overwrite any existing modifier with the same ID. Returns ErrIDRequired if id is empty.

func (*Filter) SetResponseModifier

func (f *Filter) SetResponseModifier(id string, resmod martian.ResponseModifier) error

SetResponseModifier sets the ResponseModifier for the given ID. It will overwrite any existing modifier with the same ID. Returns ErrIDRequired if id is empty.