Package io.envoyproxy.envoy.extensions.filters.http.aws_request_signing.v3

Interface AwsRequestSigningOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    AwsRequestSigning, AwsRequestSigning.Builder
    public interface AwsRequestSigningOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getHostRewrite()
      Indicates that before signing headers, the host header will be swapped with this value.
      com.google.protobuf.ByteString getHostRewriteBytes()
      Indicates that before signing headers, the host header will be swapped with this value.
      StringMatcher getMatchExcludedHeaders​(int index)
      A list of request header string matchers that will be excluded from signing.
      int getMatchExcludedHeadersCount()
      A list of request header string matchers that will be excluded from signing.
      List<StringMatcher> getMatchExcludedHeadersList()
      A list of request header string matchers that will be excluded from signing.
      StringMatcherOrBuilder getMatchExcludedHeadersOrBuilder​(int index)
      A list of request header string matchers that will be excluded from signing.
      List<? extends StringMatcherOrBuilder> getMatchExcludedHeadersOrBuilderList()
      A list of request header string matchers that will be excluded from signing.
      String getRegion()
      The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
      com.google.protobuf.ByteString getRegionBytes()
      The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP endpoint.
      String getServiceName()
      The `service namespace <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_ of the HTTP endpoint.
      com.google.protobuf.ByteString getServiceNameBytes()
      The `service namespace <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_ of the HTTP endpoint.
      boolean getUseUnsignedPayload()
      Instead of buffering the request to calculate the payload hash, use the literal string ``UNSIGNED-PAYLOAD`` to calculate the payload hash.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getServiceName

        String getServiceName()
         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
        string service_name = 1 [(.validate.rules) = { ... }
        Returns:
        The serviceName.

      • getServiceNameBytes

        com.google.protobuf.ByteString getServiceNameBytes()
         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
        string service_name = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for serviceName.

      • getRegion

        String getRegion()
         The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.
 Example: us-west-2
        string region = 2 [(.validate.rules) = { ... }
        Returns:
        The region.

      • getRegionBytes

        com.google.protobuf.ByteString getRegionBytes()
         The `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ hosting the HTTP
 endpoint.
 Example: us-west-2
        string region = 2 [(.validate.rules) = { ... }
        Returns:
        The bytes for region.

      • getHostRewrite

        String getHostRewrite()
         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.
        string host_rewrite = 3;
        Returns:
        The hostRewrite.

      • getHostRewriteBytes

        com.google.protobuf.ByteString getHostRewriteBytes()
         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.
        string host_rewrite = 3;
        Returns:
        The bytes for hostRewrite.

      • getUseUnsignedPayload

        boolean getUseUnsignedPayload()
         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.
        bool use_unsigned_payload = 4;
        Returns:
        The useUnsignedPayload.

      • getMatchExcludedHeadersList

        List<StringMatcher> getMatchExcludedHeadersList()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

      • getMatchExcludedHeaders

        StringMatcher getMatchExcludedHeaders​(int index)
         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.
        repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

      • getMatchExcludedHeadersCount

        int getMatchExcludedHeadersCount()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

      • getMatchExcludedHeadersOrBuilderList

        List<? extends StringMatcherOrBuilder> getMatchExcludedHeadersOrBuilderList()
         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.
        repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;

      • getMatchExcludedHeadersOrBuilder

        StringMatcherOrBuilder getMatchExcludedHeadersOrBuilder​(int index)
         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.
        repeated .envoy.type.matcher.v3.StringMatcher match_excluded_headers = 5;