casbin

package module

v3.10.0 Latest Latest Go to latest Published: Jan 25, 2026 License: Apache-2.0 Imports: 26 Imported by: 45

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/casbin/casbin

Links

Open Source Insights

README ¶

Casbin

News: still worry about how to write the correct Casbin policy? Casbin online editor is coming to help! Try it at: https://casbin.org/editor/

Casbin is a powerful and efficient open-source access control library for Golang projects. It provides support for enforcing authorization based on various access control models.

All the languages supported by Casbin:


Casbin	jCasbin	node-Casbin	PHP-Casbin
production-ready	production-ready	production-ready	production-ready


PyCasbin	Casbin.NET	Casbin-CPP	Casbin-RS
production-ready	production-ready	production-ready	production-ready

Supported models

ACL (Access Control List)
ACL with superuser
ACL without users: especially useful for systems that don't have authentication or user log-ins.
ACL without resources: some scenarios may target for a type of resources instead of an individual resource by using permissions like write-article, read-log. It doesn't control the access to a specific article or log.
RBAC (Role-Based Access Control)
RBAC with resource roles: both users and resources can have roles (or groups) at the same time.
RBAC with domains/tenants: users can have different role sets for different domains/tenants.
ABAC (Attribute-Based Access Control): syntax sugar like resource.Owner can be used to get the attribute for a resource.
RESTful: supports paths like /res/*, /res/:id and HTTP methods like GET, POST, PUT, DELETE.
Deny-override: both allow and deny authorizations are supported, deny overrides the allow.
Priority: the policy rules can be prioritized like firewall rules.

How it works?

In Casbin, an access control model is abstracted into a CONF file based on the PERM metamodel (Policy, Effect, Request, Matchers). So switching or upgrading the authorization mechanism for a project is just as simple as modifying a configuration. You can customize your own access control model by combining the available models. For example, you can get RBAC roles and ABAC attributes together inside one model and share one set of policy rules.

The most basic and simplest model in Casbin is ACL. ACL's model CONF is:

# Request definition
[request_definition]
r = sub, obj, act

# Policy definition
[policy_definition]
p = sub, obj, act

# Policy effect
[policy_effect]
e = some(where (p.eft == allow))

# Matchers
[matchers]
m = r.sub == p.sub && r.obj == p.obj && r.act == p.act

An example policy for ACL model is like:

p, alice, data1, read
p, bob, data2, write

It means:

alice can read data1
bob can write data2

We also support multi-line mode by appending '\' in the end:

# Matchers
[matchers]
m = r.sub == p.sub && r.obj == p.obj \
  && r.act == p.act

Further more, if you are using ABAC, you can try operator in like following in Casbin golang edition (jCasbin and Node-Casbin are not supported yet):

# Matchers
[matchers]
m = r.obj == p.obj && r.act == p.act || r.obj in ('data2', 'data3')

But you SHOULD make sure that the length of the array is MORE than 1, otherwise there will cause it to panic.

For more operators, you may take a look at govaluate

Features

What Casbin does:

enforce the policy in the classic {subject, object, action} form or a customized form as you defined, both allow and deny authorizations are supported.
handle the storage of the access control model and its policy.
manage the role-user mappings and role-role mappings (aka role hierarchy in RBAC).
support built-in superuser like root or administrator. A superuser can do anything without explicit permissions.
multiple built-in operators to support the rule matching. For example, keyMatch can map a resource key /foo/bar to the pattern /foo*.

What Casbin does NOT do:

authentication (aka verify username and password when a user logs in)
manage the list of users or roles. I believe it's more convenient for the project itself to manage these entities. Users usually have their passwords, and Casbin is not designed as a password container. However, Casbin stores the user-role mapping for the RBAC scenario.

Installation

go get github.com/casbin/casbin/v3

Documentation

https://casbin.org/docs/overview

Online editor

You can also use the online editor (https://casbin.org/editor/) to write your Casbin model and policy in your web browser. It provides functionality such as syntax highlighting and code completion, just like an IDE for a programming language.

Tutorials

https://casbin.org/docs/tutorials

Get started

New a Casbin enforcer with a model file and a policy file:

e, _ := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv")

Note: you can also initialize an enforcer with policy in DB instead of file, see Policy-persistence section for details.

Add an enforcement hook into your code right before the access happens:

sub := "alice" // the user that wants to access a resource.
obj := "data1" // the resource that is going to be accessed.
act := "read" // the operation that the user performs on the resource.

if res, _ := e.Enforce(sub, obj, act); res {
    // permit alice to read data1
} else {
    // deny the request, show an error
}

Besides the static policy file, Casbin also provides API for permission management at run-time. For example, You can get all the roles assigned to a user as below:
```
roles, _ := e.GetImplicitRolesForUser(sub)
```

See Policy management APIs for more usage.

Policy management

Casbin provides two sets of APIs to manage permissions:

Management API: the primitive API that provides full support for Casbin policy management.
RBAC API: a more friendly API for RBAC. This API is a subset of Management API. The RBAC users could use this API to simplify the code.

We also provide a web-based UI for model management and policy management:

model editor

policy editor

Examples

Model	Model file	Policy file
ACL	basic_model.conf	basic_policy.csv
ACL with superuser	basic_model_with_root.conf	basic_policy.csv
ACL without users	basic_model_without_users.conf	basic_policy_without_users.csv
ACL without resources	basic_model_without_resources.conf	basic_policy_without_resources.csv
RBAC	rbac_model.conf	rbac_policy.csv
RBAC with resource roles	rbac_model_with_resource_roles.conf	rbac_policy_with_resource_roles.csv
RBAC with domains/tenants	rbac_model_with_domains.conf	rbac_policy_with_domains.csv
ABAC	abac_model.conf	N/A
RESTful	keymatch_model.conf	keymatch_policy.csv
Deny-override	rbac_model_with_deny.conf	rbac_policy_with_deny.csv
Priority	priority_model.conf	priority_policy.csv

Middlewares

Authz middlewares for web frameworks: https://casbin.org/docs/middlewares

Our adopters

https://casbin.org/docs/adopters

How to Contribute

Please read the contributing guide.

Contributors

This project exists thanks to all the people who contribute.

Star History

License

This project is licensed under the Apache 2.0 license.

Contact

If you have any issues or feature requests, please contact us. PR is welcomed.

Documentation ¶

Overview ¶

rbac_api_context.go

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CasbinJsGetPermissionForUser ¶

func CasbinJsGetPermissionForUser(e IEnforcer, user string) (string, error)

func CasbinJsGetPermissionForUserOld ¶

func CasbinJsGetPermissionForUserOld(e IEnforcer, user string) ([]byte, error)

func GetCacheKey ¶

func GetCacheKey(params ...interface{}) (string, bool)

Types ¶

type AIConfig ¶ added in v3.10.0

type AIConfig struct {
	// Endpoint is the API endpoint (e.g., "https://api.openai.com/v1/chat/completions")
	Endpoint string
	// APIKey is the authentication key for the API
	APIKey string
	// Model is the model to use (e.g., "gpt-3.5-turbo", "gpt-4")
	Model string
	// Timeout for API requests (default: 30s)
	Timeout time.Duration
}

AIConfig contains configuration for AI API calls.

type CacheableParam ¶

type CacheableParam interface {
	GetCacheKey() string
}

type CachedEnforcer ¶

type CachedEnforcer struct {
	*Enforcer
	// contains filtered or unexported fields
}

CachedEnforcer wraps Enforcer and provides decision cache.

func NewCachedEnforcer ¶

func NewCachedEnforcer(params ...interface{}) (*CachedEnforcer, error)

NewCachedEnforcer creates a cached enforcer via file or DB.

func (*CachedEnforcer) ClearPolicy ¶

func (e *CachedEnforcer) ClearPolicy()

ClearPolicy clears all policy.

func (*CachedEnforcer) EnableCache ¶

func (e *CachedEnforcer) EnableCache(enableCache bool)

EnableCache determines whether to enable cache on Enforce(). When enableCache is enabled, cached result (true | false) will be returned for previous decisions.

func (*CachedEnforcer) Enforce ¶

func (e *CachedEnforcer) Enforce(rvals ...interface{}) (bool, error)

Enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act). if rvals is not string , ignore the cache.

func (*CachedEnforcer) InvalidateCache ¶

func (e *CachedEnforcer) InvalidateCache() error

InvalidateCache deletes all the existing cached decisions.

func (*CachedEnforcer) LoadPolicy ¶

func (e *CachedEnforcer) LoadPolicy() error

func (*CachedEnforcer) RemovePolicies ¶

func (e *CachedEnforcer) RemovePolicies(rules [][]string) (bool, error)

func (*CachedEnforcer) RemovePolicy ¶

func (e *CachedEnforcer) RemovePolicy(params ...interface{}) (bool, error)

func (*CachedEnforcer) SetCache ¶

func (e *CachedEnforcer) SetCache(c cache.Cache)

func (*CachedEnforcer) SetExpireTime ¶

func (e *CachedEnforcer) SetExpireTime(expireTime time.Duration)

type ConflictDetector ¶

type ConflictDetector struct {
	// contains filtered or unexported fields
}

ConflictDetector detects conflicts between transaction operations and current model state.

func NewConflictDetector ¶

func NewConflictDetector(baseModel, currentModel model.Model, operations []persist.PolicyOperation) *ConflictDetector

NewConflictDetector creates a new conflict detector instance.

func (*ConflictDetector) DetectConflicts ¶

func (cd *ConflictDetector) DetectConflicts() error

DetectConflicts checks for conflicts between the transaction operations and current model state. Returns nil if no conflicts are found, otherwise returns a ConflictError describing the conflict.

type ConflictError ¶

type ConflictError struct {
	Operation persist.PolicyOperation
	Reason    string
}

ConflictError represents a transaction conflict error.

func (*ConflictError) Error ¶

func (e *ConflictError) Error() string

type ContextEnforcer ¶

type ContextEnforcer struct {
	*Enforcer
	// contains filtered or unexported fields
}

ContextEnforcer wraps Enforcer and provides context-aware operations.

func (*ContextEnforcer) AddGroupingPoliciesCtx ¶

func (e *ContextEnforcer) AddGroupingPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)

AddGroupingPoliciesCtx adds grouping policy rules to the storage with context.

func (*ContextEnforcer) AddGroupingPoliciesExCtx ¶

func (e *ContextEnforcer) AddGroupingPoliciesExCtx(ctx context.Context, rules [][]string) (bool, error)

func (*ContextEnforcer) AddGroupingPolicyCtx ¶

func (e *ContextEnforcer) AddGroupingPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)

AddGroupingPolicyCtx adds a grouping policy rule to the storage with context.

func (*ContextEnforcer) AddNamedGroupingPoliciesCtx ¶

func (e *ContextEnforcer) AddNamedGroupingPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

AddNamedGroupingPoliciesCtx adds named grouping policy rules to the storage with context.

func (*ContextEnforcer) AddNamedGroupingPoliciesExCtx ¶

func (e *ContextEnforcer) AddNamedGroupingPoliciesExCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

func (*ContextEnforcer) AddNamedGroupingPolicyCtx ¶

func (e *ContextEnforcer) AddNamedGroupingPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)

AddNamedGroupingPolicyCtx adds a named grouping policy rule to the storage with context.

func (*ContextEnforcer) AddNamedPoliciesCtx ¶

func (e *ContextEnforcer) AddNamedPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

AddNamedPoliciesCtx adds named policy rules to the storage with context.

func (*ContextEnforcer) AddNamedPoliciesExCtx ¶

func (e *ContextEnforcer) AddNamedPoliciesExCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

func (*ContextEnforcer) AddNamedPolicyCtx ¶

func (e *ContextEnforcer) AddNamedPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)

AddNamedPolicyCtx adds a named policy rule to the storage with context.

func (*ContextEnforcer) AddPermissionForUserCtx ¶

func (e *ContextEnforcer) AddPermissionForUserCtx(ctx context.Context, user string, permission ...string) (bool, error)

AddPermissionForUserCtx adds a permission for a user or role with context support. Returns false if the user or role already has the permission (aka not affected).

func (*ContextEnforcer) AddPermissionsForUserCtx ¶

func (e *ContextEnforcer) AddPermissionsForUserCtx(ctx context.Context, user string, permissions ...[]string) (bool, error)

AddPermissionsForUserCtx adds multiple permissions for a user or role with context support. Returns false if the user or role already has one of the permissions (aka not affected).

func (*ContextEnforcer) AddPoliciesCtx ¶

func (e *ContextEnforcer) AddPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)

AddPoliciesCtx adds policy rules to the storage with context.

func (*ContextEnforcer) AddPoliciesExCtx ¶

func (e *ContextEnforcer) AddPoliciesExCtx(ctx context.Context, rules [][]string) (bool, error)

func (*ContextEnforcer) AddPolicyCtx ¶

func (e *ContextEnforcer) AddPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)

AddPolicyCtx adds a policy rule to the storage with context.

func (*ContextEnforcer) AddRoleForUserCtx ¶

func (e *ContextEnforcer) AddRoleForUserCtx(ctx context.Context, user string, role string, domain ...string) (bool, error)

AddRoleForUserCtx adds a role for a user with context support. Returns false if the user already has the role (aka not affected).

func (*ContextEnforcer) AddRoleForUserInDomainCtx ¶

func (e *ContextEnforcer) AddRoleForUserInDomainCtx(ctx context.Context, user string, role string, domain string) (bool, error)

AddRoleForUserInDomainCtx adds a role for a user inside a domain with context support. Returns false if the user already has the role (aka not affected).

func (*ContextEnforcer) DeleteAllUsersByDomainCtx ¶

func (e *ContextEnforcer) DeleteAllUsersByDomainCtx(ctx context.Context, domain string) (bool, error)

DeleteAllUsersByDomainCtx deletes all users associated with the domain with context support.

func (*ContextEnforcer) DeleteDomainsCtx ¶

func (e *ContextEnforcer) DeleteDomainsCtx(ctx context.Context, domains ...string) (bool, error)

DeleteDomainsCtx deletes all associated policies for domains with context support. It would delete all domains if parameter is not provided.

func (*ContextEnforcer) DeletePermissionCtx ¶

func (e *ContextEnforcer) DeletePermissionCtx(ctx context.Context, permission ...string) (bool, error)

DeletePermissionCtx deletes a permission with context support. Returns false if the permission does not exist (aka not affected).

func (*ContextEnforcer) DeletePermissionForUserCtx ¶

func (e *ContextEnforcer) DeletePermissionForUserCtx(ctx context.Context, user string, permission ...string) (bool, error)

DeletePermissionForUserCtx deletes a permission for a user or role with context support. Returns false if the user or role does not have the permission (aka not affected).

func (*ContextEnforcer) DeletePermissionsForUserCtx ¶

func (e *ContextEnforcer) DeletePermissionsForUserCtx(ctx context.Context, user string) (bool, error)

DeletePermissionsForUserCtx deletes permissions for a user or role with context support. Returns false if the user or role does not have any permissions (aka not affected).

func (*ContextEnforcer) DeleteRoleCtx ¶

func (e *ContextEnforcer) DeleteRoleCtx(ctx context.Context, role string) (bool, error)

DeleteRoleCtx deletes a role with context support. Returns false if the role does not exist (aka not affected).

func (*ContextEnforcer) DeleteRoleForUserCtx ¶

func (e *ContextEnforcer) DeleteRoleForUserCtx(ctx context.Context, user string, role string, domain ...string) (bool, error)

DeleteRoleForUserCtx deletes a role for a user with context support. Returns false if the user does not have the role (aka not affected).

func (*ContextEnforcer) DeleteRoleForUserInDomainCtx ¶

func (e *ContextEnforcer) DeleteRoleForUserInDomainCtx(ctx context.Context, user string, role string, domain string) (bool, error)

DeleteRoleForUserInDomainCtx deletes a role for a user inside a domain with context support. Returns false if the user does not have the role (aka not affected).

func (*ContextEnforcer) DeleteRolesForUserCtx ¶

func (e *ContextEnforcer) DeleteRolesForUserCtx(ctx context.Context, user string, domain ...string) (bool, error)

DeleteRolesForUserCtx deletes all roles for a user with context support. Returns false if the user does not have any roles (aka not affected).

func (*ContextEnforcer) DeleteRolesForUserInDomainCtx ¶

func (e *ContextEnforcer) DeleteRolesForUserInDomainCtx(ctx context.Context, user string, domain string) (bool, error)

DeleteRolesForUserInDomainCtx deletes all roles for a user inside a domain with context support. Returns false if the user does not have any roles (aka not affected).

func (*ContextEnforcer) DeleteUserCtx ¶

func (e *ContextEnforcer) DeleteUserCtx(ctx context.Context, user string) (bool, error)

DeleteUserCtx deletes a user with context support. Returns false if the user does not exist (aka not affected).

func (*ContextEnforcer) IsFilteredCtx ¶

func (e *ContextEnforcer) IsFilteredCtx(ctx context.Context) bool

IsFilteredCtx returns true if the loaded policy has been filtered with context.

func (*ContextEnforcer) LoadPolicyCtx ¶

func (e *ContextEnforcer) LoadPolicyCtx(ctx context.Context) error

LoadPolicyCtx loads all policy rules from the storage with context.

func (*ContextEnforcer) RemoveFilteredGroupingPolicyCtx ¶

func (e *ContextEnforcer) RemoveFilteredGroupingPolicyCtx(ctx context.Context, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredGroupingPolicyCtx removes grouping policy rules that match the filter from the storage with context.

func (*ContextEnforcer) RemoveFilteredNamedGroupingPolicyCtx ¶

func (e *ContextEnforcer) RemoveFilteredNamedGroupingPolicyCtx(ctx context.Context, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedGroupingPolicyCtx removes named grouping policy rules that match the filter from the storage with context.

func (*ContextEnforcer) RemoveFilteredNamedPolicyCtx ¶

func (e *ContextEnforcer) RemoveFilteredNamedPolicyCtx(ctx context.Context, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedPolicyCtx removes named policy rules that match the filter from the storage with context.

func (*ContextEnforcer) RemoveFilteredPolicyCtx ¶

func (e *ContextEnforcer) RemoveFilteredPolicyCtx(ctx context.Context, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredPolicyCtx removes policy rules that match the filter from the storage with context.

func (*ContextEnforcer) RemoveGroupingPoliciesCtx ¶

func (e *ContextEnforcer) RemoveGroupingPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)

RemoveGroupingPoliciesCtx removes grouping policy rules from the storage with context.

func (*ContextEnforcer) RemoveGroupingPolicyCtx ¶

func (e *ContextEnforcer) RemoveGroupingPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)

RemoveGroupingPolicyCtx removes a grouping policy rule from the storage with context.

func (*ContextEnforcer) RemoveNamedGroupingPoliciesCtx ¶

func (e *ContextEnforcer) RemoveNamedGroupingPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

RemoveNamedGroupingPoliciesCtx removes named grouping policy rules from the storage with context.

func (*ContextEnforcer) RemoveNamedGroupingPolicyCtx ¶

func (e *ContextEnforcer) RemoveNamedGroupingPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)

RemoveNamedGroupingPolicyCtx removes a named grouping policy rule from the storage with context.

func (*ContextEnforcer) RemoveNamedPoliciesCtx ¶

func (e *ContextEnforcer) RemoveNamedPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

RemoveNamedPoliciesCtx removes named policy rules from the storage with context.

func (*ContextEnforcer) RemoveNamedPolicyCtx ¶

func (e *ContextEnforcer) RemoveNamedPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)

RemoveNamedPolicyCtx removes a named policy rule from the storage with context.

func (*ContextEnforcer) RemovePoliciesCtx ¶

func (e *ContextEnforcer) RemovePoliciesCtx(ctx context.Context, rules [][]string) (bool, error)

RemovePoliciesCtx removes policy rules from the storage with context.

func (*ContextEnforcer) RemovePolicyCtx ¶

func (e *ContextEnforcer) RemovePolicyCtx(ctx context.Context, params ...interface{}) (bool, error)

RemovePolicyCtx removes a policy rule from the storage with context.

func (*ContextEnforcer) SavePolicyCtx ¶

func (e *ContextEnforcer) SavePolicyCtx(ctx context.Context) error

func (*ContextEnforcer) SelfAddPoliciesCtx ¶

func (e *ContextEnforcer) SelfAddPoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)

SelfAddPoliciesCtx adds policy rules to the current policy with context.

func (*ContextEnforcer) SelfAddPoliciesExCtx ¶

func (e *ContextEnforcer) SelfAddPoliciesExCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)

func (*ContextEnforcer) SelfAddPolicyCtx ¶

func (e *ContextEnforcer) SelfAddPolicyCtx(ctx context.Context, sec string, ptype string, rule []string) (bool, error)

SelfAddPolicyCtx adds a policy rule to the current policy with context.

func (*ContextEnforcer) SelfRemoveFilteredPolicyCtx ¶

func (e *ContextEnforcer) SelfRemoveFilteredPolicyCtx(ctx context.Context, sec string, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

SelfRemoveFilteredPolicyCtx removes policy rules that match the filter from the current policy with context.

func (*ContextEnforcer) SelfRemovePoliciesCtx ¶

func (e *ContextEnforcer) SelfRemovePoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)

SelfRemovePoliciesCtx removes policy rules from the current policy with context.

func (*ContextEnforcer) SelfRemovePolicyCtx ¶

func (e *ContextEnforcer) SelfRemovePolicyCtx(ctx context.Context, sec string, ptype string, rule []string) (bool, error)

SelfRemovePolicyCtx removes a policy rule from the current policy with context.

func (*ContextEnforcer) SelfUpdatePoliciesCtx ¶

func (e *ContextEnforcer) SelfUpdatePoliciesCtx(ctx context.Context, sec string, ptype string, oldRules, newRules [][]string) (bool, error)

SelfUpdatePoliciesCtx updates policy rules in the current policy with context.

func (*ContextEnforcer) SelfUpdatePolicyCtx ¶

func (e *ContextEnforcer) SelfUpdatePolicyCtx(ctx context.Context, sec string, ptype string, oldRule, newRule []string) (bool, error)

SelfUpdatePolicyCtx updates a policy rule in the current policy with context.

func (*ContextEnforcer) UpdateFilteredNamedPoliciesCtx ¶

func (e *ContextEnforcer) UpdateFilteredNamedPoliciesCtx(ctx context.Context, ptype string, newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

UpdateFilteredNamedPoliciesCtx updates named policy rules that match the filter in the storage with context.

func (*ContextEnforcer) UpdateFilteredPoliciesCtx ¶

func (e *ContextEnforcer) UpdateFilteredPoliciesCtx(ctx context.Context, newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

UpdateFilteredPoliciesCtx updates policy rules that match the filter in the storage with context.

func (*ContextEnforcer) UpdateGroupingPoliciesCtx ¶

func (e *ContextEnforcer) UpdateGroupingPoliciesCtx(ctx context.Context, oldRules [][]string, newRules [][]string) (bool, error)

UpdateGroupingPoliciesCtx updates grouping policy rules in the storage with context.

func (*ContextEnforcer) UpdateGroupingPolicyCtx ¶

func (e *ContextEnforcer) UpdateGroupingPolicyCtx(ctx context.Context, oldRule []string, newRule []string) (bool, error)

UpdateGroupingPolicyCtx updates a grouping policy rule in the storage with context.

func (*ContextEnforcer) UpdateNamedGroupingPoliciesCtx ¶

func (e *ContextEnforcer) UpdateNamedGroupingPoliciesCtx(ctx context.Context, ptype string, oldRules [][]string, newRules [][]string) (bool, error)

UpdateNamedGroupingPoliciesCtx updates named grouping policy rules in the storage with context.

func (*ContextEnforcer) UpdateNamedGroupingPolicyCtx ¶

func (e *ContextEnforcer) UpdateNamedGroupingPolicyCtx(ctx context.Context, ptype string, oldRule []string, newRule []string) (bool, error)

UpdateNamedGroupingPolicyCtx updates a named grouping policy rule in the storage with context.

func (*ContextEnforcer) UpdateNamedPoliciesCtx ¶

func (e *ContextEnforcer) UpdateNamedPoliciesCtx(ctx context.Context, ptype string, p1 [][]string, p2 [][]string) (bool, error)

UpdateNamedPoliciesCtx updates named policy rules in the storage with context.

func (*ContextEnforcer) UpdateNamedPolicyCtx ¶

func (e *ContextEnforcer) UpdateNamedPolicyCtx(ctx context.Context, ptype string, p1 []string, p2 []string) (bool, error)

UpdateNamedPolicyCtx updates a named policy rule in the storage with context.

func (*ContextEnforcer) UpdatePoliciesCtx ¶

func (e *ContextEnforcer) UpdatePoliciesCtx(ctx context.Context, oldPolicies [][]string, newPolicies [][]string) (bool, error)

UpdatePoliciesCtx updates policy rules in the storage with context.

func (*ContextEnforcer) UpdatePolicyCtx ¶

func (e *ContextEnforcer) UpdatePolicyCtx(ctx context.Context, oldPolicy []string, newPolicy []string) (bool, error)

UpdatePolicyCtx updates a policy rule in the storage with context.

type DistributedEnforcer ¶

type DistributedEnforcer struct {
	*SyncedEnforcer
}

DistributedEnforcer wraps SyncedEnforcer for dispatcher.

func NewDistributedEnforcer ¶

func NewDistributedEnforcer(params ...interface{}) (*DistributedEnforcer, error)

func (*DistributedEnforcer) AddPoliciesSelf ¶

func (d *DistributedEnforcer) AddPoliciesSelf(shouldPersist func() bool, sec string, ptype string, rules [][]string) (affected [][]string, err error)

AddPoliciesSelf provides a method for dispatcher to add authorization rules to the current policy. The function returns the rules affected and error.

func (*DistributedEnforcer) ClearPolicySelf ¶

func (d *DistributedEnforcer) ClearPolicySelf(shouldPersist func() bool) error

ClearPolicySelf provides a method for dispatcher to clear all rules from the current policy.

func (*DistributedEnforcer) RemoveFilteredPolicySelf ¶

func (d *DistributedEnforcer) RemoveFilteredPolicySelf(shouldPersist func() bool, sec string, ptype string, fieldIndex int, fieldValues ...string) (affected [][]string, err error)

RemoveFilteredPolicySelf provides a method for dispatcher to remove an authorization rule from the current policy, field filters can be specified. The function returns the rules affected and error.

func (*DistributedEnforcer) RemovePoliciesSelf ¶

func (d *DistributedEnforcer) RemovePoliciesSelf(shouldPersist func() bool, sec string, ptype string, rules [][]string) (affected [][]string, err error)

RemovePoliciesSelf provides a method for dispatcher to remove a set of rules from current policy. The function returns the rules affected and error.

func (*DistributedEnforcer) SetDispatcher ¶

func (d *DistributedEnforcer) SetDispatcher(dispatcher persist.Dispatcher)

SetDispatcher sets the current dispatcher.

func (*DistributedEnforcer) UpdateFilteredPoliciesSelf ¶

func (d *DistributedEnforcer) UpdateFilteredPoliciesSelf(shouldPersist func() bool, sec string, ptype string, newRules [][]string, fieldIndex int, fieldValues ...string) (bool, error)

UpdateFilteredPoliciesSelf provides a method for dispatcher to update a set of authorization rules from the current policy.

func (*DistributedEnforcer) UpdatePoliciesSelf ¶

func (d *DistributedEnforcer) UpdatePoliciesSelf(shouldPersist func() bool, sec string, ptype string, oldRules, newRules [][]string) (affected bool, err error)

UpdatePoliciesSelf provides a method for dispatcher to update a set of authorization rules from the current policy.

func (*DistributedEnforcer) UpdatePolicySelf ¶

func (d *DistributedEnforcer) UpdatePolicySelf(shouldPersist func() bool, sec string, ptype string, oldRule, newRule []string) (affected bool, err error)

UpdatePolicySelf provides a method for dispatcher to update an authorization rule from the current policy.

type EnforceContext ¶

type EnforceContext struct {
	RType string
	PType string
	EType string
	MType string
}

EnforceContext is used as the first element of the parameter "rvals" in method "enforce".

func NewEnforceContext ¶

func NewEnforceContext(suffix string) EnforceContext

NewEnforceContext Create a default structure based on the suffix.

func (EnforceContext) GetCacheKey ¶

func (e EnforceContext) GetCacheKey() string

type Enforcer ¶

type Enforcer struct {
	// contains filtered or unexported fields
}

Enforcer is the main interface for authorization enforcement and policy management.

func NewEnforcer ¶

func NewEnforcer(params ...interface{}) (*Enforcer, error)

NewEnforcer creates an enforcer via file or DB.

File:

e := casbin.NewEnforcer("path/to/basic_model.conf", "path/to/basic_policy.csv")

MySQL DB:

a := mysqladapter.NewDBAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/")
e := casbin.NewEnforcer("path/to/basic_model.conf", a)

func (*Enforcer) AddFunction ¶

func (e *Enforcer) AddFunction(name string, function govaluate.ExpressionFunction)

AddFunction adds a customized function.

func (*Enforcer) AddGroupingPolicies ¶

func (e *Enforcer) AddGroupingPolicies(rules [][]string) (bool, error)

AddGroupingPolicies adds role inheritance rules to the current policy. If the rule already exists, the function returns false for the corresponding policy rule and the rule will not be added. Otherwise the function returns true for the corresponding policy rule by adding the new rule.

func (*Enforcer) AddGroupingPoliciesEx ¶

func (e *Enforcer) AddGroupingPoliciesEx(rules [][]string) (bool, error)

AddGroupingPoliciesEx adds role inheritance rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddGroupingPolicies, other non-existent rules are added instead of returning false directly.

func (*Enforcer) AddGroupingPolicy ¶

func (e *Enforcer) AddGroupingPolicy(params ...interface{}) (bool, error)

AddGroupingPolicy adds a role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*Enforcer) AddNamedDomainLinkConditionFunc ¶

func (e *Enforcer) AddNamedDomainLinkConditionFunc(ptype, user, role string, domain string, fn rbac.LinkConditionFunc) bool

AddNamedDomainLinkConditionFunc Add condition function fn for Link userName-> {roleName, domain}, when fn returns true, Link is valid, otherwise invalid.

func (*Enforcer) AddNamedDomainMatchingFunc ¶

func (e *Enforcer) AddNamedDomainMatchingFunc(ptype, name string, fn rbac.MatchingFunc) bool

AddNamedDomainMatchingFunc add MatchingFunc by ptype to RoleManager.

func (*Enforcer) AddNamedGroupingPolicies ¶

func (e *Enforcer) AddNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)

AddNamedGroupingPolicies adds named role inheritance rules to the current policy. If the rule already exists, the function returns false for the corresponding policy rule and the rule will not be added. Otherwise the function returns true for the corresponding policy rule by adding the new rule.

func (*Enforcer) AddNamedGroupingPoliciesEx ¶

func (e *Enforcer) AddNamedGroupingPoliciesEx(ptype string, rules [][]string) (bool, error)

AddNamedGroupingPoliciesEx adds named role inheritance rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddNamedGroupingPolicies, other non-existent rules are added instead of returning false directly.

func (*Enforcer) AddNamedGroupingPolicy ¶

func (e *Enforcer) AddNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedGroupingPolicy adds a named role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*Enforcer) AddNamedLinkConditionFunc ¶

func (e *Enforcer) AddNamedLinkConditionFunc(ptype, user, role string, fn rbac.LinkConditionFunc) bool

AddNamedLinkConditionFunc Add condition function fn for Link userName->roleName, when fn returns true, Link is valid, otherwise invalid.

func (*Enforcer) AddNamedMatchingFunc ¶

func (e *Enforcer) AddNamedMatchingFunc(ptype, name string, fn rbac.MatchingFunc) bool

AddNamedMatchingFunc add MatchingFunc by ptype RoleManager.

func (*Enforcer) AddNamedPolicies ¶

func (e *Enforcer) AddNamedPolicies(ptype string, rules [][]string) (bool, error)

AddNamedPolicies adds authorization rules to the current named policy. If the rule already exists, the function returns false for the corresponding rule and the rule will not be added. Otherwise the function returns true for the corresponding by adding the new rule.

func (*Enforcer) AddNamedPoliciesEx ¶

func (e *Enforcer) AddNamedPoliciesEx(ptype string, rules [][]string) (bool, error)

AddNamedPoliciesEx adds authorization rules to the current named policy. If the rule already exists, the rule will not be added. But unlike AddNamedPolicies, other non-existent rules are added instead of returning false directly.

func (*Enforcer) AddNamedPolicy ¶

func (e *Enforcer) AddNamedPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedPolicy adds an authorization rule to the current named policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*Enforcer) AddPermissionForUser ¶

func (e *Enforcer) AddPermissionForUser(user string, permission ...string) (bool, error)

AddPermissionForUser adds a permission for a user or role. Returns false if the user or role already has the permission (aka not affected).

func (*Enforcer) AddPermissionsForUser ¶

func (e *Enforcer) AddPermissionsForUser(user string, permissions ...[]string) (bool, error)

AddPermissionsForUser adds multiple permissions for a user or role. Returns false if the user or role already has one of the permissions (aka not affected).

func (*Enforcer) AddPolicies ¶

func (e *Enforcer) AddPolicies(rules [][]string) (bool, error)

AddPolicies adds authorization rules to the current policy. If the rule already exists, the function returns false for the corresponding rule and the rule will not be added. Otherwise the function returns true for the corresponding rule by adding the new rule.

func (*Enforcer) AddPoliciesEx ¶

func (e *Enforcer) AddPoliciesEx(rules [][]string) (bool, error)

AddPoliciesEx adds authorization rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddPolicies, other non-existent rules are added instead of returning false directly.

func (*Enforcer) AddPolicy ¶

func (e *Enforcer) AddPolicy(params ...interface{}) (bool, error)

AddPolicy adds an authorization rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*Enforcer) AddRoleForUser ¶

func (e *Enforcer) AddRoleForUser(user string, role string, domain ...string) (bool, error)

AddRoleForUser adds a role for a user. Returns false if the user already has the role (aka not affected).

func (*Enforcer) AddRoleForUserInDomain ¶

func (e *Enforcer) AddRoleForUserInDomain(user string, role string, domain string) (bool, error)

AddRoleForUserInDomain adds a role for a user inside a domain. Returns false if the user already has the role (aka not affected).

func (*Enforcer) AddRolesForUser ¶

func (e *Enforcer) AddRolesForUser(user string, roles []string, domain ...string) (bool, error)

AddRolesForUser adds roles for a user. Returns false if the user already has the roles (aka not affected).

func (*Enforcer) BatchEnforce ¶

func (e *Enforcer) BatchEnforce(requests [][]interface{}) ([]bool, error)

BatchEnforce enforce in batches.

func (*Enforcer) BatchEnforceWithMatcher ¶

func (e *Enforcer) BatchEnforceWithMatcher(matcher string, requests [][]interface{}) ([]bool, error)

BatchEnforceWithMatcher enforce with matcher in batches.

func (*Enforcer) BuildIncrementalConditionalRoleLinks ¶

func (e *Enforcer) BuildIncrementalConditionalRoleLinks(op model.PolicyOp, ptype string, rules [][]string) error

BuildIncrementalConditionalRoleLinks provides incremental build the role inheritance relations with conditions.

func (*Enforcer) BuildIncrementalRoleLinks ¶

func (e *Enforcer) BuildIncrementalRoleLinks(op model.PolicyOp, ptype string, rules [][]string) error

BuildIncrementalRoleLinks provides incremental build the role inheritance relations.

func (*Enforcer) BuildRoleLinks ¶

func (e *Enforcer) BuildRoleLinks() error

BuildRoleLinks manually rebuild the role inheritance relations.

func (*Enforcer) ClearPolicy ¶

func (e *Enforcer) ClearPolicy()

ClearPolicy clears all policy.

func (*Enforcer) DeleteAllUsersByDomain ¶

func (e *Enforcer) DeleteAllUsersByDomain(domain string) (bool, error)

DeleteAllUsersByDomain would delete all users associated with the domain.

func (*Enforcer) DeleteDomains ¶

func (e *Enforcer) DeleteDomains(domains ...string) (bool, error)

DeleteDomains would delete all associated policies. It would delete all domains if parameter is not provided.

func (*Enforcer) DeletePermission ¶

func (e *Enforcer) DeletePermission(permission ...string) (bool, error)

DeletePermission deletes a permission. Returns false if the permission does not exist (aka not affected).

func (*Enforcer) DeletePermissionForUser ¶

func (e *Enforcer) DeletePermissionForUser(user string, permission ...string) (bool, error)

DeletePermissionForUser deletes a permission for a user or role. Returns false if the user or role does not have the permission (aka not affected).

func (*Enforcer) DeletePermissionsForUser ¶

func (e *Enforcer) DeletePermissionsForUser(user string) (bool, error)

DeletePermissionsForUser deletes permissions for a user or role. Returns false if the user or role does not have any permissions (aka not affected).

func (*Enforcer) DeleteRole ¶

func (e *Enforcer) DeleteRole(role string) (bool, error)

DeleteRole deletes a role. Returns false if the role does not exist (aka not affected).

func (*Enforcer) DeleteRoleForUser ¶

func (e *Enforcer) DeleteRoleForUser(user string, role string, domain ...string) (bool, error)

DeleteRoleForUser deletes a role for a user. Returns false if the user does not have the role (aka not affected).

func (*Enforcer) DeleteRoleForUserInDomain ¶

func (e *Enforcer) DeleteRoleForUserInDomain(user string, role string, domain string) (bool, error)

DeleteRoleForUserInDomain deletes a role for a user inside a domain. Returns false if the user does not have the role (aka not affected).

func (*Enforcer) DeleteRolesForUser ¶

func (e *Enforcer) DeleteRolesForUser(user string, domain ...string) (bool, error)

DeleteRolesForUser deletes all roles for a user. Returns false if the user does not have any roles (aka not affected).

func (*Enforcer) DeleteRolesForUserInDomain ¶

func (e *Enforcer) DeleteRolesForUserInDomain(user string, domain string) (bool, error)

DeleteRolesForUserInDomain deletes all roles for a user inside a domain. Returns false if the user does not have any roles (aka not affected).

func (*Enforcer) DeleteUser ¶

func (e *Enforcer) DeleteUser(user string) (bool, error)

DeleteUser deletes a user. Returns false if the user does not exist (aka not affected).

func (*Enforcer) EnableAcceptJsonRequest ¶

func (e *Enforcer) EnableAcceptJsonRequest(acceptJsonRequest bool)

EnableAcceptJsonRequest controls whether to accept json as a request parameter.

func (*Enforcer) EnableAutoBuildRoleLinks ¶

func (e *Enforcer) EnableAutoBuildRoleLinks(autoBuildRoleLinks bool)

EnableAutoBuildRoleLinks controls whether to rebuild the role inheritance relations when a role is added or deleted.

func (*Enforcer) EnableAutoNotifyDispatcher ¶

func (e *Enforcer) EnableAutoNotifyDispatcher(enable bool)

EnableAutoNotifyDispatcher controls whether to save a policy rule automatically notify the Dispatcher when it is added or removed.

func (*Enforcer) EnableAutoNotifyWatcher ¶

func (e *Enforcer) EnableAutoNotifyWatcher(enable bool)

EnableAutoNotifyWatcher controls whether to save a policy rule automatically notify the Watcher when it is added or removed.

func (*Enforcer) EnableAutoSave ¶

func (e *Enforcer) EnableAutoSave(autoSave bool)

EnableAutoSave controls whether to save a policy rule automatically to the adapter when it is added or removed.

func (*Enforcer) EnableEnforce ¶

func (e *Enforcer) EnableEnforce(enable bool)

EnableEnforce changes the enforcing state of Casbin, when Casbin is disabled, all access will be allowed by the Enforce() function.

func (*Enforcer) Enforce ¶

func (e *Enforcer) Enforce(rvals ...interface{}) (bool, error)

Enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act).

func (*Enforcer) EnforceEx ¶

func (e *Enforcer) EnforceEx(rvals ...interface{}) (bool, []string, error)

EnforceEx explain enforcement by informing matched rules.

func (*Enforcer) EnforceExWithMatcher ¶

func (e *Enforcer) EnforceExWithMatcher(matcher string, rvals ...interface{}) (bool, []string, error)

EnforceExWithMatcher use a custom matcher and explain enforcement by informing matched rules.

func (*Enforcer) EnforceWithMatcher ¶

func (e *Enforcer) EnforceWithMatcher(matcher string, rvals ...interface{}) (bool, error)

EnforceWithMatcher use a custom matcher to decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (matcher, sub, obj, act), use model matcher by default when matcher is "".

func (*Enforcer) Explain ¶ added in v3.10.0

func (e *Enforcer) Explain(rvals ...interface{}) (string, error)

Explain returns an AI-generated explanation of why Enforce returned a particular result. It calls the configured OpenAI-compatible API to generate a natural language explanation.

func (*Enforcer) GetAdapter ¶

func (e *Enforcer) GetAdapter() persist.Adapter

GetAdapter gets the current adapter.

func (*Enforcer) GetAllActions ¶

func (e *Enforcer) GetAllActions() ([]string, error)

GetAllActions gets the list of actions that show up in the current policy.

func (*Enforcer) GetAllDomains ¶

func (e *Enforcer) GetAllDomains() ([]string, error)

GetAllDomains would get all domains.

func (*Enforcer) GetAllNamedActions ¶

func (e *Enforcer) GetAllNamedActions(ptype string) ([]string, error)

GetAllNamedActions gets the list of actions that show up in the current named policy.

func (*Enforcer) GetAllNamedObjects ¶

func (e *Enforcer) GetAllNamedObjects(ptype string) ([]string, error)

GetAllNamedObjects gets the list of objects that show up in the current named policy.

func (*Enforcer) GetAllNamedRoles ¶

func (e *Enforcer) GetAllNamedRoles(ptype string) ([]string, error)

GetAllNamedRoles gets the list of roles that show up in the current named policy.

func (*Enforcer) GetAllNamedSubjects ¶

func (e *Enforcer) GetAllNamedSubjects(ptype string) ([]string, error)

GetAllNamedSubjects gets the list of subjects that show up in the current named policy.

func (*Enforcer) GetAllObjects ¶

func (e *Enforcer) GetAllObjects() ([]string, error)

GetAllObjects gets the list of objects that show up in the current policy.

func (*Enforcer) GetAllRoles ¶

func (e *Enforcer) GetAllRoles() ([]string, error)

GetAllRoles gets the list of roles that show up in the current policy.

func (*Enforcer) GetAllRolesByDomain ¶

func (e *Enforcer) GetAllRolesByDomain(domain string) ([]string, error)

GetAllRolesByDomain would get all roles associated with the domain. note: Not applicable to Domains with inheritance relationship (implicit roles)

func (*Enforcer) GetAllSubjects ¶

func (e *Enforcer) GetAllSubjects() ([]string, error)

GetAllSubjects gets the list of subjects that show up in the current policy.

func (*Enforcer) GetAllUsers ¶ added in v3.8.0

func (e *Enforcer) GetAllUsers() ([]string, error)

GetAllUsers gets the list of users that show up in the current policy. Users are subjects that are not roles (i.e., subjects that do not appear as the second element in any grouping policy).

func (*Enforcer) GetAllUsersByDomain ¶

func (e *Enforcer) GetAllUsersByDomain(domain string) ([]string, error)

GetAllUsersByDomain would get all users associated with the domain.

func (*Enforcer) GetAllowedObjectConditions ¶

func (e *Enforcer) GetAllowedObjectConditions(user string, action string, prefix string) ([]string, error)

GetAllowedObjectConditions returns a string array of object conditions that the user can access. For example: conditions, err := e.GetAllowedObjectConditions("alice", "read", "r.obj.") Note:

0. prefix: You can customize the prefix of the object conditions, and "r.obj." is commonly used as a prefix. After removing the prefix, the remaining part is the condition of the object. If there is an obj policy that does not meet the prefix requirement, an errors.ERR_OBJ_CONDITION will be returned.

1. If the 'objectConditions' array is empty, return errors.ERR_EMPTY_CONDITION This error is returned because some data adapters' ORM return full table data by default when they receive an empty condition, which tends to behave contrary to expectations.(e.g. GORM) If you are using an adapter that does not behave like this, you can choose to ignore this error.

func (*Enforcer) GetDomainsForUser ¶

func (e *Enforcer) GetDomainsForUser(user string) ([]string, error)

GetDomainsForUser gets all domains.

func (*Enforcer) GetFieldIndex ¶

func (e *Enforcer) GetFieldIndex(ptype string, field string) (int, error)

func (*Enforcer) GetFilteredGroupingPolicy ¶

func (e *Enforcer) GetFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

func (*Enforcer) GetFilteredNamedGroupingPolicy ¶

func (e *Enforcer) GetFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredNamedGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

func (*Enforcer) GetFilteredNamedPolicy ¶

func (e *Enforcer) GetFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredNamedPolicy gets all the authorization rules in the named policy, field filters can be specified.

func (*Enforcer) GetFilteredNamedPolicyWithMatcher ¶

func (e *Enforcer) GetFilteredNamedPolicyWithMatcher(ptype string, matcher string) ([][]string, error)

GetFilteredNamedPolicyWithMatcher gets rules based on matcher from the policy.

func (*Enforcer) GetFilteredPolicy ¶

func (e *Enforcer) GetFilteredPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredPolicy gets all the authorization rules in the policy, field filters can be specified.

func (*Enforcer) GetGroupingPolicy ¶

func (e *Enforcer) GetGroupingPolicy() ([][]string, error)

GetGroupingPolicy gets all the role inheritance rules in the policy.

func (*Enforcer) GetImplicitObjectPatternsForUser ¶

func (e *Enforcer) GetImplicitObjectPatternsForUser(user string, domain string, action string) ([]string, error)

GetImplicitObjectPatternsForUser returns all object patterns (with wildcards) that a user has for a given domain and action. For example: p, admin, chronicle/123, location/*, read p, user, chronicle/456, location/789, read g, alice, admin g, bob, user

GetImplicitObjectPatternsForUser("alice", "chronicle/123", "read") will return ["location/*"]. GetImplicitObjectPatternsForUser("bob", "chronicle/456", "read") will return ["location/789"].

func (*Enforcer) GetImplicitPermissionsForUser ¶

func (e *Enforcer) GetImplicitPermissionsForUser(user string, domain ...string) ([][]string, error)

GetImplicitPermissionsForUser gets implicit permissions for a user or role. Compared to GetPermissionsForUser(), this function retrieves permissions for inherited roles. For example: p, admin, data1, read p, alice, data2, read g, alice, admin

GetPermissionsForUser("alice") can only get: [["alice", "data2", "read"]]. But GetImplicitPermissionsForUser("alice") will get: [["admin", "data1", "read"], ["alice", "data2", "read"]].

func (*Enforcer) GetImplicitResourcesForUser ¶

func (e *Enforcer) GetImplicitResourcesForUser(user string, domain ...string) ([][]string, error)

GetImplicitResourcesForUser returns all policies that user obtaining in domain.

func (*Enforcer) GetImplicitRolesForUser ¶

func (e *Enforcer) GetImplicitRolesForUser(name string, domain ...string) ([]string, error)

GetImplicitRolesForUser gets implicit roles that a user has. Compared to GetRolesForUser(), this function retrieves indirect roles besides direct roles. For example: g, alice, role:admin g, role:admin, role:user

GetRolesForUser("alice") can only get: ["role:admin"]. But GetImplicitRolesForUser("alice") will get: ["role:admin", "role:user"].

func (*Enforcer) GetImplicitUsersForPermission ¶

func (e *Enforcer) GetImplicitUsersForPermission(permission ...string) ([]string, error)

GetImplicitUsersForPermission gets implicit users for a permission. For example: p, admin, data1, read p, bob, data1, read g, alice, admin

GetImplicitUsersForPermission("data1", "read") will get: ["alice", "bob"]. Note: only users will be returned, roles (2nd arg in "g") will be excluded.

func (*Enforcer) GetImplicitUsersForResource ¶

func (e *Enforcer) GetImplicitUsersForResource(resource string) ([][]string, error)

GetImplicitUsersForResource return implicit user based on resource. for example: p, alice, data1, read p, bob, data2, write p, data2_admin, data2, read p, data2_admin, data2, write g, alice, data2_admin GetImplicitUsersForResource("data2") will return [[bob data2 write] [alice data2 read] [alice data2 write]] GetImplicitUsersForResource("data1") will return [[alice data1 read]] Note: only users will be returned, roles (2nd arg in "g") will be excluded.

func (*Enforcer) GetImplicitUsersForResourceByDomain ¶

func (e *Enforcer) GetImplicitUsersForResourceByDomain(resource string, domain string) ([][]string, error)

GetImplicitUsersForResourceByDomain return implicit user based on resource and domain. Compared to GetImplicitUsersForResource, domain is supported.

func (*Enforcer) GetImplicitUsersForRole ¶

func (e *Enforcer) GetImplicitUsersForRole(name string, domain ...string) ([]string, error)

GetImplicitUsersForRole gets implicit users for a role.

func (*Enforcer) GetModel ¶

func (e *Enforcer) GetModel() model.Model

GetModel gets the current model.

func (*Enforcer) GetNamedGroupingPolicy ¶

func (e *Enforcer) GetNamedGroupingPolicy(ptype string) ([][]string, error)

GetNamedGroupingPolicy gets all the role inheritance rules in the policy.

func (*Enforcer) GetNamedImplicitPermissionsForUser ¶

func (e *Enforcer) GetNamedImplicitPermissionsForUser(ptype string, gtype string, user string, domain ...string) ([][]string, error)

GetNamedImplicitPermissionsForUser gets implicit permissions for a user or role by named policy. Compared to GetNamedPermissionsForUser(), this function retrieves permissions for inherited roles. For example: p, admin, data1, read p2, admin, create g, alice, admin

GetImplicitPermissionsForUser("alice") can only get: [["admin", "data1", "read"]], whose policy is default policy "p" But you can specify the named policy "p2" to get: [["admin", "create"]] by GetNamedImplicitPermissionsForUser("p2","alice").

func (*Enforcer) GetNamedImplicitRolesForUser ¶

func (e *Enforcer) GetNamedImplicitRolesForUser(ptype string, name string, domain ...string) ([]string, error)

GetNamedImplicitRolesForUser gets implicit roles that a user has by named role definition. Compared to GetImplicitRolesForUser(), this function retrieves indirect roles besides direct roles. For example: g, alice, role:admin g, role:admin, role:user g2, alice, role:admin2

GetImplicitRolesForUser("alice") can only get: ["role:admin", "role:user"]. But GetNamedImplicitRolesForUser("g2", "alice") will get: ["role:admin2"].

func (*Enforcer) GetNamedImplicitUsersForResource ¶

func (e *Enforcer) GetNamedImplicitUsersForResource(ptype string, resource string) ([][]string, error)

GetNamedImplicitUsersForResource return implicit user based on resource with named policy support. This function handles resource role relationships through named policies (e.g., g2, g3, etc.). for example: p, admin_group, admin_data, * g, admin, admin_group g2, app, admin_data GetNamedImplicitUsersForResource("g2", "app") will return users who have access to admin_data through g2 relationship.

func (*Enforcer) GetNamedPermissionsForUser ¶

func (e *Enforcer) GetNamedPermissionsForUser(ptype string, user string, domain ...string) ([][]string, error)

GetNamedPermissionsForUser gets permissions for a user or role by named policy.

func (*Enforcer) GetNamedPolicy ¶

func (e *Enforcer) GetNamedPolicy(ptype string) ([][]string, error)

GetNamedPolicy gets all the authorization rules in the named policy.

func (*Enforcer) GetNamedRoleManager ¶

func (e *Enforcer) GetNamedRoleManager(ptype string) rbac.RoleManager

GetNamedRoleManager gets the role manager for the named policy.

func (*Enforcer) GetPermissionsForUser ¶

func (e *Enforcer) GetPermissionsForUser(user string, domain ...string) ([][]string, error)

GetPermissionsForUser gets permissions for a user or role.

func (*Enforcer) GetPermissionsForUserInDomain ¶

func (e *Enforcer) GetPermissionsForUserInDomain(user string, domain string) [][]string

GetPermissionsForUserInDomain gets permissions for a user or role inside a domain.

func (*Enforcer) GetPolicy ¶

func (e *Enforcer) GetPolicy() ([][]string, error)

GetPolicy gets all the authorization rules in the policy.

func (*Enforcer) GetRoleManager ¶

func (e *Enforcer) GetRoleManager() rbac.RoleManager

GetRoleManager gets the current role manager.

func (*Enforcer) GetRolesForUser ¶

func (e *Enforcer) GetRolesForUser(name string, domain ...string) ([]string, error)

GetRolesForUser gets the roles that a user has.

func (*Enforcer) GetRolesForUserInDomain ¶

func (e *Enforcer) GetRolesForUserInDomain(name string, domain string) []string

GetRolesForUserInDomain gets the roles that a user has inside a domain.

func (*Enforcer) GetUsersForRole ¶

func (e *Enforcer) GetUsersForRole(name string, domain ...string) ([]string, error)

GetUsersForRole gets the users that has a role.

func (*Enforcer) GetUsersForRoleInDomain ¶

func (e *Enforcer) GetUsersForRoleInDomain(name string, domain string) []string

GetUsersForRoleInDomain gets the users that has a role inside a domain. Add by Gordon.

func (*Enforcer) HasGroupingPolicy ¶

func (e *Enforcer) HasGroupingPolicy(params ...interface{}) (bool, error)

HasGroupingPolicy determines whether a role inheritance rule exists.

func (*Enforcer) HasNamedGroupingPolicy ¶

func (e *Enforcer) HasNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

HasNamedGroupingPolicy determines whether a named role inheritance rule exists.

func (*Enforcer) HasNamedPolicy ¶

func (e *Enforcer) HasNamedPolicy(ptype string, params ...interface{}) (bool, error)

HasNamedPolicy determines whether a named authorization rule exists.

func (*Enforcer) HasPermissionForUser ¶

func (e *Enforcer) HasPermissionForUser(user string, permission ...string) (bool, error)

HasPermissionForUser determines whether a user has a permission.

func (*Enforcer) HasPolicy ¶

func (e *Enforcer) HasPolicy(params ...interface{}) (bool, error)

HasPolicy determines whether an authorization rule exists.

func (*Enforcer) HasRoleForUser ¶

func (e *Enforcer) HasRoleForUser(name string, role string, domain ...string) (bool, error)

HasRoleForUser determines whether a user has a role.

func (*Enforcer) InitWithAdapter ¶

func (e *Enforcer) InitWithAdapter(modelPath string, adapter persist.Adapter) error

InitWithAdapter initializes an enforcer with a database adapter.

func (*Enforcer) InitWithFile ¶

func (e *Enforcer) InitWithFile(modelPath string, policyPath string) error

InitWithFile initializes an enforcer with a model file and a policy file.

func (*Enforcer) InitWithModelAndAdapter ¶

func (e *Enforcer) InitWithModelAndAdapter(m model.Model, adapter persist.Adapter) error

InitWithModelAndAdapter initializes an enforcer with a model and a database adapter.

func (*Enforcer) IsFiltered ¶

func (e *Enforcer) IsFiltered() bool

IsFiltered returns true if the loaded policy has been filtered.

func (*Enforcer) LoadFilteredPolicy ¶

func (e *Enforcer) LoadFilteredPolicy(filter interface{}) error

LoadFilteredPolicy reloads a filtered policy from file/database.

func (*Enforcer) LoadFilteredPolicyCtx ¶

func (e *Enforcer) LoadFilteredPolicyCtx(ctx context.Context, filter interface{}) error

LoadFilteredPolicyCtx loads all policy rules from the storage with context and filter.

func (*Enforcer) LoadIncrementalFilteredPolicy ¶

func (e *Enforcer) LoadIncrementalFilteredPolicy(filter interface{}) error

LoadIncrementalFilteredPolicy append a filtered policy from file/database.

func (*Enforcer) LoadIncrementalFilteredPolicyCtx ¶

func (e *Enforcer) LoadIncrementalFilteredPolicyCtx(ctx context.Context, filter interface{}) error

LoadIncrementalFilteredPolicyCtx append a filtered policy from file/database with context.

func (*Enforcer) LoadModel ¶

func (e *Enforcer) LoadModel() error

LoadModel reloads the model from the model CONF file. Because the policy is attached to a model, so the policy is invalidated and needs to be reloaded by calling LoadPolicy().

func (*Enforcer) LoadPolicy ¶

func (e *Enforcer) LoadPolicy() error

LoadPolicy reloads the policy from file/database.

func (*Enforcer) RemoveFilteredGroupingPolicy ¶

func (e *Enforcer) RemoveFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredGroupingPolicy removes a role inheritance rule from the current policy, field filters can be specified.

func (*Enforcer) RemoveFilteredNamedGroupingPolicy ¶

func (e *Enforcer) RemoveFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedGroupingPolicy removes a role inheritance rule from the current named policy, field filters can be specified.

func (*Enforcer) RemoveFilteredNamedPolicy ¶

func (e *Enforcer) RemoveFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedPolicy removes an authorization rule from the current named policy, field filters can be specified.

func (*Enforcer) RemoveFilteredPolicy ¶

func (e *Enforcer) RemoveFilteredPolicy(fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredPolicy removes an authorization rule from the current policy, field filters can be specified.

func (*Enforcer) RemoveGroupingPolicies ¶

func (e *Enforcer) RemoveGroupingPolicies(rules [][]string) (bool, error)

RemoveGroupingPolicies removes role inheritance rules from the current policy.

func (*Enforcer) RemoveGroupingPolicy ¶

func (e *Enforcer) RemoveGroupingPolicy(params ...interface{}) (bool, error)

RemoveGroupingPolicy removes a role inheritance rule from the current policy.

func (*Enforcer) RemoveNamedGroupingPolicies ¶

func (e *Enforcer) RemoveNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)

RemoveNamedGroupingPolicies removes role inheritance rules from the current named policy.

func (*Enforcer) RemoveNamedGroupingPolicy ¶

func (e *Enforcer) RemoveNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedGroupingPolicy removes a role inheritance rule from the current named policy.

func (*Enforcer) RemoveNamedPolicies ¶

func (e *Enforcer) RemoveNamedPolicies(ptype string, rules [][]string) (bool, error)

RemoveNamedPolicies removes authorization rules from the current named policy.

func (*Enforcer) RemoveNamedPolicy ¶

func (e *Enforcer) RemoveNamedPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedPolicy removes an authorization rule from the current named policy.

func (*Enforcer) RemovePolicies ¶

func (e *Enforcer) RemovePolicies(rules [][]string) (bool, error)

RemovePolicies removes authorization rules from the current policy.

func (*Enforcer) RemovePolicy ¶

func (e *Enforcer) RemovePolicy(params ...interface{}) (bool, error)

RemovePolicy removes an authorization rule from the current policy.

func (*Enforcer) RunDetections ¶ added in v3.9.0

func (e *Enforcer) RunDetections() error

RunDetections runs all detectors on all role managers. Returns the first error encountered, or nil if all checks pass. Silently skips role managers that don't support the required iteration methods.

func (*Enforcer) SavePolicy ¶

func (e *Enforcer) SavePolicy() error

SavePolicy saves the current policy (usually after changed with Casbin API) back to file/database.

func (*Enforcer) SelfAddPolicies ¶

func (e *Enforcer) SelfAddPolicies(sec string, ptype string, rules [][]string) (bool, error)

func (*Enforcer) SelfAddPoliciesEx ¶

func (e *Enforcer) SelfAddPoliciesEx(sec string, ptype string, rules [][]string) (bool, error)

func (*Enforcer) SelfAddPolicy ¶

func (e *Enforcer) SelfAddPolicy(sec string, ptype string, rule []string) (bool, error)

func (*Enforcer) SelfRemoveFilteredPolicy ¶

func (e *Enforcer) SelfRemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

func (*Enforcer) SelfRemovePolicies ¶

func (e *Enforcer) SelfRemovePolicies(sec string, ptype string, rules [][]string) (bool, error)

func (*Enforcer) SelfRemovePolicy ¶

func (e *Enforcer) SelfRemovePolicy(sec string, ptype string, rule []string) (bool, error)

func (*Enforcer) SelfUpdatePolicies ¶

func (e *Enforcer) SelfUpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) (bool, error)

func (*Enforcer) SelfUpdatePolicy ¶

func (e *Enforcer) SelfUpdatePolicy(sec string, ptype string, oldRule, newRule []string) (bool, error)

func (*Enforcer) SetAIConfig ¶ added in v3.10.0

func (e *Enforcer) SetAIConfig(config AIConfig)

SetAIConfig sets the configuration for AI API calls.

func (*Enforcer) SetAdapter ¶

func (e *Enforcer) SetAdapter(adapter persist.Adapter)

SetAdapter sets the current adapter.

func (*Enforcer) SetDetector ¶ added in v3.9.0

func (e *Enforcer) SetDetector(d detector.Detector)

SetDetector sets a single detector for the enforcer.

func (*Enforcer) SetDetectors ¶ added in v3.9.0

func (e *Enforcer) SetDetectors(detectors []detector.Detector)

SetDetectors sets multiple detectors for the enforcer.

func (*Enforcer) SetEffector ¶

func (e *Enforcer) SetEffector(eft effector.Effector)

SetEffector sets the current effector.

func (*Enforcer) SetFieldIndex ¶

func (e *Enforcer) SetFieldIndex(ptype string, field string, index int)

func (*Enforcer) SetLogger ¶

func (e *Enforcer) SetLogger(logger log.Logger)

SetLogger sets the logger for the enforcer.

func (*Enforcer) SetModel ¶

func (e *Enforcer) SetModel(m model.Model)

SetModel sets the current model.

func (*Enforcer) SetNamedDomainLinkConditionFuncParams ¶

func (e *Enforcer) SetNamedDomainLinkConditionFuncParams(ptype, user, role, domain string, params ...string) bool

SetNamedDomainLinkConditionFuncParams Sets the parameters of the condition function fn for Link userName->{roleName, domain}.

func (*Enforcer) SetNamedLinkConditionFuncParams ¶

func (e *Enforcer) SetNamedLinkConditionFuncParams(ptype, user, role string, params ...string) bool

SetNamedLinkConditionFuncParams Sets the parameters of the condition function fn for Link userName->roleName.

func (*Enforcer) SetNamedRoleManager ¶

func (e *Enforcer) SetNamedRoleManager(ptype string, rm rbac.RoleManager)

SetNamedRoleManager sets the role manager for the named policy.

func (*Enforcer) SetRoleManager ¶

func (e *Enforcer) SetRoleManager(rm rbac.RoleManager)

SetRoleManager sets the current role manager.

func (*Enforcer) SetWatcher ¶

func (e *Enforcer) SetWatcher(watcher persist.Watcher) error

SetWatcher sets the current watcher.

func (*Enforcer) UpdateFilteredNamedPolicies ¶

func (e *Enforcer) UpdateFilteredNamedPolicies(ptype string, newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

func (*Enforcer) UpdateFilteredPolicies ¶

func (e *Enforcer) UpdateFilteredPolicies(newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

func (*Enforcer) UpdateGroupingPolicies ¶

func (e *Enforcer) UpdateGroupingPolicies(oldRules [][]string, newRules [][]string) (bool, error)

UpdateGroupingPolicies updates authorization rules from the current policies.

func (*Enforcer) UpdateGroupingPolicy ¶

func (e *Enforcer) UpdateGroupingPolicy(oldRule []string, newRule []string) (bool, error)

func (*Enforcer) UpdateNamedGroupingPolicies ¶

func (e *Enforcer) UpdateNamedGroupingPolicies(ptype string, oldRules [][]string, newRules [][]string) (bool, error)

func (*Enforcer) UpdateNamedGroupingPolicy ¶

func (e *Enforcer) UpdateNamedGroupingPolicy(ptype string, oldRule []string, newRule []string) (bool, error)

func (*Enforcer) UpdateNamedPolicies ¶

func (e *Enforcer) UpdateNamedPolicies(ptype string, p1 [][]string, p2 [][]string) (bool, error)

func (*Enforcer) UpdateNamedPolicy ¶

func (e *Enforcer) UpdateNamedPolicy(ptype string, p1 []string, p2 []string) (bool, error)

func (*Enforcer) UpdatePolicies ¶

func (e *Enforcer) UpdatePolicies(oldPolices [][]string, newPolicies [][]string) (bool, error)

UpdatePolicies updates authorization rules from the current policies.

func (*Enforcer) UpdatePolicy ¶

func (e *Enforcer) UpdatePolicy(oldPolicy []string, newPolicy []string) (bool, error)

UpdatePolicy updates an authorization rule from the current policy.

type IDistributedEnforcer ¶

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)
}

IDistributedEnforcer defines dispatcher enforcer.

type IEnforcer ¶

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)
}

IEnforcer is the API interface of Enforcer.

type IEnforcerContext ¶

type IEnforcerContext interface {
	IEnforcer

	/* Enforcer API */
	LoadPolicyCtx(ctx context.Context) error
	LoadFilteredPolicyCtx(ctx context.Context, filter interface{}) error
	LoadIncrementalFilteredPolicyCtx(ctx context.Context, filter interface{}) error
	IsFilteredCtx(ctx context.Context) bool
	SavePolicyCtx(ctx context.Context) error

	/* RBAC API */
	AddRoleForUserCtx(ctx context.Context, user string, role string, domain ...string) (bool, error)
	AddPermissionForUserCtx(ctx context.Context, user string, permission ...string) (bool, error)
	AddPermissionsForUserCtx(ctx context.Context, user string, permissions ...[]string) (bool, error)
	DeletePermissionForUserCtx(ctx context.Context, user string, permission ...string) (bool, error)
	DeletePermissionsForUserCtx(ctx context.Context, user string) (bool, error)

	DeleteRoleForUserCtx(ctx context.Context, user string, role string, domain ...string) (bool, error)
	DeleteRolesForUserCtx(ctx context.Context, user string, domain ...string) (bool, error)
	DeleteUserCtx(ctx context.Context, user string) (bool, error)
	DeleteRoleCtx(ctx context.Context, role string) (bool, error)
	DeletePermissionCtx(ctx context.Context, permission ...string) (bool, error)

	/* RBAC API with domains*/
	AddRoleForUserInDomainCtx(ctx context.Context, user string, role string, domain string) (bool, error)
	DeleteRoleForUserInDomainCtx(ctx context.Context, user string, role string, domain string) (bool, error)
	DeleteRolesForUserInDomainCtx(ctx context.Context, user string, domain string) (bool, error)
	DeleteAllUsersByDomainCtx(ctx context.Context, domain string) (bool, error)
	DeleteDomainsCtx(ctx context.Context, domains ...string) (bool, error)

	/* Management API */
	AddPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)
	AddPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)
	AddNamedPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)
	AddNamedPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)
	AddPoliciesExCtx(ctx context.Context, rules [][]string) (bool, error)
	AddNamedPoliciesExCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

	RemovePolicyCtx(ctx context.Context, params ...interface{}) (bool, error)
	RemovePoliciesCtx(ctx context.Context, rules [][]string) (bool, error)
	RemoveFilteredPolicyCtx(ctx context.Context, fieldIndex int, fieldValues ...string) (bool, error)
	RemoveNamedPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)
	RemoveNamedPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)
	RemoveFilteredNamedPolicyCtx(ctx context.Context, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

	AddGroupingPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)
	AddGroupingPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)
	AddGroupingPoliciesExCtx(ctx context.Context, rules [][]string) (bool, error)
	AddNamedGroupingPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)
	AddNamedGroupingPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)
	AddNamedGroupingPoliciesExCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)

	RemoveGroupingPolicyCtx(ctx context.Context, params ...interface{}) (bool, error)
	RemoveGroupingPoliciesCtx(ctx context.Context, rules [][]string) (bool, error)
	RemoveFilteredGroupingPolicyCtx(ctx context.Context, fieldIndex int, fieldValues ...string) (bool, error)
	RemoveNamedGroupingPolicyCtx(ctx context.Context, ptype string, params ...interface{}) (bool, error)
	RemoveNamedGroupingPoliciesCtx(ctx context.Context, ptype string, rules [][]string) (bool, error)
	RemoveFilteredNamedGroupingPolicyCtx(ctx context.Context, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

	UpdatePolicyCtx(ctx context.Context, oldPolicy []string, newPolicy []string) (bool, error)
	UpdatePoliciesCtx(ctx context.Context, oldPolicies [][]string, newPolicies [][]string) (bool, error)
	UpdateFilteredPoliciesCtx(ctx context.Context, newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

	UpdateGroupingPolicyCtx(ctx context.Context, oldRule []string, newRule []string) (bool, error)
	UpdateGroupingPoliciesCtx(ctx context.Context, oldRules [][]string, newRules [][]string) (bool, error)
	UpdateNamedGroupingPolicyCtx(ctx context.Context, ptype string, oldRule []string, newRule []string) (bool, error)
	UpdateNamedGroupingPoliciesCtx(ctx context.Context, ptype string, oldRules [][]string, newRules [][]string) (bool, error)

	/* Management API with autoNotifyWatcher disabled */
	SelfAddPolicyCtx(ctx context.Context, sec string, ptype string, rule []string) (bool, error)
	SelfAddPoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)
	SelfAddPoliciesExCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)
	SelfRemovePolicyCtx(ctx context.Context, sec string, ptype string, rule []string) (bool, error)
	SelfRemovePoliciesCtx(ctx context.Context, sec string, ptype string, rules [][]string) (bool, error)
	SelfRemoveFilteredPolicyCtx(ctx context.Context, sec string, ptype string, fieldIndex int, fieldValues ...string) (bool, error)
	SelfUpdatePolicyCtx(ctx context.Context, sec string, ptype string, oldRule, newRule []string) (bool, error)
	SelfUpdatePoliciesCtx(ctx context.Context, sec string, ptype string, oldRules, newRules [][]string) (bool, error)
}

