fix: harden core memory session handling #12366
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,114 +1,248 @@ | ||
| package psession | ||
|
|
||
| import ( | ||
| "crypto/rand" | ||
| "encoding/hex" | ||
| "errors" | ||
| "sync" | ||
| "sync/atomic" | ||
| "time" | ||
|
|
||
| "github.com/1Panel-dev/1Panel/core/constant" | ||
| "github.com/gin-gonic/gin" | ||
| ) | ||
|
|
||
| type SessionUser struct { | ||
| ID uint `json:"id"` | ||
| Name string `json:"name"` | ||
| } | ||
|
|
||
| type sessionItem struct { | ||
| User SessionUser | ||
| ExpiredAt time.Time | ||
| } | ||
|
|
||
| type PSession struct { | ||
| mu sync.RWMutex | ||
| sessions map[string]sessionItem | ||
| cleanupCursor uint64 | ||
| lastFullCleanup time.Time | ||
| } | ||
|
|
||
| func NewPSession(_ string) *PSession { | ||
| return &PSession{ | ||
| sessions: make(map[string]sessionItem), | ||
| } | ||
| } | ||
|
|
||
| func (p *PSession) Get(c *gin.Context) (SessionUser, error) { | ||
| var result SessionUser | ||
|
|
||
| sessionID, err := c.Cookie(constant.SessionName) | ||
| if err != nil || sessionID == "" { | ||
| return result, errors.New("ErrSessionDataNotFound") | ||
| } | ||
|
|
||
| p.mu.RLock() | ||
| item, ok := p.sessions[sessionID] | ||
| p.mu.RUnlock() | ||
| if !ok { | ||
| return result, errors.New("ErrSessionDataNotFound") | ||
| } | ||
| if !item.ExpiredAt.IsZero() && time.Now().After(item.ExpiredAt) { | ||
| p.mu.Lock() | ||
| delete(p.sessions, sessionID) | ||
| p.mu.Unlock() | ||
| return result, errors.New("ErrSessionDataNotFound") | ||
| } | ||
| return item.User, nil | ||
| } | ||
|
|
||
| func (p *PSession) Set(c *gin.Context, user SessionUser, secure bool, ttlSeconds int) error { | ||
| return p.set(c, user, secure, ttlSeconds, false) | ||
| } | ||
|
|
||
| func (p *PSession) SetFresh(c *gin.Context, user SessionUser, secure bool, ttlSeconds int) error { | ||
| return p.set(c, user, secure, ttlSeconds, true) | ||
| } | ||
|
|
||
| func (p *PSession) set(c *gin.Context, user SessionUser, secure bool, ttlSeconds int, forceNew bool) error { | ||
| sessionID, err := c.Cookie(constant.SessionName) | ||
| if forceNew { | ||
| if err == nil && sessionID != "" { | ||
| p.mu.Lock() | ||
| delete(p.sessions, sessionID) | ||
| p.mu.Unlock() | ||
| } | ||
| sessionID = "" | ||
| } | ||
| if err != nil || sessionID == "" { | ||
| sessionID, err = generateSessionID() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| expiredAt := time.Now().Add(time.Duration(ttlSeconds) * time.Second) | ||
| p.mu.Lock() | ||
| p.sessions[sessionID] = sessionItem{ | ||
| User: user, | ||
| ExpiredAt: expiredAt, | ||
| } | ||
| p.mu.Unlock() | ||
| p.cleanupExpiredOnWrite() | ||
|
|
||
| c.SetCookie(constant.SessionName, sessionID, ttlSeconds, "/", "", secure, true) | ||
| return nil | ||
| } | ||
|
|
||
| func (p *PSession) RefreshIfNeeded(c *gin.Context, user SessionUser, secure bool, ttlSeconds int) (bool, error) { | ||
| sessionID, err := c.Cookie(constant.SessionName) | ||
| if err != nil || sessionID == "" { | ||
| return false, p.Set(c, user, secure, ttlSeconds) | ||
| } | ||
|
|
||
| now := time.Now() | ||
| window := refreshWindow(ttlSeconds) | ||
|
|
||
| p.mu.RLock() | ||
| item, ok := p.sessions[sessionID] | ||
| p.mu.RUnlock() | ||
| if !ok { | ||
| return false, p.Set(c, user, secure, ttlSeconds) | ||
| } | ||
| if !item.ExpiredAt.IsZero() && now.After(item.ExpiredAt) { | ||
| p.mu.Lock() | ||
| delete(p.sessions, sessionID) | ||
| p.mu.Unlock() | ||
| return false, errors.New("ErrSessionDataNotFound") | ||
| } | ||
| if item.ExpiredAt.Sub(now) > window { | ||
| return false, nil | ||
| } | ||
| return true, p.Set(c, user, secure, ttlSeconds) | ||
| } | ||
|
|
||
| func (p *PSession) Delete(c *gin.Context) error { | ||
| sessionID, err := c.Cookie(constant.SessionName) | ||
| if err == nil && sessionID != "" { | ||
| p.mu.Lock() | ||
| delete(p.sessions, sessionID) | ||
| p.mu.Unlock() | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (p *PSession) Clean() error { | ||
| p.mu.Lock() | ||
| p.sessions = make(map[string]sessionItem) | ||
| p.lastFullCleanup = time.Time{} | ||
| p.mu.Unlock() | ||
| return nil | ||
| } | ||
|
|
||
| func generateSessionID() (string, error) { | ||
| buf := make([]byte, 32) | ||
| if _, err := rand.Read(buf); err != nil { | ||
| return "", err | ||
| } | ||
| return hex.EncodeToString(buf), nil | ||
| } | ||
|
|
||
| func refreshWindow(ttlSeconds int) time.Duration { | ||
| if ttlSeconds <= 0 { | ||
| return 0 | ||
| } | ||
| windowSeconds := ttlSeconds / 10 | ||
| if windowSeconds < 60 { | ||
| windowSeconds = 60 | ||
| } | ||
| if windowSeconds > 300 { | ||
| windowSeconds = 300 | ||
| } | ||
|
Comment on lines
+160
to
+162
There was a problem hiding this comment.
Useful? React with 👍 / 👎. |
||
| if windowSeconds >= ttlSeconds { | ||
| windowSeconds = ttlSeconds - 1 | ||
| } | ||
| if windowSeconds <= 0 { | ||
| windowSeconds = 1 | ||
| } | ||
| return time.Duration(windowSeconds) * time.Second | ||
| } | ||
|
|
||
| func (p *PSession) cleanupExpiredOnWrite() { | ||
| const ( | ||
| sampleSize = 32 | ||
| fullCleanupThreshold = 1024 | ||
| fullCleanupMinInterval = time.Minute | ||
| ) | ||
|
|
||
| now := time.Now() | ||
|
|
||
| p.mu.RLock() | ||
| size := len(p.sessions) | ||
| lastFullCleanup := p.lastFullCleanup | ||
| p.mu.RUnlock() | ||
|
|
||
| if size == 0 { | ||
| return | ||
| } | ||
| if size >= fullCleanupThreshold && now.Sub(lastFullCleanup) >= fullCleanupMinInterval { | ||
| p.cleanupExpiredAll(now) | ||
| return | ||
| } | ||
| p.cleanupExpiredSample(now, sampleSize) | ||
| } | ||
|
|
||
| func (p *PSession) cleanupExpiredSample(now time.Time, limit int) { | ||
| if limit <= 0 { | ||
| return | ||
| } | ||
|
|
||
| p.mu.Lock() | ||
| defer p.mu.Unlock() | ||
|
|
||
| total := len(p.sessions) | ||
| if total == 0 { | ||
| return | ||
| } | ||
| start := int(atomic.AddUint64(&p.cleanupCursor, uint64(limit)) % uint64(total)) | ||
| checked := 0 | ||
|
|
||
| idx := 0 | ||
| for key, item := range p.sessions { | ||
| if idx < start { | ||
| idx++ | ||
| continue | ||
| } | ||
| if !item.ExpiredAt.IsZero() && now.After(item.ExpiredAt) { | ||
| delete(p.sessions, key) | ||
| } | ||
| checked++ | ||
| idx++ | ||
| if checked >= limit { | ||
| break | ||
| } | ||
| } | ||
| if checked < limit { | ||
| for key, item := range p.sessions { | ||
| if checked >= limit { | ||
| break | ||
| } | ||
| if !item.ExpiredAt.IsZero() && now.After(item.ExpiredAt) { | ||
| delete(p.sessions, key) | ||
| } | ||
| checked++ | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (p *PSession) cleanupExpiredAll(now time.Time) { | ||
| p.mu.Lock() | ||
| for key, item := range p.sessions { | ||
| if !item.ExpiredAt.IsZero() && now.After(item.ExpiredAt) { | ||
| delete(p.sessions, key) | ||
| } | ||
| } | ||
| p.lastFullCleanup = now | ||
| p.mu.Unlock() | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,11 @@ | ||
| package session | ||
|
|
||
| import ( | ||
| "github.com/1Panel-dev/1Panel/core/global" | ||
| "github.com/1Panel-dev/1Panel/core/init/session/psession" | ||
| ) | ||
|
|
||
| func Init() { | ||
| global.SESSION = psession.NewPSession("") | ||
| global.LOG.Info("init in-memory session successfully") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new in-memory store inserts a session entry on every new login/session ID without any global size limit or eviction policy. Because entries live for
ttlSeconds(default is long) and login creates fresh IDs, repeated successful logins (e.g., automated clients not reusing cookies) can growp.sessionsunbounded and drive memory pressure/OOM in the API process.Useful? React with 👍 / 👎.