Skip to content

gh-133009: fix UAF in xml.etree.ElementTree.Element.__deepcopy__ #133010

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

Merged
merged 8 commits into from
May 10, 2025
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
44 changes: 44 additions & 0 deletions Lib/test/test_xml_etree.py
Original file line number Diff line number Diff line change
Expand Up @@ -2960,6 +2960,50 @@ def element_factory(x, y):
del b
gc_collect()

def test_deepcopy_clear(self):
# Prevent crashes when __deepcopy__() clears the children list.
# See https://github.com/python/cpython/issues/133009.
class X(ET.Element):
def __deepcopy__(self, memo):
root.clear()
return self

root = ET.Element('a')
evil = X('x')
root.extend([evil, ET.Element('y')])
if is_python_implementation():
Copy link
Member

Choose a reason for hiding this comment

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

We could also make the C implementation raising RuntimeError. It is fine either way.

Copy link
Member Author

@picnixz picnixz May 10, 2025

Choose a reason for hiding this comment

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

I'll postpone this for a future PR as I want to backport this one to 3.13 and 3.14 first.

# Mutating a list over which we iterate raises an error.
self.assertRaises(RuntimeError, copy.deepcopy, root)
else:
c = copy.deepcopy(root)
# In the C implementation, we can still copy the evil element.
self.assertListEqual(list(c), [evil])

def test_deepcopy_grow(self):
# Prevent crashes when __deepcopy__() mutates the children list.
# See https://github.com/python/cpython/issues/133009.
a = ET.Element('a')
b = ET.Element('b')
c = ET.Element('c')

class X(ET.Element):
def __deepcopy__(self, memo):
root.append(a)
root.append(b)
return self

root = ET.Element('top')
evil1, evil2 = X('1'), X('2')
root.extend([evil1, c, evil2])
children = list(copy.deepcopy(root))
# mock deep copies
self.assertIs(children[0], evil1)
self.assertIs(children[2], evil2)
# true deep copies
self.assertEqual(children[1].tag, c.tag)
self.assertEqual([c.tag for c in children[3:]],
[a.tag, b.tag, a.tag, b.tag])


class MutationDeleteElementPath(str):
def __new__(cls, elem, *args):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:mod:`xml.etree.ElementTree`: Fix a crash in :meth:`Element.__deepcopy__
<object.__deepcopy__>` when the element is concurrently mutated.
Patch by Bénédikt Tran.
41 changes: 34 additions & 7 deletions Modules/_elementtree.c
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,8 @@ _elementtree_Element___deepcopy___impl(ElementObject *self, PyObject *memo)

PyTypeObject *tp = Py_TYPE(self);
elementtreestate *st = get_elementtree_state_by_type(tp);
// The deepcopy() helper takes care of incrementing the refcount
// of the object to copy so to avoid use-after-frees.
tag = deepcopy(st, self->tag, memo);
if (!tag)
return NULL;
Expand Down Expand Up @@ -845,11 +847,13 @@ _elementtree_Element___deepcopy___impl(ElementObject *self, PyObject *memo)

assert(!element->extra || !element->extra->length);
if (self->extra) {
if (element_resize(element, self->extra->length) < 0)
Py_ssize_t expected_count = self->extra->length;
if (element_resize(element, expected_count) < 0) {
assert(!element->extra->length);
goto error;
}

// TODO(picnixz): check for an evil child's __deepcopy__ on 'self'
for (i = 0; i < self->extra->length; i++) {
for (i = 0; self->extra && i < self->extra->length; i++) {
PyObject* child = deepcopy(st, self->extra->children[i], memo);
if (!child || !Element_Check(st, child)) {
if (child) {
Expand All @@ -859,11 +863,24 @@ _elementtree_Element___deepcopy___impl(ElementObject *self, PyObject *memo)
element->extra->length = i;
goto error;
}
if (self->extra && expected_count != self->extra->length) {
// 'self->extra' got mutated and 'element' may not have
// sufficient space to hold the next iteration's item.
expected_count = self->extra->length;
if (element_resize(element, expected_count) < 0) {
Py_DECREF(child);
element->extra->length = i;
goto error;
}
}
element->extra->children[i] = child;
}

assert(!element->extra->length);
element->extra->length = self->extra->length;
// The original 'self->extra' may be gone at this point if deepcopy()
// has side-effects. However, 'i' is the number of copied items that
// we were able to successfully copy.
element->extra->length = i;
}

/* add object to memo dictionary (so deepcopy won't visit it again) */
Expand Down Expand Up @@ -906,13 +923,20 @@ deepcopy(elementtreestate *st, PyObject *object, PyObject *memo)
break;
}
}
if (simple)
if (simple) {
return PyDict_Copy(object);
}
/* Fall through to general case */
}
else if (Element_CheckExact(st, object)) {
return _elementtree_Element___deepcopy___impl(
// The __deepcopy__() call may call arbitrary code even if the
// object to copy is a built-in XML element (one of its children
// any of its parents in its own __deepcopy__() implementation).
Py_INCREF(object);
PyObject *res = _elementtree_Element___deepcopy___impl(
(ElementObject *)object, memo);
Py_DECREF(object);
return res;
}
}

Expand All @@ -923,8 +947,11 @@ deepcopy(elementtreestate *st, PyObject *object, PyObject *memo)
return NULL;
}

Py_INCREF(object);
PyObject *args[2] = {object, memo};
return PyObject_Vectorcall(st->deepcopy_obj, args, 2, NULL);
PyObject *res = PyObject_Vectorcall(st->deepcopy_obj, args, 2, NULL);
Py_DECREF(object);
return res;
}


Expand Down
Loading