aws_request_signingv3

Documentation

Index

• Variables
• type AwsRequestSigning
  • func (*AwsRequestSigning) Descriptor() ([]byte, []int)
  • func (x *AwsRequestSigning) GetHostRewrite() string
  • func (x *AwsRequestSigning) GetMatchExcludedHeaders() []*v3.StringMatcher
  • func (x *AwsRequestSigning) GetRegion() string
  • func (x *AwsRequestSigning) GetServiceName() string
  • func (x *AwsRequestSigning) GetUseUnsignedPayload() bool
  • func (*AwsRequestSigning) ProtoMessage()
  • func (x *AwsRequestSigning) ProtoReflect() protoreflect.Message
  • func (x *AwsRequestSigning) Reset()
  • func (x *AwsRequestSigning) String() string
  • func (m *AwsRequestSigning) Validate() error
  • func (m *AwsRequestSigning) ValidateAll() error
• type AwsRequestSigningMultiError
  • func (m AwsRequestSigningMultiError) AllErrors() []error
  • func (m AwsRequestSigningMultiError) Error() string
• type AwsRequestSigningValidationError
  • func (e AwsRequestSigningValidationError) Cause() error
  • func (e AwsRequestSigningValidationError) Error() string
  • func (e AwsRequestSigningValidationError) ErrorName() string
  • func (e AwsRequestSigningValidationError) Field() string
  • func (e AwsRequestSigningValidationError) Key() bool
  • func (e AwsRequestSigningValidationError) Reason() string

Variables

var File_envoy_extensions_filters_http_aws_request_signing_v3_aws_request_signing_proto protoreflect.FileDescriptor

Types

type AwsRequestSigning

type AwsRequestSigning struct {

	// The `service namespace
	// <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_
	// of the HTTP endpoint.
	//
	// Example: s3
	ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
	// endpoint.
	//
	// Example: us-west-2
	Region string `protobuf:"bytes,2,opt,name=region,proto3" json:"region,omitempty"`
	// Indicates that before signing headers, the host header will be swapped with
	// this value. If not set or empty, the original host header value
	// will be used and no rewrite will happen.
	//
	// Note: this rewrite affects both signing and host header forwarding. However, this
	// option shouldn't be used with
	// :ref:`HCM host rewrite <envoy_v3_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
	// value set here would be used for signing whereas the value set in the HCM would be used
	// for host header forwarding which is not the desired outcome.
	HostRewrite string `protobuf:"bytes,3,opt,name=host_rewrite,json=hostRewrite,proto3" json:"host_rewrite,omitempty"`
	// Instead of buffering the request to calculate the payload hash, use the literal string “UNSIGNED-PAYLOAD“
	// to calculate the payload hash. Not all services support this option. See the `S3
	// <https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-header-based-auth.html>`_ policy for details.
	UseUnsignedPayload bool `protobuf:"varint,4,opt,name=use_unsigned_payload,json=useUnsignedPayload,proto3" json:"use_unsigned_payload,omitempty"`
	// A list of request header string matchers that will be excluded from signing. The excluded header can be matched by
	// any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc).
	//
	// Example:
	// match_excluded_headers:
	// - prefix: x-envoy
	// - exact: foo
	// - exact: bar
	// When applied, all headers that start with "x-envoy" and headers "foo" and "bar" will not be signed.
	MatchExcludedHeaders []*v3.StringMatcher `protobuf:"bytes,5,rep,name=match_excluded_headers,json=matchExcludedHeaders,proto3" json:"match_excluded_headers,omitempty"`
	// contains filtered or unexported fields
}

Top level configuration for the AWS request signing filter. [#next-free-field: 6]

func (*AwsRequestSigning) Descriptor

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

Deprecated: Use AwsRequestSigning.ProtoReflect.Descriptor instead.

func (*AwsRequestSigning) GetHostRewrite

func (x *AwsRequestSigning) GetHostRewrite() string

func (*AwsRequestSigning) GetMatchExcludedHeaders

func (x *AwsRequestSigning) GetMatchExcludedHeaders() []*v3.StringMatcher

func (*AwsRequestSigning) GetRegion

func (x *AwsRequestSigning) GetRegion() string

func (*AwsRequestSigning) GetServiceName

func (x *AwsRequestSigning) GetServiceName() string

func (*AwsRequestSigning) GetUseUnsignedPayload

func (x *AwsRequestSigning) GetUseUnsignedPayload() bool

func (*AwsRequestSigning) ProtoMessage

func (*AwsRequestSigning) ProtoMessage()

func (*AwsRequestSigning) ProtoReflect

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

func (*AwsRequestSigning) Reset

func (x *AwsRequestSigning) Reset()

func (*AwsRequestSigning) String

func (x *AwsRequestSigning) String() string

func (*AwsRequestSigning) Validate

func (m *AwsRequestSigning) Validate() error

Validate checks the field values on AwsRequestSigning 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 (*AwsRequestSigning) ValidateAll

func (m *AwsRequestSigning) ValidateAll() error

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

type AwsRequestSigningMultiError

type AwsRequestSigningMultiError []error

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

func (AwsRequestSigningMultiError) AllErrors

func (m AwsRequestSigningMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AwsRequestSigningMultiError) Error

func (m AwsRequestSigningMultiError) Error() string

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

type AwsRequestSigningValidationError

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

AwsRequestSigningValidationError is the validation error returned by AwsRequestSigning.Validate if the designated constraints aren't met.

func (AwsRequestSigningValidationError) Cause

func (e AwsRequestSigningValidationError) Cause() error

Cause function returns cause value.

func (AwsRequestSigningValidationError) Error

func (e AwsRequestSigningValidationError) Error() string

Error satisfies the builtin error interface

func (AwsRequestSigningValidationError) ErrorName

func (e AwsRequestSigningValidationError) ErrorName() string

ErrorName returns error name.

func (AwsRequestSigningValidationError) Field

func (e AwsRequestSigningValidationError) Field() string

Field function returns field value.

func (AwsRequestSigningValidationError) Key

func (e AwsRequestSigningValidationError) Key() bool

Key function returns key value.

func (AwsRequestSigningValidationError) Reason

func (e AwsRequestSigningValidationError) Reason() string

Reason function returns reason value.