oauth2v3

package
v0.0.0-...-c499cad Latest Latest
Warning

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

 Go to latest Published: Aug 24, 2022 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OAuth2Config_AuthType_name = map[int32]string{
		0: "URL_ENCODED_BODY",
		1: "BASIC_AUTH",
	}
	OAuth2Config_AuthType_value = map[string]int32{
		"URL_ENCODED_BODY": 0,
		"BASIC_AUTH":       1,
	}
)

Enum value maps for OAuth2Config_AuthType.

View Source 
var File_envoy_extensions_filters_http_oauth2_v3_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 

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, the first error encountered is returned, or nil if there are no violations.

func (*OAuth2) ValidateAll 

func (m *OAuth2) ValidateAll() error

ValidateAll checks the field values on OAuth2 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 OAuth2MultiError, or nil if none found.

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"`
	// Optional list of OAuth scopes to be claimed in the authorization request. If not specified,
	// defaults to "user" scope.
	// OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
	AuthScopes []string `protobuf:"bytes,9,rep,name=auth_scopes,json=authScopes,proto3" json:"auth_scopes,omitempty"`
	// Optional resource parameter for authorization request
	// RFC: https://tools.ietf.org/html/rfc8707
	Resources []string `protobuf:"bytes,10,rep,name=resources,proto3" json:"resources,omitempty"`
	// Defines how “client_id“ and “client_secret“ are sent in OAuth client to OAuth server requests.
	// RFC https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1
	AuthType OAuth2Config_AuthType `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

OAuth config

[#next-free-field: 12]

func (*OAuth2Config) Descriptor deprecated 

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

Deprecated: Use OAuth2Config.ProtoReflect.Descriptor instead.

func (*OAuth2Config) GetAuthScopes 

func (x *OAuth2Config) GetAuthScopes() []string

func (*OAuth2Config) GetAuthType 

func (x *OAuth2Config) GetAuthType() OAuth2Config_AuthType

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) GetResources 

func (x *OAuth2Config) GetResources() []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, the first error encountered is returned, or nil if there are no violations.

func (*OAuth2Config) ValidateAll 

func (m *OAuth2Config) ValidateAll() error

ValidateAll checks the field values on OAuth2Config 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 OAuth2ConfigMultiError, or nil if none found.

type OAuth2ConfigMultiError 

type OAuth2ConfigMultiError []error

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

func (OAuth2ConfigMultiError) AllErrors 

func (m OAuth2ConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OAuth2ConfigMultiError) Error 

func (m OAuth2ConfigMultiError) Error() string

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

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 

func (e OAuth2ConfigValidationError) Cause() error

Cause function returns cause value.

func (OAuth2ConfigValidationError) Error 

func (e OAuth2ConfigValidationError) Error() string

Error satisfies the builtin error interface

func (OAuth2ConfigValidationError) ErrorName 

func (e OAuth2ConfigValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2ConfigValidationError) Field 

func (e OAuth2ConfigValidationError) Field() string

Field function returns field value.

func (OAuth2ConfigValidationError) Key 

func (e OAuth2ConfigValidationError) Key() bool

Key function returns key value.

func (OAuth2ConfigValidationError) Reason 

func (e OAuth2ConfigValidationError) Reason() string

Reason function returns reason value.

type OAuth2Config_AuthType 

type OAuth2Config_AuthType int32
const (
	// The “client_id“ and “client_secret“ will be sent in the URL encoded request body.
	// This type should only be used when Auth server does not support Basic authentication.
	OAuth2Config_URL_ENCODED_BODY OAuth2Config_AuthType = 0
	// The “client_id“ and “client_secret“ will be sent using HTTP Basic authentication scheme.
	OAuth2Config_BASIC_AUTH OAuth2Config_AuthType = 1
)

func (OAuth2Config_AuthType) Descriptor 

func (OAuth2Config_AuthType) Descriptor() protoreflect.EnumDescriptor

func (OAuth2Config_AuthType) Enum 

func (x OAuth2Config_AuthType) Enum() *OAuth2Config_AuthType

func (OAuth2Config_AuthType) EnumDescriptor deprecated 

func (OAuth2Config_AuthType) EnumDescriptor() ([]byte, []int)

Deprecated: Use OAuth2Config_AuthType.Descriptor instead.

func (OAuth2Config_AuthType) Number 

func (x OAuth2Config_AuthType) Number() protoreflect.EnumNumber

func (OAuth2Config_AuthType) String 

func (x OAuth2Config_AuthType) String() string

func (OAuth2Config_AuthType) Type 

func (OAuth2Config_AuthType) Type() protoreflect.EnumType

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"`
	// The cookie names used in OAuth filters flow.
	CookieNames *OAuth2Credentials_CookieNames `protobuf:"bytes,4,opt,name=cookie_names,json=cookieNames,proto3" json:"cookie_names,omitempty"`
	// contains filtered or unexported fields
}

func (*OAuth2Credentials) Descriptor deprecated 

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

Deprecated: Use OAuth2Credentials.ProtoReflect.Descriptor instead.

func (*OAuth2Credentials) GetClientId 

func (x *OAuth2Credentials) GetClientId() string

func (*OAuth2Credentials) GetCookieNames 

func (x *OAuth2Credentials) GetCookieNames() *OAuth2Credentials_CookieNames

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, the first error encountered is returned, or nil if there are no violations.

func (*OAuth2Credentials) ValidateAll 

func (m *OAuth2Credentials) ValidateAll() error

ValidateAll checks the field values on OAuth2Credentials 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 OAuth2CredentialsMultiError, or nil if none found.

