cookie

Documentation

Index

• func KeyPairs(keys ...string) [][]byte
• func New(opts *CookieOptions) sessions.Store
• func NewCookieStore(keyPairs ...[]byte) sessions.Store
• func Reg(store sessions.Store, args ...string)
• func RegWithOptions(opts *CookieOptions, args ...string) sessions.Store
• type CookieOptions
  • func NewCookieOptions(keys ...string) *CookieOptions

Functions

func KeyPairs

func KeyPairs(keys ...string) [][]byte

KeyPairs Convert hashKey and blockKey to bytes @param hashKey @param blockKey

func New

func New(opts *CookieOptions) sessions.Store

func NewCookieStore

func NewCookieStore(keyPairs ...[]byte) sessions.Store

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.

func Reg

func Reg(store sessions.Store, args ...string)

func RegWithOptions

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

Types

type CookieOptions

type CookieOptions struct {
	KeyPairs [][]byte `json:"-"`
}

func NewCookieOptions

func NewCookieOptions(keys ...string) *CookieOptions