patchpanel/ndproxy.h

// Copyright 2019 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PATCHPANEL_NDPROXY_H_
#define PATCHPANEL_NDPROXY_H_

#include <stdint.h>

#include <linux/if_ether.h>
#include <net/ethernet.h>
#include <netinet/icmp6.h>
#include <netinet/ip.h>
#include <netinet/ip6.h>

#include <map>
#include <memory>
#include <optional>
#include <set>

#include <base/files/scoped_file.h>
#include <brillo/daemons/daemon.h>
#include <chromeos/net-base/ipv6_address.h>
#include <chromeos/net-base/mac_address.h>
#include <chromeos/net-base/socket.h>
#include <gtest/gtest_prod.h>  // for FRIEND_TEST

#include "patchpanel/ipc.h"
#include "patchpanel/message_dispatcher.h"
#include "patchpanel/rtnl_client.h"

namespace patchpanel {

// Forward ICMPv6 RS/RA/NS/NA mssages between network interfaces according to
// RFC 4389. Support asymmetric proxy that RS will be proxied one-way from
// guest interface to physical interface ('Outbound') and RA the other way back
// ('Inbound'), as well as symmetric proxy among guest interfaces that only
// NS/NA will be proxied.
class NDProxy {
 public:
  static constexpr ssize_t kTranslateErrorNotICMPv6Packet = -1;
  static constexpr ssize_t kTranslateErrorNotNDPacket = -2;
  static constexpr ssize_t kTranslateErrorInsufficientLength = -3;
  static constexpr ssize_t kTranslateErrorBufferMisaligned = -4;
  static constexpr ssize_t kTranslateErrorMismatchedIp6Length = -5;

  using GuestIpDiscoveryHandler = base::RepeatingCallback<void(
      int /*if_id*/, const net_base::IPv6Address& /*ip6addr*/)>;
  using RouterDiscoveryHandler = base::RepeatingCallback<void(
      int /*if_id*/, const net_base::IPv6CIDR& /*prefix_cidr*/)>;

  NDProxy();
  NDProxy(const NDProxy&) = delete;
  NDProxy& operator=(const NDProxy&) = delete;

  virtual ~NDProxy() = default;

  // Given the ICMPv6 packet |icmp6| with header and options (payload) of total
  // byte length |icmp6_len|, returns a pointer to the start of the prefix
  // information, or returns nullptr if no option of type
  // ND_OPT_PREFIX_INFORMATION was found.
  static const nd_opt_prefix_info* GetPrefixInfoOption(const uint8_t* icmp6,
                                                       size_t icmp6_len);
  static nd_opt_prefix_info* GetPrefixInfoOption(uint8_t* icmp6,
                                                 size_t icmp6_len);

  // Helper function to create a AF_PACKET socket suitable for frame read/write.
  static std::unique_ptr<net_base::Socket> PreparePacketSocket();

  // Initialize the resources needed such as rtnl socket and dummy socket for
  // ioctl. Return false if failed.
  bool Init();

  // Read one IP packet from AF_PACKET socket |fd| and process it. If proxying
  // is needed, translated packets are sent out through the same socket.
  void ReadAndProcessOnePacket(int fd);

  // NDProxy can trigger a callback upon a neighbor discovered on downlink. This
  // can be triggered by either receiving a unicast NA, or an NS with non-link
  // local source address.
  // Arguments: receiving interface index, neighbor address.
  void RegisterOnGuestIpDiscoveryHandler(GuestIpDiscoveryHandler handler);

  // Callback upon receiving prefix information from RA frame.
  // Arguments: receiving interface index, CIDR with prefix address.
  void RegisterOnRouterDiscoveryHandler(RouterDiscoveryHandler handler);

  // Start proxying RS from |if_id_downstream| to |if_id_upstream|, and RA the
  // other way around. If |modify_router_address| is true we modify source
  // address when proxying RA so that downstream thinks ChromeOS host as the
  // router.
  void StartRSRAProxy(int if_id_upstream,
                      int if_id_downstream,
                      bool modify_router_address = false);
  // Start proxying NS from |if_id_ns_side| to |if_id_na_side| and NA the other
  // way around.
  void StartNSNAProxy(int if_id_na_side, int if_id_ns_side);
  // Stop all proxying between |if_id1| and |if_id2|.
  void StopProxy(int if_id1, int if_id2);
  // Add and remove interfaces that neighbor IP are monitored besides the
  // proxied ones, specified by |if_id|.
  void StartNeighborMonitor(int if_id);
  void StopNeighborMonitor(int if_id);
  // Start and stop ARC sleep mode on |if_id|. NS and NA proxying are skipped
  // for the interface in this mode.
  void StartARCSleepModeFilter(int if_id);
  void StopARCSleepModeFilter(int if_id);

 protected:
  // RFC 4389: Read the input ICMPv6 packet in |in_packet| and determine whether
  // it should be proxied. If so, fill the |out_packet| buffer with proxied
  // packet and return the length of proxied packet (usually same with input
  // frame length). Return a negative value if proxy is not needed or an error
  // occurred.
  //   in_packet: buffer containing input IPv6 packet.
  //   packet_len: the length of input IPv6 packet;
  //   local_mac_addr: MAC address of interface that will be used to send the
  //       proxied packet;
  //   new_src_ip: if not std::nullopt, address that will be used for the IP
  //       header source address to send the proxied packet;
  //   new_dst_ip: if not std::nullopt, address that will be used for the IP
  //       header destination address to send the proxied packet;
  //   out_packet: buffer for output IPv6 pacet; should have at least
  //       packet_len space.
  static ssize_t TranslateNDPacket(
      const uint8_t* in_packet,
      size_t packet_len,
      net_base::MacAddress local_mac_addr,
      const std::optional<net_base::IPv6Address>& new_src_ip,
      const std::optional<net_base::IPv6Address>& new_dst_ip,
      uint8_t* out_packet);

