CDirkx commented on Jun 15 •

Stabilization of the ip feature has for a long time been blocked on the question of whether Rust should support handling "IPv4-in-IPv6" addresses: should the various Ipv6Address property methods take IPv4-mapped or IPv4-compatible addresses into account. See also the IPv4-in-IPv6 Address Support issue #85609 and #69772 which originally asked the question.

Overview

In the recent PR #85655 I proposed changing is_loopback to take IPv4-mapped addresses into account, so ::ffff:127.0.0.1 would be recognized as a looback address. However, due to the points that came up in that PR, I alternatively propose the following: Keeping the current behaviour and commit to not assigning any special meaning for IPv4-in-IPv6 addresses, other than what the standards prescribe. This would apply to the stable method is_loopback, but also to currently unstable methods like is_global and is_documentation and any future methods. This is implemented in this PR as a change in documentation, specifically the following section:

Both types of addresses are not assigned any special meaning by this implementation, other than what the relevant standards prescribe. This means that an address like ::ffff:127.0.0.1, while representing an IPv4 loopback address, is not itself an IPv6 loopback address; only ::1 is. To handle these so called "IPv4-in-IPv6" addresses, they have to first be converted to their canonical IPv4 address.

Discussion

In the discussion for or against supporting IPv4-in-IPv6 addresses the question what would be least surprising for users of other languages has come up several times. At first it seemed most big other languages supported IPv4-in-IPv6 addresses (or at least considered ::ffff:127.0.0.1 a loopback address). However after further investigation it appears that supporting IPv4-in-IPv6 addresses comes down to how a language represents addresses. .Net and Go do not have a separate type for IPv4 or IPv6 addresses, and do consider ::ffff:127.0.0.1 a loopback address. Java and Python, which do have separate types, do not consider ::ffff:127.0.0.1 a loopback address. Seeing as Rust has the separate Ipv6Addr type, it would make sense to also not support IPv4-in-IPv6 addresses. Note that this focuses on IPv4-mapped addresses, no other language handles IPv4-compatible addresses.

Another issue that was raised is how useful supporting these IPv4-in-IPv6 addresses would be in practice. Again with the example of ::ffff:127.0.0.1, considering it a loopback address isn't too useful as to use it with most of the socket APIs it has to be converted to an IPv4 address anyway. From that perspective it would be better to instead provide better ways for doing this conversion like stabilizing to_ipv4_mapped or introducing a to_canonical method.

A point in favour of not supporting IPv4-in-IPv6 addresses is that that is the behaviour Rust has always had, and that supporting it would require changing already stable functions like is_loopback. This also keeps the documentation of these functions simpler, as we only have to refer to the relevant definitions in the IPv6 specification.

Decision

To make progress on the ip feature, a decision needs to be made on whether or not to support IPv4-in-IPv6 addresses.
There are several options:

• Keep the current implementation and commit to never supporting IPv4-in-IPv6 addresses (accept this PR).
• Support IPv4-in-IPv6 addresses in some/all IPv6Addr methods (accept PR #85655).
• Keep the current implementation and but not commit to anything yet (reject both this PR and PR #85655), this entire issue will however come up again in the stabilization of several methods under the ip feature.

There are more options, like supporting IPv4-in-IPv6 addresses in IpAddr methods instead, but to my knowledge those haven't been seriously argued for by anyone.

There is currently an FCP ongoing on PR #85655. I would ask the libs team for an alternative FCP on this PR as well, which if completed means the rejection of PR #85655, and the decision to commit to not supporting IPv4-in-IPv6 addresses.

If anyone feels there is not enough evidence yet to make the decision for or against supporting IPv4-in-IPv6 addresses, let me know and I'll do whatever I can to resolve it.