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

ABAC на Go

Контроль доступа на основе ролей отвечает на вопрос «что может делать редактор?». Многие реальные правила требуют большего, чем просто роль: авторы могут редактировать свои собственные черновики, редакторы могут редактировать статьи своего отдела, любой может читать опубликованную статью. Эти правила зависят от атрибутов пользователя и ресурса, что и является сутью атрибутивного контроля доступа (ABAC).

В этом учебнике мы создадим небольшое API статей на Go с использованием стандартного пакета net/http и поместим все эти правила в файл политики Casbin. Та же модель и политика без изменений работают в версиях этого учебника для Node.js и Python. Если вы ещё выбираете между RBAC и ABAC, сначала прочитайте Выбор модели контроля доступа.

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

Требуется Go 1.22 или новее для поддержки методов и шаблонов с подстановочными знаками в http.ServeMux.

go mod init example.com/abac
go get github.com/casbin/casbin/v3

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

Сохраните это как model.conf:

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub_rule, obj_type, act

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

[matchers]
m = r.obj.Type == p.obj_type && r.act == p.act && eval(p.sub_rule)
  • r.sub и r.obj здесь — не строки, а структуры Go. Сопоставитель (matcher) читает их поля, такие как r.obj.Type.
  • Каждое правило политики содержит условие в sub_rule. eval(p.sub_rule) вычисляет это условие относительно запроса, поэтому правила находятся в политике, а не в модели.

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

Сохраните это как policy.csv:

p, r.obj.Status == 'published', article, read
p, r.sub.Name == r.obj.Owner, article, read
p, r.sub.Name == r.obj.Owner && r.obj.Status == 'draft', article, update
p, r.sub.Role == 'editor' && r.sub.Department == r.obj.Department, article, update
p, r.sub.Role == 'editor' && r.sub.Department == r.obj.Department, article, publish

Читайте каждую строку как «разрешить это действие со статьями, когда условие истинно»:

  1. Любой может читать опубликованную статью.
  2. Авторы могут читать свои статьи, включая черновики.
  3. Авторы могут редактировать свои статьи, пока они являются черновиками.
  4. Редакторы могут редактировать любую статью своего отдела.
  5. Редакторы могут публиковать статьи своего отдела.
подсказка

Пишите строковые литералы в условиях одинарными кавычками, как в 'published'. Двойная кавычка внутри поля нарушает разбор CSV. Если условию нужна запятая, оберните всё поле в двойные кавычки.

4. Написание сервера​

Для ABAC нужен сам ресурс, а не только его URL, поэтому проверка выполняется после загрузки статьи. Хелпер authorize делает это и возвращает ошибку, если ответ отрицательный.

main.go
package main

import (
"encoding/json"
"log"
"net/http"
"sync"

"github.com/casbin/casbin/v3"
)

type User struct {
Name string
Role string
Department string
}

type Article struct {
ID string `json:"id"`
Type string `json:"-"`
Title string `json:"title"`
Owner string `json:"owner"`
Department string `json:"department"`
Status string `json:"status"`
}

// In a real application these come from your database.
var users = map[string]User{
"alice": {Name: "alice", Role: "author", Department: "engineering"},
"bob": {Name: "bob", Role: "editor", Department: "engineering"},
"carol": {Name: "carol", Role: "editor", Department: "sales"},
"dave": {Name: "dave", Role: "author", Department: "engineering"},
}

var (
mu sync.Mutex
articles = map[string]*Article{
"1": {ID: "1", Type: "article", Title: "Draft by alice", Owner: "alice", Department: "engineering", Status: "draft"},
"2": {ID: "2", Type: "article", Title: "Published by alice", Owner: "alice", Department: "engineering", Status: "published"},
}
)

type server struct {
e *casbin.Enforcer
}

// authorize loads the current user and asks Casbin whether they may perform act on the article.
func (s *server) authorize(w http.ResponseWriter, r *http.Request, a *Article, act string) bool {
// Replace this with the user from your session or JWT.
user, ok := users[r.Header.Get("X-User")]
if !ok {
http.Error(w, "unauthenticated", http.StatusUnauthorized)
return false
}
allowed, err := s.e.Enforce(user, *a, act)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return false
}
if !allowed {
http.Error(w, "forbidden", http.StatusForbidden)
return false
}
return true
}

func (s *server) article(w http.ResponseWriter, r *http.Request) *Article {
mu.Lock()
defer mu.Unlock()
a, ok := articles[r.PathValue("id")]
if !ok {
http.NotFound(w, r)
return nil
}
return a
}

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

