Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release-1.25] Clarify relationship btw MeshNetworks and ENABLE_HCM_INTERNAL_NET #3444

Open
wants to merge 3 commits into
base: release-1.25
Choose a base branch
from
Open

[release-1.25] Clarify relationship btw MeshNetworks and ENABLE_HCM_INTERNAL_NET #3444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ba239e
Clarify relationship btw MeshNetworks and ENABLE_HCM_INTERNAL_NET
jaellio Feb 6, 2025
4768139
Add release note
jaellio Feb 6, 2025
3a5c67f
Clarify security implications of enabling HCM internal networks and c…
jaellio Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions mesh/v1alpha1/istio.mesh.v1alpha1.pb.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions mesh/v1alpha1/network.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions mesh/v1alpha1/network.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,21 @@ message Network {
// locality: us-east-1a
// ```
//
// If `ENABLE_HCM_INTERNAL_NETWORKS` is set to true, MeshNetworks can be used to
// to explicitly define the networks in Envoy's internal address configuration.
// Envoy uses the IPs in the `internalAddressConfig` to decide whether or not to sanitize
// Envoy headers. If the IP address is listed an internal, the Envoy headers are not
// sanitized. As of Envoy 1.33, the default value for `internalAddressConfig` is set to
// an empty set. Previously, the default value was the set of all private IPs. Setting
// the `internalAddressConfig` to all private IPs (via Envoy's previous default behavior
// or via the MeshNetworks) will leave users with an Istio Ingress Gateway potentially
// vulnerable to `x-envoy` header manipulation by external sources. More information about
// this vulnerability can be found here:
// https://github.com/envoyproxy/envoy/security/advisories/GHSA-ffhv-fvxq-r6mf
// To preserve headers, you must explicitly configure MeshNetworks and set
// `ENABLE_HCM_INTERNAL_NETWORKS` to true. Envoy's `internalAddressConfig` will be set to
// the endpointed specified by `fromCidr`.
//
message MeshNetworks {
// The set of networks inside this mesh. Each network should
// have a unique name and information about how to infer the endpoints in
Expand Down
16 changes: 16 additions & 0 deletions releasenotes/notes/mesh-network-internal-addr-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
apiVersion: release-notes/v2
kind: bug-fix
area: documentation
issue:
- https://github.com/istio/istio/issues/53402

releaseNotes:
- |
**Fixed** documentation for using MeshNetworks to configure envoy internal address configuration
when ENABLE_HCM_INTERNAL_NETWORKS is set to true. As of Envoy 1.33, the default value for
internalAddressConfig is set to an empty set. Previously, the default value was the set of all
private IPs. To preserve Envoy headers, you must explicitly configure MeshNetworks
or revert to Envoy's prior behavior by setting envoy.reloadable_features.explicit_internal_address_config
to false. Setting MeshNetworks to all private IPs or reverting to Envoy's previous behavior will leave
users with an Istio Ingress Gateway potentially vulnerable to x-envoy header manipulation by external
sources. More information about this vulnerability can be found here: https://github.com/envoyproxy/envoy/security/advisories/GHSA-ffhv-fvxq-r6mf