cookie

Documentation

Index

• func Reg(store CookieStore, args ...string)
• func RegWithOptions(opts *CookieOptions, args ...string)
• type CookieOptions
• type CookieStore
  • func New(opts *CookieOptions) CookieStore
  • func NewCookieStore(keyPairs ...[]byte) CookieStore

Functions

func Reg

func Reg(store CookieStore, args ...string)

func RegWithOptions

func RegWithOptions(opts *CookieOptions, args ...string)

Types

type CookieOptions

type CookieOptions struct {
	KeyPairs             [][]byte `json:"keyPairs"`
	*echo.SessionOptions `json:"session"`
}

type CookieStore

type CookieStore interface {
	ss.Store
}

func New

func New(opts *CookieOptions) CookieStore

func NewCookieStore

func NewCookieStore(keyPairs ...[]byte) CookieStore

Keys are defined in pairs to allow key rotation, but the common case is to set a single authentication key and optionally an encryption key.

The first key in a pair is used for authentication and the second for encryption. The encryption key can be set to nil or omitted in the last pair, but the authentication key is required in all pairs.

It is recommended to use an authentication key with 32 or 64 bytes. The encryption key, if set, must be either 16, 24, or 32 bytes to select AES-128, AES-192, or AES-256 modes.