1 /*
2  * Copyright (C) 2010 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.net;
18 
19 import static android.net.RouteInfo.RTN_UNREACHABLE;
20 
21 import static com.android.testutils.MiscAsserts.assertEqualBothWays;
22 import static com.android.testutils.MiscAsserts.assertNotEqualEitherWay;
23 import static com.android.testutils.ParcelUtils.assertParcelingIsLossless;
24 
25 import static org.junit.Assert.assertEquals;
26 import static org.junit.Assert.assertFalse;
27 import static org.junit.Assert.assertNotEquals;
28 import static org.junit.Assert.assertNull;
29 import static org.junit.Assert.assertTrue;
30 import static org.junit.Assert.fail;
31 
32 import android.os.Build;
33 
34 import androidx.core.os.BuildCompat;
35 import androidx.test.filters.SmallTest;
36 import androidx.test.runner.AndroidJUnit4;
37 
38 import com.android.testutils.DevSdkIgnoreRule;
39 import com.android.testutils.DevSdkIgnoreRule.IgnoreUpTo;
40 
41 import org.junit.Rule;
42 import org.junit.Test;
43 import org.junit.runner.RunWith;
44 
45 import java.net.Inet4Address;
46 import java.net.Inet6Address;
47 import java.net.InetAddress;
48 
49 @RunWith(AndroidJUnit4.class)
50 @SmallTest
51 public class RouteInfoTest {
52     @Rule
53     public final DevSdkIgnoreRule ignoreRule = new DevSdkIgnoreRule();
54 
55     private static final int INVALID_ROUTE_TYPE = -1;
56 
Address(String addr)57     private InetAddress Address(String addr) {
58         return InetAddresses.parseNumericAddress(addr);
59     }
60 
Prefix(String prefix)61     private IpPrefix Prefix(String prefix) {
62         return new IpPrefix(prefix);
63     }
64 
isAtLeastR()65     private static boolean isAtLeastR() {
66         // BuildCompat.isAtLeastR is documented to return false on release SDKs (including R)
67         return Build.VERSION.SDK_INT > Build.VERSION_CODES.Q || BuildCompat.isAtLeastR();
68     }
69 
70     @Test
testConstructor()71     public void testConstructor() {
72         RouteInfo r;
73         // Invalid input.
74         try {
75             r = new RouteInfo((IpPrefix) null, null, "rmnet0");
76             fail("Expected RuntimeException:  destination and gateway null");
77         } catch (RuntimeException e) { }
78 
79         try {
80             r = new RouteInfo(Prefix("2001:db8:ace::/49"), Address("2001:db8::1"), "rmnet0",
81                     INVALID_ROUTE_TYPE);
82             fail("Invalid route type should cause exception");
83         } catch (IllegalArgumentException e) { }
84 
85         try {
86             r = new RouteInfo(Prefix("2001:db8:ace::/49"), Address("192.0.2.1"), "rmnet0",
87                     RTN_UNREACHABLE);
88             fail("Address family mismatch should cause exception");
89         } catch (IllegalArgumentException e) { }
90 
91         try {
92             r = new RouteInfo(Prefix("0.0.0.0/0"), Address("2001:db8::1"), "rmnet0",
93                     RTN_UNREACHABLE);
94             fail("Address family mismatch should cause exception");
95         } catch (IllegalArgumentException e) { }
96 
97         // Null destination is default route.
98         r = new RouteInfo((IpPrefix) null, Address("2001:db8::1"), null);
99         assertEquals(Prefix("::/0"), r.getDestination());
100         assertEquals(Address("2001:db8::1"), r.getGateway());
101         assertNull(r.getInterface());
102 
103         r = new RouteInfo((IpPrefix) null, Address("192.0.2.1"), "wlan0");
104         assertEquals(Prefix("0.0.0.0/0"), r.getDestination());
105         assertEquals(Address("192.0.2.1"), r.getGateway());
106         assertEquals("wlan0", r.getInterface());
107 
108         // Null gateway sets gateway to unspecified address (why?).
109         r = new RouteInfo(Prefix("2001:db8:beef:cafe::/48"), null, "lo");
110         assertEquals(Prefix("2001:db8:beef::/48"), r.getDestination());
111         assertEquals(Address("::"), r.getGateway());
112         assertEquals("lo", r.getInterface());
113 
114         r = new RouteInfo(Prefix("192.0.2.5/24"), null);
115         assertEquals(Prefix("192.0.2.0/24"), r.getDestination());
116         assertEquals(Address("0.0.0.0"), r.getGateway());
117         assertNull(r.getInterface());
118     }
119 
120     @Test
testMatches()121     public void testMatches() {
122         class PatchedRouteInfo {
123             private final RouteInfo mRouteInfo;
124 
125             public PatchedRouteInfo(IpPrefix destination, InetAddress gateway, String iface) {
126                 mRouteInfo = new RouteInfo(destination, gateway, iface);
127             }
128 
129             public boolean matches(InetAddress destination) {
130                 return mRouteInfo.matches(destination);
131             }
132         }
133 
134         PatchedRouteInfo r;
135 
136         r = new PatchedRouteInfo(Prefix("2001:db8:f00::ace:d00d/127"), null, "rmnet0");
137         assertTrue(r.matches(Address("2001:db8:f00::ace:d00c")));
138         assertTrue(r.matches(Address("2001:db8:f00::ace:d00d")));
139         assertFalse(r.matches(Address("2001:db8:f00::ace:d00e")));
140         assertFalse(r.matches(Address("2001:db8:f00::bad:d00d")));
141         assertFalse(r.matches(Address("2001:4868:4860::8888")));
142         assertFalse(r.matches(Address("8.8.8.8")));
143 
144         r = new PatchedRouteInfo(Prefix("192.0.2.0/23"), null, "wlan0");
145         assertTrue(r.matches(Address("192.0.2.43")));
146         assertTrue(r.matches(Address("192.0.3.21")));
147         assertFalse(r.matches(Address("192.0.0.21")));
148         assertFalse(r.matches(Address("8.8.8.8")));
149 
150         PatchedRouteInfo ipv6Default = new PatchedRouteInfo(Prefix("::/0"), null, "rmnet0");
151         assertTrue(ipv6Default.matches(Address("2001:db8::f00")));
152         assertFalse(ipv6Default.matches(Address("192.0.2.1")));
153 
154         PatchedRouteInfo ipv4Default = new PatchedRouteInfo(Prefix("0.0.0.0/0"), null, "rmnet0");
155         assertTrue(ipv4Default.matches(Address("255.255.255.255")));
156         assertTrue(ipv4Default.matches(Address("192.0.2.1")));
157         assertFalse(ipv4Default.matches(Address("2001:db8::f00")));
158     }
159 
160     @Test
testEquals()161     public void testEquals() {
162         // IPv4
163         RouteInfo r1 = new RouteInfo(Prefix("2001:db8:ace::/48"), Address("2001:db8::1"), "wlan0");
164         RouteInfo r2 = new RouteInfo(Prefix("2001:db8:ace::/48"), Address("2001:db8::1"), "wlan0");
165         assertEqualBothWays(r1, r2);
166 
167         RouteInfo r3 = new RouteInfo(Prefix("2001:db8:ace::/49"), Address("2001:db8::1"), "wlan0");
168         RouteInfo r4 = new RouteInfo(Prefix("2001:db8:ace::/48"), Address("2001:db8::2"), "wlan0");
169         RouteInfo r5 = new RouteInfo(Prefix("2001:db8:ace::/48"), Address("2001:db8::1"), "rmnet0");
170         assertNotEqualEitherWay(r1, r3);
171         assertNotEqualEitherWay(r1, r4);
172         assertNotEqualEitherWay(r1, r5);
173 
174         // IPv6
175         r1 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.1"), "wlan0");
176         r2 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.1"), "wlan0");
177         assertEqualBothWays(r1, r2);
178 
179         r3 = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), "wlan0");
180         r4 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.2"), "wlan0");
181         r5 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.1"), "rmnet0");
182         assertNotEqualEitherWay(r1, r3);
183         assertNotEqualEitherWay(r1, r4);
184         assertNotEqualEitherWay(r1, r5);
185 
186         // Interfaces (but not destinations or gateways) can be null.
187         r1 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.1"), null);
188         r2 = new RouteInfo(Prefix("192.0.2.0/25"), Address("192.0.2.1"), null);
189         r3 = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), "wlan0");
190         assertEqualBothWays(r1, r2);
191         assertNotEqualEitherWay(r1, r3);
192     }
193 
194     @Test
testHostAndDefaultRoutes()195     public void testHostAndDefaultRoutes() {
196         RouteInfo r;
197 
198         r = new RouteInfo(Prefix("0.0.0.0/0"), Address("0.0.0.0"), "wlan0");
199         assertFalse(r.isHostRoute());
200         assertTrue(r.isDefaultRoute());
201         assertTrue(r.isIPv4Default());
202         assertFalse(r.isIPv6Default());
203         if (isAtLeastR()) {
204             assertFalse(r.isIPv4UnreachableDefault());
205             assertFalse(r.isIPv6UnreachableDefault());
206         }
207 
208         r = new RouteInfo(Prefix("::/0"), Address("::"), "wlan0");
209         assertFalse(r.isHostRoute());
210         assertTrue(r.isDefaultRoute());
211         assertFalse(r.isIPv4Default());
212         assertTrue(r.isIPv6Default());
213         if (isAtLeastR()) {
214             assertFalse(r.isIPv4UnreachableDefault());
215             assertFalse(r.isIPv6UnreachableDefault());
216         }
217 
218         r = new RouteInfo(Prefix("192.0.2.0/24"), null, "wlan0");
219         assertFalse(r.isHostRoute());
220         assertFalse(r.isDefaultRoute());
221         assertFalse(r.isIPv4Default());
222         assertFalse(r.isIPv6Default());
223         if (isAtLeastR()) {
224             assertFalse(r.isIPv4UnreachableDefault());
225             assertFalse(r.isIPv6UnreachableDefault());
226         }
227 
228         r = new RouteInfo(Prefix("2001:db8::/48"), null, "wlan0");
229         assertFalse(r.isHostRoute());
230         assertFalse(r.isDefaultRoute());
231         assertFalse(r.isIPv4Default());
232         assertFalse(r.isIPv6Default());
233         if (isAtLeastR()) {
234             assertFalse(r.isIPv4UnreachableDefault());
235             assertFalse(r.isIPv6UnreachableDefault());
236         }
237 
238         r = new RouteInfo(Prefix("192.0.2.0/32"), Address("0.0.0.0"), "wlan0");
239         assertTrue(r.isHostRoute());
240         assertFalse(r.isDefaultRoute());
241         assertFalse(r.isIPv4Default());
242         assertFalse(r.isIPv6Default());
243         if (isAtLeastR()) {
244             assertFalse(r.isIPv4UnreachableDefault());
245             assertFalse(r.isIPv6UnreachableDefault());
246         }
247 
248         r = new RouteInfo(Prefix("2001:db8::/128"), Address("::"), "wlan0");
249         assertTrue(r.isHostRoute());
250         assertFalse(r.isDefaultRoute());
251         assertFalse(r.isIPv4Default());
252         assertFalse(r.isIPv6Default());
253         if (isAtLeastR()) {
254             assertFalse(r.isIPv4UnreachableDefault());
255             assertFalse(r.isIPv6UnreachableDefault());
256         }
257 
258         r = new RouteInfo(Prefix("192.0.2.0/32"), null, "wlan0");
259         assertTrue(r.isHostRoute());
260         assertFalse(r.isDefaultRoute());
261         assertFalse(r.isIPv4Default());
262         assertFalse(r.isIPv6Default());
263         if (isAtLeastR()) {
264             assertFalse(r.isIPv4UnreachableDefault());
265             assertFalse(r.isIPv6UnreachableDefault());
266         }
267 
268         r = new RouteInfo(Prefix("2001:db8::/128"), null, "wlan0");
269         assertTrue(r.isHostRoute());
270         assertFalse(r.isDefaultRoute());
271         assertFalse(r.isIPv4Default());
272         assertFalse(r.isIPv6Default());
273         if (isAtLeastR()) {
274             assertFalse(r.isIPv4UnreachableDefault());
275             assertFalse(r.isIPv6UnreachableDefault());
276         }
277 
278         r = new RouteInfo(Prefix("::/128"), Address("fe80::"), "wlan0");
279         assertTrue(r.isHostRoute());
280         assertFalse(r.isDefaultRoute());
281         assertFalse(r.isIPv4Default());
282         assertFalse(r.isIPv6Default());
283         if (isAtLeastR()) {
284             assertFalse(r.isIPv4UnreachableDefault());
285             assertFalse(r.isIPv6UnreachableDefault());
286         }
287 
288         r = new RouteInfo(Prefix("0.0.0.0/32"), Address("192.0.2.1"), "wlan0");
289         assertTrue(r.isHostRoute());
290         assertFalse(r.isDefaultRoute());
291         assertFalse(r.isIPv4Default());
292         assertFalse(r.isIPv6Default());
293         if (isAtLeastR()) {
294             assertFalse(r.isIPv4UnreachableDefault());
295             assertFalse(r.isIPv6UnreachableDefault());
296         }
297 
298         r = new RouteInfo(Prefix("0.0.0.0/32"), Address("192.0.2.1"), "wlan0");
299         assertTrue(r.isHostRoute());
300         assertFalse(r.isDefaultRoute());
301         assertFalse(r.isIPv4Default());
302         assertFalse(r.isIPv6Default());
303         if (isAtLeastR()) {
304             assertFalse(r.isIPv4UnreachableDefault());
305             assertFalse(r.isIPv6UnreachableDefault());
306         }
307 
308         r = new RouteInfo(new IpPrefix(Inet4Address.ANY, 0), RTN_UNREACHABLE);
309         assertFalse(r.isHostRoute());
310         assertFalse(r.isDefaultRoute());
311         assertFalse(r.isIPv4Default());
312         assertFalse(r.isIPv6Default());
313         if (isAtLeastR()) {
314             assertTrue(r.isIPv4UnreachableDefault());
315             assertFalse(r.isIPv6UnreachableDefault());
316         }
317 
318         r = new RouteInfo(new IpPrefix(Inet6Address.ANY, 0), RTN_UNREACHABLE);
319         assertFalse(r.isHostRoute());
320         assertFalse(r.isDefaultRoute());
321         assertFalse(r.isIPv4Default());
322         assertFalse(r.isIPv6Default());
323         if (isAtLeastR()) {
324             assertFalse(r.isIPv4UnreachableDefault());
325             assertTrue(r.isIPv6UnreachableDefault());
326         }
327     }
328 
329     @Test
testTruncation()330     public void testTruncation() {
331       LinkAddress l;
332       RouteInfo r;
333 
334       l = new LinkAddress("192.0.2.5/30");
335       r = new RouteInfo(l, Address("192.0.2.1"), "wlan0");
336       assertEquals("192.0.2.4", r.getDestination().getAddress().getHostAddress());
337 
338       l = new LinkAddress("2001:db8:1:f::5/63");
339       r = new RouteInfo(l, Address("2001:db8:5::1"), "wlan0");
340       assertEquals("2001:db8:1:e::", r.getDestination().getAddress().getHostAddress());
341     }
342 
343     // Make sure that creating routes to multicast addresses doesn't throw an exception. Even though
344     // there's nothing we can do with them, we don't want to crash if, e.g., someone calls
345     // requestRouteToHostAddress("230.0.0.0", MOBILE_HIPRI);
346     @Test
testMulticastRoute()347     public void testMulticastRoute() {
348       RouteInfo r;
349       r = new RouteInfo(Prefix("230.0.0.0/32"), Address("192.0.2.1"), "wlan0");
350       r = new RouteInfo(Prefix("ff02::1/128"), Address("2001:db8::1"), "wlan0");
351       // No exceptions? Good.
352     }
353 
354     @Test
testParceling()355     public void testParceling() {
356         RouteInfo r;
357         r = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), null);
358         assertParcelingIsLossless(r);
359         r = new RouteInfo(Prefix("192.0.2.0/24"), null, "wlan0");
360         assertParcelingIsLossless(r);
361         r = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), "wlan0", RTN_UNREACHABLE);
362         assertParcelingIsLossless(r);
363     }
364 
365     @Test @IgnoreUpTo(Build.VERSION_CODES.Q)
testMtuParceling()366     public void testMtuParceling() {
367         final RouteInfo r = new RouteInfo(Prefix("ff02::1/128"), Address("2001:db8::"), "testiface",
368                 RTN_UNREACHABLE, 1450 /* mtu */);
369         assertParcelingIsLossless(r);
370     }
371 
372     @Test @IgnoreUpTo(Build.VERSION_CODES.Q)
testMtu()373     public void testMtu() {
374         RouteInfo r;
375         r = new RouteInfo(Prefix("0.0.0.0/0"), Address("0.0.0.0"), "wlan0",
376                 RouteInfo.RTN_UNICAST, 1500);
377         assertEquals(1500, r.getMtu());
378 
379         r = new RouteInfo(Prefix("0.0.0.0/0"), Address("0.0.0.0"), "wlan0");
380         assertEquals(0, r.getMtu());
381     }
382 
383     @Test @IgnoreUpTo(Build.VERSION_CODES.Q)
testRouteKey()384     public void testRouteKey() {
385         RouteInfo.RouteKey k1, k2;
386         // Only prefix, null gateway and null interface
387         k1 = new RouteInfo(Prefix("2001:db8::/128"), null).getRouteKey();
388         k2 = new RouteInfo(Prefix("2001:db8::/128"), null).getRouteKey();
389         assertEquals(k1, k2);
390         assertEquals(k1.hashCode(), k2.hashCode());
391 
392         // With prefix, gateway and interface. Type and MTU does not affect RouteKey equality
393         k1 = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), "wlan0",
394                 RTN_UNREACHABLE, 1450).getRouteKey();
395         k2 = new RouteInfo(Prefix("192.0.2.0/24"), Address("192.0.2.1"), "wlan0",
396                 RouteInfo.RTN_UNICAST, 1400).getRouteKey();
397         assertEquals(k1, k2);
398         assertEquals(k1.hashCode(), k2.hashCode());
399 
400         // Different scope IDs are ignored by the kernel, so we consider them equal here too.
401         k1 = new RouteInfo(Prefix("2001:db8::/64"), Address("fe80::1%1"), "wlan0").getRouteKey();
402         k2 = new RouteInfo(Prefix("2001:db8::/64"), Address("fe80::1%2"), "wlan0").getRouteKey();
403         assertEquals(k1, k2);
404         assertEquals(k1.hashCode(), k2.hashCode());
405 
406         // Different prefix
407         k1 = new RouteInfo(Prefix("192.0.2.0/24"), null).getRouteKey();
408         k2 = new RouteInfo(Prefix("192.0.3.0/24"), null).getRouteKey();
409         assertNotEquals(k1, k2);
410 
411         // Different gateway
412         k1 = new RouteInfo(Prefix("ff02::1/128"), Address("2001:db8::1"), null).getRouteKey();
413         k2 = new RouteInfo(Prefix("ff02::1/128"), Address("2001:db8::2"), null).getRouteKey();
414         assertNotEquals(k1, k2);
415 
416         // Different interface
417         k1 = new RouteInfo(Prefix("ff02::1/128"), null, "tun0").getRouteKey();
418         k2 = new RouteInfo(Prefix("ff02::1/128"), null, "tun1").getRouteKey();
419         assertNotEquals(k1, k2);
420     }
421 }
422