privacy

package
v0.0.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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 AddressMutationRuleFunc

type AddressMutationRuleFunc func(context.Context, *ent.AddressMutation) error

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

func (AddressMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type AddressQueryRuleFunc

type AddressQueryRuleFunc func(context.Context, *ent.AddressQuery) error

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

func (AddressQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

type AuditLogMutationRuleFunc

type AuditLogMutationRuleFunc func(context.Context, *ent.AuditLogMutation) error

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

func (AuditLogMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type AuditLogQueryRuleFunc

type AuditLogQueryRuleFunc func(context.Context, *ent.AuditLogQuery) error

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

func (AuditLogQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

type BusinessMutationRuleFunc

type BusinessMutationRuleFunc func(context.Context, *ent.BusinessMutation) error

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

func (BusinessMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type BusinessQueryRuleFunc

type BusinessQueryRuleFunc func(context.Context, *ent.BusinessQuery) error

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

func (BusinessQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

type ContentMutationRuleFunc

type ContentMutationRuleFunc func(context.Context, *ent.ContentMutation) error

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

func (ContentMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type ContentQueryRuleFunc

type ContentQueryRuleFunc func(context.Context, *ent.ContentQuery) error

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

func (ContentQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

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 OperatorMutationRuleFunc

type OperatorMutationRuleFunc func(context.Context, *ent.OperatorMutation) error

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

func (OperatorMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type OperatorQueryRuleFunc

type OperatorQueryRuleFunc func(context.Context, *ent.OperatorQuery) error

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

func (OperatorQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

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

type TagMutationRuleFunc

type TagMutationRuleFunc func(context.Context, *ent.TagMutation) error

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

func (TagMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type TagQueryRuleFunc

type TagQueryRuleFunc func(context.Context, *ent.TagQuery) error

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

func (TagQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

type TimetableMutationRuleFunc

type TimetableMutationRuleFunc func(context.Context, *ent.TimetableMutation) error

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

func (TimetableMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type TimetableQueryRuleFunc

type TimetableQueryRuleFunc func(context.Context, *ent.TimetableQuery) error

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

func (TimetableQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

type UserMutationRuleFunc

type UserMutationRuleFunc func(context.Context, *ent.UserMutation) error

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

func (UserMutationRuleFunc) EvalMutation

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

EvalMutation calls f(ctx, m).

type UserQueryRuleFunc

type UserQueryRuleFunc func(context.Context, *ent.UserQuery) error

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

func (UserQueryRuleFunc) EvalQuery

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

EvalQuery return f(ctx, q).

Jump to

Keyboard shortcuts

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