Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package,register +k8s:conversion-gen=k8s.io/kubernetes/pkg/apis/authentication +groupName=authentication.k8s.io +k8s:openapi-gen=true +k8s:defaulter-gen=TypeMeta
Package v1 is a generated protocol buffer package.
It is generated from these files:
k8s.io/kubernetes/pkg/apis/authentication/v1/generated.proto
It has these top-level messages:
ExtraValue
TokenReview
TokenReviewSpec
TokenReviewStatus
UserInfo
Index ¶
- Constants
- Variables
- func Convert_authentication_TokenReviewSpec_To_v1_TokenReviewSpec(in *authentication.TokenReviewSpec, out *TokenReviewSpec, s conversion.Scope) error
- func Convert_authentication_TokenReviewStatus_To_v1_TokenReviewStatus(in *authentication.TokenReviewStatus, out *TokenReviewStatus, ...) error
- func Convert_authentication_TokenReview_To_v1_TokenReview(in *authentication.TokenReview, out *TokenReview, s conversion.Scope) error
- func Convert_authentication_UserInfo_To_v1_UserInfo(in *authentication.UserInfo, out *UserInfo, s conversion.Scope) error
- func Convert_v1_TokenReviewSpec_To_authentication_TokenReviewSpec(in *TokenReviewSpec, out *authentication.TokenReviewSpec, s conversion.Scope) error
- func Convert_v1_TokenReviewStatus_To_authentication_TokenReviewStatus(in *TokenReviewStatus, out *authentication.TokenReviewStatus, ...) error
- func Convert_v1_TokenReview_To_authentication_TokenReview(in *TokenReview, out *authentication.TokenReview, s conversion.Scope) error
- func Convert_v1_UserInfo_To_authentication_UserInfo(in *UserInfo, out *authentication.UserInfo, s conversion.Scope) error
- func DeepCopy_v1_TokenReview(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_TokenReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_TokenReviewStatus(in interface{}, out interface{}, c *conversion.Cloner) error
- func DeepCopy_v1_UserInfo(in interface{}, out interface{}, c *conversion.Cloner) error
- func RegisterConversions(scheme *runtime.Scheme) error
- func RegisterDeepCopies(scheme *runtime.Scheme) error
- func RegisterDefaults(scheme *runtime.Scheme) error
- func Resource(resource string) schema.GroupResource
- type ExtraValue
- func (*ExtraValue) Descriptor() ([]byte, []int)
- func (m ExtraValue) Marshal() (dAtA []byte, err error)
- func (m ExtraValue) MarshalTo(dAtA []byte) (int, error)
- func (*ExtraValue) ProtoMessage()
- func (m *ExtraValue) Reset()
- func (m ExtraValue) Size() (n int)
- func (t ExtraValue) String() string
- func (m *ExtraValue) Unmarshal(dAtA []byte) error
- type TokenReview
- func (*TokenReview) Descriptor() ([]byte, []int)
- func (m *TokenReview) Marshal() (dAtA []byte, err error)
- func (m *TokenReview) MarshalTo(dAtA []byte) (int, error)
- func (*TokenReview) ProtoMessage()
- func (m *TokenReview) Reset()
- func (m *TokenReview) Size() (n int)
- func (this *TokenReview) String() string
- func (TokenReview) SwaggerDoc() map[string]string
- func (m *TokenReview) Unmarshal(dAtA []byte) error
- type TokenReviewSpec
- func (*TokenReviewSpec) Descriptor() ([]byte, []int)
- func (m *TokenReviewSpec) Marshal() (dAtA []byte, err error)
- func (m *TokenReviewSpec) MarshalTo(dAtA []byte) (int, error)
- func (*TokenReviewSpec) ProtoMessage()
- func (m *TokenReviewSpec) Reset()
- func (m *TokenReviewSpec) Size() (n int)
- func (this *TokenReviewSpec) String() string
- func (TokenReviewSpec) SwaggerDoc() map[string]string
- func (m *TokenReviewSpec) Unmarshal(dAtA []byte) error
- type TokenReviewStatus
- func (*TokenReviewStatus) Descriptor() ([]byte, []int)
- func (m *TokenReviewStatus) Marshal() (dAtA []byte, err error)
- func (m *TokenReviewStatus) MarshalTo(dAtA []byte) (int, error)
- func (*TokenReviewStatus) ProtoMessage()
- func (m *TokenReviewStatus) Reset()
- func (m *TokenReviewStatus) Size() (n int)
- func (this *TokenReviewStatus) String() string
- func (TokenReviewStatus) SwaggerDoc() map[string]string
- func (m *TokenReviewStatus) Unmarshal(dAtA []byte) error
- type UserInfo
- func (*UserInfo) Descriptor() ([]byte, []int)
- func (m *UserInfo) Marshal() (dAtA []byte, err error)
- func (m *UserInfo) MarshalTo(dAtA []byte) (int, error)
- func (*UserInfo) ProtoMessage()
- func (m *UserInfo) Reset()
- func (m *UserInfo) Size() (n int)
- func (this *UserInfo) String() string
- func (UserInfo) SwaggerDoc() map[string]string
- func (m *UserInfo) Unmarshal(dAtA []byte) error
Constants ¶
const (
// ImpersonateUserHeader is used to impersonate a particular user during an API server request
ImpersonateUserHeader = "Impersonate-User"
// ImpersonateGroupHeader is used to impersonate a particular group during an API server request.
// It can be repeated multiplied times for multiple groups.
ImpersonateGroupHeader = "Impersonate-Group"
// ImpersonateUserExtraHeaderPrefix is a prefix for any header used to impersonate an entry in the
// extra map[string][]string for user.Info. The key will be every after the prefix.
// It can be repeated multiplied times for multiple map keys and the same key can be repeated multiple
// times to have multiple elements in the slice under a single key
ImpersonateUserExtraHeaderPrefix = "Impersonate-Extra-"
)
const GroupName = "authentication.k8s.io"
GroupName is the group name use in this package
Variables ¶
var (
ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow")
)
var (
// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
SchemeBuilder runtime.SchemeBuilder
AddToScheme = localSchemeBuilder.AddToScheme
)
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
SchemeGroupVersion is group version used to register these objects
Functions ¶
func Convert_authentication_TokenReviewSpec_To_v1_TokenReviewSpec ¶
func Convert_authentication_TokenReviewSpec_To_v1_TokenReviewSpec(in *authentication.TokenReviewSpec, out *TokenReviewSpec, s conversion.Scope) error
Convert_authentication_TokenReviewSpec_To_v1_TokenReviewSpec is an autogenerated conversion function.
func Convert_authentication_TokenReviewStatus_To_v1_TokenReviewStatus ¶
func Convert_authentication_TokenReviewStatus_To_v1_TokenReviewStatus(in *authentication.TokenReviewStatus, out *TokenReviewStatus, s conversion.Scope) error
Convert_authentication_TokenReviewStatus_To_v1_TokenReviewStatus is an autogenerated conversion function.
func Convert_authentication_TokenReview_To_v1_TokenReview ¶
func Convert_authentication_TokenReview_To_v1_TokenReview(in *authentication.TokenReview, out *TokenReview, s conversion.Scope) error
Convert_authentication_TokenReview_To_v1_TokenReview is an autogenerated conversion function.
func Convert_authentication_UserInfo_To_v1_UserInfo ¶
func Convert_authentication_UserInfo_To_v1_UserInfo(in *authentication.UserInfo, out *UserInfo, s conversion.Scope) error
Convert_authentication_UserInfo_To_v1_UserInfo is an autogenerated conversion function.
func Convert_v1_TokenReviewSpec_To_authentication_TokenReviewSpec ¶
func Convert_v1_TokenReviewSpec_To_authentication_TokenReviewSpec(in *TokenReviewSpec, out *authentication.TokenReviewSpec, s conversion.Scope) error
Convert_v1_TokenReviewSpec_To_authentication_TokenReviewSpec is an autogenerated conversion function.
func Convert_v1_TokenReviewStatus_To_authentication_TokenReviewStatus ¶
func Convert_v1_TokenReviewStatus_To_authentication_TokenReviewStatus(in *TokenReviewStatus, out *authentication.TokenReviewStatus, s conversion.Scope) error
Convert_v1_TokenReviewStatus_To_authentication_TokenReviewStatus is an autogenerated conversion function.
func Convert_v1_TokenReview_To_authentication_TokenReview ¶
func Convert_v1_TokenReview_To_authentication_TokenReview(in *TokenReview, out *authentication.TokenReview, s conversion.Scope) error
Convert_v1_TokenReview_To_authentication_TokenReview is an autogenerated conversion function.
func Convert_v1_UserInfo_To_authentication_UserInfo ¶
func Convert_v1_UserInfo_To_authentication_UserInfo(in *UserInfo, out *authentication.UserInfo, s conversion.Scope) error
Convert_v1_UserInfo_To_authentication_UserInfo is an autogenerated conversion function.
func DeepCopy_v1_TokenReview ¶
func DeepCopy_v1_TokenReview(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_v1_TokenReview is an autogenerated deepcopy function.
func DeepCopy_v1_TokenReviewSpec ¶
func DeepCopy_v1_TokenReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_v1_TokenReviewSpec is an autogenerated deepcopy function.
func DeepCopy_v1_TokenReviewStatus ¶
func DeepCopy_v1_TokenReviewStatus(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_v1_TokenReviewStatus is an autogenerated deepcopy function.
func DeepCopy_v1_UserInfo ¶
func DeepCopy_v1_UserInfo(in interface{}, out interface{}, c *conversion.Cloner) error
DeepCopy_v1_UserInfo is an autogenerated deepcopy function.
func RegisterConversions ¶
func RegisterConversions(scheme *runtime.Scheme) error
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDeepCopies ¶
func RegisterDeepCopies(scheme *runtime.Scheme) error
RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.
func RegisterDefaults ¶
func RegisterDefaults(scheme *runtime.Scheme) error
RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.
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) Descriptor ¶
func (*ExtraValue) Descriptor() ([]byte, []int)
func (*ExtraValue) ProtoMessage ¶
func (*ExtraValue) ProtoMessage()
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) Descriptor ¶
func (*TokenReview) Descriptor() ([]byte, []int)
func (*TokenReview) ProtoMessage ¶
func (*TokenReview) ProtoMessage()
func (TokenReview) SwaggerDoc ¶
func (TokenReview) SwaggerDoc() map[string]string
type TokenReviewSpec ¶
type TokenReviewSpec struct {
// Token is the opaque bearer token.
// +optional
Token string `json:"token,omitempty" protobuf:"bytes,1,opt,name=token"`
}
TokenReviewSpec is a description of the token authentication request.
func (*TokenReviewSpec) Descriptor ¶
func (*TokenReviewSpec) Descriptor() ([]byte, []int)
func (*TokenReviewSpec) ProtoMessage ¶
func (*TokenReviewSpec) ProtoMessage()
func (TokenReviewSpec) SwaggerDoc ¶
func (TokenReviewSpec) SwaggerDoc() map[string]string
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"`
// 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) Descriptor ¶
func (*TokenReviewStatus) Descriptor() ([]byte, []int)
func (*TokenReviewStatus) MarshalTo ¶
func (m *TokenReviewStatus) MarshalTo(dAtA []byte) (int, error)
func (*TokenReviewStatus) ProtoMessage ¶
func (*TokenReviewStatus) ProtoMessage()
func (TokenReviewStatus) SwaggerDoc ¶
func (TokenReviewStatus) SwaggerDoc() map[string]string
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) Descriptor ¶
func (*UserInfo) Descriptor() ([]byte, []int)
func (*UserInfo) ProtoMessage ¶
func (*UserInfo) ProtoMessage()
func (UserInfo) SwaggerDoc ¶
func (UserInfo) SwaggerDoc() map[string]string