Documentation
¶
Index ¶
- Variables
- func Allowf(format string, a ...interface{}) error
- func DecisionContext(parent context.Context, decision error) context.Context
- func DecisionFromContext(ctx context.Context) (error, bool)
- func Denyf(format string, a ...interface{}) error
- func Skipf(format string, a ...interface{}) error
- type APIAuditMutationRuleFunc
- type APIAuditQueryRuleFunc
- type FactMutationRuleFunc
- type FactQueryRuleFunc
- type FactTypeMutationRuleFunc
- type FactTypeQueryRuleFunc
- type Filter
- type FilterFunc
- type GrantMutationRuleFunc
- type GrantQueryRuleFunc
- type MutationPolicy
- type MutationRule
- type MutationRuleFunc
- type Policy
- type QueryMutationRule
- type QueryPolicy
- type QueryRule
- type QueryRuleFunc
- type ScopeMutationRuleFunc
- type ScopeQueryRuleFunc
Constants ¶
This section is empty.
Variables ¶
var ( // Allow may be returned by rules to indicate that the policy // evaluation should terminate with an allow decision. Allow = privacy.Allow // Deny may be returned by rules to indicate that the policy // evaluation should terminate with an deny decision. Deny = privacy.Deny // Skip may be returned by rules to indicate that the policy // evaluation should continue to the next rule. Skip = privacy.Skip )
Functions ¶
func DecisionContext ¶
DecisionContext creates a new context from the given parent context with a policy decision attach to it.
func DecisionFromContext ¶
DecisionFromContext retrieves the policy decision from the context.
Types ¶
type APIAuditMutationRuleFunc ¶
type APIAuditMutationRuleFunc func(context.Context, *ent.APIAuditMutation) error
The APIAuditMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.
func (APIAuditMutationRuleFunc) EvalMutation ¶
EvalMutation calls f(ctx, m).
type APIAuditQueryRuleFunc ¶
type APIAuditQueryRuleFunc func(context.Context, *ent.APIAuditQuery) error
The APIAuditQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.
type FactMutationRuleFunc ¶
type FactMutationRuleFunc func(context.Context, *ent.FactMutation) error
The FactMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.
func (FactMutationRuleFunc) EvalMutation ¶
EvalMutation calls f(ctx, m).
type FactQueryRuleFunc ¶
The FactQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.
type FactTypeMutationRuleFunc ¶
type FactTypeMutationRuleFunc func(context.Context, *ent.FactTypeMutation) error
The FactTypeMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.
func (FactTypeMutationRuleFunc) EvalMutation ¶
EvalMutation calls f(ctx, m).
type FactTypeQueryRuleFunc ¶
type FactTypeQueryRuleFunc func(context.Context, *ent.FactTypeQuery) error
The FactTypeQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.
type Filter ¶
Filter is the interface that wraps the Where function for filtering nodes in queries and mutations.
type FilterFunc ¶
The FilterFunc type is an adapter that allows the use of ordinary functions as filters for query and mutation types.
func (FilterFunc) EvalMutation ¶
EvalMutation calls f(ctx, q) if the mutation implements the Filter interface, otherwise it is denied.
type GrantMutationRuleFunc ¶
type GrantMutationRuleFunc func(context.Context, *ent.GrantMutation) error
The GrantMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.
func (GrantMutationRuleFunc) EvalMutation ¶
EvalMutation calls f(ctx, m).
type GrantQueryRuleFunc ¶
type GrantQueryRuleFunc func(context.Context, *ent.GrantQuery) error
The GrantQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.
type MutationPolicy ¶
type MutationPolicy = privacy.MutationPolicy
MutationPolicy combines multiple mutation rules into a single policy.
type MutationRule ¶
type MutationRule = privacy.MutationRule
MutationRule defines the interface which decides whether a mutation is allowed and optionally modifies it.
func DenyMutationOperationRule ¶
func DenyMutationOperationRule(op ent.Op) MutationRule
DenyMutationOperationRule returns a rule denying specified mutation operation.
func OnMutationOperation ¶
func OnMutationOperation(rule MutationRule, op ent.Op) MutationRule
OnMutationOperation evaluates the given rule only on a given mutation operation.
type MutationRuleFunc ¶
MutationRuleFunc type is an adapter which allows the use of ordinary functions as mutation rules.
func (MutationRuleFunc) EvalMutation ¶
EvalMutation returns f(ctx, m).
type Policy ¶
type Policy struct {
Query QueryPolicy
Mutation MutationPolicy
}
Policy groups query and mutation policies.
func (Policy) EvalMutation ¶
EvalMutation forwards evaluation to mutate a policy.
type QueryMutationRule ¶
type QueryMutationRule interface {
QueryRule
MutationRule
}
QueryMutationRule is an interface which groups query and mutation rules.
func AlwaysAllowRule ¶
func AlwaysAllowRule() QueryMutationRule
AlwaysAllowRule returns a rule that returns an allow decision.
func AlwaysDenyRule ¶
func AlwaysDenyRule() QueryMutationRule
AlwaysDenyRule returns a rule that returns a deny decision.
func ContextQueryMutationRule ¶
func ContextQueryMutationRule(eval func(context.Context) error) QueryMutationRule
ContextQueryMutationRule creates a query/mutation rule from a context eval func.
type QueryPolicy ¶
type QueryPolicy = privacy.QueryPolicy
QueryPolicy combines multiple query rules into a single policy.
type QueryRule ¶
QueryRule defines the interface deciding whether a query is allowed and optionally modify it.
type QueryRuleFunc ¶
QueryRuleFunc type is an adapter to allow the use of ordinary functions as query rules.
type ScopeMutationRuleFunc ¶
type ScopeMutationRuleFunc func(context.Context, *ent.ScopeMutation) error
The ScopeMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.
func (ScopeMutationRuleFunc) EvalMutation ¶
EvalMutation calls f(ctx, m).
type ScopeQueryRuleFunc ¶
type ScopeQueryRuleFunc func(context.Context, *ent.ScopeQuery) error
The ScopeQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.
Source Files