envoy_extensions_filters_http_oauth2_v3alpha

package
Version: v0.9.7 Latest Latest
Warning

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

Go to latest
Published: Oct 1, 2020 License: Apache-2.0 Imports: 23 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_filters_http_oauth2_v3alpha_oauth_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type OAuth2

type OAuth2 struct {

	// Leave this empty to disable OAuth2 for a specific route, using per filter config.
	Config *OAuth2Config `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

Filter config.

func (*OAuth2) Descriptor deprecated

This method has been deprecated.
func (*OAuth2) Descriptor() ([]byte, []int)

Deprecated: Use OAuth2.ProtoReflect.Descriptor instead.

func (*OAuth2) GetConfig

func (x *OAuth2) GetConfig() *OAuth2Config

func (*OAuth2) ProtoMessage

func (*OAuth2) ProtoMessage()

func (*OAuth2) ProtoReflect

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

func (*OAuth2) Reset

func (x *OAuth2) Reset()

func (*OAuth2) String

func (x *OAuth2) String() string

func (*OAuth2) Validate

func (m *OAuth2) Validate() error

Validate checks the field values on OAuth2 with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type OAuth2Config

type OAuth2Config struct {

	// Endpoint on the authorization server to retrieve the access token from.
	TokenEndpoint *v31.HttpUri `protobuf:"bytes,1,opt,name=token_endpoint,json=tokenEndpoint,proto3" json:"token_endpoint,omitempty"`
	// The endpoint redirect to for authorization in response to unauthorized requests.
	AuthorizationEndpoint string `protobuf:"bytes,2,opt,name=authorization_endpoint,json=authorizationEndpoint,proto3" json:"authorization_endpoint,omitempty"`
	// Credentials used for OAuth.
	Credentials *OAuth2Credentials `protobuf:"bytes,3,opt,name=credentials,proto3" json:"credentials,omitempty"`
	// The redirect URI passed to the authorization endpoint. Supports header formatting
	// tokens. For more information, including details on header value syntax, see the
	// documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
	//
	// This URI should not contain any query parameters.
	RedirectUri string `protobuf:"bytes,4,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
	// Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
	RedirectPathMatcher *v32.PathMatcher `protobuf:"bytes,5,opt,name=redirect_path_matcher,json=redirectPathMatcher,proto3" json:"redirect_path_matcher,omitempty"`
	// The path to sign a user out, clearing their credential cookies.
	SignoutPath *v32.PathMatcher `protobuf:"bytes,6,opt,name=signout_path,json=signoutPath,proto3" json:"signout_path,omitempty"`
	// Forward the OAuth token as a Bearer to upstream web service.
	ForwardBearerToken bool `protobuf:"varint,7,opt,name=forward_bearer_token,json=forwardBearerToken,proto3" json:"forward_bearer_token,omitempty"`
	// Any request that matches any of the provided matchers will be passed through without OAuth validation.
	PassThroughMatcher []*v33.HeaderMatcher `protobuf:"bytes,8,rep,name=pass_through_matcher,json=passThroughMatcher,proto3" json:"pass_through_matcher,omitempty"`
	// contains filtered or unexported fields
}

OAuth config

