blob: 07073418796522c82b7a1aea6973888c88414917 [file] [log] [blame]
Darin Petkov33af05c2012-02-28 10:10:30 +01001// 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 Petkov14c29ec2012-03-02 11:34:19 +01008#include <map>
Darin Petkovfe6a9372012-02-28 16:25:06 +01009#include <string>
10#include <vector>
11
Darin Petkova9b1fed2012-02-29 11:49:05 +010012#include <base/memory/scoped_ptr.h>
Darin Petkovfe6a9372012-02-28 16:25:06 +010013#include <gtest/gtest_prod.h> // for FRIEND_TEST
14
Darin Petkov36a3ace2012-03-06 17:22:14 +010015#include "shill/glib.h"
Darin Petkov14c29ec2012-03-02 11:34:19 +010016#include "shill/ipconfig.h"
Darin Petkovfe6a9372012-02-28 16:25:06 +010017#include "shill/key_value_store.h"
Darin Petkovf20994f2012-03-05 16:12:19 +010018#include "shill/refptr_types.h"
Darin Petkov36a3ace2012-03-06 17:22:14 +010019#include "shill/rpc_task.h"
Darin Petkov33af05c2012-02-28 10:10:30 +010020#include "shill/vpn_driver.h"
21
22namespace shill {
23
Darin Petkova9b1fed2012-02-29 11:49:05 +010024class ControlInterface;
Paul Stewartca6abd42012-03-01 15:45:29 -080025class DeviceInfo;
Darin Petkov33af05c2012-02-28 10:10:30 +010026class Error;
Darin Petkovf20994f2012-03-05 16:12:19 +010027class EventDispatcher;
28class Manager;
29class Metrics;
Darin Petkov33af05c2012-02-28 10:10:30 +010030
Darin Petkov36a3ace2012-03-06 17:22:14 +010031class OpenVPNDriver : public VPNDriver,
32 public RPCTaskDelegate {
Darin Petkov33af05c2012-02-28 10:10:30 +010033 public:
Paul Stewartca6abd42012-03-01 15:45:29 -080034 OpenVPNDriver(ControlInterface *control,
Darin Petkovf20994f2012-03-05 16:12:19 +010035 EventDispatcher *dispatcher,
36 Metrics *metrics,
37 Manager *manager,
Paul Stewartca6abd42012-03-01 15:45:29 -080038 DeviceInfo *device_info,
Darin Petkov36a3ace2012-03-06 17:22:14 +010039 GLib *glib,
Paul Stewartca6abd42012-03-01 15:45:29 -080040 const KeyValueStore &args);
Darin Petkov33af05c2012-02-28 10:10:30 +010041 virtual ~OpenVPNDriver();
42
Darin Petkovf20994f2012-03-05 16:12:19 +010043 // 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 Petkov79d74c92012-03-07 17:20:32 +010049 virtual void Connect(const VPNServiceRefPtr &service, Error *error);
Paul Stewartca6abd42012-03-01 15:45:29 -080050 virtual bool ClaimInterface(const std::string &link_name,
51 int interface_index);
Darin Petkov33af05c2012-02-28 10:10:30 +010052
53 private:
Darin Petkovfe6a9372012-02-28 16:25:06 +010054 friend class OpenVPNDriverTest;
55 FRIEND_TEST(OpenVPNDriverTest, AppendFlag);
56 FRIEND_TEST(OpenVPNDriverTest, AppendValueOption);
Paul Stewartca6abd42012-03-01 15:45:29 -080057 FRIEND_TEST(OpenVPNDriverTest, ClaimInterface);
Darin Petkov36a3ace2012-03-06 17:22:14 +010058 FRIEND_TEST(OpenVPNDriverTest, Cleanup);
Darin Petkovf20994f2012-03-05 16:12:19 +010059 FRIEND_TEST(OpenVPNDriverTest, Connect);
Darin Petkov79d74c92012-03-07 17:20:32 +010060 FRIEND_TEST(OpenVPNDriverTest, ConnectTunnelFailure);
Darin Petkov60596742012-03-05 12:17:17 +010061 FRIEND_TEST(OpenVPNDriverTest, GetRouteOptionEntry);
Darin Petkovfe6a9372012-02-28 16:25:06 +010062 FRIEND_TEST(OpenVPNDriverTest, InitOptions);
63 FRIEND_TEST(OpenVPNDriverTest, InitOptionsNoHost);
Darin Petkov36a3ace2012-03-06 17:22:14 +010064 FRIEND_TEST(OpenVPNDriverTest, Notify);
Darin Petkov79d74c92012-03-07 17:20:32 +010065 FRIEND_TEST(OpenVPNDriverTest, NotifyFail);
Darin Petkov36a3ace2012-03-06 17:22:14 +010066 FRIEND_TEST(OpenVPNDriverTest, OnOpenVPNDied);
Darin Petkov14c29ec2012-03-02 11:34:19 +010067 FRIEND_TEST(OpenVPNDriverTest, ParseForeignOption);
68 FRIEND_TEST(OpenVPNDriverTest, ParseForeignOptions);
69 FRIEND_TEST(OpenVPNDriverTest, ParseIPConfiguration);
Darin Petkov60596742012-03-05 12:17:17 +010070 FRIEND_TEST(OpenVPNDriverTest, ParseRouteOption);
71 FRIEND_TEST(OpenVPNDriverTest, SetRoutes);
Darin Petkov36a3ace2012-03-06 17:22:14 +010072 FRIEND_TEST(OpenVPNDriverTest, SpawnOpenVPN);
Darin Petkov14c29ec2012-03-02 11:34:19 +010073
74 // The map is a sorted container that allows us to iterate through the options
75 // in order.
76 typedef std::map<int, std::string> ForeignOptions;
Darin Petkov60596742012-03-05 12:17:17 +010077 typedef std::map<int, IPConfig::Route> RouteOptions;
Darin Petkov14c29ec2012-03-02 11:34:19 +010078
79 static void ParseIPConfiguration(
80 const std::map<std::string, std::string> &configuration,
81 IPConfig::Properties *properties);
82 static void ParseForeignOptions(const ForeignOptions &options,
83 IPConfig::Properties *properties);
84 static void ParseForeignOption(const std::string &option,
85 IPConfig::Properties *properties);
Darin Petkov60596742012-03-05 12:17:17 +010086 static IPConfig::Route *GetRouteOptionEntry(const std::string &prefix,
87 const std::string &key,
88 RouteOptions *routes);
89 static void ParseRouteOption(const std::string &key,
90 const std::string &value,
91 RouteOptions *routes);
92 static void SetRoutes(const RouteOptions &routes,
93 IPConfig::Properties *properties);
Darin Petkovfe6a9372012-02-28 16:25:06 +010094
95 void InitOptions(std::vector<std::string> *options, Error *error);
96
97 void AppendValueOption(const std::string &property,
98 const std::string &option,
99 std::vector<std::string> *options);
100 void AppendFlag(const std::string &property,
101 const std::string &option,
102 std::vector<std::string> *options);
103
Darin Petkov36a3ace2012-03-06 17:22:14 +0100104 bool SpawnOpenVPN();
105 void Cleanup();
106
107 // Called when the openpvn process exits.
108 static void OnOpenVPNDied(GPid pid, gint status, gpointer data);
109
110 // Implements RPCTaskDelegate.
111 virtual void Notify(const std::string &reason,
112 const std::map<std::string, std::string> &dict);
113
Darin Petkova9b1fed2012-02-29 11:49:05 +0100114 ControlInterface *control_;
Darin Petkovf20994f2012-03-05 16:12:19 +0100115 EventDispatcher *dispatcher_;
116 Metrics *metrics_;
117 Manager *manager_;
Paul Stewartca6abd42012-03-01 15:45:29 -0800118 DeviceInfo *device_info_;
Darin Petkov36a3ace2012-03-06 17:22:14 +0100119 GLib *glib_;
Darin Petkovfe6a9372012-02-28 16:25:06 +0100120 KeyValueStore args_;
Darin Petkov79d74c92012-03-07 17:20:32 +0100121
122 VPNServiceRefPtr service_;
Darin Petkova9b1fed2012-02-29 11:49:05 +0100123 scoped_ptr<RPCTask> rpc_task_;
Paul Stewartca6abd42012-03-01 15:45:29 -0800124 std::string tunnel_interface_;
Darin Petkovf20994f2012-03-05 16:12:19 +0100125 VPNRefPtr device_;
Darin Petkovfe6a9372012-02-28 16:25:06 +0100126
Darin Petkov36a3ace2012-03-06 17:22:14 +0100127 // The PID of the spawned openvpn process. May be 0 if no process has been
128 // spawned yet or the process has died.
129 int pid_;
130
131 // Child exit watch callback source tag.
132 unsigned int child_watch_tag_;
133
Darin Petkov33af05c2012-02-28 10:10:30 +0100134 DISALLOW_COPY_AND_ASSIGN(OpenVPNDriver);
135};
136
137} // namespace shill
138
139#endif // SHILL_OPENVPN_DRIVER_