snapshot of https://github.com/casbin/casbin.git (master, 2026-09-15; blobs > 131072B omitted)

rbac/role_manager.go

@@ -0,0 +1,83 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package rbac
+
+type MatchingFunc func(arg1 string, arg2 string) bool
+
+type LinkConditionFunc = func(args ...string) (bool, error)
+
+// RoleManager provides interface to define the operations for managing roles.
+type RoleManager interface {
+	// Clear clears all stored data and resets the role manager to the initial state.
+	Clear() error
+	// AddLink adds the inheritance link between two roles. role: name1 and role: name2.
+	// domain is a prefix to the roles (can be used for other purposes).
+	AddLink(name1 string, name2 string, domain ...string) error
+	// Deprecated: BuildRelationship is no longer required
+	BuildRelationship(name1 string, name2 string, domain ...string) error
+	// DeleteLink deletes the inheritance link between two roles. role: name1 and role: name2.
+	// domain is a prefix to the roles (can be used for other purposes).
+	DeleteLink(name1 string, name2 string, domain ...string) error
+	// HasLink determines whether a link exists between two roles. role: name1 inherits role: name2.
+	// domain is a prefix to the roles (can be used for other purposes).
+	HasLink(name1 string, name2 string, domain ...string) (bool, error)
+	// GetRoles gets the roles that a user inherits.
+	// domain is a prefix to the roles (can be used for other purposes).
+	GetRoles(name string, domain ...string) ([]string, error)
+	// GetUsers gets the users that inherits a role.
+	// domain is a prefix to the users (can be used for other purposes).
+	GetUsers(name string, domain ...string) ([]string, error)
+	// GetImplicitRoles gets the implicit roles that a user inherits, respecting maxHierarchyLevel.
+	// domain is a prefix to the roles (can be used for other purposes).
+	GetImplicitRoles(name string, domain ...string) ([]string, error)
+	// GetImplicitUsers gets the implicit users that inherits a role, respecting maxHierarchyLevel.
+	// domain is a prefix to the users (can be used for other purposes).
+	GetImplicitUsers(name string, domain ...string) ([]string, error)
+	// GetDomains gets domains that a user has
+	GetDomains(name string) ([]string, error)
+	// GetAllDomains gets all domains
+	GetAllDomains() ([]string, error)
+	// PrintRoles prints all the roles to log.
+	PrintRoles() error
+	// Match matches the domain with the pattern
+	Match(str string, pattern string) bool
+	// AddMatchingFunc adds the matching function
+	AddMatchingFunc(name string, fn MatchingFunc)
+	// AddDomainMatchingFunc adds the domain matching function
+	AddDomainMatchingFunc(name string, fn MatchingFunc)
+	// DeleteDomain deletes all data of a domain in the role manager.
+	DeleteDomain(domain string) error
+}
+
+// ConditionalRoleManager provides interface to define the operations for managing roles.
+// Link with conditions is supported.
+type ConditionalRoleManager interface {
+	RoleManager
+
+	// AddLinkConditionFunc Add condition function fn for Link userName->roleName,
+	// when fn returns true, Link is valid, otherwise invalid
+	AddLinkConditionFunc(userName, roleName string, fn LinkConditionFunc)
+	// SetLinkConditionFuncParams Sets the parameters of the condition function fn for Link userName->roleName
+	SetLinkConditionFuncParams(userName, roleName string, params ...string)
+	// AddDomainLinkConditionFunc Add condition function fn for Link userName-> {roleName, domain},
+	// when fn returns true, Link is valid, otherwise invalid
+	AddDomainLinkConditionFunc(user string, role string, domain string, fn LinkConditionFunc)
+	// SetDomainLinkConditionFuncParams Sets the parameters of the condition function fn
+	// for Link userName->{roleName, domain}
+	SetDomainLinkConditionFuncParams(user string, role string, domain string, params ...string)
+}