oauth2v3

Documentation

Index

• Variables
• type OAuth2
  • func (*OAuth2) Descriptor() ([]byte, []int)
  • func (x *OAuth2) GetClientCredentials() *OAuth2_ClientCredentials
  • func (m *OAuth2) GetFlowType() isOAuth2_FlowType
  • func (x *OAuth2) GetScopes() []string
  • func (x *OAuth2) GetTokenEndpoint() *v3.HttpUri
  • func (*OAuth2) ProtoMessage()
  • func (x *OAuth2) ProtoReflect() protoreflect.Message
  • func (x *OAuth2) Reset()
  • func (x *OAuth2) String() string
• type OAuth2_AuthType
  • func (OAuth2_AuthType) Descriptor() protoreflect.EnumDescriptor
  • func (x OAuth2_AuthType) Enum() *OAuth2_AuthType
  • func (OAuth2_AuthType) EnumDescriptor() ([]byte, []int)
  • func (x OAuth2_AuthType) Number() protoreflect.EnumNumber
  • func (x OAuth2_AuthType) String() string
  • func (OAuth2_AuthType) Type() protoreflect.EnumType
• type OAuth2_ClientCredentials
  • func (*OAuth2_ClientCredentials) Descriptor() ([]byte, []int)
  • func (x *OAuth2_ClientCredentials) GetAuthType() OAuth2_AuthType
  • func (x *OAuth2_ClientCredentials) GetClientId() string
  • func (x *OAuth2_ClientCredentials) GetClientSecret() *v31.SdsSecretConfig
  • func (*OAuth2_ClientCredentials) ProtoMessage()
  • func (x *OAuth2_ClientCredentials) ProtoReflect() protoreflect.Message
  • func (x *OAuth2_ClientCredentials) Reset()
  • func (x *OAuth2_ClientCredentials) String() string
• type OAuth2_ClientCredentials_

Variables

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.

var File_envoy_extensions_injected_credentials_oauth2_v3_oauth2_proto protoreflect.FileDescriptor

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"`
	// 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

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

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

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 `` /* 155-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

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

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"`
}