func NewContextEnforcer ¶

func NewContextEnforcer(params ...interface{}) (IEnforcerContext, error)

NewContextEnforcer creates a context-aware enforcer via file or DB.

type SyncedCachedEnforcer ¶

type SyncedCachedEnforcer struct {
	*SyncedEnforcer
	// contains filtered or unexported fields
}

SyncedCachedEnforcer wraps Enforcer and provides decision sync cache.

func NewSyncedCachedEnforcer ¶

func NewSyncedCachedEnforcer(params ...interface{}) (*SyncedCachedEnforcer, error)

NewSyncedCachedEnforcer creates a sync cached enforcer via file or DB.

func (*SyncedCachedEnforcer) AddPolicies ¶

func (e *SyncedCachedEnforcer) AddPolicies(rules [][]string) (bool, error)

func (*SyncedCachedEnforcer) AddPolicy ¶

func (e *SyncedCachedEnforcer) AddPolicy(params ...interface{}) (bool, error)

func (*SyncedCachedEnforcer) EnableCache ¶

func (e *SyncedCachedEnforcer) EnableCache(enableCache bool)

EnableCache determines whether to enable cache on Enforce(). When enableCache is enabled, cached result (true | false) will be returned for previous decisions.

func (*SyncedCachedEnforcer) Enforce ¶

