Перейти к основному содержимому

Golang RBAC Tutorial: Role-Based Access Control in Gin

В этом руководстве мы добавляем ролевой контроль доступа (RBAC) в REST API, написанный на Go с использованием фреймворка Gin. По итогам работы три роли (admin, editor, viewer) получают разные разрешения на выполнение различных HTTP-методов для разных маршрутов, при этом правила хранятся в файле политики, который можно изменять без правки кода обработчиков.

Та же модель и политика работают во всех реализациях Casbin, поэтому вы можете повторно использовать их в версиях этого руководства для Node.js, Python, Java и Rust. Для gRPC-сервисов см. Авторизация gRPC на Go.

1. Установка​

go mod init example.com/rbac
go get github.com/casbin/casbin/v3 github.com/gin-gonic/gin

2. Написание модели​

Модель определяет структуру запроса и способ его сопоставления с политикой. Сохраните следующий код как model.conf:

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = g(r.sub, p.sub) && keyMatch2(r.obj, p.obj) && regexMatch(r.act, p.act)
  • r = sub, obj, act: каждый запрос состоит из пользователя, URL-пути и HTTP-метода.
  • g = _, _: пользователям могут быть назначены роли.
  • g(r.sub, p.sub): пользователь из запроса должен иметь роль, указанную в правиле политики.
  • keyMatch2 сопоставляет пути вида /api/articles/:id, а regexMatch позволяет одному правилу перечислять несколько методов. Другие встроенные матчеры описаны в разделе Функции.

3. Написание политики​

Сохраните следующий код как policy.csv:

p, admin, /api/*, (GET)|(POST)|(PUT)|(DELETE)
p, editor, /api/articles, (GET)|(POST)
p, editor, /api/articles/:id, (GET)|(PUT)
p, viewer, /api/articles, GET
p, viewer, /api/articles/:id, GET

g, alice, admin
g, bob, editor
g, carol, viewer

Строки, начинающиеся с p, предоставляют роли доступ к пути и набору методов. Строки, начинающиеся с g, назначают пользователей ролям.

4. Добавление middleware​

Middleware вызывает метод Enforce с передачей пользователя, пути и метода, и отклоняет запрос с ошибкой 403 Forbidden, если Casbin запрещает действие.

main.go
package main

import (
"log"
"net/http"

"github.com/casbin/casbin/v3"
"github.com/gin-gonic/gin"
)

// Authorize asks Casbin whether the current user may call this route.
func Authorize(e *casbin.Enforcer) gin.HandlerFunc {
return func(c *gin.Context) {
// Replace this with the user from your session or JWT.
user := c.GetHeader("X-User")

allowed, err := e.Enforce(user, c.Request.URL.Path, c.Request.Method)
if err != nil {
c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
if !allowed {
c.AbortWithStatusJSON(http.StatusForbidden, gin.H{"error": "forbidden"})
return
}
c.Next()
}
}

func main() {
e, err := casbin.NewEnforcer("model.conf", "policy.csv")
if err != nil {
log.Fatal(err)
}

r := gin.Default()
api := r.Group("/api", Authorize(e))
api.GET("/articles", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"articles": []string{}}) })
api.POST("/articles", func(c *gin.Context) { c.JSON(http.StatusCreated, gin.H{"created": true}) })
api.PUT("/articles/:id", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"updated": c.Param("id")}) })
api.DELETE("/articles/:id", func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"deleted": c.Param("id")}) })

log.Fatal(r.Run(":8080"))
}
примечание

Заголовок X-User используется для краткости примера. Casbin отвечает только за авторизацию; в реальном приложении имя пользователя получается из слоя аутентификации, например из проверенного JWT или сессии.

5. Тестирование​

go run .
curl -i -X POST -H "X-User: bob" http://localhost:8080/api/articles # 201, editors can create
curl -i -X DELETE -H "X-User: bob" http://localhost:8080/api/articles/1 # 403, editors cannot delete
curl -i -X DELETE -H "X-User: alice" http://localhost:8080/api/articles/1 # 200, admins can
curl -i -X POST -H "X-User: carol" http://localhost:8080/api/articles # 403, viewers are read-only

6. Изменение ролей во время выполнения​

Роли и разрешения являются данными, поэтому их можно изменять во время работы сервера:

e.AddRoleForUser("dave", "editor") // dave becomes an editor
e.DeleteRoleForUser("bob", "editor") // bob is no longer an editor
e.AddPolicy("editor", "/api/comments", "POST") // editors may now post comments

roles, _ := e.GetRolesForUser("alice") // [admin]

Полный список методов доступен в документации RBAC API и Management API.

Дальнейшие шаги​

  • Хранение политики в базе данных. Замените policy.csv на адаптер для MySQL, PostgreSQL, MongoDB, Redis и других СУБД. Изменения политики, внесенные через API, будут сохраняться автоматически.
  • Работа нескольких экземпляров приложения. Используйте watcher, чтобы каждый экземпляр перезагружал политику при её изменении одним из них.
  • Многопользовательские приложения (Multi-tenant). RBAC с доменами позволяет назначать пользователю разные роли в разных тенантах.
  • Правила на основе атрибутов. Совместите роли с ABAC, например: «редакторы могут обновлять только свои статьи». Руководство по ABAC показывает, как это сделать шаг за шагом.
  • Готовые middleware. В списке middleware представлены плагины для Gin, Echo, Fiber, Chi и других фреймворков.
  • Эксперименты в браузере. Вставьте модель и политику в онлайн-редактор, чтобы тестировать запросы без запуска кода.

Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.