github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

InputSanitizer: rename to HttpSanitizer, remove static member (#3736)

Browse Source 
* InputSanitizer => HttpSanitizer, remove static

* Update cpp

* Clang format

Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
This commit is contained in:
Anton Kolesnyk 2022-06-15 11:18:23 -07:00 committed by GitHub
parent e2c1e219ce
commit dfe9a2be1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 118 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sdk/core/azure-core-tracing-opentelemetry/test/ut/service_support_test.cpp
View File

@ -595,7 +595,7 @@ public:
// Add the request ID policy - this adds the x-ms-request-id attribute to the pipeline.
policies.emplace_back(
std::make_unique<RequestActivityPolicy>(Azure::Core::_internal::InputSanitizer{}));
std::make_unique<RequestActivityPolicy>(Azure::Core::Http::_internal::HttpSanitizer{}));
// Final policy - functions as the HTTP transport policy.
policies.emplace_back(std::make_unique<NoOpPolicy>([&](Request& request) {

4
sdk/core/azure-core/CMakeLists.txt
View File

@ -80,6 +80,7 @@ set(
inc/azure/core/internal/diagnostics/log.hpp
inc/azure/core/internal/environment.hpp
inc/azure/core/internal/extendable_enumeration.hpp
inc/azure/core/internal/http/http_sanitizer.hpp
inc/azure/core/internal/http/pipeline.hpp
inc/azure/core/internal/http/user_agent.hpp
inc/azure/core/internal/io/null_body_stream.hpp
@ -88,7 +89,6 @@ set(
inc/azure/core/internal/json/json_serializable.hpp
inc/azure/core/internal/strings.hpp
inc/azure/core/internal/tracing/service_tracing.hpp
inc/azure/core/internal/input_sanitizer.hpp
inc/azure/core/io/body_stream.hpp
inc/azure/core/match_conditions.hpp
inc/azure/core/modified_conditions.hpp
@ -120,6 +120,7 @@ set(
src/exception.cpp
src/http/bearer_token_authentication_policy.cpp
src/http/http.cpp
src/http/http_sanitizer.cpp
src/http/log_policy.cpp
src/http/policy.cpp
src/http/raw_response.cpp
@ -136,7 +137,6 @@ set(
src/operation_status.cpp
src/private/environment_log_level_listener.hpp
src/private/package_version.hpp
src/private/input_sanitizer.cpp
src/strings.cpp
src/tracing/tracing.cpp
src/uuid.cpp

15
sdk/core/azure-core/inc/azure/core/http/policies/policy.hpp
View File

@ -14,8 +14,8 @@
#include "azure/core/dll_import_export.hpp"
#include "azure/core/http/http.hpp"
#include "azure/core/http/transport.hpp"
#include "azure/core/internal/http/http_sanitizer.hpp"
#include "azure/core/internal/http/user_agent.hpp"
#include "azure/core/internal/input_sanitizer.hpp"
#include "azure/core/uuid.hpp"
#include <atomic>
@ -395,7 +395,7 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
*/
class RequestActivityPolicy final : public HttpPolicy {
private:
Azure::Core::_internal::InputSanitizer m_inputSanitizer;
Azure::Core::Http::_internal::HttpSanitizer m_httpSanitizer;
public:
/**
@ -405,10 +405,11 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
/**
* @brief Constructs HTTP Request Activity policy.
*
* @param inputSanitizer for sanitizing data before it is logged.
* @param httpSanitizer for sanitizing data before it is logged.
*/
explicit RequestActivityPolicy(Azure::Core::_internal::InputSanitizer const& inputSanitizer)
: m_inputSanitizer(inputSanitizer)
explicit RequestActivityPolicy(
Azure::Core::Http::_internal::HttpSanitizer const& httpSanitizer)
: m_httpSanitizer(httpSanitizer)
{
}
@ -520,7 +521,7 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
*/
class LogPolicy final : public HttpPolicy {
LogOptions m_options;
Azure::Core::_internal::InputSanitizer m_inputSanitizer;
Azure::Core::Http::_internal::HttpSanitizer m_httpSanitizer;
public:
/**
@ -529,7 +530,7 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
*/
explicit LogPolicy(LogOptions options)
: m_options(std::move(options)),
m_inputSanitizer(m_options.AllowedHttpQueryParameters, m_options.AllowedHttpHeaders)
m_httpSanitizer(m_options.AllowedHttpQueryParameters, m_options.AllowedHttpHeaders)
{
}

13
sdk/core/azure-core/inc/azure/core/internal/input_sanitizer.hpp → sdk/core/azure-core/inc/azure/core/internal/http/http_sanitizer.hpp
View File

@ -6,8 +6,8 @@
#include "azure/core/url.hpp"
#include <string>
namespace Azure { namespace Core { namespace _internal {
class InputSanitizer final {
namespace Azure { namespace Core { namespace Http { namespace _internal {
class HttpSanitizer final {
/**
* @brief HTTP header names that are allowed to be logged.
*/
@ -18,12 +18,9 @@ namespace Azure { namespace Core { namespace _internal {
*/
std::set<std::string> m_allowedHttpQueryParameters;
// Manifest constant indicating a field was redacted.
static const char* m_RedactedPlaceholder;
public:
InputSanitizer() = default;
InputSanitizer(
HttpSanitizer() = default;
HttpSanitizer(
std::set<std::string> const& allowedHttpQueryParameters,
Azure::Core::CaseInsensitiveSet const& allowedHttpHeaders)
: m_allowedHttpHeaders(allowedHttpHeaders),
@ -47,4 +44,4 @@ namespace Azure { namespace Core { namespace _internal {
*/
std::string SanitizeHeader(std::string const& headerName, std::string const& headerValue) const;
};
}}} // namespace Azure::Core::_internal
}}}} // namespace Azure::Core::Http::_internal

6
sdk/core/azure-core/inc/azure/core/internal/http/pipeline.hpp
View File

@ -14,7 +14,7 @@
#include "azure/core/http/policies/policy.hpp"
#include "azure/core/http/transport.hpp"
#include "azure/core/internal/client_options.hpp"
#include "azure/core/internal/input_sanitizer.hpp"
#include "azure/core/internal/http/http_sanitizer.hpp"
#include <memory>
#include <vector>
@ -52,7 +52,7 @@ namespace Azure { namespace Core { namespace Http { namespace _internal {
std::string const& telemetryServiceName = {},
std::string const& telemetryServiceVersion = {})
{
Azure::Core::_internal::InputSanitizer inputSanitizer(
Azure::Core::Http::_internal::HttpSanitizer httpSanitizer(
clientOptions.Log.AllowedHttpQueryParameters, clientOptions.Log.AllowedHttpHeaders);
auto const& perCallClientPolicies = clientOptions.PerOperationPolicies;
@ -111,7 +111,7 @@ namespace Azure { namespace Core { namespace Http { namespace _internal {
// Add a request activity policy which will generate distributed traces for the pipeline.
m_policies.emplace_back(
std::make_unique<Azure::Core::Http::Policies::_internal::RequestActivityPolicy>(
inputSanitizer));
httpSanitizer));
// logging - won't update request
m_policies.emplace_back(

85
sdk/core/azure-core/src/http/http_sanitizer.cpp Normal file
View File

@ -0,0 +1,85 @@
#include "azure/core/internal/http/http_sanitizer.hpp"
#include "azure/core/url.hpp"
#include <regex>
#include <sstream>
namespace {
std::string const RedactedPlaceholder = "REDACTED";
}
using Azure::Core::Http::_internal::HttpSanitizer;
Azure::Core::Url HttpSanitizer::SanitizeUrl(Azure::Core::Url const& url) const
{
std::ostringstream ss;
// Sanitize the non-query part of the URL (remove username and password).
if (!url.GetScheme().empty())
{
ss << url.GetScheme() << "://";
}
ss << url.GetHost();
if (url.GetPort() != 0)
{
ss << ":" << url.GetPort();
}
if (!url.GetPath().empty())
{
ss << "/" << url.GetPath();
}
{
auto encodedRequestQueryParams = url.GetQueryParameters();
std::remove_const<std::remove_reference<decltype(encodedRequestQueryParams)>::type>::type
loggedQueryParams;
if (!encodedRequestQueryParams.empty())
{
auto const& unencodedAllowedQueryParams = m_allowedHttpQueryParameters;
if (!unencodedAllowedQueryParams.empty())
{
std::remove_const<std::remove_reference<decltype(unencodedAllowedQueryParams)>::type>::type
encodedAllowedQueryParams;
std::transform(
unencodedAllowedQueryParams.begin(),
unencodedAllowedQueryParams.end(),
std::inserter(encodedAllowedQueryParams, encodedAllowedQueryParams.begin()),
[](std::string const& s) { return Url::Encode(s); });
for (auto const& encodedRequestQueryParam : encodedRequestQueryParams)
{
if (encodedRequestQueryParam.second.empty()
|| (encodedAllowedQueryParams.find(encodedRequestQueryParam.first)
!= encodedAllowedQueryParams.end()))
{
loggedQueryParams.insert(encodedRequestQueryParam);
}
else
{
loggedQueryParams.insert(
std::make_pair(encodedRequestQueryParam.first, RedactedPlaceholder));
}
}
}
else
{
for (auto const& encodedRequestQueryParam : encodedRequestQueryParams)
{
loggedQueryParams.insert(
std::make_pair(encodedRequestQueryParam.first, RedactedPlaceholder));
}
}
ss << Azure::Core::_detail::FormatEncodedUrlQueryParameters(loggedQueryParams);
}
}
return Azure::Core::Url(ss.str());
}
std::string HttpSanitizer::SanitizeHeader(std::string const& header, std::string const& value) const
{
return (m_allowedHttpHeaders.find(header) != m_allowedHttpHeaders.end()) ? value
: RedactedPlaceholder;
}

19
sdk/core/azure-core/src/http/log_policy.cpp
View File

@ -21,7 +21,7 @@ std::string RedactedPlaceholder = "REDACTED";
inline void AppendHeaders(
std::ostringstream& log,
Azure::Core::_internal::InputSanitizer const& inputSanitizer,
Azure::Core::Http::_internal::HttpSanitizer const& httpSanitizer,
Azure::Core::CaseInsensitiveMap const& headers)
{
for (auto const& header : headers)
@ -30,27 +30,27 @@ inline void AppendHeaders(
if (!header.second.empty())
{
log << inputSanitizer.SanitizeHeader(header.first, header.second);
log << httpSanitizer.SanitizeHeader(header.first, header.second);
}
}
}
inline std::string GetRequestLogMessage(
Azure::Core::_internal::InputSanitizer const& inputSanitizer,
Azure::Core::Http::_internal::HttpSanitizer const& httpSanitizer,
Request const& request)
{
std::ostringstream log;
log << "HTTP Request : " << request.GetMethod().ToString() << " ";
Azure::Core::Url urlToLog(inputSanitizer.SanitizeUrl(request.GetUrl()));
Azure::Core::Url urlToLog(httpSanitizer.SanitizeUrl(request.GetUrl()));
log << urlToLog.GetAbsoluteUrl();
AppendHeaders(log, inputSanitizer, request.GetHeaders());
AppendHeaders(log, httpSanitizer, request.GetHeaders());
return log.str();
}
inline std::string GetResponseLogMessage(
Azure::Core::_internal::InputSanitizer const& inputSanitizer,
Azure::Core::Http::_internal::HttpSanitizer const& httpSanitizer,
RawResponse const& response,
std::chrono::system_clock::duration const& duration)
{
@ -61,7 +61,7 @@ inline std::string GetResponseLogMessage(
<< "ms) : " << static_cast<int>(response.GetStatusCode()) << " "
<< response.GetReasonPhrase();
AppendHeaders(log, inputSanitizer, response.GetHeaders());
AppendHeaders(log, httpSanitizer, response.GetHeaders());
return log.str();
}
} // namespace
@ -107,7 +107,7 @@ std::unique_ptr<RawResponse> LogPolicy::Send(
if (Log::ShouldWrite(Logger::Level::Verbose))
{
Log::Write(Logger::Level::Informational, GetRequestLogMessage(m_inputSanitizer, request));
Log::Write(Logger::Level::Informational, GetRequestLogMessage(m_httpSanitizer, request));
}
else
{
@ -119,8 +119,7 @@ std::unique_ptr<RawResponse> LogPolicy::Send(
auto const end = std::chrono::system_clock::now();
Log::Write(
Logger::Level::Informational,
GetResponseLogMessage(m_inputSanitizer, *response, end - start));
Logger::Level::Informational, GetResponseLogMessage(m_httpSanitizer, *response, end - start));
return response;
}

5
sdk/core/azure-core/src/http/request_activity_policy.cpp
View File

@ -3,7 +3,7 @@
#include "azure/core/http/policies/policy.hpp"
#include "azure/core/internal/diagnostics/log.hpp"
#include "azure/core/internal/input_sanitizer.hpp"
#include "azure/core/internal/http/http_sanitizer.hpp"
#include "azure/core/internal/tracing/service_tracing.hpp"
#include <algorithm>
@ -62,8 +62,7 @@ std::unique_ptr<RawResponse> RequestActivityPolicy::Send(
createOptions.Attributes->AddAttribute(
TracingAttributes::HttpMethod.ToString(), request.GetMethod().ToString());
const std::string sanitizedUrl
= m_inputSanitizer.SanitizeUrl(request.GetUrl()).GetAbsoluteUrl();
const std::string sanitizedUrl = m_httpSanitizer.SanitizeUrl(request.GetUrl()).GetAbsoluteUrl();
createOptions.Attributes->AddAttribute("http.url", sanitizedUrl);
const Azure::Nullable<std::string> requestId = request.GetHeader("x-ms-client-request-id");
if (requestId.HasValue())

89
sdk/core/azure-core/src/private/input_sanitizer.cpp
View File

@ -1,89 +0,0 @@
#include "azure/core/internal/input_sanitizer.hpp"
#include "azure/core/url.hpp"
#include <regex>
#include <sstream>
namespace Azure { namespace Core { namespace _internal {
const char* InputSanitizer::m_RedactedPlaceholder = "REDACTED";
Azure::Core::Url InputSanitizer::SanitizeUrl(Azure::Core::Url const& url) const
{
std::ostringstream ss;
// Sanitize the non-query part of the URL (remove username and password).
if (!url.GetScheme().empty())
{
ss << url.GetScheme() << "://";
}
ss << url.GetHost();
if (url.GetPort() != 0)
{
ss << ":" << url.GetPort();
}
if (!url.GetPath().empty())
{
ss << "/" << url.GetPath();
}
{
auto encodedRequestQueryParams = url.GetQueryParameters();
std::remove_const<std::remove_reference<decltype(encodedRequestQueryParams)>::type>::type
loggedQueryParams;
if (!encodedRequestQueryParams.empty())
{
auto const& unencodedAllowedQueryParams = m_allowedHttpQueryParameters;
if (!unencodedAllowedQueryParams.empty())
{
std::remove_const<std::remove_reference<decltype(unencodedAllowedQueryParams)>::type>::
type encodedAllowedQueryParams;
std::transform(
unencodedAllowedQueryParams.begin(),
unencodedAllowedQueryParams.end(),
std::inserter(encodedAllowedQueryParams, encodedAllowedQueryParams.begin()),
[](std::string const& s) { return Url::Encode(s); });
for (auto const& encodedRequestQueryParam : encodedRequestQueryParams)
{
if (encodedRequestQueryParam.second.empty()
|| (encodedAllowedQueryParams.find(encodedRequestQueryParam.first)
!= encodedAllowedQueryParams.end()))
{
loggedQueryParams.insert(encodedRequestQueryParam);
}
else
{
loggedQueryParams.insert(
std::make_pair(encodedRequestQueryParam.first, m_RedactedPlaceholder));
}
}
}
else
{
for (auto const& encodedRequestQueryParam : encodedRequestQueryParams)
{
loggedQueryParams.insert(
std::make_pair(encodedRequestQueryParam.first, m_RedactedPlaceholder));
}
}
ss << Azure::Core::_detail::FormatEncodedUrlQueryParameters(loggedQueryParams);
}
}
return Azure::Core::Url(ss.str());
}
std::string InputSanitizer::SanitizeHeader(std::string const& header, std::string const& value)
const
{
if (m_allowedHttpHeaders.find(header) != m_allowedHttpHeaders.end())
{
return value;
}
return m_RedactedPlaceholder;
}
}}} // namespace Azure::Core::_internal

6
sdk/core/azure-core/test/ut/request_activity_policy_test.cpp
View File

@ -170,7 +170,7 @@ TEST(RequestActivityPolicy, Basic)
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> policies;
// Add the request ID policy - this adds the x-ms-request-id attribute to the pipeline.
policies.emplace_back(
std::make_unique<RequestActivityPolicy>(Azure::Core::_internal::InputSanitizer{}));
std::make_unique<RequestActivityPolicy>(Azure::Core::Http::_internal::HttpSanitizer{}));
// Final policy - equivalent to HTTP policy.
policies.emplace_back(std::make_unique<NoOpPolicy>());
@ -205,7 +205,7 @@ TEST(RequestActivityPolicy, Basic)
policies.emplace_back(std::make_unique<RequestIdPolicy>());
policies.emplace_back(std::make_unique<RetryPolicy>(RetryOptions{}));
policies.emplace_back(
std::make_unique<RequestActivityPolicy>(Azure::Core::_internal::InputSanitizer{}));
std::make_unique<RequestActivityPolicy>(Azure::Core::Http::_internal::HttpSanitizer{}));
// Final policy - equivalent to HTTP policy.
policies.emplace_back(std::make_unique<NoOpPolicy>([&](Request& request) {
userAgent = request.GetHeader("user-agent"); // Return success.
@ -248,7 +248,7 @@ TEST(RequestActivityPolicy, TryRetries)
// Add the request ID policy - this adds the x-ms-request-id attribute to the pipeline.
policies.emplace_back(
std::make_unique<RequestActivityPolicy>(Azure::Core::_internal::InputSanitizer{}));
std::make_unique<RequestActivityPolicy>(Azure::Core::Http::_internal::HttpSanitizer{}));
// Final policy - equivalent to HTTP policy.
int retryCount = 0;
policies.emplace_back(std::make_unique<NoOpPolicy>([&](Request&) {