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
|
// Copyright 2022 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/fedcm_config_fetcher.h"
#include "base/check.h"
#include "content/browser/webid/flags.h"
#include "content/browser/webid/webid_utils.h"
#include "net/base/schemeful_site.h"
#include "third_party/blink/public/mojom/devtools/console_message.mojom-shared.h"
#include "ui/gfx/color_utils.h"
namespace content {
namespace {
// Maximum number of provider URLs in the well-known file.
// TODO(cbiesinger): Determine what the right number is.
static constexpr size_t kMaxProvidersInWellKnownFile = 1ul;
void SetError(FedCmConfigFetcher::FetchResult& fetch_result,
blink::mojom::FederatedAuthRequestResult result,
content::FedCmRequestIdTokenStatus token_status,
std::optional<std::string> additional_console_error_message) {
fetch_result.error = FedCmConfigFetcher::FetchError(
result, token_status, additional_console_error_message);
}
} // namespace
using blink::mojom::FederatedAuthRequestResult;
using TokenStatus = FedCmRequestIdTokenStatus;
FedCmConfigFetcher::FetchError::FetchError(const FetchError&) = default;
FedCmConfigFetcher::FetchError::FetchError(
blink::mojom::FederatedAuthRequestResult result,
FedCmRequestIdTokenStatus token_status,
std::optional<std::string> additional_console_error_message)
: result(result),
token_status(token_status),
additional_console_error_message(
std::move(additional_console_error_message)) {}
FedCmConfigFetcher::FetchError::~FetchError() = default;
FedCmConfigFetcher::FetchResult::FetchResult() = default;
FedCmConfigFetcher::FetchResult::FetchResult(const FetchResult&) = default;
FedCmConfigFetcher::FetchResult::~FetchResult() = default;
FedCmConfigFetcher::FedCmConfigFetcher(
RenderFrameHost& render_frame_host,
IdpNetworkRequestManager* network_manager)
: render_frame_host_(render_frame_host),
network_manager_(network_manager) {}
FedCmConfigFetcher::~FedCmConfigFetcher() = default;
void FedCmConfigFetcher::Start(
const std::vector<FetchRequest>& requested_providers,
blink::mojom::RpMode rp_mode,
int icon_ideal_size,
int icon_minimum_size,
RequesterCallback callback) {
callback_ = std::move(callback);
for (const auto& request : requested_providers) {
FetchResult fetch_result;
fetch_result.identity_provider_config_url =
request.identity_provider_config_url;
fetch_result.force_skip_well_known_enforcement =
request.force_skip_well_known_enforcement;
fetch_results_.push_back(std::move(fetch_result));
pending_well_known_fetches_.insert(request.identity_provider_config_url);
pending_config_fetches_.insert(request.identity_provider_config_url);
}
// In a separate loop to avoid invalidating references when adding elements to
// `fetch_results_`.
for (FetchResult& fetch_result : fetch_results_) {
network_manager_->FetchWellKnown(
fetch_result.identity_provider_config_url,
base::BindOnce(&FedCmConfigFetcher::OnWellKnownFetched,
weak_ptr_factory_.GetWeakPtr(), std::ref(fetch_result)));
network_manager_->FetchConfig(
fetch_result.identity_provider_config_url, rp_mode, icon_ideal_size,
icon_minimum_size,
base::BindOnce(&FedCmConfigFetcher::OnConfigFetched,
weak_ptr_factory_.GetWeakPtr(), std::ref(fetch_result)));
}
}
void FedCmConfigFetcher::OnWellKnownFetched(
FetchResult& fetch_result,
IdpNetworkRequestManager::FetchStatus status,
const IdpNetworkRequestManager::WellKnown& well_known) {
pending_well_known_fetches_.erase(fetch_result.identity_provider_config_url);
constexpr char kWellKnownFileStr[] = "well-known file";
if (status.parse_status != IdpNetworkRequestManager::ParseStatus::kSuccess &&
!ShouldSkipWellKnownEnforcementForIdp(fetch_result)) {
std::optional<std::string> additional_console_error_message =
webid::ComputeConsoleMessageForHttpResponseCode(kWellKnownFileStr,
status.response_code);
switch (status.parse_status) {
case IdpNetworkRequestManager::ParseStatus::kHttpNotFoundError: {
OnError(fetch_result,
FederatedAuthRequestResult::kWellKnownHttpNotFound,
TokenStatus::kWellKnownHttpNotFound,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kNoResponseError: {
OnError(fetch_result, FederatedAuthRequestResult::kWellKnownNoResponse,
TokenStatus::kWellKnownNoResponse,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kInvalidResponseError: {
OnError(fetch_result,
FederatedAuthRequestResult::kWellKnownInvalidResponse,
TokenStatus::kWellKnownInvalidResponse,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kEmptyListError: {
OnError(fetch_result, FederatedAuthRequestResult::kWellKnownListEmpty,
TokenStatus::kWellKnownListEmpty,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kInvalidContentTypeError: {
OnError(fetch_result,
FederatedAuthRequestResult::kWellKnownInvalidContentType,
TokenStatus::kWellKnownInvalidContentType,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kSuccess: {
NOTREACHED();
}
}
}
fetch_result.wellknown = std::move(well_known);
RunCallbackIfDone();
}
void FedCmConfigFetcher::OnConfigFetched(
FetchResult& fetch_result,
IdpNetworkRequestManager::FetchStatus status,
IdpNetworkRequestManager::Endpoints endpoints,
IdentityProviderMetadata idp_metadata) {
pending_config_fetches_.erase(fetch_result.identity_provider_config_url);
constexpr char kConfigFileStr[] = "config file";
if (status.parse_status != IdpNetworkRequestManager::ParseStatus::kSuccess) {
std::optional<std::string> additional_console_error_message =
webid::ComputeConsoleMessageForHttpResponseCode(kConfigFileStr,
status.response_code);
switch (status.parse_status) {
case IdpNetworkRequestManager::ParseStatus::kHttpNotFoundError: {
OnError(fetch_result, FederatedAuthRequestResult::kConfigHttpNotFound,
TokenStatus::kConfigHttpNotFound,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kNoResponseError: {
OnError(fetch_result, FederatedAuthRequestResult::kConfigNoResponse,
TokenStatus::kConfigNoResponse,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kInvalidResponseError: {
OnError(fetch_result,
FederatedAuthRequestResult::kConfigInvalidResponse,
TokenStatus::kConfigInvalidResponse,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kInvalidContentTypeError: {
OnError(fetch_result,
FederatedAuthRequestResult::kConfigInvalidContentType,
TokenStatus::kConfigInvalidContentType,
additional_console_error_message);
return;
}
case IdpNetworkRequestManager::ParseStatus::kEmptyListError: {
NOTREACHED() << "kEmptyListError is undefined for OnConfigFetched";
}
case IdpNetworkRequestManager::ParseStatus::kSuccess: {
NOTREACHED();
}
}
}
if (!idp_metadata.brand_background_color && idp_metadata.brand_text_color) {
idp_metadata.brand_text_color = std::nullopt;
render_frame_host_->AddMessageToConsole(
blink::mojom::ConsoleMessageLevel::kWarning,
"The FedCM text color is ignored because background color was not "
"provided");
}
if (idp_metadata.brand_background_color && idp_metadata.brand_text_color) {
float text_contrast_ratio = color_utils::GetContrastRatio(
*idp_metadata.brand_background_color, *idp_metadata.brand_text_color);
if (text_contrast_ratio < color_utils::kMinimumReadableContrastRatio) {
idp_metadata.brand_text_color = std::nullopt;
render_frame_host_->AddMessageToConsole(
blink::mojom::ConsoleMessageLevel::kWarning,
"The FedCM text color is ignored because it does not contrast enough "
"with the provided background color");
}
}
fetch_result.endpoints = endpoints;
fetch_result.metadata = idp_metadata;
RunCallbackIfDone();
}
void FedCmConfigFetcher::OnError(
FetchResult& fetch_result,
blink::mojom::FederatedAuthRequestResult result,
content::FedCmRequestIdTokenStatus token_status,
std::optional<std::string> additional_console_error_message) {
SetError(fetch_result, result, token_status,
additional_console_error_message);
RunCallbackIfDone();
}
void FedCmConfigFetcher::ValidateAndMaybeSetError(FetchResult& result) {
// This function validates fetch results, by analyzing the config file and
// the well-known file.
// If the validation fails, this function sets the "error" property in the
// result.
if (result.error) {
// A fetch error was already recorded earlier (e.g. a network error).
return;
}
// Validates the config file. A valid config file must have:
//
// (a) a token endpoint same-origin url
// (b) an accounts endpoint same-origin url
// (c) optionally, a login_url same-origin url
//
// If one of these conditions are not met (e.g. one of the urls are not
// valid), we consider the config file invalid.
bool is_token_valid = webid::IsEndpointSameOrigin(
result.identity_provider_config_url, result.endpoints.token);
bool is_accounts_valid =
webid::IsEndpointSameOrigin(result.identity_provider_config_url,
result.endpoints.accounts) ||
(IsFedCmLightweightModeEnabled() && result.endpoints.accounts.is_empty());
bool is_login_url_valid =
result.metadata &&
webid::IsEndpointSameOrigin(result.identity_provider_config_url,
result.metadata->idp_login_url);
if (!is_token_valid || !is_accounts_valid || !is_login_url_valid) {
std::string console_message =
"Config file is missing or has an invalid URL for the following:\n";
if (!is_token_valid) {
console_message += "\"id_assertion_endpoint\"\n";
}
if (!is_accounts_valid) {
console_message += "\"accounts_endpoint\"\n";
}
if (!is_login_url_valid) {
console_message += "\"login_url\"\n";
}
SetError(result, FederatedAuthRequestResult::kConfigInvalidResponse,
TokenStatus::kConfigInvalidResponse, console_message);
return;
}
// Validates the well-known file.
// A well-known is valid if:
//
// (a) a chrome://flag has been set to bypass the check or
// (b) the well-known has an accounts_endpoint/login_url attribute that
// match the one in the config file or
// (c) the well-known file has a providers_url list of size 1 and that
// contains the config url passed in the JS call
// (a)
if (ShouldSkipWellKnownEnforcementForIdp(result)) {
return;
}
// (b)
bool is_wellknown_accounts_valid =
result.wellknown.accounts.is_valid() ||
(IsFedCmLightweightModeEnabled() && result.wellknown.accounts.is_empty());
if (is_wellknown_accounts_valid && result.wellknown.login_url.is_valid() &&
result.metadata && result.metadata->idp_login_url.is_valid()) {
// Behind the AuthZ flag, it is valid for IdPs to have valid configURLs
// by announcing their accounts_endpoint and their login_urls in the
// .well-known file. When that happens, and both of these urls match the
// contents of their configURLs, the browser knows that they don't
// contain any extra data embedded in them, so they can used as a valid
// configURL without checking for its presence in the provider_urls array.
if (result.endpoints.accounts != result.wellknown.accounts ||
result.metadata->idp_login_url != result.wellknown.login_url) {
SetError(result, FederatedAuthRequestResult::kConfigInvalidResponse,
TokenStatus::kConfigInvalidResponse,
"The well-known file contains an accounts endpoint or login_url "
"that doesn't match the one in the configURL");
}
return;
}
// (c)
//
// The config url from the API call:
// navigator.credentials.get({
// federated: {
// providers: [{
// configURL: "https://foo.idp.example/fedcm.json",
// clientId: "1234"
// }],
// }
// });
//
// must match the one in the well-known file:
//
// {
// "provider_urls": [
// "https://foo.idp.example/fedcm.json"
// ]
// }
if (result.wellknown.provider_urls.size() > kMaxProvidersInWellKnownFile) {
SetError(result, FederatedAuthRequestResult::kWellKnownTooBig,
TokenStatus::kWellKnownTooBig,
/*additional_console_error_message=*/std::nullopt);
return;
}
bool provider_url_is_valid = (result.wellknown.provider_urls.count(
result.identity_provider_config_url) != 0);
if (!provider_url_is_valid) {
SetError(result, FederatedAuthRequestResult::kConfigNotInWellKnown,
TokenStatus::kConfigNotInWellKnown,
/*additional_console_error_message=*/std::nullopt);
return;
}
}
void FedCmConfigFetcher::RunCallbackIfDone() {
if (!pending_config_fetches_.empty() ||
!pending_well_known_fetches_.empty()) {
return;
}
for (auto& result : fetch_results_) {
ValidateAndMaybeSetError(result);
}
std::move(callback_).Run(std::move(fetch_results_));
}
bool FedCmConfigFetcher::ShouldSkipWellKnownEnforcementForIdp(
const FetchResult& fetch_result) {
if (IsFedCmWithoutWellKnownEnforcementEnabled()) {
return true;
}
if (fetch_result.force_skip_well_known_enforcement) {
return true;
}
// Skip if RP and IDP are same-site.
return net::SchemefulSite::IsSameSite(
render_frame_host_->GetLastCommittedOrigin(),
url::Origin::Create(fetch_result.identity_provider_config_url));
}
} // namespace content
|