func (e *SyncedCachedEnforcer) Enforce(rvals ...interface{}) (bool, error)

Enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act). if rvals is not string , ignore the cache.

func (*SyncedCachedEnforcer) InvalidateCache ¶

func (e *SyncedCachedEnforcer) InvalidateCache() error

InvalidateCache deletes all the existing cached decisions.

func (*SyncedCachedEnforcer) LoadPolicy ¶

func (e *SyncedCachedEnforcer) LoadPolicy() error

func (*SyncedCachedEnforcer) RemovePolicies ¶

func (e *SyncedCachedEnforcer) RemovePolicies(rules [][]string) (bool, error)

func (*SyncedCachedEnforcer) RemovePolicy ¶

func (e *SyncedCachedEnforcer) RemovePolicy(params ...interface{}) (bool, error)

func (*SyncedCachedEnforcer) SetCache ¶

func (e *SyncedCachedEnforcer) SetCache(c cache.Cache)

SetCache need to be sync cache.

func (*SyncedCachedEnforcer) SetExpireTime ¶

func (e *SyncedCachedEnforcer) SetExpireTime(expireTime time.Duration)

type SyncedEnforcer ¶

type SyncedEnforcer struct {
	*Enforcer
	// contains filtered or unexported fields
}

SyncedEnforcer wraps Enforcer and provides synchronized access.

