Skip to content

PYTHON-5013 Add NULL checks in InvalidDocument bson handling #2049

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
blink1073 merged 5 commits into from
Jan 14, 2025
Merged

PYTHON-5013 Add NULL checks in InvalidDocument bson handling #2049

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc2cc10
PYTHON-5013 Add NULL checks in InvalidDocument bson handling
blink1073 Jan 6, 2025
005d942
address review
blink1073 Jan 9, 2025
7834214
pass the dict
blink1073 Jan 9, 2025
fa60555
address compiler warnings and errors
blink1073 Jan 9, 2025
79a8c57
finish refactor and add test
blink1073 Jan 10, 2025
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
6 changes: 6 additions & 0 deletions bson/_cbsonmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1747,6 +1747,9 @@ int write_dict(PyObject* self, buffer_t buffer,
PyObject *etype = NULL, *evalue = NULL, *etrace = NULL;
PyErr_Fetch(&etype, &evalue, &etrace);
PyObject *InvalidDocument = _error("InvalidDocument");
if (InvalidDocument == NULL) {
Copy link
Member

@ShaneHarvey ShaneHarvey Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just realized there's a larger problem here. This logic is only in place for the is_dict fast path where it should be added generically for any mapping.

Copy link
Member Author

@blink1073 blink1073 Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I'll see if I can factor this out.

return 0;
Copy link
Member

@ShaneHarvey ShaneHarvey Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This return case will leak &etype, &evalue, &etrace. We either need to call PyErr_Restore or xdecref those explicitly.

Copy link
Member Author

@blink1073 blink1073 Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

}

if (top_level && InvalidDocument && PyErr_GivenExceptionMatches(etype, InvalidDocument)) {

Expand All @@ -1760,6 +1763,9 @@ int write_dict(PyObject* self, buffer_t buffer,
if (msg) {
// Prepend doc to the existing message
PyObject *dict_str = PyObject_Str(dict);
if (dict_str == NULL) {
return 0;
Copy link
Member

@ShaneHarvey ShaneHarvey Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same leak comment here except we'll also leak more variables, eg msg.

Copy link
Member Author

@blink1073 blink1073 Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

}
PyObject *new_msg = PyUnicode_FromFormat("Invalid document %s | %s", PyUnicode_AsUTF8(dict_str), PyUnicode_AsUTF8(msg));
Copy link
Member

@ShaneHarvey ShaneHarvey Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you fix the indentation on line 1776?

Copy link
Member

@ShaneHarvey ShaneHarvey Jan 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I believe PyUnicode_AsUTF8 can return NULL on error so we'll need checks there too. Unless there's a simpler API to construct this string that does the NULL checks for us.

Copy link
Member Author

@blink1073 blink1073 Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Py_DECREF(dict_str);

Expand Down
Loading