modify session module

change a log
2025-07-10 03:10:18 +00:00 · 2014-01-05 14:48:36 +08:00
parent 95c65de97c
commit 481448fa90
11 changed files with 551 additions and 142 deletions
--- a/session/session.go
+++ b/session/session.go
@ -6,6 +6,7 @@ import (
 	"crypto/rand"
 	"crypto/sha1"
 	"encoding/hex"
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@ -14,16 +15,16 @@ import (
 )

 type SessionStore interface {
-	Set(key, value interface{}) error //set session value
-	Get(key interface{}) interface{}  //get session value
-	Delete(key interface{}) error     //delete session value
-	SessionID() string                //back current sessionID
-	SessionRelease()                  // release the resource & save data to provider
-	Flush() error                     //delete all data
+	Set(key, value interface{}) error     //set session value
+	Get(key interface{}) interface{}      //get session value
+	Delete(key interface{}) error         //delete session value
+	SessionID() string                    //back current sessionID
+	SessionRelease(w http.ResponseWriter) // release the resource & save data to provider & return the data
+	Flush() error                         //delete all data
 }

 type Provider interface {
-	SessionInit(maxlifetime int64, savePath string) error
+	SessionInit(gclifetime int64, config string) error
 	SessionRead(sid string) (SessionStore, error)
 	SessionExist(sid string) bool
 	SessionRegenerate(oldsid, sid string) (SessionStore, error)
@ -47,15 +48,21 @@ func Register(name string, provide Provider) {
 	provides[name] = provide
 }

+type managerConfig struct {
+	CookieName        string `json:"cookieName"`
+	EnableSetCookie   bool   `json:"enableSetCookie,omitempty"`
+	Gclifetime        int64  `json:"gclifetime"`
+	Maxage            int    `json:"maxage"`
+	Secure            bool   `json:"secure"`
+	SessionIDHashFunc string `json:"sessionIDHashFunc"`
+	SessionIDHashKey  string `json:"sessionIDHashKey"`
+	CookieLifeTime    int64  `json:"cookieLifeTime"`
+	ProviderConfig    string `json:"providerConfig"`
+}
+
 type Manager struct {
-	cookieName  string //private cookiename
-	provider    Provider
-	maxlifetime int64
-	hashfunc    string //support md5 & sha1
-	hashkey     string
-	maxage      int //cookielifetime
-	secure      bool
-	options     []interface{}
+	provider Provider
+	config   *managerConfig
 }

 //options
@ -63,74 +70,49 @@ type Manager struct {
 //2. hashfunc  default sha1
 //3. hashkey default beegosessionkey
 //4. maxage default is none
-func NewManager(provideName, cookieName string, maxlifetime int64, savePath string, options ...interface{}) (*Manager, error) {
+func NewManager(provideName, config string) (*Manager, error) {
 	provider, ok := provides[provideName]
 	if !ok {
 		return nil, fmt.Errorf("session: unknown provide %q (forgotten import?)", provideName)
 	}
-	provider.SessionInit(maxlifetime, savePath)
-	secure := false
-	if len(options) > 0 {
-		secure = options[0].(bool)
+	cf := new(managerConfig)
+	cf.EnableSetCookie = true
+	err := json.Unmarshal([]byte(config), cf)
+	if err != nil {
+		return nil, err
 	}
-	hashfunc := "sha1"
-	if len(options) > 1 {
-		hashfunc = options[1].(string)
+	provider.SessionInit(cf.Gclifetime, cf.ProviderConfig)
+
+	if cf.SessionIDHashFunc == "" {
+		cf.SessionIDHashFunc = "sha1"
 	}
-	hashkey := "beegosessionkey"
-	if len(options) > 2 {
-		hashkey = options[2].(string)
-	}
-	maxage := -1
-	if len(options) > 3 {
-		switch options[3].(type) {
-		case int:
-			if options[3].(int) > 0 {
-				maxage = options[3].(int)
-			} else if options[3].(int) < 0 {
-				maxage = 0
-			}
-		case int64:
-			if options[3].(int64) > 0 {
-				maxage = int(options[3].(int64))
-			} else if options[3].(int64) < 0 {
-				maxage = 0
-			}
-		case int32:
-			if options[3].(int32) > 0 {
-				maxage = int(options[3].(int32))
-			} else if options[3].(int32) < 0 {
-				maxage = 0
-			}
-		}
+	if cf.SessionIDHashKey == "" {
+		cf.SessionIDHashKey = string(generateRandomKey(16))
 	}
+
 	return &Manager{
-		provider:    provider,
-		cookieName:  cookieName,
-		maxlifetime: maxlifetime,
-		hashfunc:    hashfunc,
-		hashkey:     hashkey,
-		maxage:      maxage,
-		secure:      secure,
-		options:     options,
+		provider,
+		cf,
 	}, nil
 }

 //get Session
 func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (session SessionStore) {
-	cookie, err := r.Cookie(manager.cookieName)
+	cookie, err := r.Cookie(manager.config.CookieName)
 	if err != nil || cookie.Value == "" {
 		sid := manager.sessionId(r)
 		session, _ = manager.provider.SessionRead(sid)
-		cookie = &http.Cookie{Name: manager.cookieName,
+		cookie = &http.Cookie{Name: manager.config.CookieName,
 			Value:    url.QueryEscape(sid),
 			Path:     "/",
 			HttpOnly: true,
-			Secure:   manager.secure}
-		if manager.maxage >= 0 {
-			cookie.MaxAge = manager.maxage
+			Secure:   manager.config.Secure}
+		if manager.config.Maxage >= 0 {
+			cookie.MaxAge = manager.config.Maxage
+		}
+		if manager.config.EnableSetCookie {
+			http.SetCookie(w, cookie)
 		}
-		http.SetCookie(w, cookie)
 		r.AddCookie(cookie)
 	} else {
 		sid, _ := url.QueryUnescape(cookie.Value)
@ -139,15 +121,17 @@ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (se
 		} else {
 			sid = manager.sessionId(r)
 			session, _ = manager.provider.SessionRead(sid)
-			cookie = &http.Cookie{Name: manager.cookieName,
+			cookie = &http.Cookie{Name: manager.config.CookieName,
 				Value:    url.QueryEscape(sid),
 				Path:     "/",
 				HttpOnly: true,
-				Secure:   manager.secure}
-			if manager.maxage >= 0 {
-				cookie.MaxAge = manager.maxage
+				Secure:   manager.config.Secure}
+			if manager.config.Maxage >= 0 {
+				cookie.MaxAge = manager.config.Maxage
+			}
+			if manager.config.EnableSetCookie {
+				http.SetCookie(w, cookie)
 			}
-			http.SetCookie(w, cookie)
 			r.AddCookie(cookie)
 		}
 	}
@ -156,13 +140,17 @@ func (manager *Manager) SessionStart(w http.ResponseWriter, r *http.Request) (se

 //Destroy sessionid
 func (manager *Manager) SessionDestroy(w http.ResponseWriter, r *http.Request) {
-	cookie, err := r.Cookie(manager.cookieName)
+	cookie, err := r.Cookie(manager.config.CookieName)
 	if err != nil || cookie.Value == "" {
 		return
 	} else {
 		manager.provider.SessionDestroy(cookie.Value)
 		expiration := time.Now()
-		cookie := http.Cookie{Name: manager.cookieName, Path: "/", HttpOnly: true, Expires: expiration, MaxAge: -1}
+		cookie := http.Cookie{Name: manager.config.CookieName,
+			Path:     "/",
+			HttpOnly: true,
+			Expires:  expiration,
+			MaxAge:   -1}
 		http.SetCookie(w, &cookie)
 	}
 }
@ -174,20 +162,20 @@ func (manager *Manager) GetProvider(sid string) (sessions SessionStore, err erro

 func (manager *Manager) GC() {
 	manager.provider.SessionGC()
-	time.AfterFunc(time.Duration(manager.maxlifetime)*time.Second, func() { manager.GC() })
+	time.AfterFunc(time.Duration(manager.config.Gclifetime)*time.Second, func() { manager.GC() })
 }

 func (manager *Manager) SessionRegenerateId(w http.ResponseWriter, r *http.Request) (session SessionStore) {
 	sid := manager.sessionId(r)
-	cookie, err := r.Cookie(manager.cookieName)
+	cookie, err := r.Cookie(manager.config.CookieName)
 	if err != nil && cookie.Value == "" {
 		//delete old cookie
 		session, _ = manager.provider.SessionRead(sid)
-		cookie = &http.Cookie{Name: manager.cookieName,
+		cookie = &http.Cookie{Name: manager.config.CookieName,
 			Value:    url.QueryEscape(sid),
 			Path:     "/",
 			HttpOnly: true,
-			Secure:   manager.secure,
+			Secure:   manager.config.Secure,
 		}
 	} else {
 		oldsid, _ := url.QueryUnescape(cookie.Value)
@ -196,8 +184,8 @@ func (manager *Manager) SessionRegenerateId(w http.ResponseWriter, r *http.Reque
 		cookie.HttpOnly = true
 		cookie.Path = "/"
 	}
-	if manager.maxage >= 0 {
-		cookie.MaxAge = manager.maxage
+	if manager.config.Maxage >= 0 {
+		cookie.MaxAge = manager.config.Maxage
 	}
 	http.SetCookie(w, cookie)
 	r.AddCookie(cookie)
@ -209,12 +197,12 @@ func (manager *Manager) GetActiveSession() int {
 }

 func (manager *Manager) SetHashFunc(hasfunc, hashkey string) {
-	manager.hashfunc = hasfunc
-	manager.hashkey = hashkey
+	manager.config.SessionIDHashFunc = hasfunc
+	manager.config.SessionIDHashKey = hashkey
 }

 func (manager *Manager) SetSecure(secure bool) {
-	manager.secure = secure
+	manager.config.Secure = secure
 }

 //remote_addr cruunixnano randdata
@ -224,16 +212,16 @@ func (manager *Manager) sessionId(r *http.Request) (sid string) {
 		return ""
 	}
 	sig := fmt.Sprintf("%s%d%s", r.RemoteAddr, time.Now().UnixNano(), bs)
-	if manager.hashfunc == "md5" {
+	if manager.config.SessionIDHashFunc == "md5" {
 		h := md5.New()
 		h.Write([]byte(sig))
 		sid = hex.EncodeToString(h.Sum(nil))
-	} else if manager.hashfunc == "sha1" {
-		h := hmac.New(sha1.New, []byte(manager.hashkey))
+	} else if manager.config.SessionIDHashFunc == "sha1" {
+		h := hmac.New(sha1.New, []byte(manager.config.SessionIDHashKey))
 		fmt.Fprintf(h, "%s", sig)
 		sid = hex.EncodeToString(h.Sum(nil))
 	} else {
-		h := hmac.New(sha1.New, []byte(manager.hashkey))
+		h := hmac.New(sha1.New, []byte(manager.config.SessionIDHashKey))
 		fmt.Fprintf(h, "%s", sig)
 		sid = hex.EncodeToString(h.Sum(nil))
 	}