privacy

Documentation

Index

• Variables
• func Allowf(format string, a ...any) error
• func DecisionContext(parent context.Context, decision error) context.Context
• func DecisionFromContext(ctx context.Context) (error, bool)
• func Denyf(format string, a ...any) error
• func Skipf(format string, a ...any) error
• type AccountUserMutationRuleFunc
  • func (f AccountUserMutationRuleFunc) EvalMutation(ctx context.Context, m ent.Mutation) error
• type AccountUserQueryRuleFunc
  • func (f AccountUserQueryRuleFunc) EvalQuery(ctx context.Context, q ent.Query) error
• type Filter
• type FilterFunc
  • func (f FilterFunc) EvalMutation(ctx context.Context, m ent.Mutation) error
  • func (f FilterFunc) EvalQuery(ctx context.Context, q ent.Query) error
• type MutationPolicy
• type MutationRule
  • func DenyMutationOperationRule(op ent.Op) MutationRule
  • func OnMutationOperation(rule MutationRule, op ent.Op) MutationRule
• type MutationRuleFunc
  • func (f MutationRuleFunc) EvalMutation(ctx context.Context, m ent.Mutation) error
• type Policy
• type QueryMutationRule
  • func AlwaysAllowRule() QueryMutationRule
  • func AlwaysDenyRule() QueryMutationRule
  • func ContextQueryMutationRule(eval func(context.Context) error) QueryMutationRule
• type QueryPolicy
• type QueryRule
• type QueryRuleFunc
  • func (f QueryRuleFunc) EvalQuery(ctx context.Context, q ent.Query) error

Variables

var (
	// Allow may be returned by rules to indicate that the policy
	// evaluation should terminate with allow decision.
	Allow = privacy.Allow

	// Deny may be returned by rules to indicate that the policy
	// evaluation should terminate with 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 Allowf

func Allowf(format string, a ...any) error

Allowf returns an formatted wrapped Allow decision.

func DecisionContext

func DecisionContext(parent context.Context, decision error) context.Context

DecisionContext creates a new context from the given parent context with a policy decision attach to it.

func DecisionFromContext

func DecisionFromContext(ctx context.Context) (error, bool)

DecisionFromContext retrieves the policy decision from the context.

func Denyf

func Denyf(format string, a ...any) error

Denyf returns an formatted wrapped Deny decision.

func Skipf

func Skipf(format string, a ...any) error

Skipf returns an formatted wrapped Skip decision.

Types

type AccountUserMutationRuleFunc

type AccountUserMutationRuleFunc func(context.Context, *ent.AccountUserMutation) error

The AccountUserMutationRuleFunc type is an adapter to allow the use of ordinary functions as a mutation rule.

func (AccountUserMutationRuleFunc) EvalMutation

func (f AccountUserMutationRuleFunc) EvalMutation(ctx context.Context, m ent.Mutation) error

EvalMutation calls f(ctx, m).

type AccountUserQueryRuleFunc

type AccountUserQueryRuleFunc func(context.Context, *ent.AccountUserQuery) error

The AccountUserQueryRuleFunc type is an adapter to allow the use of ordinary functions as a query rule.

func (AccountUserQueryRuleFunc) EvalQuery

func (f AccountUserQueryRuleFunc) EvalQuery(ctx context.Context, q ent.Query) error

EvalQuery return f(ctx, q).

type Filter

type Filter interface {
	// Where applies a filter on the executed query/mutation.
	Where(entql.P)
}

Filter is the interface that wraps the Where function for filtering nodes in queries and mutations.

type FilterFunc

type FilterFunc func(context.Context, Filter) error

The FilterFunc type is an adapter that allows the use of ordinary functions as filters for query and mutation types.

func (FilterFunc) EvalMutation

func (f FilterFunc) EvalMutation(ctx context.Context, m ent.Mutation) error

EvalMutation calls f(ctx, q) if the mutation implements the Filter interface, otherwise it is denied.

func (FilterFunc) EvalQuery

func (f FilterFunc) EvalQuery(ctx context.Context, q ent.Query) error

EvalQuery calls f(ctx, q) if the query implements the Filter interface, otherwise it is denied.

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

type MutationRuleFunc func(context.Context, ent.Mutation) error

MutationRuleFunc type is an adapter which allows the use of ordinary functions as mutation rules.

func (MutationRuleFunc) EvalMutation

func (f MutationRuleFunc) EvalMutation(ctx context.Context, m ent.Mutation) error

EvalMutation returns f(ctx, m).

type Policy

type Policy = privacy.Policy

Policy groups query and mutation policies.

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

type QueryRule = privacy.QueryRule

QueryRule defines the interface deciding whether a query is allowed and optionally modify it.

type QueryRuleFunc

type QueryRuleFunc func(context.Context, ent.Query) error

QueryRuleFunc type is an adapter to allow the use of ordinary functions as query rules.

func (QueryRuleFunc) EvalQuery

func (f QueryRuleFunc) EvalQuery(ctx context.Context, q ent.Query) error

Eval returns f(ctx, q).