patchpanel/downstream_network_info.h

// Copyright 2023 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_DOWNSTREAM_NETWORK_INFO_H_
#define PATCHPANEL_DOWNSTREAM_NETWORK_INFO_H_

#include <iostream>
#include <memory>
#include <optional>
#include <string>
#include <vector>

#include <base/functional/callback_helpers.h>
#include <chromeos/net-base/ipv4_address.h>
#include <chromeos/net-base/ipv6_address.h>
#include <chromeos/net-base/mac_address.h>
#include <patchpanel/proto_bindings/patchpanel_service.pb.h>

#include "patchpanel/dhcp_server_controller.h"
#include "patchpanel/metrics.h"
#include "patchpanel/routing_service.h"
#include "patchpanel/shill_client.h"

namespace patchpanel {

// Describes the type of CreateNetwork request issued by shill.
enum class DownstreamNetworkTopology {
  // CreateTetheredNetwork DBus method call.
  kTethering,
  // CreateLocalOnlyNetwork DBus method call.
  kLocalOnly,
};

// Describes a CreateNetwork request issued by shill.
struct DownstreamNetworkInfo {
  // The unique id assigned to this network managed as a DownstreamNetwork by
  // patchpanel.
  int network_id;
  // The type of DownstreamNetwork requested by shill.
  DownstreamNetworkTopology topology;
  // The upstream interface is only defined for Tethering. It is left undefined
  // for LocalOnlyNetwork.
  // TODO(b/273744897): Replace ShillClient::Device with the upstream
  // network_id of the shill Network.
  std::optional<ShillClient::Device> upstream_device;
  std::string downstream_ifname;
  // IPv4 CIDR of the DUT on the downstream network. This is the effective
  // gateway address for clients connected on the network.
  net_base::IPv4CIDR ipv4_cidr;
  // The MTU of the upstream. std::nullopt means the MTU is set to the default
  // value (i.e. 1500).
  std::optional<int> mtu;

  // Set to true if IPv4 DHCP server is created at the downstream.
  bool enable_ipv4_dhcp;
  // IPv4 DHCP IP range, only used when |enable_ipv4_dhcp| is true.
  net_base::IPv4Address ipv4_dhcp_start_addr;
  net_base::IPv4Address ipv4_dhcp_end_addr;
  //  The DNS server of the DHCP option, only used when |enable_ipv4_dhcp| is
  //  true.
  std::vector<net_base::IPv4Address> dhcp_dns_servers;
  // The domain search of the DHCP option, only used when |enable_ipv4_dhcp| is
  // true.
  std::vector<std::string> dhcp_domain_searches;
  // The extra DHCP options, only used when |enable_ipv4_dhcp| is true.
  DHCPServerController::Config::DHCPOptions dhcp_options;
  // Set to true if GuestIPv6Service is used on the downstream network.
  bool enable_ipv6;
  // TODO(b/239559602) Add IPv6 configuration for LocalOnlyNetwork.
  // Closure to cancel lifeline FD tracking the file descriptor committed by the
  // DBus client.
  base::ScopedClosureRunner cancel_lifeline_fd;

  // Creates the DownstreamNetworkInfo instance from TetheredNetworkRequest.
  // Returns nullptr in case of failure.
  static std::unique_ptr<DownstreamNetworkInfo> Create(
      const TetheredNetworkRequest& request,
      const ShillClient::Device& shill_device);
  // Creates the DownstreamNetworkInfo instance from LocalOnlyNetworkRequest.
  // Returns nullptr in case of failure.
  static std::unique_ptr<DownstreamNetworkInfo> Create(
      const LocalOnlyNetworkRequest& request);

  // Creates the configuration of the DHCPServerController.
  std::optional<DHCPServerController::Config> ToDHCPServerConfig() const;

  // Returns the TrafficSource to assign to traffic originated from the
  // downstream interface of this DownstreamNetworkInfo object.
  TrafficSource GetTrafficSource() const;
};

// Describes a downstream client's information. See NetworkClientInfo in
// patchpanel_service.proto.
struct DownstreamClientInfo {
  net_base::MacAddress mac_addr;
  net_base::IPv4Address ipv4_addr;
  std::vector<net_base::IPv6Address> ipv6_addresses;
  std::string hostname;
  std::string vendor_class;
};

CreateDownstreamNetworkResult DownstreamNetworkResultToUMAEvent(
    patchpanel::DownstreamNetworkResult result);

std::ostream& operator<<(std::ostream& stream,
                         const DownstreamNetworkInfo& info);

}  // namespace patchpanel

#endif  // PATCHPANEL_DOWNSTREAM_NETWORK_INFO_H_