func NewSyncedEnforcer ¶

func NewSyncedEnforcer(params ...interface{}) (*SyncedEnforcer, error)

NewSyncedEnforcer creates a synchronized enforcer via file or DB.

func (*SyncedEnforcer) AddFunction ¶

func (e *SyncedEnforcer) AddFunction(name string, function govaluate.ExpressionFunction)

AddFunction adds a customized function.

func (*SyncedEnforcer) AddGroupingPolicies ¶

func (e *SyncedEnforcer) AddGroupingPolicies(rules [][]string) (bool, error)

AddGroupingPolicies adds role inheritance rulea to the current policy. If the rule already exists, the function returns false for the corresponding policy rule and the rule will not be added. Otherwise the function returns true for the corresponding policy rule by adding the new rule.

func (*SyncedEnforcer) AddGroupingPoliciesEx ¶

func (e *SyncedEnforcer) AddGroupingPoliciesEx(rules [][]string) (bool, error)

AddGroupingPoliciesEx adds role inheritance rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddGroupingPolicies, other non-existent rules are added instead of returning false directly.

func (*SyncedEnforcer) AddGroupingPolicy ¶

func (e *SyncedEnforcer) AddGroupingPolicy(params ...interface{}) (bool, error)

AddGroupingPolicy adds a role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*SyncedEnforcer) AddNamedGroupingPolicies ¶

