security

Documentation

Index

• Variables
• type Principal
• type Subject
  • func NewSubject(opts ...SubjectOption) Subject
• type SubjectOption
  • func WithCredentials(cs ...any) SubjectOption
  • func WithPrincipals(ps ...Principal) SubjectOption

Variables

var (
	// System defines a singleton principal that can be used
	// to bypass security checks.
	// e.g. internal service to service interactions
	System = system{}

	// SystemSubject is a singleton Subject used to bypass security.
	SystemSubject = systemSubject{[]Principal{System}}
)

Types

type Principal

type Principal interface {
	Name() string
}

Principal identifies a Subject.

type Subject

type Subject interface {
	// Authenticated returns true if this Subject is authenticated.
	Authenticated() bool

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

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

	// AddPrincipals adds any new principals to this Subject.
	AddPrincipals(ps ...Principal)

	// AddCredentials add any new credentials to this Subject.
	AddCredentials(cs ...any)

	// RemovePrincipals remove the principals from this Subject.
	RemovePrincipals(ps ...Principal)

	// RemoveCredentials remove the credentials from this Subject.
	RemoveCredentials(cs ...any)
}

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

func NewSubject

func NewSubject(opts ...SubjectOption) Subject

NewSubject creates a new Subject with optional principals and credentials.

type SubjectOption

type SubjectOption func(subject Subject)

SubjectOption allows configuration of new Subject.

func WithCredentials

func WithCredentials(cs ...any) SubjectOption

WithCredentials configures a Subject with initial credentials.

func WithPrincipals

func WithPrincipals(ps ...Principal) SubjectOption

WithPrincipals configures a Subject with initial principals.