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

Развертывание в production

Casbin — это библиотека: enforcer работает внутри вашего процесса и хранит всю политику в памяти. Это делает Enforce() быстрым, но также означает, что вы решаете, как создавать enforcer, разделять его между потоками и синхронизировать с другими экземплярами. Эта страница представляет собой чек-лист для правильной реализации этих задач.

Создание одного enforcer на процесс​

Создайте enforcer один раз при запуске и разделяйте его. Загрузка политики — дорогая операция: она читает каждое правило из адаптера и перестраивает модель и граф ролей.

Не вызывайте LoadPolicy() (или создавайте новый enforcer) при каждом запросе:

// Don't: this reads the whole policy table on every request
func authorize(sub, obj, act string) (bool, error) {
if err := e.LoadPolicy(); err != nil {
return false, err
}
return e.Enforce(sub, obj, act)
}

Изменения политики, внесенные через Management API enforcer (AddPolicy, RemovePolicy, AddGroupingPolicy...), обновляют память и, при включенном AutoSave, одновременно базу данных. Изменения, сделанные другими экземплярами, достигают этого экземпляра через watcher. Нет необходимости перезагружать политику перед проверкой прав.

Если политика слишком велика для хранения в памяти, загружайте только ту часть, которая нужна каждому экземпляру, используя Policy subset loading.

Безопасное разделение Enforcer между потоками​

Обычный Enforcer не безопасен для одновременного использования, если политика может изменяться во время обработки запросов: вызов LoadPolicy() или AddPolicy() в одном потоке может конфликтовать с Enforce() в другом. Используйте синхронизированный enforcer, который защищает операции чтения и записи с помощью блокировки «чтение-запись»:

ЯзыкСинхронизированный enforcer
Gocasbin.NewSyncedEnforcer(), casbin.NewSyncedCachedEnforcer(), casbin.NewSyncedContextEnforcer() (для API *Ctx, версии после v3.11.0)
JavaSyncedEnforcer, SyncedCachedEnforcer
Pythoncasbin.SyncedEnforcer
Node.jsnewSyncedEnforcer()
C++casbin::SyncedEnforcer

Синхронизированный enforcer имеет тот же API, что и Enforcer. В Go ContextEnforcer также не является синхронизированным: одновременные вызовы LoadPolicyCtx() / AddPolicyCtx() и Enforce() могут привести к падению процесса с ошибкой concurrent map read and map write, поэтому используйте NewSyncedContextEnforcer() вместо него (версии после v3.11.0; в более ранних версиях защищайте его собственным sync.RWMutex). Подробности см. в разделах Multithreading и Enforcers.

Осторожно с кэшированием решений​

CachedEnforcer и SyncedCachedEnforcer запоминают результат каждого вызова Enforce(). Это полезно, когда одни и те же запросы повторяются часто, но закэшированное решение может пережить политику, которая его породила. В Go:

  • LoadPolicy() очищает весь кэш.
  • Добавление или удаление правила политики удаляет максимум один элемент кэша, запрос которого точно соответствует этому правилу. Решения, зависящие от этого правила косвенно, например через назначение роли (g), остаются в кэше.
  • Вызывайте InvalidateCache() после изменения назначений ролей и устанавливайте ограничение по времени с помощью SetExpireTime(), чтобы ни одно устаревшее решение не хранилось вечно.

Синхронизация реплик​

Когда вы запускаете несколько экземпляров (несколько подов или несколько рабочих процессов на под), каждый из них имеет свою копию политики. Без синхронизации разрешение, выданное через экземпляр A, будет невидимо для экземпляра B, и, что хуже, разрешение, отозванное через A, продолжит работать в B до перезапуска B.

Используйте watcher (Redis, etcd, Kafka, NATS, базу данных, ...). Когда экземпляр изменяет политику, он публикует сообщение; другие экземпляры получают его и обновляют свою копию.

import (
"github.com/casbin/casbin/v3"
gormadapter "github.com/casbin/gorm-adapter/v3"
rediswatcher "github.com/casbin/redis-watcher/v2"
)

a, _ := gormadapter.NewAdapterByDB(db)
e, _ := casbin.NewSyncedCachedEnforcer("rbac_model.conf", a)

w, _ := rediswatcher.NewWatcher("redis:6379", rediswatcher.WatcherOptions{
Channel: "/casbin",
IgnoreSelf: true,
})
_ = e.SetWatcher(w)

// Reload through the synced, cached enforcer so the reload takes its lock
// and clears its decision cache
_ = w.SetUpdateCallback(func(string) { _ = e.LoadPolicy() })

