Arman Uguray | 2717a10 | 2013-01-29 23:36:06 -0800 | [diff] [blame] | 1 | // Copyright (c) 2013 The Chromium OS Authors. All rights reserved. |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Ben Chan | 19f8397 | 2012-10-03 23:25:56 -0700 | [diff] [blame] | 5 | #ifndef SHILL_SERVICE_H_ |
| 6 | #define SHILL_SERVICE_H_ |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 7 | |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 8 | #include <time.h> |
| 9 | |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 10 | #include <deque> |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 11 | #include <map> |
Ben Chan | cd47732 | 2014-10-17 14:19:30 -0700 | [diff] [blame] | 12 | #include <memory> |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 13 | #include <set> |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 14 | #include <string> |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 15 | #include <vector> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 16 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 17 | #include <base/cancelable_callback.h> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 18 | #include <base/memory/ref_counted.h> |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 19 | #include <base/memory/weak_ptr.h> |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 20 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 21 | |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 22 | #include "shill/accessor_interface.h" |
Alex Vakulenko | a41ab51 | 2014-07-23 14:24:23 -0700 | [diff] [blame] | 23 | #include "shill/adaptor_interfaces.h" |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 24 | #include "shill/callbacks.h" |
Peter Qiu | 8d6b597 | 2014-10-28 15:33:34 -0700 | [diff] [blame] | 25 | #include "shill/net/shill_time.h" |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 26 | #include "shill/property_store.h" |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 27 | #include "shill/refptr_types.h" |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 28 | #include "shill/static_ip_parameters.h" |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 29 | #include "shill/technology.h" |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 30 | |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 31 | namespace chromeos_metrics { |
| 32 | class Timer; |
| 33 | } |
| 34 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 35 | namespace shill { |
| 36 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 37 | class ControlInterface; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 38 | class DiagnosticsReporter; |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 39 | class EapCredentials; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 40 | class Endpoint; |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 41 | class Error; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 42 | class EventDispatcher; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 43 | class HTTPProxy; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 44 | class KeyValueStore; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 45 | class Manager; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 46 | class Metrics; |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 47 | class MockManager; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 48 | class ServiceAdaptorInterface; |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 49 | class ServiceMockAdaptor; |
Paul Stewart | 45170bc | 2014-06-02 15:49:34 -0700 | [diff] [blame] | 50 | class ServicePropertyChangeNotifier; |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 51 | class Sockets; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 52 | class StoreInterface; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 53 | |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 54 | // A Service is a uniquely named entity, which the system can |
| 55 | // connect in order to begin sending and receiving network traffic. |
| 56 | // All Services are bound to an Entry, which represents the persistable |
| 57 | // state of the Service. If the Entry is populated at the time of Service |
| 58 | // creation, that information is used to prime the Service. If not, the Entry |
| 59 | // becomes populated over time. |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 60 | class Service : public base::RefCounted<Service> { |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 61 | public: |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 62 | static const char kCheckPortalAuto[]; |
| 63 | static const char kCheckPortalFalse[]; |
| 64 | static const char kCheckPortalTrue[]; |
| 65 | |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 66 | static const char kErrorDetailsNone[]; |
| 67 | |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 68 | // TODO(pstew): Storage constants shouldn't need to be public |
Paul Stewart | ee6b3d7 | 2013-07-12 16:07:51 -0700 | [diff] [blame] | 69 | // crbug.com/208736 |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 70 | static const char kStorageAutoConnect[]; |
| 71 | static const char kStorageCheckPortal[]; |
Peter Qiu | a89154b | 2014-05-23 15:45:42 -0700 | [diff] [blame] | 72 | static const char kStorageDNSAutoFallback[]; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 73 | static const char kStorageError[]; |
| 74 | static const char kStorageFavorite[]; |
| 75 | static const char kStorageGUID[]; |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 76 | static const char kStorageHasEverConnected[]; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 77 | static const char kStorageName[]; |
| 78 | static const char kStoragePriority[]; |
| 79 | static const char kStorageProxyConfig[]; |
| 80 | static const char kStorageSaveCredentials[]; |
| 81 | static const char kStorageType[]; |
| 82 | static const char kStorageUIData[]; |
Peter Qiu | 9d58193 | 2014-04-14 16:37:37 -0700 | [diff] [blame] | 83 | static const char kStorageConnectionId[]; |
Peter Qiu | d49760e | 2014-09-19 16:13:42 -0700 | [diff] [blame] | 84 | static const char kStorageLinkMonitorDisabled[]; |
Paul Stewart | 3fee7e3 | 2014-10-15 21:39:29 -0700 | [diff] [blame^] | 85 | static const char kStorageManagedCredentials[]; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 86 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 87 | static const uint8_t kStrengthMax; |
| 88 | static const uint8_t kStrengthMin; |
mukesh agrawal | 8f3f775 | 2012-02-17 19:42:09 -0800 | [diff] [blame] | 89 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 90 | enum ConnectFailure { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 91 | kFailureUnknown, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 92 | kFailureAAA, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 93 | kFailureActivation, |
| 94 | kFailureBadPassphrase, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 95 | kFailureBadWEPKey, |
| 96 | kFailureConnect, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 97 | kFailureDHCP, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 98 | kFailureDNSLookup, |
Paul Stewart | db0f917 | 2012-11-30 16:48:09 -0800 | [diff] [blame] | 99 | kFailureEAPAuthentication, |
| 100 | kFailureEAPLocalTLS, |
| 101 | kFailureEAPRemoteTLS, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 102 | kFailureHTTPGet, |
| 103 | kFailureIPSecCertAuth, |
| 104 | kFailureIPSecPSKAuth, |
| 105 | kFailureInternal, |
| 106 | kFailureNeedEVDO, |
| 107 | kFailureNeedHomeNetwork, |
| 108 | kFailureOTASP, |
| 109 | kFailureOutOfRange, |
| 110 | kFailurePPPAuth, |
| 111 | kFailurePinMissing, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 112 | kFailureMax |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 113 | }; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 114 | enum ConnectState { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 115 | kStateUnknown, |
| 116 | kStateIdle, |
| 117 | kStateAssociating, |
| 118 | kStateConfiguring, |
| 119 | kStateConnected, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 120 | kStatePortal, |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 121 | kStateFailure, |
| 122 | kStateOnline |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 123 | }; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 124 | enum CryptoAlgorithm { |
| 125 | kCryptoNone, |
| 126 | kCryptoRc4, |
| 127 | kCryptoAes |
| 128 | }; |
Paul Stewart | 7b5cee9 | 2014-06-25 02:03:34 -0700 | [diff] [blame] | 129 | |
Rebecca Silberstein | 5777690 | 2014-09-15 21:43:02 -0700 | [diff] [blame] | 130 | enum UpdateCredentialsReason{ |
| 131 | kReasonCredentialsLoaded, |
| 132 | kReasonPropertyUpdate |
| 133 | }; |
| 134 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 135 | static const int kPriorityNone; |
| 136 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 137 | // A constructor for the Service object |
| 138 | Service(ControlInterface *control_interface, |
| 139 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 140 | Metrics *metrics, |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 141 | Manager *manager, |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 142 | Technology::Identifier technology); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 143 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 144 | // AutoConnect MAY choose to ignore the connection request in some |
| 145 | // cases. For example, if the corresponding Device only supports one |
| 146 | // concurrent connection, and another Service is already connected |
| 147 | // or connecting. |
| 148 | // |
| 149 | // AutoConnect MAY issue RPCs immediately. So AutoConnect MUST NOT |
| 150 | // be called from a D-Bus signal handler context. |
| 151 | virtual void AutoConnect(); |
mukesh agrawal | dc7b844 | 2012-09-27 13:48:14 -0700 | [diff] [blame] | 152 | // Queue up a connection attempt. Derived classes SHOULD call the |
| 153 | // base class implementation before beginning a connect. The base |
| 154 | // class will log the connection attempt, and update base-class |
| 155 | // state. |
| 156 | virtual void Connect(Error *error, const char *reason); |
Christopher Wiley | abd3b50 | 2012-09-26 13:08:52 -0700 | [diff] [blame] | 157 | // Disconnect this service. Override this method to add your service specific |
| 158 | // disconnect logic, but call the super class's Disconnect() first. |
Samuel Tan | 0d06119 | 2014-07-07 15:45:15 -0700 | [diff] [blame] | 159 | virtual void Disconnect(Error *error, const char *reason); |
Christopher Wiley | abd3b50 | 2012-09-26 13:08:52 -0700 | [diff] [blame] | 160 | // Disconnects this service via Disconnect(). Marks the service as having |
| 161 | // failed with |failure|. Do not override this method. |
Samuel Tan | 0d06119 | 2014-07-07 15:45:15 -0700 | [diff] [blame] | 162 | virtual void DisconnectWithFailure(ConnectFailure failure, |
| 163 | Error *error, |
| 164 | const char *reason); |
Christopher Wiley | abd3b50 | 2012-09-26 13:08:52 -0700 | [diff] [blame] | 165 | // Disconnects this service via Disconnect(). The service will not be eligible |
| 166 | // for auto-connect until a subsequent call to Connect, or Load. Do not |
| 167 | // override this method. |
| 168 | virtual void UserInitiatedDisconnect(Error *error); |
Peter Qiu | dc4e099 | 2014-05-01 10:02:52 -0700 | [diff] [blame] | 169 | // Connect to this service via Connect(). This function indicates that the |
| 170 | // connection attempt is user-initiated. |
| 171 | virtual void UserInitiatedConnect(Error *error); |
Chris Masone | a82b711 | 2011-05-25 15:16:29 -0700 | [diff] [blame] | 172 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 173 | // The default implementation returns the error kInvalidArguments. |
| 174 | virtual void ActivateCellularModem(const std::string &carrier, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 175 | Error *error, |
| 176 | const ResultCallback &callback); |
Ben Chan | 5d92454 | 2013-02-14 17:49:08 -0800 | [diff] [blame] | 177 | // The default implementation returns the error kNotSupported. |
| 178 | virtual void CompleteCellularActivation(Error *error); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 179 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 180 | virtual bool IsActive(Error *error); |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 181 | |
Paul Stewart | 7fb0938 | 2012-07-18 17:32:27 -0700 | [diff] [blame] | 182 | // Returns whether services of this type should be auto-connect by default. |
| 183 | virtual bool IsAutoConnectByDefault() const { return false; } |
| 184 | |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 185 | virtual ConnectState state() const { return state_; } |
| 186 | // Updates the state of the Service and alerts the manager. Also |
| 187 | // clears |failure_| if the new state isn't a failure. |
| 188 | virtual void SetState(ConnectState state); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 189 | std::string GetStateString() const; |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 190 | |
Peter Qiu | 9b83c89 | 2014-08-09 23:06:02 -0700 | [diff] [blame] | 191 | // Set portal detection failure phase and status (reason). This function |
| 192 | // is called when portal detection failed for the Service. |
| 193 | virtual void SetPortalDetectionFailure(const std::string &phase, |
| 194 | const std::string &status); |
| 195 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 196 | // State utility functions |
Darin Petkov | c8d91e5 | 2013-01-21 11:43:47 +0100 | [diff] [blame] | 197 | static bool IsConnectedState(ConnectState state); |
| 198 | static bool IsConnectingState(ConnectState state); |
| 199 | |
| 200 | virtual bool IsConnected() const; |
| 201 | virtual bool IsConnecting() const; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 202 | virtual bool IsFailed() const { |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 203 | // We sometimes lie about the failure state, to keep Chrome happy |
| 204 | // (see comment in WiFi::HandleDisconnect). Hence, we check both |
| 205 | // state and |failed_time_|. |
| 206 | return state() == kStateFailure || failed_time_ > 0; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 207 | } |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 208 | |
Peter Qiu | 4943822 | 2014-03-14 14:21:09 -0700 | [diff] [blame] | 209 | virtual bool IsInFailState() const { |
| 210 | return state() == kStateFailure; |
| 211 | } |
| 212 | |
Peter Qiu | 700de64 | 2014-07-14 16:31:30 -0700 | [diff] [blame] | 213 | virtual bool IsOnline() const { |
| 214 | return state() == kStateOnline; |
| 215 | } |
| 216 | |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 217 | // Returns true if the connection for |this| depends on service |b|. |
| 218 | virtual bool IsDependentOn(const ServiceRefPtr &b) const; |
| 219 | |
Paul Stewart | a121c44 | 2012-06-09 14:12:58 -0700 | [diff] [blame] | 220 | virtual bool IsPortalled() const { |
| 221 | return state() == kStatePortal; |
| 222 | } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 223 | |
Peter Qiu | a89154b | 2014-05-23 15:45:42 -0700 | [diff] [blame] | 224 | // Return true if service is allowed to automatically switch to fallback |
| 225 | // DNS server. |
| 226 | virtual bool is_dns_auto_fallback_allowed() const { |
| 227 | return is_dns_auto_fallback_allowed_; |
| 228 | } |
| 229 | |
Peter Qiu | d49760e | 2014-09-19 16:13:42 -0700 | [diff] [blame] | 230 | virtual bool link_monitor_disabled() const { return link_monitor_disabled_; } |
| 231 | |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 232 | virtual ConnectFailure failure() const { return failure_; } |
Paul Stewart | d7c09a5 | 2014-02-19 12:50:29 -0800 | [diff] [blame] | 233 | // Sets the |previous_error_| property based on the current |failure_|, and |
| 234 | // sets a serial number for this failure. |
| 235 | virtual void SaveFailure(); |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 236 | // Records the failure mode and time. Sets the Service state to "Failure". |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 237 | virtual void SetFailure(ConnectFailure failure); |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 238 | // Records the failure mode and time. Sets the Service state to "Idle". |
| 239 | // Avoids showing a failure mole in the UI. |
| 240 | virtual void SetFailureSilent(ConnectFailure failure); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 241 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 242 | // Returns a string that is guaranteed to uniquely identify this Service |
| 243 | // instance. |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 244 | const std::string &unique_name() const { return unique_name_; } |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 245 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 246 | virtual std::string GetRpcIdentifier() const; |
Chris Masone | 3c3f6a1 | 2011-07-01 10:01:41 -0700 | [diff] [blame] | 247 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 248 | // Returns the unique persistent storage identifier for the service. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 249 | virtual std::string GetStorageIdentifier() const = 0; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 250 | |
Paul Stewart | e7de294 | 2013-04-25 17:07:31 -0700 | [diff] [blame] | 251 | // Returns the identifier within |storage| from which configuration for |
| 252 | // this service can be loaded. Returns an empty string if no entry in |
| 253 | // |storage| can be used. |
| 254 | virtual std::string GetLoadableStorageIdentifier( |
| 255 | const StoreInterface &storage) const; |
| 256 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 257 | // Returns whether the service configuration can be loaded from |storage|. |
Paul Stewart | e7de294 | 2013-04-25 17:07:31 -0700 | [diff] [blame] | 258 | virtual bool IsLoadableFrom(const StoreInterface &storage) const; |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 259 | |
Paul Stewart | 8142613 | 2012-05-16 10:05:10 -0700 | [diff] [blame] | 260 | // Returns true if the service uses 802.1x for key management. |
Paul Stewart | be9abfd | 2013-04-22 12:18:48 -0700 | [diff] [blame] | 261 | virtual bool Is8021x() const { return false; } |
Paul Stewart | 8142613 | 2012-05-16 10:05:10 -0700 | [diff] [blame] | 262 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 263 | // Loads the service from persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 264 | virtual bool Load(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 265 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 266 | // Indicate to service that it is no longer persisted to storage. It |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 267 | // should purge any stored profile state (e.g., credentials). Returns |
| 268 | // true to indicate that this service should also be unregistered from |
| 269 | // the manager, false otherwise. |
| 270 | virtual bool Unload(); |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 271 | |
Albert Chaulk | 0e1cdea | 2013-02-27 15:32:55 -0800 | [diff] [blame] | 272 | // Attempt to remove the service. On failure, no changes in state will occur. |
| 273 | virtual void Remove(Error *error); |
| 274 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 275 | // Saves the service to persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 276 | virtual bool Save(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 277 | |
Thieu Le | d4e9e55 | 2012-02-16 16:26:07 -0800 | [diff] [blame] | 278 | // Saves the service to the current profile. |
Gary Morain | d93615e | 2012-04-27 11:50:03 -0700 | [diff] [blame] | 279 | virtual void SaveToCurrentProfile(); |
Thieu Le | d4e9e55 | 2012-02-16 16:26:07 -0800 | [diff] [blame] | 280 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 281 | // Applies all the properties in |args| to this service object's mutable |
| 282 | // store, except for those in parameters_ignored_for_configure_. |
| 283 | // Returns an error in |error| if one or more parameter set attempts |
| 284 | // fails, but will only return the first error. |
| 285 | virtual void Configure(const KeyValueStore &args, Error *error); |
| 286 | |
Paul Stewart | 7a20aa4 | 2013-01-17 12:21:41 -0800 | [diff] [blame] | 287 | // Iterate over all the properties in |args| and test for an identical |
| 288 | // value in this service object's store. Returns false if one or more |
| 289 | // keys in |args| do not exist or have different values, true otherwise. |
| 290 | virtual bool DoPropertiesMatch(const KeyValueStore &args) const; |
| 291 | |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 292 | // Returns whether portal detection is explicitly disabled on this service |
| 293 | // via a property set on it. |
| 294 | virtual bool IsPortalDetectionDisabled() const; |
| 295 | |
| 296 | // Returns whether portal detection is set to follow the default setting |
| 297 | // of this service's technology via a property set on it. |
| 298 | virtual bool IsPortalDetectionAuto() const; |
| 299 | |
Paul Stewart | 10ccbb3 | 2012-04-26 15:59:30 -0700 | [diff] [blame] | 300 | // Returns true if the service is persisted to a non-ephemeral profile. |
| 301 | virtual bool IsRemembered() const; |
| 302 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 303 | // Returns true if the service RPC identifier should be part of the |
| 304 | // manager's advertised services list, false otherwise. |
| 305 | virtual bool IsVisible() const { return true; } |
| 306 | |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 307 | // Returns true if there is a proxy configuration set on this service. |
| 308 | virtual bool HasProxyConfig() const { return !proxy_config_.empty(); } |
| 309 | |
Paul Stewart | a47c3c6 | 2012-12-18 12:14:29 -0800 | [diff] [blame] | 310 | // Returns whether this service has had recent connection issues. |
| 311 | virtual bool HasRecentConnectionIssues(); |
| 312 | |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 313 | // If the AutoConnect property has not already been marked as saved, set |
| 314 | // its value to true and mark it saved. |
| 315 | virtual void EnableAndRetainAutoConnect(); |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 316 | |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 317 | // Set the connection for this service. If the connection is non-NULL, create |
| 318 | // an HTTP Proxy that will utilize this service's connection to serve |
| 319 | // requests. |
| 320 | virtual void SetConnection(const ConnectionRefPtr &connection); |
| 321 | virtual const ConnectionRefPtr &connection() const { return connection_; } |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 322 | |
Peter Qiu | a89154b | 2014-05-23 15:45:42 -0700 | [diff] [blame] | 323 | // Emit service's IP config change event to chrome. |
| 324 | virtual void NotifyIPConfigChanges(); |
| 325 | |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 326 | // Examines the EAP credentials for the service and returns true if a |
| 327 | // connection attempt can be made. |
Paul Stewart | 9413bcc | 2013-04-04 16:12:43 -0700 | [diff] [blame] | 328 | virtual bool Is8021xConnectable() const; |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 329 | |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 330 | // Add an EAP certification id |name| at position |depth| in the stack. |
| 331 | // Returns true if entry was added, false otherwise. |
| 332 | virtual bool AddEAPCertification(const std::string &name, size_t depth); |
| 333 | // Clear all EAP certification elements. |
Paul Stewart | 9413bcc | 2013-04-04 16:12:43 -0700 | [diff] [blame] | 334 | virtual void ClearEAPCertification(); |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 335 | |
Paul Stewart | 316acef | 2014-05-29 18:40:48 -0700 | [diff] [blame] | 336 | // Returns true if this service contains a IP address in its static IP |
| 337 | // parameters, false otherwise. |
| 338 | virtual bool HasStaticIPAddress() const; |
| 339 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 340 | // The inherited class that needs to send metrics after the service has |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 341 | // transitioned to the ready state should override this method. |
| 342 | // |time_resume_to_ready_milliseconds| holds the elapsed time from when |
| 343 | // the system was resumed until when the service transitioned to the |
| 344 | // connected state. This value is non-zero for the first service transition |
| 345 | // to the connected state after a resume. |
| 346 | virtual void SendPostReadyStateMetrics( |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 347 | int64_t /*time_resume_to_ready_milliseconds*/) const {} |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 348 | |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 349 | bool auto_connect() const { return auto_connect_; } |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 350 | void SetAutoConnect(bool connect); |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 351 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 352 | bool connectable() const { return connectable_; } |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 353 | // Sets the connectable property of the service, and broadcast the |
| 354 | // new value. Does not update the manager. |
| 355 | // TODO(petkov): Remove this method in favor of SetConnectableFull. |
Darin Petkov | b2ba39f | 2012-06-06 10:33:43 +0200 | [diff] [blame] | 356 | void SetConnectable(bool connectable); |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 357 | // Sets the connectable property of the service, broadcasts the new |
| 358 | // value, and alerts the manager if necessary. |
| 359 | void SetConnectableFull(bool connectable); |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 360 | |
Thieu Le | 67370f6 | 2012-02-14 23:01:42 +0000 | [diff] [blame] | 361 | virtual bool explicitly_disconnected() const { |
| 362 | return explicitly_disconnected_; |
| 363 | } |
| 364 | |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 365 | bool retain_auto_connect() const { return retain_auto_connect_; } |
| 366 | // Setter is deliberately omitted; use EnableAndRetainAutoConnect. |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 367 | |
Darin Petkov | 7f06033 | 2012-03-14 11:46:47 +0100 | [diff] [blame] | 368 | void set_friendly_name(const std::string &n) { friendly_name_ = n; } |
Darin Petkov | 9c6e981 | 2013-03-26 13:49:07 +0100 | [diff] [blame] | 369 | const std::string &friendly_name() const { return friendly_name_; } |
Ben Chan | 923a502 | 2013-09-20 11:23:23 -0700 | [diff] [blame] | 370 | // Sets the kNameProperty and broadcasts the change. |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 371 | void SetFriendlyName(const std::string &friendly_name); |
mukesh agrawal | 1590839 | 2011-11-16 18:29:25 +0000 | [diff] [blame] | 372 | |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 373 | const std::string &guid() const { return guid_; } |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 374 | bool SetGuid(const std::string &guid, Error *error); |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 375 | |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 376 | bool has_ever_connected() const { return has_ever_connected_; } |
Rebecca Silberstein | e99f664 | 2014-07-09 14:04:31 -0700 | [diff] [blame] | 377 | // Sets the has_ever_connected_ property of the service |
| 378 | // and broadcasts the new value |
| 379 | void SetHasEverConnected(bool has_ever_connected); |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 380 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 381 | int32_t priority() const { return priority_; } |
| 382 | bool SetPriority(const int32_t &priority, Error *error); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 383 | |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 384 | size_t crypto_algorithm() const { return crypto_algorithm_; } |
| 385 | bool key_rotation() const { return key_rotation_; } |
| 386 | bool endpoint_auth() const { return endpoint_auth_; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 387 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 388 | void SetStrength(uint8_t strength); |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 389 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 390 | // uint8_t streams out as a char. Coerce to a larger type, so that |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 391 | // it prints as a number. |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 392 | uint16_t strength() const { return strength_; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 393 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 394 | virtual Technology::Identifier technology() const { return technology_; } |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 395 | std::string GetTechnologyString() const; |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 396 | |
Paul Stewart | 35eff13 | 2013-04-12 12:08:40 -0700 | [diff] [blame] | 397 | virtual const EapCredentials *eap() const { return eap_.get(); } |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 398 | void SetEapCredentials(EapCredentials *eap); |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 399 | |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 400 | bool save_credentials() const { return save_credentials_; } |
| 401 | void set_save_credentials(bool save) { save_credentials_ = save; } |
| 402 | |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 403 | const std::string &error() const { return error_; } |
| 404 | void set_error(const std::string &error) { error_ = error; } |
| 405 | |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 406 | const std::string &error_details() const { return error_details_; } |
| 407 | void SetErrorDetails(const std::string &details); |
| 408 | |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 409 | static const char *ConnectFailureToString(const ConnectFailure &state); |
| 410 | static const char *ConnectStateToString(const ConnectState &state); |
| 411 | |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 412 | // Compare two services. Returns true if Service |a| should be displayed |
| 413 | // above |b|. If |compare_connectivity_state| is true, the connectivity |
| 414 | // state of the service (service->state()) is used as the most significant |
| 415 | // criteria for comparsion, otherwise the service state is ignored. Use |
| 416 | // |tech_order| to rank services if more decisive criteria do not yield a |
| 417 | // difference. |reason| is populated with the exact criteria used for the |
| 418 | // ultimate comparison. |
Rebecca Silberstein | 6d4836b | 2014-07-16 14:28:28 -0700 | [diff] [blame] | 419 | static bool Compare(Manager *manager, |
| 420 | ServiceRefPtr a, |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 421 | ServiceRefPtr b, |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 422 | bool compare_connectivity_state, |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 423 | const std::vector<Technology::Identifier> &tech_order, |
| 424 | const char **reason); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 425 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 426 | // These are defined in service.cc so that we don't have to include profile.h |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 427 | // TODO(cmasone): right now, these are here only so that we can get the |
| 428 | // profile name as a property. Can we store just the name, and then handle |
| 429 | // setting the profile for this service via |manager_|? |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 430 | const ProfileRefPtr &profile() const; |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 431 | |
| 432 | // Sets the profile property of this service. Broadcasts the new value if it's |
Ben Chan | cc225ef | 2014-09-30 13:26:51 -0700 | [diff] [blame] | 433 | // not nullptr. If the new value is nullptr, the service will either be set to |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 434 | // another profile afterwards or it will not be visible and not monitored |
| 435 | // anymore. |
| 436 | void SetProfile(const ProfileRefPtr &p); |
| 437 | |
| 438 | // This is called from tests and shouldn't be called otherwise. Use SetProfile |
| 439 | // instead. |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 440 | void set_profile(const ProfileRefPtr &p); |
| 441 | |
Paul Stewart | 4357f4e | 2012-04-26 17:39:26 -0700 | [diff] [blame] | 442 | // Notification that occurs when a service now has profile data saved |
| 443 | // on its behalf. Some service types like WiFi can choose to register |
| 444 | // themselves at this point. |
| 445 | virtual void OnProfileConfigured() {} |
| 446 | |
Paul Stewart | ff14b02 | 2012-04-24 20:06:23 -0700 | [diff] [blame] | 447 | // Notification that occurs when a single property has been changed via |
| 448 | // the RPC adaptor. |
Paul Stewart | 8142613 | 2012-05-16 10:05:10 -0700 | [diff] [blame] | 449 | virtual void OnPropertyChanged(const std::string &property); |
Paul Stewart | ff14b02 | 2012-04-24 20:06:23 -0700 | [diff] [blame] | 450 | |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 451 | // Notification that occurs when an EAP credential property has been |
| 452 | // changed. Some service subclasses can choose to respond to this |
| 453 | // event. |
Rebecca Silberstein | 5777690 | 2014-09-15 21:43:02 -0700 | [diff] [blame] | 454 | virtual void OnEapCredentialsChanged(UpdateCredentialsReason reason) {} |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 455 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 456 | // Called by the manager once after a resume. |
| 457 | virtual void OnAfterResume(); |
| 458 | |
Prathmesh Prabhu | 64ad238 | 2014-08-26 11:19:30 -0700 | [diff] [blame] | 459 | // Called by the manager once when entering dark resume. |
| 460 | virtual void OnDarkResume(); |
| 461 | |
Paul Stewart | 2eee613 | 2014-05-09 13:33:26 -0700 | [diff] [blame] | 462 | // Called by the manager to clear remembered state of being explicitly |
| 463 | // disconnected. |
| 464 | virtual void ClearExplicitlyDisconnected(); |
| 465 | |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 466 | EapCredentials *mutable_eap() { return eap_.get(); } |
| 467 | |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 468 | PropertyStore *mutable_store() { return &store_; } |
| 469 | const PropertyStore &store() const { return store_; } |
Paul Stewart | def189e | 2012-08-02 20:12:09 -0700 | [diff] [blame] | 470 | StaticIPParameters *mutable_static_ip_parameters() { |
| 471 | return &static_ip_parameters_; |
| 472 | } |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 473 | const StaticIPParameters &static_ip_parameters() const { |
| 474 | return static_ip_parameters_; |
| 475 | } |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 476 | |
Paul Stewart | c3dbff1 | 2013-07-17 10:32:48 -0700 | [diff] [blame] | 477 | // Retrieves |key| from |id| in |storage| to |value|. If this key does |
| 478 | // not exist, assign |default_value| to |value|. |
| 479 | static void LoadString(StoreInterface *storage, |
| 480 | const std::string &id, |
| 481 | const std::string &key, |
| 482 | const std::string &default_value, |
| 483 | std::string *value); |
| 484 | |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 485 | // Assigns |value| to |key| in |storage| if |value| is non-empty and |save| is |
| 486 | // true. Otherwise, removes |key| from |storage|. If |crypted| is true, the |
| 487 | // value is encrypted. |
| 488 | static void SaveString(StoreInterface *storage, |
| 489 | const std::string &id, |
| 490 | const std::string &key, |
| 491 | const std::string &value, |
| 492 | bool crypted, |
| 493 | bool save); |
| 494 | |
Paul Stewart | 967eaeb | 2013-04-25 19:53:07 -0700 | [diff] [blame] | 495 | // Called via RPC to get a dict containing profile-to-entry_name mappings |
| 496 | // of all the profile entires which contain configuration applicable to |
| 497 | // this service. |
| 498 | std::map<std::string, std::string> GetLoadableProfileEntries(); |
| 499 | |
Peter Qiu | 9d58193 | 2014-04-14 16:37:37 -0700 | [diff] [blame] | 500 | void set_connection_id(int connection_id) { connection_id_ = connection_id; } |
| 501 | int connection_id() const { return connection_id_; } |
| 502 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 503 | protected: |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 504 | friend class base::RefCounted<Service>; |
| 505 | |
mukesh agrawal | 03c15ce | 2012-11-29 17:36:21 -0800 | [diff] [blame] | 506 | static const char kAutoConnBusy[]; |
| 507 | |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 508 | virtual ~Service(); |
| 509 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 510 | // Returns true if a character is allowed to be in a service storage id. |
| 511 | static bool LegalChar(char a) { return isalnum(a) || a == '_'; } |
| 512 | |
Darin Petkov | 3133241 | 2012-01-28 01:50:02 +0100 | [diff] [blame] | 513 | // Returns true if a character is disallowed to be in a service storage id. |
| 514 | static bool IllegalChar(char a) { return !LegalChar(a); } |
| 515 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 516 | virtual std::string CalculateState(Error *error); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 517 | std::string CalculateTechnology(Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 518 | |
Paul Stewart | cca85b1 | 2014-05-30 13:56:35 -0700 | [diff] [blame] | 519 | bool GetVisibleProperty(Error *error); |
| 520 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 521 | // Returns whether this service is in a state conducive to auto-connect. |
| 522 | // This should include any tests used for computing connectable(), |
| 523 | // as well as other critera such as whether the device associated with |
| 524 | // this service is busy with another connection. |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 525 | // |
| 526 | // If the service is not auto-connectable, |*reason| will be set to |
| 527 | // point to C-string explaining why the service is not auto-connectable. |
| 528 | virtual bool IsAutoConnectable(const char **reason) const; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 529 | |
mukesh agrawal | 292dc0f | 2012-01-26 18:02:46 -0800 | [diff] [blame] | 530 | // HelpRegisterDerived*: Expose a property over RPC, with the name |name|. |
| 531 | // |
| 532 | // Reads of the property will be handled by invoking |get|. |
| 533 | // Writes to the property will be handled by invoking |set|. |
| 534 | // Clearing the property will be handled by PropertyStore. |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 535 | void HelpRegisterDerivedBool( |
| 536 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 537 | bool(Service::*get)(Error *error), |
Paul Stewart | 43d8dc0 | 2013-10-17 10:32:53 -0700 | [diff] [blame] | 538 | bool(Service::*set)(const bool &value, Error *error), |
| 539 | void(Service::*clear)(Error *error)); |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 540 | void HelpRegisterDerivedInt32( |
| 541 | const std::string &name, |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 542 | int32_t(Service::*get)(Error *error), |
| 543 | bool(Service::*set)(const int32_t &value, Error *error)); |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 544 | void HelpRegisterDerivedString( |
| 545 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 546 | std::string(Service::*get)(Error *error), |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 547 | bool(Service::*set)(const std::string &value, Error *error)); |
| 548 | void HelpRegisterConstDerivedUint16( |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 549 | const std::string &name, |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 550 | uint16_t(Service::*get)(Error *error) const); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 551 | void HelpRegisterConstDerivedRpcIdentifier( |
Jason Glasgow | acdc11f | 2012-03-30 14:12:22 -0400 | [diff] [blame] | 552 | const std::string &name, |
Paul Stewart | 1cf7eb8 | 2013-12-03 19:34:36 -0800 | [diff] [blame] | 553 | std::string(Service::*get)(Error *) const); |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 554 | void HelpRegisterConstDerivedStrings( |
Paul Stewart | 1cf7eb8 | 2013-12-03 19:34:36 -0800 | [diff] [blame] | 555 | const std::string &name, Strings(Service::*get)(Error *error) const); |
| 556 | void HelpRegisterConstDerivedString( |
| 557 | const std::string &name, std::string(Service::*get)(Error *error) const); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 558 | |
Paul Stewart | 45170bc | 2014-06-02 15:49:34 -0700 | [diff] [blame] | 559 | // HelpRegisterObservedDerived*: Expose an property over RPC, with the |
| 560 | // name |name|, for which property changes are automatically generated. |
| 561 | // |
| 562 | void HelpRegisterObservedDerivedBool( |
| 563 | const std::string &name, |
| 564 | bool(Service::*get)(Error *error), |
| 565 | bool(Service::*set)(const bool &value, Error *error), |
| 566 | void(Service::*clear)(Error *error)); |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 567 | ServiceAdaptorInterface *adaptor() const { return adaptor_.get(); } |
| 568 | |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 569 | void UnloadEapCredentials(); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 570 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 571 | // Ignore |parameter| when performing a Configure() operation. |
| 572 | void IgnoreParameterForConfigure(const std::string ¶meter); |
| 573 | |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 574 | // Update the service's string-based "Error" RPC property based on the |
| 575 | // failure_ enum. |
| 576 | void UpdateErrorProperty(); |
| 577 | |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 578 | // RPC setter for the the "AutoConnect" property. Updates the |manager_|. |
| 579 | // (cf. SetAutoConnect, which does not update the manager.) |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 580 | virtual bool SetAutoConnectFull(const bool &connect, Error *error); |
Paul Stewart | cf199de | 2012-08-16 07:50:41 -0700 | [diff] [blame] | 581 | |
Paul Stewart | 43d8dc0 | 2013-10-17 10:32:53 -0700 | [diff] [blame] | 582 | // RPC clear method for the "AutoConnect" property. Sets the AutoConnect |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 583 | // property back to its default value, and clears the retain_auto_connect_ |
| 584 | // property to allow the AutoConnect property to be enabled automatically. |
Paul Stewart | 43d8dc0 | 2013-10-17 10:32:53 -0700 | [diff] [blame] | 585 | void ClearAutoConnect(Error *error); |
| 586 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 587 | // Property accessors reserved for subclasses |
| 588 | EventDispatcher *dispatcher() const { return dispatcher_; } |
| 589 | const std::string &GetEAPKeyManagement() const; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 590 | virtual void SetEAPKeyManagement(const std::string &key_management); |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 591 | Manager *manager() const { return manager_; } |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 592 | Metrics *metrics() const { return metrics_; } |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 593 | |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 594 | // Save the serivce's auto_connect value, without affecting its auto_connect |
| 595 | // property itself. (cf. EnableAndRetainAutoConnect) |
| 596 | void RetainAutoConnect(); |
| 597 | |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 598 | // Inform base class of the security properties for the service. |
| 599 | // |
| 600 | // NB: When adding a call to this function from a subclass, please check |
| 601 | // that the semantics of SecurityLevel() are appropriate for the subclass. |
| 602 | void SetSecurity(CryptoAlgorithm crypt, bool rotation, bool endpoint_auth); |
Darin Petkov | 1d0080a | 2012-04-30 17:10:36 +0200 | [diff] [blame] | 603 | |
Paul Stewart | fa11e28 | 2013-12-02 22:04:25 -0800 | [diff] [blame] | 604 | // Return whether this service is suspected or confirmed to be |
| 605 | // provided by a mobile device, which is likely to be using a |
| 606 | // metered backhaul for internet connectivity. |
| 607 | virtual std::string GetTethering(Error *error) const; |
| 608 | |
Paul Stewart | 45170bc | 2014-06-02 15:49:34 -0700 | [diff] [blame] | 609 | // Emit property change notifications for all observed properties. |
| 610 | void NotifyPropertyChanges(); |
Paul Stewart | 7cc9068 | 2014-05-30 17:01:56 -0700 | [diff] [blame] | 611 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 612 | private: |
Thieu Le | 43ce4d4 | 2013-10-04 16:08:55 -0700 | [diff] [blame] | 613 | friend class ActivePassiveOutOfCreditsDetectorTest; |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 614 | friend class EthernetEapServiceTest; |
Paul Stewart | cf199de | 2012-08-16 07:50:41 -0700 | [diff] [blame] | 615 | friend class EthernetServiceTest; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 616 | friend class MetricsTest; |
Paul Stewart | 9dd253e | 2013-04-22 08:32:59 -0700 | [diff] [blame] | 617 | friend class ManagerTest; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 618 | friend class ServiceAdaptorInterface; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 619 | friend class ServiceTest; |
Thieu Le | 43ce4d4 | 2013-10-04 16:08:55 -0700 | [diff] [blame] | 620 | friend class SubscriptionStateOutOfCreditsDetectorTest; |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 621 | friend class VPNProviderTest; |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 622 | friend class VPNServiceTest; |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 623 | friend class WiFiServiceTest; |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 624 | friend class WiMaxProviderTest; |
Darin Petkov | 6b9b2e1 | 2012-07-10 15:51:42 +0200 | [diff] [blame] | 625 | friend class WiMaxServiceTest; |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 626 | friend void TestCommonPropertyChanges(ServiceRefPtr, ServiceMockAdaptor *); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 627 | friend void TestCustomSetterNoopChange(ServiceRefPtr, MockManager *); |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 628 | friend void TestNamePropertyChange(ServiceRefPtr, ServiceMockAdaptor *); |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 629 | FRIEND_TEST(AllMockServiceTest, AutoConnectWithFailures); |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 630 | FRIEND_TEST(CellularCapabilityGSMTest, SetStorageIdentifier); |
Ben Chan | 19f8397 | 2012-10-03 23:25:56 -0700 | [diff] [blame] | 631 | FRIEND_TEST(CellularServiceTest, IsAutoConnectable); |
mukesh agrawal | cc0fded | 2012-05-09 13:40:58 -0700 | [diff] [blame] | 632 | FRIEND_TEST(DeviceTest, IPConfigUpdatedFailureWithStatic); |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 633 | FRIEND_TEST(ManagerTest, ConnectToBestServices); |
mukesh agrawal | 03c15ce | 2012-11-29 17:36:21 -0800 | [diff] [blame] | 634 | FRIEND_TEST(ServiceTest, AutoConnectLogging); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 635 | FRIEND_TEST(ServiceTest, CalculateState); |
| 636 | FRIEND_TEST(ServiceTest, CalculateTechnology); |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 637 | FRIEND_TEST(ServiceTest, Certification); |
Paul Stewart | 22ce765 | 2014-10-15 21:26:44 -0700 | [diff] [blame] | 638 | FRIEND_TEST(ServiceTest, Compare); |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 639 | FRIEND_TEST(ServiceTest, ConfigureEapStringProperty); |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 640 | FRIEND_TEST(ServiceTest, ConfigureIgnoredProperty); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 641 | FRIEND_TEST(ServiceTest, Constructor); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 642 | FRIEND_TEST(ServiceTest, CustomSetterNoopChange); |
Paul Stewart | 10241e3 | 2012-04-23 18:15:06 -0700 | [diff] [blame] | 643 | FRIEND_TEST(ServiceTest, GetIPConfigRpcIdentifier); |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 644 | FRIEND_TEST(ServiceTest, GetProperties); |
Paul Stewart | fa11e28 | 2013-12-02 22:04:25 -0800 | [diff] [blame] | 645 | FRIEND_TEST(ServiceTest, GetTethering); |
mukesh agrawal | 76d1388 | 2012-01-12 15:23:11 -0800 | [diff] [blame] | 646 | FRIEND_TEST(ServiceTest, IsAutoConnectable); |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 647 | FRIEND_TEST(ServiceTest, IsDependentOn); |
Paul Stewart | c3dbff1 | 2013-07-17 10:32:48 -0700 | [diff] [blame] | 648 | FRIEND_TEST(ServiceTest, Load); |
Peter Qiu | 9b83c89 | 2014-08-09 23:06:02 -0700 | [diff] [blame] | 649 | FRIEND_TEST(ServiceTest, PortalDetectionFailure); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 650 | FRIEND_TEST(ServiceTest, RecheckPortal); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 651 | FRIEND_TEST(ServiceTest, Save); |
| 652 | FRIEND_TEST(ServiceTest, SaveString); |
| 653 | FRIEND_TEST(ServiceTest, SaveStringCrypted); |
| 654 | FRIEND_TEST(ServiceTest, SaveStringDontSave); |
| 655 | FRIEND_TEST(ServiceTest, SaveStringEmpty); |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 656 | FRIEND_TEST(ServiceTest, SecurityLevel); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 657 | FRIEND_TEST(ServiceTest, SetCheckPortal); |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 658 | FRIEND_TEST(ServiceTest, SetConnectableFull); |
Arman Uguray | 2717a10 | 2013-01-29 23:36:06 -0800 | [diff] [blame] | 659 | FRIEND_TEST(ServiceTest, SetFriendlyName); |
| 660 | FRIEND_TEST(ServiceTest, SetProperty); |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 661 | FRIEND_TEST(ServiceTest, State); |
Thieu Le | af47141 | 2013-06-27 14:12:37 -0700 | [diff] [blame] | 662 | FRIEND_TEST(ServiceTest, StateResetAfterFailure); |
mukesh agrawal | e37ad32 | 2013-10-08 16:33:56 -0700 | [diff] [blame] | 663 | FRIEND_TEST(ServiceTest, UniqueAttributes); |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 664 | FRIEND_TEST(ServiceTest, Unload); |
Peter Qiu | dc4e099 | 2014-05-01 10:02:52 -0700 | [diff] [blame] | 665 | FRIEND_TEST(ServiceTest, UserInitiatedConnectionResult); |
Rebecca Silberstein | e99f664 | 2014-07-09 14:04:31 -0700 | [diff] [blame] | 666 | FRIEND_TEST(WiFiServiceTest, SetPassphraseResetHasEverConnected); |
Paul Stewart | bca08f8 | 2013-07-09 16:32:37 -0700 | [diff] [blame] | 667 | FRIEND_TEST(WiFiServiceTest, SuspectedCredentialFailure); |
Rebecca Silberstein | b6df8b1 | 2014-07-10 16:07:08 -0700 | [diff] [blame] | 668 | FRIEND_TEST(WiFiServiceTest, SetPassphraseRemovesCachedCredentials); |
Rebecca Silberstein | 5777690 | 2014-09-15 21:43:02 -0700 | [diff] [blame] | 669 | FRIEND_TEST(WiFiServiceTest, LoadPassphraseClearCredentials); |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 670 | FRIEND_TEST(WiFiTimerTest, ReconnectTimer); |
Paul Stewart | 11c224b | 2013-10-22 19:04:40 -0700 | [diff] [blame] | 671 | FRIEND_TEST(WiFiMainTest, EAPEvent); // For eap_. |
Rebecca Silberstein | b6df8b1 | 2014-07-10 16:07:08 -0700 | [diff] [blame] | 672 | FRIEND_TEST(WiMaxServiceTest, ChangeCredResetHasEverConnected); |
| 673 | FRIEND_TEST(EthernetEapServiceTest, OnEapCredentialsChanged); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 674 | |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 675 | static const char kAutoConnConnected[]; |
| 676 | static const char kAutoConnConnecting[]; |
| 677 | static const char kAutoConnExplicitDisconnect[]; |
| 678 | static const char kAutoConnNotConnectable[]; |
Darin Petkov | 4cbff5b | 2013-01-29 16:29:05 +0100 | [diff] [blame] | 679 | static const char kAutoConnOffline[]; |
Ben Chan | 8e6b8ef | 2014-07-14 21:50:18 -0700 | [diff] [blame] | 680 | static const char kAutoConnTechnologyNotConnectable[]; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 681 | static const char kAutoConnThrottled[]; |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 682 | |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 683 | static const size_t kEAPMaxCertificationElements; |
| 684 | |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 685 | static const char kServiceSortAutoConnect[]; |
| 686 | static const char kServiceSortConnectable[]; |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 687 | static const char kServiceSortHasEverConnected[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 688 | static const char kServiceSortIsConnected[]; |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 689 | static const char kServiceSortDependency[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 690 | static const char kServiceSortIsConnecting[]; |
| 691 | static const char kServiceSortIsFailed[]; |
Paul Stewart | a121c44 | 2012-06-09 14:12:58 -0700 | [diff] [blame] | 692 | static const char kServiceSortIsPortalled[]; |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 693 | static const char kServiceSortPriority[]; |
Rebecca Silberstein | 6d4836b | 2014-07-16 14:28:28 -0700 | [diff] [blame] | 694 | static const char kServiceSortSecurity[]; |
| 695 | static const char kServiceSortProfileOrder[]; |
| 696 | static const char kServiceSortEtc[]; |
mukesh agrawal | e37ad32 | 2013-10-08 16:33:56 -0700 | [diff] [blame] | 697 | static const char kServiceSortSerialNumber[]; |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 698 | static const char kServiceSortTechnology[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 699 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 700 | static const uint64_t kMaxAutoConnectCooldownTimeMilliseconds; |
| 701 | static const uint64_t kMinAutoConnectCooldownTimeMilliseconds; |
| 702 | static const uint64_t kAutoConnectCooldownBackoffFactor; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 703 | |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 704 | static const int kDisconnectsMonitorSeconds; |
| 705 | static const int kMisconnectsMonitorSeconds; |
| 706 | static const int kReportDisconnectsThreshold; |
| 707 | static const int kReportMisconnectsThreshold; |
| 708 | static const int kMaxDisconnectEventHistory; |
| 709 | |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 710 | bool GetAutoConnect(Error *error); |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 711 | |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 712 | std::string GetCheckPortal(Error *error); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 713 | bool SetCheckPortal(const std::string &check_portal, Error *error); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 714 | |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 715 | std::string GetGuid(Error *error); |
| 716 | |
Paul Stewart | 1cf7eb8 | 2013-12-03 19:34:36 -0800 | [diff] [blame] | 717 | virtual std::string GetDeviceRpcId(Error *error) const = 0; |
Chris Masone | 95207da | 2011-06-29 16:50:49 -0700 | [diff] [blame] | 718 | |
Paul Stewart | 1cf7eb8 | 2013-12-03 19:34:36 -0800 | [diff] [blame] | 719 | std::string GetIPConfigRpcIdentifier(Error *error) const; |
Paul Stewart | 10241e3 | 2012-04-23 18:15:06 -0700 | [diff] [blame] | 720 | |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 721 | std::string GetNameProperty(Error *error); |
Darin Petkov | 9c6e981 | 2013-03-26 13:49:07 +0100 | [diff] [blame] | 722 | // The base implementation asserts that |name| matches the current Name |
| 723 | // property value. |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 724 | virtual bool SetNameProperty(const std::string &name, Error *error); |
mukesh agrawal | cbfb34e | 2013-04-17 19:33:25 -0700 | [diff] [blame] | 725 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 726 | int32_t GetPriority(Error *error); |
Paul Stewart | 0c43833 | 2012-04-11 07:55:27 -0700 | [diff] [blame] | 727 | |
Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 728 | std::string GetProfileRpcId(Error *error); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 729 | bool SetProfileRpcId(const std::string &profile, Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 730 | |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 731 | // Returns TCP port of service's HTTP proxy in host order. |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 732 | uint16_t GetHTTPProxyPort(Error *error) const; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 733 | |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 734 | std::string GetProxyConfig(Error *error); |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 735 | bool SetProxyConfig(const std::string &proxy_config, Error *error); |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 736 | |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 737 | static Strings ExtractWallClockToStrings( |
| 738 | const std::deque<Timestamp> ×tamps); |
Paul Stewart | 1cf7eb8 | 2013-12-03 19:34:36 -0800 | [diff] [blame] | 739 | Strings GetDisconnectsProperty(Error *error) const; |
| 740 | Strings GetMisconnectsProperty(Error *error) const; |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 741 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 742 | void ReEnableAutoConnectTask(); |
| 743 | // Disables autoconnect and posts a task to re-enable it after a cooldown. |
| 744 | // Note that autoconnect could be disabled for other reasons as well. |
| 745 | void ThrottleFutureAutoConnects(); |
| 746 | |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 747 | // Saves settings to profile, if we have one. Unlike |
| 748 | // SaveServiceToProfile, SaveToProfile never assigns this service |
| 749 | // into a profile. |
| 750 | void SaveToProfile(); |
| 751 | |
Paul Stewart | 483e472 | 2012-12-18 10:23:17 -0800 | [diff] [blame] | 752 | // Start at the head of |events| and remove all entries that occurred |
| 753 | // more than |seconds_ago| prior to |now|. Also, the size of |events| |
| 754 | // is unconditionally trimmed below kMaxDisconnectEventHistory. |
| 755 | static void ExpireEventsBefore( |
| 756 | int seconds_ago, const Timestamp &now, std::deque<Timestamp> *events); |
| 757 | |
| 758 | // Qualify the conditions under which the most recent disconnect occurred. |
| 759 | // Make note ot the fact that there was a problem connecting / staying |
| 760 | // connected if the disconnection did not occur as a clear result of user |
| 761 | // action. |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 762 | void NoteDisconnectEvent(); |
| 763 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 764 | // Utility function that returns true if a is different from b. When they |
| 765 | // are, "decision" is populated with the boolean value of "a > b". |
| 766 | static bool DecideBetween(int a, int b, bool *decision); |
| 767 | |
Peter Qiu | dc4e099 | 2014-05-01 10:02:52 -0700 | [diff] [blame] | 768 | // Report the result of user-initiated connection attempt to UMA stats. |
| 769 | // Currently only report stats for wifi service. |
| 770 | void ReportUserInitiatedConnectionResult(ConnectState state); |
| 771 | |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 772 | // Linearize security parameters (crypto algorithm, key rotation, endpoint |
| 773 | // authentication) for comparison. |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 774 | uint16_t SecurityLevel(); |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 775 | |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 776 | // WeakPtrFactory comes first, so that other fields can use it. |
| 777 | base::WeakPtrFactory<Service> weak_ptr_factory_; |
| 778 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 779 | ConnectState state_; |
Darin Petkov | c8d91e5 | 2013-01-21 11:43:47 +0100 | [diff] [blame] | 780 | ConnectState previous_state_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 781 | ConnectFailure failure_; |
| 782 | bool auto_connect_; |
Paul Stewart | 2da34c0 | 2013-10-17 15:28:56 -0700 | [diff] [blame] | 783 | |
| 784 | // Denotes whether the value of auto_connect_ property value should be |
| 785 | // retained, i.e. only be allowed to change via explicit property changes |
| 786 | // from the UI. |
| 787 | bool retain_auto_connect_; |
| 788 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 789 | std::string check_portal_; |
| 790 | bool connectable_; |
| 791 | std::string error_; |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 792 | std::string error_details_; |
Paul Stewart | d7c09a5 | 2014-02-19 12:50:29 -0800 | [diff] [blame] | 793 | std::string previous_error_; |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 794 | int32_t previous_error_serial_number_; |
mukesh agrawal | adb6848 | 2012-01-17 16:31:51 -0800 | [diff] [blame] | 795 | bool explicitly_disconnected_; |
Peter Qiu | dc4e099 | 2014-05-01 10:02:52 -0700 | [diff] [blame] | 796 | bool is_in_user_connect_; |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 797 | int32_t priority_; |
| 798 | uint8_t crypto_algorithm_; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 799 | bool key_rotation_; |
| 800 | bool endpoint_auth_; |
Peter Qiu | 9b83c89 | 2014-08-09 23:06:02 -0700 | [diff] [blame] | 801 | std::string portal_detection_failure_phase_; |
| 802 | std::string portal_detection_failure_status_; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 803 | |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 804 | uint8_t strength_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 805 | std::string proxy_config_; |
Paul Stewart | 987e71e | 2011-12-05 09:45:06 -0800 | [diff] [blame] | 806 | std::string ui_data_; |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 807 | std::string guid_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 808 | bool save_credentials_; |
Ben Chan | cd47732 | 2014-10-17 14:19:30 -0700 | [diff] [blame] | 809 | std::unique_ptr<EapCredentials> eap_; |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 810 | Technology::Identifier technology_; |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 811 | // The time of the most recent failure. Value is 0 if the service is |
| 812 | // not currently failed. |
| 813 | time_t failed_time_; |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 814 | // Whether or not this service has ever reached kStateConnected. |
| 815 | bool has_ever_connected_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 816 | |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 817 | std::deque<Timestamp> disconnects_; // Connection drops. |
| 818 | std::deque<Timestamp> misconnects_; // Failures to connect. |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 819 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 820 | base::CancelableClosure reenable_auto_connect_task_; |
Ben Chan | 7fab897 | 2014-08-10 17:14:46 -0700 | [diff] [blame] | 821 | uint64_t auto_connect_cooldown_milliseconds_; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 822 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 823 | ProfileRefPtr profile_; |
| 824 | PropertyStore store_; |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 825 | std::set<std::string> parameters_ignored_for_configure_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 826 | |
| 827 | EventDispatcher *dispatcher_; |
mukesh agrawal | e37ad32 | 2013-10-08 16:33:56 -0700 | [diff] [blame] | 828 | unsigned int serial_number_; |
mukesh agrawal | d835b20 | 2011-10-07 15:26:47 -0700 | [diff] [blame] | 829 | std::string unique_name_; // MUST be unique amongst service instances |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 830 | |
| 831 | // Service's friendly name is presented through the UI. By default it's the |
| 832 | // same as |unique_name_| but normally Service subclasses override |
| 833 | // it. WARNING: Don't log the friendly name at the default logging level due |
| 834 | // to PII concerns. |
| 835 | std::string friendly_name_; |
| 836 | |
Paul Stewart | c43cbbe | 2013-04-11 06:29:30 -0700 | [diff] [blame] | 837 | // List of subject names reported by remote entity during TLS setup. |
| 838 | std::vector<std::string> remote_certification_; |
| 839 | |
Ben Chan | cd47732 | 2014-10-17 14:19:30 -0700 | [diff] [blame] | 840 | std::unique_ptr<ServiceAdaptorInterface> adaptor_; |
| 841 | std::unique_ptr<ServicePropertyChangeNotifier> property_change_notifier_; |
| 842 | std::unique_ptr<HTTPProxy> http_proxy_; |
Paul Stewart | c1dec4d | 2011-12-08 15:25:28 -0800 | [diff] [blame] | 843 | ConnectionRefPtr connection_; |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 844 | StaticIPParameters static_ip_parameters_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 845 | Metrics *metrics_; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 846 | Manager *manager_; |
Ben Chan | cd47732 | 2014-10-17 14:19:30 -0700 | [diff] [blame] | 847 | std::unique_ptr<Sockets> sockets_; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 848 | Time *time_; |
| 849 | DiagnosticsReporter *diagnostics_reporter_; |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 850 | |
mukesh agrawal | e37ad32 | 2013-10-08 16:33:56 -0700 | [diff] [blame] | 851 | // The |serial_number_| for the next Service. |
| 852 | static unsigned int next_serial_number_; |
| 853 | |
Peter Qiu | 9d58193 | 2014-04-14 16:37:37 -0700 | [diff] [blame] | 854 | // Network identifier indicating the network (gateway) the service is |
| 855 | // connected to. |
| 856 | int connection_id_; |
Peter Qiu | a89154b | 2014-05-23 15:45:42 -0700 | [diff] [blame] | 857 | // When set to true, this service will automatically fallback to Google's DNS |
| 858 | // servers if the portal detection failed due to DNS failure and Google's DNS |
| 859 | // servers are working. |
| 860 | bool is_dns_auto_fallback_allowed_; |
Peter Qiu | d49760e | 2014-09-19 16:13:42 -0700 | [diff] [blame] | 861 | // When set to true, will not start link monitor when the connection to this |
| 862 | // service is established. |
| 863 | bool link_monitor_disabled_; |
Paul Stewart | 3fee7e3 | 2014-10-15 21:39:29 -0700 | [diff] [blame^] | 864 | // When set to true, the credentials for this service will be considered |
| 865 | // valid, and will not require an initial connection to rank it highly for |
| 866 | // auto-connect. |
| 867 | bool managed_credentials_; |
Peter Qiu | 9d58193 | 2014-04-14 16:37:37 -0700 | [diff] [blame] | 868 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 869 | DISALLOW_COPY_AND_ASSIGN(Service); |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 870 | }; |
| 871 | |
| 872 | } // namespace shill |
| 873 | |
Ben Chan | 19f8397 | 2012-10-03 23:25:56 -0700 | [diff] [blame] | 874 | #endif // SHILL_SERVICE_H_ |