session

README

session

A simple Go library to encrypt data into a cookie and read it back out. Cookie-based sessions made simple.

Documentation

Overview

A straightforward way to keep session data in a cookie. No tricks, just simple calls.

Index

• type Cryptor
  • func NewSimpleCryptor(secretKey []byte, cookieName string) *Cryptor
  • func (sc *Cryptor) Clear(w http.ResponseWriter, r *http.Request)
  • func (sc *Cryptor) Read(v interface{}, r *http.Request) error
  • func (sc *Cryptor) Write(v interface{}, w http.ResponseWriter, r *http.Request) error
• type ErrChecksumFailed
  • func (e ErrChecksumFailed) Error() string
• type MakeCookieFunc

Types

type Cryptor

type Cryptor struct {
	SecretKey      []byte
	CookieName     string
	MakeCookieFunc MakeCookieFunc // Make cookie with the specified value
}

func NewSimpleCryptor

func NewSimpleCryptor(secretKey []byte, cookieName string) *Cryptor

func (*Cryptor) Clear

func (sc *Cryptor) Clear(w http.ResponseWriter, r *http.Request)

remove cookie (effectively destroying the session)

func (*Cryptor) Read

func (sc *Cryptor) Read(v interface{}, r *http.Request) error

func (*Cryptor) Write

func (sc *Cryptor) Write(v interface{}, w http.ResponseWriter, r *http.Request) error

seralize and encrypt v and write to cookie

type ErrChecksumFailed

type ErrChecksumFailed string

func (ErrChecksumFailed) Error

func (e ErrChecksumFailed) Error() string

type MakeCookieFunc

type MakeCookieFunc func(w http.ResponseWriter, r *http.Request) *http.Cookie

makes an empty cookie, no value