genericv3

Documentation

Index

• Variables
• type Generic
  • func (x *Generic) ClearCredential()
  • func (x *Generic) GetCredential() *v3.SdsSecretConfig
  • func (x *Generic) GetHeader() string
  • func (x *Generic) HasCredential() bool
  • func (*Generic) ProtoMessage()
  • func (x *Generic) ProtoReflect() protoreflect.Message
  • func (x *Generic) Reset()
  • func (x *Generic) SetCredential(v *v3.SdsSecretConfig)
  • func (x *Generic) SetHeader(v string)
  • func (x *Generic) String() string
• type Generic_builder
  • func (b0 Generic_builder) Build() *Generic

Variables

var File_envoy_extensions_injected_credentials_generic_v3_generic_proto protoreflect.FileDescriptor

Types

type Generic

type Generic struct {

	// The SDS configuration for the credential that will be injected to the specified HTTP request header.
	// It must be a generic secret.
	Credential *v3.SdsSecretConfig `protobuf:"bytes,1,opt,name=credential,proto3" json:"credential,omitempty"`
	// The header that will be injected to the HTTP request with the provided credential.
	// If not set, filter will default to: “Authorization“
	Header string `protobuf:"bytes,2,opt,name=header,proto3" json:"header,omitempty"`
	// contains filtered or unexported fields
}

Generic extension can be used to inject HTTP Basic Auth, Bearer Token, or any arbitrary credential into the proxied requests. The credential will be injected into the specified HTTP request header. Example:

.. code-block:: yaml

credential:
  name: generic_credential
  typed_config:
    "@type": type.googleapis.com/envoy.extensions.injected_credentials.generic.v3.Generic
    credential:
      name: credential
      sds_config:
        path_config_source:
          path: credential.yaml
    header: Authorization

credential.yaml for Basic Auth:

.. code-block:: yaml

resources:
- "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret"
  name: credential
  generic_secret:
    secret:
      inline_string: "Basic base64EncodedUsernamePassword"

Refer to [RFC 7617: The 'Basic' HTTP Authentication Scheme](https://www.rfc-editor.org/rfc/rfc7617) for details.

credential.yaml for Bearer Token:

.. code-block:: yaml
resources:
- "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret"
  name: credential
  generic_secret:
    secret:
      inline_string: "Bearer myToken"

Refer to [RFC 6750: The OAuth 2.0 Authorization Framework: Bearer Token Usage](https://www.rfc-editor.org/rfc/rfc6750) for details.

func (*Generic) ClearCredential

func (x *Generic) ClearCredential()

func (*Generic) GetCredential

func (x *Generic) GetCredential() *v3.SdsSecretConfig

func (*Generic) GetHeader

func (x *Generic) GetHeader() string

func (*Generic) HasCredential

func (x *Generic) HasCredential() bool

func (*Generic) ProtoMessage

func (*Generic) ProtoMessage()

func (*Generic) ProtoReflect

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

func (*Generic) Reset

func (x *Generic) Reset()

func (*Generic) SetCredential

func (x *Generic) SetCredential(v *v3.SdsSecretConfig)

func (*Generic) SetHeader

func (x *Generic) SetHeader(v string)

func (*Generic) String

func (x *Generic) String() string

type Generic_builder

type Generic_builder struct {

	// The SDS configuration for the credential that will be injected to the specified HTTP request header.
	// It must be a generic secret.
	Credential *v3.SdsSecretConfig
	// The header that will be injected to the HTTP request with the provided credential.
	// If not set, filter will default to: “Authorization“
	Header string
	// contains filtered or unexported fields
}

func (Generic_builder) Build

func (b0 Generic_builder) Build() *Generic