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 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 5 | #ifndef SHILL_SERVICE_ |
| 6 | #define SHILL_SERVICE_ |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 7 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 8 | #include <string> |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 9 | #include <map> |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame^] | 10 | #include <set> |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 11 | #include <vector> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 12 | |
| 13 | #include <base/memory/ref_counted.h> |
Paul Stewart | ba41b99 | 2011-05-26 07:02:46 -0700 | [diff] [blame] | 14 | #include <base/memory/scoped_ptr.h> |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 15 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 16 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 17 | #include "shill/adaptor_interfaces.h" |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 18 | #include "shill/accessor_interface.h" |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 19 | #include "shill/callbacks.h" |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 20 | #include "shill/property_store.h" |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 21 | #include "shill/refptr_types.h" |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 22 | #include "shill/sockets.h" |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 23 | #include "shill/technology.h" |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 24 | |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 25 | namespace chromeos_metrics { |
| 26 | class Timer; |
| 27 | } |
| 28 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 29 | namespace shill { |
| 30 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 31 | class Configuration; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 32 | class ControlInterface; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 33 | class Endpoint; |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 34 | class Error; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 35 | class EventDispatcher; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 36 | class HTTPProxy; |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 37 | class KeyValueStore; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 38 | class Manager; |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 39 | class Metrics; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 40 | class ServiceAdaptorInterface; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 41 | class StoreInterface; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 42 | |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 43 | // A Service is a uniquely named entity, which the system can |
| 44 | // connect in order to begin sending and receiving network traffic. |
| 45 | // All Services are bound to an Entry, which represents the persistable |
| 46 | // state of the Service. If the Entry is populated at the time of Service |
| 47 | // creation, that information is used to prime the Service. If not, the Entry |
| 48 | // becomes populated over time. |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 49 | class Service : public base::RefCounted<Service> { |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 50 | public: |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 51 | static const char kCheckPortalAuto[]; |
| 52 | static const char kCheckPortalFalse[]; |
| 53 | static const char kCheckPortalTrue[]; |
| 54 | |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 55 | // TODO(pstew): Storage constants shouldn't need to be public |
| 56 | // crosbug.com/25813 |
| 57 | static const char kStorageAutoConnect[]; |
| 58 | static const char kStorageCheckPortal[]; |
| 59 | static const char kStorageEapAnonymousIdentity[]; |
| 60 | static const char kStorageEapCACert[]; |
| 61 | static const char kStorageEapCACertID[]; |
| 62 | static const char kStorageEapCertID[]; |
| 63 | static const char kStorageEapClientCert[]; |
| 64 | static const char kStorageEapEap[]; |
| 65 | static const char kStorageEapIdentity[]; |
| 66 | static const char kStorageEapInnerEap[]; |
| 67 | static const char kStorageEapKeyID[]; |
| 68 | static const char kStorageEapKeyManagement[]; |
| 69 | static const char kStorageEapPIN[]; |
| 70 | static const char kStorageEapPassword[]; |
| 71 | static const char kStorageEapPrivateKey[]; |
| 72 | static const char kStorageEapPrivateKeyPassword[]; |
| 73 | static const char kStorageEapUseSystemCAs[]; |
| 74 | static const char kStorageError[]; |
| 75 | static const char kStorageFavorite[]; |
| 76 | static const char kStorageGUID[]; |
| 77 | static const char kStorageName[]; |
| 78 | static const char kStoragePriority[]; |
| 79 | static const char kStorageProxyConfig[]; |
| 80 | static const char kStorageSaveCredentials[]; |
| 81 | static const char kStorageType[]; |
| 82 | static const char kStorageUIData[]; |
| 83 | |
mukesh agrawal | 8f3f775 | 2012-02-17 19:42:09 -0800 | [diff] [blame] | 84 | static const uint8 kStrengthMax; |
| 85 | static const uint8 kStrengthMin; |
| 86 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 87 | enum ConnectFailure { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 88 | kFailureUnknown, |
| 89 | kFailureActivationFailure, |
| 90 | kFailureOutOfRange, |
| 91 | kFailurePinMissing, |
| 92 | kFailureConfigurationFailed, |
| 93 | kFailureBadCredentials, |
| 94 | kFailureNeedEVDO, |
| 95 | kFailureNeedHomeNetwork, |
| 96 | kFailureOTASPFailure, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 97 | kFailureAAAFailure, |
| 98 | kFailureMax |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 99 | }; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 100 | enum ConnectState { |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 101 | kStateUnknown, |
| 102 | kStateIdle, |
| 103 | kStateAssociating, |
| 104 | kStateConfiguring, |
| 105 | kStateConnected, |
| 106 | kStateDisconnected, |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 107 | kStatePortal, |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 108 | kStateFailure, |
| 109 | kStateOnline |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 110 | }; |
Chris Masone | b2e326b | 2011-07-12 13:28:51 -0700 | [diff] [blame] | 111 | struct EapCredentials { |
| 112 | EapCredentials() : use_system_cas(false) {} |
| 113 | std::string identity; |
| 114 | std::string eap; |
| 115 | std::string inner_eap; |
| 116 | std::string anonymous_identity; |
| 117 | std::string client_cert; |
| 118 | std::string cert_id; |
| 119 | std::string private_key; |
| 120 | std::string private_key_password; |
| 121 | std::string key_id; |
| 122 | std::string ca_cert; |
| 123 | std::string ca_cert_id; |
| 124 | bool use_system_cas; |
| 125 | std::string pin; |
| 126 | std::string password; |
| 127 | std::string key_management; |
| 128 | }; |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 129 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 130 | static const int kPriorityNone; |
| 131 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 132 | // A constructor for the Service object |
| 133 | Service(ControlInterface *control_interface, |
| 134 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 135 | Metrics *metrics, |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 136 | Manager *manager, |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 137 | Technology::Identifier technology); |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 138 | virtual ~Service(); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 139 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 140 | // AutoConnect MAY choose to ignore the connection request in some |
| 141 | // cases. For example, if the corresponding Device only supports one |
| 142 | // concurrent connection, and another Service is already connected |
| 143 | // or connecting. |
| 144 | // |
| 145 | // AutoConnect MAY issue RPCs immediately. So AutoConnect MUST NOT |
| 146 | // be called from a D-Bus signal handler context. |
| 147 | virtual void AutoConnect(); |
| 148 | // Queue up a connection attempt. |
mukesh agrawal | adb6848 | 2012-01-17 16:31:51 -0800 | [diff] [blame] | 149 | virtual void Connect(Error *error); |
| 150 | // Disconnect this service. The service will not be eligible for |
| 151 | // auto-connect until a subsequent call to Connect, or Load. |
| 152 | virtual void Disconnect(Error *error); |
Chris Masone | a82b711 | 2011-05-25 15:16:29 -0700 | [diff] [blame] | 153 | |
Eric Shienbrood | 5de44ab | 2011-12-05 10:46:27 -0500 | [diff] [blame] | 154 | // The default implementation returns the error kInvalidArguments. |
| 155 | virtual void ActivateCellularModem(const std::string &carrier, |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 156 | Error *error, |
| 157 | const ResultCallback &callback); |
Darin Petkov | c408e69 | 2011-08-17 13:47:15 -0700 | [diff] [blame] | 158 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 159 | // Base method always returns false. |
| 160 | virtual bool TechnologyIs(const Technology::Identifier type) const; |
| 161 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 162 | virtual bool IsActive(Error *error); |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 163 | |
| 164 | virtual ConnectState state() const { return state_; } |
| 165 | // Updates the state of the Service and alerts the manager. Also |
| 166 | // clears |failure_| if the new state isn't a failure. |
| 167 | virtual void SetState(ConnectState state); |
| 168 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 169 | // State utility functions |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 170 | virtual bool IsConnected() const { |
| 171 | return state() == kStateConnected || state() == kStatePortal || |
| 172 | state() == kStateOnline; |
| 173 | } |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 174 | virtual bool IsConnecting() const { |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 175 | return state() == kStateAssociating || state() == kStateConfiguring; |
| 176 | } |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 177 | virtual bool IsFailed() const { |
| 178 | return state() == kStateFailure; |
| 179 | } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 180 | |
Paul Stewart | 03dba0b | 2011-08-22 16:32:45 -0700 | [diff] [blame] | 181 | virtual ConnectFailure failure() const { return failure_; } |
| 182 | // Records the failure mode, and sets the Service state to "Failure". |
| 183 | virtual void SetFailure(ConnectFailure failure); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 184 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 185 | // Returns a string that is guaranteed to uniquely identify this Service |
| 186 | // instance. |
mukesh agrawal | d835b20 | 2011-10-07 15:26:47 -0700 | [diff] [blame] | 187 | const std::string &UniqueName() const { return unique_name_; } |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 188 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 189 | virtual std::string GetRpcIdentifier() const; |
Chris Masone | 3c3f6a1 | 2011-07-01 10:01:41 -0700 | [diff] [blame] | 190 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 191 | // Returns the unique persistent storage identifier for the service. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 192 | virtual std::string GetStorageIdentifier() const = 0; |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 193 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 194 | // Returns whether the service configuration can be loaded from |storage|. |
| 195 | virtual bool IsLoadableFrom(StoreInterface *storage) const; |
| 196 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 197 | // Loads the service from persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 198 | virtual bool Load(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 199 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 200 | // Indicate to service that it is no longer persisted to storage. It |
| 201 | // should purge any stored profile state (e.g., credentials). |
| 202 | virtual void Unload(); |
| 203 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 204 | // Saves the service to persistent |storage|. Returns true on success. |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 205 | virtual bool Save(StoreInterface *storage); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 206 | |
Thieu Le | d4e9e55 | 2012-02-16 16:26:07 -0800 | [diff] [blame] | 207 | // Saves the service to the current profile. |
| 208 | virtual bool SaveToCurrentProfile(); |
| 209 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame^] | 210 | // Applies all the properties in |args| to this service object's mutable |
| 211 | // store, except for those in parameters_ignored_for_configure_. |
| 212 | // Returns an error in |error| if one or more parameter set attempts |
| 213 | // fails, but will only return the first error. |
| 214 | virtual void Configure(const KeyValueStore &args, Error *error); |
| 215 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 216 | // Returns true if the service RPC identifier should be part of the |
| 217 | // manager's advertised services list, false otherwise. |
| 218 | virtual bool IsVisible() const { return true; } |
| 219 | |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 220 | // Returns true if there is a proxy configuration set on this service. |
| 221 | virtual bool HasProxyConfig() const { return !proxy_config_.empty(); } |
| 222 | |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 223 | virtual void MakeFavorite(); |
| 224 | |
Paul Stewart | c1dec4d | 2011-12-08 15:25:28 -0800 | [diff] [blame] | 225 | // Set the connection for this service. If the connection is |
| 226 | // non-NULL, create an HTTP Proxy that will utilize this service's |
| 227 | // connection to serve requests. |
| 228 | virtual void SetConnection(ConnectionRefPtr connection); |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 229 | |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 230 | // Examines the EAP credentials for the service and returns true if a |
| 231 | // connection attempt can be made. |
| 232 | bool Is8021xConnectable() const; |
| 233 | |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 234 | // The inherited class should register any custom metrics in this method. |
| 235 | virtual void InitializeCustomMetrics() const {} |
| 236 | |
| 237 | // The inherited class that needs to send metrics after the service has |
Thieu Le | b84ba34 | 2012-03-02 15:15:19 -0800 | [diff] [blame] | 238 | // transitioned to the ready state should override this method. |
| 239 | // |time_resume_to_ready_milliseconds| holds the elapsed time from when |
| 240 | // the system was resumed until when the service transitioned to the |
| 241 | // connected state. This value is non-zero for the first service transition |
| 242 | // to the connected state after a resume. |
| 243 | virtual void SendPostReadyStateMetrics( |
| 244 | int64 /*time_resume_to_ready_milliseconds*/) const {} |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 245 | |
Darin Petkov | afa6fc4 | 2011-06-21 16:21:08 -0700 | [diff] [blame] | 246 | bool auto_connect() const { return auto_connect_; } |
| 247 | void set_auto_connect(bool connect) { auto_connect_ = connect; } |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 248 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 249 | bool connectable() const { return connectable_; } |
mukesh agrawal | 29c13a1 | 2011-11-24 00:09:19 +0000 | [diff] [blame] | 250 | void set_connectable(bool connectable); |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 251 | |
Thieu Le | 67370f6 | 2012-02-14 23:01:42 +0000 | [diff] [blame] | 252 | virtual bool explicitly_disconnected() const { |
| 253 | return explicitly_disconnected_; |
| 254 | } |
| 255 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 256 | bool favorite() const { return favorite_; } |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 257 | // Setter is deliberately omitted; use MakeFavorite. |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 258 | |
mukesh agrawal | 1590839 | 2011-11-16 18:29:25 +0000 | [diff] [blame] | 259 | const std::string &friendly_name() const { return friendly_name_; } |
Darin Petkov | 7f06033 | 2012-03-14 11:46:47 +0100 | [diff] [blame] | 260 | void set_friendly_name(const std::string &n) { friendly_name_ = n; } |
mukesh agrawal | 1590839 | 2011-11-16 18:29:25 +0000 | [diff] [blame] | 261 | |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 262 | const std::string &guid() const { return guid_; } |
| 263 | void set_guid(const std::string &guid) { guid_ = guid; } |
| 264 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 265 | int32 priority() const { return priority_; } |
| 266 | void set_priority(int32 priority) { priority_ = priority; } |
| 267 | |
Paul Stewart | 1ca3e85 | 2011-11-04 07:50:49 -0700 | [diff] [blame] | 268 | int32 security_level() const { return security_level_; } |
| 269 | void set_security_level(int32 security) { security_level_ = security; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 270 | |
Darin Petkov | d78ee7e | 2012-01-12 11:21:10 +0100 | [diff] [blame] | 271 | void SetStrength(uint8 strength); |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 272 | |
| 273 | // uint8 streams out as a char. Coerce to a larger type, so that |
| 274 | // it prints as a number. |
| 275 | uint16 strength() const { return strength_; } |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 276 | |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 277 | virtual Technology::Identifier technology() const { return technology_; } |
| 278 | std::string GetTechnologyString(Error *error); |
| 279 | |
Gaurav Shah | 10109f2 | 2011-11-11 20:16:22 -0800 | [diff] [blame] | 280 | const EapCredentials &eap() const { return eap_; } |
| 281 | virtual void set_eap(const EapCredentials &eap); |
| 282 | |
Darin Petkov | 5148900 | 2011-08-18 13:13:20 -0700 | [diff] [blame] | 283 | const std::string &error() const { return error_; } |
| 284 | void set_error(const std::string &error) { error_ = error; } |
| 285 | |
Gaurav Shah | c6d6c72 | 2011-11-17 18:59:39 -0800 | [diff] [blame] | 286 | static const char *ConnectFailureToString(const ConnectFailure &state); |
| 287 | static const char *ConnectStateToString(const ConnectState &state); |
| 288 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 289 | // Compare two services. Returns true if Service a should be displayed |
| 290 | // above Service b |
| 291 | static bool Compare(ServiceRefPtr a, |
| 292 | ServiceRefPtr b, |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 293 | const std::vector<Technology::Identifier> &tech_order, |
| 294 | const char **reason); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 295 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 296 | // 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] | 297 | // TODO(cmasone): right now, these are here only so that we can get the |
| 298 | // profile name as a property. Can we store just the name, and then handle |
| 299 | // setting the profile for this service via |manager_|? |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 300 | const ProfileRefPtr &profile() const; |
| 301 | void set_profile(const ProfileRefPtr &p); |
| 302 | |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 303 | PropertyStore *mutable_store() { return &store_; } |
| 304 | const PropertyStore &store() const { return store_; } |
Paul Stewart | ce4ec19 | 2012-03-14 12:53:46 -0700 | [diff] [blame] | 305 | virtual const ConnectionRefPtr &connection() const { return connection_; } |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 306 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 307 | protected: |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 308 | // Returns true if a character is allowed to be in a service storage id. |
| 309 | static bool LegalChar(char a) { return isalnum(a) || a == '_'; } |
| 310 | |
Darin Petkov | 3133241 | 2012-01-28 01:50:02 +0100 | [diff] [blame] | 311 | // Returns true if a character is disallowed to be in a service storage id. |
| 312 | static bool IllegalChar(char a) { return !LegalChar(a); } |
| 313 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 314 | virtual std::string CalculateState(Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 315 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 316 | // Returns whether this service is in a state conducive to auto-connect. |
| 317 | // This should include any tests used for computing connectable(), |
| 318 | // as well as other critera such as whether the device associated with |
| 319 | // this service is busy with another connection. |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 320 | // |
| 321 | // If the service is not auto-connectable, |*reason| will be set to |
| 322 | // point to C-string explaining why the service is not auto-connectable. |
| 323 | virtual bool IsAutoConnectable(const char **reason) const; |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 324 | |
mukesh agrawal | 292dc0f | 2012-01-26 18:02:46 -0800 | [diff] [blame] | 325 | // HelpRegisterDerived*: Expose a property over RPC, with the name |name|. |
| 326 | // |
| 327 | // Reads of the property will be handled by invoking |get|. |
| 328 | // Writes to the property will be handled by invoking |set|. |
| 329 | // Clearing the property will be handled by PropertyStore. |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 330 | void HelpRegisterDerivedBool( |
| 331 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 332 | bool(Service::*get)(Error *error), |
| 333 | void(Service::*set)(const bool &value, Error *error)); |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 334 | void HelpRegisterDerivedString( |
| 335 | const std::string &name, |
Hristo Stefanov | ed2c28c | 2011-11-29 15:37:30 -0800 | [diff] [blame] | 336 | std::string(Service::*get)(Error *error), |
| 337 | void(Service::*set)(const std::string &value, Error *error)); |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 338 | void HelpRegisterDerivedUint16( |
| 339 | const std::string &name, |
| 340 | uint16(Service::*get)(Error *error), |
| 341 | void(Service::*set)(const uint16 &value, Error *error)); |
mukesh agrawal | 292dc0f | 2012-01-26 18:02:46 -0800 | [diff] [blame] | 342 | // Expose a property over RPC, with the name |name|. |
| 343 | // |
| 344 | // Reads of the property will be handled by invoking |get|. |
| 345 | // Writes to the property will be handled by invoking |set|. |
| 346 | // |
| 347 | // Clearing the property will be handled by invoking |clear|, or |
| 348 | // calling |set| with |default_value| (whichever is non-NULL). It |
| 349 | // is an error to call this method with both |clear| and |
| 350 | // |default_value| non-NULL. |
| 351 | void HelpRegisterWriteOnlyDerivedString( |
| 352 | const std::string &name, |
| 353 | void(Service::*set)(const std::string &value, Error *error), |
| 354 | void(Service::*clear)(Error *error), |
| 355 | const std::string *default_value); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 356 | |
Darin Petkov | b72cf40 | 2011-11-22 14:51:39 +0100 | [diff] [blame] | 357 | ServiceAdaptorInterface *adaptor() const { return adaptor_.get(); } |
| 358 | |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 359 | // Assigns |value| to |key| in |storage| if |value| is non-empty and |save| is |
| 360 | // true. Otherwise, removes |key| from |storage|. If |crypted| is true, the |
| 361 | // value is encrypted. |
| 362 | void SaveString(StoreInterface *storage, |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 363 | const std::string &id, |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 364 | const std::string &key, |
| 365 | const std::string &value, |
| 366 | bool crypted, |
| 367 | bool save); |
| 368 | |
Chris Masone | 34af218 | 2011-08-22 11:59:36 -0700 | [diff] [blame] | 369 | void LoadEapCredentials(StoreInterface *storage, const std::string &id); |
| 370 | void SaveEapCredentials(StoreInterface *storage, const std::string &id); |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 371 | void UnloadEapCredentials(); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 372 | |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame^] | 373 | // Ignore |parameter| when performing a Configure() operation. |
| 374 | void IgnoreParameterForConfigure(const std::string ¶meter); |
| 375 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 376 | // Property accessors reserved for subclasses |
| 377 | EventDispatcher *dispatcher() const { return dispatcher_; } |
| 378 | const std::string &GetEAPKeyManagement() const; |
| 379 | void SetEAPKeyManagement(const std::string &key_management); |
Paul Stewart | 9f32d19 | 2012-01-30 20:37:50 -0800 | [diff] [blame] | 380 | void SetEAPPassword(const std::string &password, Error *error); |
| 381 | void SetEAPPrivateKeyPassword(const std::string &password, Error *error); |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 382 | Metrics *metrics() const { return metrics_; } |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 383 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 384 | private: |
Thieu Le | 48e6d6d | 2011-12-06 00:40:27 +0000 | [diff] [blame] | 385 | friend class MetricsTest; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 386 | friend class ServiceAdaptorInterface; |
mukesh agrawal | e1d90e9 | 2012-02-15 17:36:08 -0800 | [diff] [blame] | 387 | friend class WiFiServiceTest; |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame^] | 388 | FRIEND_TEST(ServiceTest, ConfigureIgnoredProperty); |
| 389 | FRIEND_TEST(ServiceTest, ConfigureStringProperty); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 390 | FRIEND_TEST(ServiceTest, Constructor); |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 391 | FRIEND_TEST(ServiceTest, GetProperties); |
mukesh agrawal | 76d1388 | 2012-01-12 15:23:11 -0800 | [diff] [blame] | 392 | FRIEND_TEST(ServiceTest, IsAutoConnectable); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 393 | FRIEND_TEST(ServiceTest, Save); |
| 394 | FRIEND_TEST(ServiceTest, SaveString); |
| 395 | FRIEND_TEST(ServiceTest, SaveStringCrypted); |
| 396 | FRIEND_TEST(ServiceTest, SaveStringDontSave); |
| 397 | FRIEND_TEST(ServiceTest, SaveStringEmpty); |
mukesh agrawal | 6bb9e7c | 2012-01-30 14:57:54 -0800 | [diff] [blame] | 398 | FRIEND_TEST(ServiceTest, SetProperty); |
Paul Stewart | d8ad3c4 | 2012-01-09 12:39:38 -0800 | [diff] [blame] | 399 | FRIEND_TEST(ServiceTest, Unload); |
Darin Petkov | ba40dd3 | 2011-07-11 20:06:39 -0700 | [diff] [blame] | 400 | |
mukesh agrawal | bf14e94 | 2012-03-02 14:36:34 -0800 | [diff] [blame] | 401 | static const char kAutoConnConnected[]; |
| 402 | static const char kAutoConnConnecting[]; |
| 403 | static const char kAutoConnExplicitDisconnect[]; |
| 404 | static const char kAutoConnNotConnectable[]; |
| 405 | |
mukesh agrawal | ddc378f | 2012-02-17 18:26:20 -0800 | [diff] [blame] | 406 | static const char kServiceSortConnectEtc[]; |
| 407 | static const char kServiceSortIsConnected[]; |
| 408 | static const char kServiceSortIsConnecting[]; |
| 409 | static const char kServiceSortIsFailed[]; |
| 410 | static const char kServiceSortTechnology[]; |
| 411 | static const char kServiceSortSecurityEtc[]; |
| 412 | static const char kServiceSortUniqueName[]; |
| 413 | |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 414 | bool GetAutoConnect(Error *error); |
| 415 | void SetAutoConnect(const bool &connect, Error *error); |
| 416 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 417 | virtual std::string GetDeviceRpcId(Error *error) = 0; |
Chris Masone | 95207da | 2011-06-29 16:50:49 -0700 | [diff] [blame] | 418 | |
Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 419 | std::string GetProfileRpcId(Error *error); |
| 420 | void SetProfileRpcId(const std::string &profile, Error *error); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 421 | |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 422 | // Returns TCP port of service's HTTP proxy in host order. |
| 423 | uint16 GetHTTPProxyPort(Error *error); |
| 424 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 425 | // Utility function that returns true if a is different from b. When they |
| 426 | // are, "decision" is populated with the boolean value of "a > b". |
| 427 | static bool DecideBetween(int a, int b, bool *decision); |
| 428 | |
Thieu Le | 284fe79 | 2012-01-31 17:53:19 -0800 | [diff] [blame] | 429 | // For unit testing. |
| 430 | void set_favorite(bool favorite) { favorite_ = favorite; } |
| 431 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 432 | ConnectState state_; |
| 433 | ConnectFailure failure_; |
| 434 | bool auto_connect_; |
| 435 | std::string check_portal_; |
| 436 | bool connectable_; |
| 437 | std::string error_; |
mukesh agrawal | adb6848 | 2012-01-17 16:31:51 -0800 | [diff] [blame] | 438 | bool explicitly_disconnected_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 439 | bool favorite_; |
| 440 | int32 priority_; |
Paul Stewart | 1ca3e85 | 2011-11-04 07:50:49 -0700 | [diff] [blame] | 441 | int32 security_level_; |
Darin Petkov | d78ee7e | 2012-01-12 11:21:10 +0100 | [diff] [blame] | 442 | uint8 strength_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 443 | std::string proxy_config_; |
Paul Stewart | 987e71e | 2011-12-05 09:45:06 -0800 | [diff] [blame] | 444 | std::string ui_data_; |
Paul Stewart | 4c56161 | 2012-03-21 12:49:01 -0700 | [diff] [blame] | 445 | std::string guid_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 446 | bool save_credentials_; |
| 447 | EapCredentials eap_; // Only saved if |save_credentials_| is true. |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 448 | Technology::Identifier technology_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 449 | |
| 450 | ProfileRefPtr profile_; |
| 451 | PropertyStore store_; |
Paul Stewart | cb59fed | 2012-03-21 21:14:46 -0700 | [diff] [blame^] | 452 | std::set<std::string> parameters_ignored_for_configure_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 453 | |
| 454 | EventDispatcher *dispatcher_; |
mukesh agrawal | 51a7e93 | 2011-07-27 16:18:26 -0700 | [diff] [blame] | 455 | static unsigned int serial_number_; |
mukesh agrawal | d835b20 | 2011-10-07 15:26:47 -0700 | [diff] [blame] | 456 | std::string unique_name_; // MUST be unique amongst service instances |
| 457 | std::string friendly_name_; // MAY be same as |unique_name_| |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 458 | bool available_; |
| 459 | bool configured_; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 460 | Configuration *configuration_; |
Paul Stewart | ba41b99 | 2011-05-26 07:02:46 -0700 | [diff] [blame] | 461 | scoped_ptr<ServiceAdaptorInterface> adaptor_; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 462 | scoped_ptr<HTTPProxy> http_proxy_; |
Paul Stewart | c1dec4d | 2011-12-08 15:25:28 -0800 | [diff] [blame] | 463 | ConnectionRefPtr connection_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 464 | Metrics *metrics_; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 465 | Manager *manager_; |
Paul Stewart | be5f5b3 | 2011-12-07 17:11:11 -0800 | [diff] [blame] | 466 | Sockets sockets_; |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 467 | |
mukesh agrawal | b54601c | 2011-06-07 17:39:22 -0700 | [diff] [blame] | 468 | DISALLOW_COPY_AND_ASSIGN(Service); |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 469 | }; |
| 470 | |
| 471 | } // namespace shill |
| 472 | |
| 473 | #endif // SHILL_SERVICE_ |