credential_injectorv3

type CredentialInjector ¶

type CredentialInjector struct {

	// Whether to overwrite the value or not if the injected headers already exist.
	// Value defaults to false.
	Overwrite bool `protobuf:"varint,1,opt,name=overwrite,proto3" json:"overwrite,omitempty"`
	// Whether to fail the request if the credential is not present.
	// Value defaults to false.
	// If set to true, the request will fail with 401 Unauthorized if the credential is not present.
	FailIfNotPresent bool `protobuf:"varint,2,opt,name=fail_if_not_present,json=failIfNotPresent,proto3" json:"fail_if_not_present,omitempty"`
	// The credential to inject into the proxied requests
	// TODO add extension-category
	Credential *v3.TypedExtensionConfig `protobuf:"bytes,3,opt,name=credential,proto3" json:"credential,omitempty"`
	// contains filtered or unexported fields
}

Credential Injector injects credentials into outgoing HTTP requests. The filter configuration is used to retrieve the credentials, or they can be requested through the OAuth2 client credential grant. The credentials obtained are then injected into the Authorization header of the proxied HTTP requests, utilizing either the Basic or Bearer scheme.

If the credential is not present, the request will fail with 401 Unauthorized if fail_if_not_present is set to true.

Notice: This filter is intended to be used for workload authentication, which means that the identity associated with the inserted credential is considered as the identity of the workload behind the envoy proxy(in this case, envoy is typically deployed as a sidecar alongside that workload). Please note that this filter does not handle end user authentication. Its purpose is solely to authenticate the workload itself.

Here is an example of CredentialInjector configuration with Generic credential, which injects an HTTP Basic Auth credential into the proxied requests.

.. code-block:: yaml

overwrite: true
fail_if_not_present: true
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"

It can also be configured to inject a Bearer token into the proxied requests. 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"

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

func (x *CredentialInjector) GetCredential() *v3.TypedExtensionConfig

func (x *CredentialInjector) GetFailIfNotPresent() bool

func (x *CredentialInjector) GetOverwrite() bool

func (*CredentialInjector) ProtoMessage()

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

func (x *CredentialInjector) Reset()

func (x *CredentialInjector) String() string

func (m *CredentialInjector) Validate() error

func (m *CredentialInjector) ValidateAll() error

type CredentialInjectorMultiError ¶

type CredentialInjectorMultiError []error

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

func (m CredentialInjectorMultiError) AllErrors() []error

func (m CredentialInjectorMultiError) Error() string

type CredentialInjectorValidationError ¶

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

CredentialInjectorValidationError is the validation error returned by CredentialInjector.Validate if the designated constraints aren't met.

func (e CredentialInjectorValidationError) Cause() error

func (e CredentialInjectorValidationError) Error() string

func (e CredentialInjectorValidationError) ErrorName() string

func (e CredentialInjectorValidationError) Field() string

func (e CredentialInjectorValidationError) Key() bool

func (e CredentialInjectorValidationError) Reason() string