Session

Session middleware for Fiber

Signatures

  1. func New(config ...Config) fiber.Handler

Examples

Import the middleware package that is part of the Fiber web framework

  1. import (
  2.   "github.com/gofiber/fiber/v2"
  3.   "github.com/gofiber/fiber/v2/middleware/session"
  4. )

After you initiate your Fiber app, you can use the following possibilities:

  1. // Default middleware config
  2. store := session.New()
  4. // This panic will be catch by the middleware
  5. app.Get("/", func(c *fiber.Ctx) error {
  6.     // get session from storage
  7.     sess, err := store.Get(c)
  8.     if err != nil {
  9.         panic(err)
  10.     }
  12.     // save session
  13.     defer sess.Save()
  15.     // Get value
  16.     name := sess.Get("name")
  18.     // Set key/value
  19.     sess.Set("name", "john")
  21.     // Delete key
  22.     sess.Delete("name")
  24.     // Destroy session
  25.     if err := sess.Destroy(); err != nil {
  26.         panic(err)
  27.     }
  29.     return c.SendString(fmt.Sprintf("Welcome %v", name))
  30. })

Config

  1. // Config defines the config for middleware.
  2. type Config struct {
  3.     // Allowed session duration
  4.     // Optional. Default value 24 * time.Hour
  5.     Expiration time.Duration
  7.     // Storage interface to store the session data
  8.     // Optional. Default value memory.New()
  9.     Storage fiber.Storage
  11.     // Name of the session cookie. This cookie will store session key.
  12.     // Optional. Default value "session_id".
  13.     CookieName string
  15.     // Domain of the CSRF cookie.
  16.     // Optional. Default value "".
  17.     CookieDomain string
  19.     // Path of the CSRF cookie.
  20.     // Optional. Default value "".
  21.     CookiePath string
  23.     // Indicates if CSRF cookie is secure.
  24.     // Optional. Default value false.
  25.     CookieSecure bool
  27.     // Indicates if CSRF cookie is HTTP only.
  28.     // Optional. Default value false.
  29.     CookieHTTPOnly bool
  31.     // Indicates if CSRF cookie is HTTP only.
  32.     // Optional. Default value false.
  33.     CookieSameSite string
  35.     // KeyGenerator generates the session key.
  36.     // Optional. Default value utils.UUID
  37.     KeyGenerator func() string
  38. }

Default Config

  1. var ConfigDefault = Config{
  2.     Expiration:   24 * time.Hour,
  3.     CookieName:   "session_id",
  4.     KeyGenerator: utils.UUID,
  5. }