blob: 4e5ba644f8712fdd520565ea8507c825e0eb910f [file] [log] [blame]
mukesh agrawal8a3188d2011-12-01 20:56:44 +00001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Paul Stewart75897df2011-04-27 09:05:53 -07002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Darin Petkov002c58e2012-06-19 02:56:05 +02005#ifndef SHILL_MANAGER_H_
6#define SHILL_MANAGER_H_
Paul Stewart75897df2011-04-27 09:05:53 -07007
Darin Petkova5e07ef2012-07-09 14:27:57 +02008#include <map>
Chris Masone9be4a9d2011-05-16 15:44:09 -07009#include <string>
Paul Stewart75897df2011-04-27 09:05:53 -070010#include <vector>
Chris Masone487b8bf2011-05-13 16:27:57 -070011
mukesh agrawal92496a42014-04-08 16:04:43 -070012#include <base/basictypes.h>
Paul Stewartdfa46052012-06-26 09:44:14 -070013#include <base/cancelable_callback.h>
Ben Chana0ddf462014-02-06 11:32:42 -080014#include <base/files/file_path.h>
Chris Masone9be4a9d2011-05-16 15:44:09 -070015#include <base/memory/ref_counted.h>
Chris Masone487b8bf2011-05-13 16:27:57 -070016#include <base/memory/scoped_ptr.h>
Eric Shienbrood3e20a232012-02-16 11:35:56 -050017#include <base/memory/weak_ptr.h>
Chris Masone88cbd5f2011-07-03 14:30:04 -070018#include <chromeos/dbus/service_constants.h>
Paul Stewart22aa71b2011-09-16 12:15:11 -070019#include <gtest/gtest_prod.h> // for FRIEND_TEST
Paul Stewart75897df2011-04-27 09:05:53 -070020
Christopher Wiley1057cd72013-02-28 15:21:29 -080021#include "shill/crypto_util_proxy.h"
Paul Stewart75897df2011-04-27 09:05:53 -070022#include "shill/device.h"
Paul Stewart0af98bf2011-05-10 17:38:08 -070023#include "shill/device_info.h"
Paul Stewart26b327e2011-10-19 11:38:09 -070024#include "shill/event_dispatcher.h"
Gaurav Shahb790aa22012-10-23 12:51:12 -070025#include "shill/geolocation_info.h"
Gary Moraina9fb3252012-05-31 12:05:31 -070026#include "shill/hook_table.h"
Arman Ugurayab22c162012-10-08 19:08:38 -070027#include "shill/metrics.h"
Darin Petkov887f2982011-07-14 16:10:17 -070028#include "shill/modem_info.h"
Gary Morainac1bdb42012-02-16 17:42:29 -080029#include "shill/power_manager.h"
Paul Stewartf3eced92013-04-17 12:18:22 -070030#include "shill/profile.h"
Chris Masoneb925cc82011-06-22 15:39:57 -070031#include "shill/property_store.h"
Chris Masone9be4a9d2011-05-16 15:44:09 -070032#include "shill/service.h"
mukesh agrawal7a4e4002011-09-06 11:26:05 -070033#include "shill/wifi.h"
Darin Petkovb72b62e2012-05-15 16:55:36 +020034#include "shill/wimax_provider.h"
Paul Stewart75897df2011-04-27 09:05:53 -070035
36namespace shill {
37
Chris Masoned0ceb8c2011-06-02 10:05:39 -070038class ControlInterface;
Darin Petkov002c58e2012-06-19 02:56:05 +020039class DBusManager;
Paul Stewart4d5efb72012-09-17 12:24:34 -070040class DefaultProfile;
Chris Masone8fe2c7e2011-06-09 15:51:19 -070041class Error;
Paul Stewart35eff132013-04-12 12:08:40 -070042class EthernetEapProvider;
Chris Masoned0ceb8c2011-06-02 10:05:39 -070043class EventDispatcher;
Prathmesh Prabhuba99b592013-04-17 15:13:14 -070044class IPAddressStore;
Thieu Le3426c8f2012-01-11 17:35:11 -080045class ManagerAdaptorInterface;
Paul Stewart4d5efb72012-09-17 12:24:34 -070046class Resolver;
Paul Stewart85aea152013-01-22 09:31:56 -080047class StoreInterface;
Darin Petkovc3505a52013-03-18 15:13:29 +010048class VPNProvider;
Paul Stewart3c504012013-01-17 17:49:58 -080049class WiFiProvider;
Chris Masoned0ceb8c2011-06-02 10:05:39 -070050
Eric Shienbrood3e20a232012-02-16 11:35:56 -050051class Manager : public base::SupportsWeakPtr<Manager> {
Paul Stewart75897df2011-04-27 09:05:53 -070052 public:
Darin Petkova5e07ef2012-07-09 14:27:57 +020053 typedef base::Callback<void(const ServiceRefPtr &service)> ServiceCallback;
54
Chris Masone88cbd5f2011-07-03 14:30:04 -070055 struct Properties {
56 public:
Paul Stewartc681fa02012-03-02 19:40:04 -080057 Properties()
Paul Stewartd408fdf2012-05-07 17:15:57 -070058 : offline_mode(false),
59 portal_check_interval_seconds(0),
Peter Qiu9d581932014-04-14 16:37:37 -070060 arp_gateway(true),
61 connection_id_salt(0) {}
Chris Masone88cbd5f2011-07-03 14:30:04 -070062 bool offline_mode;
63 std::string check_portal_list;
64 std::string country;
Paul Stewartc681fa02012-03-02 19:40:04 -080065 int32 portal_check_interval_seconds;
Chris Masone88cbd5f2011-07-03 14:30:04 -070066 std::string portal_url;
Paul Stewartd32f4842012-01-11 16:08:13 -080067 std::string host_name;
Paul Stewartd408fdf2012-05-07 17:15:57 -070068 // Whether to ARP for the default gateway in the DHCP client after
69 // acquiring a lease.
70 bool arp_gateway;
Paul Stewart036dba02012-08-07 12:34:41 -070071 // Comma-separated list of technologies for which link-monitoring is
72 // enabled.
73 std::string link_monitor_technologies;
Paul Stewart4d5efb72012-09-17 12:24:34 -070074 // Comma-separated list of DNS search paths to be ignored.
75 std::string ignored_dns_search_paths;
Peter Qiu9d581932014-04-14 16:37:37 -070076 // Salt value use for calculating network connection ID.
77 int connection_id_salt;
Chris Masone88cbd5f2011-07-03 14:30:04 -070078 };
79
Chris Masone9be4a9d2011-05-16 15:44:09 -070080 Manager(ControlInterface *control_interface,
Darin Petkov887f2982011-07-14 16:10:17 -070081 EventDispatcher *dispatcher,
Thieu Le3426c8f2012-01-11 17:35:11 -080082 Metrics *metrics,
Chris Masone2ae797d2011-08-23 20:41:00 -070083 GLib *glib,
84 const std::string &run_directory,
85 const std::string &storage_directory,
86 const std::string &user_storage_format);
Chris Masone3bd3c8c2011-06-13 08:20:26 -070087 virtual ~Manager();
mukesh agrawal8f317b62011-07-15 11:53:23 -070088
89 void AddDeviceToBlackList(const std::string &device_name);
Gary Morainac1bdb42012-02-16 17:42:29 -080090
Thieu Lefb46caf2012-03-08 11:57:15 -080091 virtual void Start();
Thieu Le6c1e3bb2013-02-06 15:20:35 -080092 virtual void Stop();
Darin Petkovcb0b5662012-12-13 09:59:44 +010093 bool running() const { return running_; }
Paul Stewart75897df2011-04-27 09:05:53 -070094
Paul Stewart1b253142012-01-26 14:05:52 -080095 const ProfileRefPtr &ActiveProfile() const;
96 bool IsActiveProfile(const ProfileRefPtr &profile) const;
Chris Masone6515aab2011-10-12 16:19:09 -070097 bool MoveServiceToProfile(const ServiceRefPtr &to_move,
98 const ProfileRefPtr &destination);
Paul Stewart7f61e522012-03-22 11:13:45 -070099 ProfileRefPtr LookupProfileByRpcIdentifier(const std::string &profile_rpcid);
Chris Masone7aa5f902011-07-11 11:13:35 -0700100
Paul Stewart1b1a7f22012-01-06 16:24:06 -0800101 // Called via RPC call on Service (|to_set|) to set the "Profile" property.
Paul Stewartad0e5982013-07-02 08:47:47 -0700102 virtual void SetProfileForService(const ServiceRefPtr &to_set,
103 const std::string &profile,
104 Error *error);
Paul Stewart1b1a7f22012-01-06 16:24:06 -0800105
Paul Stewart8c116a92012-05-02 18:30:03 -0700106 virtual void RegisterDevice(const DeviceRefPtr &to_manage);
107 virtual void DeregisterDevice(const DeviceRefPtr &to_forget);
Chris Masone9be4a9d2011-05-16 15:44:09 -0700108
mukesh agrawal4eb4d782011-12-05 17:34:37 +0000109 virtual bool HasService(const ServiceRefPtr &service);
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000110 // Register a Service with the Manager. Manager may choose to
111 // connect to it immediately.
mukesh agrawal32399322011-09-01 10:53:43 -0700112 virtual void RegisterService(const ServiceRefPtr &to_manage);
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000113 // Deregister a Service from the Manager. Caller is responsible
114 // for disconnecting the Service before-hand.
Chris Masone6515aab2011-10-12 16:19:09 -0700115 virtual void DeregisterService(const ServiceRefPtr &to_forget);
mukesh agrawal00917ce2011-11-22 23:56:55 +0000116 virtual void UpdateService(const ServiceRefPtr &to_update);
Chris Masone9be4a9d2011-05-16 15:44:09 -0700117
Darin Petkove7c6ad32012-06-29 10:22:09 +0200118 // Persists |to_update| into an appropriate profile.
119 virtual void UpdateDevice(const DeviceRefPtr &to_update);
120
Wade Guthrie60a37062013-04-02 11:39:09 -0700121 virtual void UpdateWiFiProvider();
122
Paul Stewartfdd16072011-09-16 12:41:35 -0700123 void FilterByTechnology(Technology::Identifier tech,
Paul Stewart3c504012013-01-17 17:49:58 -0800124 std::vector<DeviceRefPtr> *found) const;
Chris Masone9be4a9d2011-05-16 15:44:09 -0700125
Chris Masonee0dea762011-06-09 09:06:03 -0700126 ServiceRefPtr FindService(const std::string& name);
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800127 std::vector<std::string> EnumerateAvailableServices(Error *error);
Chris Masone9be4a9d2011-05-16 15:44:09 -0700128
Paul Stewart3c504012013-01-17 17:49:58 -0800129 // Return the complete list of services, including those that are not visible.
130 std::vector<std::string> EnumerateCompleteServices(Error *error);
131
mukesh agrawal32399322011-09-01 10:53:43 -0700132 // called via RPC (e.g., from ManagerDBusAdaptor)
Paul Stewart967eaeb2013-04-25 19:53:07 -0700133 std::map<std::string, std::string> GetLoadableProfileEntriesForService(
134 const ServiceConstRefPtr &service);
Darin Petkovb65c2452012-02-23 15:17:06 +0100135 ServiceRefPtr GetService(const KeyValueStore &args, Error *error);
Paul Stewart7f5ad572012-06-04 15:18:54 -0700136 ServiceRefPtr ConfigureService(const KeyValueStore &args, Error *error);
Paul Stewartd2e1c362013-03-03 19:06:07 -0800137 ServiceRefPtr ConfigureServiceForProfile(
138 const std::string &profile_rpcid,
139 const KeyValueStore &args,
140 Error *error);
Paul Stewart7a20aa42013-01-17 12:21:41 -0800141 ServiceRefPtr FindMatchingService(const KeyValueStore &args, Error *error);
Paul Stewart7de7e022013-08-28 09:42:50 -0700142
143 // Retrieve geolocation data from the Manager.
144 const std::map<std::string, GeolocationInfos>
145 &GetNetworksForGeolocation() const;
146
147 // Called by Device when its geolocation data has been updated.
148 virtual void OnDeviceGeolocationInfoUpdated(const DeviceRefPtr &device);
149
Paul Stewart39db5ca2013-03-18 14:15:17 -0700150 void ConnectToBestServices(Error *error);
Paul Stewart7f61e522012-03-22 11:13:45 -0700151
Paul Stewartc681fa02012-03-02 19:40:04 -0800152 // Request portal detection checks on each registered device until a portal
153 // detection attempt starts on one of them.
154 void RecheckPortal(Error *error);
Paul Stewartd215af62012-04-24 23:25:50 -0700155 // Request portal detection be restarted on the device connected to
156 // |service|.
157 virtual void RecheckPortalOnService(const ServiceRefPtr &service);
158
Wade Guthrie68d41092013-04-02 12:56:02 -0700159 virtual void RequestScan(Device::ScanType scan_type,
160 const std::string &technology, Error *error);
Paul Stewart22aa71b2011-09-16 12:15:11 -0700161 std::string GetTechnologyOrder();
162 void SetTechnologyOrder(const std::string &order, Error *error);
Gaurav Shah71354762011-11-28 19:22:49 -0800163 // Set up the profile list starting with a default profile along with
164 // an (optional) list of startup profiles.
165 void InitializeProfiles();
Paul Stewart19c871d2011-12-15 16:10:13 -0800166 // Create a profile. This does not affect the profile stack. Returns
167 // the RPC path of the created profile in |path|.
168 void CreateProfile(const std::string &name, std::string *path, Error *error);
Paul Stewart5dc40aa2011-10-28 19:43:43 -0700169 // Pushes existing profile with name |name| onto stack of managed profiles.
Paul Stewart19c871d2011-12-15 16:10:13 -0800170 // Returns the RPC path of the pushed profile in |path|.
171 void PushProfile(const std::string &name, std::string *path, Error *error);
Paul Stewartf3eced92013-04-17 12:18:22 -0700172 // Insert an existing user profile with name |name| into the stack of
173 // managed profiles. Associate |user_hash| with this profile entry.
174 // Returns the RPC path of the pushed profile in |path|.
175 void InsertUserProfile(const std::string &name,
176 const std::string &user_hash,
177 std::string *path,
178 Error *error);
Paul Stewart5dc40aa2011-10-28 19:43:43 -0700179 // Pops profile named |name| off the top of the stack of managed profiles.
180 void PopProfile(const std::string &name, Error *error);
181 // Remove the active profile.
182 void PopAnyProfile(Error *error);
Paul Stewart307c2502013-03-23 12:32:10 -0700183 // Remove all user profiles from the stack of managed profiles leaving only
184 // default profiles.
185 void PopAllUserProfiles(Error *error);
Paul Stewarte73d05c2012-03-29 16:26:05 -0700186 // Remove the underlying persistent storage for a profile.
187 void RemoveProfile(const std::string &name, Error *error);
Paul Stewartd3d03882013-08-29 15:43:42 -0700188 // Called by a service to remove its associated configuration. If |service|
189 // is associated with a non-ephemeral profile, this configuration entry
190 // will be removed and the manager will search for another matching profile.
191 // If the service ends up with no matching profile, it is unloaded (which
192 // may also remove the service from the manager's list, e.g. WiFi services
193 // that are not visible)..
194 void RemoveService(const ServiceRefPtr &service);
Paul Stewart75225512012-01-26 22:51:33 -0800195 // Handle the event where a profile is about to remove a profile entry.
196 // Any Services that are dependent on this storage identifier will need
197 // to find new profiles. Return true if any service has been moved to a new
198 // profile. Any such services will have had the profile group removed from
199 // the profile.
200 virtual bool HandleProfileEntryDeletion(const ProfileRefPtr &profile,
201 const std::string &entry_name);
Paul Stewart13ed2252012-03-21 12:52:46 -0700202 // Find a registered service that contains a GUID property that
203 // matches |guid|.
204 virtual ServiceRefPtr GetServiceWithGUID(const std::string &guid,
205 Error *error);
Paul Stewart0756db92012-01-27 08:34:47 -0800206 // Find a service that is both the member of |profile| and has a
207 // storage identifier that matches |entry_name|. This function is
208 // called by the Profile in order to return a profile entry's properties.
209 virtual ServiceRefPtr GetServiceWithStorageIdentifier(
210 const ProfileRefPtr &profile,
211 const std::string &entry_name,
212 Error *error);
Paul Stewarte2bad7c2012-03-14 08:55:33 -0700213 // Return a reference to the Service associated with the default connection.
214 // If there is no such connection, this function returns a reference to NULL.
215 virtual ServiceRefPtr GetDefaultService() const;
Paul Stewart0756db92012-01-27 08:34:47 -0800216
mukesh agrawal46c27cc2013-07-10 16:39:10 -0700217 // Set enabled state of all |technology_name| devices to |enabled_state|.
218 void SetEnabledStateForTechnology(const std::string &technology_name,
219 bool enabled_state,
220 Error *error,
221 const ResultCallback &callback);
Paul Stewart20088d82012-02-16 06:58:55 -0800222 // Return whether a technology is marked as enabled for portal detection.
223 virtual bool IsPortalDetectionEnabled(Technology::Identifier tech);
Paul Stewart10e9e4e2012-04-26 19:46:28 -0700224 // Set the start-up value for the portal detection list. This list will
225 // be used until a value set explicitly over the control API. Until
226 // then, we ignore but do not overwrite whatever value is stored in the
227 // profile.
228 void SetStartupPortalList(const std::string &portal_list);
Paul Stewart20088d82012-02-16 06:58:55 -0800229
Paul Stewartd2e1c362013-03-03 19:06:07 -0800230 // Returns true if profile |a| has been pushed on the Manager's
231 // |profiles_| stack before profile |b|.
232 bool IsProfileBefore(const ProfileRefPtr &a,
233 const ProfileRefPtr &b) const;
234
Paul Stewart10ccbb32012-04-26 15:59:30 -0700235 // Return whether a service belongs to the ephemeral profile.
236 virtual bool IsServiceEphemeral(const ServiceConstRefPtr &service) const;
237
Paul Stewart3c504012013-01-17 17:49:58 -0800238 // Return whether a Technology has any connected Services.
239 virtual bool IsTechnologyConnected(Technology::Identifier technology) const;
240
Paul Stewart036dba02012-08-07 12:34:41 -0700241 // Return whether a technology is enabled for link monitoring.
242 virtual bool IsTechnologyLinkMonitorEnabled(
243 Technology::Identifier technology) const;
244
Paul Stewart3c504012013-01-17 17:49:58 -0800245 // Called by Profile when a |storage| completes initialization.
246 void OnProfileStorageInitialized(StoreInterface *storage);
247
248 // Return a Device with technology |technology| in the enabled state.
249 DeviceRefPtr GetEnabledDeviceWithTechnology(
250 Technology::Identifier technology) const;
Paul Stewart85aea152013-01-22 09:31:56 -0800251
Darin Petkov4cbff5b2013-01-29 16:29:05 +0100252 // Returns true if at least one connection exists, and false if there's no
253 // connected service.
254 virtual bool IsOnline() const;
Paul Stewart38fd24c2012-04-25 14:06:29 -0700255 std::string CalculateState(Error *error);
256
Paul Stewart03e29f72013-09-26 00:49:48 -0700257 // Recalculate the |connected_state_| string and emit a singal if it has
258 // changed.
259 void RefreshConnectionState();
260
Paul Stewartc681fa02012-03-02 19:40:04 -0800261 virtual int GetPortalCheckInterval() const {
262 return props_.portal_check_interval_seconds;
263 }
Paul Stewart20088d82012-02-16 06:58:55 -0800264 virtual const std::string &GetPortalCheckURL() const {
265 return props_.portal_url;
266 }
mukesh agrawal32399322011-09-01 10:53:43 -0700267
Darin Petkov2b8e44e2012-06-25 15:13:26 +0200268 DBusManager *dbus_manager() const { return dbus_manager_.get(); }
Chris Masone626719f2011-08-18 16:58:48 -0700269 virtual DeviceInfo *device_info() { return &device_info_; }
Ben Chan5742b242013-12-18 16:25:43 -0800270#if !defined(DISABLE_CELLULAR)
Paul Stewart8c116a92012-05-02 18:30:03 -0700271 virtual ModemInfo *modem_info() { return &modem_info_; }
Ben Chan5742b242013-12-18 16:25:43 -0800272#endif // DISABLE_CELLULAR
Darin Petkovcb0b5662012-12-13 09:59:44 +0100273 PowerManager *power_manager() const { return power_manager_.get(); }
Paul Stewart35eff132013-04-12 12:08:40 -0700274 virtual EthernetEapProvider *ethernet_eap_provider() const {
275 return ethernet_eap_provider_.get();
276 }
Darin Petkovc3505a52013-03-18 15:13:29 +0100277 VPNProvider *vpn_provider() const { return vpn_provider_.get(); }
278 WiFiProvider *wifi_provider() const { return wifi_provider_.get(); }
Ben Chan520eb172013-10-30 20:51:04 -0700279#if !defined(DISABLE_WIMAX)
Paul Stewartb87d22b2013-07-29 11:11:37 -0700280 virtual WiMaxProvider *wimax_provider() { return wimax_provider_.get(); }
Ben Chan520eb172013-10-30 20:51:04 -0700281#endif // DISABLE_WIMAX
mukesh agrawalde29fa82011-09-16 16:16:36 -0700282 PropertyStore *mutable_store() { return &store_; }
283 virtual const PropertyStore &store() const { return store_; }
Darin Petkov36a3ace2012-03-06 17:22:14 +0100284 GLib *glib() const { return glib_; }
Albert Chaulk0e1cdea2013-02-27 15:32:55 -0800285 virtual const base::FilePath &run_path() const { return run_path_; }
286 const base::FilePath &storage_path() const { return storage_path_; }
Prathmesh Prabhuba99b592013-04-17 15:13:14 -0700287 IPAddressStore * health_checker_remote_ips() const {
288 return health_checker_remote_ips_.get();
289 }
Chris Masoneb925cc82011-06-22 15:39:57 -0700290
Paul Stewartd408fdf2012-05-07 17:15:57 -0700291 bool GetArpGateway() const { return props_.arp_gateway; }
292 const std::string &GetHostName() const { return props_.host_name; }
Chris Masone877ff982011-09-21 16:18:24 -0700293
Eric Shienbrood9a245532012-03-07 14:20:39 -0500294 virtual void UpdateEnabledTechnologies();
Ben Chan5086b972013-01-15 21:51:38 -0800295 virtual void UpdateUninitializedTechnologies();
Gary Morainac1bdb42012-02-16 17:42:29 -0800296
Gary Moraind93615e2012-04-27 11:50:03 -0700297 // Writes the service |to_update| to persistant storage. If the service's is
298 // ephemeral, it is moved to the current profile.
299 void SaveServiceToProfile(const ServiceRefPtr &to_update);
300
Gary Moraina9fb3252012-05-31 12:05:31 -0700301 // Adds a closure to be executed when ChromeOS suspends or shill terminates.
302 // |name| should be unique; otherwise, a previous closure by the same name
303 // will be replaced. |start| will be called when RunTerminationActions() is
304 // called. When an action completed, TerminationActionComplete() must be
305 // called.
306 void AddTerminationAction(const std::string &name,
307 const base::Closure &start);
308
309 // Users call this function to report the completion of an action |name|.
310 // This function should be called once for each action.
311 void TerminationActionComplete(const std::string &name);
312
313 // Removes the action associtated with |name|.
314 void RemoveTerminationAction(const std::string &name);
315
Arman Ugurayab22c162012-10-08 19:08:38 -0700316 // Runs the termination actions and notifies the metrics framework
317 // that the termination actions started running, only if any termination
318 // actions have been registered. |reason| specifies whether this method was
319 // called due to termination or suspend. If all actions complete within
Darin Petkov3ec55342012-09-28 14:04:44 +0200320 // |kTerminationActionsTimeoutMilliseconds|, |done| is called with a value of
Arman Ugurayab22c162012-10-08 19:08:38 -0700321 // Error::kSuccess. Otherwise, it is called with Error::kOperationTimeout.
322 //
323 // Returns true, if termination actions were run.
324 bool RunTerminationActionsAndNotifyMetrics(
325 const base::Callback<void(const Error &)> &done,
326 Metrics::TerminationActionReason reason);
Gary Moraina9fb3252012-05-31 12:05:31 -0700327
Darin Petkova5e07ef2012-07-09 14:27:57 +0200328 // Registers a |callback| that's invoked whenever the default service
329 // changes. Returns a unique tag that can be used to deregister the
330 // callback. A tag equal to 0 is invalid.
331 virtual int RegisterDefaultServiceCallback(const ServiceCallback &callback);
332 virtual void DeregisterDefaultServiceCallback(int tag);
333
Christopher Wiley0d9cf0c2013-02-19 19:24:57 -0800334 // Verifies that the destination described by certificate is valid, and that
335 // we're currently connected to that destination. A full description of the
336 // rules being enforced is in doc/manager-api.txt. Returns true iff all
337 // checks pass, false otherwise. On false, error is filled with a
338 // descriptive error code and message.
339 //
340 // |certificate| is a PEM encoded x509 certificate, |public_key| is a base64
341 // encoded public half of an RSA key, |nonce| is a random string, and
342 // |signed_data| is a base64 encoded string as described in
343 // doc/manager-api.txt.
344 void VerifyDestination(const std::string &certificate,
345 const std::string &public_key,
346 const std::string &nonce,
347 const std::string &signed_data,
348 const std::string &destination_udn,
Christopher Wileycdde79f2013-05-01 14:26:56 -0700349 const std::string &hotspot_ssid,
350 const std::string &hotspot_bssid,
Christopher Wiley0d9cf0c2013-02-19 19:24:57 -0800351 const ResultBoolCallback &cb,
352 Error *error);
353
354 // After verifying the destination, encrypt the string data with
355 // |public_key|, the base64 encoded public half of an RSA key pair. Returns
356 // the base64 encoded result if successful, or an empty string on failure.
357 // On failure, |error| will be filled with an appropriately descriptive
358 // message and error code.
359 void VerifyAndEncryptData(const std::string &certificate,
360 const std::string &public_key,
361 const std::string &nonce,
362 const std::string &signed_data,
363 const std::string &destination_udn,
Christopher Wileycdde79f2013-05-01 14:26:56 -0700364 const std::string &hotspot_ssid,
365 const std::string &hotspot_bssid,
Christopher Wiley0d9cf0c2013-02-19 19:24:57 -0800366 const std::string &data,
367 const ResultStringCallback &cb,
368 Error *error);
369
370 // After verifying the destination, encrypt the password for |network_path|
371 // under |public_key|. Similar to EncryptData above except that the
372 // information being encrypted is implicitly the authentication credentials
373 // of the given network.
374 void VerifyAndEncryptCredentials(const std::string &certificate,
375 const std::string &public_key,
376 const std::string &nonce,
377 const std::string &signed_data,
378 const std::string &destination_udn,
Christopher Wileycdde79f2013-05-01 14:26:56 -0700379 const std::string &hotspot_ssid,
380 const std::string &hotspot_bssid,
Christopher Wiley0d9cf0c2013-02-19 19:24:57 -0800381 const std::string &network_path,
382 const ResultStringCallback &cb,
383 Error *error);
384
Peter Qiu9d581932014-04-14 16:37:37 -0700385 // Calculate connection identifier, which is hash of salt value, gateway IP
386 // address, and gateway MAC address.
387 int CalcConnectionId(std::string gateway_ip, std::string gateway_mac);
388
389 // Report the number of services associated with given connection
390 // |connection_id|.
391 void ReportServicesOnSameNetwork(int connection_id);
392
Paul Stewart75897df2011-04-27 09:05:53 -0700393 private:
Arman Ugurayab22c162012-10-08 19:08:38 -0700394 friend class CellularTest;
Darin Petkovc3505a52013-03-18 15:13:29 +0100395 friend class DeviceInfoTest;
Darin Petkov6f9eaa32011-08-09 15:26:44 -0700396 friend class ManagerAdaptorInterface;
Paul Stewart22aa71b2011-09-16 12:15:11 -0700397 friend class ManagerTest;
Ben Chan66174a12014-01-08 21:27:00 -0800398 friend class ModemInfoTest;
399 friend class ModemManagerTest;
Darin Petkovcb0b5662012-12-13 09:59:44 +0100400 friend class ServiceTest;
Darin Petkovc3505a52013-03-18 15:13:29 +0100401 friend class VPNServiceTest;
Paul Stewarte369ece2012-05-22 09:11:03 -0700402 friend class WiFiObjectTest;
Darin Petkovb501ad22012-07-03 12:50:52 +0200403 friend class WiMaxProviderTest;
Arman Ugurayab22c162012-10-08 19:08:38 -0700404
Ben Chan9f3dcf82013-09-25 18:04:58 -0700405 FRIEND_TEST(CellularCapabilityUniversalMainTest, TerminationAction);
406 FRIEND_TEST(CellularCapabilityUniversalMainTest,
407 TerminationActionRemovedByStopModem);
Arman Uguray32c76402012-11-27 14:01:13 -0800408 FRIEND_TEST(CellularTest, LinkEventWontDestroyService);
Gaurav Shah435de2c2011-11-17 19:01:07 -0800409 FRIEND_TEST(ManagerTest, AvailableTechnologies);
410 FRIEND_TEST(ManagerTest, ConnectedTechnologies);
Paul Stewart39db5ca2013-03-18 14:15:17 -0700411 FRIEND_TEST(ManagerTest, ConnectToBestServices);
Gaurav Shah435de2c2011-11-17 19:01:07 -0800412 FRIEND_TEST(ManagerTest, DefaultTechnology);
Paul Stewart1b253142012-01-26 14:05:52 -0800413 FRIEND_TEST(ManagerTest, DeviceRegistrationAndStart);
Darin Petkova5e07ef2012-07-09 14:27:57 +0200414 FRIEND_TEST(ManagerTest, DisableTechnology);
415 FRIEND_TEST(ManagerTest, EnableTechnology);
Paul Stewart1b253142012-01-26 14:05:52 -0800416 FRIEND_TEST(ManagerTest, EnumerateProfiles);
Paul Stewart65512e12012-03-26 18:01:08 -0700417 FRIEND_TEST(ManagerTest, HandleProfileEntryDeletionWithUnload);
mukesh agrawal00752532013-05-03 15:46:55 -0700418 FRIEND_TEST(ManagerTest, InitializeProfilesInformsProviders);
419 FRIEND_TEST(ManagerTest, InitializeProfilesHandlesDefaults);
Paul Stewart3c504012013-01-17 17:49:58 -0800420 FRIEND_TEST(ManagerTest, IsDefaultProfile);
Paul Stewart036dba02012-08-07 12:34:41 -0700421 FRIEND_TEST(ManagerTest, LinkMonitorEnabled);
Darin Petkova5e07ef2012-07-09 14:27:57 +0200422 FRIEND_TEST(ManagerTest, NotifyDefaultServiceChanged);
Paul Stewart65512e12012-03-26 18:01:08 -0700423 FRIEND_TEST(ManagerTest, PopProfileWithUnload);
Arman Ugurayab22c162012-10-08 19:08:38 -0700424 FRIEND_TEST(ManagerTest, RunTerminationActions);
Paul Stewart1b253142012-01-26 14:05:52 -0800425 FRIEND_TEST(ManagerTest, SortServices);
426 FRIEND_TEST(ManagerTest, SortServicesWithConnection);
Paul Stewart10e9e4e2012-04-26 19:46:28 -0700427 FRIEND_TEST(ManagerTest, StartupPortalList);
Peter Qiu574996a2014-04-04 10:55:47 -0700428 FRIEND_TEST(ManagerTest, IsWifiIdle);
Darin Petkov6f9eaa32011-08-09 15:26:44 -0700429
Darin Petkovb65c2452012-02-23 15:17:06 +0100430 static const char kErrorNoDevice[];
431 static const char kErrorTypeRequired[];
432 static const char kErrorUnsupportedServiceType[];
433
Darin Petkov3ec55342012-09-28 14:04:44 +0200434 // Time to wait for termination actions to complete.
435 static const int kTerminationActionsTimeoutMilliseconds;
436
437 static const char kPowerManagerKey[];
438
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000439 void AutoConnect();
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800440 std::vector<std::string> AvailableTechnologies(Error *error);
441 std::vector<std::string> ConnectedTechnologies(Error *error);
442 std::string DefaultTechnology(Error *error);
443 std::vector<std::string> EnabledTechnologies(Error *error);
Ben Chan5086b972013-01-15 21:51:38 -0800444 std::vector<std::string> UninitializedTechnologies(Error *error);
Paul Stewartcb3eb892012-06-07 14:24:46 -0700445 RpcIdentifiers EnumerateDevices(Error *error);
446 RpcIdentifiers EnumerateProfiles(Error *error);
Chris Masone6791a432011-07-12 13:23:19 -0700447 // TODO(cmasone): This should be implemented by filtering |services_|.
Paul Stewartcb3eb892012-06-07 14:24:46 -0700448 RpcIdentifiers EnumerateWatchedServices(Error *error);
Paul Stewart1b253142012-01-26 14:05:52 -0800449 std::string GetActiveProfileRpcIdentifier(Error *error);
Paul Stewart10e9e4e2012-04-26 19:46:28 -0700450 std::string GetCheckPortalList(Error *error);
Paul Stewart49739c02012-08-08 17:24:03 -0700451 RpcIdentifier GetDefaultServiceRpcIdentifier(Error *error);
Paul Stewart4d5efb72012-09-17 12:24:34 -0700452 std::string GetIgnoredDNSSearchPaths(Error *error);
Paul Stewart7f5ad572012-06-04 15:18:54 -0700453 ServiceRefPtr GetServiceInner(const KeyValueStore &args, Error *error);
mukesh agrawalbebf1b82013-04-23 15:06:33 -0700454 bool SetCheckPortalList(const std::string &portal_list, Error *error);
455 bool SetIgnoredDNSSearchPaths(const std::string &ignored_paths, Error *error);
Paul Stewart49739c02012-08-08 17:24:03 -0700456 void EmitDefaultService();
Paul Stewart036dba02012-08-07 12:34:41 -0700457 bool IsTechnologyInList(const std::string &technology_list,
458 Technology::Identifier tech) const;
Paul Stewart3c504012013-01-17 17:49:58 -0800459 bool IsDefaultProfile(StoreInterface *storage);
Eric Shienbrood8839a892012-03-29 10:33:48 -0400460 void EmitDeviceProperties();
Paul Stewart9d97b7d2014-03-13 21:47:03 -0700461 bool SetDisableWiFiVHT(const bool &disable_wifi_vht, Error *error);
462 bool GetDisableWiFiVHT(Error *error);
Chris Masoneb925cc82011-06-22 15:39:57 -0700463
Paul Stewart65512e12012-03-26 18:01:08 -0700464 // Unload a service while iterating through |services_|. Returns true if
465 // service was erased (which means the caller loop should not increment
466 // |service_iterator|), false otherwise (meaning the caller should
467 // increment |service_iterator|).
468 bool UnloadService(std::vector<ServiceRefPtr>::iterator *service_iterator);
469
Paul Stewart4d5efb72012-09-17 12:24:34 -0700470 // Load Manager default properties from |profile|.
mukesh agrawal92496a42014-04-08 16:04:43 -0700471 void LoadProperties(const scoped_refptr<DefaultProfile> &profile);
Paul Stewart4d5efb72012-09-17 12:24:34 -0700472
Paul Stewart3c504012013-01-17 17:49:58 -0800473 // Configure the device with profile data from all current profiles.
474 void LoadDeviceFromProfiles(const DeviceRefPtr &device);
475
Paul Stewart49739c02012-08-08 17:24:03 -0700476 void HelpRegisterConstDerivedRpcIdentifier(
477 const std::string &name,
478 RpcIdentifier(Manager::*get)(Error *));
mukesh agrawal2366eed2012-03-20 18:21:50 -0700479 void HelpRegisterConstDerivedRpcIdentifiers(
480 const std::string &name,
481 RpcIdentifiers(Manager::*get)(Error *));
mukesh agrawalffa3d042011-10-06 15:26:10 -0700482 void HelpRegisterDerivedString(
483 const std::string &name,
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800484 std::string(Manager::*get)(Error *),
mukesh agrawalbebf1b82013-04-23 15:06:33 -0700485 bool(Manager::*set)(const std::string&, Error *));
486 void HelpRegisterConstDerivedStrings(
mukesh agrawalffa3d042011-10-06 15:26:10 -0700487 const std::string &name,
mukesh agrawalbebf1b82013-04-23 15:06:33 -0700488 Strings(Manager::*get)(Error *));
Paul Stewart9d97b7d2014-03-13 21:47:03 -0700489 void HelpRegisterDerivedBool(
490 const std::string &name,
491 bool(Manager::*get)(Error *error),
492 bool(Manager::*set)(const bool &value, Error *error));
Chris Masone27c4aa52011-07-02 13:10:14 -0700493
Paul Stewartf3eced92013-04-17 12:18:22 -0700494 bool HasProfile(const Profile::Identifier &ident);
495 void PushProfileInternal(const Profile::Identifier &ident,
496 std::string *path,
497 Error *error);
Paul Stewart5dc40aa2011-10-28 19:43:43 -0700498 void PopProfileInternal();
Paul Stewart78af94c2013-04-17 16:02:06 -0700499 void OnProfilesChanged();
500
Paul Stewart22aa71b2011-09-16 12:15:11 -0700501 void SortServices();
Paul Stewartdfa46052012-06-26 09:44:14 -0700502 void SortServicesTask();
Paul Stewart75225512012-01-26 22:51:33 -0800503 bool MatchProfileWithService(const ServiceRefPtr &service);
Paul Stewart22aa71b2011-09-16 12:15:11 -0700504
Paul Stewartd2e1c362013-03-03 19:06:07 -0800505 // Sets the profile of |service| to |profile|, without notifying its
506 // previous profile. Configures a |service| with |args|, then saves
507 // the resulting configuration to |profile|. This method is useful
508 // when copying a service configuration from one profile to another,
509 // or writing a newly created service config to a specific profile.
510 static void SetupServiceInProfile(ServiceRefPtr service,
511 ProfileRefPtr profile,
512 const KeyValueStore &args,
513 Error *error);
514
Paul Stewart39db5ca2013-03-18 14:15:17 -0700515 // For each technology present, connect to the "best" service available,
516 // as determined by sorting all services independent of their current state.
517 void ConnectToBestServicesTask();
518
Darin Petkova5e07ef2012-07-09 14:27:57 +0200519 void NotifyDefaultServiceChanged(const ServiceRefPtr &service);
520
Arman Ugurayab22c162012-10-08 19:08:38 -0700521 // Runs the termination actions. If all actions complete within
522 // |kTerminationActionsTimeoutMilliseconds|, |done| is called with a value of
523 // Error::kSuccess. Otherwise, it is called with Error::kOperationTimeout.
524 void RunTerminationActions(const base::Callback<void(const Error &)> &done);
525
Daniel Eratfac09532014-04-17 20:25:59 -0700526 // Called when the system is about to be suspended. Each call will be
527 // followed by a call to OnSuspendDone().
Daniel Erat0818cca2012-12-14 10:16:21 -0800528 void OnSuspendImminent(int suspend_id);
Darin Petkov3ec55342012-09-28 14:04:44 +0200529
Daniel Eratfac09532014-04-17 20:25:59 -0700530 // Called when the system has completed a suspend attempt (possibly without
531 // actually suspending, in the event of the user canceling the attempt).
532 void OnSuspendDone(int suspend_id);
533
Daniel Erat0818cca2012-12-14 10:16:21 -0800534 void OnSuspendActionsComplete(int suspend_id, const Error &error);
Christopher Wiley1057cd72013-02-28 15:21:29 -0800535 void VerifyToEncryptLink(std::string public_key, std::string data,
536 ResultStringCallback cb, const Error &error,
537 bool success);
Darin Petkovca621542012-07-25 14:25:56 +0200538
Peter Qiu574996a2014-04-04 10:55:47 -0700539 // Return true if wifi device is enabled with no existing connection (pending
540 // or connected).
541 bool IsWifiIdle();
542
Thieu Lea20cbc22012-01-09 22:01:43 +0000543 // For unit testing.
544 void set_metrics(Metrics *metrics) { metrics_ = metrics; }
Paul Stewartb87d22b2013-07-29 11:11:37 -0700545 void UpdateProviderMapping();
Thieu Lea20cbc22012-01-09 22:01:43 +0000546
Gary Morainac1bdb42012-02-16 17:42:29 -0800547 // Used by tests to set a mock PowerManager. Takes ownership of
548 // power_manager.
549 void set_power_manager(PowerManager *power_manager) {
550 power_manager_.reset(power_manager);
551 }
552
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000553 EventDispatcher *dispatcher_;
Albert Chaulk0e1cdea2013-02-27 15:32:55 -0800554 const base::FilePath run_path_;
555 const base::FilePath storage_path_;
Chris Masone2ae797d2011-08-23 20:41:00 -0700556 const std::string user_storage_format_;
mukesh agrawald142fd62013-05-01 16:50:57 -0700557 base::FilePath user_profile_list_path_; // Changed in tests.
Paul Stewart0af98bf2011-05-10 17:38:08 -0700558 scoped_ptr<ManagerAdaptorInterface> adaptor_;
Darin Petkov002c58e2012-06-19 02:56:05 +0200559 scoped_ptr<DBusManager> dbus_manager_;
Paul Stewart0af98bf2011-05-10 17:38:08 -0700560 DeviceInfo device_info_;
Ben Chan5742b242013-12-18 16:25:43 -0800561#if !defined(DISABLE_CELLULAR)
Darin Petkov887f2982011-07-14 16:10:17 -0700562 ModemInfo modem_info_;
Ben Chan5742b242013-12-18 16:25:43 -0800563#endif // DISABLE_CELLULAR
Paul Stewart35eff132013-04-12 12:08:40 -0700564 scoped_ptr<EthernetEapProvider> ethernet_eap_provider_;
Darin Petkovc3505a52013-03-18 15:13:29 +0100565 scoped_ptr<VPNProvider> vpn_provider_;
Paul Stewart3c504012013-01-17 17:49:58 -0800566 scoped_ptr<WiFiProvider> wifi_provider_;
Ben Chan520eb172013-10-30 20:51:04 -0700567#if !defined(DISABLE_WIMAX)
Paul Stewartb87d22b2013-07-29 11:11:37 -0700568 scoped_ptr<WiMaxProvider> wimax_provider_;
Ben Chan520eb172013-10-30 20:51:04 -0700569#endif // DISABLE_WIMAX
Paul Stewart4d5efb72012-09-17 12:24:34 -0700570 // Hold pointer to singleton Resolver instance for testing purposes.
571 Resolver *resolver_;
Paul Stewart75897df2011-04-27 09:05:53 -0700572 bool running_;
Paul Stewart5dc40aa2011-10-28 19:43:43 -0700573 // Used to facilitate unit tests which can't use RPC.
574 bool connect_profiles_to_rpc_;
Chris Masonec1e50412011-06-07 13:04:53 -0700575 std::vector<DeviceRefPtr> devices_;
Chris Masone6791a432011-07-12 13:23:19 -0700576 // We store Services in a vector, because we want to keep them sorted.
Gary Morain028545d2012-04-07 14:55:52 -0700577 // Services that are connected appear first in the vector. See
578 // Service::Compare() for details of the sorting criteria.
Chris Masonec1e50412011-06-07 13:04:53 -0700579 std::vector<ServiceRefPtr> services_;
Paul Stewartb87d22b2013-07-29 11:11:37 -0700580 // Map of technologies to Provider instances. These pointers are owned
581 // by the respective scoped_reptr objects that are held over the lifetime
582 // of the Manager object.
Paul Stewartbc14fb72013-07-30 08:21:58 -0700583 std::map<Technology::Identifier, ProviderInterface *> providers_;
Gaurav Shah71354762011-11-28 19:22:49 -0800584 // List of startup profile names to push on the profile stack on startup.
Chris Masone7aa5f902011-07-11 11:13:35 -0700585 std::vector<ProfileRefPtr> profiles_;
586 ProfileRefPtr ephemeral_profile_;
Chris Masone2ae797d2011-08-23 20:41:00 -0700587 ControlInterface *control_interface_;
Thieu Le3426c8f2012-01-11 17:35:11 -0800588 Metrics *metrics_;
Chris Masone2ae797d2011-08-23 20:41:00 -0700589 GLib *glib_;
Gary Morainac1bdb42012-02-16 17:42:29 -0800590 scoped_ptr<PowerManager> power_manager_;
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700591
Paul Stewart22aa71b2011-09-16 12:15:11 -0700592 // The priority order of technologies
593 std::vector<Technology::Identifier> technology_order_;
594
Paul Stewart49739c02012-08-08 17:24:03 -0700595 // This is the last Service RPC Identifier for which we emitted a
596 // "DefaultService" signal for.
597 RpcIdentifier default_service_rpc_identifier_;
598
Paul Stewart10e9e4e2012-04-26 19:46:28 -0700599 // Manager can be optionally configured with a list of technologies to
600 // do portal detection on at startup. We need to keep track of that list
601 // as well as a flag that tells us whether we should continue using it
602 // instead of the configured portal list.
603 std::string startup_portal_list_;
604 bool use_startup_portal_list_;
605
Chris Masoneb925cc82011-06-22 15:39:57 -0700606 // Properties to be get/set via PropertyStore calls.
Chris Masone88cbd5f2011-07-03 14:30:04 -0700607 Properties props_;
Chris Masone27c4aa52011-07-02 13:10:14 -0700608 PropertyStore store_;
Gary Moraina9fb3252012-05-31 12:05:31 -0700609
Paul Stewartdfa46052012-06-26 09:44:14 -0700610 base::CancelableClosure sort_services_task_;
Darin Petkov3ec55342012-09-28 14:04:44 +0200611
612 // TODO(petkov): Currently this handles both terminate and suspend
613 // actions. Rename all relevant identifiers to capture this.
Gary Moraina9fb3252012-05-31 12:05:31 -0700614 HookTable termination_actions_;
Darin Petkova5e07ef2012-07-09 14:27:57 +0200615
Daniel Erat0818cca2012-12-14 10:16:21 -0800616 // Is a suspend delay currently registered with the power manager?
617 bool suspend_delay_registered_;
618
Darin Petkova5e07ef2012-07-09 14:27:57 +0200619 // Maps tags to callbacks for monitoring default service changes.
620 std::map<int, ServiceCallback> default_service_callbacks_;
621 int default_service_callback_tag_;
Christopher Wiley1057cd72013-02-28 15:21:29 -0800622
623 // Delegate to handle destination verification operations for the manager.
624 scoped_ptr<CryptoUtilProxy> crypto_util_proxy_;
Prathmesh Prabhuba99b592013-04-17 15:13:14 -0700625
626 // Stores IP addresses of some remote hosts that accept port 80 TCP
627 // connections. ConnectionHealthChecker uses these IPs.
628 // The store resides in Manager so that it persists across Device reset.
629 scoped_ptr<IPAddressStore> health_checker_remote_ips_;
Paul Stewart7de7e022013-08-28 09:42:50 -0700630
631 // Stores the most recent copy of geolocation information for each
632 // technology type.
633 std::map<std::string, GeolocationInfos> networks_for_geolocation_;
Paul Stewart03e29f72013-09-26 00:49:48 -0700634
635 // Stores the state of the highest ranked connected service.
636 std::string connection_state_;
mukesh agrawal92496a42014-04-08 16:04:43 -0700637
638 DISALLOW_COPY_AND_ASSIGN(Manager);
Paul Stewart75897df2011-04-27 09:05:53 -0700639};
640
641} // namespace shill
642
Darin Petkov002c58e2012-06-19 02:56:05 +0200643#endif // SHILL_MANAGER_H_