oauth2v3

package
v0.13.1 Latest Latest
Warning

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

 Go to latest Published: Oct 15, 2024 License: Apache-2.0 Imports: 22 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

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

Enum value maps for OAuth2_AuthType.

View Source 
var File_envoy_extensions_http_injected_credentials_oauth2_v3_oauth2_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type OAuth2 

type OAuth2 struct {

	// Endpoint on the authorization server to retrieve the access token from.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-3.2) for details.
	TokenEndpoint *v3.HttpUri `protobuf:"bytes,1,opt,name=token_endpoint,json=tokenEndpoint,proto3" json:"token_endpoint,omitempty"`
	// Optional list of OAuth scopes to be claimed in the authorization request.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4.2) for details.
	Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// Types that are assignable to FlowType:
	//
	//	*OAuth2_ClientCredentials_
	FlowType isOAuth2_FlowType `protobuf_oneof:"flow_type"`
	// The interval between two successive retries to fetch token from Identity Provider. Default is 2 secs.
	// The interval must be at least 1 second.
	TokenFetchRetryInterval *durationpb.Duration `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

OAuth2 extension can be used to retrieve an OAuth2 access token from an authorization server and inject it into the proxied requests. Currently, only the Client Credentials Grant flow is supported. The access token will be injected into the request headers using the “Authorization“ header as a bearer token.

func (*OAuth2) Descriptor deprecated 

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

Deprecated: Use OAuth2.ProtoReflect.Descriptor instead.

func (*OAuth2) GetClientCredentials 

func (x *OAuth2) GetClientCredentials() *OAuth2_ClientCredentials

func (*OAuth2) GetFlowType 

func (m *OAuth2) GetFlowType() isOAuth2_FlowType

func (*OAuth2) GetScopes 

func (x *OAuth2) GetScopes() []string

func (*OAuth2) GetTokenEndpoint 

func (x *OAuth2) GetTokenEndpoint() *v3.HttpUri

func (*OAuth2) GetTokenFetchRetryInterval 

func (x *OAuth2) GetTokenFetchRetryInterval() *durationpb.Duration

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 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.

type OAuth2_AuthType 

type OAuth2_AuthType int32
const (
	// The “client_id“ and “client_secret“ will be sent using HTTP Basic authentication scheme.
	OAuth2_BASIC_AUTH OAuth2_AuthType = 0
	// 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.
	OAuth2_URL_ENCODED_BODY OAuth2_AuthType = 1
)

func (OAuth2_AuthType) Descriptor 

func (OAuth2_AuthType) Descriptor() protoreflect.EnumDescriptor

func (OAuth2_AuthType) Enum 

func (x OAuth2_AuthType) Enum() *OAuth2_AuthType

func (OAuth2_AuthType) EnumDescriptor deprecated 

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

Deprecated: Use OAuth2_AuthType.Descriptor instead.

func (OAuth2_AuthType) Number 

func (x OAuth2_AuthType) Number() protoreflect.EnumNumber

func (OAuth2_AuthType) String 

func (x OAuth2_AuthType) String() string

func (OAuth2_AuthType) Type 

func (OAuth2_AuthType) Type() protoreflect.EnumType

type OAuth2_ClientCredentials 

type OAuth2_ClientCredentials struct {

	// Client ID.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
	ClientId string `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Client secret.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
	ClientSecret *v31.SdsSecretConfig `protobuf:"bytes,2,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`
	// The method to use when sending credentials to the authorization server.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3.1) for details.
	AuthType OAuth2_AuthType `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

Credentials to authenticate client to the authorization server. Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-2.3) for details.

func (*OAuth2_ClientCredentials) Descriptor deprecated 

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

Deprecated: Use OAuth2_ClientCredentials.ProtoReflect.Descriptor instead.

func (*OAuth2_ClientCredentials) GetAuthType 

func (x *OAuth2_ClientCredentials) GetAuthType() OAuth2_AuthType

func (*OAuth2_ClientCredentials) GetClientId 

func (x *OAuth2_ClientCredentials) GetClientId() string

func (*OAuth2_ClientCredentials) GetClientSecret 

func (x *OAuth2_ClientCredentials) GetClientSecret() *v31.SdsSecretConfig

func (*OAuth2_ClientCredentials) ProtoMessage 

func (*OAuth2_ClientCredentials) ProtoMessage()

func (*OAuth2_ClientCredentials) ProtoReflect 

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

func (*OAuth2_ClientCredentials) Reset 

func (x *OAuth2_ClientCredentials) Reset()

func (*OAuth2_ClientCredentials) String 

func (x *OAuth2_ClientCredentials) String() string

func (*OAuth2_ClientCredentials) Validate 

func (m *OAuth2_ClientCredentials) Validate() error

Validate checks the field values on OAuth2_ClientCredentials 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_ClientCredentials) ValidateAll 

func (m *OAuth2_ClientCredentials) ValidateAll() error

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

type OAuth2_ClientCredentialsMultiError 

type OAuth2_ClientCredentialsMultiError []error

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

func (OAuth2_ClientCredentialsMultiError) AllErrors 

func (m OAuth2_ClientCredentialsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OAuth2_ClientCredentialsMultiError) Error 

func (m OAuth2_ClientCredentialsMultiError) Error() string

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

type OAuth2_ClientCredentialsValidationError 

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

OAuth2_ClientCredentialsValidationError is the validation error returned by OAuth2_ClientCredentials.Validate if the designated constraints aren't met.

func (OAuth2_ClientCredentialsValidationError) Cause 

func (e OAuth2_ClientCredentialsValidationError) Cause() error

Cause function returns cause value.

func (OAuth2_ClientCredentialsValidationError) Error 

func (e OAuth2_ClientCredentialsValidationError) Error() string

Error satisfies the builtin error interface

func (OAuth2_ClientCredentialsValidationError) ErrorName 

func (e OAuth2_ClientCredentialsValidationError) ErrorName() string

ErrorName returns error name.

func (OAuth2_ClientCredentialsValidationError) Field 

func (e OAuth2_ClientCredentialsValidationError) Field() string

Field function returns field value.

func (OAuth2_ClientCredentialsValidationError) Key 

func (e OAuth2_ClientCredentialsValidationError) Key() bool

Key function returns key value.

func (OAuth2_ClientCredentialsValidationError) Reason 

func (e OAuth2_ClientCredentialsValidationError) Reason() string

Reason function returns reason value.

type OAuth2_ClientCredentials_ 

type OAuth2_ClientCredentials_ struct {
	// Client Credentials Grant.
	// Refer to [RFC 6749: The OAuth 2.0 Authorization Framework](https://www.rfc-editor.org/rfc/rfc6749#section-4.4) for details.
	ClientCredentials *OAuth2_ClientCredentials `protobuf:"bytes,3,opt,name=client_credentials,json=clientCredentials,proto3,oneof"`
}

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.