refactor(auth): replace dashboard sessions with stateless tokens and session control (#6329)
* refactor(auth): replace dashboard sessions with stateless tokens * feat(auth): harden session issuance and distributed enforcement * fix(proxy): preserve trusted proxy compatibility defaults * refactor: address dashboard auth review feedback * refactor: remove classic frontend and flatten web app
This commit is contained in:
+105
-79
@@ -1,27 +1,29 @@
|
||||
package model
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/QuantumNous/new-api/common"
|
||||
"github.com/QuantumNous/new-api/constant"
|
||||
"github.com/QuantumNous/new-api/dto"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
|
||||
"github.com/bytedance/gopkg/util/gopool"
|
||||
)
|
||||
|
||||
// UserBase struct remains the same as it represents the cached data structure
|
||||
const userCacheSchemaVersion = 2
|
||||
|
||||
type UserBase struct {
|
||||
Id int `json:"id"`
|
||||
Group string `json:"group"`
|
||||
Email string `json:"email"`
|
||||
Quota int `json:"quota"`
|
||||
Status int `json:"status"`
|
||||
Username string `json:"username"`
|
||||
Setting string `json:"setting"`
|
||||
Id int `json:"id"`
|
||||
Group string `json:"group"`
|
||||
Email string `json:"email"`
|
||||
Quota int `json:"quota"`
|
||||
Status int `json:"status"`
|
||||
Role int `json:"role"`
|
||||
Username string `json:"username"`
|
||||
Setting string `json:"setting"`
|
||||
AuthVersion int64 `json:"-"`
|
||||
CacheSchema int `json:"-"`
|
||||
}
|
||||
|
||||
func (user *UserBase) WriteContext(c *gin.Context) {
|
||||
@@ -49,6 +51,14 @@ func getUserCacheKey(userId int) string {
|
||||
return fmt.Sprintf("user:%d", userId)
|
||||
}
|
||||
|
||||
func userCacheTTLSeconds() int {
|
||||
ttl := common.RedisKeyCacheSeconds()
|
||||
if ttl <= 0 {
|
||||
return 60
|
||||
}
|
||||
return ttl
|
||||
}
|
||||
|
||||
// invalidateUserCache clears user cache
|
||||
func invalidateUserCache(userId int) error {
|
||||
if !common.RedisEnabled {
|
||||
@@ -67,12 +77,7 @@ func populateUserCache(user User) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
|
||||
return common.RedisHSetObj(
|
||||
getUserCacheKey(user.Id),
|
||||
user.ToBaseUser(),
|
||||
time.Duration(common.RedisKeyCacheSeconds())*time.Second,
|
||||
)
|
||||
return writeUserCache(user.ToBaseUser(), true)
|
||||
}
|
||||
|
||||
// updateUserCache refreshes non-quota user cache fields.
|
||||
@@ -82,61 +87,37 @@ func updateUserCache(user User) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
if err := updateUserGroupCache(user.Id, user.Group); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := updateUserEmailCache(user.Id, user.Email); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := updateUserStatusCache(user.Id, user.Status == common.UserStatusEnabled); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := updateUserNameCache(user.Id, user.Username); err != nil {
|
||||
return err
|
||||
}
|
||||
return updateUserSettingCache(user.Id, user.Setting)
|
||||
return writeUserCache(user.ToBaseUser(), false)
|
||||
}
|
||||
|
||||
// GetUserCache gets complete user cache from hash
|
||||
func GetUserCache(userId int) (userCache *UserBase, err error) {
|
||||
var user *User
|
||||
var fromDB bool
|
||||
defer func() {
|
||||
// Update Redis cache asynchronously on successful DB read
|
||||
if shouldUpdateRedis(fromDB, err) && user != nil {
|
||||
gopool.Go(func() {
|
||||
if err := populateUserCache(*user); err != nil {
|
||||
common.SysLog("failed to update user status cache: " + err.Error())
|
||||
}
|
||||
})
|
||||
}
|
||||
}()
|
||||
|
||||
func GetUserCache(userId int) (*UserBase, error) {
|
||||
// Try getting from Redis first
|
||||
userCache, err = cacheGetUserBase(userId)
|
||||
userCache, err := cacheGetUserBase(userId)
|
||||
if err == nil {
|
||||
return userCache, nil
|
||||
}
|
||||
|
||||
// If Redis fails, get from DB
|
||||
fromDB = true
|
||||
user, err = GetUserById(userId, false)
|
||||
// Redis misses and read failures both fall back to the shared database. A
|
||||
// version fence newer than the database is the one exception: allowing that
|
||||
// snapshot would re-authorize a user while a restrictive update is pending.
|
||||
user, err := GetUserById(userId, false)
|
||||
if err != nil {
|
||||
return nil, err // Return nil and error if DB lookup fails
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Create cache object from user data
|
||||
userCache = &UserBase{
|
||||
Id: user.Id,
|
||||
Group: user.Group,
|
||||
Quota: user.Quota,
|
||||
Status: user.Status,
|
||||
Username: user.Username,
|
||||
Setting: user.Setting,
|
||||
Email: user.Email,
|
||||
if common.RedisEnabled {
|
||||
floor, floorErr := getUserAuthVersionFloor(userId)
|
||||
if floorErr == nil && floor > user.AuthVersion {
|
||||
return nil, ErrUserAuthCachePending
|
||||
}
|
||||
if err := populateUserCache(*user); err != nil {
|
||||
if errors.Is(err, ErrUserAuthCachePending) {
|
||||
return nil, err
|
||||
}
|
||||
common.SysLog("failed to synchronously populate user cache: " + err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
return userCache, nil
|
||||
return user.ToBaseUser(), nil
|
||||
}
|
||||
|
||||
func cacheGetUserBase(userId int) (*UserBase, error) {
|
||||
@@ -149,6 +130,16 @@ func cacheGetUserBase(userId int) (*UserBase, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if userCache.Id != userId || userCache.CacheSchema != userCacheSchemaVersion || userCache.AuthVersion <= 0 {
|
||||
return nil, fmt.Errorf("user cache schema is stale")
|
||||
}
|
||||
floor, err := getUserAuthVersionFloor(userId)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if floor > userCache.AuthVersion {
|
||||
return nil, ErrUserAuthCachePending
|
||||
}
|
||||
return &userCache, nil
|
||||
}
|
||||
|
||||
@@ -207,14 +198,11 @@ func getUserSettingCache(userId int) (dto.UserSetting, error) {
|
||||
|
||||
// New functions for individual field updates
|
||||
func updateUserStatusCache(userId int, status bool) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
statusInt := common.UserStatusEnabled
|
||||
if !status {
|
||||
statusInt = common.UserStatusDisabled
|
||||
}
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Status", fmt.Sprintf("%d", statusInt))
|
||||
return updateUserCacheField(userId, "Status", statusInt)
|
||||
}
|
||||
|
||||
func updateUserQuotaCache(userId int, quota int) error {
|
||||
@@ -224,36 +212,74 @@ func updateUserQuotaCache(userId int, quota int) error {
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Quota", fmt.Sprintf("%d", quota))
|
||||
}
|
||||
|
||||
func updateUserGroupCache(userId int, group string) error {
|
||||
// RefreshUserGroupCache writes the database-authoritative group into an
|
||||
// existing user hash without changing the user's authentication version.
|
||||
func RefreshUserGroupCache(userId int) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Group", group)
|
||||
}
|
||||
if userId <= 0 {
|
||||
return fmt.Errorf("invalid user id")
|
||||
}
|
||||
var authoritative User
|
||||
if err := DB.Select("id", "auth_version", commonGroupCol).Where("id = ?", userId).First(&authoritative).Error; err != nil {
|
||||
return err
|
||||
}
|
||||
// Group transitions intentionally keep the same authentication version. A
|
||||
// refresh that read the previous group can therefore arrive after a newer
|
||||
// refresh and still pass the auth-version fence. Re-read after every write
|
||||
// and repair the cache when the authoritative group changed in between.
|
||||
for range 3 {
|
||||
if err := updateUserCacheFieldAtVersion(userId, "Group", authoritative.Group, authoritative.AuthVersion); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
func UpdateUserGroupCache(userId int, group string) error {
|
||||
return updateUserGroupCache(userId, group)
|
||||
var verified User
|
||||
if err := DB.Select("id", "auth_version", commonGroupCol).Where("id = ?", userId).First(&verified).Error; err != nil {
|
||||
return err
|
||||
}
|
||||
if verified.AuthVersion == authoritative.AuthVersion && verified.Group == authoritative.Group {
|
||||
return nil
|
||||
}
|
||||
authoritative = verified
|
||||
}
|
||||
|
||||
// Preserve the freshest snapshot observed even when the row was too busy to
|
||||
// stabilize within the bounded retries. Returning an error lets best-effort
|
||||
// callers emit an operation-specific warning.
|
||||
if err := updateUserCacheFieldAtVersion(userId, "Group", authoritative.Group, authoritative.AuthVersion); err != nil {
|
||||
return err
|
||||
}
|
||||
return fmt.Errorf("user group changed repeatedly during cache refresh")
|
||||
}
|
||||
|
||||
func updateUserEmailCache(userId int, email string) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Email", email)
|
||||
return updateUserCacheField(userId, "Email", email)
|
||||
}
|
||||
|
||||
func updateUserNameCache(userId int, username string) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Username", username)
|
||||
return updateUserCacheField(userId, "Username", username)
|
||||
}
|
||||
|
||||
func updateUserSettingCache(userId int, setting string) error {
|
||||
return updateUserCacheField(userId, "Setting", setting)
|
||||
}
|
||||
|
||||
// updateUserCacheField prevents individual cache refreshes from bypassing the
|
||||
// auth-version fence. It intentionally does nothing when the complete hash is
|
||||
// absent; the next GetUserCache call will repopulate it from the database.
|
||||
func updateUserCacheField(userId int, field string, value interface{}) error {
|
||||
if !common.RedisEnabled {
|
||||
return nil
|
||||
}
|
||||
return common.RedisHSetField(getUserCacheKey(userId), "Setting", setting)
|
||||
var user User
|
||||
if err := DB.Select("id", "auth_version").Where("id = ?", userId).First(&user).Error; err != nil {
|
||||
return err
|
||||
}
|
||||
if user.AuthVersion <= 0 {
|
||||
return fmt.Errorf("invalid user auth version")
|
||||
}
|
||||
return updateUserCacheFieldAtVersion(userId, field, value, user.AuthVersion)
|
||||
}
|
||||
|
||||
// GetUserLanguage returns the user's language preference from cache
|
||||
|
||||
Reference in New Issue
Block a user