authentication

Documentation

Overview

+k8s:deepcopy-gen=package,register +groupName=authentication.k8s.io +k8s:openapi-gen=true

Index

• Constants
• Variables
• func DeepCopy_authentication_TokenReview(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_authentication_TokenReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_authentication_TokenReviewStatus(in interface{}, out interface{}, c *conversion.Cloner) error
• func DeepCopy_authentication_UserInfo(in interface{}, out interface{}, c *conversion.Cloner) error
• func Kind(kind string) unversioned.GroupKind
• func RegisterDeepCopies(scheme *runtime.Scheme) error
• func Resource(resource string) unversioned.GroupResource
• type ExtraValue
  • func (x *ExtraValue) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x ExtraValue) CodecEncodeSelf(e *codec1978.Encoder)
• type TokenReview
  • func (x *TokenReview) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *TokenReview) CodecEncodeSelf(e *codec1978.Encoder)
• type TokenReviewSpec
  • func (x *TokenReviewSpec) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *TokenReviewSpec) CodecEncodeSelf(e *codec1978.Encoder)
• type TokenReviewStatus
  • func (x *TokenReviewStatus) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *TokenReviewStatus) CodecEncodeSelf(e *codec1978.Encoder)
• type UserInfo
  • func (x *UserInfo) CodecDecodeSelf(d *codec1978.Decoder)
  • func (x *UserInfo) CodecEncodeSelf(e *codec1978.Encoder)

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 (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = unversioned.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func DeepCopy_authentication_TokenReview

func DeepCopy_authentication_TokenReview(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_authentication_TokenReviewSpec

func DeepCopy_authentication_TokenReviewSpec(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_authentication_TokenReviewStatus

func DeepCopy_authentication_TokenReviewStatus(in interface{}, out interface{}, c *conversion.Cloner) error

func DeepCopy_authentication_UserInfo

func DeepCopy_authentication_UserInfo(in interface{}, out interface{}, c *conversion.Cloner) error

func Kind

func Kind(kind string) unversioned.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func Resource

func Resource(resource string) unversioned.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

func (*ExtraValue) CodecDecodeSelf

func (x *ExtraValue) CodecDecodeSelf(d *codec1978.Decoder)

func (ExtraValue) CodecEncodeSelf

func (x ExtraValue) CodecEncodeSelf(e *codec1978.Encoder)

type TokenReview

type TokenReview struct {
	unversioned.TypeMeta
	// ObjectMeta fulfills the meta.ObjectMetaAccessor interface so that the stock
	// REST handler paths work
	api.ObjectMeta

	// Spec holds information about the request being evaluated
	Spec TokenReviewSpec

	// Status is filled in by the server and indicates whether the request can be authenticated.
	Status TokenReviewStatus
}

TokenReview attempts to authenticate a token to a known user.

func (*TokenReview) CodecDecodeSelf

func (x *TokenReview) CodecDecodeSelf(d *codec1978.Decoder)

func (*TokenReview) CodecEncodeSelf

func (x *TokenReview) CodecEncodeSelf(e *codec1978.Encoder)

type TokenReviewSpec

type TokenReviewSpec struct {
	// Token is the opaque bearer token.
	Token string
}

TokenReviewSpec is a description of the token authentication request.

func (*TokenReviewSpec) CodecDecodeSelf

func (x *TokenReviewSpec) CodecDecodeSelf(d *codec1978.Decoder)

func (*TokenReviewSpec) CodecEncodeSelf

func (x *TokenReviewSpec) CodecEncodeSelf(e *codec1978.Encoder)

type TokenReviewStatus

type TokenReviewStatus struct {
	// Authenticated indicates that the token was associated with a known user.
	Authenticated bool
	// User is the UserInfo associated with the provided token.
	User UserInfo
	// Error indicates that the token couldn't be checked
	Error string
}

TokenReviewStatus is the result of the token authentication request. This type mirrors the authentication.Token interface

func (*TokenReviewStatus) CodecDecodeSelf

func (x *TokenReviewStatus) CodecDecodeSelf(d *codec1978.Decoder)

func (*TokenReviewStatus) CodecEncodeSelf

func (x *TokenReviewStatus) CodecEncodeSelf(e *codec1978.Encoder)

type UserInfo

type UserInfo struct {
	// The name that uniquely identifies this user among all active users.
	Username string
	// 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.
	UID string
	// The names of groups this user is a part of.
	Groups []string
	// Any additional information provided by the authenticator.
	Extra map[string]ExtraValue
}

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

func (*UserInfo) CodecDecodeSelf

func (x *UserInfo) CodecDecodeSelf(d *codec1978.Decoder)

func (*UserInfo) CodecEncodeSelf

func (x *UserInfo) CodecEncodeSelf(e *codec1978.Encoder)