Skip to content
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.

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

jwks: Add UA string to headers #35977

Merged
merged 2 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions source/common/http/headers.h
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,7 @@ class HeaderValues {

struct {
const std::string EnvoyHealthChecker{"Envoy/HC"};
const std::string GoBrowser{"Go-browser"};
} UserAgentValues;

struct {
Expand Down
1 change: 1 addition & 0 deletions source/extensions/filters/http/common/jwks_fetcher.cc
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ class JwksFetcherImpl : public JwksFetcher,

Http::RequestMessagePtr message = Http::Utility::prepareHeaders(remote_jwks_.http_uri());
message->headers().setReferenceMethod(Http::Headers::get().MethodValues.Get);
message->headers().setReferenceUserAgent(Http::Headers::get().UserAgentValues.GoBrowser);
ENVOY_LOG(debug, "fetch pubkey from [uri = {}]: start", remote_jwks_.http_uri().uri());
auto options = Http::AsyncClient::RequestOptions()
.setTimeout(std::chrono::milliseconds(
Expand Down
22 changes: 22 additions & 0 deletions test/extensions/filters/http/common/jwks_fetcher_test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,28 @@ TEST_F(JwksFetcherTest, TestGetSuccess) {
fetcher_->fetch(parent_span_, receiver);
}

TEST_F(JwksFetcherTest, TestMessageHeader) {
// Setup
setupFetcher(config);
MockUpstream mock_pubkey(mock_factory_ctx_.server_factory_context_.cluster_manager_, "200",
publicKey);
MockJwksReceiver receiver;

// Expectations for message
EXPECT_CALL(mock_factory_ctx_.server_factory_context_.cluster_manager_.thread_local_cluster_
.async_client_,
send_(_, _, _))
.WillOnce(Invoke([](Http::RequestMessagePtr& message, Http::AsyncClient::Callbacks&,
const Http::AsyncClient::RequestOptions&) -> Http::AsyncClient::Request* {
EXPECT_EQ(message->headers().getUserAgentValue(),
Http::Headers::get().UserAgentValues.GoBrowser);
return nullptr;
}));

// Act
fetcher_->fetch(parent_span_, receiver);
}

TEST_F(JwksFetcherTest, TestGet400) {
// Setup
setupFetcher(config);
Expand Down