ddf063352a
让 /admin/ops 错误详情正确归因 API key 并补全早退场景字段，合并三项改动: - 鉴权早退补全用户/分组/平台字段:引入 ops fallback key(ContextKeyOpsFallbackAPIKey), apiKey 一加载成功即写入,覆盖分组停用/删除、Key 停用/过期/额度、用户停用、IP 限制等早退 路径;ops 错误日志改用 getOpsAPIKey(正式 key 优先、回退键兜底),不改「已鉴权」语义。 - 已删除 key 归因(迁移 145):删除 key 时同一事务写 deleted_api_key_audits 映射,认证失败 时用明文反查命中原所有者,错误详情展示「已删除 Key 所有者」「尝试的 Key 前缀」。 - 有效 key 报错快照前缀(迁移 147):对绑定有效 key 的错误,落库时快照明文前 8 位到 api_key_prefix(与 attempted_key_prefix 互斥),key 之后被删仍保留报错当时真实前缀。 均仅对上线后新产生的错误/删除生效。 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
308 lines
11 KiB
Go
308 lines
11 KiB
Go
package middleware
|
||
|
||
import (
|
||
"context"
|
||
"errors"
|
||
"strings"
|
||
|
||
"github.com/Wei-Shaw/sub2api/internal/config"
|
||
"github.com/Wei-Shaw/sub2api/internal/pkg/ctxkey"
|
||
"github.com/Wei-Shaw/sub2api/internal/pkg/ip"
|
||
"github.com/Wei-Shaw/sub2api/internal/service"
|
||
|
||
"github.com/gin-gonic/gin"
|
||
)
|
||
|
||
// NewAPIKeyAuthMiddleware 创建 API Key 认证中间件
|
||
func NewAPIKeyAuthMiddleware(apiKeyService *service.APIKeyService, subscriptionService *service.SubscriptionService, cfg *config.Config) APIKeyAuthMiddleware {
|
||
return APIKeyAuthMiddleware(apiKeyAuthWithSubscription(apiKeyService, subscriptionService, cfg))
|
||
}
|
||
|
||
// apiKeyAuthWithSubscription API Key认证中间件（支持订阅验证）
|
||
//
|
||
// 中间件职责分为两层：
|
||
// - 鉴权（Authentication）：验证 Key 有效性、用户状态、IP 限制 —— 始终执行
|
||
// - 计费执行（Billing Enforcement）：过期/配额/订阅/余额检查 —— skipBilling 时整块跳过
|
||
//
|
||
// /v1/usage 端点只需鉴权，不需要计费执行（允许过期/配额耗尽的 Key 查询自身用量）。
|
||
func apiKeyAuthWithSubscription(apiKeyService *service.APIKeyService, subscriptionService *service.SubscriptionService, cfg *config.Config) gin.HandlerFunc {
|
||
return func(c *gin.Context) {
|
||
// ── 1. 提取 API Key ──────────────────────────────────────────
|
||
|
||
queryKey := strings.TrimSpace(c.Query("key"))
|
||
queryApiKey := strings.TrimSpace(c.Query("api_key"))
|
||
if queryKey != "" || queryApiKey != "" {
|
||
AbortWithError(c, 400, "api_key_in_query_deprecated", "API key in query parameter is deprecated. Please use Authorization header instead.")
|
||
return
|
||
}
|
||
|
||
// 尝试从Authorization header中提取API key (Bearer scheme)
|
||
authHeader := c.GetHeader("Authorization")
|
||
var apiKeyString string
|
||
|
||
if authHeader != "" {
|
||
// 验证Bearer scheme
|
||
parts := strings.SplitN(authHeader, " ", 2)
|
||
if len(parts) == 2 && strings.EqualFold(parts[0], "Bearer") {
|
||
apiKeyString = strings.TrimSpace(parts[1])
|
||
}
|
||
}
|
||
|
||
// 如果Authorization header中没有，尝试从x-api-key header中提取
|
||
if apiKeyString == "" {
|
||
apiKeyString = c.GetHeader("x-api-key")
|
||
}
|
||
|
||
// 如果x-api-key header中没有，尝试从x-goog-api-key header中提取（Gemini CLI兼容）
|
||
if apiKeyString == "" {
|
||
apiKeyString = c.GetHeader("x-goog-api-key")
|
||
}
|
||
|
||
// 如果所有header都没有API key
|
||
if apiKeyString == "" {
|
||
AbortWithError(c, 401, "API_KEY_REQUIRED", "API key is required in Authorization header (Bearer scheme), x-api-key header, or x-goog-api-key header")
|
||
return
|
||
}
|
||
|
||
// ── 2. 验证 Key 存在 ─────────────────────────────────────────
|
||
|
||
apiKey, err := apiKeyService.GetByKey(c.Request.Context(), apiKeyString)
|
||
if err != nil {
|
||
if errors.Is(err, service.ErrAPIKeyNotFound) {
|
||
AbortWithError(c, 401, "INVALID_API_KEY", "Invalid API key")
|
||
return
|
||
}
|
||
AbortWithError(c, 500, "INTERNAL_ERROR", "Failed to validate API key")
|
||
return
|
||
}
|
||
|
||
// apiKey 已加载（含 User/Group）。即便后续因分组停用/Key 停用/用户停用/
|
||
// IP 限制等早退中断，也让 Ops 错误日志能回退取到 user/group/platform。
|
||
SetOpsFallbackAPIKey(c, apiKey)
|
||
|
||
// ── 3. 基础鉴权（始终执行） ─────────────────────────────────
|
||
|
||
// disabled / 未知状态 → 无条件拦截（expired 和 quota_exhausted 留给计费阶段）
|
||
if !apiKey.IsActive() &&
|
||
apiKey.Status != service.StatusAPIKeyExpired &&
|
||
apiKey.Status != service.StatusAPIKeyQuotaExhausted {
|
||
AbortWithError(c, 401, "API_KEY_DISABLED", "API key is disabled")
|
||
return
|
||
}
|
||
|
||
// 检查 IP 限制（白名单/黑名单）
|
||
// 注意：错误信息故意模糊，避免暴露具体的 IP 限制机制
|
||
if len(apiKey.IPWhitelist) > 0 || len(apiKey.IPBlacklist) > 0 {
|
||
clientIP := ip.GetTrustedClientIP(c)
|
||
if cfg.TrustForwardedIPForAPIKeyACL() {
|
||
clientIP = ip.GetClientIP(c)
|
||
}
|
||
allowed, _ := ip.CheckIPRestrictionWithCompiledRules(clientIP, apiKey.CompiledIPWhitelist, apiKey.CompiledIPBlacklist)
|
||
if !allowed {
|
||
service.MarkOpsClientBusinessLimited(c, service.OpsClientBusinessLimitedReasonIPRestriction)
|
||
AbortWithError(c, 403, "ACCESS_DENIED", "Access denied")
|
||
return
|
||
}
|
||
}
|
||
|
||
// 检查关联的用户
|
||
if apiKey.User == nil {
|
||
AbortWithError(c, 401, "USER_NOT_FOUND", "User associated with API key not found")
|
||
return
|
||
}
|
||
|
||
// 检查用户状态
|
||
if !apiKey.User.IsActive() {
|
||
AbortWithError(c, 401, "USER_INACTIVE", "User account is not active")
|
||
return
|
||
}
|
||
if abortIfAPIKeyGroupUnavailable(c, apiKey) {
|
||
return
|
||
}
|
||
|
||
// ── 4. SimpleMode → early return ─────────────────────────────
|
||
|
||
if cfg.RunMode == config.RunModeSimple {
|
||
c.Set(string(ContextKeyAPIKey), apiKey)
|
||
c.Set(string(ContextKeyUser), AuthSubject{
|
||
UserID: apiKey.User.ID,
|
||
Concurrency: apiKey.User.Concurrency,
|
||
})
|
||
c.Set(string(ContextKeyUserRole), apiKey.User.Role)
|
||
setGroupContext(c, apiKey.Group)
|
||
_ = apiKeyService.TouchLastUsed(c.Request.Context(), apiKey.ID)
|
||
c.Next()
|
||
return
|
||
}
|
||
|
||
// ── 5. 加载订阅（订阅模式时始终加载） ───────────────────────
|
||
|
||
// skipBilling: /v1/usage 只需鉴权，跳过所有计费执行
|
||
skipBilling := c.Request.URL.Path == "/v1/usage"
|
||
|
||
var subscription *service.UserSubscription
|
||
isSubscriptionType := apiKey.Group != nil && apiKey.Group.IsSubscriptionType()
|
||
|
||
if isSubscriptionType && subscriptionService != nil {
|
||
sub, subErr := subscriptionService.GetActiveSubscription(
|
||
c.Request.Context(),
|
||
apiKey.User.ID,
|
||
apiKey.Group.ID,
|
||
)
|
||
if subErr != nil {
|
||
if !skipBilling {
|
||
AbortWithError(c, 403, "SUBSCRIPTION_NOT_FOUND", "No active subscription found for this group")
|
||
return
|
||
}
|
||
// skipBilling: 订阅不存在也放行，handler 会返回可用的数据
|
||
} else {
|
||
subscription = sub
|
||
}
|
||
}
|
||
|
||
// ── 6. 计费执行（skipBilling 时整块跳过） ────────────────────
|
||
|
||
if !skipBilling {
|
||
// Key 状态检查
|
||
switch apiKey.Status {
|
||
case service.StatusAPIKeyQuotaExhausted:
|
||
AbortWithError(c, 429, "API_KEY_QUOTA_EXHAUSTED", "API key 额度已用完")
|
||
return
|
||
case service.StatusAPIKeyExpired:
|
||
AbortWithError(c, 403, "API_KEY_EXPIRED", "API key 已过期")
|
||
return
|
||
}
|
||
|
||
// 运行时过期/配额检查（即使状态是 active，也要检查时间和用量）
|
||
if apiKey.IsExpired() {
|
||
AbortWithError(c, 403, "API_KEY_EXPIRED", "API key 已过期")
|
||
return
|
||
}
|
||
if apiKey.IsQuotaExhausted() {
|
||
AbortWithError(c, 429, "API_KEY_QUOTA_EXHAUSTED", "API key 额度已用完")
|
||
return
|
||
}
|
||
|
||
// 订阅模式：验证订阅限额
|
||
if subscription != nil {
|
||
needsMaintenance, validateErr := subscriptionService.ValidateAndCheckLimits(subscription, apiKey.Group)
|
||
if validateErr != nil {
|
||
code := "SUBSCRIPTION_INVALID"
|
||
status := 403
|
||
if errors.Is(validateErr, service.ErrDailyLimitExceeded) ||
|
||
errors.Is(validateErr, service.ErrWeeklyLimitExceeded) ||
|
||
errors.Is(validateErr, service.ErrMonthlyLimitExceeded) {
|
||
code = "USAGE_LIMIT_EXCEEDED"
|
||
status = 429
|
||
}
|
||
AbortWithError(c, status, code, validateErr.Error())
|
||
return
|
||
}
|
||
|
||
// 窗口维护异步化（不阻塞请求）
|
||
if needsMaintenance {
|
||
maintenanceCopy := *subscription
|
||
subscriptionService.DoWindowMaintenance(&maintenanceCopy)
|
||
}
|
||
} else {
|
||
// 非订阅模式 或 订阅模式但 subscriptionService 未注入：回退到余额检查
|
||
if apiKey.User.Balance <= 0 {
|
||
AbortWithError(c, 403, "INSUFFICIENT_BALANCE", "Insufficient account balance")
|
||
return
|
||
}
|
||
}
|
||
}
|
||
|
||
// ── 7. 设置上下文 → Next ─────────────────────────────────────
|
||
|
||
if subscription != nil {
|
||
c.Set(string(ContextKeySubscription), subscription)
|
||
}
|
||
c.Set(string(ContextKeyAPIKey), apiKey)
|
||
c.Set(string(ContextKeyUser), AuthSubject{
|
||
UserID: apiKey.User.ID,
|
||
Concurrency: apiKey.User.Concurrency,
|
||
})
|
||
c.Set(string(ContextKeyUserRole), apiKey.User.Role)
|
||
setGroupContext(c, apiKey.Group)
|
||
_ = apiKeyService.TouchLastUsed(c.Request.Context(), apiKey.ID)
|
||
|
||
c.Next()
|
||
}
|
||
}
|
||
|
||
// GetAPIKeyFromContext 从上下文中获取API key
|
||
func GetAPIKeyFromContext(c *gin.Context) (*service.APIKey, bool) {
|
||
value, exists := c.Get(string(ContextKeyAPIKey))
|
||
if !exists {
|
||
return nil, false
|
||
}
|
||
apiKey, ok := value.(*service.APIKey)
|
||
return apiKey, ok
|
||
}
|
||
|
||
// SetOpsFallbackAPIKey 记录已加载的 API Key，供 Ops 错误日志在鉴权早退时回退使用。
|
||
// 与 ContextKeyAPIKey 区分：写入它不代表请求已通过鉴权，因此不影响 handler、
|
||
// 审计日志等对“已鉴权”的判断。
|
||
func SetOpsFallbackAPIKey(c *gin.Context, apiKey *service.APIKey) {
|
||
if c == nil || apiKey == nil {
|
||
return
|
||
}
|
||
c.Set(string(ContextKeyOpsFallbackAPIKey), apiKey)
|
||
}
|
||
|
||
// GetOpsFallbackAPIKey 读取 Ops 错误日志专用的回退 API Key。
|
||
func GetOpsFallbackAPIKey(c *gin.Context) (*service.APIKey, bool) {
|
||
value, exists := c.Get(string(ContextKeyOpsFallbackAPIKey))
|
||
if !exists {
|
||
return nil, false
|
||
}
|
||
apiKey, ok := value.(*service.APIKey)
|
||
return apiKey, ok
|
||
}
|
||
|
||
// GetSubscriptionFromContext 从上下文中获取订阅信息
|
||
func GetSubscriptionFromContext(c *gin.Context) (*service.UserSubscription, bool) {
|
||
value, exists := c.Get(string(ContextKeySubscription))
|
||
if !exists {
|
||
return nil, false
|
||
}
|
||
subscription, ok := value.(*service.UserSubscription)
|
||
return subscription, ok
|
||
}
|
||
|
||
func setGroupContext(c *gin.Context, group *service.Group) {
|
||
if !service.IsGroupContextValid(group) {
|
||
return
|
||
}
|
||
if existing, ok := c.Request.Context().Value(ctxkey.Group).(*service.Group); ok && existing != nil && existing.ID == group.ID && service.IsGroupContextValid(existing) {
|
||
return
|
||
}
|
||
ctx := context.WithValue(c.Request.Context(), ctxkey.Group, group)
|
||
c.Request = c.Request.WithContext(ctx)
|
||
}
|
||
|
||
func abortIfAPIKeyGroupUnavailable(c *gin.Context, apiKey *service.APIKey) bool {
|
||
code, message, ok := validateAPIKeyGroupAvailable(apiKey)
|
||
if ok {
|
||
return false
|
||
}
|
||
service.MarkOpsClientBusinessLimited(c, service.OpsClientBusinessLimitedReasonAPIKeyGroupUnavailable)
|
||
AbortWithError(c, 403, code, message)
|
||
return true
|
||
}
|
||
|
||
func validateAPIKeyGroupAvailable(apiKey *service.APIKey) (string, string, bool) {
|
||
if apiKey == nil || apiKey.GroupID == nil {
|
||
return "", "", true
|
||
}
|
||
group := apiKey.Group
|
||
if group == nil || strings.EqualFold(group.Status, "deleted") {
|
||
return "GROUP_DELETED", "API Key 所属分组已删除", false
|
||
}
|
||
if !group.IsActive() {
|
||
return "GROUP_DISABLED", "API Key 所属分组已停用", false
|
||
}
|
||
return "", "", true
|
||
}
|