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

**Functions**

Functions in matchers​

Вы можете использовать встроенные функции в матчерах или регистрировать собственные. Встроенные функции сопоставления ключей имеют форму:

bool function_name(string url, string pattern)

Они возвращают результат проверки, соответствует ли url шаблону pattern.

Доступные встроенные функции:

ФункцияurlpatternПример
keyMatcha URL path like /alice_data/resource1a URL path or a * pattern like /alice_data/*keymatch_model.conf/keymatch_policy.csv
keyMatch2путь URL вида /alice_data/resource1путь URL или шаблон с :, например /alice_data/:resourcekeymatch2_model.conf/keymatch2_policy.csv
keyMatch3путь URL вида /alice_data/resource1путь URL или шаблон с {}, например /alice_data/{resource}https://github.com/apache/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L171-L196
keyMatch4путь URL вида /alice_data/123/book/123путь URL или шаблон с {}, например /alice_data/{id}/book/{id}https://github.com/apache/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L208-L222
keyMatch5путь URL вида /alice_data/123/?status=1путь URL, шаблон с {} или *, например /alice_data/{id}/*https://github.com/apache/casbin/blob/1cde2646d10ad1190c0d784c3a1c0e1ace1b5bc9/util/builtin_operators_test.go#L485-L526
regexMatchлюбая строкарегулярное выражениеkeymatch_model.conf/keymatch_policy.csv
ipMatchIP-адрес, например 192.168.2.123IP-адрес или CIDR, например 192.168.2.0/24ipmatch_model.conf/ipmatch_policy.csv
globMatchпуть вида /alice_data/resource1glob-шаблон, например /alice_data/*https://github.com/apache/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L426-L466

Функции извлечения ключей принимают три параметра (кроме keyGet, которая принимает два):

bool function_name(string url, string pattern, string key_name)

Они возвращают значение указанного ключа, если URL соответствует шаблону, иначе — "".

Примеры:

  • KeyGet2("/resource1/action", "/:res/action", "res") → "resource1"
  • KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res") → "resource1"
  • KeyGet("/resource1/action", "/*") → "resource1/action" (форма с двумя параметрами)
Функцияurlpatternkey_nameexample
keyGetпуть URL вида /proj/resource1путь URL или шаблон с *, например /proj/*\keyget_model.conf/keymatch_policy.csv
keyGet2путь URL вида /proj/resource1путь URL или шаблон с :, например /proj/:resourceимя ключа, указанное в шаблонеkeyget2_model.conf/keymatch2_policy.csv
keyGet3путь URL вида /proj/res3_admin/путь URL или шаблон с {}, например /proj/{resource}_admin/*имя ключа, указанное в шаблонеhttps://github.com/apache/casbin/blob/7bd496f94f5a2739a392d333a9aaaa10ae397673/util/builtin_operators_test.go#L209-L247

Полные сведения о функциях: https://github.com/apache/casbin/blob/master/util/builtin_operators_test.go

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

  1. Реализуйте функцию, которая принимает необходимые аргументы и возвращает bool:

    func KeyMatch(key1 string, key2 string) bool {
    i := strings.Index(key2, "*")
    if i == -1 {
    return key1 == key2
    }

    if len(key1) > i {
    return key1[:i] == key2[:i]
    }
    return key1 == key2[:i]
    }
  2. Оберните её для Casbin (сигнатура func(...interface{}) (interface{}, error)):

    func KeyMatchFunc(args ...interface{}) (interface{}, error) {
    name1 := args[0].(string)
    name2 := args[1].(string)

    return (bool)(KeyMatch(name1, name2)), nil
    }
  3. Зарегистрируйте её в enforcer:

    e.AddFunction("my_func", KeyMatchFunc)
  4. Используйте её в вашей модели:

    [matchers]
    m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act

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