engines

type BulkChecker ¶

type BulkChecker struct {

	// input queue for permission check requests
	RequestChan chan BulkCheckerRequest
	// contains filtered or unexported fields
}

BulkChecker is a struct for checking permissions in bulk.

func NewBulkChecker(ctx context.Context, checker invoke.Check, callback func(entityID string, result base.CheckResult), concurrencyLimit int) *BulkChecker

func (c *BulkChecker) Start(typ BulkCheckerType)

func (c *BulkChecker) Stop()

func (c *BulkChecker) Wait() error

type BulkCheckerRequest ¶

type BulkCheckerRequest struct {
	Request *base.PermissionCheckRequest
	Result  base.CheckResult
}

BulkCheckerRequest is a struct for a permission check request and the channel to send the result.

type BulkCheckerType ¶ added in v0.5.0

type BulkCheckerType string

const (
	BULK_SUBJECT BulkCheckerType = "subject"
	BULK_ENTITY  BulkCheckerType = "entity"
)

type BulkEntityPublisher ¶ added in v0.5.0

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

BulkEntityPublisher is a struct for streaming permission check results.

func NewBulkEntityPublisher(ctx context.Context, request *base.PermissionLookupEntityRequest, bulkChecker *BulkChecker) *BulkEntityPublisher

func (s *BulkEntityPublisher) Publish(entity *base.Entity, metadata *base.PermissionCheckRequestMetadata, context *base.Context, result base.CheckResult)

type BulkSubjectPublisher ¶ added in v0.5.0

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

BulkSubjectPublisher is a struct for streaming permission check results.

func NewBulkSubjectPublisher(ctx context.Context, request *base.PermissionLookupSubjectRequest, bulkChecker *BulkChecker) *BulkSubjectPublisher

func (s *BulkSubjectPublisher) Publish(subject *base.Subject, metadata *base.PermissionCheckRequestMetadata, context *base.Context, result base.CheckResult)

type CheckCombiner ¶

type CheckCombiner func(ctx context.Context, functions []CheckFunction, limit int) (*base.PermissionCheckResponse, error)

CheckCombiner is a type that represents a function which takes a context, a slice of CheckFunctions, and a limit. It combines the results of multiple CheckFunctions according to a specific strategy and returns a PermissionCheckResponse along with an error.

type CheckEngine ¶

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

CheckEngine is a core component responsible for performing permission checks. It reads schema and relationship information, and uses the engine key manager to validate permission requests.

func NewCheckEngine(sr storage.SchemaReader, rr storage.DataReader, opts ...CheckOption) *CheckEngine

func (engine *CheckEngine) Check(ctx context.Context, request *base.PermissionCheckRequest) (response *base.PermissionCheckResponse, err error)

func (engine *CheckEngine) SetInvoker(invoker invoke.Check)

type CheckFunction ¶

type CheckFunction func(ctx context.Context) (*base.PermissionCheckResponse, error)

CheckFunction is a type that represents a function that takes a context and returns a PermissionCheckResponse along with an error. It is used to perform individual permission checks within the CheckEngine.

type CheckOption ¶

type CheckOption func(engine *CheckEngine)

CheckOption - a functional option type for configuring the CheckEngine.

func CheckConcurrencyLimit(limit int) CheckOption

type CheckResponse ¶

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

CheckResponse - a struct that holds a PermissionCheckResponse and an error for a single check function.

type ERMap ¶

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

ERMap - a thread-safe map of ENR records.

func (s *ERMap) Add(entity *base.Entity, relation string) bool

type ExpandCombiner ¶

type ExpandCombiner func(ctx context.Context, entity *base.Entity, permission string, arguments []*base.Argument, functions []ExpandFunction) ExpandResponse

ExpandCombiner represents a function that combines the results of multiple ExpandFunction calls into a single ExpandResponse.

type ExpandEngine ¶

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

ExpandEngine - This comment is describing a type called ExpandEngine. The ExpandEngine type contains two fields: schemaReader, which is a storage.SchemaReader object, and relationshipReader, which is a storage.RelationshipReader object. The ExpandEngine type is used to expand permission scopes based on a given user ID and a set of permission requirements.

func NewExpandEngine(sr storage.SchemaReader, rr storage.DataReader) *ExpandEngine

func (engine *ExpandEngine) Expand(ctx context.Context, request *base.PermissionExpandRequest) (response *base.PermissionExpandResponse, err error)

type ExpandFunction ¶

type ExpandFunction func(ctx context.Context, expandChain chan<- ExpandResponse)

ExpandFunction represents a function that expands the schema and relationships of a request and sends the response through the provided channel.

type ExpandResponse ¶

type ExpandResponse struct {
	Response *base.PermissionExpandResponse
	Err      error
}

ExpandResponse is a struct that contains the response and error returned from the expand function in the ExpandEngine. It is used to return the response and error together as a single object.

type LookupEngine ¶ added in v0.5.0

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

