1Panel/core/app/auth/api_auth.go

package auth

import (
	"crypto/hmac"
	"crypto/md5"
	"crypto/sha256"
	"encoding/hex"
	"errors"
	"net"
	"strconv"
	"strings"
	"time"

	"github.com/1Panel-dev/1Panel/core/app/api/v2/helper"
	"github.com/1Panel-dev/1Panel/core/app/repo"
	"github.com/1Panel-dev/1Panel/core/buserr"
	"github.com/1Panel-dev/1Panel/core/constant"
	"github.com/1Panel-dev/1Panel/core/global"
	"github.com/1Panel-dev/1Panel/core/utils/common"
	"github.com/gin-gonic/gin"
)

type APIAuthConfig struct {
	ApiInterfaceStatus string
	ApiKey             string
	IpWhiteList        string
	ApiTrustedProxies  string
	ApiKeyValidityTime int
}

type APIAuthConfigLoader func(c *gin.Context) (APIAuthConfig, error)
type APIAuthSuccessHandler func(c *gin.Context, config APIAuthConfig)

func APIAuthMiddleware(loadConfig APIAuthConfigLoader, onSuccess APIAuthSuccessHandler) gin.HandlerFunc {
	return func(c *gin.Context) {
		if strings.HasPrefix(c.Request.URL.Path, "/api/v2/core/auth") {
			c.Next()
			return
		}

		panelToken := c.GetHeader("1Panel-Token")
		panelTimestamp := c.GetHeader("1Panel-Timestamp")
		if panelToken == "" && panelTimestamp == "" {
			c.Next()
			return
		}

		config, err := loadConfig(c)
		if err != nil {
			var bizErr buserr.BusinessError
			if errors.As(err, &bizErr) && strings.HasPrefix(bizErr.Msg, "ErrApiConfig") {
				helper.BadAuth(c, bizErr.Msg, bizErr.Err)
				return
			}
			helper.InternalServer(c, err)
			return
		}
		if config.ApiInterfaceStatus != constant.StatusEnable {
			helper.BadAuth(c, "ErrApiConfigStatusInvalid", nil)
			return
		}
		if !isValid1PanelTimestamp(panelTimestamp, config.ApiKeyValidityTime) {
			helper.BadAuth(c, "ErrApiConfigKeyTimeInvalid", nil)
			return
		}
		if !isValid1PanelToken(panelToken, panelTimestamp, config.ApiKey) {
			helper.BadAuth(c, "ErrApiConfigKeyInvalid", nil)
			return
		}
		if !isIPInWhiteList(GetAPIClientIP(c, config.ApiTrustedProxies), config.IpWhiteList) {
			helper.BadAuth(c, "ErrApiConfigIPInvalid", nil)
			return
		}

		c.Set("API_AUTH", true)
		if onSuccess != nil {
			onSuccess(c, config)
		}
		c.Next()
	}
}

func LoadAPIAuthConfig(_ *gin.Context) (APIAuthConfig, error) {
	settingRepo := repo.NewISettingRepo()
	config := APIAuthConfig{}
	var err error
	if config.ApiInterfaceStatus, err = settingRepo.GetValueByKey("ApiInterfaceStatus"); err != nil {
		return config, err
	}
	if config.ApiKey, err = settingRepo.GetValueByKey("ApiKey"); err != nil {
		return config, err
	}
	if config.IpWhiteList, err = settingRepo.GetValueByKey("IpWhiteList"); err != nil {
		return config, err
	}
	if config.ApiTrustedProxies, err = settingRepo.GetValueByKey("ApiTrustedProxies"); err != nil {
		return config, err
	}
	apiValidity, err := settingRepo.GetValueByKey("ApiKeyValidityTime")
	if err != nil {
		return config, err
	}
	if config.ApiKeyValidityTime, err = strconv.Atoi(apiValidity); err != nil {
		return config, err
	}
	return config, nil
}

func GetAPIClientIP(c *gin.Context, trustedProxies string) string {
	return common.ResolveClientIP(c, trustedProxies)
}

func NormalizeAPITrustedProxies(value string) (string, error) {
	return common.NormalizeTrustedProxies(value)
}

