README
¶
negroni-sessions 
Negroni middleware/handler for easy session management.
Usage
package main
import (
"github.com/codegangsta/negroni"
"github.com/goincremental/negroni-sessions"
"net/http"
)
func main() {
n := negroni.Classic()
store := sessions.NewCookieStore([]byte("secret123"))
n.Use(sessions.Sessions("my_session", store))
mux := http.NewServeMux()
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
session := sessions.GetSession(req)
session.Set("hello", "world")
})
n.UseHandler(mux)
n.Run(":3000")
}
Authors
Documentation
¶
Overview ¶
Package sessions contains middleware for easy session management in Negroni. Based on github.com/martini-contrib/sessions
package main
import (
"github.com/codegangsta/negroni"
"github.com/goincremental/negroni-sessions"
"net/http"
)
func main() {
n := negroni.Classic()
store := sessions.NewCookieStore([]byte("secret123"))
n.Use(sessions.Sessions("my_session", store))
mux := http.NewServeMux()
mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
session := sessions.GetSession(req)
session.Set("hello", "world")
})
}
Index ¶
- Variables
- func Sessions(name string, store Store) negroni.HandlerFunc
- type Options
- type Session
- type Store
- func NewCookieStore(keyPairs ...[]byte) Store
- func NewDalStore(connection dal.Connection, database string, collection string, maxAge int, ...) Store
- func NewMongoStore(session mgo.Session, database string, collection string, maxAge int, ...) Store
- func NewRediStore(size int, network, address, password string, keyPairs ...[]byte) (Store, error)
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidId = errors.New("session: invalid session id") ErrInvalidModified = errors.New("mongostore: invalid modified value") )
Functions ¶
Types ¶
type Options ¶
type Options struct {
Path string
Domain string
// MaxAge=0 means no 'Max-Age' attribute specified.
// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'.
// MaxAge>0 means Max-Age attribute present and given in seconds.
MaxAge int
Secure bool
HTTPOnly bool
}
Options stores configuration for a session or session store.
Fields are a subset of http.Cookie fields.
type Session ¶
type Session interface {
// Get returns the session value associated to the given key.
Get(key interface{}) interface{}
// Set sets the session value associated to the given key.
Set(key interface{}, val interface{})
// Delete removes the session value associated to the given key.
Delete(key interface{})
// Clear deletes all values in the session.
Clear()
// AddFlash adds a flash message to the session.
// A single variadic argument is accepted, and it is optional: it defines the flash key.
// If not defined "_flash" is used by default.
AddFlash(value interface{}, vars ...string)
// Flashes returns a slice of flash messages from the session.
// A single variadic argument is accepted, and it is optional: it defines the flash key.
// If not defined "_flash" is used by default.
Flashes(vars ...string) []interface{}
// Options sets confuguration for a session.
Options(Options)
}
Session stores the values and optional configuration for a session.
func GetSession ¶
GetSession returns the session stored in the request context
type Store ¶
Store is an interface for custom session stores.
func NewCookieStore ¶
NewCookieStore returns a new CookieStore.
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 NewDalStore ¶
func NewDalStore(connection dal.Connection, database string, collection string, maxAge int, ensureTTL bool, keyPairs ...[]byte) Store
NewDalStore is a factory function that returns a store object using the provided dal.Connection
Source Files