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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
// Copyright 2020 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_CERT_PROVISIONING_CERT_PROVISIONING_INVALIDATOR_H_
#define CHROME_BROWSER_ASH_CERT_PROVISIONING_CERT_PROVISIONING_INVALIDATOR_H_
#include <memory>
#include <string>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/scoped_observation.h"
#include "base/sequence_checker.h"
#include "components/invalidation/invalidation_listener.h"
class Profile;
namespace ash::cert_provisioning {
enum class InvalidationEvent {
// The client has successfully subscribed to the invalidation topic.
// This is relevant because if an invalidation was published for that
// invalidation topic before the client has successfully subscribed, the
// client will not receive that invalidation.
// This could be called multiple times because the registration could need to
// be re-established by the FCM client.
kSuccessfullySubscribed,
// An invalidation has been received.
kInvalidationReceived,
};
using OnInvalidationEventCallback =
base::RepeatingCallback<void(InvalidationEvent invalidation_event)>;
//=============== CertProvisioningInvalidationHandler ==========================
namespace internal {
// Responsible for listening to events of certificate invalidations.
class CertProvisioningInvalidationHandler
: public invalidation::InvalidationListener::Observer {
public:
// Creates and registers the handler to `invalidation_listener`
// with `listener_type`.
// `on_invalidation_event_callback` will be called when incoming invalidation
// is received.
CertProvisioningInvalidationHandler(
invalidation::InvalidationListener* invalidation_listener,
const std::string& listener_type,
OnInvalidationEventCallback on_invalidation_event_callback);
CertProvisioningInvalidationHandler(
const CertProvisioningInvalidationHandler&) = delete;
CertProvisioningInvalidationHandler& operator=(
const CertProvisioningInvalidationHandler&) = delete;
~CertProvisioningInvalidationHandler() override;
// invalidation::InvalidationListener::Observer
void OnExpectationChanged(
invalidation::InvalidationsExpected expected) override;
void OnInvalidationReceived(
const invalidation::DirectInvalidation& invalidation) override;
std::string GetType() const override;
private:
// Returns true if ready to receive invalidations.
bool IsRegistered() const;
// Returns true if ready to receive invalidations and invalidations are
// enabled.
bool AreInvalidationsEnabled() const;
// Sequence checker to ensure that calls from invalidation service are
// consecutive.
SEQUENCE_CHECKER(sequence_checker_);
// An invalidation service providing the handler with incoming invalidations.
const raw_ptr<invalidation::InvalidationListener> invalidation_listener_;
// A listener type for routing FCM invalidations.
const std::string listener_type_;
invalidation::InvalidationsExpected are_invalidations_expected_ =
invalidation::InvalidationsExpected::kMaybe;
// A callback to be called on incoming invalidation event.
const OnInvalidationEventCallback on_invalidation_event_callback_;
// Automatically unregisters `this` as an observer on destruction. Should be
// destroyed first so the other fields are still valid and can be used during
// the unregistration.
base::ScopedObservation<invalidation::InvalidationListener,
invalidation::InvalidationListener::Observer>
invalidation_listener_observation_{this};
};
} // namespace internal
//=============== CertProvisioningInvalidatorFactory ===========================
class CertProvisioningInvalidator;
// Interface for a factory that creates CertProvisioningInvalidators.
class CertProvisioningInvalidatorFactory {
public:
CertProvisioningInvalidatorFactory() = default;
CertProvisioningInvalidatorFactory(
const CertProvisioningInvalidatorFactory&) = delete;
CertProvisioningInvalidatorFactory& operator=(
const CertProvisioningInvalidatorFactory&) = delete;
virtual ~CertProvisioningInvalidatorFactory() = default;
virtual std::unique_ptr<CertProvisioningInvalidator> Create() = 0;
};
//=============== CertProvisioningInvalidator ==================================
// An invalidator that calls a Callback when an invalidation for a specific
// topic has been received. Register can be called multiple times for the same
// topic (e.g. after a chrome restart).
class CertProvisioningInvalidator {
public:
CertProvisioningInvalidator();
CertProvisioningInvalidator(const CertProvisioningInvalidator&) = delete;
CertProvisioningInvalidator& operator=(const CertProvisioningInvalidator&) =
delete;
virtual ~CertProvisioningInvalidator();
virtual void Register(
const std::string& listener_type,
OnInvalidationEventCallback on_invalidation_event_callback) = 0;
virtual void Unregister();
protected:
std::unique_ptr<internal::CertProvisioningInvalidationHandler>
invalidation_handler_;
};
//=============== CertProvisioningUserInvalidatorFactory =======================
// This factory creates CertProvisioningInvalidators that use the passed user
// Profile's `InvalidationListener`.
class CertProvisioningUserInvalidatorFactory
: public CertProvisioningInvalidatorFactory {
public:
explicit CertProvisioningUserInvalidatorFactory(Profile* profile);
std::unique_ptr<CertProvisioningInvalidator> Create() override;
private:
raw_ptr<Profile> profile_ = nullptr;
};
//=============== CertProvisioningUserInvalidator ==============================
class CertProvisioningUserInvalidator : public CertProvisioningInvalidator {
public:
explicit CertProvisioningUserInvalidator(Profile* profile);
void Register(
const std::string& listener_type,
OnInvalidationEventCallback on_invalidation_event_callback) override;
private:
raw_ptr<Profile> profile_ = nullptr;
};
//=============== CertProvisioningDeviceInvalidatorFactory =====================
// This factory creates CertProvisioningInvalidators that use the device-wide
// `InvalidationListener`.
class CertProvisioningDeviceInvalidatorFactory
: public CertProvisioningInvalidatorFactory {
public:
CertProvisioningDeviceInvalidatorFactory();
~CertProvisioningDeviceInvalidatorFactory() override;
explicit CertProvisioningDeviceInvalidatorFactory(
invalidation::InvalidationListener* invalidation__listener);
std::unique_ptr<CertProvisioningInvalidator> Create() override;
private:
raw_ptr<invalidation::InvalidationListener> invalidation_listener_;
};
//=============== CertProvisioningDeviceInvalidator ============================
class CertProvisioningDeviceInvalidator : public CertProvisioningInvalidator {
public:
explicit CertProvisioningDeviceInvalidator(
invalidation::InvalidationListener* invalidation_listener);
~CertProvisioningDeviceInvalidator() override;
void Register(
const std::string& listener_type,
OnInvalidationEventCallback on_invalidation_event_callback) override;
private:
std::string listener_type_;
OnInvalidationEventCallback on_invalidation_event_callback_;
raw_ptr<invalidation::InvalidationListener> invalidation_listener_;
};
} // namespace ash::cert_provisioning
#endif // CHROME_BROWSER_ASH_CERT_PROVISIONING_CERT_PROVISIONING_INVALIDATOR_H_
|
