Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
| 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef SHILL_L2TP_IPSEC_DRIVER_ |
| 6 | #define SHILL_L2TP_IPSEC_DRIVER_ |
| 7 | |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 8 | #include <vector> |
| 9 | |
| 10 | #include <base/file_path.h> |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 11 | #include <base/memory/scoped_ptr.h> |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 12 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 13 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 14 | #include "shill/glib.h" |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 15 | #include "shill/ipconfig.h" |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 16 | #include "shill/rpc_task.h" |
| 17 | #include "shill/service.h" |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 18 | #include "shill/vpn_driver.h" |
| 19 | |
| 20 | namespace shill { |
| 21 | |
Darin Petkov | 95f317f | 2012-10-22 13:37:43 +0200 | [diff] [blame] | 22 | // Declared in the header to avoid linking unused code into shims. |
| 23 | static const char kL2TPIPSecDNS1[] = "DNS1"; |
| 24 | static const char kL2TPIPSecDNS2[] = "DNS2"; |
| 25 | static const char kL2TPIPSecExternalIP4Address[] = "EXTERNAL_IP4_ADDRESS"; |
| 26 | static const char kL2TPIPSecGatewayAddress[] = "GATEWAY_ADDRESS"; |
| 27 | static const char kL2TPIPSecInterfaceName[] = "INTERNAL_IFNAME"; |
| 28 | static const char kL2TPIPSecInternalIP4Address[] = "INTERNAL_IP4_ADDRESS"; |
| 29 | static const char kL2TPIPSecLNSAddress[] = "LNS_ADDRESS"; |
| 30 | static const char kL2TPIPSecReasonConnect[] = "connect"; |
| 31 | static const char kL2TPIPSecReasonDisconnect[] = "disconnect"; |
| 32 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 33 | class ControlInterface; |
Darin Petkov | f8046b8 | 2012-04-24 16:29:23 +0200 | [diff] [blame] | 34 | class DeviceInfo; |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 35 | class GLib; |
Darin Petkov | f8046b8 | 2012-04-24 16:29:23 +0200 | [diff] [blame] | 36 | class Metrics; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 37 | class NSS; |
Darin Petkov | 5a85047 | 2012-06-06 15:44:24 +0200 | [diff] [blame] | 38 | class ProcessKiller; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 39 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 40 | class L2TPIPSecDriver : public VPNDriver, |
| 41 | public RPCTaskDelegate { |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 42 | public: |
Darin Petkov | f8046b8 | 2012-04-24 16:29:23 +0200 | [diff] [blame] | 43 | L2TPIPSecDriver(ControlInterface *control, |
| 44 | EventDispatcher *dispatcher, |
| 45 | Metrics *metrics, |
| 46 | Manager *manager, |
| 47 | DeviceInfo *device_info, |
| 48 | GLib *glib); |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 49 | virtual ~L2TPIPSecDriver(); |
| 50 | |
| 51 | // Inherited from VPNDriver. |
| 52 | virtual bool ClaimInterface(const std::string &link_name, |
| 53 | int interface_index); |
| 54 | virtual void Connect(const VPNServiceRefPtr &service, Error *error); |
| 55 | virtual void Disconnect(); |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 56 | virtual void OnConnectionDisconnected(); |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 57 | virtual std::string GetProviderType() const; |
| 58 | |
| 59 | private: |
| 60 | friend class L2TPIPSecDriverTest; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 61 | FRIEND_TEST(L2TPIPSecDriverTest, AppendFlag); |
| 62 | FRIEND_TEST(L2TPIPSecDriverTest, AppendValueOption); |
| 63 | FRIEND_TEST(L2TPIPSecDriverTest, Cleanup); |
Darin Petkov | 602303f | 2012-06-06 12:15:59 +0200 | [diff] [blame] | 64 | FRIEND_TEST(L2TPIPSecDriverTest, Connect); |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 65 | FRIEND_TEST(L2TPIPSecDriverTest, DeletePSKFile); |
Darin Petkov | a0e645e | 2012-04-25 11:38:59 +0200 | [diff] [blame] | 66 | FRIEND_TEST(L2TPIPSecDriverTest, Disconnect); |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 67 | FRIEND_TEST(L2TPIPSecDriverTest, GetLogin); |
| 68 | FRIEND_TEST(L2TPIPSecDriverTest, InitEnvironment); |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 69 | FRIEND_TEST(L2TPIPSecDriverTest, InitNSSOptions); |
| 70 | FRIEND_TEST(L2TPIPSecDriverTest, InitOptions); |
| 71 | FRIEND_TEST(L2TPIPSecDriverTest, InitOptionsNoHost); |
| 72 | FRIEND_TEST(L2TPIPSecDriverTest, InitPSKOptions); |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 73 | FRIEND_TEST(L2TPIPSecDriverTest, Notify); |
Darin Petkov | a0e645e | 2012-04-25 11:38:59 +0200 | [diff] [blame] | 74 | FRIEND_TEST(L2TPIPSecDriverTest, NotifyFail); |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 75 | FRIEND_TEST(L2TPIPSecDriverTest, OnConnectionDisconnected); |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 76 | FRIEND_TEST(L2TPIPSecDriverTest, OnL2TPIPSecVPNDied); |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 77 | FRIEND_TEST(L2TPIPSecDriverTest, ParseIPConfiguration); |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 78 | FRIEND_TEST(L2TPIPSecDriverTest, SpawnL2TPIPSecVPN); |
Darin Petkov | a0e645e | 2012-04-25 11:38:59 +0200 | [diff] [blame] | 79 | FRIEND_TEST(L2TPIPSecDriverTest, VerifyPaths); |
Darin Petkov | d432539 | 2012-04-23 15:48:22 +0200 | [diff] [blame] | 80 | |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 81 | static const char kPPPDPlugin[]; |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 82 | static const char kL2TPIPSecVPNPath[]; |
Darin Petkov | d432539 | 2012-04-23 15:48:22 +0200 | [diff] [blame] | 83 | static const Property kProperties[]; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 84 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 85 | bool SpawnL2TPIPSecVPN(Error *error); |
| 86 | |
| 87 | void InitEnvironment(std::vector<std::string> *environment); |
| 88 | |
| 89 | bool InitOptions(std::vector<std::string> *options, Error *error); |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 90 | bool InitPSKOptions(std::vector<std::string> *options, Error *error); |
| 91 | void InitNSSOptions(std::vector<std::string> *options); |
| 92 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 93 | void Cleanup(Service::ConnectState state); |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 94 | |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 95 | void DeletePSKFile(); |
| 96 | |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 97 | // Returns true if an opton was appended. |
| 98 | bool AppendValueOption(const std::string &property, |
| 99 | const std::string &option, |
| 100 | std::vector<std::string> *options); |
| 101 | |
| 102 | // Returns true if a flag was appended. |
| 103 | bool AppendFlag(const std::string &property, |
| 104 | const std::string &true_option, |
| 105 | const std::string &false_option, |
| 106 | std::vector<std::string> *options); |
| 107 | |
Darin Petkov | 0e9735d | 2012-04-24 12:33:45 +0200 | [diff] [blame] | 108 | static void ParseIPConfiguration( |
| 109 | const std::map<std::string, std::string> &configuration, |
| 110 | IPConfig::Properties *properties, |
| 111 | std::string *interface_name); |
| 112 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 113 | // Called when the l2tpipsec_vpn process exits. |
| 114 | static void OnL2TPIPSecVPNDied(GPid pid, gint status, gpointer data); |
| 115 | |
Darin Petkov | b536a74 | 2012-04-26 11:31:28 +0200 | [diff] [blame] | 116 | // Inherit from VPNDriver to add custom properties. |
| 117 | virtual KeyValueStore GetProvider(Error *error); |
| 118 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 119 | // Implements RPCTaskDelegate. |
| 120 | virtual void GetLogin(std::string *user, std::string *password); |
| 121 | virtual void Notify(const std::string &reason, |
| 122 | const std::map<std::string, std::string> &dict); |
| 123 | |
| 124 | ControlInterface *control_; |
Darin Petkov | f8046b8 | 2012-04-24 16:29:23 +0200 | [diff] [blame] | 125 | Metrics *metrics_; |
| 126 | DeviceInfo *device_info_; |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 127 | GLib *glib_; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 128 | NSS *nss_; |
Darin Petkov | 5a85047 | 2012-06-06 15:44:24 +0200 | [diff] [blame] | 129 | ProcessKiller *process_killer_; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 130 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 131 | VPNServiceRefPtr service_; |
| 132 | scoped_ptr<RPCTask> rpc_task_; |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 133 | FilePath psk_file_; |
Darin Petkov | f8046b8 | 2012-04-24 16:29:23 +0200 | [diff] [blame] | 134 | VPNRefPtr device_; |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 135 | |
Darin Petkov | 209e629 | 2012-04-20 11:33:32 +0200 | [diff] [blame] | 136 | // The PID of the spawned l2tpipsec_vpn process. May be 0 if no process has |
| 137 | // been spawned yet or the process has died. |
| 138 | int pid_; |
| 139 | |
| 140 | // Child exit watch callback source tag. |
| 141 | unsigned int child_watch_tag_; |
| 142 | |
Darin Petkov | 7476a26 | 2012-04-12 16:30:46 +0200 | [diff] [blame] | 143 | DISALLOW_COPY_AND_ASSIGN(L2TPIPSecDriver); |
| 144 | }; |
| 145 | |
| 146 | } // namespace shill |
| 147 | |
| 148 | #endif // SHILL_L2TP_IPSEC_DRIVER_ |