policy

Documentation

Index

• type API
  • func NewAPI(core core.API) API
• type Body
• type Capability
• type Entity
• type Policy
  • func (p *Policy) GetPolicyName() (string, error)
  • func (p *Policy) GetPolicyRules() ([]*Rule, error)
  • func (p *Policy) MarshalJSON() ([]byte, error)
  • func (p *Policy) UnmarshalJSON(bytes []byte) error
• type Rule

Types

type API

type API interface {
	UpdatePolicy(policy Entity) error
	DeletePolicy(policy core.PolicyNameEntity) error
	ReadPolicy(policy core.PolicyNameEntity) (*Policy, error)
}

func NewAPI

func NewAPI(core core.API) API

type Body

type Body interface {
	GetPolicyRules() ([]*Rule, error)
}

type Capability

type Capability string

var (
	// CreateCapability gives permission to create objects.
	CreateCapability Capability = "create"
	// ReadCapability gives permission to read objects.
	ReadCapability Capability = "read"
	// UpdateCapability gives permission to update objects.
	UpdateCapability Capability = "update"
	// DeleteCapability gives permission to delete objects.
	DeleteCapability Capability = "delete"
	// ListCapability gives permission to list objects.
	ListCapability Capability = "list"
)

type Entity

type Entity interface {
	core.PolicyNameEntity
	Body
}

type Policy

type Policy struct {
	Name  string
	Rules []*Rule `hcl:"path,block"`
}

func (*Policy) GetPolicyName

func (p *Policy) GetPolicyName() (string, error)

func (*Policy) GetPolicyRules

func (p *Policy) GetPolicyRules() ([]*Rule, error)

func (*Policy) MarshalJSON

func (p *Policy) MarshalJSON() ([]byte, error)

func (*Policy) UnmarshalJSON

func (p *Policy) UnmarshalJSON(bytes []byte) error

type Rule

type Rule struct {
	Path         string       `hcl:"name,label"`
	Capabilities []Capability `hcl:"capabilities"`
}