shill/vpn/ikev2_driver.h

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

#ifndef SHILL_VPN_IKEV2_DRIVER_H_
#define SHILL_VPN_IKEV2_DRIVER_H_

#include <memory>
#include <string>

#include <base/memory/weak_ptr.h>
#include <net-base/network_config.h>
#include <net-base/process_manager.h>

#include "shill/manager.h"
#include "shill/mockable.h"
#include "shill/vpn/ipsec_connection.h"
#include "shill/vpn/vpn_connection.h"
#include "shill/vpn/vpn_driver.h"
#include "shill/vpn/vpn_end_reason.h"

namespace shill {

class IKEv2Driver : public VPNDriver {
 public:
  IKEv2Driver(Manager* manager, net_base::ProcessManager* process_manager);
  IKEv2Driver(const IKEv2Driver&) = delete;
  IKEv2Driver& operator=(const IKEv2Driver&) = delete;
  ~IKEv2Driver() override;

  // Inherited from VPNDriver.
  base::TimeDelta ConnectAsync(EventHandler* handler) override;
  void Disconnect() override;
  std::unique_ptr<net_base::NetworkConfig> GetNetworkConfig() const override;
  void OnConnectTimeout() override;

  // Disconnects from the VPN service before suspend or when the current default
  // physical service becomes unavailable. The reconnection behavior relies on
  // whether the user sets "Automatically connect to this network".
  void OnBeforeSuspend(ResultCallback callback) override;
  void OnDefaultPhysicalServiceEvent(
      DefaultPhysicalServiceEvent event) override;

 private:
  friend class IKEv2DriverUnderTest;

  static const VPNDriver::Property kProperties[];

  void NotifyServiceOfFailure(VPNEndReason failure);

  void StartIPsecConnection();

  // Isolates the creation of VPNConnections for the ease of unit tests. This
  // function is static, but we do not declare it as const also for the ease of
  // unit tests.
  mockable std::unique_ptr<VPNConnection> CreateIPsecConnection(
      std::unique_ptr<IPsecConnection::Config> config,
      std::unique_ptr<VPNConnection::Callbacks> callbacks,
      DeviceInfo* device_info,
      EventDispatcher* dispatcher,
      net_base::ProcessManager* process_manager);

  // Callbacks from IPsecConnection.
  void OnIPsecConnected(
      const std::string& link_name,
      int interface_index,
      std::unique_ptr<net_base::NetworkConfig> network_config);
  void OnIPsecFailure(VPNEndReason failure);
  void OnIPsecStopped();

  // Inherit from VPNDriver to add custom properties.
  KeyValueStore GetProvider(Error* error) override;

  void ReportConnectionMetrics();

  EventHandler* event_handler_ = nullptr;
  std::unique_ptr<VPNConnection> ipsec_connection_;
  std::optional<net_base::NetworkConfig> network_config_;

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

}  // namespace shill

#endif  // SHILL_VPN_IKEV2_DRIVER_H_