utils

Documentation

Overview

Package utils is a helper for working with ent policies

Index

• Constants
• func AuthzClient(ctx context.Context, m generated.Mutation) *fgax.Client
• func AuthzClientFromContext(ctx context.Context) *fgax.Client
• func NewMutationPolicyWithoutNil(source privacy.MutationPolicy) privacy.MutationPolicy
• func NewOrganizationConditionContext(domains []string) *map[string]any
• func NewOrganizationContextKey(e string) *map[string]any
• type MutationClient

Constants

const (

	// OrgEmailConditionName is the name of the condition for organization email domain checks
	OrgEmailConditionName = "email_domains_allowed"
	// OrgAccessCheckRelation is the relation for organization access checks
	OrgAccessCheckRelation = "access"
)

Context keys for authorization checks

Functions

func AuthzClient

func AuthzClient(ctx context.Context, m generated.Mutation) *fgax.Client

AuthzClient returns the authz client from the context if it exists, otherwise it will attempt to get the client from the mutation if it implements the `MutationClient` interface

func AuthzClientFromContext

func AuthzClientFromContext(ctx context.Context) *fgax.Client

AuthzClientFromContext returns the authz client from the context if it exists this is useful when you need to get the client from the context directly

func NewMutationPolicyWithoutNil

func NewMutationPolicyWithoutNil(source privacy.MutationPolicy) privacy.MutationPolicy

NewMutationPolicyWithoutNil is creating a new slice of `privacy.MutationPolicy` by removing any `nil` values from the input `source` slice. It iterates over each item in the source slice and appends it to the new slice only if it is not `nil` - the new slice is then returned

func NewOrganizationConditionContext

func NewOrganizationConditionContext(domains []string) *map[string]any

NewOrganizationConditionContext creates a new context key for organization condition checks

func NewOrganizationContextKey

func NewOrganizationContextKey(e string) *map[string]any

NewOrganizationContextKey creates a new context key for organization checks if the full email is provided it will take the domain after the `@` symbol

Types

type MutationClient

type MutationClient interface {
	Client() *generated.Client
}

MutationClient is an interface that can be implemented by a mutation to return the ent client