server/RouteController.cpp

   1 /*
   2  * Copyright (C) 2014 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 #include "RouteController.h"
  18
  19 #include "Fwmark.h"
  20 #include "UidRanges.h"
  21
  22 #define LOG_TAG "Netd"
  23 #include "log/log.h"
  24 #include "logwrap/logwrap.h"
  25 #include "resolv_netid.h"
  26
  27 #include <arpa/inet.h>
  28 #include <fcntl.h>
  29 #include <linux/fib_rules.h>
  30 #include <map>
  31 #include <net/if.h>
  32 #include <sys/stat.h>
  33
  34 namespace {
  35
  36 // BEGIN CONSTANTS --------------------------------------------------------------------------------
  37
  38 const uint32_t RULE_PRIORITY_VPN_OVERRIDE_SYSTEM = 10000;
  39 // const uint32_t RULE_PRIORITY_VPN_OVERRIDE_LOCAL  = 11000;
  40 const uint32_t RULE_PRIORITY_SECURE_VPN          = 12000;
  41 const uint32_t RULE_PRIORITY_EXPLICIT_NETWORK    = 13000;
  42 const uint32_t RULE_PRIORITY_OUTPUT_INTERFACE    = 14000;
  43 const uint32_t RULE_PRIORITY_LEGACY_SYSTEM       = 15000;
  44 const uint32_t RULE_PRIORITY_LEGACY_NETWORK      = 16000;
  45 const uint32_t RULE_PRIORITY_LOCAL_NETWORK       = 17000;
  46 const uint32_t RULE_PRIORITY_TETHERING           = 18000;
  47 const uint32_t RULE_PRIORITY_IMPLICIT_NETWORK    = 19000;
  48 // const uint32_t RULE_PRIORITY_BYPASSABLE_VPN      = 20000;
  49 // const uint32_t RULE_PRIORITY_VPN_FALLTHROUGH     = 21000;
  50 const uint32_t RULE_PRIORITY_DEFAULT_NETWORK     = 22000;
  51 const uint32_t RULE_PRIORITY_DIRECTLY_CONNECTED  = 23000;
  52 const uint32_t RULE_PRIORITY_UNREACHABLE         = 24000;
  53
  54 const uint32_t ROUTE_TABLE_LOCAL_NETWORK  = 97;
  55 const uint32_t ROUTE_TABLE_LEGACY_NETWORK = 98;
  56 const uint32_t ROUTE_TABLE_LEGACY_SYSTEM  = 99;
  57
  58 const char* const ROUTE_TABLE_NAME_LOCAL_NETWORK  = "local_network";
  59 const char* const ROUTE_TABLE_NAME_LEGACY_NETWORK = "legacy_network";
  60 const char* const ROUTE_TABLE_NAME_LEGACY_SYSTEM  = "legacy_system";
  61
  62 const char* const ROUTE_TABLE_NAME_LOCAL = "local";
  63 const char* const ROUTE_TABLE_NAME_MAIN  = "main";
  64
  65 // TODO: These values aren't defined by the Linux kernel, because our UID routing changes are not
  66 // upstream (yet?), so we can't just pick them up from kernel headers. When (if?) the changes make
  67 // it upstream, we'll remove this and rely on the kernel header values. For now, add a static assert
  68 // that will warn us if upstream has given these values some other meaning.
  69 const uint16_t FRA_UID_START = 18;
  70 const uint16_t FRA_UID_END   = 19;
  71 static_assert(FRA_UID_START > FRA_MAX,
  72              "Android-specific FRA_UID_{START,END} values also assigned in Linux uapi. "
  73              "Check that these values match what the kernel does and then update this assertion.");
  74
  75 const uint16_t NETLINK_REQUEST_FLAGS = NLM_F_REQUEST | NLM_F_ACK;
  76 const uint16_t NETLINK_CREATE_REQUEST_FLAGS = NETLINK_REQUEST_FLAGS | NLM_F_CREATE | NLM_F_EXCL;
  77
  78 const sockaddr_nl NETLINK_ADDRESS = {AF_NETLINK, 0, 0, 0};
  79
  80 const uint8_t AF_FAMILIES[] = {AF_INET, AF_INET6};
  81
  82 const char* const IP_VERSIONS[] = {"-4", "-6"};
  83
  84 const uid_t UID_ROOT = 0;
  85 const char* const IIF_NONE = NULL;
  86 const char* const OIF_NONE = NULL;
  87 const bool ACTION_ADD = true;
  88 const bool ACTION_DEL = false;
  89 const bool MODIFY_NON_UID_BASED_RULES = true;
  90
  91 const char* const RT_TABLES_PATH = "/data/misc/net/rt_tables";
  92 const int RT_TABLES_FLAGS = O_CREAT | O_TRUNC | O_WRONLY | O_NOFOLLOW | O_CLOEXEC;
  93 const mode_t RT_TABLES_MODE = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH;  // mode 0644, rw-r--r--
  94
  95 // Avoids "non-constant-expression cannot be narrowed from type 'unsigned int' to 'unsigned short'"
  96 // warnings when using RTA_LENGTH(x) inside static initializers (even when x is already uint16_t).
  97 constexpr uint16_t U16_RTA_LENGTH(uint16_t x) {
  98     return RTA_LENGTH(x);
  99 }
 100
 101 // These are practically const, but can't be declared so, because they are used to initialize
 102 // non-const pointers ("void* iov_base") in iovec arrays.
 103 rtattr FRATTR_PRIORITY  = { U16_RTA_LENGTH(sizeof(uint32_t)), FRA_PRIORITY };
 104 rtattr FRATTR_TABLE     = { U16_RTA_LENGTH(sizeof(uint32_t)), FRA_TABLE };
 105 rtattr FRATTR_FWMARK    = { U16_RTA_LENGTH(sizeof(uint32_t)), FRA_FWMARK };
 106 rtattr FRATTR_FWMASK    = { U16_RTA_LENGTH(sizeof(uint32_t)), FRA_FWMASK };
 107 rtattr FRATTR_UID_START = { U16_RTA_LENGTH(sizeof(uid_t)),    FRA_UID_START };
 108 rtattr FRATTR_UID_END   = { U16_RTA_LENGTH(sizeof(uid_t)),    FRA_UID_END };
 109
 110 rtattr RTATTR_TABLE     = { U16_RTA_LENGTH(sizeof(uint32_t)), RTA_TABLE };
 111 rtattr RTATTR_OIF       = { U16_RTA_LENGTH(sizeof(uint32_t)), RTA_OIF };
 112
 113 uint8_t PADDING_BUFFER[RTA_ALIGNTO] = {0, 0, 0, 0};
 114
 115 // END CONSTANTS ----------------------------------------------------------------------------------
 116
 117 // No locks needed because RouteController is accessed only from one thread (in CommandListener).
 118 std::map<std::string, uint32_t> interfaceToTable;
 119
 120 uint32_t getRouteTableForInterface(const char* interface) {
 121     uint32_t index = if_nametoindex(interface);
 122     if (index) {
 123         index += RouteController::ROUTE_TABLE_OFFSET_FROM_INDEX;
 124         interfaceToTable[interface] = index;
 125         return index;
 126     }
 127     // If the interface goes away if_nametoindex() will return 0 but we still need to know
 128     // the index so we can remove the rules and routes.
 129     auto iter = interfaceToTable.find(interface);
 130     if (iter == interfaceToTable.end()) {
 131         ALOGE("cannot find interface %s", interface);
 132         return RT_TABLE_UNSPEC;
 133     }
 134     return iter->second;
 135 }
 136
 137 void addTableName(uint32_t table, const std::string& name, std::string* contents) {
 138     char tableString[UINT32_STRLEN];
 139     snprintf(tableString, sizeof(tableString), "%u", table);
 140     *contents += tableString;
 141     *contents += " ";
 142     *contents += name;
 143     *contents += "\n";
 144 }
 145
 146 // Doesn't return success/failure as the file is optional; it's okay if we fail to update it.
 147 void updateTableNamesFile() {
 148     std::string contents;
 149
 150     addTableName(RT_TABLE_LOCAL, ROUTE_TABLE_NAME_LOCAL, &contents);
 151     addTableName(RT_TABLE_MAIN,  ROUTE_TABLE_NAME_MAIN,  &contents);
 152
 153     addTableName(ROUTE_TABLE_LOCAL_NETWORK,  ROUTE_TABLE_NAME_LOCAL_NETWORK,  &contents);
 154     addTableName(ROUTE_TABLE_LEGACY_NETWORK, ROUTE_TABLE_NAME_LEGACY_NETWORK, &contents);
 155     addTableName(ROUTE_TABLE_LEGACY_SYSTEM,  ROUTE_TABLE_NAME_LEGACY_SYSTEM,  &contents);
 156
 157     for (const auto& entry : interfaceToTable) {
 158         addTableName(entry.second, entry.first, &contents);
 159     }
 160
 161     int fd = open(RT_TABLES_PATH, RT_TABLES_FLAGS, RT_TABLES_MODE);
 162     if (fd == -1) {
 163         ALOGE("failed to create %s (%s)", RT_TABLES_PATH, strerror(errno));
 164         return;
 165     }
 166     // File creation is affected by umask, so make sure the right mode bits are set.
 167     if (fchmod(fd, RT_TABLES_MODE) == -1) {
 168         ALOGE("failed to set mode 0%o on %s (%s)", RT_TABLES_MODE, RT_TABLES_PATH, strerror(errno));
 169     }
 170     ssize_t bytesWritten = write(fd, contents.data(), contents.size());
 171     if (bytesWritten != static_cast<ssize_t>(contents.size())) {
 172         ALOGE("failed to write to %s (%zd vs %zu bytes) (%s)", RT_TABLES_PATH, bytesWritten,
 173               contents.size(), strerror(errno));
 174     }
 175     close(fd);
 176 }
 177
 178 // Sends a netlink request and expects an ack.
 179 // |iov| is an array of struct iovec that contains the netlink message payload.
 180 // The netlink header is generated by this function based on |action| and |flags|.
 181 // Returns -errno if there was an error or if the kernel reported an error.
 182 WARN_UNUSED_RESULT int sendNetlinkRequest(uint16_t action, uint16_t flags, iovec* iov, int iovlen) {
 183     nlmsghdr nlmsg = {
 184         .nlmsg_type = action,
 185         .nlmsg_flags = flags,
 186     };
 187     iov[0].iov_base = &nlmsg;
 188     iov[0].iov_len = sizeof(nlmsg);
 189     for (int i = 0; i < iovlen; ++i) {
 190         nlmsg.nlmsg_len += iov[i].iov_len;
 191     }
 192
 193     int ret;
 194     struct {
 195         nlmsghdr msg;
 196         nlmsgerr err;
 197     } response;
 198
 199     int sock = socket(AF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
 200     if (sock != -1 &&
 201             connect(sock, reinterpret_cast<const sockaddr*>(&NETLINK_ADDRESS),
 202                     sizeof(NETLINK_ADDRESS)) != -1 &&
 203             writev(sock, iov, iovlen) != -1 &&
 204             (ret = recv(sock, &response, sizeof(response), 0)) != -1) {
 205         if (ret == sizeof(response)) {
 206             ret = response.err.error;  // Netlink errors are negative errno.
 207             if (ret) {
 208                 ALOGE("netlink response contains error (%s)", strerror(-ret));
 209             }
 210         } else {
 211             ALOGE("bad netlink response message size (%d != %zu)", ret, sizeof(response));
 212             ret = -EBADMSG;
 213         }
 214     } else {
 215         ALOGE("netlink socket/connect/writev/recv failed (%s)", strerror(errno));
 216         ret = -errno;
 217     }
 218
 219     if (sock != -1) {
 220         close(sock);
 221     }
 222
 223     return ret;
 224 }
 225
 226 // Returns 0 on success or negative errno on failure.
 227 int padInterfaceName(const char* input, char* name, size_t* length, uint16_t* padding) {
 228     if (!input) {
 229         *length = 0;
 230         *padding = 0;
 231         return 0;
 232     }
 233     *length = strlcpy(name, input, IFNAMSIZ) + 1;
 234     if (*length > IFNAMSIZ) {
 235         ALOGE("interface name too long (%zu > %u)", *length, IFNAMSIZ);
 236         return -ENAMETOOLONG;
 237     }
 238     *padding = RTA_SPACE(*length) - RTA_LENGTH(*length);
 239     return 0;
 240 }
 241
 242 // Adds or removes a routing rule for IPv4 and IPv6.
 243 //
 244 // + If |table| is non-zero, the rule points at the specified routing table. Otherwise, the rule
 245 //   returns ENETUNREACH.
 246 // + If |mask| is non-zero, the rule matches the specified fwmark and mask. Otherwise, |fwmark| is
 247 //   ignored.
 248 // + If |iif| is non-NULL, the rule matches the specified incoming interface.
 249 // + If |oif| is non-NULL, the rule matches the specified outgoing interface.
 250 // + If |uidStart| and |uidEnd| are not INVALID_UID, the rule matches packets from UIDs in that
 251 //   range (inclusive). Otherwise, the rule matches packets from all UIDs.
 252 //
 253 // Returns 0 on success or negative errno on failure.
 254 WARN_UNUSED_RESULT int modifyIpRule(uint16_t action, uint32_t priority, uint32_t table,
 255                                     uint32_t fwmark, uint32_t mask, const char* iif,
 256                                     const char* oif, uid_t uidStart, uid_t uidEnd) {
 257     // Ensure that if you set a bit in the fwmark, it's not being ignored by the mask.
 258     if (fwmark & ~mask) {
 259         ALOGE("mask 0x%x does not select all the bits set in fwmark 0x%x", mask, fwmark);
 260         return -ERANGE;
 261     }
 262
 263     // Interface names must include exactly one terminating NULL and be properly padded, or older
 264     // kernels will refuse to delete rules.
 265     char iifName[IFNAMSIZ], oifName[IFNAMSIZ];
 266     size_t iifLength, oifLength;
 267     uint16_t iifPadding, oifPadding;
 268     if (int ret = padInterfaceName(iif, iifName, &iifLength, &iifPadding)) {
 269         return ret;
 270     }
 271     if (int ret = padInterfaceName(oif, oifName, &oifLength, &oifPadding)) {
 272         return ret;
 273     }
 274
 275     // Either both start and end UID must be specified, or neither.
 276     if ((uidStart == INVALID_UID) != (uidEnd == INVALID_UID)) {
 277         ALOGE("incompatible start and end UIDs (%u vs %u)", uidStart, uidEnd);
 278         return -EUSERS;
 279     }
 280     bool isUidRule = (uidStart != INVALID_UID);
 281
 282     // Assemble a rule request and put it in an array of iovec structures.
 283     fib_rule_hdr rule = {
 284         .action = static_cast<uint8_t>(table != RT_TABLE_UNSPEC ? FR_ACT_TO_TBL :
 285                                                                   FR_ACT_UNREACHABLE),
 286     };
 287
 288     rtattr fraIifName = { U16_RTA_LENGTH(iifLength), FRA_IIFNAME };
 289     rtattr fraOifName = { U16_RTA_LENGTH(oifLength), FRA_OIFNAME };
 290
 291     iovec iov[] = {
 292         { NULL,              0 },
 293         { &rule,             sizeof(rule) },
 294         { &FRATTR_PRIORITY,  sizeof(FRATTR_PRIORITY) },
 295         { &priority,         sizeof(priority) },
 296         { &FRATTR_TABLE,     table != RT_TABLE_UNSPEC ? sizeof(FRATTR_TABLE) : 0 },
 297         { &table,            table != RT_TABLE_UNSPEC ? sizeof(table) : 0 },
 298         { &FRATTR_FWMARK,    mask ? sizeof(FRATTR_FWMARK) : 0 },
 299         { &fwmark,           mask ? sizeof(fwmark) : 0 },
 300         { &FRATTR_FWMASK,    mask ? sizeof(FRATTR_FWMASK) : 0 },
 301         { &mask,             mask ? sizeof(mask) : 0 },
 302         { &FRATTR_UID_START, isUidRule ? sizeof(FRATTR_UID_START) : 0 },
 303         { &uidStart,         isUidRule ? sizeof(uidStart) : 0 },
 304         { &FRATTR_UID_END,   isUidRule ? sizeof(FRATTR_UID_END) : 0 },
 305         { &uidEnd,           isUidRule ? sizeof(uidEnd) : 0 },
 306         { &fraIifName,       iif != IIF_NONE ? sizeof(fraIifName) : 0 },
 307         { iifName,           iifLength },
 308         { PADDING_BUFFER,    iifPadding },
 309         { &fraOifName,       oif != OIF_NONE ? sizeof(fraOifName) : 0 },
 310         { oifName,           oifLength },
 311         { PADDING_BUFFER,    oifPadding },
 312     };
 313
 314     uint16_t flags = (action == RTM_NEWRULE) ? NETLINK_CREATE_REQUEST_FLAGS : NETLINK_REQUEST_FLAGS;
 315     for (size_t i = 0; i < ARRAY_SIZE(AF_FAMILIES); ++i) {
 316         rule.family = AF_FAMILIES[i];
 317         if (int ret = sendNetlinkRequest(action, flags, iov, ARRAY_SIZE(iov))) {
 318             return ret;
 319         }
 320     }
 321
 322     return 0;
 323 }
 324
 325 WARN_UNUSED_RESULT int modifyIpRule(uint16_t action, uint32_t priority, uint32_t table,
 326                                     uint32_t fwmark, uint32_t mask) {
 327     return modifyIpRule(action, priority, table, fwmark, mask, IIF_NONE, OIF_NONE, INVALID_UID,
 328                         INVALID_UID);
 329 }
 330
 331 // Adds or deletes an IPv4 or IPv6 route.
 332 // Returns 0 on success or negative errno on failure.
 333 WARN_UNUSED_RESULT int modifyIpRoute(uint16_t action, uint32_t table, const char* interface,
 334                                      const char* destination, const char* nexthop) {
 335     // At least the destination must be non-null.
 336     if (!destination) {
 337         ALOGE("null destination");
 338         return -EFAULT;
 339     }
 340
 341     // Parse the prefix.
 342     uint8_t rawAddress[sizeof(in6_addr)];
 343     uint8_t family;
 344     uint8_t prefixLength;
 345     int rawLength = parsePrefix(destination, &family, rawAddress, sizeof(rawAddress),
 346                                 &prefixLength);
 347     if (rawLength < 0) {
 348         ALOGE("parsePrefix failed for destination %s (%s)", destination, strerror(-rawLength));
 349         return rawLength;
 350     }
 351
 352     if (static_cast<size_t>(rawLength) > sizeof(rawAddress)) {
 353         ALOGE("impossible! address too long (%d vs %zu)", rawLength, sizeof(rawAddress));
 354         return -ENOBUFS;  // Cannot happen; parsePrefix only supports IPv4 and IPv6.
 355     }
 356
 357     // If an interface was specified, find the ifindex.
 358     uint32_t ifindex;
 359     if (interface != OIF_NONE) {
 360         ifindex = if_nametoindex(interface);
 361         if (!ifindex) {
 362             ALOGE("cannot find interface %s", interface);
 363             return -ENODEV;
 364         }
 365     }
 366
 367     // If a nexthop was specified, parse it as the same family as the prefix.
 368     uint8_t rawNexthop[sizeof(in6_addr)];
 369     if (nexthop && inet_pton(family, nexthop, rawNexthop) <= 0) {
 370         ALOGE("inet_pton failed for nexthop %s", nexthop);
 371         return -EINVAL;
 372     }
 373
 374     // Assemble a rtmsg and put it in an array of iovec structures.
 375     rtmsg route = {
 376         .rtm_protocol = RTPROT_STATIC,
 377         .rtm_type = RTN_UNICAST,
 378         .rtm_family = family,
 379         .rtm_dst_len = prefixLength,
 380     };
 381
 382     rtattr rtaDst     = { U16_RTA_LENGTH(rawLength), RTA_DST };
 383     rtattr rtaGateway = { U16_RTA_LENGTH(rawLength), RTA_GATEWAY };
 384
 385     iovec iov[] = {
 386         { NULL,          0 },
 387         { &route,        sizeof(route) },
 388         { &RTATTR_TABLE, sizeof(RTATTR_TABLE) },
 389         { &table,        sizeof(table) },
 390         { &rtaDst,       sizeof(rtaDst) },
 391         { rawAddress,    static_cast<size_t>(rawLength) },
 392         { &RTATTR_OIF,   interface != OIF_NONE ? sizeof(RTATTR_OIF) : 0 },
 393         { &ifindex,      interface != OIF_NONE ? sizeof(ifindex) : 0 },
 394         { &rtaGateway,   nexthop ? sizeof(rtaGateway) : 0 },
 395         { rawNexthop,    nexthop ? static_cast<size_t>(rawLength) : 0 },
 396     };
 397
 398     uint16_t flags = (action == RTM_NEWROUTE) ? NETLINK_CREATE_REQUEST_FLAGS :
 399                                                 NETLINK_REQUEST_FLAGS;
 400     return sendNetlinkRequest(action, flags, iov, ARRAY_SIZE(iov));
 401 }
 402
 403 // An iptables rule to mark incoming packets on a network with the netId of the network.
 404 //
 405 // This is so that the kernel can:
 406 // + Use the right fwmark for (and thus correctly route) replies (e.g.: TCP RST, ICMP errors, ping
 407 //   replies, SYN-ACKs, etc).
 408 // + Mark sockets that accept connections from this interface so that the connection stays on the
 409 //   same interface.
 410 WARN_UNUSED_RESULT int modifyIncomingPacketMark(unsigned netId, const char* interface,
 411                                                 Permission permission, bool add) {
 412     Fwmark fwmark;
 413
 414     fwmark.netId = netId;
 415     fwmark.explicitlySelected = true;
 416     fwmark.protectedFromVpn = true;
 417     fwmark.permission = permission;
 418
 419     char markString[UINT32_HEX_STRLEN];
 420     snprintf(markString, sizeof(markString), "0x%x", fwmark.intValue);
 421
 422     if (execIptables(V4V6, "-t", "mangle", add ? "-A" : "-D", "INPUT", "-i", interface, "-j",
 423                      "MARK", "--set-mark", markString, NULL)) {
 424         ALOGE("failed to change iptables rule that sets incoming packet mark");
 425         return -EREMOTEIO;
 426     }
 427
 428     return 0;
 429 }
 430
 431 // A rule to route all traffic from a given set of UIDs to go over the VPN.
 432 //
 433 // Notice that this rule doesn't use the netId. I.e., no matter what netId the user's socket may
 434 // have, if they are subject to this VPN, their traffic has to go through it. Allows the traffic to
 435 // bypass the VPN if the protectedFromVpn bit is set.
 436 WARN_UNUSED_RESULT int modifyVpnUidRangeRule(uint32_t table, uid_t uidStart, uid_t uidEnd,
 437                                              bool add) {
 438     Fwmark fwmark;
 439     Fwmark mask;
 440
 441     fwmark.protectedFromVpn = false;
 442     mask.protectedFromVpn = true;
 443
 444     return modifyIpRule(add ? RTM_NEWRULE : RTM_DELRULE, RULE_PRIORITY_SECURE_VPN, table,
 445                         fwmark.intValue, mask.intValue, IIF_NONE, OIF_NONE, uidStart, uidEnd);
 446 }
 447
 448 // A rule to allow system apps to send traffic over this VPN even if they are not part of the target
 449 // set of UIDs.
 450 //
 451 // This is needed for DnsProxyListener to correctly resolve a request for a user who is in the
 452 // target set, but where the DnsProxyListener itself is not.
 453 WARN_UNUSED_RESULT int modifyVpnSystemPermissionRule(unsigned netId, uint32_t table, bool add) {
 454     Fwmark fwmark;
 455     Fwmark mask;
 456
 457     fwmark.netId = netId;
 458     mask.netId = FWMARK_NET_ID_MASK;
 459
 460     fwmark.permission = PERMISSION_SYSTEM;
 461     mask.permission = PERMISSION_SYSTEM;
 462
 463     return modifyIpRule(add ? RTM_NEWRULE : RTM_DELRULE, RULE_PRIORITY_SECURE_VPN, table,
 464                         fwmark.intValue, mask.intValue);
 465 }
 466
 467 // A rule to route traffic based on an explicitly chosen network.
 468 //
 469 // Supports apps that use the multinetwork APIs to restrict their traffic to a network.
 470 //
 471 // Even though we check permissions at the time we set a netId into the fwmark of a socket, we need
 472 // to check it again in the rules here, because a network's permissions may have been updated via
 473 // modifyNetworkPermission().
 474 WARN_UNUSED_RESULT int modifyExplicitNetworkRule(unsigned netId, uint32_t table,
 475                                                  Permission permission, uid_t uidStart,
 476                                                  uid_t uidEnd, bool add) {
 477     Fwmark fwmark;
 478     Fwmark mask;
 479
 480     fwmark.netId = netId;
 481     mask.netId = FWMARK_NET_ID_MASK;
 482
 483     fwmark.explicitlySelected = true;
 484     mask.explicitlySelected = true;
 485
 486     fwmark.permission = permission;
 487     mask.permission = permission;
 488
 489     return modifyIpRule(add ? RTM_NEWRULE : RTM_DELRULE, RULE_PRIORITY_EXPLICIT_NETWORK, table,
 490                         fwmark.intValue, mask.intValue, IIF_NONE, OIF_NONE, uidStart, uidEnd);
 491 }
 492
 493 // A rule to route traffic based on a chosen outgoing interface.
 494 //
 495 // Supports apps that use SO_BINDTODEVICE or IP_PKTINFO options and the kernel that already knows
 496 // the outgoing interface (typically for link-local communications).
 497 WARN_UNUSED_RESULT int modifyOutputInterfaceRule(const char* interface, uint32_t table,
 498                                                  Permission permission, uid_t uidStart,
 499                                                  uid_t uidEnd, bool add) {
 500     Fwmark fwmark;
 501     Fwmark mask;
 502
 503     fwmark.permission = permission;
 504     mask.permission = permission;
 505
 506     return modifyIpRule(add ? RTM_NEWRULE : RTM_DELRULE, RULE_PRIORITY_OUTPUT_INTERFACE, table,
 507                         fwmark.intValue, mask.intValue, IIF_NONE, interface, uidStart, uidEnd);
 508 }
 509
 510 // A rule to route traffic based on the chosen network.
 511 //
 512 // This is for sockets that have not explicitly requested a particular network, but have been
 513 // bound to one when they called connect(). This ensures that sockets connected on a particular
 514 // network stay on that network even if the default network changes.
 515 WARN_UNUSED_RESULT int modifyImplicitNetworkRule(unsigned netId, uint32_t table,
 516                                                  Permission permission, bool add) {
 517     Fwmark fwmark;
 518     Fwmark mask;
 519
 520     fwmark.netId = netId;
 521     mask.netId = FWMARK_NET_ID_MASK;
 522
 523     fwmark.explicitlySelected = false;
 524     mask.explicitlySelected = true;
 525
 526     fwmark.permission = permission;
 527     mask.permission = permission;
 528
 529     return modifyIpRule(add ? RTM_NEWRULE : RTM_DELRULE, RULE_PRIORITY_IMPLICIT_NETWORK, table,
 530                         fwmark.intValue, mask.intValue);
 531 }
 532
 533 // Add rules to allow legacy routes added through the requestRouteToHost() API.
 534 WARN_UNUSED_RESULT int addLegacyRouteRules() {
 535     Fwmark fwmark;
 536     Fwmark mask;
 537
 538     fwmark.explicitlySelected = false;
 539     mask.explicitlySelected = true;
 540
 541     // Rules to allow legacy routes to override the default network.
 542     if (int ret = modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_LEGACY_SYSTEM, ROUTE_TABLE_LEGACY_SYSTEM,
 543                                fwmark.intValue, mask.intValue)) {
 544         return ret;
 545     }
 546     if (int ret = modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_LEGACY_NETWORK,
 547                                ROUTE_TABLE_LEGACY_NETWORK, fwmark.intValue, mask.intValue)) {
 548         return ret;
 549     }
 550
 551     fwmark.permission = PERMISSION_SYSTEM;
 552     mask.permission = PERMISSION_SYSTEM;
 553
 554     // A rule to allow legacy routes from system apps to override VPNs.
 555     return modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_VPN_OVERRIDE_SYSTEM, ROUTE_TABLE_LEGACY_SYSTEM,
 556                         fwmark.intValue, mask.intValue);
 557 }
 558
 559 // Add rules to lookup the local network when specified explicitly or otherwise.
 560 WARN_UNUSED_RESULT int addLocalNetworkRules(unsigned localNetId) {
 561     if (int ret = modifyExplicitNetworkRule(localNetId, ROUTE_TABLE_LOCAL_NETWORK, PERMISSION_NONE,
 562                                             INVALID_UID, INVALID_UID, ACTION_ADD)) {
 563         return ret;
 564     }
 565
 566     Fwmark fwmark;
 567     Fwmark mask;
 568
 569     fwmark.explicitlySelected = false;
 570     mask.explicitlySelected = true;
 571
 572     return modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_LOCAL_NETWORK, ROUTE_TABLE_LOCAL_NETWORK,
 573                         fwmark.intValue, mask.intValue);
 574 }
 575
 576 // Add a new rule to look up the 'main' table, with the same selectors as the "default network"
 577 // rule, but with a lower priority. Since the default network rule points to a table with a default
 578 // route, the rule we're adding will never be used for normal routing lookups. However, the kernel
 579 // may fall-through to it to find directly-connected routes when it validates that a nexthop (in a
 580 // route being added) is reachable.
 581 WARN_UNUSED_RESULT int addDirectlyConnectedRule() {
 582     Fwmark fwmark;
 583     Fwmark mask;
 584
 585     fwmark.netId = NETID_UNSET;
 586     mask.netId = FWMARK_NET_ID_MASK;
 587
 588     return modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_DIRECTLY_CONNECTED, RT_TABLE_MAIN,
 589                         fwmark.intValue, mask.intValue, IIF_NONE, OIF_NONE, UID_ROOT, UID_ROOT);
 590 }
 591
 592 // Add a rule to preempt the pre-defined "from all lookup main" rule. Packets that reach this rule
 593 // will be null-routed, and won't fall-through to the main table.
 594 WARN_UNUSED_RESULT int addUnreachableRule() {
 595     return modifyIpRule(RTM_NEWRULE, RULE_PRIORITY_UNREACHABLE, RT_TABLE_UNSPEC, MARK_UNSET,
 596                         MARK_UNSET);
 597 }
 598
 599 WARN_UNUSED_RESULT int modifyLocalNetwork(unsigned netId, const char* interface, bool add) {
 600     if (int ret = modifyIncomingPacketMark(netId, interface, PERMISSION_NONE, add)) {
 601         return ret;
 602     }
 603     return modifyOutputInterfaceRule(interface, ROUTE_TABLE_LOCAL_NETWORK, PERMISSION_NONE,
 604                                      INVALID_UID, INVALID_UID, add);
 605 }
 606
 607 WARN_UNUSED_RESULT int modifyPhysicalNetwork(unsigned netId, const char* interface,
 608                                              Permission permission, bool add) {
 609     uint32_t table = getRouteTableForInterface(interface);
 610     if (table == RT_TABLE_UNSPEC) {
 611         return -ESRCH;
 612     }
 613
 614     if (int ret = modifyIncomingPacketMark(netId, interface, permission, add)) {
 615         return ret;
 616     }
 617     if (int ret = modifyExplicitNetworkRule(netId, table, permission, INVALID_UID, INVALID_UID,
 618                                             add)) {
 619         return ret;
 620     }
 621     if (int ret = modifyOutputInterfaceRule(interface, table, permission, INVALID_UID, INVALID_UID,
 622                                             add)) {
 623         return ret;
 624     }
 625     return modifyImplicitNetworkRule(netId, table, permission, add);
 626 }
 627
 628 WARN_UNUSED_RESULT int modifyVirtualNetwork(unsigned netId, const char* interface,
 629                                             const UidRanges& uidRanges, bool add,
 630                                             bool modifyNonUidBasedRules) {
 631     uint32_t table = getRouteTableForInterface(interface);
 632     if (table == RT_TABLE_UNSPEC) {
 633         return -ESRCH;
 634     }
 635
 636     for (const UidRanges::Range& range : uidRanges.getRanges()) {
 637         if (int ret = modifyVpnUidRangeRule(table, range.first, range.second, add)) {
 638             return ret;
 639         }
 640         if (int ret = modifyExplicitNetworkRule(netId, table, PERMISSION_NONE, range.first,
 641                                                 range.second, add)) {
 642             return ret;
 643         }
 644         if (int ret = modifyOutputInterfaceRule(interface, table, PERMISSION_NONE, range.first,
 645                                                 range.second, add)) {
 646             return ret;
 647         }
 648     }
 649
 650     if (modifyNonUidBasedRules) {
 651         if (int ret = modifyIncomingPacketMark(netId, interface, PERMISSION_NONE, add)) {
 652             return ret;
 653         }
 654         if (int ret = modifyVpnSystemPermissionRule(netId, table, add)) {
 655             return ret;
 656         }
 657         return modifyExplicitNetworkRule(netId, table, PERMISSION_NONE, UID_ROOT, UID_ROOT, add);
 658     }
 659
 660     return 0;
 661 }
 662
 663 WARN_UNUSED_RESULT int modifyDefaultNetwork(uint16_t action, const char* interface,
 664                                             Permission permission) {
 665     uint32_t table = getRouteTableForInterface(interface);
 666     if (table == RT_TABLE_UNSPEC) {
 667         return -ESRCH;
 668     }
 669
 670     Fwmark fwmark;
 671     Fwmark mask;
 672
 673     fwmark.netId = NETID_UNSET;
 674     mask.netId = FWMARK_NET_ID_MASK;
 675
 676     fwmark.permission = permission;
 677     mask.permission = permission;
 678
 679     return modifyIpRule(action, RULE_PRIORITY_DEFAULT_NETWORK, table, fwmark.intValue,
 680                         mask.intValue);
 681 }
 682
 683 WARN_UNUSED_RESULT int modifyTetheredNetwork(uint16_t action, const char* inputInterface,
 684                                              const char* outputInterface) {
 685     uint32_t table = getRouteTableForInterface(outputInterface);
 686     if (table == RT_TABLE_UNSPEC) {
 687         return -ESRCH;
 688     }
 689
 690     return modifyIpRule(action, RULE_PRIORITY_TETHERING, table, MARK_UNSET, MARK_UNSET,
 691                         inputInterface, OIF_NONE, INVALID_UID, INVALID_UID);
 692 }
 693
 694 // Returns 0 on success or negative errno on failure.
 695 WARN_UNUSED_RESULT int flushRules() {
 696     for (size_t i = 0; i < ARRAY_SIZE(IP_VERSIONS); ++i) {
 697         const char* argv[] = {
 698             IP_PATH,
 699             IP_VERSIONS[i],
 700             "rule",
 701             "flush",
 702         };
 703         if (android_fork_execvp(ARRAY_SIZE(argv), const_cast<char**>(argv), NULL, false, false)) {
 704             ALOGE("failed to flush rules");
 705             return -EREMOTEIO;
 706         }
 707     }
 708     return 0;
 709 }
 710
 711 // Adds or removes an IPv4 or IPv6 route to the specified table and, if it's a directly-connected
 712 // route, to the main table as well.
 713 // Returns 0 on success or negative errno on failure.
 714 WARN_UNUSED_RESULT int modifyRoute(uint16_t action, const char* interface, const char* destination,
 715                                    const char* nexthop, RouteController::TableType tableType) {
 716     uint32_t table;
 717     switch (tableType) {
 718         case RouteController::INTERFACE: {
 719             table = getRouteTableForInterface(interface);
 720             if (table == RT_TABLE_UNSPEC) {
 721                 return -ESRCH;
 722             }
 723             break;
 724         }
 725         case RouteController::LOCAL_NETWORK: {
 726             table = ROUTE_TABLE_LOCAL_NETWORK;
 727             break;
 728         }
 729         case RouteController::LEGACY_NETWORK: {
 730             table = ROUTE_TABLE_LEGACY_NETWORK;
 731             break;
 732         }
 733         case RouteController::LEGACY_SYSTEM: {
 734             table = ROUTE_TABLE_LEGACY_SYSTEM;
 735             break;
 736         }
 737     }
 738
 739     int ret = modifyIpRoute(action, table, interface, destination, nexthop);
 740     // We allow apps to call requestRouteToHost() multiple times with the same route, so ignore
 741     // EEXIST failures when adding routes to legacy tables.
 742     if (ret && !(action == RTM_NEWROUTE && ret == -EEXIST &&
 743                  (tableType == RouteController::LEGACY_NETWORK ||
 744                   tableType == RouteController::LEGACY_SYSTEM))) {
 745         return ret;
 746     }
 747
 748     // If there's no nexthop, this is a directly connected route. Add it to the main table also, to
 749     // let the kernel find it when validating nexthops when global routes are added.
 750     if (!nexthop) {
 751         ret = modifyIpRoute(action, RT_TABLE_MAIN, interface, destination, NULL);
 752         // A failure with action == ADD && errno == EEXIST means that the route already exists in
 753         // the main table, perhaps because the kernel added it automatically as part of adding the
 754         // IP address to the interface. Ignore this, but complain about everything else.
 755         if (ret && !(action == RTM_NEWROUTE && ret == -EEXIST)) {
 756             return ret;
 757         }
 758     }
 759
 760     return 0;
 761 }
 762
 763 // Returns 0 on success or negative errno on failure.
 764 WARN_UNUSED_RESULT int flushRoutes(const char* interface) {
 765     uint32_t table = getRouteTableForInterface(interface);
 766     if (table == RT_TABLE_UNSPEC) {
 767         return -ESRCH;
 768     }
 769
 770     char tableString[UINT32_STRLEN];
 771     snprintf(tableString, sizeof(tableString), "%u", table);
 772
 773     for (size_t i = 0; i < ARRAY_SIZE(IP_VERSIONS); ++i) {
 774         const char* argv[] = {
 775             IP_PATH,
 776             IP_VERSIONS[i],
 777             "route",
 778             "flush",
 779             "table",
 780             tableString,
 781         };
 782         if (android_fork_execvp(ARRAY_SIZE(argv), const_cast<char**>(argv), NULL, false, false)) {
 783             ALOGE("failed to flush routes");
 784             return -EREMOTEIO;
 785         }
 786     }
 787
 788     interfaceToTable.erase(interface);
 789     return 0;
 790 }
 791
 792 }  // namespace
 793
 794 int RouteController::Init(unsigned localNetId) {
 795     if (int ret = flushRules()) {
 796         return ret;
 797     }
 798     if (int ret = addLegacyRouteRules()) {
 799         return ret;
 800     }
 801     if (int ret = addLocalNetworkRules(localNetId)) {
 802         return ret;
 803     }
 804     if (int ret = addDirectlyConnectedRule()) {
 805         return ret;
 806     }
 807     if (int ret = addUnreachableRule()) {
 808         return ret;
 809     }
 810     updateTableNamesFile();
 811     return 0;
 812 }
 813
 814 int RouteController::addInterfaceToLocalNetwork(unsigned netId, const char* interface) {
 815     return modifyLocalNetwork(netId, interface, ACTION_ADD);
 816 }
 817
 818 int RouteController::removeInterfaceFromLocalNetwork(unsigned netId, const char* interface) {
 819     return modifyLocalNetwork(netId, interface, ACTION_DEL);
 820 }
 821
 822 int RouteController::addInterfaceToPhysicalNetwork(unsigned netId, const char* interface,
 823                                                    Permission permission) {
 824     if (int ret = modifyPhysicalNetwork(netId, interface, permission, ACTION_ADD)) {
 825         return ret;
 826     }
 827     updateTableNamesFile();
 828     return 0;
 829 }
 830
 831 int RouteController::removeInterfaceFromPhysicalNetwork(unsigned netId, const char* interface,
 832                                                         Permission permission) {
 833     if (int ret = modifyPhysicalNetwork(netId, interface, permission, ACTION_DEL)) {
 834         return ret;
 835     }
 836     if (int ret = flushRoutes(interface)) {
 837         return ret;
 838     }
 839     updateTableNamesFile();
 840     return 0;
 841 }
 842
 843 int RouteController::addInterfaceToVirtualNetwork(unsigned netId, const char* interface,
 844                                                   const UidRanges& uidRanges) {
 845     if (int ret = modifyVirtualNetwork(netId, interface, uidRanges, ACTION_ADD,
 846                                        MODIFY_NON_UID_BASED_RULES)) {
 847         return ret;
 848     }
 849     updateTableNamesFile();
 850     return 0;
 851 }
 852
 853 int RouteController::removeInterfaceFromVirtualNetwork(unsigned netId, const char* interface,
 854                                                        const UidRanges& uidRanges) {
 855     if (int ret = modifyVirtualNetwork(netId, interface, uidRanges, ACTION_DEL,
 856                                        MODIFY_NON_UID_BASED_RULES)) {
 857         return ret;
 858     }
 859     if (int ret = flushRoutes(interface)) {
 860         return ret;
 861     }
 862     updateTableNamesFile();
 863     return 0;
 864 }
 865
 866 int RouteController::modifyPhysicalNetworkPermission(unsigned netId, const char* interface,
 867                                                      Permission oldPermission,
 868                                                      Permission newPermission) {
 869     // Add the new rules before deleting the old ones, to avoid race conditions.
 870     if (int ret = modifyPhysicalNetwork(netId, interface, newPermission, ACTION_ADD)) {
 871         return ret;
 872     }
 873     return modifyPhysicalNetwork(netId, interface, oldPermission, ACTION_DEL);
 874 }
 875
 876 int RouteController::addUsersToVirtualNetwork(unsigned netId, const char* interface,
 877                                               const UidRanges& uidRanges) {
 878     return modifyVirtualNetwork(netId, interface, uidRanges, ACTION_ADD,
 879                                 !MODIFY_NON_UID_BASED_RULES);
 880 }
 881
 882 int RouteController::removeUsersFromVirtualNetwork(unsigned netId, const char* interface,
 883                                                    const UidRanges& uidRanges) {
 884     return modifyVirtualNetwork(netId, interface, uidRanges, ACTION_DEL,
 885                                 !MODIFY_NON_UID_BASED_RULES);
 886 }
 887
 888 int RouteController::addInterfaceToDefaultNetwork(const char* interface, Permission permission) {
 889     return modifyDefaultNetwork(RTM_NEWRULE, interface, permission);
 890 }
 891
 892 int RouteController::removeInterfaceFromDefaultNetwork(const char* interface,
 893                                                        Permission permission) {
 894     return modifyDefaultNetwork(RTM_DELRULE, interface, permission);
 895 }
 896
 897 int RouteController::addRoute(const char* interface, const char* destination, const char* nexthop,
 898                               TableType tableType) {
 899     return modifyRoute(RTM_NEWROUTE, interface, destination, nexthop, tableType);
 900 }
 901
 902 int RouteController::removeRoute(const char* interface, const char* destination,
 903                                  const char* nexthop, TableType tableType) {
 904     return modifyRoute(RTM_DELROUTE, interface, destination, nexthop, tableType);
 905 }
 906
 907 int RouteController::enableTethering(const char* inputInterface, const char* outputInterface) {
 908     return modifyTetheredNetwork(RTM_NEWRULE, inputInterface, outputInterface);
 909 }
 910
 911 int RouteController::disableTethering(const char* inputInterface, const char* outputInterface) {
 912     return modifyTetheredNetwork(RTM_DELRULE, inputInterface, outputInterface);
 913 }