shill/ipconfig.cc

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

#include "shill/ipconfig.h"

#include <limits>
#include <string>
#include <utility>
#include <vector>

#include <base/logging.h>
#include <base/strings/strcat.h>
#include <base/strings/string_number_conversions.h>
#include <chromeos/dbus/service_constants.h>

#include "shill/adaptor_interfaces.h"
#include "shill/control_interface.h"
#include "shill/error.h"
#include "shill/logging.h"
#include "shill/network/network_config.h"

namespace shill {

namespace Logging {
static auto kModuleLogScope = ScopeLogger::kInet;
static std::string ObjectID(const IPConfig* i) {
  return i->GetRpcIdentifier().value();
}
}  // namespace Logging

namespace {

constexpr char kTypeIP[] = "ip";

template <class T>
void ApplyOptional(const std::optional<T>& src, T* dst) {
  if (src.has_value()) {
    *dst = src.value();
  }
}

}  // namespace

IPConfig::Properties::Properties() = default;
IPConfig::Properties::~Properties() = default;

bool IPConfig::Properties::HasIPAddressAndDNS() const {
  return !address.empty() && !dns_servers.empty();
}

NetworkConfig IPConfig::Properties::ToNetworkConfig() const {
  NetworkConfig ret;

  if (mtu != IPConfig::kUndefinedMTU) {
    ret.mtu = mtu;
  }
  ret.dns_search_domains = domain_search;
  ret.dns_servers = dns_servers;

  if (address_family != IPAddress::kFamilyIPv4 &&
      address_family != IPAddress::kFamilyIPv6) {
    LOG(INFO) << "The input IPConfig::Properties does not have an valid "
                 "family. Skip setting family-specific fields.";
    return ret;
  }

  NetworkConfig::RouteProperties* route_props = nullptr;
  switch (address_family) {
    case IPAddress::kFamilyIPv4:
      if (!address.empty()) {
        ret.ipv4_address_cidr =
            base::StrCat({address, "/", base::NumberToString(subnet_prefix)});
      }
      ret.ipv4_default_route = default_route;
      route_props = &ret.ipv4_route;
      break;
    case IPAddress::kFamilyIPv6:
      if (!address.empty()) {
        ret.ipv6_address_cidrs = std::vector<std::string>{};
        ret.ipv6_address_cidrs->push_back(
            base::StrCat({address, "/", base::NumberToString(subnet_prefix)}));
      }
      route_props = &ret.ipv6_route;
      break;
    default:
      LOG(INFO) << "The input IPConfig::Properties does not have an valid "
                   "family. Skip setting family-specific fields.";
      return ret;
  }

  route_props->gateway = gateway;
  route_props->included_route_prefixes = inclusion_list;
  route_props->excluded_route_prefixes = exclusion_list;

  return ret;
}

void IPConfig::Properties::UpdateFromNetworkConfig(
    const NetworkConfig& network_config) {
  if (address_family == IPAddress::kFamilyUnknown) {
    // In situations where no address is supplied (bad or missing DHCP config)
    // supply an address family ourselves.
    address_family = IPAddress::kFamilyIPv4;
  }
  if (method.empty()) {
    // When it's empty, it means there is no other IPConfig provider now (e.g.,
    // DHCP). A StaticIPParameters object is only for IPv4.
    method = kTypeIPv4;
  }

  if (address_family != IPAddress::kFamilyIPv4) {
    LOG(DFATAL) << "The IPConfig object is not for IPv4, but for "
                << address_family;
    return;
  }

  if (network_config.ipv4_address_cidr.has_value()) {
    IPAddress addr(IPAddress::kFamilyIPv4);
    if (addr.SetAddressAndPrefixFromString(
            network_config.ipv4_address_cidr.value())) {
      address = addr.ToString();
      subnet_prefix = addr.prefix();
    } else {
      LOG(ERROR) << "ipv4_address_cidr does not have a valid value "
                 << network_config.ipv4_address_cidr.value();
    }
  }
  ApplyOptional(network_config.ipv4_default_route, &default_route);
  ApplyOptional(network_config.ipv4_route.gateway, &gateway);
  ApplyOptional(network_config.ipv4_route.included_route_prefixes,
                &inclusion_list);
  ApplyOptional(network_config.ipv4_route.excluded_route_prefixes,
                &exclusion_list);
  ApplyOptional(network_config.mtu, &mtu);
  ApplyOptional(network_config.dns_servers, &dns_servers);
  ApplyOptional(network_config.dns_search_domains, &domain_search);
}

// static
uint32_t IPConfig::global_serial_ = 0;

IPConfig::IPConfig(ControlInterface* control_interface,
                   const std::string& device_name)
    : IPConfig(control_interface, device_name, kTypeIP) {}

IPConfig::IPConfig(ControlInterface* control_interface,
                   const std::string& device_name,
                   const std::string& type)
    : device_name_(device_name),
      type_(type),
      serial_(global_serial_++),
      adaptor_(control_interface->CreateIPConfigAdaptor(this)) {
  store_.RegisterConstString(kAddressProperty, &properties_.address);
  store_.RegisterConstString(kBroadcastProperty,
                             &properties_.broadcast_address);
  store_.RegisterConstString(kDomainNameProperty, &properties_.domain_name);
  store_.RegisterConstString(kGatewayProperty, &properties_.gateway);
  store_.RegisterConstString(kMethodProperty, &properties_.method);
  store_.RegisterConstInt32(kMtuProperty, &properties_.mtu);
  store_.RegisterConstStrings(kNameServersProperty, &properties_.dns_servers);
  store_.RegisterConstString(kPeerAddressProperty, &properties_.peer_address);
  store_.RegisterConstInt32(kPrefixlenProperty, &properties_.subnet_prefix);
  store_.RegisterConstStrings(kSearchDomainsProperty,
                              &properties_.domain_search);
  store_.RegisterConstByteArray(kVendorEncapsulatedOptionsProperty,
                                &properties_.vendor_encapsulated_options);
  store_.RegisterConstString(kWebProxyAutoDiscoveryUrlProperty,
                             &properties_.web_proxy_auto_discovery);
  store_.RegisterConstUint32(kLeaseDurationSecondsProperty,
                             &properties_.lease_duration_seconds);
  store_.RegisterConstByteArray(kiSNSOptionDataProperty,
                                &properties_.isns_option_data);
  SLOG(this, 2) << __func__ << " device: " << device_name_;
}

IPConfig::~IPConfig() {
  SLOG(this, 2) << __func__ << " device: " << device_name();
}

const RpcIdentifier& IPConfig::GetRpcIdentifier() const {
  return adaptor_->GetRpcIdentifier();
}

NetworkConfig IPConfig::ApplyNetworkConfig(const NetworkConfig& config) {
  auto current_config = properties_.ToNetworkConfig();
  properties_.UpdateFromNetworkConfig(config);
  EmitChanges();
  return current_config;
}

void IPConfig::UpdateProperties(const Properties& properties) {
  properties_ = properties;
  EmitChanges();
}

void IPConfig::UpdateDNSServers(std::vector<std::string> dns_servers) {
  properties_.dns_servers = std::move(dns_servers);
  EmitChanges();
}

void IPConfig::ResetProperties() {
  properties_ = Properties();
  EmitChanges();
}

void IPConfig::EmitChanges() {
  adaptor_->EmitStringChanged(kAddressProperty, properties_.address);
  adaptor_->EmitStringsChanged(kNameServersProperty, properties_.dns_servers);
}

bool operator==(const IPConfig::Route& lhs, const IPConfig::Route& rhs) {
  return lhs.host == rhs.host && lhs.prefix == rhs.prefix &&
         lhs.gateway == rhs.gateway;
}

// TODO(b/232177767): Ignore the order for vector properties.
bool operator==(const IPConfig::Properties& lhs,
                const IPConfig::Properties& rhs) {
  return lhs.address_family == rhs.address_family &&
         lhs.address == rhs.address && lhs.subnet_prefix == rhs.subnet_prefix &&
         lhs.broadcast_address == rhs.broadcast_address &&
         lhs.dns_servers == rhs.dns_servers &&
         lhs.domain_name == rhs.domain_name &&
         lhs.domain_search == rhs.domain_search && lhs.gateway == rhs.gateway &&
         lhs.method == rhs.method && lhs.peer_address == rhs.peer_address &&
         lhs.default_route == rhs.default_route &&
         lhs.inclusion_list == rhs.inclusion_list &&
         lhs.exclusion_list == rhs.exclusion_list &&
         lhs.blackhole_ipv6 == rhs.blackhole_ipv6 &&
         lhs.use_if_addrs == rhs.use_if_addrs && lhs.mtu == rhs.mtu &&
         lhs.dhcp_classless_static_routes == rhs.dhcp_classless_static_routes &&
         lhs.vendor_encapsulated_options == rhs.vendor_encapsulated_options &&
         lhs.isns_option_data == rhs.isns_option_data &&
         lhs.web_proxy_auto_discovery == rhs.web_proxy_auto_discovery &&
         lhs.lease_duration_seconds == rhs.lease_duration_seconds;
}

}  // namespace shill