Decompressor

This extension may be referenced by the qualified name envoy.filters.http.decompressor

Note

This extension is intended to be robust against both untrusted downstream and upstream traffic.

Tip

This extension extends and can be used with the following extension category:

extensions.filters.http.decompressor.v3.Decompressor

[extensions.filters.http.decompressor.v3.Decompressor proto]

{
  "decompressor_library": "{...}",
  "request_direction_config": "{...}",
  "response_direction_config": "{...}"
}
decompressor_library

(config.core.v3.TypedExtensionConfig, REQUIRED) A decompressor library to use for both request and response decompression. Currently only envoy.compression.gzip.compressor is included in Envoy.

Tip

This extension category has the following known extensions:

request_direction_config

(extensions.filters.http.decompressor.v3.Decompressor.RequestDirectionConfig) Configuration for request decompression. Decompression is enabled by default if left empty.

response_direction_config

(extensions.filters.http.decompressor.v3.Decompressor.ResponseDirectionConfig) Configuration for response decompression. Decompression is enabled by default if left empty.

extensions.filters.http.decompressor.v3.Decompressor.CommonDirectionConfig

[extensions.filters.http.decompressor.v3.Decompressor.CommonDirectionConfig proto]

Common configuration for filter behavior on both the request and response direction.

{
  "enabled": "{...}",
  "ignore_no_transform_header": "..."
}
enabled

(config.core.v3.RuntimeFeatureFlag) Runtime flag that controls whether the filter is enabled for decompression or not. If set to false, the filter will operate as a pass-through filter. If the message is unspecified, the filter will be enabled.

ignore_no_transform_header

(bool) If set to true, will decompress response even if a no-transform cache control header is set.

extensions.filters.http.decompressor.v3.Decompressor.RequestDirectionConfig

[extensions.filters.http.decompressor.v3.Decompressor.RequestDirectionConfig proto]

Configuration for filter behavior on the request direction.

{
  "common_config": "{...}",
  "advertise_accept_encoding": "{...}"
}
common_config

(extensions.filters.http.decompressor.v3.Decompressor.CommonDirectionConfig)

advertise_accept_encoding

(BoolValue) If set to true, and response decompression is enabled, the filter modifies the Accept-Encoding request header by appending the decompressor_library’s encoding. Defaults to true.

extensions.filters.http.decompressor.v3.Decompressor.ResponseDirectionConfig

[extensions.filters.http.decompressor.v3.Decompressor.ResponseDirectionConfig proto]

Configuration for filter behavior on the response direction.

{
  "common_config": "{...}"
}
common_config

(extensions.filters.http.decompressor.v3.Decompressor.CommonDirectionConfig)