blob: 4a808d0887a169c92c18cf79f0c38ce426f243f9 [file] [log] [blame]
mukesh agrawal8a3188d2011-12-01 20:56:44 +00001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
Paul Stewart75897df2011-04-27 09:05:53 -07002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Chris Masone9be4a9d2011-05-16 15:44:09 -07005#ifndef SHILL_SERVICE_
6#define SHILL_SERVICE_
Paul Stewart75897df2011-04-27 09:05:53 -07007
mukesh agrawal568b5c62012-02-28 14:44:47 -08008#include <time.h>
9
Chris Masone9be4a9d2011-05-16 15:44:09 -070010#include <string>
Chris Masone8fe2c7e2011-06-09 15:51:19 -070011#include <map>
Paul Stewartcb59fed2012-03-21 21:14:46 -070012#include <set>
Chris Masone8fe2c7e2011-06-09 15:51:19 -070013#include <vector>
Chris Masone9be4a9d2011-05-16 15:44:09 -070014
15#include <base/memory/ref_counted.h>
Paul Stewartba41b992011-05-26 07:02:46 -070016#include <base/memory/scoped_ptr.h>
Darin Petkovba40dd32011-07-11 20:06:39 -070017#include <gtest/gtest_prod.h> // for FRIEND_TEST
Paul Stewart75897df2011-04-27 09:05:53 -070018
Eric Shienbrood9a245532012-03-07 14:20:39 -050019#include "shill/adaptor_interfaces.h"
Chris Masone3bd3c8c2011-06-13 08:20:26 -070020#include "shill/accessor_interface.h"
Eric Shienbrood9a245532012-03-07 14:20:39 -050021#include "shill/callbacks.h"
Chris Masoneb925cc82011-06-22 15:39:57 -070022#include "shill/property_store.h"
Chris Masone7aa5f902011-07-11 11:13:35 -070023#include "shill/refptr_types.h"
Paul Stewart1062d9d2012-04-27 10:42:27 -070024#include "shill/static_ip_parameters.h"
Paul Stewart22aa71b2011-09-16 12:15:11 -070025#include "shill/technology.h"
Chris Masonec1e50412011-06-07 13:04:53 -070026
Thieu Leb84ba342012-03-02 15:15:19 -080027namespace chromeos_metrics {
28class Timer;
29}
30
Paul Stewart75897df2011-04-27 09:05:53 -070031namespace shill {
32
Paul Stewart75897df2011-04-27 09:05:53 -070033class Configuration;
Chris Masone9be4a9d2011-05-16 15:44:09 -070034class ControlInterface;
Paul Stewart75897df2011-04-27 09:05:53 -070035class Endpoint;
Chris Masone8fe2c7e2011-06-09 15:51:19 -070036class Error;
Chris Masone9be4a9d2011-05-16 15:44:09 -070037class EventDispatcher;
Paul Stewartbe5f5b32011-12-07 17:11:11 -080038class HTTPProxy;
mukesh agrawal7a4e4002011-09-06 11:26:05 -070039class KeyValueStore;
Chris Masone6791a432011-07-12 13:23:19 -070040class Manager;
Thieu Le48e6d6d2011-12-06 00:40:27 +000041class Metrics;
Chris Masone9be4a9d2011-05-16 15:44:09 -070042class ServiceAdaptorInterface;
Darin Petkov5eb05422012-05-11 15:45:25 +020043class Sockets;
Darin Petkovba40dd32011-07-11 20:06:39 -070044class StoreInterface;
Paul Stewart75897df2011-04-27 09:05:53 -070045
Chris Masone7aa5f902011-07-11 11:13:35 -070046// A Service is a uniquely named entity, which the system can
47// connect in order to begin sending and receiving network traffic.
48// All Services are bound to an Entry, which represents the persistable
49// state of the Service. If the Entry is populated at the time of Service
50// creation, that information is used to prime the Service. If not, the Entry
51// becomes populated over time.
Chris Masone27c4aa52011-07-02 13:10:14 -070052class Service : public base::RefCounted<Service> {
Paul Stewart75897df2011-04-27 09:05:53 -070053 public:
Darin Petkovba40dd32011-07-11 20:06:39 -070054 static const char kCheckPortalAuto[];
55 static const char kCheckPortalFalse[];
56 static const char kCheckPortalTrue[];
57
Paul Stewart0756db92012-01-27 08:34:47 -080058 // TODO(pstew): Storage constants shouldn't need to be public
59 // crosbug.com/25813
60 static const char kStorageAutoConnect[];
61 static const char kStorageCheckPortal[];
62 static const char kStorageEapAnonymousIdentity[];
63 static const char kStorageEapCACert[];
64 static const char kStorageEapCACertID[];
Paul Stewartecf4cd12012-04-17 11:08:39 -070065 static const char kStorageEapCACertNSS[];
Paul Stewart0756db92012-01-27 08:34:47 -080066 static const char kStorageEapCertID[];
67 static const char kStorageEapClientCert[];
68 static const char kStorageEapEap[];
69 static const char kStorageEapIdentity[];
70 static const char kStorageEapInnerEap[];
71 static const char kStorageEapKeyID[];
72 static const char kStorageEapKeyManagement[];
73 static const char kStorageEapPIN[];
74 static const char kStorageEapPassword[];
75 static const char kStorageEapPrivateKey[];
76 static const char kStorageEapPrivateKeyPassword[];
77 static const char kStorageEapUseSystemCAs[];
78 static const char kStorageError[];
79 static const char kStorageFavorite[];
80 static const char kStorageGUID[];
mukesh agrawalcf24a242012-05-21 16:46:11 -070081 static const char kStorageHasEverConnected[];
Paul Stewart0756db92012-01-27 08:34:47 -080082 static const char kStorageName[];
83 static const char kStoragePriority[];
84 static const char kStorageProxyConfig[];
85 static const char kStorageSaveCredentials[];
86 static const char kStorageType[];
87 static const char kStorageUIData[];
88
mukesh agrawal8f3f7752012-02-17 19:42:09 -080089 static const uint8 kStrengthMax;
90 static const uint8 kStrengthMin;
91
Paul Stewart75897df2011-04-27 09:05:53 -070092 enum ConnectFailure {
Paul Stewart03dba0b2011-08-22 16:32:45 -070093 kFailureUnknown,
Paul Stewartf2d60912012-07-15 08:37:30 -070094 kFailureActivation,
Paul Stewart03dba0b2011-08-22 16:32:45 -070095 kFailureOutOfRange,
96 kFailurePinMissing,
Paul Stewartf2d60912012-07-15 08:37:30 -070097 kFailureDHCP,
98 kFailureBadPassphrase,
Paul Stewart03dba0b2011-08-22 16:32:45 -070099 kFailureNeedEVDO,
100 kFailureNeedHomeNetwork,
Paul Stewartf2d60912012-07-15 08:37:30 -0700101 kFailureOTASP,
102 kFailureAAA,
103 kFailureBadWEPKey,
104 kFailureConnect,
105 kFailureDNSLookup,
106 kFailureHTTPGet,
107 kFailurePPPAuth,
Thieu Le48e6d6d2011-12-06 00:40:27 +0000108 kFailureMax
Paul Stewart75897df2011-04-27 09:05:53 -0700109 };
Chris Masone9be4a9d2011-05-16 15:44:09 -0700110 enum ConnectState {
Paul Stewart03dba0b2011-08-22 16:32:45 -0700111 kStateUnknown,
112 kStateIdle,
113 kStateAssociating,
114 kStateConfiguring,
115 kStateConnected,
116 kStateDisconnected,
Thieu Le48e6d6d2011-12-06 00:40:27 +0000117 kStatePortal,
Gaurav Shahc6d6c722011-11-17 18:59:39 -0800118 kStateFailure,
119 kStateOnline
Chris Masone9be4a9d2011-05-16 15:44:09 -0700120 };
Chris Masoneb2e326b2011-07-12 13:28:51 -0700121 struct EapCredentials {
Paul Stewart20550982012-04-16 12:16:11 -0700122 EapCredentials() : use_system_cas(true) {}
Paul Stewartbc6e7392012-05-24 07:07:48 -0700123 // Who we identify ourselves as to the EAP authenticator.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700124 std::string identity;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700125 // The outer or only EAP authetnication type.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700126 std::string eap;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700127 // The inner EAP authentication type.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700128 std::string inner_eap;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700129 // When there is an inner EAP type, use this identity for the outer.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700130 std::string anonymous_identity;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700131 // Filename of the client certificate.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700132 std::string client_cert;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700133 // Locator for the client certificate within the security token.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700134 std::string cert_id;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700135 // Filename of the client private key.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700136 std::string private_key;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700137 // Password for decrypting the client private key file.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700138 std::string private_key_password;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700139 // Locator for the client private key within the security token.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700140 std::string key_id;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700141 // Filename of the certificate authority (CA) certificate.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700142 std::string ca_cert;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700143 // Locator for the CA certificate within the security token.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700144 std::string ca_cert_id;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700145 // Locator for the CA certificate within the user NSS database.
Paul Stewartecf4cd12012-04-17 11:08:39 -0700146 std::string ca_cert_nss;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700147 // If true, use the system-wide CA database to authenticate the remote.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700148 bool use_system_cas;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700149 // PIN code for accessing the security token.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700150 std::string pin;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700151 // Password to use for EAP methods which require one.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700152 std::string password;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700153 // Key management algorithm to use after EAP succeeds.
Chris Masoneb2e326b2011-07-12 13:28:51 -0700154 std::string key_management;
Paul Stewartbc6e7392012-05-24 07:07:48 -0700155 // If non-empty, string to match remote subject against before connecting.
156 std::string subject_match;
157 // List of subject names reported by remote entity during TLS setup.
158 std::vector<std::string> remote_certification;
Chris Masoneb2e326b2011-07-12 13:28:51 -0700159 };
Chris Masone9be4a9d2011-05-16 15:44:09 -0700160
Paul Stewartac4ac002011-08-26 12:04:26 -0700161 static const int kPriorityNone;
162
Chris Masone9be4a9d2011-05-16 15:44:09 -0700163 // A constructor for the Service object
164 Service(ControlInterface *control_interface,
165 EventDispatcher *dispatcher,
Thieu Le3426c8f2012-01-11 17:35:11 -0800166 Metrics *metrics,
mukesh agrawal7a4e4002011-09-06 11:26:05 -0700167 Manager *manager,
Gaurav Shah435de2c2011-11-17 19:01:07 -0800168 Technology::Identifier technology);
Darin Petkovba40dd32011-07-11 20:06:39 -0700169
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000170 // AutoConnect MAY choose to ignore the connection request in some
171 // cases. For example, if the corresponding Device only supports one
172 // concurrent connection, and another Service is already connected
173 // or connecting.
174 //
175 // AutoConnect MAY issue RPCs immediately. So AutoConnect MUST NOT
176 // be called from a D-Bus signal handler context.
177 virtual void AutoConnect();
178 // Queue up a connection attempt.
mukesh agrawaladb68482012-01-17 16:31:51 -0800179 virtual void Connect(Error *error);
180 // Disconnect this service. The service will not be eligible for
181 // auto-connect until a subsequent call to Connect, or Load.
182 virtual void Disconnect(Error *error);
Chris Masonea82b7112011-05-25 15:16:29 -0700183
Eric Shienbrood5de44ab2011-12-05 10:46:27 -0500184 // The default implementation returns the error kInvalidArguments.
185 virtual void ActivateCellularModem(const std::string &carrier,
Eric Shienbrood9a245532012-03-07 14:20:39 -0500186 Error *error,
187 const ResultCallback &callback);
Darin Petkovc408e692011-08-17 13:47:15 -0700188
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800189 virtual bool IsActive(Error *error);
Paul Stewart03dba0b2011-08-22 16:32:45 -0700190
Paul Stewart7fb09382012-07-18 17:32:27 -0700191 // Returns whether services of this type should be auto-connect by default.
192 virtual bool IsAutoConnectByDefault() const { return false; }
193
Paul Stewart03dba0b2011-08-22 16:32:45 -0700194 virtual ConnectState state() const { return state_; }
195 // Updates the state of the Service and alerts the manager. Also
196 // clears |failure_| if the new state isn't a failure.
197 virtual void SetState(ConnectState state);
Darin Petkov58f0b6d2012-06-12 12:52:30 +0200198 std::string GetStateString() const;
Paul Stewart03dba0b2011-08-22 16:32:45 -0700199
Paul Stewart22aa71b2011-09-16 12:15:11 -0700200 // State utility functions
Paul Stewart20088d82012-02-16 06:58:55 -0800201 virtual bool IsConnected() const {
202 return state() == kStateConnected || state() == kStatePortal ||
203 state() == kStateOnline;
204 }
Gaurav Shah435de2c2011-11-17 19:01:07 -0800205 virtual bool IsConnecting() const {
Paul Stewart22aa71b2011-09-16 12:15:11 -0700206 return state() == kStateAssociating || state() == kStateConfiguring;
207 }
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000208 virtual bool IsFailed() const {
mukesh agrawal568b5c62012-02-28 14:44:47 -0800209 // We sometimes lie about the failure state, to keep Chrome happy
210 // (see comment in WiFi::HandleDisconnect). Hence, we check both
211 // state and |failed_time_|.
212 return state() == kStateFailure || failed_time_ > 0;
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000213 }
Paul Stewarta121c442012-06-09 14:12:58 -0700214 virtual bool IsPortalled() const {
215 return state() == kStatePortal;
216 }
Paul Stewart22aa71b2011-09-16 12:15:11 -0700217
Paul Stewart03dba0b2011-08-22 16:32:45 -0700218 virtual ConnectFailure failure() const { return failure_; }
mukesh agrawal568b5c62012-02-28 14:44:47 -0800219 // Records the failure mode and time. Sets the Service state to "Failure".
Paul Stewart03dba0b2011-08-22 16:32:45 -0700220 virtual void SetFailure(ConnectFailure failure);
mukesh agrawal568b5c62012-02-28 14:44:47 -0800221 // Records the failure mode and time. Sets the Service state to "Idle".
222 // Avoids showing a failure mole in the UI.
223 virtual void SetFailureSilent(ConnectFailure failure);
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700224
Darin Petkovba40dd32011-07-11 20:06:39 -0700225 // Returns a string that is guaranteed to uniquely identify this Service
226 // instance.
mukesh agrawald835b202011-10-07 15:26:47 -0700227 const std::string &UniqueName() const { return unique_name_; }
Darin Petkovafa6fc42011-06-21 16:21:08 -0700228
Chris Masone6791a432011-07-12 13:23:19 -0700229 virtual std::string GetRpcIdentifier() const;
Chris Masone3c3f6a12011-07-01 10:01:41 -0700230
Darin Petkovba40dd32011-07-11 20:06:39 -0700231 // Returns the unique persistent storage identifier for the service.
Chris Masone6515aab2011-10-12 16:19:09 -0700232 virtual std::string GetStorageIdentifier() const = 0;
Darin Petkovba40dd32011-07-11 20:06:39 -0700233
Paul Stewartbba6a5b2011-11-02 18:45:59 -0700234 // Returns whether the service configuration can be loaded from |storage|.
235 virtual bool IsLoadableFrom(StoreInterface *storage) const;
236
Paul Stewart81426132012-05-16 10:05:10 -0700237 // Returns true if the service uses 802.1x for key management.
238 virtual bool Is8021x() const { return false; };
239
Darin Petkovba40dd32011-07-11 20:06:39 -0700240 // Loads the service from persistent |storage|. Returns true on success.
Chris Masone9d779932011-08-25 16:33:41 -0700241 virtual bool Load(StoreInterface *storage);
Darin Petkovba40dd32011-07-11 20:06:39 -0700242
Paul Stewarta41e38d2011-11-11 07:47:29 -0800243 // Indicate to service that it is no longer persisted to storage. It
Paul Stewart65512e12012-03-26 18:01:08 -0700244 // should purge any stored profile state (e.g., credentials). Returns
245 // true to indicate that this service should also be unregistered from
246 // the manager, false otherwise.
247 virtual bool Unload();
Paul Stewarta41e38d2011-11-11 07:47:29 -0800248
Darin Petkovba40dd32011-07-11 20:06:39 -0700249 // Saves the service to persistent |storage|. Returns true on success.
Chris Masone9d779932011-08-25 16:33:41 -0700250 virtual bool Save(StoreInterface *storage);
Darin Petkovba40dd32011-07-11 20:06:39 -0700251
Thieu Led4e9e552012-02-16 16:26:07 -0800252 // Saves the service to the current profile.
Gary Moraind93615e2012-04-27 11:50:03 -0700253 virtual void SaveToCurrentProfile();
Thieu Led4e9e552012-02-16 16:26:07 -0800254
Paul Stewartcb59fed2012-03-21 21:14:46 -0700255 // Applies all the properties in |args| to this service object's mutable
256 // store, except for those in parameters_ignored_for_configure_.
257 // Returns an error in |error| if one or more parameter set attempts
258 // fails, but will only return the first error.
259 virtual void Configure(const KeyValueStore &args, Error *error);
260
Paul Stewartd215af62012-04-24 23:25:50 -0700261 // Returns whether portal detection is explicitly disabled on this service
262 // via a property set on it.
263 virtual bool IsPortalDetectionDisabled() const;
264
265 // Returns whether portal detection is set to follow the default setting
266 // of this service's technology via a property set on it.
267 virtual bool IsPortalDetectionAuto() const;
268
Paul Stewart10ccbb32012-04-26 15:59:30 -0700269 // Returns true if the service is persisted to a non-ephemeral profile.
270 virtual bool IsRemembered() const;
271
Paul Stewarta41e38d2011-11-11 07:47:29 -0800272 // Returns true if the service RPC identifier should be part of the
273 // manager's advertised services list, false otherwise.
274 virtual bool IsVisible() const { return true; }
275
Paul Stewart20088d82012-02-16 06:58:55 -0800276 // Returns true if there is a proxy configuration set on this service.
277 virtual bool HasProxyConfig() const { return !proxy_config_.empty(); }
278
mukesh agrawal00917ce2011-11-22 23:56:55 +0000279 virtual void MakeFavorite();
280
Darin Petkov5eb05422012-05-11 15:45:25 +0200281 // Set the connection for this service. If the connection is non-NULL, create
282 // an HTTP Proxy that will utilize this service's connection to serve
283 // requests.
284 virtual void SetConnection(const ConnectionRefPtr &connection);
285 virtual const ConnectionRefPtr &connection() const { return connection_; }
Paul Stewartbe5f5b32011-12-07 17:11:11 -0800286
Gaurav Shah10109f22011-11-11 20:16:22 -0800287 // Examines the EAP credentials for the service and returns true if a
288 // connection attempt can be made.
289 bool Is8021xConnectable() const;
290
Paul Stewartbc6e7392012-05-24 07:07:48 -0700291 // Add an EAP certification id |name| at position |depth| in the stack.
292 // Returns true if entry was added, false otherwise.
293 virtual bool AddEAPCertification(const std::string &name, size_t depth);
294 // Clear all EAP certification elements.
295 void ClearEAPCertification();
296
Thieu Le48e6d6d2011-12-06 00:40:27 +0000297 // The inherited class should register any custom metrics in this method.
298 virtual void InitializeCustomMetrics() const {}
299
300 // The inherited class that needs to send metrics after the service has
Thieu Leb84ba342012-03-02 15:15:19 -0800301 // transitioned to the ready state should override this method.
302 // |time_resume_to_ready_milliseconds| holds the elapsed time from when
303 // the system was resumed until when the service transitioned to the
304 // connected state. This value is non-zero for the first service transition
305 // to the connected state after a resume.
306 virtual void SendPostReadyStateMetrics(
307 int64 /*time_resume_to_ready_milliseconds*/) const {}
Thieu Le48e6d6d2011-12-06 00:40:27 +0000308
Darin Petkovafa6fc42011-06-21 16:21:08 -0700309 bool auto_connect() const { return auto_connect_; }
310 void set_auto_connect(bool connect) { auto_connect_ = connect; }
Paul Stewart75897df2011-04-27 09:05:53 -0700311
Gaurav Shah435de2c2011-11-17 19:01:07 -0800312 bool connectable() const { return connectable_; }
Darin Petkovb2ba39f2012-06-06 10:33:43 +0200313 // TODO(petkov): Remove this method in favor of SetConnectable.
mukesh agrawal29c13a12011-11-24 00:09:19 +0000314 void set_connectable(bool connectable);
Darin Petkovb2ba39f2012-06-06 10:33:43 +0200315 // Sets the connectable property of the service. Broadcasts the new value and
316 // alerts the manager if necessary.
317 void SetConnectable(bool connectable);
Gaurav Shah435de2c2011-11-17 19:01:07 -0800318
Thieu Le67370f62012-02-14 23:01:42 +0000319 virtual bool explicitly_disconnected() const {
320 return explicitly_disconnected_;
321 }
322
Paul Stewart22aa71b2011-09-16 12:15:11 -0700323 bool favorite() const { return favorite_; }
mukesh agrawal00917ce2011-11-22 23:56:55 +0000324 // Setter is deliberately omitted; use MakeFavorite.
Paul Stewart22aa71b2011-09-16 12:15:11 -0700325
mukesh agrawal15908392011-11-16 18:29:25 +0000326 const std::string &friendly_name() const { return friendly_name_; }
Darin Petkov7f060332012-03-14 11:46:47 +0100327 void set_friendly_name(const std::string &n) { friendly_name_ = n; }
mukesh agrawal15908392011-11-16 18:29:25 +0000328
Paul Stewart4c561612012-03-21 12:49:01 -0700329 const std::string &guid() const { return guid_; }
330 void set_guid(const std::string &guid) { guid_ = guid; }
331
mukesh agrawalcf24a242012-05-21 16:46:11 -0700332 bool has_ever_connected() const { return has_ever_connected_; }
333
Paul Stewart22aa71b2011-09-16 12:15:11 -0700334 int32 priority() const { return priority_; }
335 void set_priority(int32 priority) { priority_ = priority; }
336
Paul Stewart1ca3e852011-11-04 07:50:49 -0700337 int32 security_level() const { return security_level_; }
338 void set_security_level(int32 security) { security_level_ = security; }
Paul Stewart22aa71b2011-09-16 12:15:11 -0700339
Darin Petkovd78ee7e2012-01-12 11:21:10 +0100340 void SetStrength(uint8 strength);
mukesh agrawale1d90e92012-02-15 17:36:08 -0800341
342 // uint8 streams out as a char. Coerce to a larger type, so that
343 // it prints as a number.
344 uint16 strength() const { return strength_; }
Paul Stewart22aa71b2011-09-16 12:15:11 -0700345
Gaurav Shah435de2c2011-11-17 19:01:07 -0800346 virtual Technology::Identifier technology() const { return technology_; }
Darin Petkov58f0b6d2012-06-12 12:52:30 +0200347 std::string GetTechnologyString() const;
Gaurav Shah435de2c2011-11-17 19:01:07 -0800348
Gaurav Shah10109f22011-11-11 20:16:22 -0800349 const EapCredentials &eap() const { return eap_; }
350 virtual void set_eap(const EapCredentials &eap);
351
Darin Petkovcb715292012-04-25 13:04:37 +0200352 bool save_credentials() const { return save_credentials_; }
353 void set_save_credentials(bool save) { save_credentials_ = save; }
354
Darin Petkov51489002011-08-18 13:13:20 -0700355 const std::string &error() const { return error_; }
356 void set_error(const std::string &error) { error_ = error; }
357
Gaurav Shahc6d6c722011-11-17 18:59:39 -0800358 static const char *ConnectFailureToString(const ConnectFailure &state);
359 static const char *ConnectStateToString(const ConnectState &state);
360
Paul Stewart22aa71b2011-09-16 12:15:11 -0700361 // Compare two services. Returns true if Service a should be displayed
362 // above Service b
363 static bool Compare(ServiceRefPtr a,
364 ServiceRefPtr b,
mukesh agrawalddc378f2012-02-17 18:26:20 -0800365 const std::vector<Technology::Identifier> &tech_order,
366 const char **reason);
Paul Stewart22aa71b2011-09-16 12:15:11 -0700367
Chris Masone34af2182011-08-22 11:59:36 -0700368 // These are defined in service.cc so that we don't have to include profile.h
Chris Masone9d779932011-08-25 16:33:41 -0700369 // TODO(cmasone): right now, these are here only so that we can get the
370 // profile name as a property. Can we store just the name, and then handle
371 // setting the profile for this service via |manager_|?
Chris Masone6791a432011-07-12 13:23:19 -0700372 const ProfileRefPtr &profile() const;
373 void set_profile(const ProfileRefPtr &p);
374
Paul Stewart4357f4e2012-04-26 17:39:26 -0700375 // Notification that occurs when a service now has profile data saved
376 // on its behalf. Some service types like WiFi can choose to register
377 // themselves at this point.
378 virtual void OnProfileConfigured() {}
379
Paul Stewartff14b022012-04-24 20:06:23 -0700380 // Notification that occurs when a single property has been changed via
381 // the RPC adaptor.
Paul Stewart81426132012-05-16 10:05:10 -0700382 virtual void OnPropertyChanged(const std::string &property);
Paul Stewartff14b022012-04-24 20:06:23 -0700383
mukesh agrawalde29fa82011-09-16 16:16:36 -0700384 PropertyStore *mutable_store() { return &store_; }
385 const PropertyStore &store() const { return store_; }
Paul Stewartdef189e2012-08-02 20:12:09 -0700386 StaticIPParameters *mutable_static_ip_parameters() {
387 return &static_ip_parameters_;
388 }
Paul Stewart1062d9d2012-04-27 10:42:27 -0700389 const StaticIPParameters &static_ip_parameters() const {
390 return static_ip_parameters_;
391 }
Chris Masone27c4aa52011-07-02 13:10:14 -0700392
mukesh agrawalb54601c2011-06-07 17:39:22 -0700393 protected:
Darin Petkov5eb05422012-05-11 15:45:25 +0200394 friend class base::RefCounted<Service>;
395
396 virtual ~Service();
397
Chris Masone34af2182011-08-22 11:59:36 -0700398 // Returns true if a character is allowed to be in a service storage id.
399 static bool LegalChar(char a) { return isalnum(a) || a == '_'; }
400
Darin Petkov31332412012-01-28 01:50:02 +0100401 // Returns true if a character is disallowed to be in a service storage id.
402 static bool IllegalChar(char a) { return !LegalChar(a); }
403
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800404 virtual std::string CalculateState(Error *error);
Darin Petkov58f0b6d2012-06-12 12:52:30 +0200405 std::string CalculateTechnology(Error *error);
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700406
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000407 // Returns whether this service is in a state conducive to auto-connect.
408 // This should include any tests used for computing connectable(),
409 // as well as other critera such as whether the device associated with
410 // this service is busy with another connection.
mukesh agrawalbf14e942012-03-02 14:36:34 -0800411 //
412 // If the service is not auto-connectable, |*reason| will be set to
413 // point to C-string explaining why the service is not auto-connectable.
414 virtual bool IsAutoConnectable(const char **reason) const;
mukesh agrawal8a3188d2011-12-01 20:56:44 +0000415
mukesh agrawal292dc0f2012-01-26 18:02:46 -0800416 // HelpRegisterDerived*: Expose a property over RPC, with the name |name|.
417 //
418 // Reads of the property will be handled by invoking |get|.
419 // Writes to the property will be handled by invoking |set|.
420 // Clearing the property will be handled by PropertyStore.
mukesh agrawalffa3d042011-10-06 15:26:10 -0700421 void HelpRegisterDerivedBool(
422 const std::string &name,
Hristo Stefanoved2c28c2011-11-29 15:37:30 -0800423 bool(Service::*get)(Error *error),
424 void(Service::*set)(const bool &value, Error *error));
mukesh agrawalffa3d042011-10-06 15:26:10 -0700425 void HelpRegisterDerivedString(
426 const std::string &name,
Hristo Stefanoved2c28c2011-11-29 15:37:30 -0800427 std::string(Service::*get)(Error *error),
428 void(Service::*set)(const std::string &value, Error *error));
Paul Stewartbe5f5b32011-12-07 17:11:11 -0800429 void HelpRegisterDerivedUint16(
430 const std::string &name,
431 uint16(Service::*get)(Error *error),
432 void(Service::*set)(const uint16 &value, Error *error));
Jason Glasgowacdc11f2012-03-30 14:12:22 -0400433 void HelpRegisterDerivedRpcIdentifier(
434 const std::string &name,
435 std::string(Service::*get)(Error *),
436 void(Service::*set)(const RpcIdentifier&, Error *));
mukesh agrawal292dc0f2012-01-26 18:02:46 -0800437 // Expose a property over RPC, with the name |name|.
438 //
439 // Reads of the property will be handled by invoking |get|.
440 // Writes to the property will be handled by invoking |set|.
441 //
442 // Clearing the property will be handled by invoking |clear|, or
443 // calling |set| with |default_value| (whichever is non-NULL). It
444 // is an error to call this method with both |clear| and
445 // |default_value| non-NULL.
446 void HelpRegisterWriteOnlyDerivedString(
447 const std::string &name,
448 void(Service::*set)(const std::string &value, Error *error),
449 void(Service::*clear)(Error *error),
450 const std::string *default_value);
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700451
Darin Petkovb72cf402011-11-22 14:51:39 +0100452 ServiceAdaptorInterface *adaptor() const { return adaptor_.get(); }
453
Darin Petkovba40dd32011-07-11 20:06:39 -0700454 // Assigns |value| to |key| in |storage| if |value| is non-empty and |save| is
455 // true. Otherwise, removes |key| from |storage|. If |crypted| is true, the
456 // value is encrypted.
457 void SaveString(StoreInterface *storage,
Chris Masone34af2182011-08-22 11:59:36 -0700458 const std::string &id,
Darin Petkovba40dd32011-07-11 20:06:39 -0700459 const std::string &key,
460 const std::string &value,
461 bool crypted,
462 bool save);
463
Chris Masone34af2182011-08-22 11:59:36 -0700464 void LoadEapCredentials(StoreInterface *storage, const std::string &id);
465 void SaveEapCredentials(StoreInterface *storage, const std::string &id);
Paul Stewartd8ad3c42012-01-09 12:39:38 -0800466 void UnloadEapCredentials();
Darin Petkovba40dd32011-07-11 20:06:39 -0700467
Paul Stewartcb59fed2012-03-21 21:14:46 -0700468 // Ignore |parameter| when performing a Configure() operation.
469 void IgnoreParameterForConfigure(const std::string &parameter);
470
Paul Stewartf2d60912012-07-15 08:37:30 -0700471 // Update the service's string-based "Error" RPC property based on the
472 // failure_ enum.
473 void UpdateErrorProperty();
474
Paul Stewartac4ac002011-08-26 12:04:26 -0700475 // Property accessors reserved for subclasses
476 EventDispatcher *dispatcher() const { return dispatcher_; }
477 const std::string &GetEAPKeyManagement() const;
478 void SetEAPKeyManagement(const std::string &key_management);
Paul Stewart9f32d192012-01-30 20:37:50 -0800479 void SetEAPPassword(const std::string &password, Error *error);
480 void SetEAPPrivateKeyPassword(const std::string &password, Error *error);
Paul Stewart65512e12012-03-26 18:01:08 -0700481 Manager *manager() const { return manager_; }
Thieu Le48e6d6d2011-12-06 00:40:27 +0000482 Metrics *metrics() const { return metrics_; }
mukesh agrawalb54601c2011-06-07 17:39:22 -0700483
Darin Petkov1d0080a2012-04-30 17:10:36 +0200484 void set_favorite(bool favorite) { favorite_ = favorite; }
485
Paul Stewart75897df2011-04-27 09:05:53 -0700486 private:
Thieu Le48e6d6d2011-12-06 00:40:27 +0000487 friend class MetricsTest;
Paul Stewart0756db92012-01-27 08:34:47 -0800488 friend class ServiceAdaptorInterface;
Darin Petkov5eb05422012-05-11 15:45:25 +0200489 friend class VPNServiceTest;
mukesh agrawale1d90e92012-02-15 17:36:08 -0800490 friend class WiFiServiceTest;
Darin Petkov6b9b2e12012-07-10 15:51:42 +0200491 friend class WiMaxServiceTest;
mukesh agrawalcc0fded2012-05-09 13:40:58 -0700492 FRIEND_TEST(DeviceTest, IPConfigUpdatedFailureWithStatic);
Darin Petkov58f0b6d2012-06-12 12:52:30 +0200493 FRIEND_TEST(ServiceTest, CalculateState);
494 FRIEND_TEST(ServiceTest, CalculateTechnology);
Paul Stewartbc6e7392012-05-24 07:07:48 -0700495 FRIEND_TEST(ServiceTest, Certification);
Paul Stewartcb59fed2012-03-21 21:14:46 -0700496 FRIEND_TEST(ServiceTest, ConfigureIgnoredProperty);
497 FRIEND_TEST(ServiceTest, ConfigureStringProperty);
Darin Petkovba40dd32011-07-11 20:06:39 -0700498 FRIEND_TEST(ServiceTest, Constructor);
Paul Stewart10241e32012-04-23 18:15:06 -0700499 FRIEND_TEST(ServiceTest, GetIPConfigRpcIdentifier);
Thieu Le284fe792012-01-31 17:53:19 -0800500 FRIEND_TEST(ServiceTest, GetProperties);
mukesh agrawal76d13882012-01-12 15:23:11 -0800501 FRIEND_TEST(ServiceTest, IsAutoConnectable);
Paul Stewartd215af62012-04-24 23:25:50 -0700502 FRIEND_TEST(ServiceTest, RecheckPortal);
Darin Petkovba40dd32011-07-11 20:06:39 -0700503 FRIEND_TEST(ServiceTest, Save);
504 FRIEND_TEST(ServiceTest, SaveString);
505 FRIEND_TEST(ServiceTest, SaveStringCrypted);
506 FRIEND_TEST(ServiceTest, SaveStringDontSave);
507 FRIEND_TEST(ServiceTest, SaveStringEmpty);
mukesh agrawal6bb9e7c2012-01-30 14:57:54 -0800508 FRIEND_TEST(ServiceTest, SetProperty);
Paul Stewartd215af62012-04-24 23:25:50 -0700509 FRIEND_TEST(ServiceTest, SetCheckPortal);
Darin Petkovb2ba39f2012-06-06 10:33:43 +0200510 FRIEND_TEST(ServiceTest, SetConnectable);
mukesh agrawal568b5c62012-02-28 14:44:47 -0800511 FRIEND_TEST(ServiceTest, State);
Paul Stewartd8ad3c42012-01-09 12:39:38 -0800512 FRIEND_TEST(ServiceTest, Unload);
mukesh agrawalcf24a242012-05-21 16:46:11 -0700513 FRIEND_TEST(WiFiMainTest, SuspectCredentialsWPAPreviouslyConnected);
Darin Petkovba40dd32011-07-11 20:06:39 -0700514
mukesh agrawalbf14e942012-03-02 14:36:34 -0800515 static const char kAutoConnConnected[];
516 static const char kAutoConnConnecting[];
517 static const char kAutoConnExplicitDisconnect[];
518 static const char kAutoConnNotConnectable[];
519
Paul Stewartbc6e7392012-05-24 07:07:48 -0700520 static const size_t kEAPMaxCertificationElements;
521
Darin Petkov2f903b32012-04-18 12:56:43 +0200522 static const char kServiceSortAutoConnect[];
523 static const char kServiceSortConnectable[];
524 static const char kServiceSortFavorite[];
mukesh agrawalddc378f2012-02-17 18:26:20 -0800525 static const char kServiceSortIsConnected[];
526 static const char kServiceSortIsConnecting[];
527 static const char kServiceSortIsFailed[];
Paul Stewarta121c442012-06-09 14:12:58 -0700528 static const char kServiceSortIsPortalled[];
Darin Petkov2f903b32012-04-18 12:56:43 +0200529 static const char kServiceSortPriority[];
mukesh agrawalddc378f2012-02-17 18:26:20 -0800530 static const char kServiceSortSecurityEtc[];
Darin Petkov2f903b32012-04-18 12:56:43 +0200531 static const char kServiceSortTechnology[];
mukesh agrawalddc378f2012-02-17 18:26:20 -0800532 static const char kServiceSortUniqueName[];
533
Thieu Le284fe792012-01-31 17:53:19 -0800534 bool GetAutoConnect(Error *error);
535 void SetAutoConnect(const bool &connect, Error *error);
536
Paul Stewartd215af62012-04-24 23:25:50 -0700537 std::string GetCheckPortal(Error *error);
538 void SetCheckPortal(const std::string &check_portal, Error *error);
539
Gaurav Shah1b7a6162011-11-09 11:41:01 -0800540 virtual std::string GetDeviceRpcId(Error *error) = 0;
Chris Masone95207da2011-06-29 16:50:49 -0700541
Paul Stewart10241e32012-04-23 18:15:06 -0700542 std::string GetIPConfigRpcIdentifier(Error *error);
543
Paul Stewart0c438332012-04-11 07:55:27 -0700544 std::string GetNameProperty(Error *error);
545 void AssertTrivialSetNameProperty(const std::string &name, Error *error);
546
Paul Stewart1b1a7f22012-01-06 16:24:06 -0800547 std::string GetProfileRpcId(Error *error);
548 void SetProfileRpcId(const std::string &profile, Error *error);
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700549
Paul Stewartbe5f5b32011-12-07 17:11:11 -0800550 // Returns TCP port of service's HTTP proxy in host order.
551 uint16 GetHTTPProxyPort(Error *error);
552
mukesh agrawalcf24a242012-05-21 16:46:11 -0700553 // Saves settings to profile, if we have one. Unlike
554 // SaveServiceToProfile, SaveToProfile never assigns this service
555 // into a profile.
556 void SaveToProfile();
557
Paul Stewart22aa71b2011-09-16 12:15:11 -0700558 // Utility function that returns true if a is different from b. When they
559 // are, "decision" is populated with the boolean value of "a > b".
560 static bool DecideBetween(int a, int b, bool *decision);
561
Paul Stewartac4ac002011-08-26 12:04:26 -0700562 ConnectState state_;
563 ConnectFailure failure_;
564 bool auto_connect_;
565 std::string check_portal_;
566 bool connectable_;
567 std::string error_;
mukesh agrawaladb68482012-01-17 16:31:51 -0800568 bool explicitly_disconnected_;
Paul Stewartac4ac002011-08-26 12:04:26 -0700569 bool favorite_;
570 int32 priority_;
Paul Stewart1ca3e852011-11-04 07:50:49 -0700571 int32 security_level_;
Darin Petkovd78ee7e2012-01-12 11:21:10 +0100572 uint8 strength_;
Paul Stewartac4ac002011-08-26 12:04:26 -0700573 std::string proxy_config_;
Paul Stewart987e71e2011-12-05 09:45:06 -0800574 std::string ui_data_;
Paul Stewart4c561612012-03-21 12:49:01 -0700575 std::string guid_;
Paul Stewartac4ac002011-08-26 12:04:26 -0700576 bool save_credentials_;
577 EapCredentials eap_; // Only saved if |save_credentials_| is true.
Gaurav Shah435de2c2011-11-17 19:01:07 -0800578 Technology::Identifier technology_;
mukesh agrawal568b5c62012-02-28 14:44:47 -0800579 // The time of the most recent failure. Value is 0 if the service is
580 // not currently failed.
581 time_t failed_time_;
mukesh agrawalcf24a242012-05-21 16:46:11 -0700582 // Whether or not this service has ever reached kStateConnected.
583 bool has_ever_connected_;
Paul Stewartac4ac002011-08-26 12:04:26 -0700584
585 ProfileRefPtr profile_;
586 PropertyStore store_;
Paul Stewartcb59fed2012-03-21 21:14:46 -0700587 std::set<std::string> parameters_ignored_for_configure_;
Paul Stewartac4ac002011-08-26 12:04:26 -0700588
589 EventDispatcher *dispatcher_;
mukesh agrawal51a7e932011-07-27 16:18:26 -0700590 static unsigned int serial_number_;
mukesh agrawald835b202011-10-07 15:26:47 -0700591 std::string unique_name_; // MUST be unique amongst service instances
592 std::string friendly_name_; // MAY be same as |unique_name_|
Paul Stewart75897df2011-04-27 09:05:53 -0700593 bool available_;
594 bool configured_;
Paul Stewart75897df2011-04-27 09:05:53 -0700595 Configuration *configuration_;
Paul Stewartba41b992011-05-26 07:02:46 -0700596 scoped_ptr<ServiceAdaptorInterface> adaptor_;
Paul Stewartbe5f5b32011-12-07 17:11:11 -0800597 scoped_ptr<HTTPProxy> http_proxy_;
Paul Stewartc1dec4d2011-12-08 15:25:28 -0800598 ConnectionRefPtr connection_;
Paul Stewart1062d9d2012-04-27 10:42:27 -0700599 StaticIPParameters static_ip_parameters_;
Thieu Le3426c8f2012-01-11 17:35:11 -0800600 Metrics *metrics_;
Chris Masone6791a432011-07-12 13:23:19 -0700601 Manager *manager_;
Darin Petkov5eb05422012-05-11 15:45:25 +0200602 scoped_ptr<Sockets> sockets_;
Chris Masone3bd3c8c2011-06-13 08:20:26 -0700603
mukesh agrawalb54601c2011-06-07 17:39:22 -0700604 DISALLOW_COPY_AND_ASSIGN(Service);
Paul Stewart75897df2011-04-27 09:05:53 -0700605};
606
607} // namespace shill
608
609#endif // SHILL_SERVICE_