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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
// 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/signin/ios/browser/account_consistency_service.h"
#include <WebKit/WebKit.h>
#import "base/ios/weak_nsobject.h"
#include "base/logging.h"
#import "base/mac/foundation_util.h"
#include "base/macros.h"
#include "base/strings/sys_string_conversions.h"
#include "components/google/core/browser/google_util.h"
#include "components/pref_registry/pref_registry_syncable.h"
#include "components/prefs/scoped_user_pref_update.h"
#include "components/signin/core/browser/account_reconcilor.h"
#include "components/signin/core/browser/signin_client.h"
#include "components/signin/core/browser/signin_header_helper.h"
#include "ios/web/public/browser_state.h"
#include "ios/web/public/web_state/web_state_policy_decider.h"
#include "ios/web/public/web_view_creation_util.h"
#include "net/base/mac/url_conversions.h"
#include "net/base/registry_controlled_domains/registry_controlled_domain.h"
#include "url/gurl.h"
namespace {
// Threshold (in hours) used to control whether the CHROME_CONNECTED cookie
// should be added again on a domain it was previously set.
const int kHoursThresholdToReAddCookie = 24;
// JavaScript template used to set (or delete) the CHROME_CONNECTED cookie.
// It takes 3 arguments: the domain of the cookie, its value and its expiration
// date. It also clears the legacy X-CHROME-CONNECTED cookie.
NSString* const kChromeConnectedCookieTemplate =
@"<html><script>domain=\"%@\";"
"document.cookie=\"X-CHROME-CONNECTED=; path=/; domain=\" + domain + \";"
" expires=Thu, 01-Jan-1970 00:00:01 GMT\";"
"document.cookie=\"CHROME_CONNECTED=%@; path=/; domain=\" + domain + \";"
" expires=\" + new Date(%f).toGMTString() + \"; secure;\"</script></html>";
// WebStatePolicyDecider that monitors the HTTP headers on Gaia responses,
// reacting on the X-Chrome-Manage-Accounts header and notifying its delegate.
// It also notifies the AccountConsistencyService of domains it should add the
// CHROME_CONNECTED cookie to.
class AccountConsistencyHandler : public web::WebStatePolicyDecider {
public:
AccountConsistencyHandler(web::WebState* web_state,
AccountConsistencyService* service,
AccountReconcilor* account_reconcilor,
id<ManageAccountsDelegate> delegate);
private:
// web::WebStatePolicyDecider override
bool ShouldAllowResponse(NSURLResponse* response) override;
void WebStateDestroyed() override;
AccountConsistencyService* account_consistency_service_; // Weak.
AccountReconcilor* account_reconcilor_; // Weak.
base::WeakNSProtocol<id<ManageAccountsDelegate>> delegate_;
};
}
AccountConsistencyHandler::AccountConsistencyHandler(
web::WebState* web_state,
AccountConsistencyService* service,
AccountReconcilor* account_reconcilor,
id<ManageAccountsDelegate> delegate)
: web::WebStatePolicyDecider(web_state),
account_consistency_service_(service),
account_reconcilor_(account_reconcilor),
delegate_(delegate) {}
bool AccountConsistencyHandler::ShouldAllowResponse(NSURLResponse* response) {
NSHTTPURLResponse* http_response =
base::mac::ObjCCast<NSHTTPURLResponse>(response);
if (!http_response)
return true;
GURL url = net::GURLWithNSURL(http_response.URL);
if (google_util::IsGoogleDomainUrl(
url, google_util::ALLOW_SUBDOMAIN,
google_util::DISALLOW_NON_STANDARD_PORTS)) {
// User is showing intent to navigate to a Google domain. Add the
// CHROME_CONNECTED cookie to the domain if necessary.
std::string domain = net::registry_controlled_domains::GetDomainAndRegistry(
url, net::registry_controlled_domains::EXCLUDE_PRIVATE_REGISTRIES);
account_consistency_service_->AddChromeConnectedCookieToDomain(
domain, true /* force_update_if_too_old */);
account_consistency_service_->AddChromeConnectedCookieToDomain(
"google.com", true /* force_update_if_too_old */);
}
if (!gaia::IsGaiaSignonRealm(url.GetOrigin()))
return true;
NSString* manage_accounts_header = [[http_response allHeaderFields]
objectForKey:@"X-Chrome-Manage-Accounts"];
if (!manage_accounts_header)
return true;
signin::ManageAccountsParams params = signin::BuildManageAccountsParams(
base::SysNSStringToUTF8(manage_accounts_header));
account_reconcilor_->OnReceivedManageAccountsResponse(params.service_type);
switch (params.service_type) {
case signin::GAIA_SERVICE_TYPE_INCOGNITO: {
GURL continue_url = GURL(params.continue_url);
DLOG_IF(ERROR, !params.continue_url.empty() && !continue_url.is_valid())
<< "Invalid continuation URL: \"" << continue_url << "\"";
[delegate_ onGoIncognito:continue_url];
break;
}
case signin::GAIA_SERVICE_TYPE_SIGNUP:
case signin::GAIA_SERVICE_TYPE_ADDSESSION:
[delegate_ onAddAccount];
break;
case signin::GAIA_SERVICE_TYPE_SIGNOUT:
case signin::GAIA_SERVICE_TYPE_REAUTH:
case signin::GAIA_SERVICE_TYPE_DEFAULT:
[delegate_ onManageAccounts];
break;
case signin::GAIA_SERVICE_TYPE_NONE:
NOTREACHED();
break;
}
// WKWebView loads a blank page even if the response code is 204
// ("No Content"). http://crbug.com/368717
//
// Manage accounts responses are handled via native UI. Abort this request
// for the following reasons:
// * Avoid loading a blank page in WKWebView.
// * Avoid adding this request to history.
return false;
}
void AccountConsistencyHandler::WebStateDestroyed() {
account_consistency_service_->RemoveWebStateHandler(web_state());
}
// WKWebView navigation delegate that calls its callback every time a navigation
// has finished.
@interface AccountConsistencyNavigationDelegate : NSObject<WKNavigationDelegate>
// Designated initializer. |callback| will be called every time a navigation has
// finished. |callback| must not be empty.
- (instancetype)initWithCallback:(const base::Closure&)callback
NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
@end
@implementation AccountConsistencyNavigationDelegate {
// Callback that will be called every time a navigation has finished.
base::Closure _callback;
}
- (instancetype)initWithCallback:(const base::Closure&)callback {
self = [super init];
if (self) {
DCHECK(!callback.is_null());
_callback = callback;
}
return self;
}
- (instancetype)init {
NOTREACHED();
return nil;
}
#pragma mark - WKNavigationDelegate
- (void)webView:(WKWebView*)webView
didFinishNavigation:(WKNavigation*)navigation {
_callback.Run();
}
@end
const char AccountConsistencyService::kDomainsWithCookiePref[] =
"signin.domains_with_cookie";
AccountConsistencyService::CookieRequest
AccountConsistencyService::CookieRequest::CreateAddCookieRequest(
const std::string& domain) {
AccountConsistencyService::CookieRequest cookie_request;
cookie_request.request_type = ADD_CHROME_CONNECTED_COOKIE;
cookie_request.domain = domain;
return cookie_request;
}
AccountConsistencyService::CookieRequest
AccountConsistencyService::CookieRequest::CreateRemoveCookieRequest(
const std::string& domain) {
AccountConsistencyService::CookieRequest cookie_request;
cookie_request.request_type = REMOVE_CHROME_CONNECTED_COOKIE;
cookie_request.domain = domain;
return cookie_request;
}
AccountConsistencyService::AccountConsistencyService(
web::BrowserState* browser_state,
AccountReconcilor* account_reconcilor,
scoped_refptr<content_settings::CookieSettings> cookie_settings,
GaiaCookieManagerService* gaia_cookie_manager_service,
SigninClient* signin_client,
SigninManager* signin_manager)
: browser_state_(browser_state),
account_reconcilor_(account_reconcilor),
cookie_settings_(cookie_settings),
gaia_cookie_manager_service_(gaia_cookie_manager_service),
signin_client_(signin_client),
signin_manager_(signin_manager),
applying_cookie_requests_(false) {
gaia_cookie_manager_service_->AddObserver(this);
signin_manager_->AddObserver(this);
web::BrowserState::GetActiveStateManager(browser_state_)->AddObserver(this);
LoadFromPrefs();
if (signin_manager_->IsAuthenticated()) {
AddChromeConnectedCookies();
} else {
RemoveChromeConnectedCookies();
}
}
AccountConsistencyService::~AccountConsistencyService() {
DCHECK(!web_view_);
DCHECK(!navigation_delegate_);
}
// static
void AccountConsistencyService::RegisterPrefs(
user_prefs::PrefRegistrySyncable* registry) {
registry->RegisterDictionaryPref(
AccountConsistencyService::kDomainsWithCookiePref);
}
void AccountConsistencyService::SetWebStateHandler(
web::WebState* web_state,
id<ManageAccountsDelegate> delegate) {
DCHECK_EQ(0u, web_state_handlers_.count(web_state));
web_state_handlers_[web_state].reset(new AccountConsistencyHandler(
web_state, this, account_reconcilor_, delegate));
}
void AccountConsistencyService::RemoveWebStateHandler(
web::WebState* web_state) {
DCHECK_LT(0u, web_state_handlers_.count(web_state));
web_state_handlers_.erase(web_state);
}
bool AccountConsistencyService::ShouldAddChromeConnectedCookieToDomain(
const std::string& domain,
bool force_update_if_too_old) {
auto it = last_cookie_update_map_.find(domain);
if (it == last_cookie_update_map_.end()) {
// |domain| isn't in the map, always add the cookie.
return true;
}
if (!force_update_if_too_old) {
// |domain| is in the map and the cookie is considered valid. Don't add it
// again.
return false;
}
return (base::Time::Now() - it->second) >
base::TimeDelta::FromHours(kHoursThresholdToReAddCookie);
}
void AccountConsistencyService::AddChromeConnectedCookieToDomain(
const std::string& domain,
bool force_update_if_too_old) {
if (!ShouldAddChromeConnectedCookieToDomain(domain,
force_update_if_too_old)) {
return;
}
last_cookie_update_map_[domain] = base::Time::Now();
cookie_requests_.push_back(CookieRequest::CreateAddCookieRequest(domain));
ApplyCookieRequests();
}
void AccountConsistencyService::RemoveChromeConnectedCookieFromDomain(
const std::string& domain) {
if (last_cookie_update_map_.count(domain) == 0) {
// Cookie is not on the domain. Nothing to do.
return;
}
last_cookie_update_map_.erase(domain);
cookie_requests_.push_back(CookieRequest::CreateRemoveCookieRequest(domain));
ApplyCookieRequests();
}
void AccountConsistencyService::LoadFromPrefs() {
const base::DictionaryValue* dict =
signin_client_->GetPrefs()->GetDictionary(kDomainsWithCookiePref);
for (base::DictionaryValue::Iterator it(*dict); !it.IsAtEnd(); it.Advance()) {
last_cookie_update_map_[it.key()] = base::Time();
}
}
void AccountConsistencyService::Shutdown() {
gaia_cookie_manager_service_->RemoveObserver(this);
signin_manager_->RemoveObserver(this);
web::BrowserState::GetActiveStateManager(browser_state_)
->RemoveObserver(this);
ResetWKWebView();
web_state_handlers_.clear();
}
void AccountConsistencyService::ApplyCookieRequests() {
if (applying_cookie_requests_) {
// A cookie request is already being applied, the following ones will be
// handled as soon as the current one is done.
return;
}
if (cookie_requests_.empty()) {
return;
}
if (!web::BrowserState::GetActiveStateManager(browser_state_)->IsActive()) {
// Web view usage isn't active for now, ignore cookie requests for now and
// wait to be notified that it became active again.
return;
}
applying_cookie_requests_ = true;
const GURL url("https://" + cookie_requests_.front().domain);
std::string cookie_value = "";
// Expiration date of the cookie in the JavaScript convention of time, a
// number of milliseconds since the epoch.
double expiration_date = 0;
switch (cookie_requests_.front().request_type) {
case ADD_CHROME_CONNECTED_COOKIE:
cookie_value = signin::BuildMirrorRequestCookieIfPossible(
url, signin_manager_->GetAuthenticatedAccountInfo().gaia,
cookie_settings_.get(), signin::PROFILE_MODE_DEFAULT);
if (cookie_value.empty()) {
// Don't add the cookie. Tentatively correct |last_cookie_update_map_|.
last_cookie_update_map_.erase(cookie_requests_.front().domain);
FinishedApplyingCookieRequest(false);
return;
}
// Create expiration date of Now+2y to roughly follow the APISID cookie.
expiration_date =
(base::Time::Now() + base::TimeDelta::FromDays(730)).ToJsTime();
break;
case REMOVE_CHROME_CONNECTED_COOKIE:
// Nothing to do. Default values correspond to removing the cookie (no
// value, expiration date in the past).
break;
}
NSString* html = [NSString
stringWithFormat:kChromeConnectedCookieTemplate,
base::SysUTF8ToNSString(url.host()),
base::SysUTF8ToNSString(cookie_value), expiration_date];
// Load an HTML string with embedded JavaScript that will set or remove the
// cookie. By setting the base URL to |url|, this effectively allows to modify
// cookies on the correct domain without having to do a network request.
[GetWKWebView() loadHTMLString:html baseURL:net::NSURLWithGURL(url)];
}
void AccountConsistencyService::FinishedApplyingCookieRequest(bool success) {
DCHECK(!cookie_requests_.empty());
if (success) {
const CookieRequest& request = cookie_requests_.front();
DictionaryPrefUpdate update(
signin_client_->GetPrefs(),
AccountConsistencyService::kDomainsWithCookiePref);
switch (request.request_type) {
case ADD_CHROME_CONNECTED_COOKIE:
// Add request.domain to prefs, use |true| as a dummy value (that is
// never used), as the dictionary is used as a set.
update->SetBooleanWithoutPathExpansion(request.domain, true);
break;
case REMOVE_CHROME_CONNECTED_COOKIE:
// Remove request.domain from prefs.
update->RemoveWithoutPathExpansion(request.domain, nullptr);
break;
}
}
cookie_requests_.pop_front();
applying_cookie_requests_ = false;
ApplyCookieRequests();
}
WKWebView* AccountConsistencyService::GetWKWebView() {
if (!web::BrowserState::GetActiveStateManager(browser_state_)->IsActive()) {
// |browser_state_| is not active, WKWebView linked to this browser state
// should not exist or be created.
return nil;
}
if (!web_view_) {
web_view_.reset(CreateWKWebView());
navigation_delegate_.reset([[AccountConsistencyNavigationDelegate alloc]
initWithCallback:base::Bind(&AccountConsistencyService::
FinishedApplyingCookieRequest,
base::Unretained(this), true)]);
[web_view_ setNavigationDelegate:navigation_delegate_];
}
return web_view_.get();
}
WKWebView* AccountConsistencyService::CreateWKWebView() {
return web::CreateWKWebView(CGRectZero, browser_state_);
}
void AccountConsistencyService::ResetWKWebView() {
[web_view_ setNavigationDelegate:nil];
[web_view_ stopLoading];
web_view_.reset();
navigation_delegate_.reset();
applying_cookie_requests_ = false;
}
void AccountConsistencyService::AddChromeConnectedCookies() {
DCHECK(!browser_state_->IsOffTheRecord());
// These cookie request are preventive and not a strong signal (unlike
// navigation to a domain). Don't force update the old cookies in this case.
AddChromeConnectedCookieToDomain("google.com",
false /* force_update_if_too_old */);
AddChromeConnectedCookieToDomain("youtube.com",
false /* force_update_if_too_old */);
}
void AccountConsistencyService::RemoveChromeConnectedCookies() {
DCHECK(!browser_state_->IsOffTheRecord());
std::map<std::string, base::Time> last_cookie_update_map =
last_cookie_update_map_;
for (const auto& domain : last_cookie_update_map) {
RemoveChromeConnectedCookieFromDomain(domain.first);
}
}
void AccountConsistencyService::OnBrowsingDataRemoved() {
// CHROME_CONNECTED cookies have been removed, update internal state
// accordingly.
ResetWKWebView();
cookie_requests_.clear();
last_cookie_update_map_.clear();
base::DictionaryValue dict;
signin_client_->GetPrefs()->Set(kDomainsWithCookiePref, dict);
// APISID cookie has been removed, notify the GCMS.
gaia_cookie_manager_service_->ForceOnCookieChangedProcessing();
}
void AccountConsistencyService::OnAddAccountToCookieCompleted(
const std::string& account_id,
const GoogleServiceAuthError& error) {
AddChromeConnectedCookies();
}
void AccountConsistencyService::OnGaiaAccountsInCookieUpdated(
const std::vector<gaia::ListedAccount>& accounts,
const std::vector<gaia::ListedAccount>& signed_out_accounts,
const GoogleServiceAuthError& error) {
AddChromeConnectedCookies();
}
void AccountConsistencyService::GoogleSigninSucceeded(
const std::string& account_id,
const std::string& username,
const std::string& password) {
AddChromeConnectedCookies();
}
void AccountConsistencyService::GoogleSignedOut(const std::string& account_id,
const std::string& username) {
RemoveChromeConnectedCookies();
}
void AccountConsistencyService::OnActive() {
// |browser_state_| is now active. There might be some pending cookie requests
// to apply.
ApplyCookieRequests();
}
void AccountConsistencyService::OnInactive() {
// |browser_state_| is now inactive. Stop using |web_view_| and don't create
// a new one until it is active.
ResetWKWebView();
}
|
