session

README

echo-session

Middleware echo-session is a session support for echo.

This version is working with echo v3. Please checkout v2 branch if you want use session with echo v2.

Installation

go get github.com/ipfans/echo-session

Example

package main

import (
	"github.com/ipfans/echo-session"
	"github.com/labstack/echo"
	"github.com/labstack/echo/middleware"
)

func main() {
	serv := echo.New()
	serv.Use(middleware.Logger())
	serv.Use(middleware.Recover())
	store, err := session.NewRedisStore(32, "tcp", "localhost:6379", "", []byte("secret"))
	if err != nil {
		panic(err)
	}
	serv.Use(session.Sessions("GSESSION", store))
	serv.GET("/", func(ctx echo.Context) error {
		session := session.Default(ctx)
		var count int
		v := session.Get("count")
		if v == nil {
			count = 0
		} else {
			count = v.(int)
			count += 1
		}
		session.Set("count", count)
		session.Save()
		ctx.JSON(200, map[string]interface{}{
			"visit": count,
		})
		return nil
	})
	serv.Start(":8081")
}

License

This project is under Apache v2 License. See the LICENSE file for the full license text.

Documentation

Index

• Constants
• func Sessions(name string, store Store) echo.MiddlewareFunc
• func SessionsWithKey(name, key string, store Store) echo.MiddlewareFunc
• type CookieStore
  • func NewCookieStore(keyPairs ...[]byte) CookieStore
• type FileSystemStore
  • func NewFileSystemStoreStore(path string, keyPairs ...[]byte) FileSystemStore
• type Options
• type PostgresStore
  • func NewPostgresStore(dbURL string, keyPairs ...[]byte) (PostgresStore, error)
• type RedisStore
  • func NewRedisStore(size int, network, address, password string, keyPairs ...[]byte) (RedisStore, error)
  • func NewRedisStoreWithDB(size int, network, address, password string, DB string, keyPairs ...[]byte) (RedisStore, error)
  • func NewRedisStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (RedisStore, error)
• type Session
  • func Default(ctx echo.Context) Session
• type Store

Constants

const (
	DefaultKey = "session_key"
)

Functions

func Sessions

func Sessions(name string, store Store) echo.MiddlewareFunc

func SessionsWithKey

func SessionsWithKey(name, key string, store Store) echo.MiddlewareFunc

Types

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 FileSystemStore

type FileSystemStore interface {
	Store
	MaxLength(int)
}

func NewFileSystemStoreStore

func NewFileSystemStoreStore(path string, keyPairs ...[]byte) FileSystemStore

The path argument is the directory where sessions will be saved. If empty it will use os.TempDir().

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 PostgresStore

type PostgresStore interface {
	Store
}

func NewPostgresStore

func NewPostgresStore(dbURL string, keyPairs ...[]byte) (PostgresStore, error)

type RedisStore

type RedisStore interface {
	Store
	GetStore() *redistore.RediStore
}

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.

func NewRedisStoreWithDB

func NewRedisStoreWithDB(size int, network, address, password string, DB 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. DB: database index

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 NewRedisStoreWithPool

func NewRedisStoreWithPool(pool *redis.Pool, keyPairs ...[]byte) (RedisStore, error)

pool: redis pool connections 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)
	// Save saves all sessions used during the current request.
	Save() error
}

Session stores the values and optional configuration for a session.

func Default

func Default(ctx echo.Context) Session

shortcut to get session

type Store

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