session

Documentation

Overview

Package session provides session management utilities for the 3x-ui web panel. It handles user authentication state, login sessions, and session storage using Gin sessions.

Index

• func ClearSession(c *gin.Context)
• func GetLoginUser(c *gin.Context) *model.User
• func IsLogin(c *gin.Context) bool
• func SetLoginUser(c *gin.Context, user *model.User)
• func SetMaxAge(c *gin.Context, maxAge int)

Functions

func ClearSession

func ClearSession(c *gin.Context)

ClearSession removes all session data and invalidates the session. This effectively logs out the user and clears any stored session information.

func GetLoginUser

func GetLoginUser(c *gin.Context) *model.User

GetLoginUser retrieves the authenticated user from the session. Returns nil if no user is logged in or if the session data is invalid.

func IsLogin

func IsLogin(c *gin.Context) bool

IsLogin checks if a user is currently authenticated in the session. Returns true if a valid user session exists, false otherwise.

func SetLoginUser

func SetLoginUser(c *gin.Context, user *model.User)

SetLoginUser stores the authenticated user in the session. The user object is serialized and stored for subsequent requests.

func SetMaxAge

func SetMaxAge(c *gin.Context, maxAge int)

SetMaxAge configures the session cookie maximum age in seconds. This controls how long the session remains valid before requiring re-authentication.