gcp_authnv3

package
v0.11.1 Latest Latest
Warning

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

 Go to latest Published: May 28, 2023 License: Apache-2.0 Imports: 20 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_filters_http_gcp_authn_v3_gcp_authn_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Audience 

type Audience struct {
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

Audience is the URL of the receiving service that performs token authentication. It will be provided to the filter through cluster's typed_filter_metadata.

func (*Audience) Descriptor deprecated 

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

Deprecated: Use Audience.ProtoReflect.Descriptor instead.

func (*Audience) GetUrl 

func (x *Audience) GetUrl() string

func (*Audience) ProtoMessage 

func (*Audience) ProtoMessage()

func (*Audience) ProtoReflect 

func (x *Audience) ProtoReflect() protoreflect.Message

func (*Audience) Reset 

func (x *Audience) Reset()

func (*Audience) String 

func (x *Audience) String() string

func (*Audience) Validate 

func (m *Audience) Validate() error

Validate checks the field values on Audience with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Audience) ValidateAll 

func (m *Audience) ValidateAll() error

ValidateAll checks the field values on Audience with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in AudienceMultiError, or nil if none found.

type AudienceMultiError 

type AudienceMultiError []error

AudienceMultiError is an error wrapping multiple validation errors returned by Audience.ValidateAll() if the designated constraints aren't met.

func (AudienceMultiError) AllErrors 

func (m AudienceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AudienceMultiError) Error 

