security

Documentation

Index

• Variables
• func Credentials(cs ...any) func(Subject)
• func HasAllPrincipals(subject Subject, ps ...any) bool
• func HasAnyPrincipals(subject Subject, ps ...any) bool
• func Principals(ps ...any) func(Subject)
• type Group
• type Role
• type Subject
  • func NewSubject(config ...func(Subject)) Subject

Variables

var System = system{}

System defines a singleton principal that can be used to bypass security checks. e.g. internal service to service interactions

var SystemSubject = systemSubject{[]any{System}}

Functions

func Credentials

func Credentials(cs ...any) func(Subject)

Credentials configures a Subject with initial credentials.

func HasAllPrincipals

func HasAllPrincipals(subject Subject, ps ...any) bool

HasAllPrincipals return true if the subject possess all principals.

func HasAnyPrincipals

func HasAnyPrincipals(subject Subject, ps ...any) bool

HasAnyPrincipals return true if the subject possess any principals.

func Principals

func Principals(ps ...any) func(Subject)

Principals configures a Subject with initial principals.

Types

type Group

type Group struct {
	Name string
}

Group organizes users having common capabilities.

type Role

type Role struct {
	Name string
}

Role represents a certain level of authorization.

type Subject

type Subject interface {
	// Principals return the identities of this Subject.
	// e.g. UserId, Username, Group or Role
	Principals() []any

	// Credentials return security-related attributes of this Subject.
	// e.g. passwords, certificates, claims
	Credentials() []any

	// AddPrincipals adds the principals if not present.
	AddPrincipals(ps ...any)

	// AddCredentials add credentials if not present.
	AddCredentials(cs ...any)
}

Subject is any entity that requests access to a resource. e.g. Process, Machine, Service or User

func NewSubject

func NewSubject(config ...func(Subject)) Subject

NewSubject creates a new Subject with optional principals and credentials.