policy_handler

Documentation

Index

• type EvaluatorSelector
• type EventHandler
  • func NewPolicyEventHandler(subscriptionNames []string, evalSelector EvaluatorSelector, opts ...Opt) EventHandler
  • func (h EventHandler) CreateHttpHandler() func(http.ResponseWriter, *http.Request)
  • func (h EventHandler) ExecuteSyncRequest(ctx context.Context, req skill.RequestContext) ([]goals.GoalEvaluationQueryResult, error)
  • func (h EventHandler) Start()
• type Opt
  • func WithAsync() Opt
  • func WithAsyncMultiQuery() Opt
  • func WithLocal() Opt
  • func WithSyncQuery() Opt
• type Package
• type SyncRequestMetadata

Types

type EvaluatorSelector

type EvaluatorSelector func(ctx context.Context, goal goals.Goal, dataSource data.DataSource) (goals.GoalEvaluator, error)

type EventHandler

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

func NewPolicyEventHandler

func NewPolicyEventHandler(subscriptionNames []string, evalSelector EvaluatorSelector, opts ...Opt) EventHandler

func (EventHandler) CreateHttpHandler

func (h EventHandler) CreateHttpHandler() func(http.ResponseWriter, *http.Request)

func (EventHandler) ExecuteSyncRequest

func (h EventHandler) ExecuteSyncRequest(ctx context.Context, req skill.RequestContext) ([]goals.GoalEvaluationQueryResult, error)

func (EventHandler) Start

func (h EventHandler) Start()

type Opt

type Opt func(handler *EventHandler)

func WithAsync

func WithAsync() Opt

WithAsync is enabled by default, added last after all other Opts if not explicitly registered early.

func WithAsyncMultiQuery

func WithAsyncMultiQuery() Opt

WithAsyncMultiQuery will enable the async graphql data source to spool results across multiple queries. These intermediate results are stored in the following requests' metadata, and as such risk hitting the upper limit on the metadata field, and failing.

func WithLocal

func WithLocal() Opt

func WithSyncQuery

func WithSyncQuery() Opt

type Package

type Package struct {
	Licenses  []string `edn:"licenses,omitempty"` // only needed for the license policy evaluation
	Name      string   `edn:"name"`
	Namespace string   `edn:"namespace"`
	Version   string   `edn:"version"`
	Purl      string   `edn:"purl"`
	Type      string   `edn:"type"`
}

type SyncRequestMetadata

type SyncRequestMetadata struct {
	QueryResults map[edn.Keyword]edn.RawMessage `edn:"fixedQueryResults"`
	Packages     []Package                      `edn:"packages"`      // todo remove when no longer used
	User         string                         `edn:"imgConfigUser"` // The user from the image config blob // todo remove when no longer used
	SBOM         string                         `edn:"sbom"`
	ContentType  string                         `edn:"contentType"`
	Encoding     string                         `edn:"encoding"`
}