func (e *SyncedEnforcer) AddNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)

AddNamedGroupingPolicies adds named role inheritance rules to the current policy. If the rule already exists, the function returns false for the corresponding policy rule and the rule will not be added. Otherwise the function returns true for the corresponding policy rule by adding the new rule.

func (*SyncedEnforcer) AddNamedGroupingPoliciesEx ¶

func (e *SyncedEnforcer) AddNamedGroupingPoliciesEx(ptype string, rules [][]string) (bool, error)

AddNamedGroupingPoliciesEx adds named role inheritance rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddNamedGroupingPolicies, other non-existent rules are added instead of returning false directly.

func (*SyncedEnforcer) AddNamedGroupingPolicy ¶

func (e *SyncedEnforcer) AddNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedGroupingPolicy adds a named role inheritance rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*SyncedEnforcer) AddNamedPolicies ¶

func (e *SyncedEnforcer) AddNamedPolicies(ptype string, rules [][]string) (bool, error)

AddNamedPolicies adds authorization rules to the current named policy. If the rule already exists, the function returns false for the corresponding rule and the rule will not be added. Otherwise the function returns true for the corresponding by adding the new rule.

func (*SyncedEnforcer) AddNamedPoliciesEx ¶

func (e *SyncedEnforcer) AddNamedPoliciesEx(ptype string, rules [][]string) (bool, error)