  // Given the ICMPv6 segment |icmp6| with header and options (payload) of total
  // byte length |icmp6_len|, overwrites in option |opt_type| the mac address
  // with |target_mac|. |icmp6_len| is the total size in bytes of the ICMPv6
  // segment. |nd_hdr_len| is the length of ICMPv6 header (so the first option
  // starts after |nd_hdr_len|.)
  static void ReplaceMacInIcmpOption(uint8_t* icmp6,
                                     size_t icmp6_len,
                                     size_t nd_hdr_len,
                                     uint8_t opt_type,
                                     net_base::MacAddress target_mac);

  // Returns the resolved MAC for destination IP address |dest_ipv6|. A neighbor
  // table lookup may take place but no NS message will be sent.
  // Returns std::nullopt the IP cannot be resolved.
  std::optional<net_base::MacAddress> ResolveDestinationMac(
      const net_base::IPv6Address& dest_ipv6);

  // Trigger the router discovery and neighbor discovery callbacks upon
  // receiving a corresponding packet.
  void NotifyPacketCallbacks(int recv_ifindex,
                             const uint8_t* packet,
                             size_t len);

 private:
  // Data structure to store interface mapping for a certain kind of packet to
  // be proxied. For example, {1: {2}, 2: {1}} means that packet from interfaces
  // 1 and 2 will be proxied to each other.
  using interface_mapping = std::map<int, std::set<int>>;

  // Get MAC address on a local interface through ioctl().
  // Returns std::nullopt upon failure.
  virtual std::optional<net_base::MacAddress> GetLocalMac(int if_id);

  // Query kernel NDP table and get the MAC address of a certain IPv6 neighbor.
  // Returns std::nullopt when neighbor entry is not found.
  virtual std::optional<net_base::MacAddress> GetNeighborMac(
      const net_base::IPv6Address& ipv6_addr);

  // Get the link local IPv6 address on a local interface.
  // Returns std::nullopt upon failure.
  virtual std::optional<net_base::IPv6Address> GetLinkLocalAddress(int if_id);

  interface_mapping* MapForType(uint8_t type);
  bool IsGuestInterface(int ifindex);
  bool IsRouterInterface(int ifindex);

  // Socket used to communicate with kernel through ioctl. No real packet data
  // goes through this socket.
  base::ScopedFD dummy_fd_;

  std::unique_ptr<RTNLClient> rtnl_client_;

  // Fixed buffers for receiving and sending IP packets.
  uint8_t* in_packet_buffer_[IP_MAXPACKET];
  uint8_t* out_packet_buffer_[IP_MAXPACKET];

  // Maps of interface names to set of interfaces to which a given ICMP6 types
  // of ND packet should be forwarded. For any ND packet of a given ICMP6 type
  // arriving on an interface, the relevant map indicates which other interfaces
  // this packets should be proxied to.
  interface_mapping if_map_rs_;
  interface_mapping if_map_ra_;
  interface_mapping if_map_ns_;
  interface_mapping if_map_na_;

  // The set of uplink interfaces from which the RA should be injected so that
  // the downstream guests treat the host as the next hop router.
  std::set<int> modify_ra_uplinks_;

  // Set of links for which the neighbor IPs are monitored and NeighborDetected
  // events are fired. Any downlinks that are part of a forwarding group are
  // always monitored and do not need to be added to this.
  std::set<int> neighbor_monitor_links_;

  // Set of links to which NS and NA forwarding are paused temporarily.
  std::set<int> sleep_mode_filter_links_;

  // The amount of packets of which forwarding are skipped. Reset when
  // StartARCSleepModeFilter is called again. This is just for logging purposes.
  int sleep_mode_filtered_packet_count_ = 0;

  // Map from downlink interface id to the link local address on it
  std::map<int, net_base::IPv6Address> downlink_link_local_;

  GuestIpDiscoveryHandler guest_discovery_handler_;
  RouterDiscoveryHandler router_discovery_handler_;

  base::WeakPtrFactory<NDProxy> weak_factory_{this};
};

// A wrapper class for running NDProxy in a daemon process. Control messages and
// guest IP discovery messages are passed through |control_fd|.
class NDProxyDaemon : public brillo::Daemon {
 public:
  explicit NDProxyDaemon(base::ScopedFD control_fd);
  NDProxyDaemon(const NDProxyDaemon&) = delete;
  NDProxyDaemon& operator=(const NDProxyDaemon&) = delete;

  ~NDProxyDaemon() override;

 private:
  // Overrides Daemon init callback. Returns 0 on success and < 0 on error.
  int OnInit() override;
  // FileDescriptorWatcher callbacks for new data on socket_.
  void OnDataSocketReadReady();
  // Callbacks to be registered to msg_dispatcher to handle control messages.
  void OnParentProcessExit();
  void OnControlMessage(const SubprocessMessage& msg);

  // Callback from NDProxy core when receive NA from guest
  void OnGuestIpDiscovery(int if_id, const net_base::IPv6Address& ip6addr);

  // Callback from NDProxy core when receive prefix info from router
  void OnRouterDiscovery(int if_id, const net_base::IPv6CIDR& prefix_cidr);

  // Utilize MessageDispatcher to watch control fd
  std::unique_ptr<MessageDispatcher<SubprocessMessage>> msg_dispatcher_;

  // Data socket.
  std::unique_ptr<net_base::Socket> socket_;

  NDProxy proxy_;

  base::WeakPtrFactory<NDProxyDaemon> weak_factory_{this};
};

}  // namespace patchpanel

#endif  // PATCHPANEL_NDPROXY_H_