주요 콘텐츠로 건너뛰기

Functions

매처의 함수​

Enhance matcher capabilities by incorporating functions. Use built-in functions or define custom ones. Built-in key-matching functions follow this signature:

bool function_name(string url, string pattern)

These functions return booleans indicating whether url matches pattern.

Available built-in functions:

함수url패턴예시
keyMatch/alice_data/resource1과 같은 URL 경로/alice_data/*와 같은 URL 경로 또는 * 패턴keymatch_model.conf/keymatch_policy.csv
keyMatch2/alice_data/resource1과 같은 URL 경로/alice_data/:resource와 같은 URL 경로 또는 : 패턴keymatch2_model.conf/keymatch2_policy.csv
keyMatch3/alice_data/resource1과 같은 URL 경로/alice_data/{resource}와 같은 URL 경로 또는 {} 패턴https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L171-L196
keyMatch4/alice_data/123/book/123과 같은 URL 경로/alice_data/{id}/book/{id}와 같은 URL 경로 또는 {} 패턴https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L208-L222
keyMatch5/alice_data/123/?status=1과 같은 URL 경로/alice_data/{id}/*와 같은 URL 경로, {} 또는 * 패턴https://github.com/casbin/casbin/blob/1cde2646d10ad1190c0d784c3a1c0e1ace1b5bc9/util/builtin_operators_test.go#L485-L526
regexMatch아무 문자열정규 표현식 패턴keymatch_model.conf/keymatch_policy.csv
ipMatch192.168.2.123과 같은 IP 주소192.168.2.0/24와 같은 IP 주소 또는 CIDRipmatch_model.conf/ipmatch_policy.csv
globMatch/alice_data/resource1과 같은 경로 형식의 경로/alice_data/*와 같은 glob 패턴https://github.com/casbin/casbin/blob/277c1a2b85698272f764d71a94d2595a8d425915/util/builtin_operators_test.go#L426-L466

Key-getting functions generally accept three parameters (except keyGet):

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

These return the key_name value when matching the pattern, otherwise returning "".

Examples: KeyGet2("/resource1/action", "/:res/action", "res") returns "resource1", while KeyGet3("/resource1_admin/action", "/{res}_admin/*", "res") returns "resource1". For KeyGet with two parameters: KeyGet("/resource1/action", "/*") returns "resource1/action".

함수url패턴key_name예시
keyGet/proj/resource1과 같은 URL 경로/proj/*와 같은 URL 경로 또는 * 패턴\keyget_model.conf/keymatch_policy.csv
keyGet2/proj/resource1과 같은 URL 경로/prooj/:resource와 같은 URL 경로 또는 : 패턴패턴에 지정된 키 이름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

사용자 정의 함수 추가 방법​

Start by creating your function, accepting multiple parameters and returning 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]
}

Next, create an interface{} wrapper:

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

    return (bool)(KeyMatch(name1, name2)), nil
}

Register the function with the Casbin enforcer:

e.AddFunction("my_func", KeyMatchFunc)

Use the function in your model CONF:

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