gorilla/sessions

Package gorilla/sessions provides cookie and filesystem sessions and infrastructure for custom session backends.

Github stars Tracking Chart

sessions

GoDoc Build Status
Sourcegraph

gorilla/sessions provides cookie and filesystem sessions and infrastructure for
custom session backends.

The key features are:

  • Simple API: use it as an easy way to set signed (and optionally
    encrypted) cookies.
  • Built-in backends to store sessions in cookies or the filesystem.
  • Flash messages: session values that last until read.
  • Convenient way to switch session persistency (aka "remember me") and set
    other attributes.
  • Mechanism to rotate authentication and encryption keys.
  • Multiple sessions per request, even using different backends.
  • Interfaces and infrastructure for custom session backends: sessions from
    different stores can be retrieved and batch-saved using a common API.

Let's start with an example that shows the sessions API in a nutshell:

	import (
		"net/http"
		"github.com/gorilla/sessions"
	)

	// Note: Don't store your key in your source code. Pass it via an
	// environmental variable, or flag (or both), and don't accidentally commit it
	// alongside your code. Ensure your key is sufficiently random - i.e. use Go's
	// crypto/rand or securecookie.GenerateRandomKey(32) and persist the result.
	var store = sessions.NewCookieStore([]byte(os.Getenv("SESSION_KEY")))

	func MyHandler(w http.ResponseWriter, r *http.Request) {
		// Get a session. We're ignoring the error resulted from decoding an
		// existing session: Get() always returns a session, even if empty.
		session, _ := store.Get(r, "session-name")
		// Set some session values.
		session.Values["foo"] = "bar"
		session.Values[42] = 43
		// Save it before we write to the response/return from the handler.
		err = session.Save(r, w)
		if err != nil {
			http.Error(w, err.Error(), http.StatusInternalServerError)
			return
		}
	}

First we initialize a session store calling NewCookieStore() and passing a
secret key used to authenticate the session. Inside the handler, we call
store.Get() to retrieve an existing session or create a new one. Then we set
some session values in session.Values, which is a map[interface{}]interface{}.
And finally we call session.Save() to save the session in the response.

More examples are available on the Gorilla
website
.

Store Implementations

Other implementations of the sessions.Store interface:

License

BSD licensed. See the LICENSE file for details.

Main metrics

Overview
Name With Ownergorilla/sessions
Primary LanguageGo
Program languageGo (Language Count: 2)
Platform
License:BSD 3-Clause "New" or "Revised" License
所有者活动
Created At2012-10-02 21:33:02
Pushed At2024-08-20 14:12:54
Last Commit At
Release Count9
Last Release Namev1.4.0 (Posted on )
First Release Namev1.1 (Posted on )
用户参与
Stargazers Count3.1k
Watchers Count55
Fork Count374
Commits Count152
Has Issues Enabled
Issues Count166
Issue Open Count3
Pull Requests Count85
Pull Requests Open Count4
Pull Requests Close Count30
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private