Adding upstream version 2.52.6.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-05-17 06:50:16 +02:00 · 2025-05-17 06:50:16 +02:00 · 6d002e9543
commit 6d002e9543
parent a960158181
441 changed files with 95392 additions and 0 deletions
--- a/docs/api/middleware/session.md
+++ b/docs/api/middleware/session.md
@ -0,0 +1,139 @@
+---
+id: session
+---
+
+# Session
+
+Session middleware for [Fiber](https://github.com/gofiber/fiber).
+
+:::note
+This middleware uses our [Storage](https://github.com/gofiber/storage) package to support various databases through a single interface. The default configuration for this middleware saves data to memory, see the examples below for other databases.
+:::
+
+## Signatures
+
+```go
+func New(config ...Config) *Store
+func (s *Store) RegisterType(i interface{})
+func (s *Store) Get(c *fiber.Ctx) (*Session, error)
+func (s *Store) Delete(id string) error
+func (s *Store) Reset() error
+
+func (s *Session) Get(key string) interface{}
+func (s *Session) Set(key string, val interface{})
+func (s *Session) Delete(key string)
+func (s *Session) Destroy() error
+func (s *Session) Reset() error
+func (s *Session) Regenerate() error
+func (s *Session) Save() error
+func (s *Session) Fresh() bool
+func (s *Session) ID() string
+func (s *Session) Keys() []string
+```
+
+:::caution
+Storing `interface{}` values are limited to built-ins Go types.
+:::
+
+## Examples
+Import the middleware package that is part of the Fiber web framework
+```go
+import (
+  "github.com/gofiber/fiber/v2"
+  "github.com/gofiber/fiber/v2/middleware/session"
+)
+```
+
+After you initiate your Fiber app, you can use the following possibilities:
+
+```go
+// Initialize default config
+// This stores all of your app's sessions
+store := session.New()
+
+app.Get("/", func(c *fiber.Ctx) error {
+    // Get session from storage
+    sess, err := store.Get(c)
+    if err != nil {
+        panic(err)
+    }
+
+    // Get value
+    name := sess.Get("name")
+
+    // Set key/value
+    sess.Set("name", "john")
+
+    // Get all Keys
+    keys := sess.Keys()
+
+    // Delete key
+    sess.Delete("name")
+
+    // Destroy session
+    if err := sess.Destroy(); err != nil {
+        panic(err)
+    }
+
+	// Sets a specific expiration for this session
+	sess.SetExpiry(time.Second * 2)
+
+    // Save session
+    if err := sess.Save(); err != nil {
+		panic(err)
+	}
+
+	return c.SendString(fmt.Sprintf("Welcome %v", name))
+})
+```
+
+## Config
+
+| Property                | Type            | Description                                                                                                 | Default               |
+|:------------------------|:----------------|:------------------------------------------------------------------------------------------------------------|:----------------------|
+| Expiration              | `time.Duration` | Allowed session duration.                                                                                   | `24 * time.Hour`      |
+| Storage                 | `fiber.Storage` | Storage interface to store the session data.                                                                | `memory.New()`        |
+| KeyLookup               | `string`        | KeyLookup is a string in the form of "`<source>:<name>`" that is used to extract session id from the request. | `"cookie:session_id"` |
+| CookieDomain            | `string`        | Domain of the cookie.                                                                                       | `""`                  |
+| CookiePath              | `string`        | Path of the cookie.                                                                                         | `""`                  |
+| CookieSecure            | `bool`          | Indicates if cookie is secure.                                                                              | `false`               |
+| CookieHTTPOnly          | `bool`          | Indicates if cookie is HTTP only.                                                                           | `false`               |
+| CookieSameSite          | `string`        | Value of SameSite cookie.                                                                                   | `"Lax"`               |
+| CookieSessionOnly       | `bool`          | Decides whether cookie should last for only the browser session. Ignores Expiration if set to true.         | `false`               |
+| KeyGenerator            | `func() string` | KeyGenerator generates the session key.                                                                     | `utils.UUIDv4`        |
+| CookieName (Deprecated) | `string`        | Deprecated: Please use KeyLookup. The session name.                                                         | `""`                  |
+
+## Default Config
+
+```go
+var ConfigDefault = Config{
+	Expiration:   24 * time.Hour,
+	KeyLookup:    "cookie:session_id",
+	KeyGenerator: utils.UUIDv4,
+	source:       "cookie",
+	sessionName:  "session_id",
+}
+```
+
+## Constants
+
+```go
+const (
+	SourceCookie   Source = "cookie"
+	SourceHeader   Source = "header"
+	SourceURLQuery Source = "query"
+)
+```
+
+### Custom Storage/Database
+
+You can use any storage from our [storage](https://github.com/gofiber/storage/) package.
+
+```go
+storage := sqlite3.New() // From github.com/gofiber/storage/sqlite3
+store := session.New(session.Config{
+	Storage: storage,
+})
+```
+
+To use the store, see the [Examples](#examples).