gorillastore

Documentation

Index

• type GenericStore
  • func NewGenericStore(store SessionStorer, keyPairs ...[]byte) *GenericStore
  • func (s *GenericStore) Get(r *http.Request, name string) (*sessions.Session, error)
  • func (s *GenericStore) MaxAge(age int)
  • func (s *GenericStore) MaxLength(l int)
  • func (s *GenericStore) New(r *http.Request, name string) (*sessions.Session, error)
  • func (s *GenericStore) Save(r *http.Request, w http.ResponseWriter, session *sessions.Session) error
• type SessionStorer

Types

type GenericStore

type GenericStore struct {
	Codecs  []securecookie.Codec
	Options *sessions.Options // default configuration
	// contains filtered or unexported fields
}

GenericStore stores sessions in the filesystem.

It also serves as a reference for custom stores.

This store is still experimental and not well tested. Feedback is welcome.

func NewGenericStore

func NewGenericStore(store SessionStorer, keyPairs ...[]byte) *GenericStore

NewGenericStore returns a new GenericStore.

See NewCookieStore() for a description of the other parameters.

func (*GenericStore) Get

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

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

See CookieStore.Get().

func (*GenericStore) MaxAge

func (s *GenericStore) MaxAge(age int)

MaxAge sets the maximum age for the store and the underlying cookie implementation. Individual sessions can be deleted by setting Options.MaxAge = -1 for that session.

func (*GenericStore) MaxLength

func (s *GenericStore) MaxLength(l int)

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 GenericStore is 4096.

func (*GenericStore) New

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

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

See CookieStore.New().

func (*GenericStore) Save

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

Save adds a single session to the response.

If the Options.MaxAge of the session is <= 0 then the session file will be deleted from the store path. With this process it enforces the properly session cookie handling so no need to trust in the cookie management in the web browser.

type SessionStorer

type SessionStorer interface {
	// Delete should remove the session token and corresponding data from the
	// session store. If the token does not exist then Delete should be a no-op
	// and return nil (not an error).
	Delete(token string) (err error)

	// Find should return the data for a session token from the store. If the
	// session token is not found or is expired, the found return value should
	// be false (and the err return value should be nil). Similarly, tampered
	// or malformed tokens should result in a found return value of false and a
	// nil err value. The err return value should be used for system errors only.
	Find(token string) (b []byte, found bool, err error)

	// Commit should add the session token and data to the store, with the given
	// expiry time. If the session token already exists, then the data and
	// expiry time should be overwritten.
	Commit(token string, b []byte, expiry time.Time) (err error)
}

SessionStorer is the interface for session stores.