server/web/session/session_config.go - develop - githubmirror/beego

server/web/session/session_config.go
143 строки4 KB
loyalsoldier
Fix: avoid shadow of builtin
16 июн 2021, 22:36
16 июн 2021, 22:3687158d6
package session

import "net/http"

// ManagerConfig define the session config
type ManagerConfig struct {
	EnableSetCookie         bool          `json:"enableSetCookie,omitempty"`
	DisableHTTPOnly         bool          `json:"disableHTTPOnly"`
	Secure                  bool          `json:"secure"`
	EnableSidInHTTPHeader   bool          `json:"EnableSidInHTTPHeader"`
	EnableSidInURLQuery     bool          `json:"EnableSidInURLQuery"`
	CookieName              string        `json:"cookieName"`
	Gclifetime              int64         `json:"gclifetime"`
	Maxlifetime             int64         `json:"maxLifetime"`
	CookieLifeTime          int           `json:"cookieLifeTime"`
	ProviderConfig          string        `json:"providerConfig"`
	Domain                  string        `json:"domain"`
	SessionIDLength         int64         `json:"sessionIDLength"`
	SessionNameInHTTPHeader string        `json:"SessionNameInHTTPHeader"`
	SessionIDPrefix         string        `json:"sessionIDPrefix"`
	CookieSameSite          http.SameSite `json:"cookieSameSite"`
}

func (c *ManagerConfig) Opts(opts ...ManagerConfigOpt) {
	for _, opt := range opts {
		opt(c)
	}
}

type ManagerConfigOpt func(config *ManagerConfig)

func NewManagerConfig(opts ...ManagerConfigOpt) *ManagerConfig {
	config := &ManagerConfig{}
	for _, opt := range opts {
		opt(config)
	}
	return config
}

// CfgCookieName set key of session id
func CfgCookieName(cookieName string) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.CookieName = cookieName
	}
}

// CfgCookieName set len of session id
func CfgSessionIdLength(length int64) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.SessionIDLength = length
	}
}

// CfgSessionIdPrefix set prefix of session id
func CfgSessionIdPrefix(prefix string) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.SessionIDPrefix = prefix
	}
}

// CfgSetCookie whether set `Set-Cookie` header in HTTP response
func CfgSetCookie(enable bool) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.EnableSetCookie = enable
	}
}

// CfgGcLifeTime set session gc lift time
func CfgGcLifeTime(lifeTime int64) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.Gclifetime = lifeTime
	}
}

// CfgMaxLifeTime set session lift time
func CfgMaxLifeTime(lifeTime int64) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.Maxlifetime = lifeTime
	}
}

// CfgGcLifeTime set session lift time
func CfgCookieLifeTime(lifeTime int) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.CookieLifeTime = lifeTime
	}
}

// CfgProviderConfig configure session provider
func CfgProviderConfig(providerConfig string) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.ProviderConfig = providerConfig
	}
}

// CfgDomain set cookie domain
func CfgDomain(domain string) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.Domain = domain
	}
}

// CfgSessionIdInHTTPHeader enable session id in http header
func CfgSessionIdInHTTPHeader(enable bool) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.EnableSidInHTTPHeader = enable
	}
}

// CfgSetSessionNameInHTTPHeader set key of session id in http header
func CfgSetSessionNameInHTTPHeader(name string) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.SessionNameInHTTPHeader = name
	}
}

// EnableSidInURLQuery enable session id in query string
func CfgEnableSidInURLQuery(enable bool) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.EnableSidInURLQuery = enable
	}
}

// DisableHTTPOnly set HTTPOnly for http.Cookie
func CfgHTTPOnly(HTTPOnly bool) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.DisableHTTPOnly = !HTTPOnly
	}
}

// CfgSecure set Secure for http.Cookie
func CfgSecure(Enable bool) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.Secure = Enable
	}
}

// CfgSameSite set http.SameSite
func CfgSameSite(sameSite http.SameSite) ManagerConfigOpt {
	return func(config *ManagerConfig) {
		config.CookieSameSite = sameSite
	}
}