▽

Package sessions

Constants

const (
    DefaultKey = "github.com/gin-gonic/contrib/sessions"
)

func Sessions ¶

func Sessions(name string, store Store) gin.HandlerFunc

type CookieStore ¶

type CookieStore interface {
    Store
}

func NewCookieStore ¶

func NewCookieStore(keyPairs ...[]byte) 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 ¶

Options stores configuration for a session or session store. Fields are a subset of http.Cookie fields.

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
}

type RedisStore ¶

type RedisStore interface {
    Store
}

func NewRedisStore ¶

func NewRedisStore(size int, network, address, password string, keyPairs ...[]byte) (RedisStore, error)

size: maximum number of idle connections. network: tcp or udp address: host:port password: redis-password 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 ¶

Wraps thinly gorilla-session methods. Session stores the values and optional configuration for a 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 configuration for a session.
    Options(Options)
    // Save saves all sessions used during the current request.
    Save() error
}

func Default ¶

func Default(c *gin.Context) Session

shortcut to get session

type Store ¶

type Store interface {
    sessions.Store
    Options(Options)
}

Subdirectories