Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [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_OPENVPN_DRIVER_ |
| 6 | #define SHILL_OPENVPN_DRIVER_ |
| 7 | |
Darin Petkov | 14c29ec | 2012-03-02 11:34:19 +0100 | [diff] [blame] | 8 | #include <map> |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 9 | #include <string> |
| 10 | #include <vector> |
| 11 | |
Darin Petkov | a9b1fed | 2012-02-29 11:49:05 +0100 | [diff] [blame] | 12 | #include <base/memory/scoped_ptr.h> |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 13 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
| 14 | |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 15 | #include "shill/glib.h" |
Darin Petkov | 14c29ec | 2012-03-02 11:34:19 +0100 | [diff] [blame] | 16 | #include "shill/ipconfig.h" |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 17 | #include "shill/key_value_store.h" |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 18 | #include "shill/refptr_types.h" |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 19 | #include "shill/rpc_task.h" |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 20 | #include "shill/vpn_driver.h" |
| 21 | |
| 22 | namespace shill { |
| 23 | |
Darin Petkov | a9b1fed | 2012-02-29 11:49:05 +0100 | [diff] [blame] | 24 | class ControlInterface; |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 25 | class DeviceInfo; |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 26 | class Error; |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 27 | class EventDispatcher; |
| 28 | class Manager; |
| 29 | class Metrics; |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 30 | |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 31 | class OpenVPNDriver : public VPNDriver, |
| 32 | public RPCTaskDelegate { |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 33 | public: |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 34 | OpenVPNDriver(ControlInterface *control, |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 35 | EventDispatcher *dispatcher, |
| 36 | Metrics *metrics, |
| 37 | Manager *manager, |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 38 | DeviceInfo *device_info, |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 39 | GLib *glib, |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 40 | const KeyValueStore &args); |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 41 | virtual ~OpenVPNDriver(); |
| 42 | |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 43 | // Inherited from VPNDriver. |Connect| initiates the VPN connection by |
| 44 | // creating a tunnel device. When the device index becomes available, this |
| 45 | // instance is notified through |ClaimInterface| and resumes the connection |
| 46 | // process by setting up and spawning an external 'openvpn' process. IP |
| 47 | // configuration settings are passed back from the external process through |
| 48 | // the |Notify| RPC service method. |
Darin Petkov | 79d74c9 | 2012-03-07 17:20:32 +0100 | [diff] [blame] | 49 | virtual void Connect(const VPNServiceRefPtr &service, Error *error); |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 50 | virtual bool ClaimInterface(const std::string &link_name, |
| 51 | int interface_index); |
Darin Petkov | 6aa2187 | 2012-03-09 16:10:19 +0100 | [diff] [blame] | 52 | virtual void Disconnect(); |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 53 | |
| 54 | private: |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 55 | friend class OpenVPNDriverTest; |
| 56 | FRIEND_TEST(OpenVPNDriverTest, AppendFlag); |
| 57 | FRIEND_TEST(OpenVPNDriverTest, AppendValueOption); |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 58 | FRIEND_TEST(OpenVPNDriverTest, ClaimInterface); |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 59 | FRIEND_TEST(OpenVPNDriverTest, Cleanup); |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 60 | FRIEND_TEST(OpenVPNDriverTest, Connect); |
Darin Petkov | 79d74c9 | 2012-03-07 17:20:32 +0100 | [diff] [blame] | 61 | FRIEND_TEST(OpenVPNDriverTest, ConnectTunnelFailure); |
Darin Petkov | 6aa2187 | 2012-03-09 16:10:19 +0100 | [diff] [blame] | 62 | FRIEND_TEST(OpenVPNDriverTest, Disconnect); |
Darin Petkov | 6059674 | 2012-03-05 12:17:17 +0100 | [diff] [blame] | 63 | FRIEND_TEST(OpenVPNDriverTest, GetRouteOptionEntry); |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 64 | FRIEND_TEST(OpenVPNDriverTest, InitOptions); |
| 65 | FRIEND_TEST(OpenVPNDriverTest, InitOptionsNoHost); |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 66 | FRIEND_TEST(OpenVPNDriverTest, Notify); |
Darin Petkov | 79d74c9 | 2012-03-07 17:20:32 +0100 | [diff] [blame] | 67 | FRIEND_TEST(OpenVPNDriverTest, NotifyFail); |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 68 | FRIEND_TEST(OpenVPNDriverTest, OnOpenVPNDied); |
Darin Petkov | 14c29ec | 2012-03-02 11:34:19 +0100 | [diff] [blame] | 69 | FRIEND_TEST(OpenVPNDriverTest, ParseForeignOption); |
| 70 | FRIEND_TEST(OpenVPNDriverTest, ParseForeignOptions); |
| 71 | FRIEND_TEST(OpenVPNDriverTest, ParseIPConfiguration); |
Darin Petkov | 6059674 | 2012-03-05 12:17:17 +0100 | [diff] [blame] | 72 | FRIEND_TEST(OpenVPNDriverTest, ParseRouteOption); |
| 73 | FRIEND_TEST(OpenVPNDriverTest, SetRoutes); |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 74 | FRIEND_TEST(OpenVPNDriverTest, SpawnOpenVPN); |
Darin Petkov | 14c29ec | 2012-03-02 11:34:19 +0100 | [diff] [blame] | 75 | |
| 76 | // The map is a sorted container that allows us to iterate through the options |
| 77 | // in order. |
| 78 | typedef std::map<int, std::string> ForeignOptions; |
Darin Petkov | 6059674 | 2012-03-05 12:17:17 +0100 | [diff] [blame] | 79 | typedef std::map<int, IPConfig::Route> RouteOptions; |
Darin Petkov | 14c29ec | 2012-03-02 11:34:19 +0100 | [diff] [blame] | 80 | |
| 81 | static void ParseIPConfiguration( |
| 82 | const std::map<std::string, std::string> &configuration, |
| 83 | IPConfig::Properties *properties); |
| 84 | static void ParseForeignOptions(const ForeignOptions &options, |
| 85 | IPConfig::Properties *properties); |
| 86 | static void ParseForeignOption(const std::string &option, |
| 87 | IPConfig::Properties *properties); |
Darin Petkov | 6059674 | 2012-03-05 12:17:17 +0100 | [diff] [blame] | 88 | static IPConfig::Route *GetRouteOptionEntry(const std::string &prefix, |
| 89 | const std::string &key, |
| 90 | RouteOptions *routes); |
| 91 | static void ParseRouteOption(const std::string &key, |
| 92 | const std::string &value, |
| 93 | RouteOptions *routes); |
| 94 | static void SetRoutes(const RouteOptions &routes, |
| 95 | IPConfig::Properties *properties); |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 96 | |
| 97 | void InitOptions(std::vector<std::string> *options, Error *error); |
| 98 | |
| 99 | void AppendValueOption(const std::string &property, |
| 100 | const std::string &option, |
| 101 | std::vector<std::string> *options); |
| 102 | void AppendFlag(const std::string &property, |
| 103 | const std::string &option, |
| 104 | std::vector<std::string> *options); |
| 105 | |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 106 | bool SpawnOpenVPN(); |
| 107 | void Cleanup(); |
| 108 | |
| 109 | // Called when the openpvn process exits. |
| 110 | static void OnOpenVPNDied(GPid pid, gint status, gpointer data); |
| 111 | |
| 112 | // Implements RPCTaskDelegate. |
| 113 | virtual void Notify(const std::string &reason, |
| 114 | const std::map<std::string, std::string> &dict); |
| 115 | |
Darin Petkov | a9b1fed | 2012-02-29 11:49:05 +0100 | [diff] [blame] | 116 | ControlInterface *control_; |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 117 | EventDispatcher *dispatcher_; |
| 118 | Metrics *metrics_; |
| 119 | Manager *manager_; |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 120 | DeviceInfo *device_info_; |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 121 | GLib *glib_; |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 122 | KeyValueStore args_; |
Darin Petkov | 79d74c9 | 2012-03-07 17:20:32 +0100 | [diff] [blame] | 123 | |
| 124 | VPNServiceRefPtr service_; |
Darin Petkov | a9b1fed | 2012-02-29 11:49:05 +0100 | [diff] [blame] | 125 | scoped_ptr<RPCTask> rpc_task_; |
Paul Stewart | ca6abd4 | 2012-03-01 15:45:29 -0800 | [diff] [blame] | 126 | std::string tunnel_interface_; |
Darin Petkov | f20994f | 2012-03-05 16:12:19 +0100 | [diff] [blame] | 127 | VPNRefPtr device_; |
Darin Petkov | fe6a937 | 2012-02-28 16:25:06 +0100 | [diff] [blame] | 128 | |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 129 | // The PID of the spawned openvpn process. May be 0 if no process has been |
| 130 | // spawned yet or the process has died. |
| 131 | int pid_; |
| 132 | |
| 133 | // Child exit watch callback source tag. |
| 134 | unsigned int child_watch_tag_; |
| 135 | |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 136 | DISALLOW_COPY_AND_ASSIGN(OpenVPNDriver); |
| 137 | }; |
| 138 | |
| 139 | } // namespace shill |
| 140 | |
| 141 | #endif // SHILL_OPENVPN_DRIVER_ |