rama-net 0.3.0

rama network types and utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245

use core::net::{IpAddr, SocketAddr};

use crate::address::{Authority, Host, HostWithOptPort, HostWithPort, ProxyAddress, SocketAddress};

/// Converts an IP address into a canonical representation.
///
/// Canonical means:
/// - IPv4 stays IPv4.
/// - IPv6 stays IPv6, except for IPv4-mapped addresses (`::ffff:a.b.c.d`,
///   [RFC 4291, Section 2.5.5.2]), which convert to the embedded IPv4 address.
///
/// IPv4-mapped addresses represent IPv4 connectivity exposed through the
/// IPv6 socket API of dual-stack hosts ([RFC 4038, Section 4.2]); they never
/// appear on the wire as IPv6 and are not routable as IPv6 ([IANA registry]).
/// Connecting to one is therefore always IPv4 wire traffic, and dialing the
/// embedded IPv4 address directly is the only form that also works on hosts
/// without (working) dual-stack IPv6 sockets — e.g. Windows, where sockets
/// default to `IPV6_V6ONLY`.
///
/// [RFC 4291, Section 2.5.5.2]: https://datatracker.ietf.org/doc/html/rfc4291#section-2.5.5.2
/// [RFC 4038, Section 4.2]: https://datatracker.ietf.org/doc/html/rfc4038#section-4.2
/// [IANA registry]: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
pub trait IntoCanonicalIpAddr {
    #[must_use]
    fn into_canonical_ip_addr(self) -> Self;
}

impl IntoCanonicalIpAddr for IpAddr {
    #[inline(always)]
    fn into_canonical_ip_addr(self) -> Self {
        self.to_canonical()
    }
}

impl IntoCanonicalIpAddr for SocketAddress {
    #[inline(always)]
    fn into_canonical_ip_addr(mut self) -> Self {
        self.ip_addr = self.ip_addr.into_canonical_ip_addr();
        self
    }
}

impl IntoCanonicalIpAddr for SocketAddr {
    #[inline(always)]
    fn into_canonical_ip_addr(self) -> Self {
        let ip_addr = self.ip().into_canonical_ip_addr();
        Self::new(ip_addr, self.port())
    }
}

impl IntoCanonicalIpAddr for Host {
    fn into_canonical_ip_addr(self) -> Self {
        // Bridge `Uninterpreted` to `IpAddr` before canonicalising —
        // a pct-encoded IPv4-mapped IPv6 (`%3A%3Affff%3A192.0.2.1`)
        // would otherwise pass through unchanged and miss the v4
        // fold-down. Non-promotable inputs (Name, sub-delim Uninterpreted,
        // IPvFuture) keep their original shape.
        match self.try_as_ip() {
            Ok(ip) => Self::Address(ip.into_canonical_ip_addr()),
            Err(_) => self,
        }
    }
}

impl IntoCanonicalIpAddr for HostWithPort {
    #[inline(always)]
    fn into_canonical_ip_addr(self) -> Self {
        Self {
            host: self.host.into_canonical_ip_addr(),
            port: self.port,
        }
    }
}

impl IntoCanonicalIpAddr for HostWithOptPort {
    #[inline(always)]
    fn into_canonical_ip_addr(self) -> Self {
        Self {
            host: self.host.into_canonical_ip_addr(),
            port: self.port,
        }
    }
}

impl IntoCanonicalIpAddr for ProxyAddress {
    #[inline(always)]
    fn into_canonical_ip_addr(self) -> Self {
        Self {
            protocol: self.protocol,
            address: self.address.into_canonical_ip_addr(),
            credential: self.credential,
        }
    }
}