AddNamedPoliciesEx adds authorization rules to the current named policy. If the rule already exists, the rule will not be added. But unlike AddNamedPolicies, other non-existent rules are added instead of returning false directly.

func (*SyncedEnforcer) AddNamedPolicy ¶

func (e *SyncedEnforcer) AddNamedPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedPolicy adds an authorization rule to the current named policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*SyncedEnforcer) AddPermissionForUser ¶

func (e *SyncedEnforcer) AddPermissionForUser(user string, permission ...string) (bool, error)

AddPermissionForUser adds a permission for a user or role. Returns false if the user or role already has the permission (aka not affected).

func (*SyncedEnforcer) AddPermissionsForUser ¶

func (e *SyncedEnforcer) AddPermissionsForUser(user string, permissions ...[]string) (bool, error)

AddPermissionsForUser adds permissions for a user or role. Returns false if the user or role already has the permissions (aka not affected).

func (*SyncedEnforcer) AddPolicies ¶

func (e *SyncedEnforcer) AddPolicies(rules [][]string) (bool, error)

AddPolicies adds authorization rules to the current policy. If the rule already exists, the function returns false for the corresponding rule and the rule will not be added. Otherwise the function returns true for the corresponding rule by adding the new rule.

func (*SyncedEnforcer) AddPoliciesEx ¶

func (e *SyncedEnforcer) AddPoliciesEx(rules [][]string) (bool, error)

AddPoliciesEx adds authorization rules to the current policy. If the rule already exists, the rule will not be added. But unlike AddPolicies, other non-existent rules are added instead of returning false directly.

func (*SyncedEnforcer) AddPolicy ¶

func (e *SyncedEnforcer) AddPolicy(params ...interface{}) (bool, error)

AddPolicy adds an authorization rule to the current policy. If the rule already exists, the function returns false and the rule will not be added. Otherwise the function returns true by adding the new rule.

func (*SyncedEnforcer) AddRoleForUser ¶

func (e *SyncedEnforcer) AddRoleForUser(user string, role string, domain ...string) (bool, error)

AddRoleForUser adds a role for a user. Returns false if the user already has the role (aka not affected).

func (*SyncedEnforcer) AddRoleForUserInDomain ¶

func (e *SyncedEnforcer) AddRoleForUserInDomain(user string, role string, domain string) (bool, error)

AddRoleForUserInDomain adds a role for a user inside a domain. Returns false if the user already has the role (aka not affected).

func (*SyncedEnforcer) AddRolesForUser ¶

func (e *SyncedEnforcer) AddRolesForUser(user string, roles []string, domain ...string) (bool, error)

AddRolesForUser adds roles for a user. Returns false if the user already has the roles (aka not affected).

func (*SyncedEnforcer) BatchEnforce ¶

func (e *SyncedEnforcer) BatchEnforce(requests [][]interface{}) ([]bool, error)

BatchEnforce enforce in batches.

func (*SyncedEnforcer) BatchEnforceWithMatcher ¶

func (e *SyncedEnforcer) BatchEnforceWithMatcher(matcher string, requests [][]interface{}) ([]bool, error)

BatchEnforceWithMatcher enforce with matcher in batches.

func (*SyncedEnforcer) BuildRoleLinks ¶

func (e *SyncedEnforcer) BuildRoleLinks() error

BuildRoleLinks manually rebuild the role inheritance relations.

func (*SyncedEnforcer) ClearPolicy ¶

func (e *SyncedEnforcer) ClearPolicy()

ClearPolicy clears all policy.

func (*SyncedEnforcer) DeleteDomains ¶

func (e *SyncedEnforcer) DeleteDomains(domains ...string) (bool, error)

DeleteDomains deletes domains from the model. Returns false if the domain does not exist (aka not affected).

func (*SyncedEnforcer) DeletePermission ¶

func (e *SyncedEnforcer) DeletePermission(permission ...string) (bool, error)

DeletePermission deletes a permission. Returns false if the permission does not exist (aka not affected).

func (*SyncedEnforcer) DeletePermissionForUser ¶

func (e *SyncedEnforcer) DeletePermissionForUser(user string, permission ...string) (bool, error)

DeletePermissionForUser deletes a permission for a user or role. Returns false if the user or role does not have the permission (aka not affected).

func (*SyncedEnforcer) DeletePermissionsForUser ¶

func (e *SyncedEnforcer) DeletePermissionsForUser(user string) (bool, error)

DeletePermissionsForUser deletes permissions for a user or role. Returns false if the user or role does not have any permissions (aka not affected).

func (*SyncedEnforcer) DeleteRole ¶

func (e *SyncedEnforcer) DeleteRole(role string) (bool, error)

DeleteRole deletes a role. Returns false if the role does not exist (aka not affected).

func (*SyncedEnforcer) DeleteRoleForUser ¶

func (e *SyncedEnforcer) DeleteRoleForUser(user string, role string, domain ...string) (bool, error)

DeleteRoleForUser deletes a role for a user. Returns false if the user does not have the role (aka not affected).

func (*SyncedEnforcer) DeleteRoleForUserInDomain ¶

func (e *SyncedEnforcer) DeleteRoleForUserInDomain(user string, role string, domain string) (bool, error)

DeleteRoleForUserInDomain deletes a role for a user inside a domain. Returns false if the user does not have the role (aka not affected).

func (*SyncedEnforcer) DeleteRolesForUser ¶

func (e *SyncedEnforcer) DeleteRolesForUser(user string, domain ...string) (bool, error)

DeleteRolesForUser deletes all roles for a user. Returns false if the user does not have any roles (aka not affected).

func (*SyncedEnforcer) DeleteRolesForUserInDomain ¶

func (e *SyncedEnforcer) DeleteRolesForUserInDomain(user string, domain string) (bool, error)

DeleteRolesForUserInDomain deletes all roles for a user inside a domain. Returns false if the user does not have any roles (aka not affected).

func (*SyncedEnforcer) DeleteUser ¶

func (e *SyncedEnforcer) DeleteUser(user string) (bool, error)

DeleteUser deletes a user. Returns false if the user does not exist (aka not affected).

func (*SyncedEnforcer) Enforce ¶

func (e *SyncedEnforcer) Enforce(rvals ...interface{}) (bool, error)

Enforce decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (sub, obj, act).

func (*SyncedEnforcer) EnforceEx ¶

func (e *SyncedEnforcer) EnforceEx(rvals ...interface{}) (bool, []string, error)

EnforceEx explain enforcement by informing matched rules.

func (*SyncedEnforcer) EnforceExWithMatcher ¶

func (e *SyncedEnforcer) EnforceExWithMatcher(matcher string, rvals ...interface{}) (bool, []string, error)

EnforceExWithMatcher use a custom matcher and explain enforcement by informing matched rules.

func (*SyncedEnforcer) EnforceWithMatcher ¶

func (e *SyncedEnforcer) EnforceWithMatcher(matcher string, rvals ...interface{}) (bool, error)

EnforceWithMatcher use a custom matcher to decides whether a "subject" can access a "object" with the operation "action", input parameters are usually: (matcher, sub, obj, act), use model matcher by default when matcher is "".

func (*SyncedEnforcer) GetAllActions ¶

func (e *SyncedEnforcer) GetAllActions() ([]string, error)

GetAllActions gets the list of actions that show up in the current policy.

func (*SyncedEnforcer) GetAllNamedActions ¶

func (e *SyncedEnforcer) GetAllNamedActions(ptype string) ([]string, error)

GetAllNamedActions gets the list of actions that show up in the current named policy.

func (*SyncedEnforcer) GetAllNamedObjects ¶

func (e *SyncedEnforcer) GetAllNamedObjects(ptype string) ([]string, error)

GetAllNamedObjects gets the list of objects that show up in the current named policy.

func (*SyncedEnforcer) GetAllNamedRoles ¶

func (e *SyncedEnforcer) GetAllNamedRoles(ptype string) ([]string, error)

GetAllNamedRoles gets the list of roles that show up in the current named policy.

func (*SyncedEnforcer) GetAllNamedSubjects ¶

func (e *SyncedEnforcer) GetAllNamedSubjects(ptype string) ([]string, error)

GetAllNamedSubjects gets the list of subjects that show up in the current named policy.

func (*SyncedEnforcer) GetAllObjects ¶

func (e *SyncedEnforcer) GetAllObjects() ([]string, error)

GetAllObjects gets the list of objects that show up in the current policy.

func (*SyncedEnforcer) GetAllRoles ¶

func (e *SyncedEnforcer) GetAllRoles() ([]string, error)

GetAllRoles gets the list of roles that show up in the current policy.

func (*SyncedEnforcer) GetAllSubjects ¶

