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
|
// 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 COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_PROXY_CONFIG_DIRECT_FETCHER_H_
#define COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_PROXY_CONFIG_DIRECT_FETCHER_H_
#include <memory>
#include <optional>
#include <string>
#include <vector>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "base/types/expected.h"
#include "components/ip_protection/common/ip_protection_proxy_config_fetcher.h"
#include "components/ip_protection/get_proxy_config.pb.h"
#include "net/base/proxy_chain.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
class GURL;
namespace network {
class SimpleURLLoader;
} // namespace network
namespace ip_protection {
struct GeoHint;
// Manages fetching the proxy configuration from the server that is
// necessary for IP Protection.
//
// This class is responsible for using the retriever to get the proxy config,
// retrying if necessary, and creating the corresponding ProxyChain list and
// GeoHint.
class IpProtectionProxyConfigDirectFetcher
: public IpProtectionProxyConfigFetcher {
public:
// A delegate to support getting authenticating requests.
class Delegate {
public:
virtual ~Delegate() = default;
// Checks if getting proxy config is enabled (via user settings, policy,
// etc.).
virtual bool IsProxyConfigFetchEnabled() = 0;
// Callback made when `AuthenticateRequest` is done. The callback's boolean
// parameter is true on success, and false if the request should not be
// made. The `ResourceRequest` is the request passed to
// `AuthenticateCallback`, possibly modified to include authentication
// information.
using AuthenticateRequestCallback =
base::OnceCallback<void(bool,
std::unique_ptr<network::ResourceRequest>)>;
virtual void AuthenticateRequest(std::unique_ptr<network::ResourceRequest>,
AuthenticateRequestCallback) = 0;
};
// Retrieve proxy config from an HTTP server, abstracted to ease testing of
// the fetcher.
class Retriever {
public:
explicit Retriever(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
std::string service_type,
Delegate* delegate);
virtual ~Retriever();
using RetrieveCallback = base::OnceCallback<void(
base::expected<GetProxyConfigResponse, std::string>)>;
virtual void RetrieveProxyConfig(RetrieveCallback callback);
private:
void OnAuthenticatedResourceRequest(
RetrieveCallback callback,
bool success,
std::unique_ptr<network::ResourceRequest> resource_request);
void OnGetProxyConfigCompleted(
std::unique_ptr<network::SimpleURLLoader> url_loader,
RetrieveCallback callback,
std::optional<std::string> response);
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
const GURL ip_protection_server_url_;
const std::string ip_protection_server_get_proxy_config_path_;
const std::string service_type_;
raw_ptr<Delegate> delegate_;
base::WeakPtrFactory<Retriever> weak_ptr_factory_{this};
};
explicit IpProtectionProxyConfigDirectFetcher(
scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
std::string service_type,
Delegate* delegate);
explicit IpProtectionProxyConfigDirectFetcher(
std::unique_ptr<Retriever> retriever,
Delegate* delegate);
~IpProtectionProxyConfigDirectFetcher() override;
// IpProtectionProxyConfigFetcher implementation.
void GetProxyConfig(GetProxyConfigCallback callback) override;
// Shortcut to create a ProxyChain from hostnames for unit tests.
static net::ProxyChain MakeChainForTesting(
std::vector<std::string> hostnames,
int chain_id = net::ProxyChain::kDefaultIpProtectionChainId);
base::Time GetNoGetProxyConfigUntilTimeForTesting() {
return no_get_proxy_config_until_;
}
base::TimeDelta GetNextGetProxyConfigBackoffForTesting() {
return next_get_proxy_config_backoff_;
}
// The account status has changed, so the delegate's `AuthenticateRequest`
// behavior may change.
void AccountStatusChanged(bool account_available);
// Timeout for failures from GetProxyConfig. This is doubled for
// each subsequent failure.
static constexpr base::TimeDelta kGetProxyConfigFailureTimeout =
base::Minutes(1);
private:
// Reset the backoff settings to their default (no-error) state.
void ClearBackoffTimer();
void OnGetProxyConfigCompleted(
GetProxyConfigCallback callback,
base::expected<GetProxyConfigResponse, std::string> response);
// Returns true if the GetProxyConfigResponse contains an error or is invalid.
// In order for a response to be valid, the following must be true:
// 1. !response.has_value()
// 2. If a response has a value and the proxy chain is NOT empty and the
// GeoHint MUST be present.
bool IsProxyConfigResponseError(
const base::expected<GetProxyConfigResponse, std::string>& response);
// Creates a list of ProxyChains from GetProxyConfigResponse.
std::vector<net::ProxyChain> GetProxyListFromProxyConfigResponse(
GetProxyConfigResponse response);
// Creates a GeoHint by converting the GeoHint from the
// `GetProxyConfigResponse` to a `network::GeoHint`.
std::optional<GeoHint> GetGeoHintFromProxyConfigResponse(
GetProxyConfigResponse& response);
std::unique_ptr<Retriever> ip_protection_proxy_config_retriever_;
// The time before the retriever's GetProxyConfig should not be called, and
// the exponential backoff to be applied next time such a call fails.
base::Time no_get_proxy_config_until_;
base::TimeDelta next_get_proxy_config_backoff_ =
kGetProxyConfigFailureTimeout;
raw_ptr<Delegate> delegate_;
};
} // namespace ip_protection
#endif // COMPONENTS_IP_PROTECTION_COMMON_IP_PROTECTION_PROXY_CONFIG_DIRECT_FETCHER_H_
|
