chromeos/network/managed_network_configuration_handler_impl.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROMEOS_NETWORK_MANAGED_NETWORK_CONFIGURATION_HANDLER_IMPL_H_
   6 #define CHROMEOS_NETWORK_MANAGED_NETWORK_CONFIGURATION_HANDLER_IMPL_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11
  12 #include "base/basictypes.h"
  13 #include "base/compiler_specific.h"
  14 #include "base/memory/linked_ptr.h"
  15 #include "base/memory/weak_ptr.h"
  16 #include "chromeos/chromeos_export.h"
  17 #include "chromeos/network/managed_network_configuration_handler.h"
  18 #include "chromeos/network/network_handler_callbacks.h"
  19 #include "chromeos/network/network_profile_observer.h"
  20 #include "chromeos/network/policy_applicator.h"
  21
  22 namespace base {
  23 class DictionaryValue;
  24 }
  25
  26 namespace chromeos {
  27
  28 class NetworkConfigurationHandler;
  29 struct NetworkProfile;
  30 class NetworkProfileHandler;
  31 class NetworkStateHandler;
  32
  33 class CHROMEOS_EXPORT ManagedNetworkConfigurationHandlerImpl
  34     : public ManagedNetworkConfigurationHandler,
  35       public NetworkProfileObserver,
  36       public PolicyApplicator::ConfigurationHandler {
  37  public:
  38   ~ManagedNetworkConfigurationHandlerImpl() override;
  39
  40   // ManagedNetworkConfigurationHandler overrides
  41   void AddObserver(NetworkPolicyObserver* observer) override;
  42   void RemoveObserver(NetworkPolicyObserver* observer) override;
  43
  44   void GetProperties(
  45       const std::string& service_path,
  46       const network_handler::DictionaryResultCallback& callback,
  47       const network_handler::ErrorCallback& error_callback) override;
  48
  49   void GetManagedProperties(
  50       const std::string& userhash,
  51       const std::string& service_path,
  52       const network_handler::DictionaryResultCallback& callback,
  53       const network_handler::ErrorCallback& error_callback) override;
  54
  55   void SetProperties(
  56       const std::string& service_path,
  57       const base::DictionaryValue& user_settings,
  58       const base::Closure& callback,
  59       const network_handler::ErrorCallback& error_callback) override;
  60
  61   void CreateConfiguration(
  62       const std::string& userhash,
  63       const base::DictionaryValue& properties,
  64       const network_handler::StringResultCallback& callback,
  65       const network_handler::ErrorCallback& error_callback) const override;
  66
  67   void RemoveConfiguration(
  68       const std::string& service_path,
  69       const base::Closure& callback,
  70       const network_handler::ErrorCallback& error_callback) const override;
  71
  72   void SetPolicy(onc::ONCSource onc_source,
  73                  const std::string& userhash,
  74                  const base::ListValue& network_configs_onc,
  75                  const base::DictionaryValue& global_network_config) override;
  76
  77   bool IsAnyPolicyApplicationRunning() const override;
  78
  79   const base::DictionaryValue* FindPolicyByGUID(
  80       const std::string userhash,
  81       const std::string& guid,
  82       onc::ONCSource* onc_source) const override;
  83
  84   const GuidToPolicyMap* GetNetworkConfigsFromPolicy(
  85       const std::string& userhash) const override;
  86
  87   const base::DictionaryValue* GetGlobalConfigFromPolicy(
  88       const std::string& userhash) const override;
  89
  90   const base::DictionaryValue* FindPolicyByGuidAndProfile(
  91       const std::string& guid,
  92       const std::string& profile_path) const override;
  93
  94   // NetworkProfileObserver overrides
  95   void OnProfileAdded(const NetworkProfile& profile) override;
  96   void OnProfileRemoved(const NetworkProfile& profile) override;
  97
  98   // PolicyApplicator::ConfigurationHandler overrides
  99   void CreateConfigurationFromPolicy(
 100       const base::DictionaryValue& shill_properties) override;
 101
 102   void UpdateExistingConfigurationWithPropertiesFromPolicy(
 103       const base::DictionaryValue& existing_properties,
 104       const base::DictionaryValue& new_properties) override;
 105
 106   void OnPoliciesApplied(const NetworkProfile& profile) override;
 107
 108  private:
 109   friend class AutoConnectHandlerTest;
 110   friend class ClientCertResolverTest;
 111   friend class ManagedNetworkConfigurationHandlerTest;
 112   friend class NetworkConnectionHandlerTest;
 113   friend class NetworkHandler;
 114
 115   struct Policies;
 116   typedef base::Callback<void(const std::string& service_path,
 117                               scoped_ptr<base::DictionaryValue> properties)>
 118       GetDevicePropertiesCallback;
 119   typedef std::map<std::string, linked_ptr<Policies> > UserToPoliciesMap;
 120   typedef std::map<std::string, linked_ptr<PolicyApplicator>>
 121       UserToPolicyApplicatorMap;
 122   typedef std::map<std::string, std::set<std::string>>
 123       UserToModifiedPoliciesMap;
 124
 125   ManagedNetworkConfigurationHandlerImpl();
 126
 127   // Handlers may be NULL in tests so long as they do not execute any paths
 128   // that require the handlers.
 129   void Init(NetworkStateHandler* network_state_handler,
 130             NetworkProfileHandler* network_profile_handler,
 131             NetworkConfigurationHandler* network_configuration_handler,
 132             NetworkDeviceHandler* network_device_handler);
 133
 134   // Sends the response to the caller of GetManagedProperties.
 135   void SendManagedProperties(
 136       const std::string& userhash,
 137       const network_handler::DictionaryResultCallback& callback,
 138       const network_handler::ErrorCallback& error_callback,
 139       const std::string& service_path,
 140       scoped_ptr<base::DictionaryValue> shill_properties);
 141
 142   // Sends the response to the caller of GetProperties.
 143   void SendProperties(
 144       const network_handler::DictionaryResultCallback& callback,
 145       const network_handler::ErrorCallback& error_callback,
 146       const std::string& service_path,
 147       scoped_ptr<base::DictionaryValue> shill_properties);
 148
 149   const Policies* GetPoliciesForUser(const std::string& userhash) const;
 150   const Policies* GetPoliciesForProfile(const NetworkProfile& profile) const;
 151
 152   void OnPolicyAppliedToNetwork(const std::string& service_path);
 153
 154   // Helper method to append associated Device properties to |properties|.
 155   void GetDeviceStateProperties(const std::string& service_path,
 156                                 base::DictionaryValue* properties);
 157
 158   // Callback for NetworkConfigurationHandler::GetProperties requests from
 159   // Get{Managed}Properties. This callback fills in properties from
 160   // DeviceState and may request additional Device properties.
 161   // Note: Requesting Device properties requires an additional fetch and
 162   // additional copying of data, so we only do it for Cellular networks which
 163   // contain a lot of necessary state in the associated Device object.
 164   void GetPropertiesCallback(
 165       GetDevicePropertiesCallback send_callback,
 166       const std::string& service_path,
 167       const base::DictionaryValue& shill_properties);
 168
 169   void GetDevicePropertiesSuccess(
 170       const std::string& service_path,
 171       scoped_ptr<base::DictionaryValue> network_properties,
 172       GetDevicePropertiesCallback send_callback,
 173       const std::string& device_path,
 174       const base::DictionaryValue& device_properties);
 175   void GetDevicePropertiesFailure(
 176       const std::string& service_path,
 177       scoped_ptr<base::DictionaryValue> network_properties,
 178       GetDevicePropertiesCallback send_callback,
 179       const std::string& error_name,
 180       scoped_ptr<base::DictionaryValue> error_data);
 181
 182   // Called from SetProperties, calls NCH::SetShillProperties.
 183   void SetShillProperties(const std::string& service_path,
 184                           scoped_ptr<base::DictionaryValue> shill_dictionary,
 185                           const base::Closure& callback,
 186                           const network_handler::ErrorCallback& error_callback);
 187
 188   // Applies policies for |userhash|. |modified_policies| must be not null and
 189   // contain the GUIDs of the network configurations that changed since the last
 190   // policy application. Returns true if policy application was started and
 191   // false if it was queued or delayed.
 192   bool ApplyOrQueuePolicies(const std::string& userhash,
 193                             std::set<std::string>* modified_policies);
 194
 195   // If present, the empty string maps to the device policy.
 196   UserToPoliciesMap policies_by_user_;
 197
 198   // Local references to the associated handler instances.
 199   NetworkStateHandler* network_state_handler_;
 200   NetworkProfileHandler* network_profile_handler_;
 201   NetworkConfigurationHandler* network_configuration_handler_;
 202   NetworkDeviceHandler* network_device_handler_;
 203
 204   // Owns the currently running PolicyApplicators.
 205   UserToPolicyApplicatorMap policy_applicators_;
 206
 207   // Per userhash (or empty string for device policy), contains the GUIDs of the
 208   // policies that were modified.
 209   // If this map contains a userhash as key, it means that a policy application
 210   // for this userhash is pending even if no policies were modified and the
 211   // associated set of GUIDs is empty.
 212   UserToModifiedPoliciesMap queued_modified_policies_;
 213
 214   base::ObserverList<NetworkPolicyObserver> observers_;
 215
 216   // For Shill client callbacks
 217   base::WeakPtrFactory<ManagedNetworkConfigurationHandlerImpl>
 218       weak_ptr_factory_;
 219
 220   DISALLOW_COPY_AND_ASSIGN(ManagedNetworkConfigurationHandlerImpl);
 221 };
 222
 223 }  // namespace chromeos
 224
 225 #endif  // CHROMEOS_NETWORK_MANAGED_NETWORK_CONFIGURATION_HANDLER_IMPL_H_