permission

Documentation

Index

• Constants
• func Annotate(cmd *cobra.Command, resource, operation string)
• type Policy
  • func Parse(s string) (*Policy, error)
  • func (p *Policy) Allows(resource, op string) bool
  • func (p *Policy) IsUnrestricted() bool
  • func (p *Policy) Rules() []Rule
  • func (p *Policy) String() string
• type Rule

Constants

const (
	AnnotationResource  = "hs:resource"
	AnnotationOperation = "hs:operation"
)

Annotation keys stored on cobra.Command.Annotations.

const (
	OpRead   = "read"
	OpWrite  = "write"
	OpDelete = "delete"
)

Valid operations.

Functions

func Annotate

func Annotate(cmd *cobra.Command, resource, operation string)

Annotate sets the resource and operation annotations on a command.

Types

type Policy

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

Policy is a parsed set of permission rules. A nil or zero-value Policy is unrestricted (allows everything).

func Parse

func Parse(s string) (*Policy, error)

Parse parses a comma-separated permission string into a Policy. An empty string yields an unrestricted policy.

func (*Policy) Allows

func (p *Policy) Allows(resource, op string) bool

Allows checks whether the given resource:operation is permitted.

func (*Policy) IsUnrestricted

func (p *Policy) IsUnrestricted() bool

IsUnrestricted returns true when no rules are set (everything allowed).

func (*Policy) Rules

func (p *Policy) Rules() []Rule

Rules returns a copy of the parsed rules.

func (*Policy) String

func (p *Policy) String() string

String returns the original permission string, or "unrestricted".

type Rule

type Rule struct {
	Resource  string
	Operation string
}

Rule is a single resource:operation pair.