README
¶
sessions 
Martini middleware/handler for easy session management.
Usage
package main
import (
"github.com/go-martini/martini"
"github.com/martini-contrib/sessions"
)
func main() {
m := martini.Classic()
store := sessions.NewCookieStore([]byte("secret123"))
m.Use(sessions.Sessions("my_session", store))
m.Get("/set", func(session sessions.Session) string {
session.Set("hello", "world")
return "OK"
})
m.Get("/get", func(session sessions.Session) string {
v := session.Get("hello")
if v == nil {
return ""
}
return v.(string)
})
m.Run()
}
Authors
Documentation
¶
Overview ¶
Package sessions contains middleware for easy session management in Martini.
package main
import (
"github.com/go-martini/martini"
"github.com/martini-contrib/sessions"
)
func main() {
m := martini.Classic()
store := sessions.NewCookieStore([]byte("secret123"))
m.Use(sessions.Sessions("my_session", store))
m.Get("/", func(session sessions.Session) string {
session.Set("hello", "world")
})
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CookieStore ¶
type CookieStore interface {
// Store is an embedded interface so that CookieStore can be used
// as a session store.
Store
// Options sets the default options for each session stored in this
// CookieStore.
Options(Options)
}
CookieStore is an interface that represents a Cookie based storage for Sessions.
func NewCookieStore ¶
func NewCookieStore(maxAge int, keyPairs ...[]byte) CookieStore
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.
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 RediStore ¶
type RediStore interface {
// Store is an embedded interface so that RedisStore can be used
// as a session store.
Store
// Options sets the default options for each session stored in this
// CookieStore.
Options(Options)
}
RedisStore is an interface that represents a Cookie based storage for Sessions.
func NewRediStore ¶
func NewRediStore(size int, network, address, password string, keyPairs ...[]byte) (RediStore, error)
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.
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.
Source Files