func (m AudienceMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type AudienceValidationError 

type AudienceValidationError struct {
	// contains filtered or unexported fields
}

AudienceValidationError is the validation error returned by Audience.Validate if the designated constraints aren't met.

func (AudienceValidationError) Cause 

func (e AudienceValidationError) Cause() error

Cause function returns cause value.

func (AudienceValidationError) Error 

func (e AudienceValidationError) Error() string

Error satisfies the builtin error interface

func (AudienceValidationError) ErrorName 

func (e AudienceValidationError) ErrorName() string

ErrorName returns error name.

func (AudienceValidationError) Field 

func (e AudienceValidationError) Field() string

Field function returns field value.

func (AudienceValidationError) Key 

func (e AudienceValidationError) Key() bool

Key function returns key value.

func (AudienceValidationError) Reason 

func (e AudienceValidationError) Reason() string

Reason function returns reason value.

type GcpAuthnFilterConfig 

type GcpAuthnFilterConfig struct {

	// The HTTP URI to fetch tokens from GCE Metadata Server(https://cloud.google.com/compute/docs/metadata/overview).
	// The URL format is "http://metadata.google.internal/computeMetadata/v1/instance/service-accounts/default/identity?audience=[AUDIENCE]"
	HttpUri *v3.HttpUri `protobuf:"bytes,1,opt,name=http_uri,json=httpUri,proto3" json:"http_uri,omitempty"`
	// Retry policy for fetching tokens. This field is optional.
	RetryPolicy *v3.RetryPolicy `protobuf:"bytes,2,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
	// Token cache configuration. This field is optional.
	CacheConfig *TokenCacheConfig `protobuf:"bytes,3,opt,name=cache_config,json=cacheConfig,proto3" json:"cache_config,omitempty"`
	// Request header location to extract the token. By default (i.e. if this field is not specified), the token
	// is extracted to the Authorization HTTP header, in the format "Authorization: Bearer <token>".
	TokenHeader *TokenHeader `protobuf:"bytes,4,opt,name=token_header,json=tokenHeader,proto3" json:"token_header,omitempty"`
	// contains filtered or unexported fields
}

Filter configuration.

func (*GcpAuthnFilterConfig) Descriptor deprecated 

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

Deprecated: Use GcpAuthnFilterConfig.ProtoReflect.Descriptor instead.

func (*GcpAuthnFilterConfig) GetCacheConfig 

func (x *GcpAuthnFilterConfig) GetCacheConfig() *TokenCacheConfig

func (*GcpAuthnFilterConfig) GetHttpUri 

func (x *GcpAuthnFilterConfig) GetHttpUri() *v3.HttpUri

func (*GcpAuthnFilterConfig) GetRetryPolicy 

func (x *GcpAuthnFilterConfig) GetRetryPolicy() *v3.RetryPolicy

func (*GcpAuthnFilterConfig) GetTokenHeader added in v0.11.0 

func (x *GcpAuthnFilterConfig) GetTokenHeader() *TokenHeader

func (*GcpAuthnFilterConfig) ProtoMessage 

func (*GcpAuthnFilterConfig) ProtoMessage()

func (*GcpAuthnFilterConfig) ProtoReflect 

func (x *GcpAuthnFilterConfig) ProtoReflect() protoreflect.Message

func (*GcpAuthnFilterConfig) Reset 

func (x *GcpAuthnFilterConfig) Reset()

func (*GcpAuthnFilterConfig) String 

func (x *GcpAuthnFilterConfig) String() string

func (*GcpAuthnFilterConfig) Validate 

func (m *GcpAuthnFilterConfig) Validate() error

Validate checks the field values on GcpAuthnFilterConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*GcpAuthnFilterConfig) ValidateAll 

func (m *GcpAuthnFilterConfig) ValidateAll() error

ValidateAll checks the field values on GcpAuthnFilterConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GcpAuthnFilterConfigMultiError, or nil if none found.

type GcpAuthnFilterConfigMultiError 

type GcpAuthnFilterConfigMultiError []error

GcpAuthnFilterConfigMultiError is an error wrapping multiple validation errors returned by GcpAuthnFilterConfig.ValidateAll() if the designated constraints aren't met.

func (GcpAuthnFilterConfigMultiError) AllErrors 

func (m GcpAuthnFilterConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GcpAuthnFilterConfigMultiError) Error 

func (m GcpAuthnFilterConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GcpAuthnFilterConfigValidationError 

type GcpAuthnFilterConfigValidationError struct {
	// contains filtered or unexported fields
}

GcpAuthnFilterConfigValidationError is the validation error returned by GcpAuthnFilterConfig.Validate if the designated constraints aren't met.

func (GcpAuthnFilterConfigValidationError) Cause 

func (e GcpAuthnFilterConfigValidationError) Cause() error

Cause function returns cause value.

func (GcpAuthnFilterConfigValidationError) Error 

func (e GcpAuthnFilterConfigValidationError) Error() string

Error satisfies the builtin error interface

func (GcpAuthnFilterConfigValidationError) ErrorName 

func (e GcpAuthnFilterConfigValidationError) ErrorName() string

ErrorName returns error name.

func (GcpAuthnFilterConfigValidationError) Field 

func (e GcpAuthnFilterConfigValidationError) Field() string

Field function returns field value.

func (GcpAuthnFilterConfigValidationError) Key 

func (e GcpAuthnFilterConfigValidationError) Key() bool

Key function returns key value.

func (GcpAuthnFilterConfigValidationError) Reason 

func (e GcpAuthnFilterConfigValidationError) Reason() string

Reason function returns reason value.

type TokenCacheConfig 

type TokenCacheConfig struct {

	// The number of cache entries. The maximum number of entries is INT64_MAX as it is constrained by underlying cache implementation.
	// Default value 0 (i.e., proto3 defaults) disables the cache by default. Other default values will enable the cache.
	CacheSize *wrappers.UInt64Value `protobuf:"bytes,1,opt,name=cache_size,json=cacheSize,proto3" json:"cache_size,omitempty"`
	// contains filtered or unexported fields
}

Token Cache configuration.

func (*TokenCacheConfig) Descriptor deprecated 

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

Deprecated: Use TokenCacheConfig.ProtoReflect.Descriptor instead.

func (*TokenCacheConfig) GetCacheSize 

func (x *TokenCacheConfig) GetCacheSize() *wrappers.UInt64Value

func (*TokenCacheConfig) ProtoMessage 

func (*TokenCacheConfig) ProtoMessage()

func (*TokenCacheConfig) ProtoReflect 

func (x *TokenCacheConfig) ProtoReflect() protoreflect.Message

func (*TokenCacheConfig) Reset 

func (x *TokenCacheConfig) Reset()

func (*TokenCacheConfig) String 

func (x *TokenCacheConfig) String() string

func (*TokenCacheConfig) Validate 

func (m *TokenCacheConfig) Validate() error

Validate checks the field values on TokenCacheConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*TokenCacheConfig) ValidateAll 

func (m *TokenCacheConfig) ValidateAll() error

ValidateAll checks the field values on TokenCacheConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TokenCacheConfigMultiError, or nil if none found.

type TokenCacheConfigMultiError 

type TokenCacheConfigMultiError []error

TokenCacheConfigMultiError is an error wrapping multiple validation errors returned by TokenCacheConfig.ValidateAll() if the designated constraints aren't met.

func (TokenCacheConfigMultiError) AllErrors 

func (m TokenCacheConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TokenCacheConfigMultiError) Error 

func (m TokenCacheConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TokenCacheConfigValidationError 

type TokenCacheConfigValidationError struct {
	// contains filtered or unexported fields
}

TokenCacheConfigValidationError is the validation error returned by TokenCacheConfig.Validate if the designated constraints aren't met.

func (TokenCacheConfigValidationError) Cause 

func (e TokenCacheConfigValidationError) Cause() error

Cause function returns cause value.

func (TokenCacheConfigValidationError) Error 

func (e TokenCacheConfigValidationError) Error() string

Error satisfies the builtin error interface

func (TokenCacheConfigValidationError) ErrorName 

func (e TokenCacheConfigValidationError) ErrorName() string

ErrorName returns error name.

func (TokenCacheConfigValidationError) Field 

func (e TokenCacheConfigValidationError) Field() string

Field function returns field value.

func (TokenCacheConfigValidationError) Key 

func (e TokenCacheConfigValidationError) Key() bool

Key function returns key value.

func (TokenCacheConfigValidationError) Reason 

func (e TokenCacheConfigValidationError) Reason() string

Reason function returns reason value.

type TokenHeader added in v0.11.0 

type TokenHeader struct {

	// The HTTP header's name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The header's prefix. The format is "value_prefix<token>"
	// For example, for "Authorization: Bearer <token>", value_prefix="Bearer " with a space at the
	// end.
	ValuePrefix string `protobuf:"bytes,2,opt,name=value_prefix,json=valuePrefix,proto3" json:"value_prefix,omitempty"`
	// contains filtered or unexported fields
}

func (*TokenHeader) Descriptor deprecated added in v0.11.0 

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

Deprecated: Use TokenHeader.ProtoReflect.Descriptor instead.

func (*TokenHeader) GetName added in v0.11.0 

func (x *TokenHeader) GetName() string

func (*TokenHeader) GetValuePrefix added in v0.11.0 

func (x *TokenHeader) GetValuePrefix() string

func (*TokenHeader) ProtoMessage added in v0.11.0 

func (*TokenHeader) ProtoMessage()

func (*TokenHeader) ProtoReflect added in v0.11.0 

func (x *TokenHeader) ProtoReflect() protoreflect.Message

func (*TokenHeader) Reset added in v0.11.0 

func (x *TokenHeader) Reset()

func (*TokenHeader) String added in v0.11.0 

func (x *TokenHeader) String() string

func (*TokenHeader) Validate added in v0.11.0 

func (m *TokenHeader) Validate() error

Validate checks the field values on TokenHeader with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*TokenHeader) ValidateAll added in v0.11.0 

func (m *TokenHeader) ValidateAll() error

ValidateAll checks the field values on TokenHeader with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TokenHeaderMultiError, or nil if none found.

type TokenHeaderMultiError added in v0.11.0 

type TokenHeaderMultiError []error

TokenHeaderMultiError is an error wrapping multiple validation errors returned by TokenHeader.ValidateAll() if the designated constraints aren't met.

func (TokenHeaderMultiError) AllErrors added in v0.11.0 

func (m TokenHeaderMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TokenHeaderMultiError) Error added in v0.11.0 

func (m TokenHeaderMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TokenHeaderValidationError added in v0.11.0 

type TokenHeaderValidationError struct {
	// contains filtered or unexported fields
}

TokenHeaderValidationError is the validation error returned by TokenHeader.Validate if the designated constraints aren't met.

func (TokenHeaderValidationError) Cause added in v0.11.0 

func (e TokenHeaderValidationError) Cause() error

Cause function returns cause value.

func (TokenHeaderValidationError) Error added in v0.11.0 

func (e TokenHeaderValidationError) Error() string

Error satisfies the builtin error interface

func (TokenHeaderValidationError) ErrorName added in v0.11.0 

func (e TokenHeaderValidationError) ErrorName() string

ErrorName returns error name.

func (TokenHeaderValidationError) Field added in v0.11.0 

func (e TokenHeaderValidationError) Field() string

Field function returns field value.

func (TokenHeaderValidationError) Key added in v0.11.0 

func (e TokenHeaderValidationError) Key() bool

Key function returns key value.

func (TokenHeaderValidationError) Reason added in v0.11.0 

func (e TokenHeaderValidationError) Reason() string

Reason function returns reason value.

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.