Functions
マッチャーの関数
You can use built-in functions in matchers or register custom ones. Built-in key-matching functions have the form:
bool function_name(string url, string pattern)
They return whether url matches pattern.
Available built-in functions:
Key-extraction functions take three parameters (except keyGet, which takes two):
bool function_name(string url, string pattern, string key_name)
They return the value of the named key when the URL matches the pattern, or "" otherwise.
Examples:
KeyGet2("/resource1/action", "/:res/action", "res")→"resource1"KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res")→"resource1"KeyGet("/resource1/action", "/*")→"resource1/action"(two-parameter form)
| 関数 | url | パターン | key_name | 例 |
|---|---|---|---|---|
| keyGet | /proj/resource1のようなURLパス | /proj/*のようなURLパスまたは*パターン | \ | keyget_model.conf/keymatch_policy.csv |
| keyGet2 | /proj/resource1のようなURLパス | a URL path or : pattern like /proj/:resource | パターンで指定されたキー名 | keyget2_model.conf/keymatch2_policy.csv |
| keyGet3 | /proj/res3_admin/ のようなURLパス | /proj/{resource}_admin/* のようなURLパスまたは{}パターン | パターンで指定されたキー名 | https://github.com/casbin/casbin/blob/7bd496f94f5a2739a392d333a9aaaa10ae397673/util/builtin_operators_test.go#L209-L247 |
Complete function details: https://github.com/casbin/casbin/blob/master/util/builtin_operators_test.go
Adding a custom function
- Implement a function that takes the required arguments and returns a
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]
}
- Wrap it for Casbin (signature
func(...interface{}) (interface{}, error)):
func KeyMatchFunc(args ...interface{}) (interface{}, error) {
name1 := args[0].(string)
name2 := args[1].(string)
return (bool)(KeyMatch(name1, name2)), nil
}
- Register it on the enforcer:
e.AddFunction("my_func", KeyMatchFunc)
- Use it in your model:
[matchers]
m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act