v1

package
v1.21.0-kw10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const GroupName = "authorization.k8s.io"

GroupName is the group name use in this package

Variables

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type LocalSubjectAccessReview 

type LocalSubjectAccessReview struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds information about the request being evaluated.  spec.namespace must be equal to the namespace you made the request against.  If empty, it is defaulted.
	// Required: true
	Spec *SubjectAccessReviewSpec `json:"spec"`

	// Status is filled in by the server and indicates whether the request is allowed or not
	Status *SubjectAccessReviewStatus `json:"status,omitempty"`
}

LocalSubjectAccessReview LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking.

swagger:model LocalSubjectAccessReview

func (*LocalSubjectAccessReview) GroupVersionKind 

func (v *LocalSubjectAccessReview) GroupVersionKind() schema.GroupVersionKind

type NonResourceAttributes 

type NonResourceAttributes struct {

	// Path is the URL path of the request
	Path string `json:"path,omitempty"`

	// Verb is the standard HTTP verb
	Verb string `json:"verb,omitempty"`
}

NonResourceAttributes NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

swagger:model NonResourceAttributes

type NonResourceRule 

type NonResourceRule struct {

	// NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path.  "*" means all.
	NonResourceURLs []string `json:"nonResourceURLs,omitempty"`

	// Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options.  "*" means all.
	// Required: true
	Verbs []string `json:"verbs"`
}

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

swagger:model NonResourceRule

type ResourceAttributes 

type ResourceAttributes struct {

	// Group is the API Group of the Resource.  "*" means all.
	Group string `json:"group,omitempty"`

	// Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
	Name string `json:"name,omitempty"`

	// Namespace is the namespace of the action being requested.  Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
	Namespace string `json:"namespace,omitempty"`

	// Resource is one of the existing resource types.  "*" means all.
	Resource string `json:"resource,omitempty"`

	// Subresource is one of the existing resource types.  "" means none.
	Subresource string `json:"subresource,omitempty"`

	// Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy.  "*" means all.
	Verb string `json:"verb,omitempty"`

	// Version is the API Version of the Resource.  "*" means all.
	Version string `json:"version,omitempty"`
}

ResourceAttributes ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

swagger:model ResourceAttributes

type ResourceRule 

type ResourceRule struct {

	// APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.  "*" means all.
	APIGroups []string `json:"apiGroups,omitempty"`

	// ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed.  "*" means all.
	ResourceNames []string `json:"resourceNames,omitempty"`

	// Resources is a list of resources this rule applies to.  "*" means all in the specified apiGroups.
	//  "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
	Resources []string `json:"resources,omitempty"`

	// Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy.  "*" means all.
	// Required: true
	Verbs []string `json:"verbs"`
}

ResourceRule ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

swagger:model ResourceRule

type SelfSubjectAccessReview 

type SelfSubjectAccessReview struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds information about the request being evaluated.  user and groups must be empty
	// Required: true
	Spec *SelfSubjectAccessReviewSpec `json:"spec"`

	// Status is filled in by the server and indicates whether the request is allowed or not
	Status *SubjectAccessReviewStatus `json:"status,omitempty"`
}

SelfSubjectAccessReview SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action

swagger:model SelfSubjectAccessReview

func (*SelfSubjectAccessReview) GroupVersionKind 

func (v *SelfSubjectAccessReview) GroupVersionKind() schema.GroupVersionKind

type SelfSubjectAccessReviewSpec 

type SelfSubjectAccessReviewSpec struct {

	// NonResourceAttributes describes information for a non-resource access request
	NonResourceAttributes *NonResourceAttributes `json:"nonResourceAttributes,omitempty"`

	// ResourceAuthorizationAttributes describes information for a resource access request
	ResourceAttributes *ResourceAttributes `json:"resourceAttributes,omitempty"`
}

SelfSubjectAccessReviewSpec SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

swagger:model SelfSubjectAccessReviewSpec

type SelfSubjectRulesReview 

type SelfSubjectRulesReview struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds information about the request being evaluated.
	// Required: true
	Spec *SelfSubjectRulesReviewSpec `json:"spec"`

	// Status is filled in by the server and indicates the set of actions a user can perform.
	Status *SubjectRulesReviewStatus `json:"status,omitempty"`
}

SelfSubjectRulesReview SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server.

swagger:model SelfSubjectRulesReview

func (*SelfSubjectRulesReview) GroupVersionKind 

func (v *SelfSubjectRulesReview) GroupVersionKind() schema.GroupVersionKind

type SelfSubjectRulesReviewSpec 

type SelfSubjectRulesReviewSpec struct {

	// Namespace to evaluate rules for. Required.
	Namespace string `json:"namespace,omitempty"`
}

SelfSubjectRulesReviewSpec self subject rules review spec

swagger:model SelfSubjectRulesReviewSpec

type SubjectAccessReview 

type SubjectAccessReview struct {

	// APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
	APIVersion string `json:"apiVersion,omitempty"`

	// Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind,omitempty"`

	// metadata
	Metadata *apimachinery_pkg_apis_meta_v1.ObjectMeta `json:"metadata,omitempty"`

	// Spec holds information about the request being evaluated
	// Required: true
	Spec *SubjectAccessReviewSpec `json:"spec"`

	// Status is filled in by the server and indicates whether the request is allowed or not
	Status *SubjectAccessReviewStatus `json:"status,omitempty"`
}

SubjectAccessReview SubjectAccessReview checks whether or not a user or group can perform an action.

swagger:model SubjectAccessReview

func (*SubjectAccessReview) GroupVersionKind 

func (v *SubjectAccessReview) GroupVersionKind() schema.GroupVersionKind

type SubjectAccessReviewSpec 

type SubjectAccessReviewSpec struct {

	// Extra corresponds to the user.Info.GetExtra() method from the authenticator.  Since that is input to the authorizer it needs a reflection here.
	Extra map[string][]string `json:"extra,omitempty"`

	// Groups is the groups you're testing for.
	Groups []string `json:"groups,omitempty"`

	// NonResourceAttributes describes information for a non-resource access request
	NonResourceAttributes *NonResourceAttributes `json:"nonResourceAttributes,omitempty"`

	// ResourceAuthorizationAttributes describes information for a resource access request
	ResourceAttributes *ResourceAttributes `json:"resourceAttributes,omitempty"`

	// UID information about the requesting user.
	UID string `json:"uid,omitempty"`

	// User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
	User string `json:"user,omitempty"`
}

SubjectAccessReviewSpec SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

swagger:model SubjectAccessReviewSpec

type SubjectAccessReviewStatus 

type SubjectAccessReviewStatus struct {

	// Allowed is required. True if the action would be allowed, false otherwise.
	// Required: true
	Allowed *bool `json:"allowed"`

	// Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true.
	Denied bool `json:"denied,omitempty"`

	// EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
	EvaluationError string `json:"evaluationError,omitempty"`

	// Reason is optional.  It indicates why a request was allowed or denied.
	Reason string `json:"reason,omitempty"`
}

SubjectAccessReviewStatus SubjectAccessReviewStatus

swagger:model SubjectAccessReviewStatus

type SubjectRulesReviewStatus 

type SubjectRulesReviewStatus struct {

	// EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.
	EvaluationError string `json:"evaluationError,omitempty"`

	// Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
	// Required: true
	Incomplete *bool `json:"incomplete"`

	// NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
	// Required: true
	NonResourceRules []*NonResourceRule `json:"nonResourceRules"`

	// ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
	// Required: true
	ResourceRules []*ResourceRule `json:"resourceRules"`
}

SubjectRulesReviewStatus SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

swagger:model SubjectRulesReviewStatus

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.