authorizer

Documentation

Index

• type Attributes
• type AttributesRecord
  • func (a AttributesRecord) GetAPIGroup() string
  • func (a AttributesRecord) GetGroups() []string
  • func (a AttributesRecord) GetNamespace() string
  • func (a AttributesRecord) GetResource() string
  • func (a AttributesRecord) GetUserName() string
  • func (a AttributesRecord) GetVerb() string
  • func (a AttributesRecord) IsReadOnly() bool
• type Authorizer
• type AuthorizerFunc
  • func (f AuthorizerFunc) Authorize(a Attributes) error
• type RequestAttributesGetter

Types

type Attributes

type Attributes interface {
	// The user string which the request was authenticated as, or empty if
	// no authentication occurred and the request was allowed to proceed.
	GetUserName() string

	// The list of group names the authenticated user is a member of. Can be
	// empty if the authenticated user is not in any groups, or if no
	// authentication occurred.
	GetGroups() []string

	// GetVerb returns the kube verb associated with API requests (this includes get, list, watch, create, update, patch, delete, and proxy),
	// or the lowercased HTTP verb associated with non-API requests (this includes get, put, post, patch, and delete)
	GetVerb() string

	// When IsReadOnly() == true, the request has no side effects, other than
	// caching, logging, and other incidentals.
	IsReadOnly() bool

	// The namespace of the object, if a request is for a REST object.
	GetNamespace() string

	// The kind of object, if a request is for a REST object.
	GetResource() string

	// The group of the resource, if a request is for a REST object.
	GetAPIGroup() string
}

Attributes is an interface used by an Authorizer to get information about a request that is used to make an authorization decision.

type AttributesRecord

type AttributesRecord struct {
	User      user.Info
	Verb      string
	Namespace string
	APIGroup  string
	Resource  string
}

AttributesRecord implements Attributes interface.

func (AttributesRecord) GetAPIGroup

func (a AttributesRecord) GetAPIGroup() string

func (AttributesRecord) GetGroups

func (a AttributesRecord) GetGroups() []string

func (AttributesRecord) GetNamespace

func (a AttributesRecord) GetNamespace() string

func (AttributesRecord) GetResource

func (a AttributesRecord) GetResource() string

func (AttributesRecord) GetUserName

func (a AttributesRecord) GetUserName() string

func (AttributesRecord) GetVerb

func (a AttributesRecord) GetVerb() string

func (AttributesRecord) IsReadOnly

func (a AttributesRecord) IsReadOnly() bool

type Authorizer

type Authorizer interface {
	Authorize(a Attributes) (err error)
}

Authorizer makes an authorization decision based on information gained by making zero or more calls to methods of the Attributes interface. It returns nil when an action is authorized, otherwise it returns an error.

type AuthorizerFunc

type AuthorizerFunc func(a Attributes) error

func (AuthorizerFunc) Authorize

func (f AuthorizerFunc) Authorize(a Attributes) error

type RequestAttributesGetter

type RequestAttributesGetter interface {
	GetRequestAttributes(user.Info, *http.Request) Attributes
}

RequestAttributesGetter provides a function that extracts Attributes from an http.Request