CDRIVER-6019 Improve error messages from Windows APIs #2020
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm."
For consistency between Windows / non-Windows
kevinAlbs
changed the title
mdb-ad
approved these changes
May 28, 2025
kevinAlbs
added a commit
to kevinAlbs/mongo-c-driver
that referenced
this pull request
May 28, 2025
* add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
kevinAlbs
added a commit
to kevinAlbs/mongo-c-driver
that referenced
this pull request
May 28, 2025
* add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
kevinAlbs
added a commit
to kevinAlbs/mongo-c-driver
that referenced
this pull request
May 28, 2025
* add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
kevinAlbs
added a commit
that referenced
this pull request
May 28, 2025
* add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
kevinAlbs
added a commit
that referenced
this pull request
May 29, 2025
…#2023) * CDRIVER-6019 Improve error messages from Windows APIs (#2020) * add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
kevinAlbs
added a commit
to kevinAlbs/mongo-c-driver
that referenced
this pull request
May 29, 2025
* add helper to convert Windows error to string: `mongoc_winerr_to_string` * use SECURITY_STATUS for error message Improves observed "Incorrect function" error with a more informative "The client and server cannot communicate, because they do not possess a common algorithm." * use `bson_strerror_r` for consistency between Windows / non-Windows
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Improve error messages from Windows APIs
Patch build: https://spruce.mongodb.com/version/682dfd72aeaf7a000773acc6
Background
This PR intends to consistently use
FormatMessageto get an error message from a Windows error code.Using the return value from
InitializeSecurityContextimproves an error message observed when investigating TLS handshake failure as part of CDRIVER-6000:Before:
After:
The Windows error types used in libmongoc (
SECURITY_STATUS,DNS_STATUS, and return ofGetLastError()) all appear accepted in FormatMessage (expects a DWORD). A test is added with a sample of error codes to check the messages.FormatMessageAis used rather thanFormatMessage/FormatMessageWto ensure the resulting error message consists of single-byte characters. The C driver does not test (and appears broken) when building with Unicode encoding on Windows: CDRIVER-6015.