func (e *SyncedEnforcer) GetAllSubjects() ([]string, error)

GetAllSubjects gets the list of subjects that show up in the current policy.

func (*SyncedEnforcer) GetAllUsers ¶ added in v3.8.0

func (e *SyncedEnforcer) GetAllUsers() ([]string, error)

GetAllUsers gets the list of users that show up in the current policy.

func (*SyncedEnforcer) GetFilteredGroupingPolicy ¶

func (e *SyncedEnforcer) GetFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

func (*SyncedEnforcer) GetFilteredNamedGroupingPolicy ¶

func (e *SyncedEnforcer) GetFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredNamedGroupingPolicy gets all the role inheritance rules in the policy, field filters can be specified.

func (*SyncedEnforcer) GetFilteredNamedPolicy ¶

func (e *SyncedEnforcer) GetFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredNamedPolicy gets all the authorization rules in the named policy, field filters can be specified.

func (*SyncedEnforcer) GetFilteredPolicy ¶

func (e *SyncedEnforcer) GetFilteredPolicy(fieldIndex int, fieldValues ...string) ([][]string, error)

GetFilteredPolicy gets all the authorization rules in the policy, field filters can be specified.

func (*SyncedEnforcer) GetGroupingPolicy ¶

func (e *SyncedEnforcer) GetGroupingPolicy() ([][]string, error)

GetGroupingPolicy gets all the role inheritance rules in the policy.

func (*SyncedEnforcer) GetImplicitObjectPatternsForUser ¶

func (e *SyncedEnforcer) GetImplicitObjectPatternsForUser(user string, domain string, action string) ([]string, error)

