{"id":15685677,"url":"https://github.com/prongbang/fiber-casbinrest","last_synced_at":"2025-05-07T17:30:17.892Z","repository":{"id":57547687,"uuid":"303074915","full_name":"prongbang/fiber-casbinrest","owner":"prongbang","description":"Casbin RESTful Adapter on Fiber Web Framework","archived":false,"fork":false,"pushed_at":"2025-04-27T04:15:29.000Z","size":43,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-01T21:36:21.064Z","etag":null,"topics":["adapter","casbin-adapter","fiber","fiber-framework","go","golang","role-api"],"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/prongbang.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,"publiccode":null,"codemeta":null}},"created_at":"2020-10-11T08:26:28.000Z","updated_at":"2025-04-27T04:15:32.000Z","dependencies_parsed_at":"2024-06-20T21:57:16.634Z","dependency_job_id":"c0019296-e5fa-4a2b-a048-351176b861d0","html_url":"https://github.com/prongbang/fiber-casbinrest","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Ffiber-casbinrest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Ffiber-casbinrest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Ffiber-casbinrest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prongbang%2Ffiber-casbinrest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prongbang","download_url":"https://codeload.github.com/prongbang/fiber-casbinrest/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252926441,"owners_count":21826315,"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":["adapter","casbin-adapter","fiber","fiber-framework","go","golang","role-api"],"created_at":"2024-10-03T17:28:47.483Z","updated_at":"2025-05-07T17:30:17.866Z","avatar_url":"https://github.com/prongbang.png","language":"Go","funding_links":["https://www.buymeacoffee.com/prongbang"],"categories":[],"sub_categories":[],"readme":"# Fiber Casbin REST 🛡️\n\n[![Codecov](https://img.shields.io/codecov/c/github/prongbang/fiber-casbinrest.svg)](https://codecov.io/gh/prongbang/fiber-casbinrest)\n[![Go Report Card](https://goreportcard.com/badge/github.com/prongbang/fiber-casbinrest)](https://goreportcard.com/report/github.com/prongbang/fiber-casbinrest)\n[![Go Reference](https://pkg.go.dev/badge/github.com/prongbang/fiber-casbinrest.svg)](https://pkg.go.dev/github.com/prongbang/fiber-casbinrest)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n\u003e RESTful adapter for [Casbin](https://github.com/casbin/casbin) on [Fiber](https://github.com/gofiber/fiber) web framework. Simplify your authorization with powerful and flexible access control.\n\n## ✨ Features\n\n- 🚀 **Simple Integration** - Easy to integrate with Fiber applications\n- 🔐 **JWT Support** - Built-in JWT token authentication\n- 🎯 **Role-Based Access Control** - Fine-grained RBAC support\n- 🔌 **Custom Adapter** - Flexible adapter system for various storage backends\n- 📦 **MongoDB Support** - Ready-to-use MongoDB adapter\n- ⚡ **High Performance** - Optimized for speed and efficiency\n\n## 📦 Installation\n\n```shell\ngo get github.com/prongbang/fiber-casbinrest\n```\n\n## 🚀 Quick Start\n\n### 1. Configure Casbin Model\n\nCreate `model.conf`:\n\n```ini\n[request_definition]\nr = sub, obj, act\n\n[policy_definition]\np = sub, obj, act\n\n[policy_effect]\ne = some(where (p.eft == allow))\n\n[matchers]\nm = r.sub == p.sub \u0026\u0026 (keyMatch(r.obj, p.obj) || keyMatch2(r.obj, p.obj)) \u0026\u0026 (r.act == p.act || regexMatch(r.act, p.act))\n```\n\n### 2. Define Policies\n\nExample policies:\n\n```\np, admin, /user/*, (GET)|(POST)\np, anonymous, /login, (GET)\np, admin, /admin/user/:id, (GET)|(POST)\n```\n\n### 3. Implement in Your Application\n\n```go\nimport (\n    \"github.com/casbin/casbin/v2\"\n    \"github.com/gofiber/fiber/v2\"\n    fibercasbinrest \"github.com/prongbang/fiber-casbinrest\"\n    \"log\"\n)\n\nfunc main() {\n    e, _ := casbin.NewEnforcer(\"auth_model.conf\", \"policy.csv\")\n    \n    app := fiber.New()\n    app.Use(fibercasbinrest.NewDefault(e, \"secret\"))\n    \n    app.Get(\"/admin/user/:id\", func(c *fiber.Ctx) error {\n        return c.SendString(\"Hello, Admin! 👋\")\n    })\n    \n    log.Fatal(app.Listen(\":3000\"))\n}\n```\n\n## 🔑 JWT Authentication\n\nThe middleware supports JWT tokens with role claims:\n\n```json\n{\n  \"sub\": \"1234567890\",\n  \"name\": \"John Doe\",\n  \"iat\": 1516239022,\n  \"roles\": [\"ADMIN\"]\n}\n```\n\nExample JWT token:\n```\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyLCJyb2xlcyI6WyJBRE1JTiJdfQ.oW8uC8uyL4nZSjcDGRkW3ZHoEoHShPD7ft0cppgvQe4\n```\n\n## 🛠️ Advanced Usage\n\n### Custom Adapter\n\nCreate your own adapter for different storage backends:\n\n```go\ntype redisAdapter struct {}\n\nfunc NewRedisAdapter() fibercasbinrest.Adapter {\n    return \u0026redisAdapter{}\n}\n\nfunc (r *redisAdapter) GetRoleByToken(reqToken string) ([]string, error) {\n    // Implement your token validation and role retrieval logic\n    if reqToken == \"ADMIN_TOKEN\" {\n        return []string{\"admin\"}, nil\n    }\n    return []string{\"anonymous\"}, nil\n}\n\nfunc main() {\n    adapter := NewRedisAdapter()\n    e, _ := casbin.NewEnforcer(\"auth_model.conf\", \"policy.csv\")\n    \n    app := fiber.New()\n    app.Use(fibercasbinrest.New(e, adapter))\n    \n    app.Get(\"/admin/user/:id\", func(c *fiber.Ctx) error {\n        return c.SendString(\"Hello, Admin! 👋\")\n    })\n    \n    log.Fatal(app.Listen(\":3000\"))\n}\n```\n\n### MongoDB Integration\n\nUse MongoDB as your policy storage:\n\n```go\nimport (\n    mongodbadapter \"github.com/casbin/mongodb-adapter/v3\"\n)\n\nfunc main() {\n    a, _ := mongodbadapter.NewAdapter(\"127.0.0.1:27017\")\n    e, _ := casbin.NewEnforcer(\"model.conf\", a)\n    \n    // Add policies\n    _, _ = e.AddPolicy(\"anonymous\", \"/login\", \"GET\")\n    _, _ = e.AddPolicy(\"admin\", \"/admin\", \"(GET)|(POST)\")\n    _, _ = e.AddPolicy(\"admin\", \"/admin/user/:id\", \"GET\")\n    \n    // Save and load policies\n    _ = e.SavePolicy()\n    _ = e.LoadPolicy()\n    \n    app := fiber.New()\n    app.Use(fibercasbinrest.NewDefault(e, \"secret\"))\n    \n    app.Get(\"/admin/user/:id\", func(c *fiber.Ctx) error {\n        return c.SendString(\"Hello, Admin! 👋\")\n    })\n    \n    log.Fatal(app.Listen(\":3000\"))\n}\n```\n\n## 📚 API Reference\n\n### Middleware Functions\n\n| Function | Description |\n|----------|-------------|\n| `NewDefault(e *casbin.Enforcer, secret string)` | Creates middleware with default JWT configuration |\n| `New(e *casbin.Enforcer, adapter Adapter)` | Creates middleware with custom adapter |\n\n### Adapter Interface\n\n```go\ntype Adapter interface {\n    GetRoleByToken(reqToken string) ([]string, error)\n}\n```\n\n## 🔧 Configuration Options\n\n### Supported Matcher Functions\n\n- `keyMatch`: URL path matching\n- `keyMatch2`: URL path matching with wildcard support\n- `regexMatch`: Regular expression matching\n\nFor more matcher functions, visit: [Casbin Functions](https://casbin.org/docs/en/function)\n\n## 🧪 Testing Your Policies\n\nUse the [Casbin Editor](https://casbin.org/editor/) to test and validate your policies online.\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit issues and pull requests.\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 💖 Support\n\nIf you find this library helpful, please consider buying me a coffee:\n\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/prongbang)\n\n## 🔗 Related Projects\n\n- [Casbin](https://github.com/casbin/casbin) - Authorization library\n- [Fiber](https://github.com/gofiber/fiber) - Express-inspired web framework\n- [MongoDB Adapter](https://github.com/casbin/mongodb-adapter) - MongoDB storage adapter for Casbin\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprongbang%2Ffiber-casbinrest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprongbang%2Ffiber-casbinrest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprongbang%2Ffiber-casbinrest/lists"}