Files
nginx-ui/internal/middleware/middleware.go
0xJacky fb37c94276 feat: implement short token endpoint for WebSocket authentication
- Added `InitTokenRouter` to define the `/token/short` endpoint for issuing short tokens.
- Created `IssueShortToken` function to handle short token generation and response.
- Updated WebSocket middleware to require short token for authentication, preventing CSWSH attacks.
- Modified user store and login handling to integrate short token functionality.
- Enhanced documentation to reflect changes in WebSocket security requirements.
2026-04-02 00:06:04 +08:00

213 lines
4.5 KiB
Go

package middleware
import (
"encoding/base64"
"net/http"
"path"
"strings"
"github.com/0xJacky/Nginx-UI/internal/user"
"github.com/0xJacky/Nginx-UI/model"
"github.com/0xJacky/Nginx-UI/settings"
"github.com/gin-gonic/gin"
"github.com/uozi-tech/cosy/logger"
)
// getToken from header, cookie or query
func getToken(c *gin.Context) (token string) {
if token = c.GetHeader("Authorization"); token != "" {
return
}
if token = c.Query("token"); token != "" {
if len(token) > 16 {
// Long token (base64 encoded JWT)
tokenBytes, _ := base64.StdEncoding.DecodeString(token)
return string(tokenBytes)
}
// Short token (16 characters)
return token
}
if token, _ = c.Cookie("token"); token != "" {
return token
}
return ""
}
// getTokenWS reads token from header or query only (no cookie fallback).
// This prevents Cross-Site WebSocket Hijacking (CSWSH) by ensuring
// browsers cannot silently authenticate WebSocket upgrades via cookies.
func getTokenWS(c *gin.Context) (token string) {
if token = c.GetHeader("Authorization"); token != "" {
return
}
if token = c.Query("token"); token != "" {
if len(token) > 16 {
tokenBytes, _ := base64.StdEncoding.DecodeString(token)
return string(tokenBytes)
}
return token
}
return ""
}
// getXNodeID from header or query
func getXNodeID(c *gin.Context) (xNodeID string) {
if xNodeID = c.GetHeader("X-Node-ID"); xNodeID != "" {
return xNodeID
}
return c.Query("x_node_id")
}
// getNodeSecret from header or query
func getNodeSecret(c *gin.Context) (secret string) {
if secret = c.GetHeader("X-Node-Secret"); secret != "" {
return secret
}
return c.Query("node_secret")
}
// AuthRequired is a middleware that checks if the user is authenticated
func AuthRequired() gin.HandlerFunc {
return func(c *gin.Context) {
abortWithAuthFailure := func() {
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
"message": "Authorization failed",
})
}
xNodeID := getXNodeID(c)
if xNodeID != "" {
c.Set("ProxyNodeID", xNodeID)
}
// Check node secret authentication
if nodeSecret := getNodeSecret(c); nodeSecret != "" && nodeSecret == settings.NodeSettings.Secret {
initUser := user.GetInitUser(c)
c.Set("Secret", nodeSecret)
c.Set("user", initUser)
c.Next()
return
}
token := getToken(c)
if token == "" {
abortWithAuthFailure()
return
}
var (
u *model.User
ok bool
)
if len(token) <= 16 {
// Short token (16 characters)
u, ok = user.GetTokenUserByShortToken(token)
if !ok {
abortWithAuthFailure()
return
}
} else {
// Long JWT token
u, ok = user.GetTokenUser(token)
if !ok {
abortWithAuthFailure()
return
}
}
c.Set("user", u)
c.Next()
}
}
// AuthRequiredWS is a WebSocket-specific auth middleware that does NOT read cookies.
// This prevents CSWSH attacks by requiring explicit token passing via header or query param.
func AuthRequiredWS() gin.HandlerFunc {
return func(c *gin.Context) {
abortWithAuthFailure := func() {
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{
"message": "Authorization failed",
})
}
xNodeID := getXNodeID(c)
if xNodeID != "" {
c.Set("ProxyNodeID", xNodeID)
}
if nodeSecret := getNodeSecret(c); nodeSecret != "" && nodeSecret == settings.NodeSettings.Secret {
initUser := user.GetInitUser(c)
c.Set("Secret", nodeSecret)
c.Set("user", initUser)
c.Next()
return
}
token := getTokenWS(c)
if token == "" {
abortWithAuthFailure()
return
}
var (
u *model.User
ok bool
)
if len(token) <= 16 {
u, ok = user.GetTokenUserByShortToken(token)
if !ok {
abortWithAuthFailure()
return
}
} else {
u, ok = user.GetTokenUser(token)
if !ok {
abortWithAuthFailure()
return
}
}
c.Set("user", u)
c.Next()
}
}
type ServerFileSystemType struct {
http.FileSystem
}
func (f ServerFileSystemType) Exists(prefix string, _path string) bool {
file, err := f.Open(path.Join(prefix, _path))
if file != nil {
defer func(file http.File) {
err = file.Close()
if err != nil {
logger.Error("file not found", err)
}
}(file)
}
return err == nil
}
// CacheJs is a middleware that send header to client to cache js file
func CacheJs() gin.HandlerFunc {
return func(c *gin.Context) {
if strings.Contains(c.Request.URL.String(), "js") {
c.Header("Cache-Control", "max-age: 1296000")
if c.Request.Header.Get("If-Modified-Since") == settings.LastModified {
c.AbortWithStatus(http.StatusNotModified)
}
c.Header("Last-Modified", settings.LastModified)
}
}
}