Важные моменты:

  • Устанавливайте колбэк самостоятельно при использовании обёрнутого enforcer. В Go SetWatcher() устанавливает колбэк по умолчанию, который перезагружает внутренний Enforcer, обходя блокировку SyncedEnforcer и кэш SyncedCachedEnforcer. Вызывайте SetUpdateCallback() после SetWatcher(), как показано выше.
  • AutoSave и уведомления независимы. EnableAutoSave() определяет, записывается ли изменение в адаптер; EnableAutoNotifyWatcher() определяет, уведомляются ли другие экземпляры об этом. Вы можете отключить AutoSave и всё равно отправлять уведомления, что необходимо, если вы сохраняете политику сами (см. ниже). pycasbin 2.8.0 и более ранние версии отправляют уведомления только при включённом AutoSave; более новые версии ведут себя так же, как другие языки.
  • Инкрементальные обновления. Обычный Watcher заставляет другие экземпляры перезагружать всю политику целиком. WatcherEx отправляет точное изменение (UpdateForAddPolicy, UpdateForRemovePolicy, ...), и принимающий экземпляр применяет только это изменение. В Python применяйте его с помощью DistributedEnforcer.add_policy_self(False, ...) и аналогичных методов, которые обновляют память без записи в адаптер. В Go методы Self* (SelfAddPolicy, SelfRemovePolicy, ...) пропускают watcher, но всё ещё пишут в адаптер, пока включён AutoSave. Когда все экземпляры используют одну базу данных, изменение уже там, поэтому вторая запись создаст дубликат или завершится ошибкой; вместо этого перезагружайте данные с помощью LoadPolicy() в колбэке, как в примере выше.
  • Имейте резервный механизм. Сообщения могут потеряться, пока экземпляр отключён от шины сообщений. Периодическая полная перезагрузка ограничивает время, в течение которого пропущенное обновление остаётся неучтённым: StartAutoLoadPolicy(5 * time.Minute) для SyncedEnforcer (доступно в Go, Java и Python).
  • Нужна строгая согласованность? Watcher обеспечивает в конечном счёте согласованную систему (eventual consistency). Если каждый экземпляр должен видеть изменение до возврата управления из операции записи, используйте dispatcher или перенесите авторизацию в единый сервис с помощью Casbin Server.

Запись политики внутри собственной транзакции​

Приложения часто создают пользователя, команду и роль пользователя в одной транзакции базы данных. Если enforcer пишет в таблицу casbin_rule при включённом AutoSave, эта запись находится вне вашей транзакции, и если транзакция откатывается, правило остаётся.

Два способа сохранить их вместе:

  1. Запишите строки сами, затем обновите память после коммита. Отключите AutoSave, вставьте строки в таблицу casbin_rule в своей транзакции и после её фиксации вызовите AddPolicy() / AddGroupingPolicy() enforcer'а. При отключённом AutoSave эти методы обновляют только память, а watcher всё равно уведомляет другие экземпляры.

    enforcer.enable_auto_save(False)

    with db.transaction():
    create_user(...)
    insert_casbin_rule("g", "alice", "team-admin")

    # after commit: update this instance and notify the others
    enforcer.add_grouping_policy("alice", "team-admin")
  2. Go: используйте транзакционный enforcer. NewTransactionalEnforcer() с транзакционным адаптером (например, gormadapter.NewTransactionalAdapterByDB()) буферизует изменения и применяет их к базе данных и памяти при вызове Commit(). См. Adapters: Transaction. Версии после v3.11.0 уведомляют watcher после успешного выполнения Commit() с точными изменениями, если watcher является WatcherEx, а откатившаяся транзакция никого не уведомляет. В v3.11.0 и более ранних версиях фиксация транзакции не уведомляет watcher, поэтому вызывайте w.Update() после неё, чтобы сообщить другим экземплярам.

Реплики только для чтения и миграции​

Некоторые адаптеры создают таблицу casbin_rule при запуске. На реплике базы данных только для чтения (например, пассивном сайте аварийного восстановления) этот оператор завершается ошибкой. Создайте таблицу с помощью собственных миграций и отключите миграцию адаптера, где это поддерживается, например, gormadapter.TurnOffAutoMigrate(db) в Go. На экземплярах только для чтения вызывайте только LoadPolicy() и Enforce().

Отказ по умолчанию (Fail closed)​

Трактуем любую ошибку как отказ в доступе:

  • Если эфорсер не может быть создан или политика не может быть загружена при запуске, отказывайте в обслуживании запросов, требующих авторизации, вместо того чтобы пропускать их.
  • Если Enforce() возвращает ошибку, отклоните запрос.
ok, err := e.Enforce(sub, obj, act)
if err != nil || !ok {
return http.StatusForbidden
}

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