Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attributes

type Attributes interface {
	// GetUser returns the user.Info object to authorize
	GetUser() user.Info

	// GetVerb returns the kube verb associated with API requests (this includes get, list, watch, create, update, patch, delete, deletecollection, 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

	// GetSubresource returns the subresource being requested, if present
	GetSubresource() string

	// GetName returns the name of the object as parsed off the request.  This will not be present for all request types, but
	// will be present for: get, update, delete
	GetName() string

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

	// GetAPIVersion returns the version of the group requested, if a request is for a REST object.
	GetAPIVersion() string

	// IsResourceRequest returns true for requests to API resources, like /api/v1/nodes,
	// and false for non-resource endpoints like /api, /healthz
	IsResourceRequest() bool

	// GetPath returns the path of the request
	GetPath() 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
    	APIVersion      string
    	Resource        string
    	Subresource     string
    	Name            string
    	ResourceRequest bool
    	Path            string
    }

      AttributesRecord implements Attributes interface.

      func (AttributesRecord) GetAPIGroup

      func (a AttributesRecord) GetAPIGroup() string

      func (AttributesRecord) GetAPIVersion

      func (a AttributesRecord) GetAPIVersion() string

      func (AttributesRecord) GetName

      func (a AttributesRecord) GetName() string

      func (AttributesRecord) GetNamespace

      func (a AttributesRecord) GetNamespace() string

      func (AttributesRecord) GetPath

      func (a AttributesRecord) GetPath() string

      func (AttributesRecord) GetResource

      func (a AttributesRecord) GetResource() string

      func (AttributesRecord) GetSubresource

      func (a AttributesRecord) GetSubresource() string

      func (AttributesRecord) GetUser

      func (a AttributesRecord) GetUser() user.Info

      func (AttributesRecord) GetVerb

      func (a AttributesRecord) GetVerb() string

      func (AttributesRecord) IsReadOnly

      func (a AttributesRecord) IsReadOnly() bool

      func (AttributesRecord) IsResourceRequest

      func (a AttributesRecord) IsResourceRequest() bool

      type Authorizer

      type Authorizer interface {
      	Authorize(ctx context.Context, a Attributes) (authorized Decision, reason string, 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) (Decision, string, error)

        func (AuthorizerFunc) Authorize

        func (f AuthorizerFunc) Authorize(ctx context.Context, a Attributes) (Decision, string, error)

        type Decision

        type Decision int
        const (
        	// DecisionDeny means that an authorizer decided to deny the action.
        	DecisionDeny Decision = iota
        	// DecisionAllow means that an authorizer decided to allow the action.
        	DecisionAllow
        	// DecisionNoOpionion means that an authorizer has no opinion on whether
        	// to allow or deny an action.
        	DecisionNoOpinion
        )

        type DefaultNonResourceRuleInfo

        type DefaultNonResourceRuleInfo struct {
        	Verbs           []string
        	NonResourceURLs []string
        }

          DefaultNonResourceRuleInfo holds information that describes a rule for the non-resource

          func (*DefaultNonResourceRuleInfo) GetNonResourceURLs

          func (i *DefaultNonResourceRuleInfo) GetNonResourceURLs() []string

          func (*DefaultNonResourceRuleInfo) GetVerbs

          func (i *DefaultNonResourceRuleInfo) GetVerbs() []string

          type DefaultResourceRuleInfo

          type DefaultResourceRuleInfo struct {
          	Verbs         []string
          	APIGroups     []string
          	Resources     []string
          	ResourceNames []string
          }

            DefaultResourceRuleInfo holds information that describes a rule for the resource

            func (*DefaultResourceRuleInfo) GetAPIGroups

            func (i *DefaultResourceRuleInfo) GetAPIGroups() []string

            func (*DefaultResourceRuleInfo) GetResourceNames

            func (i *DefaultResourceRuleInfo) GetResourceNames() []string

            func (*DefaultResourceRuleInfo) GetResources

            func (i *DefaultResourceRuleInfo) GetResources() []string

            func (*DefaultResourceRuleInfo) GetVerbs

            func (i *DefaultResourceRuleInfo) GetVerbs() []string

            type NonResourceRuleInfo

            type NonResourceRuleInfo interface {
            	// GetVerbs returns a list of kubernetes resource API verbs.
            	GetVerbs() []string
            	// GetNonResourceURLs return a set of partial urls that a user should have access to.
            	GetNonResourceURLs() []string
            }

            type RequestAttributesGetter

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

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

              type ResourceRuleInfo

              type ResourceRuleInfo interface {
              	// GetVerbs returns a list of kubernetes resource API verbs.
              	GetVerbs() []string
              	// GetAPIGroups return the names of the APIGroup that contains the resources.
              	GetAPIGroups() []string
              	// GetResources return a list of resources the rule applies to.
              	GetResources() []string
              	// GetResourceNames return a white list of names that the rule applies to.
              	GetResourceNames() []string
              }

              type RuleResolver

              type RuleResolver interface {
              	// RulesFor get the list of cluster wide rules, the list of rules in the specific namespace, incomplete status and errors.
              	RulesFor(user user.Info, namespace string) ([]ResourceRuleInfo, []NonResourceRuleInfo, bool, error)
              }

                RuleResolver provides a mechanism for resolving the list of rules that apply to a given user within a namespace.