Skip to content

Include api-version to default list of unredacted query params for logging #3730

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

Merged
antkmsft merged 1 commit into from
Jun 11, 2022
Merged

Include api-version to default list of unredacted query params for logging #3730

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
7 changes: 4 additions & 3 deletions sdk/core/azure-core/inc/azure/core/http/policies/policy.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {

namespace _detail {
std::shared_ptr<HttpTransport> GetTransportAdapter();
AZ_CORE_DLLEXPORT extern Azure::Core::CaseInsensitiveSet const g_defaultAllowedHttpHeaders;
AZ_CORE_DLLEXPORT extern std::set<std::string> const g_defaultAllowedHttpQueryParameters;
AZ_CORE_DLLEXPORT extern CaseInsensitiveSet const g_defaultAllowedHttpHeaders;
} // namespace _detail

/**
Expand Down Expand Up @@ -120,13 +121,13 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
* @brief HTTP query parameter names that are allowed to be logged.
*
*/
std::set<std::string> AllowedHttpQueryParameters;
std::set<std::string> AllowedHttpQueryParameters = _detail::g_defaultAllowedHttpQueryParameters;

/**
* @brief HTTP header names that are allowed to be logged.
*
*/
Azure::Core::CaseInsensitiveSet AllowedHttpHeaders = _detail::g_defaultAllowedHttpHeaders;
CaseInsensitiveSet AllowedHttpHeaders = _detail::g_defaultAllowedHttpHeaders;
};

/**
Expand Down
56 changes: 29 additions & 27 deletions sdk/core/azure-core/src/http/log_policy.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,33 +66,35 @@ inline std::string GetResponseLogMessage(
}
} // namespace

Azure::Core::CaseInsensitiveSet const
Azure::Core::Http::Policies::_detail::g_defaultAllowedHttpHeaders
= {
"Accept",
"Cache-Control",
"Connection",
"Content-Length",
"Content-Type",
"Date",
"ETag",
"Expires",
"If-Match",
"If-Modified-Since",
"If-None-Match",
"If-Unmodified-Since",
"Last-Modified",
"Pragma",
"Request-Id",
"Retry-After",
"Server",
"traceparent",
"tracestate",
"Transfer-Encoding",
"User-Agent",
"x-ms-client-request-id",
"x-ms-request-id",
"x-ms-return-client-request-id",
std::set<std::string> const Policies::_detail::g_defaultAllowedHttpQueryParameters = {
"api-version",
};

CaseInsensitiveSet const Policies::_detail::g_defaultAllowedHttpHeaders = {
"Accept",
"Cache-Control",
"Connection",
"Content-Length",
"Content-Type",
"Date",
"ETag",
"Expires",
"If-Match",
"If-Modified-Since",
"If-None-Match",
"If-Unmodified-Since",
"Last-Modified",
"Pragma",
"Request-Id",
"Retry-After",
"Server",
"traceparent",
"tracestate",
"Transfer-Encoding",
"User-Agent",
"x-ms-client-request-id",
"x-ms-request-id",
"x-ms-return-client-request-id",
};

std::unique_ptr<RawResponse> LogPolicy::Send(
Expand Down