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

Attempt to diagnose WinHTTP CI pipeline errors. (#5259)

Browse Source 
* Fixes for CVE-2024-21646

* Added note about this fix to CHANGELOG.md

* Tweaks to investigate CI pipeline error
This commit is contained in:
Larry Osterman 2024-01-17 12:02:42 -08:00 committed by GitHub
parent 84c4812d98
commit 3bff843704
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 61 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
sdk/core/azure-core/src/http/winhttp/win_http_transport.cpp
View File

@ -421,6 +421,15 @@ std::string GetErrorMessage(DWORD error)
errorMessage += ": ";
errorMessage += errorString.get();
// If the end of the error message is a CRLF, remove it.
if (errorMessage.back() == '\n')
{
errorMessage.erase(errorMessage.size() - 1);
if (errorMessage.back() == '\r')
{
errorMessage.erase(errorMessage.size() - 1);
}
}
}
errorMessage += '.';
return errorMessage;
@ -475,15 +484,24 @@ namespace Azure { namespace Core { namespace Http { namespace _detail {
if (waitResult == WAIT_TIMEOUT)
{
// If the request was cancelled while we were waiting, throw an exception.
if (context.IsCancelled())
{
Log::Stream(Logger::Level::Error)
<< "Request was cancelled while waiting for action to complete." << std::endl;
}
context.ThrowIfCancelled();
}
else if (waitResult != WAIT_OBJECT_0)
{
Log::Stream(Logger::Level::Error)
<< "WaitForSingleObject failed with error code " << GetLastError() << std::endl;
return false;
}
} while (waitResult != WAIT_OBJECT_0);
if (m_stowedError != NO_ERROR)
{
Log::Stream(Logger::Level::Error)
<< "Action completed with error: " << GetErrorMessage(m_stowedError);
return false;
}
return true;
@ -567,7 +585,28 @@ namespace Azure { namespace Core { namespace Http { namespace _detail {
Log::Write(Logger::Level::Error, "Exception Thrown: " + std::string(ex.what()));
}
}
namespace {
std::string WinHttpAsyncResultToString(DWORD_PTR result)
{
switch (result)
{
case API_RECEIVE_RESPONSE:
return "API_RECEIVE_RESPONSE";
case API_QUERY_DATA_AVAILABLE:
return "API_QUERY_DATA_AVAILABLE";
case API_READ_DATA:
return "API_READ_DATA";
case API_WRITE_DATA:
return "API_WRITE_DATA";
case API_SEND_REQUEST:
return "API_SEND_REQUEST";
case API_GET_PROXY_FOR_URL:
return "API_GET_PROXY_FOR_URL";
default:
return "Unknown (" + std::to_string(result) + ")";
}
}
} // namespace
/**
* @brief HTTP Callback to enable private certificate checks.
*
@ -599,8 +638,8 @@ namespace Azure { namespace Core { namespace Http { namespace _detail {
WINHTTP_ASYNC_RESULT* asyncResult = static_cast<WINHTTP_ASYNC_RESULT*>(statusInformation);
Log::Write(
Logger::Level::Error,
"Request error. " + GetErrorMessage(asyncResult->dwError) + " "
+ std::to_string(asyncResult->dwResult));
"Request error: " + GetErrorMessage(asyncResult->dwError)
+ " Failing API: " + WinHttpAsyncResultToString(asyncResult->dwResult));
CompleteActionWithError(asyncResult->dwResult, asyncResult->dwError);
}
else if (internetStatus == WINHTTP_CALLBACK_STATUS_SENDING_REQUEST)
@ -999,13 +1038,27 @@ _detail::WinHttpRequest::~WinHttpRequest()
if (!m_requestHandleClosed)
{
Log::Write(
Logger::Level::Verbose, "WinHttpRequest::~WinHttpRequest. Closing handle synchronously.");
Logger::Level::Informational,
"WinHttpRequest::~WinHttpRequest. Closing handle synchronously.");
// Close the outstanding request handle, waiting until the HANDLE_CLOSING status is received.
m_httpAction->WaitForAction(
[this]() { m_requestHandle.reset(); },
WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING,
Azure::Core::Context{});
if (!m_httpAction->WaitForAction(
[this]() {
auto requestHandle = m_requestHandle.release();
if (!WinHttpCloseHandle(requestHandle))
{
Log::Write(
Logger::Level::Error,
"Error closing WinHTTP handle: " + GetErrorMessage(GetLastError()));
}
},
WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING,
Azure::Core::Context{}))
{
Log::Write(Logger::Level::Error, "Error while closing the request handle.");
}
Log::Write(Logger::Level::Informational, "WinHttpRequest::~WinHttpRequest. Handle closed.");
}
}