session

README

Echo SCS Session Middleware

All credit must go to alexedwards for his great package scs

Features (As per SCS)

• Automatic loading and saving of session data via middleware.
• Choice of server-side session stores including PostgreSQL, MySQL, Redis, BadgerDB and BoltDB. Custom session stores are also supported.
• Supports multiple sessions per request, 'flash' messages, session token regeneration, idle and absolute session timeouts, and 'remember me' functionality.
• Easy to extend and customize. Communicate session tokens to/from clients in HTTP headers or request/response bodies.
• Efficient design. Smaller, faster and uses less memory than gorilla/sessions.

Instructions

• Installation
• Basic Use

Installation

This package requires Go 1.12 or newer.

$ go get github.com/spazzymoto/echo-scs-session

Basic Use

See scs for further configuration options for scs sessions

package main

import (
	"net/http"
	"time"

	"github.com/alexedwards/scs/v2"
	"github.com/labstack/echo/v4"
	"github.com/spazzymoto/echo-scs-session"
)

var sessionManager *scs.SessionManager

func main() {
	// Initialize a new session manager and configure the session lifetime.
	sessionManager = scs.New()
	sessionManager.Lifetime = 24 * time.Hour

	e := echo.New()

	// Use the LoadAndSave() middleware.
	e.Use(session.LoadAndSave(sessionManager))

	e.GET("/put", putHandler)
	e.GET("/get", getHandler)

	e.Logger.Fatal(e.Start(":4000"))
}

func putHandler(c echo.Context) error {
	// Store a new key and value in the session data.
	sessionManager.Put(c.Request().Context(), "message", "Hello from a session!")

	return c.String(http.StatusOK, "")
}

func getHandler(c echo.Context) error {
	// Use the GetString helper to retrieve the string value associated with a
	// key. The zero value is returned if the key does not exist.
	msg := sessionManager.GetString(c.Request().Context(), "message")

	return c.String(http.StatusOK, msg)
}

$ curl -i --cookie-jar cj --cookie cj localhost:4000/put
HTTP/1.1 200 OK
Cache-Control: no-cache="Set-Cookie"
Content-Type: text/plain; charset=UTF-8
Set-Cookie: session=0KumL8V5WYuvZwEQj2IPrYvm-cC3y7m8xQWLhTmxq_U; Path=/; HttpOnly; SameSite=Lax
Vary: Cookie
Date: Thu, 20 May 2021 14:47:23 GMT
Content-Length: 0

$ curl -i --cookie-jar cj --cookie cj localhost:4000/get
HTTP/1.1 200 OK
Content-Type: text/plain; charset=UTF-8
Date: Thu, 20 May 2021 14:47:40 GMT
Content-Length: 21

Hello from a session!

Documentation

Index

• Variables
• func LoadAndSave(sessionManager *scs.SessionManager) echo.MiddlewareFunc
• func LoadAndSaveWithConfig(config SessionConfig) echo.MiddlewareFunc
• type SessionConfig

Variables

var DefaultSessionConfig = SessionConfig{
	Skipper: middleware.DefaultSkipper,
}

Functions

func LoadAndSave

func LoadAndSave(sessionManager *scs.SessionManager) echo.MiddlewareFunc

func LoadAndSaveWithConfig

func LoadAndSaveWithConfig(config SessionConfig) echo.MiddlewareFunc

Types

type SessionConfig

type SessionConfig struct {
	Skipper        middleware.Skipper
	SessionManager *scs.SessionManager
}