redistore

README

redistore

A fork of redistore, a session store backend for gorilla/sessions. It uses go-redis instead of redigo.

Requirements

Depends on the go-redis library.

Installation

go get github.com/climech/redistore

Documentation

See http://www.gorillatoolkit.org/pkg/sessions for full documentation on underlying interface.

Example

// Fetch new store.
store, err := NewRediStore(":6379", "", []byte("secret-key"))
if err != nil {
	panic(err)
}
defer store.Close()

// Get a session.
session, err = store.Get(req, "session-name")
if err != nil {
	log.Error(err.Error())
}

// Add a value.
session.Values["foo"] = "bar"

// Save.
if err = sessions.Save(req, rsp); err != nil {
	t.Fatalf("Error saving session: %v", err)
}

// Delete session.
session.Options.MaxAge = -1
if err = sessions.Save(req, rsp); err != nil {
	t.Fatalf("Error saving session: %v", err)
}

// Change session storage configuration for MaxAge = 10 days.
store.SetMaxAge(10 * 24 * 3600)

Documentation

Overview

Package redistore is a session store backend for gorilla/sessions

Index

• type GobSerializer
  • func (s GobSerializer) Deserialize(d []byte, ss *sessions.Session) error
  • func (s GobSerializer) Serialize(ss *sessions.Session) ([]byte, error)
• type JSONSerializer
  • func (s JSONSerializer) Deserialize(d []byte, ss *sessions.Session) error
  • func (s JSONSerializer) Serialize(ss *sessions.Session) ([]byte, error)
• type RediStore
  • func NewRediStore(address, password string, keyPairs ...[]byte) (*RediStore, error)
  • func NewRediStoreWithClient(client *redis.Client, keyPairs ...[]byte) (*RediStore, error)
  • func NewRediStoreWithDB(address, password string, db int, keyPairs ...[]byte) (*RediStore, error)
  • func (s *RediStore) Close() error
  • func (s *RediStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (s *RediStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (s *RediStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
  • func (s *RediStore) SetKeyPrefix(p string)
  • func (s *RediStore) SetMaxAge(v int)
  • func (s *RediStore) SetMaxLength(l int)
  • func (s *RediStore) SetSerializer(ss SessionSerializer)
• type SessionSerializer

Examples

• RediStore

Types

type GobSerializer

type GobSerializer struct{}

GobSerializer uses gob package to encode the session map

func (GobSerializer) Deserialize

func (s GobSerializer) Deserialize(d []byte, ss *sessions.Session) error

Deserialize back to map[interface{}]interface{}

func (GobSerializer) Serialize

func (s GobSerializer) Serialize(ss *sessions.Session) ([]byte, error)

Serialize using gob

type JSONSerializer

type JSONSerializer struct{}

JSONSerializer encode the session map to JSON.

func (JSONSerializer) Deserialize

func (s JSONSerializer) Deserialize(d []byte, ss *sessions.Session) error

Deserialize back to map[string]interface{}

func (JSONSerializer) Serialize

func (s JSONSerializer) Serialize(ss *sessions.Session) ([]byte, error)

Serialize to JSON. Will err if there are unmarshalable key values

type RediStore

type RediStore struct {
	Client        *redis.Client
	Codecs        []securecookie.Codec
	Options       *sessions.Options // default configuration
	DefaultMaxAge int               // default Redis TTL for a MaxAge == 0 session
	// contains filtered or unexported fields
}

RediStore stores sessions in a redis backend.

Example

// RedisStore
store, err := NewRediStore(":6379", "", []byte("secret-key"))
if err != nil {
	panic(err)
}
defer store.Close()

func NewRediStore

func NewRediStore(address, password string, keyPairs ...[]byte) (*RediStore, error)

NewRediStore returns a new RediStore. size: maximum number of idle connections.

func NewRediStoreWithClient

func NewRediStoreWithClient(client *redis.Client, keyPairs ...[]byte) (*RediStore, error)

NewRediStoreWithClient instantiates a RediStore with a *redis.Client passed in.

func NewRediStoreWithDB

func NewRediStoreWithDB(address, password string, db int, keyPairs ...[]byte) (*RediStore, error)

NewRediStoreWithDB - like NewRedisStore but accepts `db` parameter to select redis DB instead of using the default one (0).

func (*RediStore) Close

func (s *RediStore) Close() error

Close closes the underlying *redis.Client

func (*RediStore) Get

func (s *RediStore) Get(r *http.Request, name string) (*sessions.Session, error)

Get returns a session for the given name after adding it to the registry.

See gorilla/sessions FilesystemStore.Get().

func (*RediStore) New

func (s *RediStore) New(r *http.Request, name string) (*sessions.Session, error)

New returns a session for the given name without adding it to the registry.

See gorilla/sessions FilesystemStore.New().

func (*RediStore) Save

func (s *RediStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error

Save adds a single session to the response.

func (*RediStore) SetKeyPrefix

func (s *RediStore) SetKeyPrefix(p string)

SetKeyPrefix set the prefix

func (*RediStore) SetMaxAge

func (s *RediStore) SetMaxAge(v int)

SetMaxAge restricts the maximum age, in seconds, of the session record both in database and a browser. This is to change session storage configuration. If you want just to remove session use your session `s` object and change it's `Options.MaxAge` to -1, as specified in

http://godoc.org/github.com/gorilla/sessions#Options

Default is the one provided by this package value - `sessionExpire`. Set it to 0 for no restriction. Because we use `MaxAge` also in SecureCookie crypting algorithm you should use this function to change `MaxAge` value.

func (*RediStore) SetMaxLength

func (s *RediStore) SetMaxLength(l int)

SetMaxLength sets RediStore.maxLength if the `l` argument is greater or equal 0 maxLength restricts the maximum length of new sessions to l. If l is 0 there is no limit to the size of a session, use with caution. The default for a new RediStore is 4096. Redis allows for max. value sizes of up to 512MB (http://redis.io/topics/data-types) Default: 4096,

func (*RediStore) SetSerializer

func (s *RediStore) SetSerializer(ss SessionSerializer)

SetSerializer sets the serializer

type SessionSerializer

type SessionSerializer interface {
	Deserialize(d []byte, ss *sessions.Session) error
	Serialize(ss *sessions.Session) ([]byte, error)
}

SessionSerializer provides an interface hook for alternative serializers