File: kiosk_network_state_observer.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (108 lines) | stat: -rw-r--r-- 4,181 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_ASH_APP_MODE_KIOSK_NETWORK_STATE_OBSERVER_H_
#define CHROME_BROWSER_ASH_APP_MODE_KIOSK_NETWORK_STATE_OBSERVER_H_

#include <optional>
#include <string>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "base/values.h"
#include "chromeos/ash/components/network/network_state_handler_observer.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/prefs/pref_service.h"

namespace ash {

// Max number of attempts to expose active WiFi.
inline constexpr size_t kMaxWifiExposureAttempts = 3;

// When `KioskActiveWiFiCredentialsScopeChangeEnabled` policy is enabled,
// expose the first active WiFi configuration to the device level.
class KioskNetworkStateObserver : public NetworkStateHandlerObserver {
 public:
  explicit KioskNetworkStateObserver(PrefService* pref_service);

  KioskNetworkStateObserver(const KioskNetworkStateObserver&) = delete;
  KioskNetworkStateObserver& operator=(const KioskNetworkStateObserver&) =
      delete;
  ~KioskNetworkStateObserver() override;

  bool IsPolicyEnabled() const;

  // This callback is called after an attempt to expose active WiFi.
  // `is_successful_attempt` indicates where the attempt was successful or not.
  using WifiExposureAttemptCallback =
      base::RepeatingCallback<void(bool is_successful_attempt)>;

  void SetWifiExposureAttemptCallbackForTesting(
      WifiExposureAttemptCallback callback);

 private:
  // NetworkStateHandlerObserver overrides:
  void ActiveNetworksChanged(
      const std::vector<const NetworkState*>& active_networks) override;

  void StartActiveWifiExposureProcess();
  void StopActiveWifiExposureProcess();

  void ExposeActiveWifiConfiguration();

  void OnGetWifiPassphraseResult(const std::string& service_path,
                                 const std::string& passphrase);
  void OnGetWifiPassphraseError(const std::string& error_name,
                                const std::string& error_message);
  void ReceiveProperties(const std::string& passphrase,
                         const std::string& service_path,
                         std::optional<base::Value::Dict> shill_properties);

  void OnCreatedShillConfigSuccess(const std::string&, const std::string&);
  void OnCreatedShillConfigFailure(const std::string& error);

  // This function is called once
  // `prefs::kKioskActiveWiFiCredentialsScopeChangeEnabled` preference is
  // updated.
  void PolicyChanged();

  // If the attempt to expose WiFi fails, call this function to update
  // `active_wifi_exposed_` and `wifi_exposure_attempts_`.
  void FailCurrentAttempt();

  // Does nothing if `wifi_exposure_attempt_callback_for_testing_` is not set.
  // Propagates `is_successful_attempt` to
  // `wifi_exposure_attempt_callback_for_testing_`.
  void MaybeRunWifiExposureAttemptCallback(bool is_successful_attempt);

  // Copy only one active WiFi. This helps to avoid a situation when
  // `ActiveNetworksChanged` is called second time before we unsubscribe on
  // the success WiFi exposure.
  bool active_wifi_exposed_ = false;

  // To avoid a failure loop, stop trying to expose the active WiFi after
  // `kMaxWifiExposureAttempts`
  size_t wifi_exposure_attempts_ = 0;

  const raw_ptr<PrefService> pref_service_;
  // Register `prefs::kKioskActiveWiFiCredentialsScopeChangeEnabled`
  // preference to support dynamic refresh.
  PrefChangeRegistrar pref_change_registrar_;

  base::ScopedObservation<NetworkStateHandler, NetworkStateHandlerObserver>
      network_state_handler_observation_{this};

  // This callback should be called after each successful or failed attempt. The
  // callback should be set only for testing via
  // `SetWifiExposureAttemptCallbackForTesting`.
  WifiExposureAttemptCallback wifi_exposure_attempt_callback_;

  base::WeakPtrFactory<KioskNetworkStateObserver> weak_ptr_factory_{this};
};

}  // namespace ash

#endif  // CHROME_BROWSER_ASH_APP_MODE_KIOSK_NETWORK_STATE_OBSERVER_H_