Skip to content

fix(rest): omit OAuth token type values from errors #1079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
zhjwpku wants to merge 1 commit into from
Closed

fix(rest): omit OAuth token type values from errors #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/iceberg/catalog/rest/types.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ Status OAuthTokenResponse::Validate() const {
std::string lower_type = token_type;
std::ranges::transform(lower_type, lower_type.begin(), ::tolower);
if (lower_type != "bearer" && lower_type != "n_a") {
return ValidationFailed(R"(Unsupported token type: {} (must be "bearer" or "N_A"))",
token_type);
// Keep OAuth response values out of errors that callers may log.
return ValidationFailed(R"(Unsupported token type (must be "bearer" or "N_A"))");
}
return {};
}
Expand Down
29 changes: 29 additions & 0 deletions src/iceberg/test/auth_manager_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -659,6 +659,35 @@ Result<std::shared_ptr<AuthSession>> RefreshingSession(

} // namespace

TEST(OAuth2UtilTest, TokenResponseErrorsDoNotExposeResponseValues) {
const std::array<std::string, 6> responses{
R"({"access_token":"sensitive-response-value",)",
R"({"access_token":"sensitive-response-value"})",
R"({"access_token":{"value":"sensitive-response-value"},"token_type":"bearer"})",
R"({"access_token":"access","token_type":"sensitive-response-value"})",
R"({"access_token":"access","token_type":"","refresh_token":"sensitive-response-value"})",
R"({"access_token":"","token_type":"bearer","refresh_token":"sensitive-response-value"})"};
ICEBERG_UNWRAP_OR_FAIL(auto properties,
AuthProperties::FromProperties(
{{"credential", "client:secret"},
{"oauth2-server-uri", "https://auth.example/token"}}));
auto session = AuthSession::MakeDefault({});
RefreshHttpClient client;
const auto check_error = [](const Result<OAuthTokenResponse>& result) {
ASSERT_FALSE(result.has_value());
EXPECT_THAT(result.error().message,
::testing::Not(::testing::HasSubstr("sensitive-response-value")));
};
for (const auto& body : responses) {
client.response = [&] { return HttpResponse(200, body); };
check_error(OAuth2Util::FetchToken(client, *session, properties));
check_error(OAuth2Util::ExchangeToken(
client, *session, {}, "subject-token", AuthProperties::kAccessTokenType,
std::nullopt, std::nullopt, "catalog", "https://auth.example/token", {}));
}
EXPECT_EQ(client.requests, responses.size() * 2);
}

TEST(OAuth2SessionTest, RefreshesAndReschedulesThroughPublicFactory) {
MockExecutor executor;
std::array<std::promise<ExecutorTask>, 2> queued;
Expand Down
Loading