{"id":15285751,"url":"https://github.com/uptutu/auth-go","last_synced_at":"2026-01-04T18:32:14.363Z","repository":{"id":110610529,"uuid":"484473712","full_name":"uptutu/auth-go","owner":"uptutu","description":"An easy to use Gin middleware that generates a certified JWT for any structure and parses the Token into the target structure. | 一款简单易用的可以为任意结构体生成认证 JWT 并解析 Token 为目标结构体的 Gin 中间件。","archived":false,"fork":false,"pushed_at":"2022-05-10T07:06:57.000Z","size":21,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T16:15:52.052Z","etag":null,"topics":["gin","go","golang","jwt","token"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/uptutu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-22T14:58:23.000Z","updated_at":"2022-05-08T02:18:57.000Z","dependencies_parsed_at":"2023-07-21T02:04:04.494Z","dependency_job_id":null,"html_url":"https://github.com/uptutu/auth-go","commit_stats":null,"previous_names":["uptutu/auth"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptutu%2Fauth-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptutu%2Fauth-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptutu%2Fauth-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/uptutu%2Fauth-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/uptutu","download_url":"https://codeload.github.com/uptutu/auth-go/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245168912,"owners_count":20571804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gin","go","golang","jwt","token"],"created_at":"2024-09-30T15:07:28.424Z","updated_at":"2026-01-04T18:32:14.334Z","avatar_url":"https://github.com/uptutu.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auth Middleware for Gin\n\n## What is it?\n一款简单易用的可以为任意结构体生成认证 JWT 并解析 Token 为目标结构体的中间件。\n\n## How to use it?\n关于认证模块简单的来说分为以下几个步骤：\n1. 认证用户信息\n2. 为用户生成对应的认证信息并生成 Token\n3. 解析 Token 拿到用户信息\n4. 使用用户信息\n\n## Usage Cases\n### Generate JWT\n```go\nimport \"github.com/uptutu/auth\"\n\n    user = User{\n\t    ID:     \"id code\", \n\t    Name:   \"user name\", \n\t    Avatar: \"avatar url\",\n    }\n    token, err = auth.NewSession(user).GenerateAccessToken()\n\t\n    // 设置 Cookie\n    // c *gin.Context\n    auth.SetCookie(c, token)\n\n```\n\n### Parse Token in Gin Middleware\n```go\n    // 使用认证中间件\n    // NewSession 函数中传入生成 Token 的结构体实例或指针皆可\n    // 解析到的用户信息会存在 ctx *gin.Context 中\n    r.Use(auth.Identify(User{}))\n\n    // 使用认证中间件\n    r.GET(\"/\", func(c *gin.Context) {\n        data, err := auth.GetAuthenticationDataFrom(c, auth.ValueContextKey)\n        if err != nil {\n            c.AbortWithStatus(401)\n            return\n        }\n    // 使用自己定义的用户信息断言\n        user := data.(User)\n        c.JSON(200, gin.H{\n            \"user\": user,\n        })\n\n    })\n```\n建议将从上下文和断言的代码放在一个函数中，可以复用\n\n```go\nfunc GetAuthenticationData(ctx *gin.Context) (*User, error) {\n    d, err := auth.GetAuthenticationDataFrom(ctx, auth.ValueContextKey)\n    if err != nil {\n        return nil, errors.Wrap(err, \"get authentication data failed\")\n    }\n    a, ok := d.(User)\n    if !ok {\n        return nil, errors.Wrap(err, \"get authentication data failed\")\n    }\n    return \u0026a, nil\n}\n\n\nfunc main() {\n\t...\n    r.GET(\"/\", func(c *gin.Context) {\n        user, err := GetAuthenticationData(c)\n        if err != nil {\n            c.AbortWithStatus(401)\n            return\n        }\n        c.JSON(200, gin.H{\n            \"user\": user,\n        })\n    }\n        ...\n```\n# Advanced\n## 自定义认证结构体\n实现自己实现 `auth.Session` 的接口，用一个自己的结构体生成和解析 Token。\n```go\ntype Session interface {\n    GenerateAccessToken() (string, error)\n    ParseToken(ctx context.Context, token string) error\n    IsParsed() bool\n    SetExtIntoGinContext(ctx *gin.Context) error\n    GetExtFromGinContext(ctx *gin.Context) (interface{}, error)\n    GetToken(ctx *gin.Context) (string, error)\n}\n\n...\n\ntype customSession struct{}\n\nfunc ( customSession )GenerateAccessToken() ( string, error) {\n//TODO implement me\npanic(\"your own custom token generator\")\n}\n\nfunc ( customSession )ParseToken(ctx context.Context, token string) error {\n//TODO implement me\npanic(\"your own custom token parser\")\n}\n\nfunc ( customSession )IsParsed() bool {\n//TODO implement me\npanic(\"implement me\")\n}\n\nfunc ( customSession )SetExtIntoGinContext(ctx *gin.Context) error {\n//TODO implement me\npanic(\"implement me\")\n}\n\nfunc ( customSession )GetExtFromGinContext(ctx *gin.Context) ( interface{}, error) {\n//TODO implement me\npanic(\"implement me\")\n}\n\nfunc ( customSession )GetToken(ctx *gin.Context) ( string, error) {\n//TODO implement me\npanic(\"your own custom token generator\")\n}\n\n\n\n```\n中间件上的使用流程上也没有改变：\n```go\n    // 使用认证中间件\n    // NewSession 函数中传入生成 Token 的结构体实例或指针皆可\n    // 解析到的用户信息会存在 ctx *gin.Context 中\n    r.Use(auth.Identify(customSession{}))\n\n    // 使用认证中间件\n    r.GET(\"/\", func(c *gin.Context) {\n        data, err := auth.GetAuthenticationDataFrom(c, asession{}.ValueContextKey())\n        if err != nil {\n            c.AbortWithStatus(401)\n            return\n        }\n    // 使用自己定义的用户信息断言\n        user := data.(asession)\n        c.JSON(200, gin.H{\n            \"user\": user,\n        })\n\n    })\n```\n## 通过中间件层认证请求\n假设现在有一个接口是获取订单信息，检验该请求的订单 ID 是否为该用户的订单\n```go\nfunc IsUserOrder(c *gin.Context, sess Session){\n\torderID := c.Request.Query(\"order_id\")\n    authInfo, ok := sess.(User)\n\tif !ok {\n\t\tc.JSON(http.StatusInternalServerError, nil)\n\t\tc.Abrode()\n\t\treturn\n    }\n\tfound := db.Select(\"1\").From(\"orders\").Where(\"user_id = ?\", authInfo.ID).Where(\"id = ?\", orderID).Exists()\n    if !found {\n        c.JSON(http.StatusBadRequest, )\n        c.Abrode()\n        return\n    }\n}\n\n...\n\nr.Use(auth.Identify(auth.NewSession(User{}), IsUserOrder))\nr.GET(\"/order/id\", func(c *gin.Context) {\n\t...\n}\n```\n\n# License \nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptutu%2Fauth-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuptutu%2Fauth-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuptutu%2Fauth-go/lists"}