func NewLookupEngine(
	check invoke.Check,
	schemaReader storage.SchemaReader,
	dataReader storage.DataReader,
	opts ...LookupOption,
) *LookupEngine

func (engine *LookupEngine) LookupEntity(ctx context.Context, request *base.PermissionLookupEntityRequest) (response *base.PermissionLookupEntityResponse, err error)

func (engine *LookupEngine) LookupEntityStream(ctx context.Context, request *base.PermissionLookupEntityRequest, server base.Permission_LookupEntityStreamServer) (err error)

func (engine *LookupEngine) LookupSubject(ctx context.Context, request *base.PermissionLookupSubjectRequest) (response *base.PermissionLookupSubjectResponse, err error)

type LookupOption ¶ added in v0.5.0

type LookupOption func(engine *LookupEngine)

func LookupConcurrencyLimit(limit int) LookupOption

type MassEntityFilter ¶ added in v0.5.0

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

MassEntityFilter is a struct that performs permission checks on a set of entities

func NewMassEntityFilter(dataReader storage.DataReader) *MassEntityFilter

func (filter *MassEntityFilter) EntityFilter(
	ctx context.Context,
	request *base.PermissionLookupEntityRequest,
	publisher *BulkEntityPublisher,
) (err error)

type MassSubjectFilter ¶ added in v0.5.0

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

MassSubjectFilter is a struct that represents a filter for mass subjects.

func NewMassSubjectFilter(dataReader storage.DataReader) *MassSubjectFilter

func (filter *MassSubjectFilter) SubjectFilter(
	ctx context.Context,
	request *base.PermissionLookupSubjectRequest,
	publisher *BulkSubjectPublisher,
) (err error)

type SchemaBaseSubjectFilterOption ¶ added in v0.5.0

type SchemaBaseSubjectFilterOption func(engine *SchemaBasedSubjectFilter)

SchemaBaseSubjectFilterOption - a functional option type for configuring the LookupSubjectEngine.

func SchemaBaseSubjectFilterConcurrencyLimit(limit int) SchemaBaseSubjectFilterOption

type SchemaBasedEntityFilter ¶ added in v0.5.0

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

SchemaBasedEntityFilter is a struct that performs permission checks on a set of entities

func NewSchemaBasedEntityFilter(dataReader storage.DataReader, sch *base.SchemaDefinition) *SchemaBasedEntityFilter

func (engine *SchemaBasedEntityFilter) EntityFilter(
	ctx context.Context,
	request *base.PermissionEntityFilterRequest,
	visits *ERMap,
	publisher *BulkEntityPublisher,
) (err error)

type SchemaBasedSubjectFilter ¶ added in v0.5.0

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

func NewSchemaBasedSubjectFilter(schemaReader storage.SchemaReader, dataReader storage.DataReader, opts ...SchemaBaseSubjectFilterOption) *SchemaBasedSubjectFilter

func (engine *SchemaBasedSubjectFilter) SubjectFilter(ctx context.Context, request *base.PermissionLookupSubjectRequest) (response []string, err error)

type SubjectFilterCombiner ¶ added in v0.5.0

type SubjectFilterCombiner func(ctx context.Context, functions []SubjectFilterFunction, limit int) ([]string, error)

SubjectFilterCombiner defines the type for a function that takes a context, a slice of SubjectFilterFunctions, an integer as a limit and returns a pointer to a PermissionSubjectFilterResponse and an error. This type is useful when you want to define a function that can execute multiple SubjectFilterFunctions in a specific way (like concurrently with a limit or sequentially) and combine their results into a single PermissionSubjectFilterResponse.

type SubjectFilterFunction ¶ added in v0.5.0

type SubjectFilterFunction func(ctx context.Context) ([]string, error)

SubjectFilterFunction defines the type for a function that takes a context and returns a pointer to a PermissionSubjectFilterResponse and an error. This type is often used when you want to pass around functions with this specific signature.

type SubjectFilterResponse ¶ added in v0.5.0

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

SubjectFilterResponse -

type SubjectPermissionEngine ¶ added in v0.4.7

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

func NewSubjectPermission(checker invoke.Check, sr storage.SchemaReader, opts ...SubjectPermissionOption) *SubjectPermissionEngine

func (engine *SubjectPermissionEngine) SubjectPermission(ctx context.Context, request *base.PermissionSubjectPermissionRequest) (*base.PermissionSubjectPermissionResponse, error)

type SubjectPermissionOption ¶ added in v0.4.7

type SubjectPermissionOption func(engine *SubjectPermissionEngine)

SubjectPermissionOption - a functional option type for configuring the SubjectPermissionEngine.

func SubjectPermissionConcurrencyLimit(limit int) SubjectPermissionOption

type SubjectPermissionResponse ¶ added in v0.4.7

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

SubjectPermissionResponse - a struct that holds a SubjectPermissionResponse and an error for a single subject permission check result.