Documentation

Index

Constants

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

    GroupName is the group name use in this package

    Variables

    View Source
    var (
    	ErrInvalidLengthGenerated        = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowGenerated          = fmt.Errorf("proto: integer overflow")
    	ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
    )
    View Source
    var (
    	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
    	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
    	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
    
    	AddToScheme = localSchemeBuilder.AddToScheme
    )
    View Source
    var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

      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 ExtraValue

        type ExtraValue []string

          ExtraValue masks the value so protobuf can generate +protobuf.nullable=true +protobuf.options.(gogoproto.goproto_stringer)=false

          func (ExtraValue) DeepCopy

          func (in ExtraValue) DeepCopy() ExtraValue

            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExtraValue.

            func (ExtraValue) DeepCopyInto

            func (in ExtraValue) DeepCopyInto(out *ExtraValue)

              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

              func (*ExtraValue) Descriptor

              func (*ExtraValue) Descriptor() ([]byte, []int)

              func (ExtraValue) Marshal

              func (m ExtraValue) Marshal() (dAtA []byte, err error)

              func (ExtraValue) MarshalTo

              func (m ExtraValue) MarshalTo(dAtA []byte) (int, error)

              func (ExtraValue) MarshalToSizedBuffer

              func (m ExtraValue) MarshalToSizedBuffer(dAtA []byte) (int, error)

              func (*ExtraValue) ProtoMessage

              func (*ExtraValue) ProtoMessage()

              func (*ExtraValue) Reset

              func (m *ExtraValue) Reset()

              func (ExtraValue) Size

              func (m ExtraValue) Size() (n int)

              func (ExtraValue) String

              func (t ExtraValue) String() string

              func (*ExtraValue) Unmarshal

              func (m *ExtraValue) Unmarshal(dAtA []byte) error

              func (*ExtraValue) XXX_DiscardUnknown

              func (m *ExtraValue) XXX_DiscardUnknown()

              func (*ExtraValue) XXX_Marshal

              func (m *ExtraValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

              func (*ExtraValue) XXX_Merge

              func (m *ExtraValue) XXX_Merge(src proto.Message)

              func (*ExtraValue) XXX_Size

              func (m *ExtraValue) XXX_Size() int

              func (*ExtraValue) XXX_Unmarshal

              func (m *ExtraValue) XXX_Unmarshal(b []byte) error

              type TokenReview

              type TokenReview struct {
              	metav1.TypeMeta `json:",inline"`
              	// +optional
              	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
              
              	// Spec holds information about the request being evaluated
              	Spec TokenReviewSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
              
              	// Status is filled in by the server and indicates whether the request can be authenticated.
              	// +optional
              	Status TokenReviewStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
              }

                TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

                func (*TokenReview) APILifecycleDeprecated

                func (in *TokenReview) APILifecycleDeprecated() (major, minor int)

                  APILifecycleDeprecated is an autogenerated function, returning the release in which the API struct was or will be deprecated as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:deprecated" tags in types.go or "k8s:prerelease-lifecycle-gen:introduced" plus three minor.

                  func (*TokenReview) APILifecycleIntroduced

                  func (in *TokenReview) APILifecycleIntroduced() (major, minor int)

                    APILifecycleIntroduced is an autogenerated function, returning the release in which the API struct was introduced as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:introduced" tags in types.go.

                    func (*TokenReview) APILifecycleRemoved

                    func (in *TokenReview) APILifecycleRemoved() (major, minor int)

                      APILifecycleRemoved is an autogenerated function, returning the release in which the API is no longer served as int versions of major and minor for comparison. It is controlled by "k8s:prerelease-lifecycle-gen:removed" tags in types.go or "k8s:prerelease-lifecycle-gen:deprecated" plus three minor.

                      func (*TokenReview) APILifecycleReplacement

                      func (in *TokenReview) APILifecycleReplacement() schema.GroupVersionKind

                        APILifecycleReplacement is an autogenerated function, returning the group, version, and kind that should be used instead of this deprecated type. It is controlled by "k8s:prerelease-lifecycle-gen:replacement=<group>,<version>,<kind>" tags in types.go.

                        func (*TokenReview) DeepCopy

                        func (in *TokenReview) DeepCopy() *TokenReview

                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenReview.

                          func (*TokenReview) DeepCopyInto

                          func (in *TokenReview) DeepCopyInto(out *TokenReview)

                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                            func (*TokenReview) DeepCopyObject

                            func (in *TokenReview) DeepCopyObject() runtime.Object

                              DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                              func (*TokenReview) Descriptor

                              func (*TokenReview) Descriptor() ([]byte, []int)

                              func (*TokenReview) Marshal

                              func (m *TokenReview) Marshal() (dAtA []byte, err error)

                              func (*TokenReview) MarshalTo

                              func (m *TokenReview) MarshalTo(dAtA []byte) (int, error)

                              func (*TokenReview) MarshalToSizedBuffer

                              func (m *TokenReview) MarshalToSizedBuffer(dAtA []byte) (int, error)

                              func (*TokenReview) ProtoMessage

                              func (*TokenReview) ProtoMessage()

                              func (*TokenReview) Reset

                              func (m *TokenReview) Reset()

                              func (*TokenReview) Size

                              func (m *TokenReview) Size() (n int)

                              func (*TokenReview) String

                              func (this *TokenReview) String() string

                              func (TokenReview) SwaggerDoc

                              func (TokenReview) SwaggerDoc() map[string]string

                              func (*TokenReview) Unmarshal

                              func (m *TokenReview) Unmarshal(dAtA []byte) error

                              func (*TokenReview) XXX_DiscardUnknown

                              func (m *TokenReview) XXX_DiscardUnknown()

                              func (*TokenReview) XXX_Marshal

                              func (m *TokenReview) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                              func (*TokenReview) XXX_Merge

                              func (m *TokenReview) XXX_Merge(src proto.Message)

                              func (*TokenReview) XXX_Size

                              func (m *TokenReview) XXX_Size() int

                              func (*TokenReview) XXX_Unmarshal

                              func (m *TokenReview) XXX_Unmarshal(b []byte) error

                              type TokenReviewSpec

                              type TokenReviewSpec struct {
                              	// Token is the opaque bearer token.
                              	// +optional
                              	Token string `json:"token,omitempty" protobuf:"bytes,1,opt,name=token"`
                              	// Audiences is a list of the identifiers that the resource server presented
                              	// with the token identifies as. Audience-aware token authenticators will
                              	// verify that the token was intended for at least one of the audiences in
                              	// this list. If no audiences are provided, the audience will default to the
                              	// audience of the Kubernetes apiserver.
                              	// +optional
                              	Audiences []string `json:"audiences,omitempty" protobuf:"bytes,2,rep,name=audiences"`
                              }

                                TokenReviewSpec is a description of the token authentication request.

                                func (*TokenReviewSpec) DeepCopy

                                func (in *TokenReviewSpec) DeepCopy() *TokenReviewSpec

                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenReviewSpec.

                                  func (*TokenReviewSpec) DeepCopyInto

                                  func (in *TokenReviewSpec) DeepCopyInto(out *TokenReviewSpec)

                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                    func (*TokenReviewSpec) Descriptor

                                    func (*TokenReviewSpec) Descriptor() ([]byte, []int)

                                    func (*TokenReviewSpec) Marshal

                                    func (m *TokenReviewSpec) Marshal() (dAtA []byte, err error)

                                    func (*TokenReviewSpec) MarshalTo

                                    func (m *TokenReviewSpec) MarshalTo(dAtA []byte) (int, error)

                                    func (*TokenReviewSpec) MarshalToSizedBuffer

                                    func (m *TokenReviewSpec) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                    func (*TokenReviewSpec) ProtoMessage

                                    func (*TokenReviewSpec) ProtoMessage()

                                    func (*TokenReviewSpec) Reset

                                    func (m *TokenReviewSpec) Reset()

                                    func (*TokenReviewSpec) Size

                                    func (m *TokenReviewSpec) Size() (n int)

                                    func (*TokenReviewSpec) String

                                    func (this *TokenReviewSpec) String() string

                                    func (TokenReviewSpec) SwaggerDoc

                                    func (TokenReviewSpec) SwaggerDoc() map[string]string

                                    func (*TokenReviewSpec) Unmarshal

                                    func (m *TokenReviewSpec) Unmarshal(dAtA []byte) error

                                    func (*TokenReviewSpec) XXX_DiscardUnknown

                                    func (m *TokenReviewSpec) XXX_DiscardUnknown()

                                    func (*TokenReviewSpec) XXX_Marshal

                                    func (m *TokenReviewSpec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                    func (*TokenReviewSpec) XXX_Merge

                                    func (m *TokenReviewSpec) XXX_Merge(src proto.Message)

                                    func (*TokenReviewSpec) XXX_Size

                                    func (m *TokenReviewSpec) XXX_Size() int

                                    func (*TokenReviewSpec) XXX_Unmarshal

                                    func (m *TokenReviewSpec) XXX_Unmarshal(b []byte) error

                                    type TokenReviewStatus

                                    type TokenReviewStatus struct {
                                    	// Authenticated indicates that the token was associated with a known user.
                                    	// +optional
                                    	Authenticated bool `json:"authenticated,omitempty" protobuf:"varint,1,opt,name=authenticated"`
                                    	// User is the UserInfo associated with the provided token.
                                    	// +optional
                                    	User UserInfo `json:"user,omitempty" protobuf:"bytes,2,opt,name=user"`
                                    	// Audiences are audience identifiers chosen by the authenticator that are
                                    	// compatible with both the TokenReview and token. An identifier is any
                                    	// identifier in the intersection of the TokenReviewSpec audiences and the
                                    	// token's audiences. A client of the TokenReview API that sets the
                                    	// spec.audiences field should validate that a compatible audience identifier
                                    	// is returned in the status.audiences field to ensure that the TokenReview
                                    	// server is audience aware. If a TokenReview returns an empty
                                    	// status.audience field where status.authenticated is "true", the token is
                                    	// valid against the audience of the Kubernetes API server.
                                    	// +optional
                                    	Audiences []string `json:"audiences,omitempty" protobuf:"bytes,4,rep,name=audiences"`
                                    	// Error indicates that the token couldn't be checked
                                    	// +optional
                                    	Error string `json:"error,omitempty" protobuf:"bytes,3,opt,name=error"`
                                    }

                                      TokenReviewStatus is the result of the token authentication request.

                                      func (*TokenReviewStatus) DeepCopy

                                      func (in *TokenReviewStatus) DeepCopy() *TokenReviewStatus

                                        DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TokenReviewStatus.

                                        func (*TokenReviewStatus) DeepCopyInto

                                        func (in *TokenReviewStatus) DeepCopyInto(out *TokenReviewStatus)

                                          DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                          func (*TokenReviewStatus) Descriptor

                                          func (*TokenReviewStatus) Descriptor() ([]byte, []int)

                                          func (*TokenReviewStatus) Marshal

                                          func (m *TokenReviewStatus) Marshal() (dAtA []byte, err error)

                                          func (*TokenReviewStatus) MarshalTo

                                          func (m *TokenReviewStatus) MarshalTo(dAtA []byte) (int, error)

                                          func (*TokenReviewStatus) MarshalToSizedBuffer

                                          func (m *TokenReviewStatus) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                          func (*TokenReviewStatus) ProtoMessage

                                          func (*TokenReviewStatus) ProtoMessage()

                                          func (*TokenReviewStatus) Reset

                                          func (m *TokenReviewStatus) Reset()

                                          func (*TokenReviewStatus) Size

                                          func (m *TokenReviewStatus) Size() (n int)

                                          func (*TokenReviewStatus) String

                                          func (this *TokenReviewStatus) String() string

                                          func (TokenReviewStatus) SwaggerDoc

                                          func (TokenReviewStatus) SwaggerDoc() map[string]string

                                          func (*TokenReviewStatus) Unmarshal

                                          func (m *TokenReviewStatus) Unmarshal(dAtA []byte) error

                                          func (*TokenReviewStatus) XXX_DiscardUnknown

                                          func (m *TokenReviewStatus) XXX_DiscardUnknown()

                                          func (*TokenReviewStatus) XXX_Marshal

                                          func (m *TokenReviewStatus) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                          func (*TokenReviewStatus) XXX_Merge

                                          func (m *TokenReviewStatus) XXX_Merge(src proto.Message)

                                          func (*TokenReviewStatus) XXX_Size

                                          func (m *TokenReviewStatus) XXX_Size() int

                                          func (*TokenReviewStatus) XXX_Unmarshal

                                          func (m *TokenReviewStatus) XXX_Unmarshal(b []byte) error

                                          type UserInfo

                                          type UserInfo struct {
                                          	// The name that uniquely identifies this user among all active users.
                                          	// +optional
                                          	Username string `json:"username,omitempty" protobuf:"bytes,1,opt,name=username"`
                                          	// A unique value that identifies this user across time. If this user is
                                          	// deleted and another user by the same name is added, they will have
                                          	// different UIDs.
                                          	// +optional
                                          	UID string `json:"uid,omitempty" protobuf:"bytes,2,opt,name=uid"`
                                          	// The names of groups this user is a part of.
                                          	// +optional
                                          	Groups []string `json:"groups,omitempty" protobuf:"bytes,3,rep,name=groups"`
                                          	// Any additional information provided by the authenticator.
                                          	// +optional
                                          	Extra map[string]ExtraValue `json:"extra,omitempty" protobuf:"bytes,4,rep,name=extra"`
                                          }

                                            UserInfo holds the information about the user needed to implement the user.Info interface.

                                            func (*UserInfo) DeepCopy

                                            func (in *UserInfo) DeepCopy() *UserInfo

                                              DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new UserInfo.

                                              func (*UserInfo) DeepCopyInto

                                              func (in *UserInfo) DeepCopyInto(out *UserInfo)

                                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                func (*UserInfo) Descriptor

                                                func (*UserInfo) Descriptor() ([]byte, []int)

                                                func (*UserInfo) Marshal

                                                func (m *UserInfo) Marshal() (dAtA []byte, err error)

                                                func (*UserInfo) MarshalTo

                                                func (m *UserInfo) MarshalTo(dAtA []byte) (int, error)

                                                func (*UserInfo) MarshalToSizedBuffer

                                                func (m *UserInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

                                                func (*UserInfo) ProtoMessage

                                                func (*UserInfo) ProtoMessage()

                                                func (*UserInfo) Reset

                                                func (m *UserInfo) Reset()

                                                func (*UserInfo) Size

                                                func (m *UserInfo) Size() (n int)

                                                func (*UserInfo) String

                                                func (this *UserInfo) String() string

                                                func (UserInfo) SwaggerDoc

                                                func (UserInfo) SwaggerDoc() map[string]string

                                                func (*UserInfo) Unmarshal

                                                func (m *UserInfo) Unmarshal(dAtA []byte) error

                                                func (*UserInfo) XXX_DiscardUnknown

                                                func (m *UserInfo) XXX_DiscardUnknown()

                                                func (*UserInfo) XXX_Marshal

                                                func (m *UserInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

                                                func (*UserInfo) XXX_Merge

                                                func (m *UserInfo) XXX_Merge(src proto.Message)

                                                func (*UserInfo) XXX_Size

                                                func (m *UserInfo) XXX_Size() int

                                                func (*UserInfo) XXX_Unmarshal

                                                func (m *UserInfo) XXX_Unmarshal(b []byte) error