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