如何验证 go-gin 框架中的 API 键？

Question

所以我目前有一个函数，它将接受一个字符串 APIKey 来根据我的 MongoDB collection 检查它。如果未找到任何内容（未通过身份验证），则 returns 为假 - 如果找到用户，则 returns 为真。然而，我的问题是我不确定如何将它与 Gin POST 路由集成。这是我的代码：


import (
    "context"
    "fmt"
    "log"
    "os"

    "github.com/gin-gonic/gin"
    _ "github.com/joho/godotenv/autoload"
    "go.mongodb.org/mongo-driver/bson"
    "go.mongodb.org/mongo-driver/bson/primitive"
    "go.mongodb.org/mongo-driver/mongo"
    "go.mongodb.org/mongo-driver/mongo/options"
)

type User struct {
    Name   string
    APIKey string
}

func validateAPIKey(users *mongo.Collection, APIKey string) bool {
    var user User

    filter := bson.D{primitive.E{Key: "APIKey", Value: APIKey}}
    if err := users.FindOne(context.TODO(), filter).Decode(&user); err != nil {
        fmt.Printf("Found 0 results for API Key: %s\n", APIKey)
        return false
    }

    fmt.Printf("Found: %s\n", user.Name)
    return true
}

func handleUpload(c *gin.Context) {

}

func main() {
    r := gin.Default()

    api := r.Group("/api")
    v1 := api.Group("/v1")

    v1.POST("/upload", handleUpload)

    mongoURI := os.Getenv("MONGO_URI")
    mongoOptions := options.Client().ApplyURI(mongoURI)
    client, err := mongo.Connect(context.TODO(), mongoOptions)
    if err != nil {
        log.Fatal(err, "Unable to access MongoDB server, exiting...")
    }
    defer client.Disconnect(context.TODO())

    // users := client.Database("sharex_api").Collection("authorized_users") // commented out when testing to ignore unused warnings

    r.Run(":8085")
}

如果单独测试，validateAPIKey 函数完全按预期工作，我只是不确定我将如何运行此函数用于特定端点（在本例中为 /api/v1/upload）并传入用户collection.

Answer 1

经过一番搜索，我找到了解决办法。我将 validateAPIKey 函数更改为 return git.HandlerFunc。这是代码：

func validateAPIKey(users *mongo.Collection) gin.HandlerFunc {
    return func(c *gin.Context) {
        var user authorizedUser
        APIKey := c.Request.Header.Get("X-API-Key")

        filter := bson.D{primitive.E{Key: "APIKey", Value: APIKey}}
        if err := users.FindOne(context.TODO(), filter).Decode(&user); err != nil {
            fmt.Printf("Found 0 results for API Key: %s\n", APIKey)
            c.JSON(http.StatusUnauthorized, gin.H{"status": 401, "message": "Authentication failed"})
            return
        }

        return
    }
}

对于路线，我有以下内容：

v1.POST("/upload", validateAPIKey(users), handleUpload)

如何验证 go-gin 框架中的 API 键？

How to validate API key in go-gin framework?

go

go-gin