type OAuth2CredentialsMultiError 

type OAuth2CredentialsMultiError []error

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

func (OAuth2CredentialsMultiError) AllErrors 

func (m OAuth2CredentialsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OAuth2CredentialsMultiError) Error 

func (m OAuth2CredentialsMultiError) Error() string

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

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 

func (e OAuth2CredentialsValidationError) Cause() error

Cause function returns cause value.

func (OAuth2CredentialsValidationError) Error 

func (e OAuth2CredentialsValidationError) Error() string

Error satisfies the builtin error interface

func (OAuth2CredentialsValidationError) ErrorName 

func (e OAuth2CredentialsValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2CredentialsValidationError) Field 

func (e OAuth2CredentialsValidationError) Field() string

Field function returns field value.

func (OAuth2CredentialsValidationError) Key 

func (e OAuth2CredentialsValidationError) Key() bool

Key function returns key value.

func (OAuth2CredentialsValidationError) Reason 

func (e OAuth2CredentialsValidationError) Reason() string

Reason function returns reason value.

type OAuth2Credentials_CookieNames 

type OAuth2Credentials_CookieNames struct {

	// Cookie name to hold OAuth bearer token value. When the authentication server validates the
	// client and returns an authorization token back to the OAuth filter, no matter what format
	// that token is, if :ref:`forward_bearer_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.forward_bearer_token>`
	// is set to true the filter will send over the bearer token as a cookie with this name to the
	// upstream. Defaults to “BearerToken“.
	BearerToken string `protobuf:"bytes,1,opt,name=bearer_token,json=bearerToken,proto3" json:"bearer_token,omitempty"`
	// Cookie name to hold OAuth HMAC value. Defaults to “OauthHMAC“.
	OauthHmac string `protobuf:"bytes,2,opt,name=oauth_hmac,json=oauthHmac,proto3" json:"oauth_hmac,omitempty"`
	// Cookie name to hold OAuth expiry value. Defaults to “OauthExpires“.
	OauthExpires string `protobuf:"bytes,3,opt,name=oauth_expires,json=oauthExpires,proto3" json:"oauth_expires,omitempty"`
	// contains filtered or unexported fields
}

func (*OAuth2Credentials_CookieNames) Descriptor deprecated 

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

Deprecated: Use OAuth2Credentials_CookieNames.ProtoReflect.Descriptor instead.

func (*OAuth2Credentials_CookieNames) GetBearerToken 

func (x *OAuth2Credentials_CookieNames) GetBearerToken() string

func (*OAuth2Credentials_CookieNames) GetOauthExpires 

func (x *OAuth2Credentials_CookieNames) GetOauthExpires() string

func (*OAuth2Credentials_CookieNames) GetOauthHmac 

func (x *OAuth2Credentials_CookieNames) GetOauthHmac() string

func (*OAuth2Credentials_CookieNames) ProtoMessage 

func (*OAuth2Credentials_CookieNames) ProtoMessage()

func (*OAuth2Credentials_CookieNames) ProtoReflect 

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

func (*OAuth2Credentials_CookieNames) Reset 

func (x *OAuth2Credentials_CookieNames) Reset()

func (*OAuth2Credentials_CookieNames) String 

func (x *OAuth2Credentials_CookieNames) String() string

func (*OAuth2Credentials_CookieNames) Validate 

func (m *OAuth2Credentials_CookieNames) Validate() error

Validate checks the field values on OAuth2Credentials_CookieNames 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 (*OAuth2Credentials_CookieNames) ValidateAll 

func (m *OAuth2Credentials_CookieNames) ValidateAll() error

ValidateAll checks the field values on OAuth2Credentials_CookieNames 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 OAuth2Credentials_CookieNamesMultiError, or nil if none found.

type OAuth2Credentials_CookieNamesMultiError 

type OAuth2Credentials_CookieNamesMultiError []error

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

func (OAuth2Credentials_CookieNamesMultiError) AllErrors 

func (m OAuth2Credentials_CookieNamesMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OAuth2Credentials_CookieNamesMultiError) Error 

func (m OAuth2Credentials_CookieNamesMultiError) Error() string

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

type OAuth2Credentials_CookieNamesValidationError 

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

OAuth2Credentials_CookieNamesValidationError is the validation error returned by OAuth2Credentials_CookieNames.Validate if the designated constraints aren't met.

func (OAuth2Credentials_CookieNamesValidationError) Cause 

func (e OAuth2Credentials_CookieNamesValidationError) Cause() error

Cause function returns cause value.

func (OAuth2Credentials_CookieNamesValidationError) Error 

func (e OAuth2Credentials_CookieNamesValidationError) Error() string

Error satisfies the builtin error interface

func (OAuth2Credentials_CookieNamesValidationError) ErrorName 

func (e OAuth2Credentials_CookieNamesValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2Credentials_CookieNamesValidationError) Field 

func (e OAuth2Credentials_CookieNamesValidationError) Field() string

Field function returns field value.

func (OAuth2Credentials_CookieNamesValidationError) Key 

func (e OAuth2Credentials_CookieNamesValidationError) Key() bool

Key function returns key value.

func (OAuth2Credentials_CookieNamesValidationError) Reason 

func (e OAuth2Credentials_CookieNamesValidationError) Reason() string

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 OAuth2MultiError 

type OAuth2MultiError []error

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

func (OAuth2MultiError) AllErrors 

func (m OAuth2MultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OAuth2MultiError) Error 

func (m OAuth2MultiError) Error() string

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

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.

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.