Class AwsRequestSigning
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,AwsRequestSigningOrBuilder,Serializable
public final class AwsRequestSigning
extends com.google.protobuf.GeneratedMessageV3
implements AwsRequestSigningOrBuilder
Top level configuration for the AWS request signing filter. [#next-free-field: 10]Protobuf type
envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classTop level configuration for the AWS request signing filter.static final classProtobuf typeenvoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryStringstatic interfacestatic enumProtobuf enumenvoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithmNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe credential provider for signing the request.The credential provider for signing the request.static AwsRequestSigningstatic final com.google.protobuf.Descriptors.DescriptorIndicates that before signing headers, the host header will be swapped with this value.com.google.protobuf.ByteStringIndicates that before signing headers, the host header will be swapped with this value.getMatchExcludedHeaders(int index) A list of request header string matchers that will be excluded from signing.intA list of request header string matchers that will be excluded from signing.A list of request header string matchers that will be excluded from signing.getMatchExcludedHeadersOrBuilder(int index) A list of request header string matchers that will be excluded from signing.List<? extends StringMatcherOrBuilder>A list of request header string matchers that will be excluded from signing.getMatchIncludedHeaders(int index) A list of request header string matchers that will be included during signing.intA list of request header string matchers that will be included during signing.A list of request header string matchers that will be included during signing.getMatchIncludedHeadersOrBuilder(int index) A list of request header string matchers that will be included during signing.List<? extends StringMatcherOrBuilder>A list of request header string matchers that will be included during signing.com.google.protobuf.Parser<AwsRequestSigning>If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers.If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers.Optional region string.com.google.protobuf.ByteStringOptional region string.intThe `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.ByteStringThe `service namespace <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces>`_ of the HTTP endpoint.Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.intOptional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.booleanInstead of buffering the request to calculate the payload hash, use the literal string ``UNSIGNED-PAYLOAD`` to calculate the payload hash.booleanThe credential provider for signing the request.inthashCode()booleanIf set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic AwsRequestSigning.Builderstatic AwsRequestSigning.BuildernewBuilder(AwsRequestSigning prototype) protected AwsRequestSigning.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static AwsRequestSigningparseDelimitedFrom(InputStream input) static AwsRequestSigningparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AwsRequestSigningparseFrom(byte[] data) static AwsRequestSigningparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AwsRequestSigningparseFrom(com.google.protobuf.ByteString data) static AwsRequestSigningparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AwsRequestSigningparseFrom(com.google.protobuf.CodedInputStream input) static AwsRequestSigningparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AwsRequestSigningparseFrom(InputStream input) static AwsRequestSigningparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static AwsRequestSigningparseFrom(ByteBuffer data) static AwsRequestSigningparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<AwsRequestSigning>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SERVICE_NAME_FIELD_NUMBER
public static final int SERVICE_NAME_FIELD_NUMBER- See Also:
-
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER- See Also:
-
HOST_REWRITE_FIELD_NUMBER
public static final int HOST_REWRITE_FIELD_NUMBER- See Also:
-
USE_UNSIGNED_PAYLOAD_FIELD_NUMBER
public static final int USE_UNSIGNED_PAYLOAD_FIELD_NUMBER- See Also:
-
MATCH_EXCLUDED_HEADERS_FIELD_NUMBER
public static final int MATCH_EXCLUDED_HEADERS_FIELD_NUMBER- See Also:
-
SIGNING_ALGORITHM_FIELD_NUMBER
public static final int SIGNING_ALGORITHM_FIELD_NUMBER- See Also:
-
QUERY_STRING_FIELD_NUMBER
public static final int QUERY_STRING_FIELD_NUMBER- See Also:
-
CREDENTIAL_PROVIDER_FIELD_NUMBER
public static final int CREDENTIAL_PROVIDER_FIELD_NUMBER- See Also:
-
MATCH_INCLUDED_HEADERS_FIELD_NUMBER
public static final int MATCH_INCLUDED_HEADERS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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) = { ... }- Specified by:
getServiceNamein interfaceAwsRequestSigningOrBuilder- Returns:
- The serviceName.
-
getServiceNameBytes
public 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) = { ... }- Specified by:
getServiceNameBytesin interfaceAwsRequestSigningOrBuilder- Returns:
- The bytes for serviceName.
-
getRegion
Optional region string. If region is not provided, the region will be retrieved from the environment or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details. When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service hosting the HTTP endpoint. Example: ``us-west-2`` When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set. A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*`` or even region strings containing wildcards such as ``us-east-*`` Example: ``'*'`` By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being valid for only a single region destination.
string region = 2;- Specified by:
getRegionin interfaceAwsRequestSigningOrBuilder- Returns:
- The region.
-
getRegionBytes
public com.google.protobuf.ByteString getRegionBytes()Optional region string. If region is not provided, the region will be retrieved from the environment or AWS configuration files. See :ref:`config_http_filters_aws_request_signing_region` for more details. When signing_algorithm is set to ``AWS_SIGV4`` the region is a standard AWS `region <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ string for the service hosting the HTTP endpoint. Example: ``us-west-2`` When signing_algorithm is set to ``AWS_SIGV4A`` the region is used as a region set. A region set is a comma separated list of AWS regions, such as ``us-east-1,us-east-2`` or wildcard ``*`` or even region strings containing wildcards such as ``us-east-*`` Example: ``'*'`` By configuring a region set, a SigV4A signed request can be sent to multiple regions, rather than being valid for only a single region destination.
string region = 2;- Specified by:
getRegionBytesin interfaceAwsRequestSigningOrBuilder- Returns:
- The bytes for region.
-
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;- Specified by:
getHostRewritein interfaceAwsRequestSigningOrBuilder- Returns:
- The hostRewrite.
-
getHostRewriteBytes
public 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;- Specified by:
getHostRewriteBytesin interfaceAwsRequestSigningOrBuilder- Returns:
- The bytes for hostRewrite.
-
getUseUnsignedPayload
public 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;- Specified by:
getUseUnsignedPayloadin interfaceAwsRequestSigningOrBuilder- Returns:
- The useUnsignedPayload.
-
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: .. code-block:: yaml 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;- Specified by:
getMatchExcludedHeadersListin interfaceAwsRequestSigningOrBuilder
-
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: .. code-block:: yaml 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;- Specified by:
getMatchExcludedHeadersOrBuilderListin interfaceAwsRequestSigningOrBuilder
-
getMatchExcludedHeadersCount
public 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: .. code-block:: yaml 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;- Specified by:
getMatchExcludedHeadersCountin interfaceAwsRequestSigningOrBuilder
-
getMatchExcludedHeaders
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: .. code-block:: yaml 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;- Specified by:
getMatchExcludedHeadersin interfaceAwsRequestSigningOrBuilder
-
getMatchExcludedHeadersOrBuilder
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: .. code-block:: yaml 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;- Specified by:
getMatchExcludedHeadersOrBuilderin interfaceAwsRequestSigningOrBuilder
-
getSigningAlgorithmValue
public int getSigningAlgorithmValue()Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;- Specified by:
getSigningAlgorithmValuein interfaceAwsRequestSigningOrBuilder- Returns:
- The enum numeric value on the wire for signingAlgorithm.
-
getSigningAlgorithm
Optional Signing algorithm specifier, either ``AWS_SIGV4`` or ``AWS_SIGV4A``, defaulting to ``AWS_SIGV4``.
.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.SigningAlgorithm signing_algorithm = 6;- Specified by:
getSigningAlgorithmin interfaceAwsRequestSigningOrBuilder- Returns:
- The signingAlgorithm.
-
hasQueryString
public boolean hasQueryString()If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string`` is configured. Example: query_string: {}.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;- Specified by:
hasQueryStringin interfaceAwsRequestSigningOrBuilder- Returns:
- Whether the queryString field is set.
-
getQueryString
If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string`` is configured. Example: query_string: {}.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;- Specified by:
getQueryStringin interfaceAwsRequestSigningOrBuilder- Returns:
- The queryString.
-
getQueryStringOrBuilder
If set, use the query string to store output of SigV4 or SigV4A calculation, rather than HTTP headers. The ``Authorization`` header will not be modified if ``query_string`` is configured. Example: query_string: {}.envoy.extensions.filters.http.aws_request_signing.v3.AwsRequestSigning.QueryString query_string = 7;- Specified by:
getQueryStringOrBuilderin interfaceAwsRequestSigningOrBuilder
-
hasCredentialProvider
public boolean hasCredentialProvider()The credential provider for signing the request. This is optional and if not set, it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
.envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;- Specified by:
hasCredentialProviderin interfaceAwsRequestSigningOrBuilder- Returns:
- Whether the credentialProvider field is set.
-
getCredentialProvider
The credential provider for signing the request. This is optional and if not set, it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
.envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;- Specified by:
getCredentialProviderin interfaceAwsRequestSigningOrBuilder- Returns:
- The credentialProvider.
-
getCredentialProviderOrBuilder
The credential provider for signing the request. This is optional and if not set, it will be retrieved using the procedure described in :ref:`config_http_filters_aws_request_signing`.
.envoy.extensions.common.aws.v3.AwsCredentialProvider credential_provider = 8;- Specified by:
getCredentialProviderOrBuilderin interfaceAwsRequestSigningOrBuilder
-
getMatchIncludedHeadersList
A list of request header string matchers that will be included during signing. The included header can be matched by any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc). match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored. Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_. Example: .. code-block:: yaml match_included_headers: - prefix: x-envoy - exact: foo - exact: bar When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;- Specified by:
getMatchIncludedHeadersListin interfaceAwsRequestSigningOrBuilder
-
getMatchIncludedHeadersOrBuilderList
A list of request header string matchers that will be included during signing. The included header can be matched by any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc). match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored. Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_. Example: .. code-block:: yaml match_included_headers: - prefix: x-envoy - exact: foo - exact: bar When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;- Specified by:
getMatchIncludedHeadersOrBuilderListin interfaceAwsRequestSigningOrBuilder
-
getMatchIncludedHeadersCount
public int getMatchIncludedHeadersCount()A list of request header string matchers that will be included during signing. The included header can be matched by any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc). match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored. Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_. Example: .. code-block:: yaml match_included_headers: - prefix: x-envoy - exact: foo - exact: bar When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;- Specified by:
getMatchIncludedHeadersCountin interfaceAwsRequestSigningOrBuilder
-
getMatchIncludedHeaders
A list of request header string matchers that will be included during signing. The included header can be matched by any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc). match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored. Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_. Example: .. code-block:: yaml match_included_headers: - prefix: x-envoy - exact: foo - exact: bar When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;- Specified by:
getMatchIncludedHeadersin interfaceAwsRequestSigningOrBuilder
-
getMatchIncludedHeadersOrBuilder
A list of request header string matchers that will be included during signing. The included header can be matched by any patterns defined in the StringMatcher proto (e.g. exact string, prefix, regex, etc). match_included_headers takes precedence over match_excluded_headers - if match_included_headers is set, only those headers will be signed and match_excluded_headers will be ignored. Required headers for signing such as ``host`` will always be signed regardless of this setting. The required headers are determined via ``CanonicalHeaders`` section in the AWS documentation `here <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-create-signed-request.html#create-canonical-request>`_. Example: .. code-block:: yaml match_included_headers: - prefix: x-envoy - exact: foo - exact: bar When applied, all headers that start with ``x-envoy`` and headers ``foo`` and ``bar`` will be signed and all other headers will be excluded from signing except required headers.
repeated .envoy.type.matcher.v3.StringMatcher match_included_headers = 9;- Specified by:
getMatchIncludedHeadersOrBuilderin interfaceAwsRequestSigningOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static AwsRequestSigning parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AwsRequestSigning parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AwsRequestSigning parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AwsRequestSigning parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AwsRequestSigning parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static AwsRequestSigning parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static AwsRequestSigning parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static AwsRequestSigning parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static AwsRequestSigning parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static AwsRequestSigning parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AwsRequestSigning.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-