mux := http.NewServeMux()
mux.HandleFunc("GET /articles/{id}", func(w http.ResponseWriter, r *http.Request) {
a := s.article(w, r)
if a == nil || !s.authorize(w, r, a, "read") {
return
}
json.NewEncoder(w).Encode(a)
})
mux.HandleFunc("PUT /articles/{id}", func(w http.ResponseWriter, r *http.Request) {
a := s.article(w, r)
if a == nil || !s.authorize(w, r, a, "update") {
return
}
mu.Lock()
json.NewDecoder(r.Body).Decode(&struct {
Title *string `json:"title"`
}{&a.Title})
mu.Unlock()
json.NewEncoder(w).Encode(a)
})
mux.HandleFunc("POST /articles/{id}/publish", func(w http.ResponseWriter, r *http.Request) {
a := s.article(w, r)
if a == nil || !s.authorize(w, r, a, "publish") {
return
}
mu.Lock()
a.Status = "published"
mu.Unlock()
json.NewEncoder(w).Encode(a)
})

log.Fatal(http.ListenAndServe(":8080", mux))
}

Casbin читает поля структур через рефлексию, поэтому поля, используемые в политике (Name, Owner, Status и т. д.), должны быть экспортированы.

примечание

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

5. Попробуйте​

go run .

Статья 1 — это черновик alice, а статья 2 — её опубликованная статья, обе находятся в отделе engineering.

curl -i -H "X-User: dave" http://localhost:8080/articles/1 # 403, someone else's draft
curl -i -H "X-User: dave" http://localhost:8080/articles/2 # 200, published
curl -i -X PUT -H "X-User: alice" -d '{"title":"New title"}' \
http://localhost:8080/articles/1 # 200, her own draft
curl -i -X PUT -H "X-User: alice" -d '{"title":"x"}' \
http://localhost:8080/articles/2 # 403, no longer a draft
curl -i -X PUT -H "X-User: bob" -d '{"title":"x"}' \
http://localhost:8080/articles/2 # 200, editor in engineering
curl -i -X PUT -H "X-User: carol" -d '{"title":"x"}' \
http://localhost:8080/articles/2 # 403, editor in sales
curl -i -X POST -H "X-User: alice" http://localhost:8080/articles/1/publish # 403, authors cannot publish
curl -i -X POST -H "X-User: bob" http://localhost:8080/articles/1/publish # 200
curl -i -H "X-User: dave" http://localhost:8080/articles/1 # 200, now published

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

Условия — это строки политик, поэтому их можно добавлять и удалять во время работы сервера, а также сохранять в базу данных через адаптер:

// Admins may edit any article.
e.AddPolicy("r.sub.Role == 'admin'", "article", "update")

// Nobody may publish any more.
e.RemoveFilteredPolicy(1, "article", "publish")

Чтобы узнать, какое правило разрешило запрос, используйте EnforceEx. Он возвращает совпавшее правило, что полезно для журналов аудита:

ok, rule, _ := e.EnforceEx(users["bob"], *articles["2"], "update")
// true [r.sub.Role == 'editor' && r.sub.Department == r.obj.Department article update]

ABAC или RBAC?​

  • Используйте RBAC, когда разрешения следуют должностным обязанностям и не зависят от того, к какой записи осуществляется доступ. Это проще для аудита: «список всех действий, которые может выполнить редактор» — это простой запрос. См. Руководство по RBAC в Go.
  • Используйте ABAC, когда ответ зависит от конкретной записи: её владельца, отдела, статуса или уровня конфиденциальности.
  • В большинстве приложений используются оба подхода: роли определяют, какие функции доступны пользователю, а атрибуты сужают этот набор до записей, к которым у него есть доступ. В сравнении моделей контроля доступа показана комбинированная модель.

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

  • Полная справка по ABAC. Документация ABAC подробно описывает параметры JSON-запросов, правила цитирования и функцию eval().
  • Правила, зависящие от времени и места. Добавьте дополнительные поля в запрос, например IP-адрес, проверяемый с помощью ipMatch, или текущее время, переданное как атрибут. См. Функции.
  • Запрещающие правила. Добавьте столбец eft и используйте эффект deny-override, чтобы одно правило могло блокировать то, что разрешают другие. См. Эффектор.
  • Эксперименты в браузере. Онлайн-редактор позволяет оценивать ABAC-запросы с атрибутами в формате JSON.

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