impl IntoCanonicalIpAddr for Authority {
    fn into_canonical_ip_addr(self) -> Self {
        Self {
            user_info: self.user_info,
            address: self.address.into_canonical_ip_addr(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn ipv4_loopback_is_unchanged() {
        let socket_addr = SocketAddress::local_ipv4(8080);
        assert_eq!(socket_addr.into_canonical_ip_addr(), socket_addr);
    }

    #[test]
    fn ipv6_loopback_is_unchanged() {
        let socket_addr = SocketAddress::local_ipv6(8080);
        assert_eq!(socket_addr.into_canonical_ip_addr(), socket_addr);
    }

    #[test]
    fn ipv4_is_unchanged() {
        let socket_addr = SocketAddress::from(([192, 168, 1, 1], 8080));
        assert_eq!(socket_addr.into_canonical_ip_addr(), socket_addr);
    }

    #[test]
    fn ipv6_is_unchanged() {
        let socket_addr = SocketAddress::from(([0x2001, 0x0db8, 0, 0, 0, 0, 0xdead, 0xbeef], 8080));
        assert_eq!(socket_addr.into_canonical_ip_addr(), socket_addr);
    }

    #[test]
    fn ipv4_mapped_ipv6_is_converted_to_ipv4() {
        // ::ffff:192.10.2.255
        let socket_addr = SocketAddress::from(([0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff], 8080));
        assert_eq!(
            socket_addr.into_canonical_ip_addr(),
            SocketAddress::from(([192, 10, 2, 255], 8080))
        );
    }

    #[test]
    fn ipv4_mapped_loopback_ipv6_is_converted_to_ipv4() {
        // ::ffff:127.0.0.1
        let socket_addr = SocketAddress::from(([0, 0, 0, 0, 0, 0xffff, 0x7f00, 0x0001], 8080));
        assert_eq!(
            socket_addr.into_canonical_ip_addr(),
            SocketAddress::from(([127, 0, 0, 1], 8080))
        );
    }

    #[test]
    fn ipv4_compatible_ipv6_is_not_converted_to_ipv4() {
        // ::192.0.2.33, represented as 0:0:0:0:0:0:c000:0221
        let socket_addr = SocketAddress::from(([0, 0, 0, 0, 0, 0, 0xc000, 0x0221], 8080));
        assert_eq!(socket_addr.into_canonical_ip_addr(), socket_addr);
    }

    #[test]
    fn ipv4_mapped_zero_zero_zero_one_is_converted_to_ipv4() {
        // ::ffff:0.0.0.1
        let socket_addr = SocketAddress::from(([0, 0, 0, 0, 0, 0xffff, 0x0000, 0x0001], 8080));
        assert_eq!(
            socket_addr.into_canonical_ip_addr(),
            SocketAddress::from(([0, 0, 0, 1], 8080))
        );
    }

    // ---- Host bridging through Uninterpreted ----------------------------

    /// Regression: a pct-encoded IPv4-mapped IPv6 carried in
    /// `Host::Uninterpreted` must canonicalize to the embedded IPv4,
    /// not pass through unchanged. The eager parser doesn't promote
    /// pct-encoded forms — `Host::try_as_ip` does — so the canonical
    /// op needs to bridge.
    #[test]
    fn host_uninterpreted_pct_encoded_v4_mapped_v6_canonicalizes_to_v4() {
        // ::ffff:192.0.2.1 — but pct-encoded so the URI parser stored
        // it as `Host::Uninterpreted`.
        let host = crate::uri::Uri::parse("http://%3A%3Affff%3A192.0.2.1/")
            .unwrap()
            .host()
            .unwrap()
            .into_owned();
        assert!(matches!(host, Host::Uninterpreted(_)), "fixture sanity");
        let canonical = host.into_canonical_ip_addr();
        assert_eq!(
            canonical,
            Host::Address("192.0.2.1".parse::<IpAddr>().unwrap())
        );
    }

    /// A pct-encoded plain IPv4 also promotes.
    #[test]
    fn host_uninterpreted_pct_encoded_v4_canonicalizes() {
        let host = crate::uri::Uri::parse("http://%31%32%37.0.0.1/")
            .unwrap()
            .host()
            .unwrap()
            .into_owned();
        assert!(matches!(host, Host::Uninterpreted(_)));
        let canonical = host.into_canonical_ip_addr();
        assert_eq!(
            canonical,
            Host::Address("127.0.0.1".parse::<IpAddr>().unwrap())
        );
    }

    /// Non-promotable Uninterpreted (sub-delim) passes through unchanged.
    #[test]
    fn host_uninterpreted_subdelim_passes_through() {
        let host = crate::uri::Uri::parse("http://tag,with,commas/")
            .unwrap()
            .host()
            .unwrap()
            .into_owned();
        assert!(matches!(host, Host::Uninterpreted(_)));
        let canonical = host.clone().into_canonical_ip_addr();
        assert_eq!(canonical, host);
    }

    /// IPvFuture (bracketed Uninterpreted) passes through unchanged —
    /// no IPv4-mapped fold-down for `[vN.X]` shapes.
    #[test]
    fn host_uninterpreted_ipvfuture_passes_through() {
        let host = crate::uri::Uri::parse("http://[v1.fe80::a]/")
            .unwrap()
            .host()
            .unwrap()
            .into_owned();
        assert!(matches!(host, Host::Uninterpreted(_)));
        let canonical = host.clone().into_canonical_ip_addr();
        assert_eq!(canonical, host);
    }

    /// `Host::Name` always passes through — domains have no IP shape
    /// to canonicalize.
    #[test]
    fn host_name_passes_through() {
        let host = Host::Name(crate::address::Domain::from_static("example.com"));
        let canonical = host.clone().into_canonical_ip_addr();
        assert_eq!(canonical, host);
    }
}