session

README

session

A efficient, easy-to-use Go session library.

Quick Start

Download and install

$ go get -u -v gopkg.in/session.v2

Create file server.go

package main

import (
	"context"
	"fmt"
	"net/http"

	"gopkg.in/session.v2"
)

func main() {
	session.InitManager(
		session.SetCookieName("session_id"),
		session.SetSign([]byte("sign")),
	)

	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		store, err := session.Start(context.Background(), w, r)
		if err != nil {
			fmt.Fprint(w, err)
			return
		}

		store.Set("foo", "bar")
		err = store.Save()
		if err != nil {
			fmt.Fprint(w, err)
			return
		}

		http.Redirect(w, r, "/foo", 302)
	})

	http.HandleFunc("/foo", func(w http.ResponseWriter, r *http.Request) {
		store, err := session.Start(context.Background(), w, r)
		if err != nil {
			fmt.Fprint(w, err)
			return
		}

		foo, ok := store.Get("foo")
		if ok {
			fmt.Fprintf(w, "foo:%s", foo)
			return
		}
		fmt.Fprint(w, "does not exist")
	})

	http.ListenAndServe(":8080", nil)
}

Build and run

$ go build server.go
$ ./server

Open in your web browser

http://localhost:8080

foo:bar

Features

• Easy to use
• Multi-storage support
• More secure, signature-based tamper-proof

MIT License

Copyright (c) 2018 Lyric

Documentation

Index

• Variables
• func Destroy(ctx context.Context, w http.ResponseWriter, r *http.Request) error
• func FromReqContext(ctx context.Context) (*http.Request, bool)
• func FromResContext(ctx context.Context) (http.ResponseWriter, bool)
• func InitManager(opt ...Option)
• type Manager
  • func NewManager(opt ...Option) *Manager
  • func (m *Manager) Destroy(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (m *Manager) Start(ctx context.Context, w http.ResponseWriter, r *http.Request) (Store, error)
• type ManagerStore
  • func NewFileStore(path string) ManagerStore
  • func NewMemoryStore() ManagerStore
• type Option
  • func SetCookieLifeTime(cookieLifeTime int) Option
  • func SetCookieName(cookieName string) Option
  • func SetDomain(domain string) Option
  • func SetExpired(expired int64) Option
  • func SetSecure(secure bool) Option
  • func SetSessionID(sessionID func() string) Option
  • func SetSign(sign []byte) Option
  • func SetStore(store ManagerStore) Option
• type Store
  • func Start(ctx context.Context, w http.ResponseWriter, r *http.Request) (Store, error)

Variables

var (
	// ErrInvalidSessionID invalid session id
	ErrInvalidSessionID = errors.New("invalid session id")
)

Functions

func Destroy

func Destroy(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Destroy Destroy a session

func FromReqContext

func FromReqContext(ctx context.Context) (*http.Request, bool)

FromReqContext returns the Request value stored in ctx, if any.

func FromResContext

func FromResContext(ctx context.Context) (http.ResponseWriter, bool)

FromResContext returns the ResponseWriter value stored in ctx, if any.

func InitManager

func InitManager(opt ...Option)

InitManager Initialize the global session management instance

Types

type Manager

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

Manager A session management instance, including start and destroy operations

func NewManager

func NewManager(opt ...Option) *Manager

NewManager Create a session management instance

func (*Manager) Destroy

func (m *Manager) Destroy(ctx context.Context, w http.ResponseWriter, r *http.Request) error

Destroy Destroy a session

func (*Manager) Start

func (m *Manager) Start(ctx context.Context, w http.ResponseWriter, r *http.Request) (Store, error)

Start Start a session and return to session storage

type ManagerStore

type ManagerStore interface {
	// Create a session store and specify the expiration time (in seconds)
	Create(ctx context.Context, sid string, expired int64) (Store, error)
	// Update a session store and specify the expiration time (in seconds)
	Update(ctx context.Context, sid string, expired int64) (Store, error)
	// Delete a session store
	Delete(ctx context.Context, sid string) error
	// Check the session store exists
	Check(ctx context.Context, sid string) (bool, error)
	// Close storage, release resources
	Close() error
}

ManagerStore Management of session storage, including creation, update, and delete operations

func NewFileStore

func NewFileStore(path string) ManagerStore

NewFileStore Create an instance of a file store

func NewMemoryStore

func NewMemoryStore() ManagerStore

NewMemoryStore Create an instance of a memory store

type Option

type Option func(*options)

Option A session parameter options

func SetCookieLifeTime

func SetCookieLifeTime(cookieLifeTime int) Option

SetCookieLifeTime Set the cookie expiration time (in seconds)

func SetCookieName

func SetCookieName(cookieName string) Option

SetCookieName Set the cookie name

func SetDomain

func SetDomain(domain string) Option

SetDomain Set the domain name of the cookie

func SetExpired

func SetExpired(expired int64) Option

SetExpired Set session expiration time (in seconds)

func SetSecure

func SetSecure(secure bool) Option

SetSecure Set cookie security

func SetSessionID

func SetSessionID(sessionID func() string) Option

SetSessionID Set callback function to generate session id

func SetSign

func SetSign(sign []byte) Option

SetSign Set the session id signature value

func SetStore

func SetStore(store ManagerStore) Option

SetStore Set session management storage

type Store

type Store interface {
	// Get a session storage context
	Context() context.Context
	// Get the current session id
	SessionID() string
	// Set session value, call save function to take effect
	Set(key, value string)
	// Get session value
	Get(key string) (string, bool)
	// Delete session value, call save function to take effect
	Delete(key string) string
	// Clear all session data, call save function to take effect
	Flush()
	// Save session data
	Save() error
}

Store A session id storage operation

func Start

func Start(ctx context.Context, w http.ResponseWriter, r *http.Request) (Store, error)

Start Start a session and return to session storage