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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/webid/federated_auth_user_info_request.h"
#include "base/functional/callback.h"
#include "base/metrics/histogram_functions.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/browser/webid/federated_auth_request_page_data.h"
#include "content/browser/webid/flags.h"
#include "content/browser/webid/webid_utils.h"
#include "content/public/browser/federated_identity_api_permission_context_delegate.h"
#include "content/public/browser/federated_identity_permission_context_delegate.h"
#include "content/public/browser/render_frame_host.h"
#include "services/network/public/cpp/is_potentially_trustworthy.h"
#include "third_party/blink/public/mojom/webid/federated_auth_request.mojom.h"
#include "url/origin.h"
#include "url/url_constants.h"
namespace content {
namespace {
std::string GetConsoleErrorMessage(FederatedAuthUserInfoRequestResult error) {
switch (error) {
case FederatedAuthUserInfoRequestResult::kNotSameOrigin: {
return "getUserInfo() caller is not same origin as the config URL.";
}
case FederatedAuthUserInfoRequestResult::kNotIframe: {
return "getUserInfo() caller is not an iframe.";
}
case FederatedAuthUserInfoRequestResult::kNotPotentiallyTrustworthy: {
return "getUserInfo() failed because the config URL is not potentially "
"trustworthy.";
}
case FederatedAuthUserInfoRequestResult::kNoApiPermission: {
return "getUserInfo() is disabled because FedCM is disabled.";
}
case FederatedAuthUserInfoRequestResult::kNotSignedInWithIdp: {
return "getUserInfo() is disabled because the IDP Sign-In Status is "
"signed-out.";
}
case FederatedAuthUserInfoRequestResult::kNoAccountSharingPermission: {
return "getUserInfo() failed because the user has not yet used FedCM on "
"this site with the provided IDP.";
}
case FederatedAuthUserInfoRequestResult::kInvalidConfigOrWellKnown: {
return "getUserInfo() failed because the config and well-known files "
"were invalid.";
}
case FederatedAuthUserInfoRequestResult::kInvalidAccountsResponse: {
return "getUserInfo() failed because of an invalid accounts response.";
}
case FederatedAuthUserInfoRequestResult::
kNoReturningUserFromFetchedAccounts: {
return "getUserInfo() failed because no account received was a returning "
"account.";
}
case FederatedAuthUserInfoRequestResult::kUnhandledRequest:
case FederatedAuthUserInfoRequestResult::kSuccess: {
NOTREACHED();
}
}
}
} // namespace
using FederatedApiPermissionStatus =
FederatedIdentityApiPermissionContextDelegate::PermissionStatus;
using LoginState = IdentityRequestAccount::LoginState;
// static
std::unique_ptr<FederatedAuthUserInfoRequest>
FederatedAuthUserInfoRequest::Create(
std::unique_ptr<IdpNetworkRequestManager> network_manager,
FederatedIdentityPermissionContextDelegate* permission_delegate,
FederatedIdentityApiPermissionContextDelegate* api_permission_delegate,
RenderFrameHost* render_frame_host,
blink::mojom::IdentityProviderConfigPtr provider) {
std::unique_ptr<FederatedAuthUserInfoRequest> request =
base::WrapUnique<FederatedAuthUserInfoRequest>(
new FederatedAuthUserInfoRequest(
std::move(network_manager), permission_delegate,
api_permission_delegate, render_frame_host, std::move(provider)));
return request;
}
FederatedAuthUserInfoRequest::~FederatedAuthUserInfoRequest() {
CompleteWithError(FederatedAuthUserInfoRequestResult::kUnhandledRequest);
}
FederatedAuthUserInfoRequest::FederatedAuthUserInfoRequest(
std::unique_ptr<IdpNetworkRequestManager> network_manager,
FederatedIdentityPermissionContextDelegate* permission_delegate,
FederatedIdentityApiPermissionContextDelegate* api_permission_delegate,
RenderFrameHost* render_frame_host,
blink::mojom::IdentityProviderConfigPtr provider)
: network_manager_(std::move(network_manager)),
permission_delegate_(permission_delegate),
api_permission_delegate_(api_permission_delegate),
render_frame_host_(render_frame_host),
client_id_(provider->client_id),
idp_config_url_(provider->config_url),
origin_(render_frame_host->GetLastCommittedOrigin()) {
RenderFrameHost* main_frame = render_frame_host->GetMainFrame();
DCHECK(main_frame->IsInPrimaryMainFrame());
embedding_origin_ = main_frame->GetLastCommittedOrigin();
RenderFrameHost* parent_frame = render_frame_host->GetParentOrOuterDocument();
parent_frame_origin_ =
parent_frame ? parent_frame->GetLastCommittedOrigin() : url::Origin();
}
void FederatedAuthUserInfoRequest::SetCallbackAndStart(
blink::mojom::FederatedAuthRequest::RequestUserInfoCallback callback) {
callback_ = std::move(callback);
request_start_time_ = base::TimeTicks::Now();
// Renderer also checks that the origin is same origin with `idp_config_url_`.
// The check is duplicated in case that the renderer is compromised.
if (!origin_.IsSameOriginWith(idp_config_url_)) {
CompleteWithError(FederatedAuthUserInfoRequestResult::kNotSameOrigin);
return;
}
// Check that `render_frame_host` is for an iframe.
if (!parent_frame_origin_.GetURL().is_valid()) {
CompleteWithError(FederatedAuthUserInfoRequestResult::kNotIframe);
return;
}
url::Origin idp_origin = url::Origin::Create(idp_config_url_);
if (!network::IsOriginPotentiallyTrustworthy(idp_origin)) {
CompleteWithError(
FederatedAuthUserInfoRequestResult::kNotPotentiallyTrustworthy);
return;
}
FederatedApiPermissionStatus permission_status =
api_permission_delegate_->GetApiPermissionStatus(embedding_origin_);
if (permission_status != FederatedApiPermissionStatus::GRANTED) {
CompleteWithError(FederatedAuthUserInfoRequestResult::kNoApiPermission);
return;
}
if (webid::ShouldFailAccountsEndpointRequestBecauseNotSignedInWithIdp(
*render_frame_host_, idp_config_url_, permission_delegate_)) {
CompleteWithError(FederatedAuthUserInfoRequestResult::kNotSignedInWithIdp);
return;
}
if (!webid::HasSharingPermissionOrIdpHasThirdPartyCookiesAccess(
*render_frame_host_, idp_config_url_, embedding_origin_,
parent_frame_origin_, /*account_id=*/std::nullopt,
permission_delegate_, api_permission_delegate_)) {
// If there is no sharing permission or the IdP does not have third party
// cookies access, we can abort before performing any fetch.
CompleteWithError(
FederatedAuthUserInfoRequestResult::kNoAccountSharingPermission);
return;
}
// FedCmConfigFetcher is stored as a member so that it is destroyed when
// FederatedAuthRequestImpl is destroyed.
config_fetcher_ = std::make_unique<FedCmConfigFetcher>(
*render_frame_host_, network_manager_.get());
// TODO(crbug.com/390626180): It seems ok to ignore the well-known checks in
// all cases here. However, keeping this unchanged for now when the IDP
// registration API is not enabled since we only really need this for that
// case.
config_fetcher_->Start(
{{idp_config_url_, IsFedCmIdPRegistrationEnabled()}},
blink::mojom::RpMode::kPassive, /*icon_ideal_size=*/0,
/*icon_minimum_size=*/0,
base::BindOnce(
&FederatedAuthUserInfoRequest::OnAllConfigAndWellKnownFetched,
weak_ptr_factory_.GetWeakPtr()));
}
void FederatedAuthUserInfoRequest::OnAllConfigAndWellKnownFetched(
std::vector<FedCmConfigFetcher::FetchResult> fetch_results) {
config_fetcher_.reset();
if (fetch_results.size() != 1u) {
// This could happen when the user info request was sent from a compromised
// renderer (>1) or fetch_results is empty (<1).
CompleteWithError(
FederatedAuthUserInfoRequestResult::kInvalidConfigOrWellKnown);
return;
}
if (fetch_results[0].error) {
CompleteWithError(
FederatedAuthUserInfoRequestResult::kInvalidConfigOrWellKnown);
return;
}
// Make sure that we don't fetch accounts if the IDP sign-in bit is reset to
// false during the API call. e.g. by the login/logout HEADER.
does_idp_have_failing_signin_status_ =
webid::ShouldFailAccountsEndpointRequestBecauseNotSignedInWithIdp(
*render_frame_host_, idp_config_url_, permission_delegate_);
if (does_idp_have_failing_signin_status_) {
CompleteWithError(FederatedAuthUserInfoRequestResult::kNotSignedInWithIdp);
return;
}
network_manager_->SendAccountsRequest(
url::Origin::Create(idp_config_url_), fetch_results[0].endpoints.accounts,
client_id_,
base::BindOnce(&FederatedAuthUserInfoRequest::OnAccountsResponseReceived,
weak_ptr_factory_.GetWeakPtr()));
}
void FederatedAuthUserInfoRequest::OnAccountsResponseReceived(
IdpNetworkRequestManager::FetchStatus fetch_status,
std::vector<IdentityRequestAccountPtr> accounts) {
webid::UpdateIdpSigninStatusForAccountsEndpointResponse(
*render_frame_host_, idp_config_url_, fetch_status,
does_idp_have_failing_signin_status_, permission_delegate_);
if (fetch_status.parse_status !=
IdpNetworkRequestManager::ParseStatus::kSuccess) {
CompleteWithError(
FederatedAuthUserInfoRequestResult::kInvalidAccountsResponse);
return;
}
webid::GetPageData(render_frame_host_->GetPage())
->SetUserInfoAccountsResponseTime(idp_config_url_,
base::TimeTicks::Now());
// Populate the accounts login state.
for (auto& account : accounts) {
// We set the login state based on the IDP response if it sends
// back an approved_clients list. If it does not, we need to set
// it here based on browser state.
if (account->login_state) {
continue;
}
LoginState login_state = LoginState::kSignUp;
// Consider this a sign-in if we have seen a successful sign-up for
// this account before.
if (permission_delegate_->GetLastUsedTimestamp(
parent_frame_origin_, embedding_origin_,
url::Origin::Create(idp_config_url_), account->id)) {
login_state = LoginState::kSignIn;
}
account->login_state = login_state;
}
MaybeReturnAccounts(std::move(accounts));
}
void FederatedAuthUserInfoRequest::MaybeReturnAccounts(
const std::vector<IdentityRequestAccountPtr>& accounts) {
DCHECK(!accounts.empty());
bool has_returning_accounts = false;
for (const auto& account : accounts) {
if (IsReturningAccount(*account)) {
has_returning_accounts = true;
break;
}
}
FedCmMetrics::NumAccounts num_accounts = FedCmMetrics::NumAccounts::kZero;
if (has_returning_accounts) {
num_accounts = accounts.size() == 1u ? FedCmMetrics::NumAccounts::kOne
: FedCmMetrics::NumAccounts::kMultiple;
}
base::UmaHistogramEnumeration("Blink.FedCm.UserInfo.NumAccounts",
num_accounts);
base::UmaHistogramMediumTimes("Blink.FedCm.UserInfo.TimeToRequestCompleted",
base::TimeTicks::Now() - request_start_time_);
if (!has_returning_accounts) {
CompleteWithError(FederatedAuthUserInfoRequestResult::
kNoReturningUserFromFetchedAccounts);
return;
}
// The user previously accepted the FedCM prompt for one of the returned IdP
// accounts. Return data for all the IdP accounts.
std::vector<blink::mojom::IdentityUserInfoPtr> user_info;
std::vector<blink::mojom::IdentityUserInfoPtr> not_returning_accounts;
for (const auto& account : accounts) {
if (IsReturningAccount(*account)) {
user_info.push_back(blink::mojom::IdentityUserInfo::New(
account->email, account->given_name, account->name,
account->picture.spec()));
} else {
not_returning_accounts.push_back(blink::mojom::IdentityUserInfo::New(
account->email, account->given_name, account->name,
account->picture.spec()));
}
}
user_info.insert(user_info.end(),
std::make_move_iterator(not_returning_accounts.begin()),
std::make_move_iterator(not_returning_accounts.end()));
Complete(blink::mojom::RequestUserInfoStatus::kSuccess, std::move(user_info),
FederatedAuthUserInfoRequestResult::kSuccess);
}
bool FederatedAuthUserInfoRequest::IsReturningAccount(
const IdentityRequestAccount& account) {
// The |login_state| will only be |kSignUp| if IDP provides an
// |approved_clients| AND the client id is NOT on the |approved_clients|
// list, in which case we trust the IDP that we should treat the user as a
// new user and shouldn't return the user info. This should override browser
// local stored permission since a user can revoke their account out of
// band.
if (account.login_state == LoginState::kSignUp) {
return false;
}
return webid::HasSharingPermissionOrIdpHasThirdPartyCookiesAccess(
*render_frame_host_, idp_config_url_, embedding_origin_,
parent_frame_origin_, account.id, permission_delegate_,
api_permission_delegate_);
}
void FederatedAuthUserInfoRequest::Complete(
blink::mojom::RequestUserInfoStatus status,
std::optional<std::vector<blink::mojom::IdentityUserInfoPtr>> user_info,
FederatedAuthUserInfoRequestResult request_status) {
if (!callback_) {
return;
}
base::UmaHistogramEnumeration("Blink.FedCm.UserInfo.Status", request_status);
std::move(callback_).Run(status, std::move(user_info));
}
void FederatedAuthUserInfoRequest::CompleteWithError(
FederatedAuthUserInfoRequestResult error) {
// Do not add a console error for an unhandled request: the RenderFrameHost
// may have been destroyed.
if (error != FederatedAuthUserInfoRequestResult::kUnhandledRequest) {
render_frame_host_->AddMessageToConsole(
blink::mojom::ConsoleMessageLevel::kError,
GetConsoleErrorMessage(error));
AddDevToolsIssue(error);
}
Complete(blink::mojom::RequestUserInfoStatus::kError, std::nullopt, error);
}
void FederatedAuthUserInfoRequest::AddDevToolsIssue(
FederatedAuthUserInfoRequestResult error) {
DCHECK_NE(error, FederatedAuthUserInfoRequestResult::kSuccess);
auto details = blink::mojom::InspectorIssueDetails::New();
auto federated_auth_user_info_request_details =
blink::mojom::FederatedAuthUserInfoRequestIssueDetails::New(error);
details->federated_auth_user_info_request_details =
std::move(federated_auth_user_info_request_details);
render_frame_host_->ReportInspectorIssue(
blink::mojom::InspectorIssueInfo::New(
blink::mojom::InspectorIssueCode::kFederatedAuthUserInfoRequestIssue,
std::move(details)));
}
} // namespace content
|