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
207
208
209
210
211
|
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/variations/net/variations_http_headers.h"
#include <stddef.h>
#include <utility>
#include <vector>
#include "base/bind.h"
#include "base/feature_list.h"
#include "base/macros.h"
#include "base/metrics/histogram_macros.h"
#include "base/stl_util.h"
#include "base/strings/string_util.h"
#include "components/google/core/common/google_util.h"
#include "components/variations/net/omnibox_http_headers.h"
#include "components/variations/variations_http_header_provider.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "net/url_request/redirect_info.h"
#include "services/network/public/cpp/resource_request.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "services/network/public/mojom/url_response_head.mojom.h"
#include "url/gurl.h"
namespace variations {
namespace {
// The name string for the header for variations information.
// Note that prior to M33 this header was named X-Chrome-Variations.
const char kClientDataHeader[] = "X-Client-Data";
// The result of checking if a URL should have variations headers appended.
// This enum is used to record UMA histogram values, and should not be
// reordered.
enum URLValidationResult {
INVALID_URL,
NOT_HTTPS,
NOT_GOOGLE_DOMAIN,
SHOULD_APPEND,
NEITHER_HTTP_HTTPS,
IS_GOOGLE_NOT_HTTPS,
URL_VALIDATION_RESULT_SIZE,
};
void LogUrlValidationHistogram(URLValidationResult result) {
UMA_HISTOGRAM_ENUMERATION("Variations.Headers.URLValidationResult", result,
URL_VALIDATION_RESULT_SIZE);
}
bool ShouldAppendVariationsHeader(const GURL& url) {
if (!url.is_valid()) {
LogUrlValidationHistogram(INVALID_URL);
return false;
}
if (!url.SchemeIsHTTPOrHTTPS()) {
LogUrlValidationHistogram(NEITHER_HTTP_HTTPS);
return false;
}
if (!google_util::IsGoogleAssociatedDomainUrl(url)) {
LogUrlValidationHistogram(NOT_GOOGLE_DOMAIN);
return false;
}
// We check https here, rather than before the IsGoogleDomain() check, to know
// how many Google domains are being rejected by the change to https only.
if (!url.SchemeIs(url::kHttpsScheme)) {
LogUrlValidationHistogram(IS_GOOGLE_NOT_HTTPS);
return false;
}
LogUrlValidationHistogram(SHOULD_APPEND);
return true;
}
class VariationsHeaderHelper {
public:
// Note: It's OK to pass SignedIn::kNo if it's unknown, as it does not affect
// transmission of experiments coming from the variations server.
VariationsHeaderHelper(network::ResourceRequest* request,
SignedIn signed_in = SignedIn::kNo)
: VariationsHeaderHelper(request, CreateVariationsHeader(signed_in)) {}
VariationsHeaderHelper(network::ResourceRequest* resource_request,
std::string variations_header)
: resource_request_(resource_request) {
DCHECK(resource_request_);
variations_header_ = std::move(variations_header);
}
bool AppendHeaderIfNeeded(const GURL& url, InIncognito incognito) {
AppendOmniboxOnDeviceSuggestionsHeaderIfNeeded(url, resource_request_);
// Note the criteria for attaching client experiment headers:
// 1. We only transmit to Google owned domains which can evaluate
// experiments.
// 1a. These include hosts which have a standard postfix such as:
// *.doubleclick.net or *.googlesyndication.com or
// exactly www.googleadservices.com or
// international TLD domains *.google.<TLD> or *.youtube.<TLD>.
// 2. Only transmit for non-Incognito profiles.
// 3. For the X-Client-Data header, only include non-empty variation IDs.
if ((incognito == InIncognito::kYes) || !ShouldAppendVariationsHeader(url))
return false;
if (variations_header_.empty())
return false;
// Set the variations header to cors_exempt_headers rather than headers
// to be exempted from CORS checks.
resource_request_->cors_exempt_headers.SetHeaderIfMissing(
kClientDataHeader, variations_header_);
return true;
}
private:
static std::string CreateVariationsHeader(SignedIn signed_in) {
return VariationsHttpHeaderProvider::GetInstance()->GetClientDataHeader(
signed_in == SignedIn::kYes);
}
network::ResourceRequest* resource_request_;
std::string variations_header_;
DISALLOW_COPY_AND_ASSIGN(VariationsHeaderHelper);
};
} // namespace
bool AppendVariationsHeader(const GURL& url,
InIncognito incognito,
SignedIn signed_in,
network::ResourceRequest* request) {
return VariationsHeaderHelper(request, signed_in)
.AppendHeaderIfNeeded(url, incognito);
}
bool AppendVariationsHeaderWithCustomValue(const GURL& url,
InIncognito incognito,
const std::string& variations_header,
network::ResourceRequest* request) {
return VariationsHeaderHelper(request, variations_header)
.AppendHeaderIfNeeded(url, incognito);
}
bool AppendVariationsHeaderUnknownSignedIn(const GURL& url,
InIncognito incognito,
network::ResourceRequest* request) {
return VariationsHeaderHelper(request).AppendHeaderIfNeeded(url, incognito);
}
void RemoveVariationsHeaderIfNeeded(
const net::RedirectInfo& redirect_info,
const network::mojom::URLResponseHead& response_head,
std::vector<std::string>* to_be_removed_headers) {
if (!ShouldAppendVariationsHeader(redirect_info.new_url))
to_be_removed_headers->push_back(kClientDataHeader);
}
std::unique_ptr<network::SimpleURLLoader>
CreateSimpleURLLoaderWithVariationsHeader(
std::unique_ptr<network::ResourceRequest> request,
InIncognito incognito,
SignedIn signed_in,
const net::NetworkTrafficAnnotationTag& annotation_tag) {
bool variation_headers_added =
AppendVariationsHeader(request->url, incognito, signed_in, request.get());
std::unique_ptr<network::SimpleURLLoader> simple_url_loader =
network::SimpleURLLoader::Create(std::move(request), annotation_tag);
if (variation_headers_added) {
simple_url_loader->SetOnRedirectCallback(
base::BindRepeating(&RemoveVariationsHeaderIfNeeded));
}
return simple_url_loader;
}
std::unique_ptr<network::SimpleURLLoader>
CreateSimpleURLLoaderWithVariationsHeaderUnknownSignedIn(
std::unique_ptr<network::ResourceRequest> request,
InIncognito incognito,
const net::NetworkTrafficAnnotationTag& annotation_tag) {
return CreateSimpleURLLoaderWithVariationsHeader(
std::move(request), incognito, SignedIn::kNo, annotation_tag);
}
bool IsVariationsHeader(const std::string& header_name) {
return header_name == kClientDataHeader ||
header_name == kOmniboxOnDeviceSuggestionsHeader;
}
bool HasVariationsHeader(const network::ResourceRequest& request) {
// Note: kOmniboxOnDeviceSuggestionsHeader is not listed because this function
// is only used for testing.
return request.cors_exempt_headers.HasHeader(kClientDataHeader);
}
bool ShouldAppendVariationsHeaderForTesting(const GURL& url) {
return ShouldAppendVariationsHeader(url);
}
void UpdateCorsExemptHeaderForVariations(
network::mojom::NetworkContextParams* params) {
params->cors_exempt_header_list.push_back(kClientDataHeader);
if (base::FeatureList::IsEnabled(kReportOmniboxOnDeviceSuggestionsHeader)) {
params->cors_exempt_header_list.push_back(
kOmniboxOnDeviceSuggestionsHeader);
}
}
} // namespace variations
|