GetImplicitObjectPatternsForUser returns all object patterns (with wildcards) that a user has for a given domain and action. For example: p, admin, chronicle/123, location/*, read p, user, chronicle/456, location/789, read g, alice, admin g, bob, user

GetImplicitObjectPatternsForUser("alice", "chronicle/123", "read") will return ["location/*"]. GetImplicitObjectPatternsForUser("bob", "chronicle/456", "read") will return ["location/789"].

func (*SyncedEnforcer) GetImplicitPermissionsForUser ¶

func (e *SyncedEnforcer) GetImplicitPermissionsForUser(user string, domain ...string) ([][]string, error)

GetImplicitPermissionsForUser gets implicit permissions for a user or role. Compared to GetPermissionsForUser(), this function retrieves permissions for inherited roles. For example: p, admin, data1, read p, alice, data2, read g, alice, admin

GetPermissionsForUser("alice") can only get: [["alice", "data2", "read"]]. But GetImplicitPermissionsForUser("alice") will get: [["admin", "data1", "read"], ["alice", "data2", "read"]].

func (*SyncedEnforcer) GetImplicitRolesForUser ¶

func (e *SyncedEnforcer) GetImplicitRolesForUser(name string, domain ...string) ([]string, error)

GetImplicitRolesForUser gets implicit roles that a user has. Compared to GetRolesForUser(), this function retrieves indirect roles besides direct roles. For example: g, alice, role:admin g, role:admin, role:user

GetRolesForUser("alice") can only get: ["role:admin"]. But GetImplicitRolesForUser("alice") will get: ["role:admin", "role:user"].

func (*SyncedEnforcer) GetImplicitUsersForPermission ¶

func (e *SyncedEnforcer) GetImplicitUsersForPermission(permission ...string) ([]string, error)

GetImplicitUsersForPermission gets implicit users for a permission. For example: p, admin, data1, read p, bob, data1, read g, alice, admin

GetImplicitUsersForPermission("data1", "read") will get: ["alice", "bob"]. Note: only users will be returned, roles (2nd arg in "g") will be excluded.

func (*SyncedEnforcer) GetLock ¶

func (e *SyncedEnforcer) GetLock() *sync.RWMutex

GetLock return the private RWMutex lock.

func (*SyncedEnforcer) GetNamedGroupingPolicy ¶

func (e *SyncedEnforcer) GetNamedGroupingPolicy(ptype string) ([][]string, error)

GetNamedGroupingPolicy gets all the role inheritance rules in the policy.

func (*SyncedEnforcer) GetNamedImplicitPermissionsForUser ¶

func (e *SyncedEnforcer) GetNamedImplicitPermissionsForUser(ptype string, gtype string, user string, domain ...string) ([][]string, error)

GetNamedImplicitPermissionsForUser gets implicit permissions for a user or role by named policy. Compared to GetNamedPermissionsForUser(), this function retrieves permissions for inherited roles. For example: p, admin, data1, read p2, admin, create g, alice, admin

GetImplicitPermissionsForUser("alice") can only get: [["admin", "data1", "read"]], whose policy is default policy "p" But you can specify the named policy "p2" to get: [["admin", "create"]] by GetNamedImplicitPermissionsForUser("p2","alice").

func (*SyncedEnforcer) GetNamedPermissionsForUser ¶

func (e *SyncedEnforcer) GetNamedPermissionsForUser(ptype string, user string, domain ...string) ([][]string, error)

GetNamedPermissionsForUser gets permissions for a user or role by named policy.

func (*SyncedEnforcer) GetNamedPolicy ¶

func (e *SyncedEnforcer) GetNamedPolicy(ptype string) ([][]string, error)

GetNamedPolicy gets all the authorization rules in the named policy.

func (*SyncedEnforcer) GetNamedRoleManager ¶

func (e *SyncedEnforcer) GetNamedRoleManager(ptype string) rbac.RoleManager

GetNamedRoleManager gets the role manager for the named policy with synchronization.

func (*SyncedEnforcer) GetPermissionsForUser ¶

func (e *SyncedEnforcer) GetPermissionsForUser(user string, domain ...string) ([][]string, error)

GetPermissionsForUser gets permissions for a user or role.

func (*SyncedEnforcer) GetPermissionsForUserInDomain ¶

func (e *SyncedEnforcer) GetPermissionsForUserInDomain(user string, domain string) [][]string

GetPermissionsForUserInDomain gets permissions for a user or role inside a domain.

func (*SyncedEnforcer) GetPolicy ¶

func (e *SyncedEnforcer) GetPolicy() ([][]string, error)

GetPolicy gets all the authorization rules in the policy.

func (*SyncedEnforcer) GetRoleManager ¶

func (e *SyncedEnforcer) GetRoleManager() rbac.RoleManager

GetRoleManager gets the current role manager with synchronization.

func (*SyncedEnforcer) GetRolesForUser ¶

func (e *SyncedEnforcer) GetRolesForUser(name string, domain ...string) ([]string, error)

GetRolesForUser gets the roles that a user has.

func (*SyncedEnforcer) GetRolesForUserInDomain ¶

func (e *SyncedEnforcer) GetRolesForUserInDomain(name string, domain string) []string

GetRolesForUserInDomain gets the roles that a user has inside a domain.

func (*SyncedEnforcer) GetUsersForRole ¶

func (e *SyncedEnforcer) GetUsersForRole(name string, domain ...string) ([]string, error)

GetUsersForRole gets the users that has a role.

func (*SyncedEnforcer) GetUsersForRoleInDomain ¶

func (e *SyncedEnforcer) GetUsersForRoleInDomain(name string, domain string) []string

GetUsersForRoleInDomain gets the users that has a role inside a domain. Add by Gordon.

func (*SyncedEnforcer) HasGroupingPolicy ¶

func (e *SyncedEnforcer) HasGroupingPolicy(params ...interface{}) (bool, error)

HasGroupingPolicy determines whether a role inheritance rule exists.

func (*SyncedEnforcer) HasNamedGroupingPolicy ¶

func (e *SyncedEnforcer) HasNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

HasNamedGroupingPolicy determines whether a named role inheritance rule exists.

func (*SyncedEnforcer) HasNamedPolicy ¶

func (e *SyncedEnforcer) HasNamedPolicy(ptype string, params ...interface{}) (bool, error)

HasNamedPolicy determines whether a named authorization rule exists.

func (*SyncedEnforcer) HasPermissionForUser ¶

func (e *SyncedEnforcer) HasPermissionForUser(user string, permission ...string) (bool, error)

HasPermissionForUser determines whether a user has a permission.

func (*SyncedEnforcer) HasPolicy ¶

func (e *SyncedEnforcer) HasPolicy(params ...interface{}) (bool, error)

HasPolicy determines whether an authorization rule exists.

func (*SyncedEnforcer) HasRoleForUser ¶

func (e *SyncedEnforcer) HasRoleForUser(name string, role string, domain ...string) (bool, error)

HasRoleForUser determines whether a user has a role.

func (*SyncedEnforcer) IsAutoLoadingRunning ¶

func (e *SyncedEnforcer) IsAutoLoadingRunning() bool

IsAutoLoadingRunning check if SyncedEnforcer is auto loading policies.

func (*SyncedEnforcer) LoadFilteredPolicy ¶

func (e *SyncedEnforcer) LoadFilteredPolicy(filter interface{}) error

LoadFilteredPolicy reloads a filtered policy from file/database.

func (*SyncedEnforcer) LoadIncrementalFilteredPolicy ¶

func (e *SyncedEnforcer) LoadIncrementalFilteredPolicy(filter interface{}) error

LoadIncrementalFilteredPolicy reloads a filtered policy from file/database.

func (*SyncedEnforcer) LoadModel ¶

func (e *SyncedEnforcer) LoadModel() error

LoadModel reloads the model from the model CONF file.

func (*SyncedEnforcer) LoadPolicy ¶

func (e *SyncedEnforcer) LoadPolicy() error

LoadPolicy reloads the policy from file/database.

func (*SyncedEnforcer) RemoveFilteredGroupingPolicy ¶

func (e *SyncedEnforcer) RemoveFilteredGroupingPolicy(fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredGroupingPolicy removes a role inheritance rule from the current policy, field filters can be specified.

func (*SyncedEnforcer) RemoveFilteredNamedGroupingPolicy ¶

func (e *SyncedEnforcer) RemoveFilteredNamedGroupingPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedGroupingPolicy removes a role inheritance rule from the current named policy, field filters can be specified.

func (*SyncedEnforcer) RemoveFilteredNamedPolicy ¶

func (e *SyncedEnforcer) RemoveFilteredNamedPolicy(ptype string, fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredNamedPolicy removes an authorization rule from the current named policy, field filters can be specified.

func (*SyncedEnforcer) RemoveFilteredPolicy ¶

func (e *SyncedEnforcer) RemoveFilteredPolicy(fieldIndex int, fieldValues ...string) (bool, error)

RemoveFilteredPolicy removes an authorization rule from the current policy, field filters can be specified.

func (*SyncedEnforcer) RemoveGroupingPolicies ¶

func (e *SyncedEnforcer) RemoveGroupingPolicies(rules [][]string) (bool, error)

RemoveGroupingPolicies removes role inheritance rules from the current policy.

func (*SyncedEnforcer) RemoveGroupingPolicy ¶

func (e *SyncedEnforcer) RemoveGroupingPolicy(params ...interface{}) (bool, error)

RemoveGroupingPolicy removes a role inheritance rule from the current policy.

func (*SyncedEnforcer) RemoveNamedGroupingPolicies ¶

func (e *SyncedEnforcer) RemoveNamedGroupingPolicies(ptype string, rules [][]string) (bool, error)

RemoveNamedGroupingPolicies removes role inheritance rules from the current named policy.

func (*SyncedEnforcer) RemoveNamedGroupingPolicy ¶

func (e *SyncedEnforcer) RemoveNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedGroupingPolicy removes a role inheritance rule from the current named policy.

func (*SyncedEnforcer) RemoveNamedPolicies ¶

func (e *SyncedEnforcer) RemoveNamedPolicies(ptype string, rules [][]string) (bool, error)

RemoveNamedPolicies removes authorization rules from the current named policy.

func (*SyncedEnforcer) RemoveNamedPolicy ¶

func (e *SyncedEnforcer) RemoveNamedPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedPolicy removes an authorization rule from the current named policy.

func (*SyncedEnforcer) RemovePolicies ¶

func (e *SyncedEnforcer) RemovePolicies(rules [][]string) (bool, error)

RemovePolicies removes authorization rules from the current policy.

func (*SyncedEnforcer) RemovePolicy ¶

func (e *SyncedEnforcer) RemovePolicy(params ...interface{}) (bool, error)

RemovePolicy removes an authorization rule from the current policy.

func (*SyncedEnforcer) SavePolicy ¶

func (e *SyncedEnforcer) SavePolicy() error

SavePolicy saves the current policy (usually after changed with Casbin API) back to file/database.

func (*SyncedEnforcer) SelfAddPolicies ¶

func (e *SyncedEnforcer) SelfAddPolicies(sec string, ptype string, rules [][]string) (bool, error)

func (*SyncedEnforcer) SelfAddPoliciesEx ¶

func (e *SyncedEnforcer) SelfAddPoliciesEx(sec string, ptype string, rules [][]string) (bool, error)

func (*SyncedEnforcer) SelfAddPolicy ¶

func (e *SyncedEnforcer) SelfAddPolicy(sec string, ptype string, rule []string) (bool, error)

func (*SyncedEnforcer) SelfRemoveFilteredPolicy ¶

func (e *SyncedEnforcer) SelfRemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) (bool, error)

func (*SyncedEnforcer) SelfRemovePolicies ¶

func (e *SyncedEnforcer) SelfRemovePolicies(sec string, ptype string, rules [][]string) (bool, error)

func (*SyncedEnforcer) SelfRemovePolicy ¶

func (e *SyncedEnforcer) SelfRemovePolicy(sec string, ptype string, rule []string) (bool, error)

func (*SyncedEnforcer) SelfUpdatePolicies ¶

func (e *SyncedEnforcer) SelfUpdatePolicies(sec string, ptype string, oldRules, newRules [][]string) (bool, error)

func (*SyncedEnforcer) SelfUpdatePolicy ¶

func (e *SyncedEnforcer) SelfUpdatePolicy(sec string, ptype string, oldRule, newRule []string) (bool, error)

func (*SyncedEnforcer) SetNamedRoleManager ¶

func (e *SyncedEnforcer) SetNamedRoleManager(ptype string, rm rbac.RoleManager)

SetNamedRoleManager sets the role manager for the named policy with synchronization.

func (*SyncedEnforcer) SetRoleManager ¶

func (e *SyncedEnforcer) SetRoleManager(rm rbac.RoleManager)

SetRoleManager sets the current role manager with synchronization.

func (*SyncedEnforcer) SetWatcher ¶

func (e *SyncedEnforcer) SetWatcher(watcher persist.Watcher) error

SetWatcher sets the current watcher.

func (*SyncedEnforcer) StartAutoLoadPolicy ¶

func (e *SyncedEnforcer) StartAutoLoadPolicy(d time.Duration)

StartAutoLoadPolicy starts a go routine that will every specified duration call LoadPolicy.

func (*SyncedEnforcer) StopAutoLoadPolicy ¶

func (e *SyncedEnforcer) StopAutoLoadPolicy()

StopAutoLoadPolicy causes the go routine to exit.

func (*SyncedEnforcer) UpdateFilteredNamedPolicies ¶

func (e *SyncedEnforcer) UpdateFilteredNamedPolicies(ptype string, newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

func (*SyncedEnforcer) UpdateFilteredPolicies ¶

func (e *SyncedEnforcer) UpdateFilteredPolicies(newPolicies [][]string, fieldIndex int, fieldValues ...string) (bool, error)

func (*SyncedEnforcer) UpdateGroupingPolicies ¶

func (e *SyncedEnforcer) UpdateGroupingPolicies(oldRules [][]string, newRules [][]string) (bool, error)

func (*SyncedEnforcer) UpdateGroupingPolicy ¶

func (e *SyncedEnforcer) UpdateGroupingPolicy(oldRule []string, newRule []string) (bool, error)

func (*SyncedEnforcer) UpdateNamedGroupingPolicies ¶

func (e *SyncedEnforcer) UpdateNamedGroupingPolicies(ptype string, oldRules [][]string, newRules [][]string) (bool, error)

func (*SyncedEnforcer) UpdateNamedGroupingPolicy ¶

func (e *SyncedEnforcer) UpdateNamedGroupingPolicy(ptype string, oldRule []string, newRule []string) (bool, error)

func (*SyncedEnforcer) UpdateNamedPolicies ¶

func (e *SyncedEnforcer) UpdateNamedPolicies(ptype string, p1 [][]string, p2 [][]string) (bool, error)

func (*SyncedEnforcer) UpdateNamedPolicy ¶

func (e *SyncedEnforcer) UpdateNamedPolicy(ptype string, p1 []string, p2 []string) (bool, error)

func (*SyncedEnforcer) UpdatePolicies ¶

func (e *SyncedEnforcer) UpdatePolicies(oldPolices [][]string, newPolicies [][]string) (bool, error)

UpdatePolicies updates authorization rules from the current policies.

func (*SyncedEnforcer) UpdatePolicy ¶

func (e *SyncedEnforcer) UpdatePolicy(oldPolicy []string, newPolicy []string) (bool, error)

UpdatePolicy updates an authorization rule from the current policy.

type Transaction ¶

type Transaction struct {
	// contains filtered or unexported fields
}

Transaction represents a Casbin transaction. It provides methods to perform policy operations within a transaction. and commit or rollback all changes atomically.

func (*Transaction) AddGroupingPolicy ¶

func (tx *Transaction) AddGroupingPolicy(params ...interface{}) (bool, error)

AddGroupingPolicy adds a grouping policy within the transaction.

func (*Transaction) AddNamedGroupingPolicy ¶

func (tx *Transaction) AddNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedGroupingPolicy adds a named grouping policy within the transaction.

func (*Transaction) AddNamedPolicies ¶

func (tx *Transaction) AddNamedPolicies(ptype string, rules [][]string) (bool, error)

AddNamedPolicies adds multiple named policies within the transaction.

func (*Transaction) AddNamedPolicy ¶

func (tx *Transaction) AddNamedPolicy(ptype string, params ...interface{}) (bool, error)

AddNamedPolicy adds a named policy within the transaction. The policy is buffered and will be applied when the transaction is committed.

func (*Transaction) AddPolicies ¶

func (tx *Transaction) AddPolicies(rules [][]string) (bool, error)

AddPolicies adds multiple policies within the transaction.

func (*Transaction) AddPolicy ¶

func (tx *Transaction) AddPolicy(params ...interface{}) (bool, error)

AddPolicy adds a policy within the transaction. The policy is buffered and will be applied when the transaction is committed.

func (*Transaction) Commit ¶

func (tx *Transaction) Commit() error

Commit commits the transaction using a two-phase commit protocol. Phase 1: Apply all operations to the database Phase 2: Apply changes to the in-memory model and rebuild role links.

func (*Transaction) GetBufferedModel ¶

func (tx *Transaction) GetBufferedModel() (model.Model, error)

GetBufferedModel returns the model as it would look after applying all buffered operations. This is useful for preview or validation purposes within the transaction.

func (*Transaction) HasOperations ¶

func (tx *Transaction) HasOperations() bool

HasOperations returns true if the transaction has any buffered operations.

func (*Transaction) IsActive ¶

func (tx *Transaction) IsActive() bool

IsActive returns true if the transaction is still active (not committed or rolled back).

func (*Transaction) IsCommitted ¶

func (tx *Transaction) IsCommitted() bool

IsCommitted returns true if the transaction has been committed.

func (*Transaction) IsRolledBack ¶

func (tx *Transaction) IsRolledBack() bool

IsRolledBack returns true if the transaction has been rolled back.

func (*Transaction) OperationCount ¶

func (tx *Transaction) OperationCount() int

OperationCount returns the number of buffered operations in the transaction.

func (*Transaction) RemoveGroupingPolicy ¶

func (tx *Transaction) RemoveGroupingPolicy(params ...interface{}) (bool, error)

RemoveGroupingPolicy removes a grouping policy within the transaction.

func (*Transaction) RemoveNamedGroupingPolicy ¶

func (tx *Transaction) RemoveNamedGroupingPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedGroupingPolicy removes a named grouping policy within the transaction.

func (*Transaction) RemoveNamedPolicies ¶

func (tx *Transaction) RemoveNamedPolicies(ptype string, rules [][]string) (bool, error)

RemoveNamedPolicies removes multiple named policies within the transaction.

func (*Transaction) RemoveNamedPolicy ¶

func (tx *Transaction) RemoveNamedPolicy(ptype string, params ...interface{}) (bool, error)

RemoveNamedPolicy removes a named policy within the transaction.

func (*Transaction) RemovePolicies ¶

func (tx *Transaction) RemovePolicies(rules [][]string) (bool, error)

RemovePolicies removes multiple policies within the transaction.

func (*Transaction) RemovePolicy ¶

func (tx *Transaction) RemovePolicy(params ...interface{}) (bool, error)

RemovePolicy removes a policy within the transaction.

func (*Transaction) Rollback ¶

func (tx *Transaction) Rollback() error

Rollback rolls back the transaction. This will rollback the database transaction and clear the transaction state.

func (*Transaction) UpdateNamedPolicy ¶

func (tx *Transaction) UpdateNamedPolicy(ptype string, oldPolicy []string, newPolicy []string) (bool, error)

UpdateNamedPolicy updates a named policy within the transaction.

func (*Transaction) UpdatePolicy ¶

func (tx *Transaction) UpdatePolicy(oldPolicy []string, newPolicy []string) (bool, error)

UpdatePolicy updates a policy within the transaction.

type TransactionBuffer ¶

type TransactionBuffer struct {
	// contains filtered or unexported fields
}

TransactionBuffer holds all policy changes made within a transaction. It maintains a list of operations and a snapshot of the model state at the beginning of the transaction.

func NewTransactionBuffer ¶

func NewTransactionBuffer(baseModel model.Model) *TransactionBuffer

NewTransactionBuffer creates a new transaction buffer with a model snapshot. The snapshot represents the state of the model at the beginning of the transaction.

func (*TransactionBuffer) AddOperation ¶

func (tb *TransactionBuffer) AddOperation(op persist.PolicyOperation)

AddOperation adds a policy operation to the buffer. This operation will be applied when the transaction is committed.

func (*TransactionBuffer) ApplyOperationsToModel ¶

func (tb *TransactionBuffer) ApplyOperationsToModel(baseModel model.Model) (model.Model, error)

ApplyOperationsToModel applies all buffered operations to a model and returns the result. This simulates what the model would look like after all operations are applied. It's used for validation and preview purposes within the transaction.

func (*TransactionBuffer) Clear ¶

func (tb *TransactionBuffer) Clear()

Clear removes all buffered operations. This is typically called after a successful commit or rollback.

func (*TransactionBuffer) GetModelSnapshot ¶

func (tb *TransactionBuffer) GetModelSnapshot() model.Model

GetModelSnapshot returns the model snapshot taken at transaction start. This represents the original state before any transaction operations.

func (*TransactionBuffer) GetOperations ¶

func (tb *TransactionBuffer) GetOperations() []persist.PolicyOperation

GetOperations returns all buffered operations. Returns a copy to prevent external modifications.

func (*TransactionBuffer) HasOperations ¶

func (tb *TransactionBuffer) HasOperations() bool

HasOperations returns true if there are any buffered operations.

func (*TransactionBuffer) OperationCount ¶

func (tb *TransactionBuffer) OperationCount() int

OperationCount returns the number of buffered operations.

type TransactionalEnforcer ¶

type TransactionalEnforcer struct {
	*Enforcer // Embedded enforcer for all standard functionality
	// contains filtered or unexported fields
}

TransactionalEnforcer extends Enforcer with transaction support. It provides atomic policy operations through transactions.

func NewTransactionalEnforcer ¶

func NewTransactionalEnforcer(params ...interface{}) (*TransactionalEnforcer, error)

NewTransactionalEnforcer creates a new TransactionalEnforcer. It accepts the same parameters as NewEnforcer.

func (*TransactionalEnforcer) BeginTransaction ¶

func (te *TransactionalEnforcer) BeginTransaction(ctx context.Context) (*Transaction, error)

BeginTransaction starts a new transaction. Returns an error if a transaction is already in progress or if the adapter doesn't support transactions.

func (*TransactionalEnforcer) GetTransaction ¶

func (te *TransactionalEnforcer) GetTransaction(id string) *Transaction

GetTransaction returns a transaction by its ID, or nil if not found.

func (*TransactionalEnforcer) IsTransactionActive ¶

func (te *TransactionalEnforcer) IsTransactionActive(id string) bool

IsTransactionActive returns true if the transaction with the given ID is active.

func (*TransactionalEnforcer) WithTransaction ¶

func (te *TransactionalEnforcer) WithTransaction(ctx context.Context, fn func(*Transaction) error) error

WithTransaction executes a function within a transaction. If the function returns an error, the transaction is rolled back. Otherwise, it's committed automatically.

Directories ¶

Path	Synopsis
config
constant
detector
effector
errors
log
model
persist
cache
file-adapter
string-adapter
rbac
default-role-manager
util

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

Casbin

All the languages supported by Casbin:

Table of contents

Supported models

How it works?

Features

Installation

Documentation

Online editor

Tutorials

Get started

Policy management

Policy persistence

Policy consistence between multiple nodes

Role manager

Benchmarks

Examples

Middlewares

Our adopters

How to Contribute

Contributors

Star History

License

Contact

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func CasbinJsGetPermissionForUser ¶

func CasbinJsGetPermissionForUserOld ¶

func GetCacheKey ¶

Types ¶

type AIConfig ¶ added in v3.10.0

type CacheableParam ¶

type CachedEnforcer ¶

func NewCachedEnforcer ¶

func (*CachedEnforcer) ClearPolicy ¶

func (*CachedEnforcer) EnableCache ¶

func (*CachedEnforcer) Enforce ¶

func (*CachedEnforcer) InvalidateCache ¶

func (*CachedEnforcer) LoadPolicy ¶

func (*CachedEnforcer) RemovePolicies ¶

func (*CachedEnforcer) RemovePolicy ¶

func (*CachedEnforcer) SetCache ¶

func (*CachedEnforcer) SetExpireTime ¶

type ConflictDetector ¶

func NewConflictDetector ¶

func (*ConflictDetector) DetectConflicts ¶

type ConflictError ¶

func (*ConflictError) Error ¶

type ContextEnforcer ¶

func (*ContextEnforcer) AddGroupingPoliciesCtx ¶

func (*ContextEnforcer) AddGroupingPoliciesExCtx ¶

func (*ContextEnforcer) AddGroupingPolicyCtx ¶

func (*ContextEnforcer) AddNamedGroupingPoliciesCtx ¶

func (*ContextEnforcer) AddNamedGroupingPoliciesExCtx ¶

func (*ContextEnforcer) AddNamedGroupingPolicyCtx ¶

func (*ContextEnforcer) AddNamedPoliciesCtx ¶

func (*ContextEnforcer) AddNamedPoliciesExCtx ¶

func (*ContextEnforcer) AddNamedPolicyCtx ¶

func (*ContextEnforcer) AddPermissionForUserCtx ¶

func (*ContextEnforcer) AddPermissionsForUserCtx ¶

func (*ContextEnforcer) AddPoliciesCtx ¶

func (*ContextEnforcer) AddPoliciesExCtx ¶

func (*ContextEnforcer) AddPolicyCtx ¶

func (*ContextEnforcer) AddRoleForUserCtx ¶

func (*ContextEnforcer) AddRoleForUserInDomainCtx ¶

func (*ContextEnforcer) DeleteAllUsersByDomainCtx ¶

func (*ContextEnforcer) DeleteDomainsCtx ¶

func (*ContextEnforcer) DeletePermissionCtx ¶

func (*ContextEnforcer) DeletePermissionForUserCtx ¶

func (*ContextEnforcer) DeletePermissionsForUserCtx ¶

func (*ContextEnforcer) DeleteRoleCtx ¶

func (*ContextEnforcer) DeleteRoleForUserCtx ¶

func (*ContextEnforcer) DeleteRoleForUserInDomainCtx ¶

func (*ContextEnforcer) DeleteRolesForUserCtx ¶

func (*ContextEnforcer) DeleteRolesForUserInDomainCtx ¶