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> |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 12 | #include <set> |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 13 | #include <string> |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 14 | #include <vector> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 15 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 16 | #include <base/cancelable_callback.h> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 17 | #include <base/memory/ref_counted.h> |
Paul Stewart | ba41b99 | 2011-05-26 07:02:46 -0700 | [diff] [blame] | 18 | #include <base/memory/scoped_ptr.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 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 22 | #include "shill/adaptor_interfaces.h" |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 23 | #include "shill/accessor_interface.h" |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 24 | #include "shill/callbacks.h" |
Paul Stewart | 0654ece | 2013-03-26 15:21:26 -0700 | [diff] [blame] | 25 | #include "shill/eap_credentials.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" |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 28 | #include "shill/shill_time.h" |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 29 | #include "shill/static_ip_parameters.h" |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 30 | #include "shill/technology.h" |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 31 | |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 32 | namespace chromeos_metrics { |
| 33 | class Timer; |
| 34 | } |
| 35 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 36 | namespace shill { |
| 37 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 38 | class ControlInterface; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 39 | class DiagnosticsReporter; |
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; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 47 | class ServiceAdaptorInterface; |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 48 | class Sockets; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 49 | class StoreInterface; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 50 | |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 51 | // A Service is a uniquely named entity, which the system can |
| 52 | // connect in order to begin sending and receiving network traffic. |
| 53 | // All Services are bound to an Entry, which represents the persistable |
| 54 | // state of the Service. If the Entry is populated at the time of Service |
| 55 | // creation, that information is used to prime the Service. If not, the Entry |
| 56 | // becomes populated over time. |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 57 | class Service : public base::RefCounted<Service> { |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 58 | public: |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 59 | static const char kCheckPortalAuto[]; |
| 60 | static const char kCheckPortalFalse[]; |
| 61 | static const char kCheckPortalTrue[]; |
| 62 | |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 63 | static const char kErrorDetailsNone[]; |
| 64 | |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 65 | // TODO(pstew): Storage constants shouldn't need to be public |
| 66 | // crosbug.com/25813 |
| 67 | static const char kStorageAutoConnect[]; |
| 68 | static const char kStorageCheckPortal[]; |
| 69 | static const char kStorageEapAnonymousIdentity[]; |
| 70 | static const char kStorageEapCACert[]; |
| 71 | static const char kStorageEapCACertID[]; |
Paul Stewart | ecf4cd1 | 2012-04-17 11:08:39 -0700 | [diff] [blame] | 72 | static const char kStorageEapCACertNSS[]; |
Paul Stewart | 5baebb7 | 2013-03-14 11:43:29 -0700 | [diff] [blame] | 73 | static const char kStorageEapCACertPEM[]; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 74 | static const char kStorageEapCertID[]; |
| 75 | static const char kStorageEapClientCert[]; |
| 76 | static const char kStorageEapEap[]; |
| 77 | static const char kStorageEapIdentity[]; |
| 78 | static const char kStorageEapInnerEap[]; |
| 79 | static const char kStorageEapKeyID[]; |
| 80 | static const char kStorageEapKeyManagement[]; |
| 81 | static const char kStorageEapPIN[]; |
| 82 | static const char kStorageEapPassword[]; |
| 83 | static const char kStorageEapPrivateKey[]; |
| 84 | static const char kStorageEapPrivateKeyPassword[]; |
| 85 | static const char kStorageEapUseSystemCAs[]; |
| 86 | static const char kStorageError[]; |
| 87 | static const char kStorageFavorite[]; |
| 88 | static const char kStorageGUID[]; |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 89 | static const char kStorageHasEverConnected[]; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 90 | static const char kStorageName[]; |
| 91 | static const char kStoragePriority[]; |
| 92 | static const char kStorageProxyConfig[]; |
| 93 | static const char kStorageSaveCredentials[]; |
| 94 | static const char kStorageType[]; |
| 95 | static const char kStorageUIData[]; |
| 96 | |
mukesh agrawal | 8f3f775 | 2012-02-17 19:42:09 -0800 | [diff] [blame] | 97 | static const uint8 kStrengthMax; |
| 98 | static const uint8 kStrengthMin; |
| 99 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 100 | enum ConnectFailure { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 101 | kFailureUnknown, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 102 | kFailureAAA, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 103 | kFailureActivation, |
| 104 | kFailureBadPassphrase, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 105 | kFailureBadWEPKey, |
| 106 | kFailureConnect, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 107 | kFailureDHCP, |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 108 | kFailureDNSLookup, |
Paul Stewart | db0f917 | 2012-11-30 16:48:09 -0800 | [diff] [blame] | 109 | kFailureEAPAuthentication, |
| 110 | kFailureEAPLocalTLS, |
| 111 | kFailureEAPRemoteTLS, |
Darin Petkov | 1c049c7 | 2013-03-21 13:15:45 +0100 | [diff] [blame] | 112 | kFailureHTTPGet, |
| 113 | kFailureIPSecCertAuth, |
| 114 | kFailureIPSecPSKAuth, |
| 115 | kFailureInternal, |
| 116 | kFailureNeedEVDO, |
| 117 | kFailureNeedHomeNetwork, |
| 118 | kFailureOTASP, |
| 119 | kFailureOutOfRange, |
| 120 | kFailurePPPAuth, |
| 121 | kFailurePinMissing, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 122 | kFailureMax |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 123 | }; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 124 | enum ConnectState { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 125 | kStateUnknown, |
| 126 | kStateIdle, |
| 127 | kStateAssociating, |
| 128 | kStateConfiguring, |
| 129 | kStateConnected, |
| 130 | kStateDisconnected, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 131 | kStatePortal, |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 132 | kStateFailure, |
| 133 | kStateOnline |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 134 | }; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 135 | enum CryptoAlgorithm { |
| 136 | kCryptoNone, |
| 137 | kCryptoRc4, |
| 138 | kCryptoAes |
| 139 | }; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 140 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 141 | static const int kPriorityNone; |
| 142 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 143 | // A constructor for the Service object |
| 144 | Service(ControlInterface *control_interface, |
| 145 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 146 | Metrics *metrics, |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 147 | Manager *manager, |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 148 | Technology::Identifier technology); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 149 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 150 | // AutoConnect MAY choose to ignore the connection request in some |
| 151 | // cases. For example, if the corresponding Device only supports one |
| 152 | // concurrent connection, and another Service is already connected |
| 153 | // or connecting. |
| 154 | // |
| 155 | // AutoConnect MAY issue RPCs immediately. So AutoConnect MUST NOT |
| 156 | // be called from a D-Bus signal handler context. |
| 157 | virtual void AutoConnect(); |
mukesh agrawal | dc7b844 | 2012-09-27 13:48:14 -0700 | [diff] [blame^] | 158 | // Queue up a connection attempt. Derived classes SHOULD call the |
| 159 | // base class implementation before beginning a connect. The base |
| 160 | // class will log the connection attempt, and update base-class |
| 161 | // state. |
| 162 | virtual void Connect(Error *error, const char *reason); |
Christopher Wiley | abd3b50 | 2012-09-26 13:08:52 -0700 | [diff] [blame] | 163 | // Disconnect this service. Override this method to add your service specific |
| 164 | // disconnect logic, but call the super class's Disconnect() first. |
mukesh agrawal | adb6848 | 2012-01-17 16:31:51 -0800 | [diff] [blame] | 165 | virtual void Disconnect(Error *error); |
Christopher Wiley | abd3b50 | 2012-09-26 13:08:52 -0700 | [diff] [blame] | 166 | // Disconnects this service via Disconnect(). Marks the service as having |
| 167 | // failed with |failure|. Do not override this method. |
| 168 | virtual void DisconnectWithFailure(ConnectFailure failure, Error *error); |
| 169 | // Disconnects this service via Disconnect(). The service will not be eligible |
| 170 | // for auto-connect until a subsequent call to Connect, or Load. Do not |
| 171 | // override this method. |
| 172 | virtual void UserInitiatedDisconnect(Error *error); |
Chris Masone | a82b711 | 2011-05-25 15:16:29 -0700 | [diff] [blame] | 173 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 174 | // The default implementation returns the error kInvalidArguments. |
| 175 | virtual void ActivateCellularModem(const std::string &carrier, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 176 | Error *error, |
| 177 | const ResultCallback &callback); |
Ben Chan | 5d92454 | 2013-02-14 17:49:08 -0800 | [diff] [blame] | 178 | // The default implementation returns the error kNotSupported. |
| 179 | virtual void CompleteCellularActivation(Error *error); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 180 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 181 | virtual bool IsActive(Error *error); |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 182 | |
Paul Stewart | 7fb0938 | 2012-07-18 17:32:27 -0700 | [diff] [blame] | 183 | // Returns whether services of this type should be auto-connect by default. |
| 184 | virtual bool IsAutoConnectByDefault() const { return false; } |
| 185 | |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 186 | virtual ConnectState state() const { return state_; } |
| 187 | // Updates the state of the Service and alerts the manager. Also |
| 188 | // clears |failure_| if the new state isn't a failure. |
| 189 | virtual void SetState(ConnectState state); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 190 | std::string GetStateString() const; |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 191 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 192 | // State utility functions |
Darin Petkov | c8d91e5 | 2013-01-21 11:43:47 +0100 | [diff] [blame] | 193 | static bool IsConnectedState(ConnectState state); |
| 194 | static bool IsConnectingState(ConnectState state); |
| 195 | |
| 196 | virtual bool IsConnected() const; |
| 197 | virtual bool IsConnecting() const; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 198 | virtual bool IsFailed() const { |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 199 | // We sometimes lie about the failure state, to keep Chrome happy |
| 200 | // (see comment in WiFi::HandleDisconnect). Hence, we check both |
| 201 | // state and |failed_time_|. |
| 202 | return state() == kStateFailure || failed_time_ > 0; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 203 | } |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 204 | |
| 205 | // Returns true if the connection for |this| depends on service |b|. |
| 206 | virtual bool IsDependentOn(const ServiceRefPtr &b) const; |
| 207 | |
Paul Stewart | a121c44 | 2012-06-09 14:12:58 -0700 | [diff] [blame] | 208 | virtual bool IsPortalled() const { |
| 209 | return state() == kStatePortal; |
| 210 | } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 211 | |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 212 | virtual ConnectFailure failure() const { return failure_; } |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 213 | // Records the failure mode and time. Sets the Service state to "Failure". |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 214 | virtual void SetFailure(ConnectFailure failure); |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 215 | // Records the failure mode and time. Sets the Service state to "Idle". |
| 216 | // Avoids showing a failure mole in the UI. |
| 217 | virtual void SetFailureSilent(ConnectFailure failure); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 218 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 219 | // Returns a string that is guaranteed to uniquely identify this Service |
| 220 | // instance. |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 221 | const std::string &unique_name() const { return unique_name_; } |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 222 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 223 | virtual std::string GetRpcIdentifier() const; |
Chris Masone | 3c3f6a1 | 2011-07-01 10:01:41 -0700 | [diff] [blame] | 224 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 225 | // Returns the unique persistent storage identifier for the service. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 226 | virtual std::string GetStorageIdentifier() const = 0; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 227 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 228 | // Returns whether the service configuration can be loaded from |storage|. |
| 229 | virtual bool IsLoadableFrom(StoreInterface *storage) const; |
| 230 | |
Paul Stewart | 8142613 | 2012-05-16 10:05:10 -0700 | [diff] [blame] | 231 | // Returns true if the service uses 802.1x for key management. |
| 232 | virtual bool Is8021x() const { return false; }; |
| 233 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 234 | // Loads the service from persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 235 | virtual bool Load(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 236 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 237 | // Indicate to service that it is no longer persisted to storage. It |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 238 | // should purge any stored profile state (e.g., credentials). Returns |
| 239 | // true to indicate that this service should also be unregistered from |
| 240 | // the manager, false otherwise. |
| 241 | virtual bool Unload(); |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 242 | |
Albert Chaulk | 0e1cdea | 2013-02-27 15:32:55 -0800 | [diff] [blame] | 243 | // Attempt to remove the service. On failure, no changes in state will occur. |
| 244 | virtual void Remove(Error *error); |
| 245 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 246 | // Saves the service to persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 247 | virtual bool Save(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 248 | |
Thieu Le | d4e9e55 | 2012-02-16 16:26:07 -0800 | [diff] [blame] | 249 | // Saves the service to the current profile. |
Gary Morain | d93615e | 2012-04-27 11:50:03 -0700 | [diff] [blame] | 250 | virtual void SaveToCurrentProfile(); |
Thieu Le | d4e9e55 | 2012-02-16 16:26:07 -0800 | [diff] [blame] | 251 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 252 | // Applies all the properties in |args| to this service object's mutable |
| 253 | // store, except for those in parameters_ignored_for_configure_. |
| 254 | // Returns an error in |error| if one or more parameter set attempts |
| 255 | // fails, but will only return the first error. |
| 256 | virtual void Configure(const KeyValueStore &args, Error *error); |
| 257 | |
Paul Stewart | 7a20aa4 | 2013-01-17 12:21:41 -0800 | [diff] [blame] | 258 | // Iterate over all the properties in |args| and test for an identical |
| 259 | // value in this service object's store. Returns false if one or more |
| 260 | // keys in |args| do not exist or have different values, true otherwise. |
| 261 | virtual bool DoPropertiesMatch(const KeyValueStore &args) const; |
| 262 | |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 263 | // Returns whether portal detection is explicitly disabled on this service |
| 264 | // via a property set on it. |
| 265 | virtual bool IsPortalDetectionDisabled() const; |
| 266 | |
| 267 | // Returns whether portal detection is set to follow the default setting |
| 268 | // of this service's technology via a property set on it. |
| 269 | virtual bool IsPortalDetectionAuto() const; |
| 270 | |
Paul Stewart | 10ccbb3 | 2012-04-26 15:59:30 -0700 | [diff] [blame] | 271 | // Returns true if the service is persisted to a non-ephemeral profile. |
| 272 | virtual bool IsRemembered() const; |
| 273 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 274 | // Returns true if the service RPC identifier should be part of the |
| 275 | // manager's advertised services list, false otherwise. |
| 276 | virtual bool IsVisible() const { return true; } |
| 277 | |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 278 | // Returns true if there is a proxy configuration set on this service. |
| 279 | virtual bool HasProxyConfig() const { return !proxy_config_.empty(); } |
| 280 | |
Paul Stewart | a47c3c6 | 2012-12-18 12:14:29 -0800 | [diff] [blame] | 281 | // Returns whether this service has had recent connection issues. |
| 282 | virtual bool HasRecentConnectionIssues(); |
| 283 | |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 284 | virtual void MakeFavorite(); |
| 285 | |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 286 | // Set the connection for this service. If the connection is non-NULL, create |
| 287 | // an HTTP Proxy that will utilize this service's connection to serve |
| 288 | // requests. |
| 289 | virtual void SetConnection(const ConnectionRefPtr &connection); |
| 290 | virtual const ConnectionRefPtr &connection() const { return connection_; } |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 291 | |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 292 | // Examines the EAP credentials for the service and returns true if a |
| 293 | // connection attempt can be made. |
| 294 | bool Is8021xConnectable() const; |
| 295 | |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 296 | // Add an EAP certification id |name| at position |depth| in the stack. |
| 297 | // Returns true if entry was added, false otherwise. |
| 298 | virtual bool AddEAPCertification(const std::string &name, size_t depth); |
| 299 | // Clear all EAP certification elements. |
| 300 | void ClearEAPCertification(); |
| 301 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 302 | // The inherited class should register any custom metrics in this method. |
| 303 | virtual void InitializeCustomMetrics() const {} |
| 304 | |
| 305 | // The inherited class that needs to send metrics after the service has |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 306 | // transitioned to the ready state should override this method. |
| 307 | // |time_resume_to_ready_milliseconds| holds the elapsed time from when |
| 308 | // the system was resumed until when the service transitioned to the |
| 309 | // connected state. This value is non-zero for the first service transition |
| 310 | // to the connected state after a resume. |
| 311 | virtual void SendPostReadyStateMetrics( |
| 312 | int64 /*time_resume_to_ready_milliseconds*/) const {} |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 313 | |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 314 | bool auto_connect() const { return auto_connect_; } |
| 315 | void set_auto_connect(bool connect) { auto_connect_ = connect; } |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 316 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 317 | bool connectable() const { return connectable_; } |
Darin Petkov | b2ba39f | 2012-06-06 10:33:43 +0200 | [diff] [blame] | 318 | // TODO(petkov): Remove this method in favor of SetConnectable. |
mukesh agrawal | 29c13a1 | 2011-11-24 00:09:19 +0000 | [diff] [blame] | 319 | void set_connectable(bool connectable); |
Darin Petkov | b2ba39f | 2012-06-06 10:33:43 +0200 | [diff] [blame] | 320 | // Sets the connectable property of the service. Broadcasts the new value and |
| 321 | // alerts the manager if necessary. |
| 322 | void SetConnectable(bool connectable); |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 323 | |
Thieu Le | 67370f6 | 2012-02-14 23:01:42 +0000 | [diff] [blame] | 324 | virtual bool explicitly_disconnected() const { |
| 325 | return explicitly_disconnected_; |
| 326 | } |
| 327 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 328 | bool favorite() const { return favorite_; } |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 329 | // Setter is deliberately omitted; use MakeFavorite. |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 330 | |
Arman Uguray | 2717a10 | 2013-01-29 23:36:06 -0800 | [diff] [blame] | 331 | // Sets the flimflam::kNameProperty |
| 332 | void SetFriendlyName(const std::string &friendly_name); |
Darin Petkov | 7f06033 | 2012-03-14 11:46:47 +0100 | [diff] [blame] | 333 | void set_friendly_name(const std::string &n) { friendly_name_ = n; } |
Darin Petkov | 9c6e981 | 2013-03-26 13:49:07 +0100 | [diff] [blame] | 334 | const std::string &friendly_name() const { return friendly_name_; } |
mukesh agrawal | 1590839 | 2011-11-16 18:29:25 +0000 | [diff] [blame] | 335 | |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 336 | const std::string &guid() const { return guid_; } |
| 337 | void set_guid(const std::string &guid) { guid_ = guid; } |
| 338 | |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 339 | bool has_ever_connected() const { return has_ever_connected_; } |
| 340 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 341 | int32 priority() const { return priority_; } |
| 342 | void set_priority(int32 priority) { priority_ = priority; } |
| 343 | |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 344 | size_t crypto_algorithm() const { return crypto_algorithm_; } |
| 345 | bool key_rotation() const { return key_rotation_; } |
| 346 | bool endpoint_auth() const { return endpoint_auth_; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 347 | |
Darin Petkov | d78ee7e | 2012-01-12 11:21:10 +0100 | [diff] [blame] | 348 | void SetStrength(uint8 strength); |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 349 | |
| 350 | // uint8 streams out as a char. Coerce to a larger type, so that |
| 351 | // it prints as a number. |
| 352 | uint16 strength() const { return strength_; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 353 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 354 | virtual Technology::Identifier technology() const { return technology_; } |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 355 | std::string GetTechnologyString() const; |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 356 | |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 357 | const EapCredentials &eap() const { return eap_; } |
| 358 | virtual void set_eap(const EapCredentials &eap); |
| 359 | |
Darin Petkov | cb71529 | 2012-04-25 13:04:37 +0200 | [diff] [blame] | 360 | bool save_credentials() const { return save_credentials_; } |
| 361 | void set_save_credentials(bool save) { save_credentials_ = save; } |
| 362 | |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 363 | const std::string &error() const { return error_; } |
| 364 | void set_error(const std::string &error) { error_ = error; } |
| 365 | |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 366 | const std::string &error_details() const { return error_details_; } |
| 367 | void SetErrorDetails(const std::string &details); |
| 368 | |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 369 | static const char *ConnectFailureToString(const ConnectFailure &state); |
| 370 | static const char *ConnectStateToString(const ConnectState &state); |
| 371 | |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 372 | // Compare two services. Returns true if Service |a| should be displayed |
| 373 | // above |b|. If |compare_connectivity_state| is true, the connectivity |
| 374 | // state of the service (service->state()) is used as the most significant |
| 375 | // criteria for comparsion, otherwise the service state is ignored. Use |
| 376 | // |tech_order| to rank services if more decisive criteria do not yield a |
| 377 | // difference. |reason| is populated with the exact criteria used for the |
| 378 | // ultimate comparison. |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 379 | static bool Compare(ServiceRefPtr a, |
| 380 | ServiceRefPtr b, |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 381 | bool compare_connectivity_state, |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 382 | const std::vector<Technology::Identifier> &tech_order, |
| 383 | const char **reason); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 384 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 385 | // 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] | 386 | // TODO(cmasone): right now, these are here only so that we can get the |
| 387 | // profile name as a property. Can we store just the name, and then handle |
| 388 | // setting the profile for this service via |manager_|? |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 389 | const ProfileRefPtr &profile() const; |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 390 | |
| 391 | // Sets the profile property of this service. Broadcasts the new value if it's |
| 392 | // not NULL. If the new value is NULL, the service will either be set to |
| 393 | // another profile afterwards or it will not be visible and not monitored |
| 394 | // anymore. |
| 395 | void SetProfile(const ProfileRefPtr &p); |
| 396 | |
| 397 | // This is called from tests and shouldn't be called otherwise. Use SetProfile |
| 398 | // instead. |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 399 | void set_profile(const ProfileRefPtr &p); |
| 400 | |
Paul Stewart | 4357f4e | 2012-04-26 17:39:26 -0700 | [diff] [blame] | 401 | // Notification that occurs when a service now has profile data saved |
| 402 | // on its behalf. Some service types like WiFi can choose to register |
| 403 | // themselves at this point. |
| 404 | virtual void OnProfileConfigured() {} |
| 405 | |
Paul Stewart | ff14b02 | 2012-04-24 20:06:23 -0700 | [diff] [blame] | 406 | // Notification that occurs when a single property has been changed via |
| 407 | // the RPC adaptor. |
Paul Stewart | 8142613 | 2012-05-16 10:05:10 -0700 | [diff] [blame] | 408 | virtual void OnPropertyChanged(const std::string &property); |
Paul Stewart | ff14b02 | 2012-04-24 20:06:23 -0700 | [diff] [blame] | 409 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 410 | // Called by the manager once after a resume. |
| 411 | virtual void OnAfterResume(); |
| 412 | |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 413 | PropertyStore *mutable_store() { return &store_; } |
| 414 | const PropertyStore &store() const { return store_; } |
Paul Stewart | def189e | 2012-08-02 20:12:09 -0700 | [diff] [blame] | 415 | StaticIPParameters *mutable_static_ip_parameters() { |
| 416 | return &static_ip_parameters_; |
| 417 | } |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 418 | const StaticIPParameters &static_ip_parameters() const { |
| 419 | return static_ip_parameters_; |
| 420 | } |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 421 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 422 | protected: |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 423 | friend class base::RefCounted<Service>; |
| 424 | |
mukesh agrawal | 03c15ce | 2012-11-29 17:36:21 -0800 | [diff] [blame] | 425 | static const char kAutoConnBusy[]; |
| 426 | |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 427 | virtual ~Service(); |
| 428 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 429 | // Returns true if a character is allowed to be in a service storage id. |
| 430 | static bool LegalChar(char a) { return isalnum(a) || a == '_'; } |
| 431 | |
Darin Petkov | 3133241 | 2012-01-28 01:50:02 +0100 | [diff] [blame] | 432 | // Returns true if a character is disallowed to be in a service storage id. |
| 433 | static bool IllegalChar(char a) { return !LegalChar(a); } |
| 434 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 435 | virtual std::string CalculateState(Error *error); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 436 | std::string CalculateTechnology(Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 437 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 438 | // Returns whether this service is in a state conducive to auto-connect. |
| 439 | // This should include any tests used for computing connectable(), |
| 440 | // as well as other critera such as whether the device associated with |
| 441 | // this service is busy with another connection. |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 442 | // |
| 443 | // If the service is not auto-connectable, |*reason| will be set to |
| 444 | // point to C-string explaining why the service is not auto-connectable. |
| 445 | virtual bool IsAutoConnectable(const char **reason) const; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 446 | |
mukesh agrawal | 292dc0f | 2012-01-26 18:02:46 -0800 | [diff] [blame] | 447 | // HelpRegisterDerived*: Expose a property over RPC, with the name |name|. |
| 448 | // |
| 449 | // Reads of the property will be handled by invoking |get|. |
| 450 | // Writes to the property will be handled by invoking |set|. |
| 451 | // Clearing the property will be handled by PropertyStore. |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 452 | void HelpRegisterDerivedBool( |
| 453 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 454 | bool(Service::*get)(Error *error), |
| 455 | void(Service::*set)(const bool &value, Error *error)); |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 456 | void HelpRegisterDerivedString( |
| 457 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 458 | std::string(Service::*get)(Error *error), |
| 459 | void(Service::*set)(const std::string &value, Error *error)); |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 460 | void HelpRegisterDerivedUint16( |
| 461 | const std::string &name, |
| 462 | uint16(Service::*get)(Error *error), |
| 463 | void(Service::*set)(const uint16 &value, Error *error)); |
Jason Glasgow | acdc11f | 2012-03-30 14:12:22 -0400 | [diff] [blame] | 464 | void HelpRegisterDerivedRpcIdentifier( |
| 465 | const std::string &name, |
| 466 | std::string(Service::*get)(Error *), |
| 467 | void(Service::*set)(const RpcIdentifier&, Error *)); |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 468 | void HelpRegisterConstDerivedStrings( |
| 469 | const std::string &name, Strings(Service::*get)(Error *error)); |
mukesh agrawal | 292dc0f | 2012-01-26 18:02:46 -0800 | [diff] [blame] | 470 | // Expose a property over RPC, with the name |name|. |
| 471 | // |
| 472 | // Reads of the property will be handled by invoking |get|. |
| 473 | // Writes to the property will be handled by invoking |set|. |
| 474 | // |
| 475 | // Clearing the property will be handled by invoking |clear|, or |
| 476 | // calling |set| with |default_value| (whichever is non-NULL). It |
| 477 | // is an error to call this method with both |clear| and |
| 478 | // |default_value| non-NULL. |
| 479 | void HelpRegisterWriteOnlyDerivedString( |
| 480 | const std::string &name, |
| 481 | void(Service::*set)(const std::string &value, Error *error), |
| 482 | void(Service::*clear)(Error *error), |
| 483 | const std::string *default_value); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 484 | |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 485 | ServiceAdaptorInterface *adaptor() const { return adaptor_.get(); } |
| 486 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 487 | // Assigns |value| to |key| in |storage| if |value| is non-empty and |save| is |
| 488 | // true. Otherwise, removes |key| from |storage|. If |crypted| is true, the |
| 489 | // value is encrypted. |
| 490 | void SaveString(StoreInterface *storage, |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 491 | const std::string &id, |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 492 | const std::string &key, |
| 493 | const std::string &value, |
| 494 | bool crypted, |
| 495 | bool save); |
| 496 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 497 | void LoadEapCredentials(StoreInterface *storage, const std::string &id); |
| 498 | void SaveEapCredentials(StoreInterface *storage, const std::string &id); |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 499 | void UnloadEapCredentials(); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 500 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 501 | // Ignore |parameter| when performing a Configure() operation. |
| 502 | void IgnoreParameterForConfigure(const std::string ¶meter); |
| 503 | |
Paul Stewart | f2d6091 | 2012-07-15 08:37:30 -0700 | [diff] [blame] | 504 | // Update the service's string-based "Error" RPC property based on the |
| 505 | // failure_ enum. |
| 506 | void UpdateErrorProperty(); |
| 507 | |
Paul Stewart | cf199de | 2012-08-16 07:50:41 -0700 | [diff] [blame] | 508 | // RPC setter for the the "AutoConnect" property. |
| 509 | virtual void SetAutoConnect(const bool &connect, Error *error); |
| 510 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 511 | // Property accessors reserved for subclasses |
| 512 | EventDispatcher *dispatcher() const { return dispatcher_; } |
| 513 | const std::string &GetEAPKeyManagement() const; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 514 | virtual void SetEAPKeyManagement(const std::string &key_management); |
Paul Stewart | 9f32d19 | 2012-01-30 20:37:50 -0800 | [diff] [blame] | 515 | void SetEAPPassword(const std::string &password, Error *error); |
| 516 | void SetEAPPrivateKeyPassword(const std::string &password, Error *error); |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 517 | Manager *manager() const { return manager_; } |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 518 | Metrics *metrics() const { return metrics_; } |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 519 | |
Darin Petkov | 1d0080a | 2012-04-30 17:10:36 +0200 | [diff] [blame] | 520 | void set_favorite(bool favorite) { favorite_ = favorite; } |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 521 | // Inform base class of the security properties for the service. |
| 522 | // |
| 523 | // NB: When adding a call to this function from a subclass, please check |
| 524 | // that the semantics of SecurityLevel() are appropriate for the subclass. |
| 525 | void SetSecurity(CryptoAlgorithm crypt, bool rotation, bool endpoint_auth); |
Darin Petkov | 1d0080a | 2012-04-30 17:10:36 +0200 | [diff] [blame] | 526 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 527 | private: |
Paul Stewart | cf199de | 2012-08-16 07:50:41 -0700 | [diff] [blame] | 528 | friend class EthernetServiceTest; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 529 | friend class MetricsTest; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 530 | friend class ServiceAdaptorInterface; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 531 | friend class ServiceTest; |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 532 | friend class VPNProviderTest; |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 533 | friend class VPNServiceTest; |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 534 | friend class WiFiServiceTest; |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 535 | friend class WiMaxProviderTest; |
Darin Petkov | 6b9b2e1 | 2012-07-10 15:51:42 +0200 | [diff] [blame] | 536 | friend class WiMaxServiceTest; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 537 | FRIEND_TEST(AllMockServiceTest, AutoConnectWithFailures); |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 538 | FRIEND_TEST(CellularCapabilityGSMTest, SetStorageIdentifier); |
Liam McLoughlin | 0fec81c | 2013-02-28 10:31:47 -0500 | [diff] [blame] | 539 | FRIEND_TEST(CellularCapabilityUniversalMainTest, UpdateStorageIdentifier); |
Ben Chan | 19f8397 | 2012-10-03 23:25:56 -0700 | [diff] [blame] | 540 | FRIEND_TEST(CellularServiceTest, IsAutoConnectable); |
mukesh agrawal | cc0fded | 2012-05-09 13:40:58 -0700 | [diff] [blame] | 541 | FRIEND_TEST(DeviceTest, IPConfigUpdatedFailureWithStatic); |
Paul Stewart | 39db5ca | 2013-03-18 14:15:17 -0700 | [diff] [blame] | 542 | FRIEND_TEST(ManagerTest, ConnectToBestServices); |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 543 | // TODO(quiche): The SortServices test should probably move into |
| 544 | // service_unittest.cc. Then the following line should be removed. |
| 545 | // (crosbug.com/23370) |
| 546 | FRIEND_TEST(ManagerTest, SortServices); |
mukesh agrawal | 03c15ce | 2012-11-29 17:36:21 -0800 | [diff] [blame] | 547 | FRIEND_TEST(ServiceTest, AutoConnectLogging); |
Darin Petkov | 58f0b6d | 2012-06-12 12:52:30 +0200 | [diff] [blame] | 548 | FRIEND_TEST(ServiceTest, CalculateState); |
| 549 | FRIEND_TEST(ServiceTest, CalculateTechnology); |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 550 | FRIEND_TEST(ServiceTest, Certification); |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 551 | FRIEND_TEST(ServiceTest, ConfigureIgnoredProperty); |
| 552 | FRIEND_TEST(ServiceTest, ConfigureStringProperty); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 553 | FRIEND_TEST(ServiceTest, Constructor); |
Paul Stewart | 10241e3 | 2012-04-23 18:15:06 -0700 | [diff] [blame] | 554 | FRIEND_TEST(ServiceTest, GetIPConfigRpcIdentifier); |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 555 | FRIEND_TEST(ServiceTest, GetProperties); |
mukesh agrawal | 76d1388 | 2012-01-12 15:23:11 -0800 | [diff] [blame] | 556 | FRIEND_TEST(ServiceTest, IsAutoConnectable); |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 557 | FRIEND_TEST(ServiceTest, IsDependentOn); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 558 | FRIEND_TEST(ServiceTest, RecheckPortal); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 559 | FRIEND_TEST(ServiceTest, Save); |
| 560 | FRIEND_TEST(ServiceTest, SaveString); |
| 561 | FRIEND_TEST(ServiceTest, SaveStringCrypted); |
| 562 | FRIEND_TEST(ServiceTest, SaveStringDontSave); |
| 563 | FRIEND_TEST(ServiceTest, SaveStringEmpty); |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 564 | FRIEND_TEST(ServiceTest, SecurityLevel); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 565 | FRIEND_TEST(ServiceTest, SetCheckPortal); |
Darin Petkov | b2ba39f | 2012-06-06 10:33:43 +0200 | [diff] [blame] | 566 | FRIEND_TEST(ServiceTest, SetConnectable); |
Arman Uguray | 2717a10 | 2013-01-29 23:36:06 -0800 | [diff] [blame] | 567 | FRIEND_TEST(ServiceTest, SetFriendlyName); |
| 568 | FRIEND_TEST(ServiceTest, SetProperty); |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 569 | FRIEND_TEST(ServiceTest, State); |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 570 | FRIEND_TEST(ServiceTest, Unload); |
Paul Stewart | 1369c2b | 2013-01-11 05:41:26 -0800 | [diff] [blame] | 571 | FRIEND_TEST(WiFiMainTest, SuspectCredentialsEAPInProgress); |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 572 | FRIEND_TEST(WiFiMainTest, SuspectCredentialsWPAPreviouslyConnected); |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 573 | FRIEND_TEST(WiFiTimerTest, ReconnectTimer); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 574 | |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 575 | static const char kAutoConnConnected[]; |
| 576 | static const char kAutoConnConnecting[]; |
| 577 | static const char kAutoConnExplicitDisconnect[]; |
| 578 | static const char kAutoConnNotConnectable[]; |
Darin Petkov | 4cbff5b | 2013-01-29 16:29:05 +0100 | [diff] [blame] | 579 | static const char kAutoConnOffline[]; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 580 | static const char kAutoConnThrottled[]; |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 581 | |
Paul Stewart | bc6e739 | 2012-05-24 07:07:48 -0700 | [diff] [blame] | 582 | static const size_t kEAPMaxCertificationElements; |
| 583 | |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 584 | static const char kServiceSortAutoConnect[]; |
| 585 | static const char kServiceSortConnectable[]; |
| 586 | static const char kServiceSortFavorite[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 587 | static const char kServiceSortIsConnected[]; |
Paul Stewart | df3c0a8 | 2012-11-09 15:54:33 -0800 | [diff] [blame] | 588 | static const char kServiceSortDependency[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 589 | static const char kServiceSortIsConnecting[]; |
| 590 | static const char kServiceSortIsFailed[]; |
Paul Stewart | a121c44 | 2012-06-09 14:12:58 -0700 | [diff] [blame] | 591 | static const char kServiceSortIsPortalled[]; |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 592 | static const char kServiceSortPriority[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 593 | static const char kServiceSortSecurityEtc[]; |
Darin Petkov | 2f903b3 | 2012-04-18 12:56:43 +0200 | [diff] [blame] | 594 | static const char kServiceSortTechnology[]; |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 595 | static const char kServiceSortUniqueName[]; |
| 596 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 597 | static const uint64 kMaxAutoConnectCooldownTimeMilliseconds; |
| 598 | static const uint64 kMinAutoConnectCooldownTimeMilliseconds; |
| 599 | static const uint64 kAutoConnectCooldownBackoffFactor; |
| 600 | |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 601 | static const int kDisconnectsMonitorSeconds; |
| 602 | static const int kMisconnectsMonitorSeconds; |
| 603 | static const int kReportDisconnectsThreshold; |
| 604 | static const int kReportMisconnectsThreshold; |
| 605 | static const int kMaxDisconnectEventHistory; |
| 606 | |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 607 | bool GetAutoConnect(Error *error); |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 608 | |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 609 | std::string GetCheckPortal(Error *error); |
| 610 | void SetCheckPortal(const std::string &check_portal, Error *error); |
| 611 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 612 | virtual std::string GetDeviceRpcId(Error *error) = 0; |
Chris Masone | 95207da | 2011-06-29 16:50:49 -0700 | [diff] [blame] | 613 | |
Paul Stewart | 10241e3 | 2012-04-23 18:15:06 -0700 | [diff] [blame] | 614 | std::string GetIPConfigRpcIdentifier(Error *error); |
| 615 | |
Darin Petkov | 9c6e981 | 2013-03-26 13:49:07 +0100 | [diff] [blame] | 616 | // The base implementation asserts that |name| matches the current Name |
| 617 | // property value. |
| 618 | virtual void SetNameProperty(const std::string &name, Error *error); |
Paul Stewart | 0c43833 | 2012-04-11 07:55:27 -0700 | [diff] [blame] | 619 | std::string GetNameProperty(Error *error); |
Paul Stewart | 0c43833 | 2012-04-11 07:55:27 -0700 | [diff] [blame] | 620 | |
Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 621 | std::string GetProfileRpcId(Error *error); |
| 622 | void SetProfileRpcId(const std::string &profile, Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 623 | |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 624 | // Returns TCP port of service's HTTP proxy in host order. |
| 625 | uint16 GetHTTPProxyPort(Error *error); |
| 626 | |
Philipp Neubeck | 7917360 | 2012-11-13 21:10:09 +0100 | [diff] [blame] | 627 | std::string GetProxyConfig(Error *error); |
| 628 | void SetProxyConfig(const std::string &proxy_config, Error *error); |
| 629 | |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 630 | static Strings ExtractWallClockToStrings( |
| 631 | const std::deque<Timestamp> ×tamps); |
| 632 | Strings GetDisconnectsProperty(Error *error); |
| 633 | Strings GetMisconnectsProperty(Error *error); |
| 634 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 635 | void ReEnableAutoConnectTask(); |
| 636 | // Disables autoconnect and posts a task to re-enable it after a cooldown. |
| 637 | // Note that autoconnect could be disabled for other reasons as well. |
| 638 | void ThrottleFutureAutoConnects(); |
| 639 | |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 640 | // Saves settings to profile, if we have one. Unlike |
| 641 | // SaveServiceToProfile, SaveToProfile never assigns this service |
| 642 | // into a profile. |
| 643 | void SaveToProfile(); |
| 644 | |
Paul Stewart | 483e472 | 2012-12-18 10:23:17 -0800 | [diff] [blame] | 645 | // Start at the head of |events| and remove all entries that occurred |
| 646 | // more than |seconds_ago| prior to |now|. Also, the size of |events| |
| 647 | // is unconditionally trimmed below kMaxDisconnectEventHistory. |
| 648 | static void ExpireEventsBefore( |
| 649 | int seconds_ago, const Timestamp &now, std::deque<Timestamp> *events); |
| 650 | |
| 651 | // Qualify the conditions under which the most recent disconnect occurred. |
| 652 | // Make note ot the fact that there was a problem connecting / staying |
| 653 | // connected if the disconnection did not occur as a clear result of user |
| 654 | // action. |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 655 | void NoteDisconnectEvent(); |
| 656 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 657 | // Utility function that returns true if a is different from b. When they |
| 658 | // are, "decision" is populated with the boolean value of "a > b". |
| 659 | static bool DecideBetween(int a, int b, bool *decision); |
| 660 | |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 661 | // Linearize security parameters (crypto algorithm, key rotation, endpoint |
| 662 | // authentication) for comparison. |
| 663 | uint16 SecurityLevel(); |
| 664 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 665 | ConnectState state_; |
Darin Petkov | c8d91e5 | 2013-01-21 11:43:47 +0100 | [diff] [blame] | 666 | ConnectState previous_state_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 667 | ConnectFailure failure_; |
| 668 | bool auto_connect_; |
| 669 | std::string check_portal_; |
| 670 | bool connectable_; |
| 671 | std::string error_; |
Darin Petkov | aba8932 | 2013-03-11 14:48:22 +0100 | [diff] [blame] | 672 | std::string error_details_; |
mukesh agrawal | adb6848 | 2012-01-17 16:31:51 -0800 | [diff] [blame] | 673 | bool explicitly_disconnected_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 674 | bool favorite_; |
| 675 | int32 priority_; |
mukesh agrawal | 43970a2 | 2013-02-15 16:00:07 -0800 | [diff] [blame] | 676 | uint8 crypto_algorithm_; |
| 677 | bool key_rotation_; |
| 678 | bool endpoint_auth_; |
| 679 | |
Darin Petkov | d78ee7e | 2012-01-12 11:21:10 +0100 | [diff] [blame] | 680 | uint8 strength_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 681 | std::string proxy_config_; |
Paul Stewart | 987e71e | 2011-12-05 09:45:06 -0800 | [diff] [blame] | 682 | std::string ui_data_; |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 683 | std::string guid_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 684 | bool save_credentials_; |
| 685 | EapCredentials eap_; // Only saved if |save_credentials_| is true. |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 686 | Technology::Identifier technology_; |
mukesh agrawal | 568b5c6 | 2012-02-28 14:44:47 -0800 | [diff] [blame] | 687 | // The time of the most recent failure. Value is 0 if the service is |
| 688 | // not currently failed. |
| 689 | time_t failed_time_; |
mukesh agrawal | cf24a24 | 2012-05-21 16:46:11 -0700 | [diff] [blame] | 690 | // Whether or not this service has ever reached kStateConnected. |
| 691 | bool has_ever_connected_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 692 | |
Darin Petkov | 0c65bdd | 2012-12-05 13:42:41 +0100 | [diff] [blame] | 693 | std::deque<Timestamp> disconnects_; // Connection drops. |
| 694 | std::deque<Timestamp> misconnects_; // Failures to connect. |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 695 | |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 696 | base::CancelableClosure reenable_auto_connect_task_; |
| 697 | uint64 auto_connect_cooldown_milliseconds_ ; |
| 698 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 699 | ProfileRefPtr profile_; |
| 700 | PropertyStore store_; |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame] | 701 | std::set<std::string> parameters_ignored_for_configure_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 702 | |
| 703 | EventDispatcher *dispatcher_; |
mukesh agrawal | 51a7e93 | 2011-07-27 16:18:26 -0700 | [diff] [blame] | 704 | static unsigned int serial_number_; |
mukesh agrawal | d835b20 | 2011-10-07 15:26:47 -0700 | [diff] [blame] | 705 | std::string unique_name_; // MUST be unique amongst service instances |
Darin Petkov | 457728b | 2013-01-09 09:49:08 +0100 | [diff] [blame] | 706 | |
| 707 | // Service's friendly name is presented through the UI. By default it's the |
| 708 | // same as |unique_name_| but normally Service subclasses override |
| 709 | // it. WARNING: Don't log the friendly name at the default logging level due |
| 710 | // to PII concerns. |
| 711 | std::string friendly_name_; |
| 712 | |
Paul Stewart | ba41b99 | 2011-05-26 07:02:46 -0700 | [diff] [blame] | 713 | scoped_ptr<ServiceAdaptorInterface> adaptor_; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 714 | scoped_ptr<HTTPProxy> http_proxy_; |
Paul Stewart | c1dec4d | 2011-12-08 15:25:28 -0800 | [diff] [blame] | 715 | ConnectionRefPtr connection_; |
Paul Stewart | 1062d9d | 2012-04-27 10:42:27 -0700 | [diff] [blame] | 716 | StaticIPParameters static_ip_parameters_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 717 | Metrics *metrics_; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 718 | Manager *manager_; |
Darin Petkov | 5eb0542 | 2012-05-11 15:45:25 +0200 | [diff] [blame] | 719 | scoped_ptr<Sockets> sockets_; |
Christopher Wiley | 0801d19 | 2012-09-24 11:57:15 -0700 | [diff] [blame] | 720 | base::WeakPtrFactory<Service> weak_ptr_factory_; |
Darin Petkov | 385b9bc | 2012-12-03 15:25:05 +0100 | [diff] [blame] | 721 | Time *time_; |
| 722 | DiagnosticsReporter *diagnostics_reporter_; |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 723 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 724 | DISALLOW_COPY_AND_ASSIGN(Service); |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 725 | }; |
| 726 | |
| 727 | } // namespace shill |
| 728 | |
Ben Chan | 19f8397 | 2012-10-03 23:25:56 -0700 | [diff] [blame] | 729 | #endif // SHILL_SERVICE_H_ |