Documentation
¶
Overview ¶
Package v1 is a generated protocol buffer package.
It is generated from these files:
k8s.io/api/authentication/v1/generated.proto
It has these top-level messages:
BoundObjectReference ExtraValue TokenRequest TokenRequestSpec TokenRequestStatus TokenReview TokenReviewSpec TokenReviewStatus UserInfo
Index ¶
- Variables
- type BoundObjectReference
- func (*BoundObjectReference) Descriptor() ([]byte, []int)
- func (m *BoundObjectReference) GetAPIVersion() string
- func (m *BoundObjectReference) GetKind() string
- func (m *BoundObjectReference) GetName() string
- func (m *BoundObjectReference) GetUID() string
- func (m *BoundObjectReference) Marshal() (dAtA []byte, err error)
- func (m *BoundObjectReference) MarshalTo(dAtA []byte) (int, error)
- func (*BoundObjectReference) ProtoMessage()
- func (m *BoundObjectReference) Reset()
- func (m *BoundObjectReference) Size() (n int)
- func (m *BoundObjectReference) String() string
- func (m *BoundObjectReference) Unmarshal(dAtA []byte) error
- type ExtraValue
- func (*ExtraValue) Descriptor() ([]byte, []int)
- func (m *ExtraValue) GetItems() []string
- 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 (m *ExtraValue) String() string
- func (m *ExtraValue) Unmarshal(dAtA []byte) error
- type TokenRequest
- func (*TokenRequest) Descriptor() ([]byte, []int)
- func (m *TokenRequest) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
- func (m *TokenRequest) GetSpec() *TokenRequestSpec
- func (m *TokenRequest) GetStatus() *TokenRequestStatus
- func (m *TokenRequest) Marshal() (dAtA []byte, err error)
- func (m *TokenRequest) MarshalTo(dAtA []byte) (int, error)
- func (*TokenRequest) ProtoMessage()
- func (m *TokenRequest) Reset()
- func (m *TokenRequest) Size() (n int)
- func (m *TokenRequest) String() string
- func (m *TokenRequest) Unmarshal(dAtA []byte) error
- type TokenRequestSpec
- func (*TokenRequestSpec) Descriptor() ([]byte, []int)
- func (m *TokenRequestSpec) GetAudiences() []string
- func (m *TokenRequestSpec) GetBoundObjectRef() *BoundObjectReference
- func (m *TokenRequestSpec) GetExpirationSeconds() int64
- func (m *TokenRequestSpec) Marshal() (dAtA []byte, err error)
- func (m *TokenRequestSpec) MarshalTo(dAtA []byte) (int, error)
- func (*TokenRequestSpec) ProtoMessage()
- func (m *TokenRequestSpec) Reset()
- func (m *TokenRequestSpec) Size() (n int)
- func (m *TokenRequestSpec) String() string
- func (m *TokenRequestSpec) Unmarshal(dAtA []byte) error
- type TokenRequestStatus
- func (*TokenRequestStatus) Descriptor() ([]byte, []int)
- func (m *TokenRequestStatus) GetExpirationTimestamp() *k8s_io_apimachinery_pkg_apis_meta_v1.Time
- func (m *TokenRequestStatus) GetToken() string
- func (m *TokenRequestStatus) Marshal() (dAtA []byte, err error)
- func (m *TokenRequestStatus) MarshalTo(dAtA []byte) (int, error)
- func (*TokenRequestStatus) ProtoMessage()
- func (m *TokenRequestStatus) Reset()
- func (m *TokenRequestStatus) Size() (n int)
- func (m *TokenRequestStatus) String() string
- func (m *TokenRequestStatus) Unmarshal(dAtA []byte) error
- type TokenReview
- func (*TokenReview) Descriptor() ([]byte, []int)
- func (m *TokenReview) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
- func (m *TokenReview) GetSpec() *TokenReviewSpec
- func (m *TokenReview) GetStatus() *TokenReviewStatus
- 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 (m *TokenReview) String() string
- func (m *TokenReview) Unmarshal(dAtA []byte) error
- type TokenReviewSpec
- func (*TokenReviewSpec) Descriptor() ([]byte, []int)
- func (m *TokenReviewSpec) GetToken() string
- 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 (m *TokenReviewSpec) String() string
- func (m *TokenReviewSpec) Unmarshal(dAtA []byte) error
- type TokenReviewStatus
- func (*TokenReviewStatus) Descriptor() ([]byte, []int)
- func (m *TokenReviewStatus) GetAuthenticated() bool
- func (m *TokenReviewStatus) GetError() string
- func (m *TokenReviewStatus) GetUser() *UserInfo
- 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 (m *TokenReviewStatus) String() string
- func (m *TokenReviewStatus) Unmarshal(dAtA []byte) error
- type UserInfo
- func (*UserInfo) Descriptor() ([]byte, []int)
- func (m *UserInfo) GetExtra() map[string]*ExtraValue
- func (m *UserInfo) GetGroups() []string
- func (m *UserInfo) GetUid() string
- func (m *UserInfo) GetUsername() string
- 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 (m *UserInfo) String() string
- func (m *UserInfo) Unmarshal(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type BoundObjectReference ¶ added in v1.1.0
type BoundObjectReference struct {
// Kind of the referent. Valid kinds are 'Pod' and 'Secret'.
// +optional
Kind *string `protobuf:"bytes,1,opt,name=kind" json:"kind,omitempty"`
// API version of the referent.
// +optional
APIVersion *string `protobuf:"bytes,2,opt,name=aPIVersion" json:"aPIVersion,omitempty"`
// Name of the referent.
// +optional
Name *string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
// UID of the referent.
// +optional
UID *string `protobuf:"bytes,4,opt,name=uID" json:"uID,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
BoundObjectReference is a reference to an object that a token is bound to.
func (*BoundObjectReference) Descriptor ¶ added in v1.1.0
func (*BoundObjectReference) Descriptor() ([]byte, []int)
func (*BoundObjectReference) GetAPIVersion ¶ added in v1.1.0
func (m *BoundObjectReference) GetAPIVersion() string
func (*BoundObjectReference) GetKind ¶ added in v1.1.0
func (m *BoundObjectReference) GetKind() string
func (*BoundObjectReference) GetName ¶ added in v1.1.0
func (m *BoundObjectReference) GetName() string
func (*BoundObjectReference) GetUID ¶ added in v1.1.0
func (m *BoundObjectReference) GetUID() string
func (*BoundObjectReference) Marshal ¶ added in v1.1.0
func (m *BoundObjectReference) Marshal() (dAtA []byte, err error)
func (*BoundObjectReference) MarshalTo ¶ added in v1.1.0
func (m *BoundObjectReference) MarshalTo(dAtA []byte) (int, error)
func (*BoundObjectReference) ProtoMessage ¶ added in v1.1.0
func (*BoundObjectReference) ProtoMessage()
func (*BoundObjectReference) Reset ¶ added in v1.1.0
func (m *BoundObjectReference) Reset()
func (*BoundObjectReference) Size ¶ added in v1.1.0
func (m *BoundObjectReference) Size() (n int)
func (*BoundObjectReference) String ¶ added in v1.1.0
func (m *BoundObjectReference) String() string
func (*BoundObjectReference) Unmarshal ¶ added in v1.1.0
func (m *BoundObjectReference) Unmarshal(dAtA []byte) error
type ExtraValue ¶
type ExtraValue struct {
Items []string `protobuf:"bytes,1,rep,name=items" json:"items,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
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) GetItems ¶
func (m *ExtraValue) GetItems() []string
func (*ExtraValue) Marshal ¶
func (m *ExtraValue) Marshal() (dAtA []byte, err 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 (m *ExtraValue) String() string
func (*ExtraValue) Unmarshal ¶
func (m *ExtraValue) Unmarshal(dAtA []byte) error
type TokenRequest ¶ added in v1.1.0
type TokenRequest struct {
// +optional
Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
Spec *TokenRequestSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
// +optional
Status *TokenRequestStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
TokenRequest requests a token for a given service account.
func (*TokenRequest) Descriptor ¶ added in v1.1.0
func (*TokenRequest) Descriptor() ([]byte, []int)
func (*TokenRequest) GetMetadata ¶ added in v1.1.0
func (m *TokenRequest) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
func (*TokenRequest) GetSpec ¶ added in v1.1.0
func (m *TokenRequest) GetSpec() *TokenRequestSpec
func (*TokenRequest) GetStatus ¶ added in v1.1.0
func (m *TokenRequest) GetStatus() *TokenRequestStatus
func (*TokenRequest) Marshal ¶ added in v1.1.0
func (m *TokenRequest) Marshal() (dAtA []byte, err error)
func (*TokenRequest) MarshalTo ¶ added in v1.1.0
func (m *TokenRequest) MarshalTo(dAtA []byte) (int, error)
func (*TokenRequest) ProtoMessage ¶ added in v1.1.0
func (*TokenRequest) ProtoMessage()
func (*TokenRequest) Reset ¶ added in v1.1.0
func (m *TokenRequest) Reset()
func (*TokenRequest) Size ¶ added in v1.1.0
func (m *TokenRequest) Size() (n int)
func (*TokenRequest) String ¶ added in v1.1.0
func (m *TokenRequest) String() string
func (*TokenRequest) Unmarshal ¶ added in v1.1.0
func (m *TokenRequest) Unmarshal(dAtA []byte) error
type TokenRequestSpec ¶ added in v1.1.0
type TokenRequestSpec struct {
// Audiences are the intendend audiences of the token. A recipient of a
// token must identitfy themself with an identifier in the list of
// audiences of the token, and otherwise should reject the token. A
// token issued for multiple audiences may be used to authenticate
// against any of the audiences listed but implies a high degree of
// trust between the target audiences.
Audiences []string `protobuf:"bytes,1,rep,name=audiences" json:"audiences,omitempty"`
// ExpirationSeconds is the requested duration of validity of the request. The
// token issuer may return a token with a different validity duration so a
// client needs to check the 'expiration' field in a response.
// +optional
ExpirationSeconds *int64 `protobuf:"varint,4,opt,name=expirationSeconds" json:"expirationSeconds,omitempty"`
// BoundObjectRef is a reference to an object that the token will be bound to.
// The token will only be valid for as long as the bound objet exists.
// +optional
BoundObjectRef *BoundObjectReference `protobuf:"bytes,3,opt,name=boundObjectRef" json:"boundObjectRef,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
TokenRequestSpec contains client provided parameters of a token request.
func (*TokenRequestSpec) Descriptor ¶ added in v1.1.0
func (*TokenRequestSpec) Descriptor() ([]byte, []int)
func (*TokenRequestSpec) GetAudiences ¶ added in v1.1.0
func (m *TokenRequestSpec) GetAudiences() []string
func (*TokenRequestSpec) GetBoundObjectRef ¶ added in v1.1.0
func (m *TokenRequestSpec) GetBoundObjectRef() *BoundObjectReference
func (*TokenRequestSpec) GetExpirationSeconds ¶ added in v1.1.0
func (m *TokenRequestSpec) GetExpirationSeconds() int64
func (*TokenRequestSpec) Marshal ¶ added in v1.1.0
func (m *TokenRequestSpec) Marshal() (dAtA []byte, err error)
func (*TokenRequestSpec) MarshalTo ¶ added in v1.1.0
func (m *TokenRequestSpec) MarshalTo(dAtA []byte) (int, error)
func (*TokenRequestSpec) ProtoMessage ¶ added in v1.1.0
func (*TokenRequestSpec) ProtoMessage()
func (*TokenRequestSpec) Reset ¶ added in v1.1.0
func (m *TokenRequestSpec) Reset()
func (*TokenRequestSpec) Size ¶ added in v1.1.0
func (m *TokenRequestSpec) Size() (n int)
func (*TokenRequestSpec) String ¶ added in v1.1.0
func (m *TokenRequestSpec) String() string
func (*TokenRequestSpec) Unmarshal ¶ added in v1.1.0
func (m *TokenRequestSpec) Unmarshal(dAtA []byte) error
type TokenRequestStatus ¶ added in v1.1.0
type TokenRequestStatus struct {
// Token is the opaque bearer token.
Token *string `protobuf:"bytes,1,opt,name=token" json:"token,omitempty"`
// ExpirationTimestamp is the time of expiration of the returned token.
ExpirationTimestamp *k8s_io_apimachinery_pkg_apis_meta_v1.Time `protobuf:"bytes,2,opt,name=expirationTimestamp" json:"expirationTimestamp,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
TokenRequestStatus is the result of a token request.
func (*TokenRequestStatus) Descriptor ¶ added in v1.1.0
func (*TokenRequestStatus) Descriptor() ([]byte, []int)
func (*TokenRequestStatus) GetExpirationTimestamp ¶ added in v1.1.0
func (m *TokenRequestStatus) GetExpirationTimestamp() *k8s_io_apimachinery_pkg_apis_meta_v1.Time
func (*TokenRequestStatus) GetToken ¶ added in v1.1.0
func (m *TokenRequestStatus) GetToken() string
func (*TokenRequestStatus) Marshal ¶ added in v1.1.0
func (m *TokenRequestStatus) Marshal() (dAtA []byte, err error)
func (*TokenRequestStatus) MarshalTo ¶ added in v1.1.0
func (m *TokenRequestStatus) MarshalTo(dAtA []byte) (int, error)
func (*TokenRequestStatus) ProtoMessage ¶ added in v1.1.0
func (*TokenRequestStatus) ProtoMessage()
func (*TokenRequestStatus) Reset ¶ added in v1.1.0
func (m *TokenRequestStatus) Reset()
func (*TokenRequestStatus) Size ¶ added in v1.1.0
func (m *TokenRequestStatus) Size() (n int)
func (*TokenRequestStatus) String ¶ added in v1.1.0
func (m *TokenRequestStatus) String() string
func (*TokenRequestStatus) Unmarshal ¶ added in v1.1.0
func (m *TokenRequestStatus) Unmarshal(dAtA []byte) error
type TokenReview ¶
type TokenReview struct {
// +optional
Metadata *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta `protobuf:"bytes,1,opt,name=metadata" json:"metadata,omitempty"`
// Spec holds information about the request being evaluated
Spec *TokenReviewSpec `protobuf:"bytes,2,opt,name=spec" json:"spec,omitempty"`
// Status is filled in by the server and indicates whether the request can be authenticated.
// +optional
Status *TokenReviewStatus `protobuf:"bytes,3,opt,name=status" json:"status,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
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) GetMetadata ¶
func (m *TokenReview) GetMetadata() *k8s_io_apimachinery_pkg_apis_meta_v1.ObjectMeta
func (*TokenReview) GetSpec ¶
func (m *TokenReview) GetSpec() *TokenReviewSpec
func (*TokenReview) GetStatus ¶
func (m *TokenReview) GetStatus() *TokenReviewStatus
func (*TokenReview) Marshal ¶
func (m *TokenReview) Marshal() (dAtA []byte, err 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 (m *TokenReview) String() string
func (*TokenReview) Unmarshal ¶
func (m *TokenReview) Unmarshal(dAtA []byte) error
type TokenReviewSpec ¶
type TokenReviewSpec struct {
// Token is the opaque bearer token.
// +optional
Token *string `protobuf:"bytes,1,opt,name=token" json:"token,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
TokenReviewSpec is a description of the token authentication request.
func (*TokenReviewSpec) Descriptor ¶
func (*TokenReviewSpec) Descriptor() ([]byte, []int)
func (*TokenReviewSpec) GetToken ¶
func (m *TokenReviewSpec) GetToken() string
func (*TokenReviewSpec) Marshal ¶
func (m *TokenReviewSpec) Marshal() (dAtA []byte, err 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 (m *TokenReviewSpec) String() string
func (*TokenReviewSpec) Unmarshal ¶
func (m *TokenReviewSpec) Unmarshal(dAtA []byte) error
type TokenReviewStatus ¶
type TokenReviewStatus struct {
// Authenticated indicates that the token was associated with a known user.
// +optional
Authenticated *bool `protobuf:"varint,1,opt,name=authenticated" json:"authenticated,omitempty"`
// User is the UserInfo associated with the provided token.
// +optional
User *UserInfo `protobuf:"bytes,2,opt,name=user" json:"user,omitempty"`
// Error indicates that the token couldn't be checked
// +optional
Error *string `protobuf:"bytes,3,opt,name=error" json:"error,omitempty"`
XXX_unrecognized []byte `json:"-"`
}
TokenReviewStatus is the result of the token authentication request.
func (*TokenReviewStatus) Descriptor ¶
func (*TokenReviewStatus) Descriptor() ([]byte, []int)
func (*TokenReviewStatus) GetAuthenticated ¶
func (m *TokenReviewStatus) GetAuthenticated() bool
func (*TokenReviewStatus) GetError ¶
func (m *TokenReviewStatus) GetError() string
func (*TokenReviewStatus) GetUser ¶
func (m *TokenReviewStatus) GetUser() *UserInfo
func (*TokenReviewStatus) Marshal ¶
func (m *TokenReviewStatus) Marshal() (dAtA []byte, err error)
func (*TokenReviewStatus) MarshalTo ¶
func (m *TokenReviewStatus) MarshalTo(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 (m *TokenReviewStatus) String() string
func (*TokenReviewStatus) Unmarshal ¶
func (m *TokenReviewStatus) Unmarshal(dAtA []byte) error
type UserInfo ¶
type UserInfo struct {
// The name that uniquely identifies this user among all active users.
// +optional
Username *string `protobuf:"bytes,1,opt,name=username" json:"username,omitempty"`
// 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 `protobuf:"bytes,2,opt,name=uid" json:"uid,omitempty"`
// The names of groups this user is a part of.
// +optional
Groups []string `protobuf:"bytes,3,rep,name=groups" json:"groups,omitempty"`
// Any additional information provided by the authenticator.
// +optional
Extra map[string]*ExtraValue `` /* 130-byte string literal not displayed */
XXX_unrecognized []byte `json:"-"`
}
UserInfo holds the information about the user needed to implement the user.Info interface.
func (*UserInfo) Descriptor ¶
func (*UserInfo) GetExtra ¶
func (m *UserInfo) GetExtra() map[string]*ExtraValue
func (*UserInfo) GetUsername ¶
func (*UserInfo) ProtoMessage ¶
func (*UserInfo) ProtoMessage()