185 lines
9.4 KiB
Go
185 lines
9.4 KiB
Go
// 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 casbin
|
|
|
|
import (
|
|
"github.com/casbin/casbin/v3/effector"
|
|
"github.com/casbin/casbin/v3/model"
|
|
"github.com/casbin/casbin/v3/persist"
|
|
"github.com/casbin/casbin/v3/rbac"
|
|
"github.com/casbin/govaluate"
|
|
)
|
|
|
|
var (
|
|
_ IEnforcer = &Enforcer{}
|
|
_ IEnforcer = &SyncedEnforcer{}
|
|
_ IEnforcer = &CachedEnforcer{}
|
|
)
|
|
|
|
// IEnforcer is the API interface of Enforcer.
|
|
type IEnforcer interface {
|
|
/* Enforcer API */
|
|
InitWithFile(modelPath string, policyPath string) error
|
|
InitWithAdapter(modelPath string, adapter persist.Adapter) error
|
|
InitWithModelAndAdapter(m model.Model, adapter persist.Adapter) error
|
|
LoadModel() error
|
|
GetModel() model.Model
|
|
SetModel(m model.Model)
|
|
GetAdapter() persist.Adapter
|
|
SetAdapter(adapter persist.Adapter)
|
|
SetWatcher(watcher persist.Watcher) error
|
|
GetRoleManager() rbac.RoleManager
|
|
SetRoleManager(rm rbac.RoleManager)
|
|
SetEffector(eft effector.Effector)
|
|
SetAIConfig(config AIConfig)
|
|
ClearPolicy()
|
|
LoadPolicy() error
|
|
LoadFilteredPolicy(filter interface{}) error
|
|
LoadIncrementalFilteredPolicy(filter interface{}) error
|
|
IsFiltered() bool
|
|
SavePolicy() error
|
|
EnableEnforce(enable bool)
|
|
EnableAutoNotifyWatcher(enable bool)
|
|
EnableAutoSave(autoSave bool)
|
|
EnableAutoBuildRoleLinks(autoBuildRoleLinks bool)
|
|
BuildRoleLinks() error
|
|
Enforce(rvals ...interface{}) (bool, error)
|
|
EnforceWithMatcher(matcher string, rvals ...interface{}) (bool, error)
|
|
EnforceEx(rvals ...interface{}) (bool, []string, error)
|
|
EnforceExWithMatcher(matcher string, rvals ...interface{}) (bool, []string, error)
|
|
BatchEnforce(requests [][]interface{}) ([]bool, error)
|
|
BatchEnforceWithMatcher(matcher string, requests [][]interface{}) ([]bool, error)
|
|
Explain(rvals ...interface{}) (string, error)
|
|
|
|
/* RBAC API */
|
|
GetRolesForUser(name string, domain ...string) ([]string, error)
|
|
GetUsersForRole(name string, domain ...string) ([]string, error)
|
|
HasRoleForUser(name string, role string, domain ...string) (bool, error)
|
|
AddRoleForUser(user string, role string, domain ...string) (bool, error)
|
|
AddPermissionForUser(user string, permission ...string) (bool, error)
|
|
AddPermissionsForUser(user string, permissions ...[]string) (bool, error)
|
|
DeletePermissionForUser(user string, permission ...string) (bool, error)
|
|
DeletePermissionsForUser(user string) (bool, error)
|
|
GetPermissionsForUser(user string, domain ...string) ([][]string, error)
|
|
HasPermissionForUser(user string, permission ...string) (bool, error)
|
|
GetImplicitRolesForUser(name string, domain ...string) ([]string, error)
|
|
GetImplicitPermissionsForUser(user string, domain ...string) ([][]string, error)
|
|
GetImplicitUsersForPermission(permission ...string) ([]string, error)
|
|
DeleteRoleForUser(user string, role string, domain ...string) (bool, error)
|
|
DeleteRolesForUser(user string, domain ...string) (bool, error)
|
|
DeleteUser(user string) (bool, error)
|
|
DeleteRole(role string) (bool, error)
|
|
DeletePermission(permission ...string) (bool, error)
|
|
|
|
/* RBAC API with domains*/
|
|
GetUsersForRoleInDomain(name string, domain string) []string
|
|
GetRolesForUserInDomain(name string, domain string) []string
|
|
GetPermissionsForUserInDomain(user string, domain string) [][]string
|
|
AddRoleForUserInDomain(user string, role string, domain string) (bool, error)
|
|
DeleteRoleForUserInDomain(user string, role string, domain string) (bool, error)
|
|
GetAllUsersByDomain(domain string) ([]string, error)
|
|
DeleteRolesForUserInDomain(user string, domain string) (bool, error)
|
|
DeleteAllUsersByDomain(domain string) (bool, error)
|
|
DeleteDomains(domains ...string) (bool, error)
|
|
GetAllDomains() ([]string, error)
|
|
GetAllRolesByDomain(domain string) ([]string, error)
|
|
|
|
/* Management API */
|
|
GetAllSubjects() ([]string, error)
|
|
GetAllNamedSubjects(ptype string) ([]string, error)
|
|
GetAllObjects() ([]string, error)
|
|
GetAllNamedObjects(ptype string) ([]string, error)
|
|
GetAllActions() ([]string, error)
|
|
GetAllNamedActions(ptype string) ([]string, error)
|
|
GetAllRoles() ([]string, error)
|
|
GetAllNamedRoles(ptype string) ([]string, error)
|
|
GetAllUsers() ([]string, error)
|
|
GetPolicy() ([][]string, error)
|
|
GetFilteredPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)
|
|
GetNamedPolicy(ptype string) ([][]string, error)
|
|
GetFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)
|
|
GetGroupingPolicy() ([][]string, error)
|
|
GetFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)
|
|
GetNamedGroupingPolicy(ptype string) ([][]string, error)
|
|
GetFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)
|
|
HasPolicy(params ...interface{}) (bool, error)
|
|
HasNamedPolicy(ptype string, params ...interface{}) (bool, error)
|
|
AddPolicy(params ...interface{}) (bool, error)
|
|
AddPolicies(rules [][]string) (bool, error)
|
|
AddNamedPolicy(ptype string, params ...interface{}) (bool, error)
|
|
AddNamedPolicies(ptype string, rules [][]string) (bool, error)
|
|
AddPoliciesEx(rules [][]string) (bool, error)
|
|
AddNamedPoliciesEx(ptype string, rules [][]string) (bool, error)
|
|
RemovePolicy(params ...interface{}) (bool, error)
|
|
RemovePolicies(rules [][]string) (bool, error)
|
|
RemoveFilteredPolicy(fieldIndex int, fieldValues ...string) (bool, error)
|
|
RemoveNamedPolicy(ptype string, params ...interface{}) (bool, error)
|
|
RemoveNamedPolicies(ptype string, rules [][]string) (bool, error)
|
|
RemoveFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)
|
|
HasGroupingPolicy(params ...interface{}) (bool, error)
|
|
HasNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)
|
|
AddGroupingPolicy(params ...interface{}) (bool, error)
|
|
AddGroupingPolicies(rules [][]string) (bool, error)
|
|
AddGroupingPoliciesEx(rules [][]string) (bool, error)
|
|
AddNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)
|
|
AddNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)
|
|
AddNamedGroupingPoliciesEx(ptype string, rules [][]string) (bool, error)
|
|
RemoveGroupingPolicy(params ...interface{}) (bool, error)
|
|
RemoveGroupingPolicies(rules [][]string) (bool, error)
|
|
RemoveFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) (bool, error)
|
|
RemoveNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)
|
|
RemoveNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)
|
|
RemoveFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)
|
|
AddFunction(name string, function govaluate.ExpressionFunction)
|
|
|
|
UpdatePolicy(oldPolicy []string, newPolicy []string) (bool, error)
|
|
UpdatePolicies(oldPolicies [][]string, newPolicies [][]string) (bool, error)
|
|
UpdateFilteredPolicies(newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)
|
|
|
|
UpdateGroupingPolicy(oldRule []string, newRule []string) (bool, error)
|
|
UpdateGroupingPolicies(oldRules [][]string, newRules [][]string) (bool, error)
|
|
UpdateNamedGroupingPolicy(ptype string, oldRule []string, newRule []string) (bool, error)
|
|
UpdateNamedGroupingPolicies(ptype string, oldRules [][]string, newRules [][]string) (bool, error)
|
|
|
|
/* Management API with autoNotifyWatcher disabled */
|
|
SelfAddPolicy(sec string, ptype string, rule []string) (bool, error)
|
|
SelfAddPolicies(sec string, ptype string, rules [][]string) (bool, error)
|
|
SelfAddPoliciesEx(sec string, ptype string, rules [][]string) (bool, error)
|
|
SelfRemovePolicy(sec string, ptype string, rule []string) (bool, error)
|
|
SelfRemovePolicies(sec string, ptype string, rules [][]string) (bool, error)
|
|
SelfRemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) (bool, error)
|
|
SelfUpdatePolicy(sec string, ptype string, oldRule, newRule []string) (bool, error)
|
|
SelfUpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) (bool, error)
|
|
}
|
|
|
|
var _ IDistributedEnforcer = &DistributedEnforcer{}
|
|
|
|
// IDistributedEnforcer defines dispatcher enforcer.
|
|
type IDistributedEnforcer interface {
|
|
IEnforcer
|
|
SetDispatcher(dispatcher persist.Dispatcher)
|
|
/* Management API for DistributedEnforcer*/
|
|
AddPoliciesSelf(shouldPersist func() bool, sec string, ptype string, rules [][]string) (affected [][]string, err error)
|
|
RemovePoliciesSelf(shouldPersist func() bool, sec string, ptype string, rules [][]string) (affected [][]string, err error)
|
|
RemoveFilteredPolicySelf(shouldPersist func() bool, sec string, ptype string, fieldIndex int, fieldValues ...string) (affected [][]string, err error)
|
|
ClearPolicySelf(shouldPersist func() bool) error
|
|
UpdatePolicySelf(shouldPersist func() bool, sec string, ptype string, oldRule, newRule []string) (affected bool, err error)
|
|
UpdatePoliciesSelf(shouldPersist func() bool, sec string, ptype string, oldRules, newRules [][]string) (affected bool, err error)
|
|
UpdateFilteredPoliciesSelf(shouldPersist func() bool, sec string, ptype string, newRules [][]string, fieldIndex int, fieldValues ...string) (bool, error)
|
|
}
|