func IsValid1PanelTimestamp(panelTimestamp string, apiKeyValidityTime int) bool {
	apiTime := apiKeyValidityTime
	if apiTime < 0 {
		return false
	}
	if apiTime == 0 {
		return true
	}
	panelTime, err := strconv.ParseInt(panelTimestamp, 10, 64)
	if err != nil {
		global.LOG.Errorf("panelTimestamp %s, panelTime %d, apiTime %d, err: %v", panelTimestamp, apiTime, panelTime, err)
		return false
	}
	nowTime := time.Now().Unix()
	tolerance := int64(60)
	if panelTime > nowTime+tolerance {
		global.LOG.Errorf("Valid Panel Timestamp, apiTime %d, panelTime %d, nowTime %d, err: %v", apiTime, panelTime, nowTime, err)
		return false
	}
	return nowTime-panelTime <= int64(apiTime)*60+tolerance
}

func IsValid1PanelToken(panelToken string, panelTimestamp string, apiKey string) bool {
	return IsValid1PanelTokenWithVersion(panelToken, panelTimestamp, apiKey, "")
}

func IsValid1PanelTokenWithVersion(panelToken string, panelTimestamp string, apiKey string, signatureVersion string) bool {
	panelToken = strings.ToLower(strings.TrimSpace(panelToken))
	version := strings.ToLower(strings.TrimSpace(signatureVersion))
	switch version {
	case "v1", "md5":
		return isValidMD5Token(panelToken, panelTimestamp, apiKey)
	case "hmac-sha256":
		return isValidHMACSHA256Token(panelToken, panelTimestamp, apiKey)
	default:
		return isValidMD5Token(panelToken, panelTimestamp, apiKey) || isValidHMACSHA256Token(panelToken, panelTimestamp, apiKey)
	}
}

func isValidMD5Token(panelToken string, panelTimestamp string, apiKey string) bool {
	return panelToken == GenerateMD5("1panel"+apiKey+panelTimestamp)
}

func isValidHMACSHA256Token(panelToken string, panelTimestamp string, apiKey string) bool {
	return panelToken == GenerateHMACSHA256(apiKey, "1panel:"+panelTimestamp)
}

func IsIPInWhiteList(clientIP string, ipWhiteString string) bool {
	if strings.TrimSpace(ipWhiteString) == "" {
		global.LOG.Error("IP whitelist is empty")
		return false
	}
	ipWhiteList, ipErr := common.HandleIPList(ipWhiteString)
	if ipErr != nil {
		global.LOG.Errorf("Failed to handle IP list: %v", ipErr)
		return false
	}
	clientParsedIP := net.ParseIP(clientIP)
	if clientParsedIP == nil {
		return false
	}
	iPv4 := clientParsedIP.To4()
	iPv6 := clientParsedIP.To16()
	for _, cidr := range ipWhiteList {
		cidr = strings.TrimSpace(cidr)
		if cidr == "" {
			continue
		}
		if (iPv4 != nil && (cidr == "0.0.0.0" || cidr == "0.0.0.0/0" || iPv4.String() == cidr)) || (iPv6 != nil && (cidr == "::/0" || iPv6.String() == cidr)) {
			return true
		}
		whiteIP := net.ParseIP(cidr)
		if whiteIP != nil && whiteIP.Equal(clientParsedIP) {
			return true
		}
		_, ipNet, err := net.ParseCIDR(cidr)
		if err != nil {
			continue
		}
		if (iPv4 != nil && ipNet.Contains(iPv4)) || (iPv6 != nil && ipNet.Contains(iPv6)) {
			return true
		}
	}
	return false
}

func isValid1PanelTimestamp(panelTimestamp string, apiKeyValidityTime int) bool {
	return IsValid1PanelTimestamp(panelTimestamp, apiKeyValidityTime)
}

func isValid1PanelToken(panelToken string, panelTimestamp string, apiKey string) bool {
	return IsValid1PanelToken(panelToken, panelTimestamp, apiKey)
}

func isIPInWhiteList(clientIP string, ipWhiteString string) bool {
	return IsIPInWhiteList(clientIP, ipWhiteString)
}

func GenerateMD5(param string) string {
	hash := md5.New()
	hash.Write([]byte(param))
	return hex.EncodeToString(hash.Sum(nil))
}

func GenerateHMACSHA256(secret string, message string) string {
	mac := hmac.New(sha256.New, []byte(secret))
	mac.Write([]byte(message))
	return hex.EncodeToString(mac.Sum(nil))
}