Set-Metadata HTTP filter #16400
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # DO NOT EDIT. This file is generated by tools/proto_format/proto_sync.py. | ||
|
|
||
| load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package") | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| api_proto_package( | ||
| deps = ["@com_github_cncf_udpa//udpa/annotations:pkg"], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.extensions.filters.http.set_metadata.v3; | ||
|
|
||
| import "google/protobuf/struct.proto"; | ||
|
|
||
| import "udpa/annotations/migrate.proto"; | ||
|
aguinet marked this conversation as resolved.
Outdated
|
||
| import "udpa/annotations/status.proto"; | ||
| import "udpa/annotations/versioning.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.extensions.filters.http.set_metadata.v3"; | ||
| option java_outer_classname = "SetMetadataProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Set-Metadata Filter] | ||
| // | ||
| // This filters adds or updates dynamic metadata with static data. | ||
| // | ||
| // [#extension: envoy.filters.http.set_metadata] | ||
|
|
||
| message Config { | ||
| // The metadata namespace. | ||
| string metadata_namespace = 1 [(validate.rules).string = {min_len: 1}]; | ||
|
|
||
| // The value to update the namespace with. | ||
|
Member
There was a problem hiding this comment. RST link to docs providing details of the merge semantics. |
||
| google.protobuf.Struct value = 2; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| admin: | ||
| address: | ||
| socket_address: | ||
| protocol: TCP | ||
| address: 0.0.0.0 | ||
| port_value: 9901 | ||
| static_resources: | ||
| listeners: | ||
| - name: listener_0 | ||
| address: | ||
| socket_address: | ||
| protocol: TCP | ||
| address: 0.0.0.0 | ||
| port_value: 10000 | ||
| filter_chains: | ||
| - filters: | ||
| - name: envoy.filters.network.http_connection_manager | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager | ||
| stat_prefix: ingress_http | ||
| access_log: | ||
| - name: envoy.access_loggers.file | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.access_loggers.file.v3.FileAccessLog | ||
| path: /dev/stdout | ||
| log_format: | ||
| text_format_source: | ||
| inline_string: | | ||
| [%START_TIME%] "%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%" %RESPONSE_CODE% %RESPONSE_FLAGS% %BYTES_RECEIVED% %BYTES_SENT% %DURATION% %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% "%REQ(X-FORWARDED-FOR)%" "%REQ(USER-AGENT)%" "%REQ(X-REQUEST-ID)%" "%REQ(:AUTHORITY)%" '%DYNAMIC_METADATA(curiefense)%' "%UPSTREAM_HOST%"\n | ||
| route_config: | ||
| name: local_route | ||
| virtual_hosts: | ||
| - name: local_service | ||
| domains: ["*"] | ||
| routes: | ||
| - match: | ||
| prefix: "/" | ||
| route: | ||
| host_rewrite_literal: localhost | ||
| cluster: service_envoyproxy_io | ||
| http_filters: | ||
| - name: mytag0 | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.common.matching.v3.ExtensionWithMatcher | ||
| extension_config: | ||
| name: envoy.filters.http.set_metadata | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.filters.http.set_metadata.v3.Config | ||
| metadata_namespace: curiefense | ||
| value: | ||
| tags: | ||
| mytag0: 0 | ||
| matcher: | ||
| matcher_list: | ||
| matchers: | ||
| - predicate: | ||
| not_matcher: | ||
| or_matcher: | ||
| predicate: | ||
| - single_predicate: | ||
| input: | ||
| name: request-headers | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput | ||
| header_name: myheader | ||
| value_match: | ||
| exact: foo | ||
| - single_predicate: | ||
| input: | ||
| name: request-headers | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput | ||
| header_name: myheader | ||
| value_match: | ||
| exact: bar | ||
| on_match: | ||
| action: | ||
| name: skip | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.filters.common.matcher.action.v3.SkipFilter | ||
| - name: mytag1 | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.common.matching.v3.ExtensionWithMatcher | ||
| extension_config: | ||
| name: envoy.filters.http.set_metadata | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.filters.http.set_metadata.v3.Config | ||
| metadata_namespace: curiefense | ||
| value: | ||
| tags: | ||
| mytag1: 1 | ||
| matcher: | ||
| matcher_list: | ||
| matchers: | ||
| - predicate: | ||
| not_matcher: | ||
| single_predicate: | ||
| input: | ||
| name: request-headers | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.type.matcher.v3.HttpRequestHeaderMatchInput | ||
| header_name: header2 | ||
| value_match: | ||
| exact: toto | ||
| on_match: | ||
| action: | ||
| name: skip | ||
| typed_config: | ||
| "@type": type.googleapis.com/envoy.extensions.filters.common.matcher.action.v3.SkipFilter | ||
| - name: envoy.filters.http.router | ||
| clusters: | ||
| - name: service_envoyproxy_io | ||
| connect_timeout: 30s | ||
| type: LOGICAL_DNS | ||
| # Comment out the following line to test on v6 networks | ||
| dns_lookup_family: V4_ONLY | ||
| lb_policy: ROUND_ROBIN | ||
| load_assignment: | ||
| cluster_name: service_envoyproxy_io | ||
| endpoints: | ||
| - lb_endpoints: | ||
| - endpoint: | ||
| address: | ||
| socket_address: | ||
| address: 127.0.0.1 | ||
| port_value: 5555 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| .. _config_http_filters_set_metadata: | ||
|
|
||
| Set Metadata | ||
| ============ | ||
| * :ref:`v3 API reference <envoy_v3_api_msg_extensions.filters.http.set_metadata.v3.Config>` | ||
| * This filter should be configured with the name *envoy.filters.http.set_metadata*. | ||
|
|
||
| This filters adds or updates dynamic metadata with static data. | ||
|
|
||
| Dynamic metadata values are updated with the following scheme. If a key | ||
|
Member
There was a problem hiding this comment. @envoyproxy/api-shepherds this differs from |
||
| does not exists, it's just copied into the current metadata. Otherwise: | ||
|
|
||
| * scalar values (null, string, number, boolean) are replaced with the new value | ||
| * list: new values are added to the current list | ||
| * structure: recursively apply this scheme | ||
|
|
||
| For instance, if the namespace already contains this structure: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| myint: 1 | ||
| mylist: ["a"] | ||
| mytags: | ||
| tag0: 1 | ||
|
|
||
| and the value to set is: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| myint: 2 | ||
| mylist: ["b","c"] | ||
| mytags: | ||
| tag1: 1 | ||
|
|
||
| After applying this filter, the namespace will contain: | ||
|
|
||
| .. code-block:: yaml | ||
|
|
||
| myint: 2 | ||
| mylist: ["a","b","c"] | ||
| mytags: | ||
| tag0: 1 | ||
| tag1: 1 | ||
|
|
||
| Statistics | ||
| ---------- | ||
|
|
||
| Currently, this filter generates no statistics. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| load( | ||
| "//bazel:envoy_build_system.bzl", | ||
| "envoy_cc_extension", | ||
| "envoy_cc_library", | ||
| "envoy_extension_package", | ||
| ) | ||
|
|
||
| licenses(["notice"]) # Apache 2 | ||
|
|
||
| envoy_extension_package() | ||
|
|
||
| envoy_cc_library( | ||
| name = "set_metadata_filter_lib", | ||
| srcs = ["set_metadata_filter.cc"], | ||
| hdrs = ["set_metadata_filter.h"], | ||
| deps = [ | ||
| "//include/envoy/server:filter_config_interface", | ||
| "//source/common/http:utility_lib", | ||
| "//source/extensions/filters/http:well_known_names", | ||
| "//source/extensions/filters/http/common:pass_through_filter_lib", | ||
| "@envoy_api//envoy/extensions/filters/http/set_metadata/v3:pkg_cc_proto", | ||
| ], | ||
| ) | ||
|
|
||
| envoy_cc_extension( | ||
| name = "config", | ||
| srcs = ["config.cc"], | ||
| hdrs = ["config.h"], | ||
| category = "envoy.filters.http", | ||
| security_posture = "robust_to_untrusted_downstream_and_upstream", | ||
| deps = [ | ||
| "//include/envoy/registry", | ||
| "//source/common/protobuf:utility_lib", | ||
| "//source/extensions/filters/http:well_known_names", | ||
| "//source/extensions/filters/http/common:factory_base_lib", | ||
| "//source/extensions/filters/http/set_metadata:set_metadata_filter_lib", | ||
| "@envoy_api//envoy/extensions/filters/http/set_metadata/v3:pkg_cc_proto", | ||
| ], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| #include "extensions/filters/http/set_metadata/config.h" | ||
|
|
||
| #include <string> | ||
|
|
||
| #include "envoy/extensions/filters/http/set_metadata/v3/set_metadata.pb.h" | ||
| #include "envoy/extensions/filters/http/set_metadata/v3/set_metadata.pb.validate.h" | ||
| #include "envoy/registry/registry.h" | ||
|
|
||
| #include "common/protobuf/utility.h" | ||
|
|
||
| #include "extensions/filters/http/set_metadata/set_metadata_filter.h" | ||
|
|
||
| namespace Envoy { | ||
| namespace Extensions { | ||
| namespace HttpFilters { | ||
| namespace SetMetadataFilter { | ||
|
|
||
| Http::FilterFactoryCb SetMetadataConfig::createFilterFactoryFromProtoTyped( | ||
|
htuch marked this conversation as resolved.
|
||
| const envoy::extensions::filters::http::set_metadata::v3::Config& proto_config, | ||
| const std::string&, Server::Configuration::FactoryContext&) { | ||
| ConfigSharedPtr filter_config(std::make_shared<Config>(proto_config)); | ||
|
|
||
| return [filter_config](Http::FilterChainFactoryCallbacks& callbacks) -> void { | ||
| callbacks.addStreamDecoderFilter( | ||
| Http::StreamDecoderFilterSharedPtr{new SetMetadataFilter(filter_config)}); | ||
| }; | ||
| } | ||
|
|
||
| REGISTER_FACTORY(SetMetadataConfig, Server::Configuration::NamedHttpFilterConfigFactory); | ||
|
|
||
| } // namespace SetMetadataFilter | ||
| } // namespace HttpFilters | ||
| } // namespace Extensions | ||
| } // namespace Envoy | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update https://github.com/envoyproxy/envoy/blob/main/CODEOWNERS
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried to added myself, but it asked for a second maintainer. Who should I add? @snowp as he is sponsoring it :) ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, Snow and you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry missed this answer. Done in d139579 !