Skip to content
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.

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

gh-125969: fix OOB in future_schedule_callbacks due to an evil call_soon #125970

Merged
merged 8 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions Lib/test/test_asyncio/test_futures.py
Original file line number Diff line number Diff line change
Expand Up @@ -947,6 +947,39 @@ def __eq__(self, other):

fut.remove_done_callback(evil())

def test_evil_call_soon_list_mutation(self):
called_on_fut_callback0 = False

pad = lambda: ...

def evil_call_soon(*args, **kwargs):
nonlocal called_on_fut_callback0
if called_on_fut_callback0:
# Called when handling fut->fut_callbacks[0]
# and mutates the length fut->fut_callbacks.
fut.remove_done_callback(int)
fut.remove_done_callback(pad)
else:
called_on_fut_callback0 = True

fake_event_loop = lambda: ...
fake_event_loop.call_soon = evil_call_soon
fake_event_loop.get_debug = lambda: False # suppress traceback

with mock.patch.object(self, 'loop', fake_event_loop):
fut = self._new_future()
self.assertIs(fut.get_loop(), fake_event_loop)

fut.add_done_callback(str) # sets fut->fut_callback0
fut.add_done_callback(int) # sets fut->fut_callbacks[0]
fut.add_done_callback(pad) # sets fut->fut_callbacks[1]
fut.add_done_callback(pad) # sets fut->fut_callbacks[2]
fut.set_result("boom")

# When there are no more callbacks, the Python implementation
# returns an empty list but the C implementation returns None.
self.assertIn(fut._callbacks, (None, []))


@unittest.skipUnless(hasattr(futures, '_CFuture'),
'requires the C _asyncio module')
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix an out-of-bounds crash when an evil :meth:`asyncio.loop.call_soon`
graingert marked this conversation as resolved.
Show resolved Hide resolved
mutates the length of the internal callbacks list. Patch by Bénédikt Tran.
29 changes: 12 additions & 17 deletions Modules/_asynciomodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,6 @@ future_ensure_alive(FutureObj *fut)
static int
future_schedule_callbacks(asyncio_state *state, FutureObj *fut)
{
Py_ssize_t len;
Py_ssize_t i;

if (fut->fut_callback0 != NULL) {
/* There's a 1st callback */

Expand All @@ -434,27 +431,25 @@ future_schedule_callbacks(asyncio_state *state, FutureObj *fut)
return 0;
}

len = PyList_GET_SIZE(fut->fut_callbacks);
if (len == 0) {
/* The list of callbacks was empty; clear it and return. */
Py_CLEAR(fut->fut_callbacks);
return 0;
}

for (i = 0; i < len; i++) {
PyObject *cb_tup = PyList_GET_ITEM(fut->fut_callbacks, i);
// Beware: An evil call_soon could change fut->fut_callbacks.
// The idea is to transfer the ownership of the callbacks list
// so that external code is not able to mutate the list during
// the iteration.
PyObject *callbacks = fut->fut_callbacks;
fut->fut_callbacks = NULL;
Py_ssize_t n = PyList_GET_SIZE(callbacks);
for (Py_ssize_t i = 0; i < n; i++) {
assert(PyList_GET_SIZE(callbacks) == n);
PyObject *cb_tup = PyList_GET_ITEM(callbacks, i);
PyObject *cb = PyTuple_GET_ITEM(cb_tup, 0);
PyObject *ctx = PyTuple_GET_ITEM(cb_tup, 1);

if (call_soon(state, fut->fut_loop, cb, (PyObject *)fut, ctx)) {
/* If an error occurs in pure-Python implementation,
all callbacks are cleared. */
Py_CLEAR(fut->fut_callbacks);
Py_DECREF(callbacks);
return -1;
}
}

Py_CLEAR(fut->fut_callbacks);
Py_DECREF(callbacks);
return 0;
}

Expand Down
Loading