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

#ifndef SHILL_VPN_VPN_PROVIDER_H_
#define SHILL_VPN_VPN_PROVIDER_H_

#include <string>
#include <vector>

#include <base/macros.h>
#include <gtest/gtest_prod.h>  // for FRIEND_TEST

#include "shill/ipconfig.h"
#include "shill/provider_interface.h"
#include "shill/refptr_types.h"
#include "shill/technology.h"
#include "shill/virtual_device.h"

namespace shill {

class Error;
class KeyValueStore;
class Manager;

class VPNProvider : public ProviderInterface {
 public:
  explicit VPNProvider(Manager* manager);
  ~VPNProvider() override;

  // Called by Manager as a part of the Provider interface.  The attributes
  // used for matching services for the VPN provider are the ProviderType,
  // ProviderHost mode and Name parameters.
  void CreateServicesFromProfile(const ProfileRefPtr& profile) override;
  ServiceRefPtr FindSimilarService(const KeyValueStore& args,
                                   Error* error) const override;
  ServiceRefPtr GetService(const KeyValueStore& args, Error* error) override;
  ServiceRefPtr CreateTemporaryService(const KeyValueStore& args,
                                       Error* error) override;
  ServiceRefPtr CreateTemporaryServiceFromProfile(const ProfileRefPtr& profile,
                                                  const std::string& entry_name,
                                                  Error* error) override;
  void Start() override;
  void Stop() override;

  // Offers an unclaimed interface to VPN services.  Returns true if this
  // device has been accepted by a service.
  // TODO(crbug.com/1026648) Remove this and VPNDriver::ClaimInterface.
  virtual bool OnDeviceInfoAvailable(const std::string& link_name,
                                     int interface_index,
                                     Technology technology);

  // Clean up a VPN services that has been unloaded and will be deregistered.
  // This removes the VPN provider's reference to this service in its
  // services_ vector.
  void RemoveService(VPNServiceRefPtr service);

  // Returns true if any of the managed VPN services is connecting or connected.
  virtual bool HasActiveService() const;

  // Disconnect any other active VPN services.
  virtual void DisconnectAll();

  // Default lists of allowed input interfaces, for VPNs that
  // do not want to handle all system traffic.
  const std::vector<std::string>& allowed_iifs() const { return allowed_iifs_; }

  // Allow Chrome and crosh UIDs, plus any ARC interface(s) on this system.
  // Chrome OS VPNs will use this policy.  ARC VPN will not.
  void SetDefaultRoutingPolicy(IPConfig::Properties* properties);

  VirtualDeviceRefPtr arc_device() const { return arc_device_; }

  // Adds |interface_name| to the list of allowed networking interfaces
  // |allowed_iifs_| that route traffic through VPNs.
  void AddAllowedInterface(const std::string& interface_name);
  // Removes |interface_name| from the list of allowed networking interfaces
  // |allowed_iifs_| that route traffic through VPNs.
  void RemoveAllowedInterface(const std::string& interface_name);

 private:
  friend class ArcVpnDriverTest;
  friend class L2TPIPSecDriverTest;
  friend class OpenVPNDriverTest;
  friend class VPNProviderTest;
  friend class VPNServiceTest;
  FRIEND_TEST(ThirdPartyVpnDriverTest, SetParameters);
  FRIEND_TEST(VPNProviderTest, ArcDeviceFound);
  FRIEND_TEST(VPNProviderTest, CreateService);
  FRIEND_TEST(VPNProviderTest, CreateArcService);
  FRIEND_TEST(VPNProviderTest, OnDeviceInfoAvailable);
  FRIEND_TEST(VPNProviderTest, RemoveService);
  FRIEND_TEST(VPNServiceTest, AddRemoveVMInterface);
  FRIEND_TEST(VPNServiceTest, Unload);

  // Create a service of type |type| and storage identifier |storage_id|
  // and initial parameters |args|.  Returns a service reference pointer
  // to the newly created service, or populates |error| with an the error
  // that caused this to fail.
  VPNServiceRefPtr CreateServiceInner(const std::string& type,
                                      const std::string& name,
                                      const std::string& storage_id,
                                      Error* error);

  // Calls CreateServiceInner above, and on success registers and adds this
  // service to the provider's list.
  VPNServiceRefPtr CreateService(const std::string& type,
                                 const std::string& name,
                                 const std::string& storage_id,
                                 Error* error);

  // Finds a service of type |type| with its Name property set to |name| and its
  // Provider.Host property set to |host|.
  VPNServiceRefPtr FindService(const std::string& type,
                               const std::string& name,
                               const std::string& host) const;

  Manager* manager_;
  std::vector<VPNServiceRefPtr> services_;
  // List of allowed networking interfaces that route traffic through VPNs
  // via policy-based routing rules.
  std::vector<std::string> allowed_iifs_;

  VirtualDeviceRefPtr arc_device_;

  DISALLOW_COPY_AND_ASSIGN(VPNProvider);
};

}  // namespace shill

#endif  // SHILL_VPN_VPN_PROVIDER_H_