[#next-free-field: 9]

func (*OAuth2Config) Descriptor deprecated

This method has been deprecated.
func (*OAuth2Config) Descriptor() ([]byte, []int)

Deprecated: Use OAuth2Config.ProtoReflect.Descriptor instead.

func (*OAuth2Config) GetAuthorizationEndpoint

func (x *OAuth2Config) GetAuthorizationEndpoint() string

func (*OAuth2Config) GetCredentials

func (x *OAuth2Config) GetCredentials() *OAuth2Credentials

func (*OAuth2Config) GetForwardBearerToken

func (x *OAuth2Config) GetForwardBearerToken() bool

func (*OAuth2Config) GetPassThroughMatcher

func (x *OAuth2Config) GetPassThroughMatcher() []*v33.HeaderMatcher

func (*OAuth2Config) GetRedirectPathMatcher

func (x *OAuth2Config) GetRedirectPathMatcher() *v32.PathMatcher

func (*OAuth2Config) GetRedirectUri

func (x *OAuth2Config) GetRedirectUri() string

func (*OAuth2Config) GetSignoutPath

func (x *OAuth2Config) GetSignoutPath() *v32.PathMatcher

func (*OAuth2Config) GetTokenEndpoint

func (x *OAuth2Config) GetTokenEndpoint() *v31.HttpUri

func (*OAuth2Config) ProtoMessage

func (*OAuth2Config) ProtoMessage()

func (*OAuth2Config) ProtoReflect

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

func (*OAuth2Config) Reset

func (x *OAuth2Config) Reset()

func (*OAuth2Config) String

func (x *OAuth2Config) String() string

func (*OAuth2Config) Validate

func (m *OAuth2Config) Validate() error

Validate checks the field values on OAuth2Config with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type OAuth2ConfigValidationError

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

OAuth2ConfigValidationError is the validation error returned by OAuth2Config.Validate if the designated constraints aren't met.

func (OAuth2ConfigValidationError) Cause

Cause function returns cause value.

func (OAuth2ConfigValidationError) Error

Error satisfies the builtin error interface

func (OAuth2ConfigValidationError) ErrorName

func (e OAuth2ConfigValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2ConfigValidationError) Field

Field function returns field value.

func (OAuth2ConfigValidationError) Key

Key function returns key value.

func (OAuth2ConfigValidationError) Reason

Reason function returns reason value.

type OAuth2Credentials

type OAuth2Credentials struct {

	// The client_id to be used in the authorize calls. This value will be URL encoded when sent to the OAuth server.
	ClientId string `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// The secret used to retrieve the access token. This value will be URL encoded when sent to the OAuth server.
	TokenSecret *v3.SdsSecretConfig `protobuf:"bytes,2,opt,name=token_secret,json=tokenSecret,proto3" json:"token_secret,omitempty"`
	// Configures how the secret token should be created.
	//
	// Types that are assignable to TokenFormation:
	//	*OAuth2Credentials_HmacSecret
	TokenFormation isOAuth2Credentials_TokenFormation `protobuf_oneof:"token_formation"`
	// contains filtered or unexported fields
}

func (*OAuth2Credentials) Descriptor deprecated

This method has been deprecated.
func (*OAuth2Credentials) Descriptor() ([]byte, []int)

Deprecated: Use OAuth2Credentials.ProtoReflect.Descriptor instead.

func (*OAuth2Credentials) GetClientId

func (x *OAuth2Credentials) GetClientId() string

func (*OAuth2Credentials) GetHmacSecret

func (x *OAuth2Credentials) GetHmacSecret() *v3.SdsSecretConfig

func (*OAuth2Credentials) GetTokenFormation

func (m *OAuth2Credentials) GetTokenFormation() isOAuth2Credentials_TokenFormation

func (*OAuth2Credentials) GetTokenSecret

func (x *OAuth2Credentials) GetTokenSecret() *v3.SdsSecretConfig

func (*OAuth2Credentials) ProtoMessage

func (*OAuth2Credentials) ProtoMessage()

func (*OAuth2Credentials) ProtoReflect

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

func (*OAuth2Credentials) Reset

func (x *OAuth2Credentials) Reset()

func (*OAuth2Credentials) String

func (x *OAuth2Credentials) String() string

func (*OAuth2Credentials) Validate

func (m *OAuth2Credentials) Validate() error

Validate checks the field values on OAuth2Credentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type OAuth2CredentialsValidationError

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

OAuth2CredentialsValidationError is the validation error returned by OAuth2Credentials.Validate if the designated constraints aren't met.

func (OAuth2CredentialsValidationError) Cause

Cause function returns cause value.

func (OAuth2CredentialsValidationError) Error

Error satisfies the builtin error interface

func (OAuth2CredentialsValidationError) ErrorName

ErrorName returns error name.

func (OAuth2CredentialsValidationError) Field

Field function returns field value.

func (OAuth2CredentialsValidationError) Key

Key function returns key value.

func (OAuth2CredentialsValidationError) Reason

Reason function returns reason value.

type OAuth2Credentials_HmacSecret

type OAuth2Credentials_HmacSecret struct {
	// If present, the secret token will be a HMAC using the provided secret.
	HmacSecret *v3.SdsSecretConfig `protobuf:"bytes,3,opt,name=hmac_secret,json=hmacSecret,proto3,oneof"`
}

type OAuth2ValidationError

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

OAuth2ValidationError is the validation error returned by OAuth2.Validate if the designated constraints aren't met.

func (OAuth2ValidationError) Cause

func (e OAuth2ValidationError) Cause() error

Cause function returns cause value.

func (OAuth2ValidationError) Error

func (e OAuth2ValidationError) Error() string

Error satisfies the builtin error interface

func (OAuth2ValidationError) ErrorName

func (e OAuth2ValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2ValidationError) Field

func (e OAuth2ValidationError) Field() string

Field function returns field value.

func (OAuth2ValidationError) Key

func (e OAuth2ValidationError) Key() bool

Key function returns key value.

func (OAuth2ValidationError) Reason

func (e OAuth2ValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto