policies

Documentation

Index

• Variables
• type NewRegistryConfig
• type PolicyProvider
  • func (p *PolicyProvider) Resolve(policyName, orgName, token string) (*schemaapi.Policy, *PolicyReference, error)
  • func (p *PolicyProvider) ResolveGroup(groupName, orgName, token string) (*schemaapi.PolicyGroup, *PolicyReference, error)
  • func (p *PolicyProvider) ValidateAttachment(att *schemaapi.PolicyAttachment, token string) error
• type PolicyReference
• type ProviderResponse
• type RawMessage
• type Registry
  • func NewRegistry(logger log.Logger, conf ...*NewRegistryConfig) (*Registry, error)
  • func (r *Registry) DefaultProvider() *PolicyProvider
  • func (r *Registry) GetProvider(name string) *PolicyProvider
  • func (r *Registry) GetProviderNames() []string
• type ValidateRequest
• type ValidateResponse

Variables

var ErrNotFound = fmt.Errorf("policy not found")

Types

type NewRegistryConfig

type NewRegistryConfig struct {
	Name string
	// Host is deprecated. Use URL instead
	Host    string
	URL     string
	Default bool
}

type PolicyProvider

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

PolicyProvider represents an external policy provider

func (*PolicyProvider) Resolve

func (p *PolicyProvider) Resolve(policyName, orgName, token string) (*schemaapi.Policy, *PolicyReference, error)

Resolve calls the remote provider for retrieving a policy

func (*PolicyProvider) ResolveGroup

func (p *PolicyProvider) ResolveGroup(groupName, orgName, token string) (*schemaapi.PolicyGroup, *PolicyReference, error)

ResolveGroup calls remote provider for retrieving a policy group definition

func (*PolicyProvider) ValidateAttachment

func (p *PolicyProvider) ValidateAttachment(att *schemaapi.PolicyAttachment, token string) error

type PolicyReference

type PolicyReference struct {
	URL    string
	Digest string
}

type ProviderResponse

type ProviderResponse struct {
	// Deprecated: Raw is the preferred approach
	Data   map[string]any `json:"data"`
	Digest string         `json:"digest"`
	Raw    *RawMessage    `json:"raw"`
}

type RawMessage

type RawMessage struct {
	Body   []byte `json:"body"`
	Format string `json:"format"`
}

type Registry

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

Registry manages policy providers

func NewRegistry

func NewRegistry(logger log.Logger, conf ...*NewRegistryConfig) (*Registry, error)

func (*Registry) DefaultProvider

func (r *Registry) DefaultProvider() *PolicyProvider

func (*Registry) GetProvider

func (r *Registry) GetProvider(name string) *PolicyProvider

func (*Registry) GetProviderNames

func (r *Registry) GetProviderNames() []string

type ValidateRequest

type ValidateRequest struct {
	PolicyAttachment string `json:"policy_attachment"`
}

type ValidateResponse

type ValidateResponse struct {
	Valid            bool     `json:"valid"`
	ValidationErrors []string `json:"validationErrors"`
}