can

package module

v0.0.0-...-bb6dc8f Latest Latest Go to latest Published: Feb 4, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This package is a simple implementation of a can/cannot method for authorization.

if can.Can(someAccount, "update", someResource) {
  // do something...
} else {
  // show an error maybe?
}

Or, if you only want to see if something is not allowed:

if can.Not(someAccount, "update", someResource) {
  // do something...
}

This section is empty.

View Source

var (
	ErrNotAuthorized = errors.New("not authorized")
	ErrInvalidAction = errors.New("invalid action")
)

View Source

var (
	PolicyRegistry = make(map[string]Policy[any])
)

PolicyRegistry is a map of policy names to policies. Where the name is the type associated withthe policy.

func AddPolicy(p Policy[any])

AddPolicy adds a policy to the PolicyRegistry.

func Can[K any](actor K, action string, resources ...any) error

func Not[K any](actor K, action string, resources ...any) bool

func PolicyExists(k any) bool

PolicyExists returns true if a policy exists in the PolicyRegistry.

func RemovePolicy(k any)

RemovePolicy removes a policy from the PolicyRegistry.

type Canner[K any] interface {
	Can(actor K, action string) error
}

Canner allows a resource to define if an account can perform a given action.

type Policy[K any] map[string]func(K) error

Policy is a map of actions to functions that return an error if the action cannot be performed for the given account.

func (p Policy[K]) Can(actor K, action string) error

Can implements the Canner interface.

func (p Policy[K]) Verbs() []string

Verbs implements the Verber interface.

type Verber interface {
	Verbs() []string
}

Verber is used to allow a resource to define the actions it supports.