csrf

Documentation

Index

• Variables
• type Config
  • func Cache(client cache.Client) Config
  • func Cookie(cookie cookie.Cookie) Config
  • func Enabled(enabled ...bool) Config
  • func Expiration(expiration time.Duration) Config
  • func Request(request *http.Request) Config
• type Csrf
  • func New(configs ...Config) Csrf
• type Token

Variables

var (
	ErrorInvalidToken   = errors.New("invalid csrf token")
	ErrorMissingCookies = errors.New("missing http header cookies")
)

Types

type Config

type Config interface{}

func Cache

func Cache(client cache.Client) Config

func Cookie

func Cookie(cookie cookie.Cookie) Config

func Enabled

func Enabled(enabled ...bool) Config

func Expiration

func Expiration(expiration time.Duration) Config

func Request

func Request(request *http.Request) Config

type Csrf

type Csrf interface {
	Exists(name, value string) (bool, error)
	Get(name, value string) (Token, error)
	Create(token Token) (string, error)
	Destroy(token Token) error
	Clean(ignore string) error

	IsEnabled() bool
	GetExpiration() time.Duration

	MustExists(name, value string) bool
	MustGet(name, value string) Token
	MustCreate(token Token) string
	MustDestroy(token Token)
	MustClean(ignore string)
}

func New

func New(configs ...Config) Csrf

type Token

type Token struct {
	Exists    bool   `json:"exists"`
	Name      string `json:"name"`
	Ip        string `json:"ip"`
	UserAgent string `json:"userAgent"`
	Value     string `json:"value"`
}