Documentation
¶
Index ¶
- Variables
- type Generic
- func (*Generic) Descriptor() ([]byte, []int)deprecated
- func (x *Generic) GetCredential() *v3.SdsSecretConfig
- func (x *Generic) GetHeader() string
- func (*Generic) ProtoMessage()
- func (x *Generic) ProtoReflect() protoreflect.Message
- func (x *Generic) Reset()
- func (x *Generic) String() string
- func (m *Generic) Validate() error
- func (m *Generic) ValidateAll() error
- type GenericMultiError
- type GenericValidationError
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_injected_credentials_generic_v3_generic_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
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) Descriptor
deprecated
func (*Generic) GetCredential ¶
func (x *Generic) GetCredential() *v3.SdsSecretConfig
func (*Generic) ProtoMessage ¶
func (*Generic) ProtoMessage()
func (*Generic) ProtoReflect ¶
func (x *Generic) ProtoReflect() protoreflect.Message
func (*Generic) Validate ¶
Validate checks the field values on Generic 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 (*Generic) ValidateAll ¶
ValidateAll checks the field values on Generic 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 GenericMultiError, or nil if none found.
type GenericMultiError ¶
type GenericMultiError []error
GenericMultiError is an error wrapping multiple validation errors returned by Generic.ValidateAll() if the designated constraints aren't met.
func (GenericMultiError) AllErrors ¶
func (m GenericMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (GenericMultiError) Error ¶
func (m GenericMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type GenericValidationError ¶
type GenericValidationError struct {
// contains filtered or unexported fields
}
GenericValidationError is the validation error returned by Generic.Validate if the designated constraints aren't met.
func (GenericValidationError) Cause ¶
func (e GenericValidationError) Cause() error
Cause function returns cause value.
func (GenericValidationError) Error ¶
func (e GenericValidationError) Error() string
Error satisfies the builtin error interface
func (GenericValidationError) ErrorName ¶
func (e GenericValidationError) ErrorName() string
ErrorName returns error name.
func (GenericValidationError) Field ¶
func (e GenericValidationError) Field() string
Field function returns field value.
func (GenericValidationError) Key ¶
func (e GenericValidationError) Key() bool
Key function returns key value.
func (GenericValidationError) Reason ¶
func (e GenericValidationError) Reason() string
Reason function returns reason value.
Source Files