https://github.com/python/cpython/commit/58e01a1c7f18087c6cde0b462f6f6df975714b44
commit: 58e01a1c7f18087c6cde0b462f6f6df975714b44
branch: 3.12
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: ambv <luk...@langa.pl>
date: 2024-09-06T15:50:27+02:00
summary:
[3.12] gh-123431: Harmonize extension code checks in pickle (GH-123434)
(#123460)
This checks are redundant in normal circumstances and can only work if
the extension registry was intentionally broken.
(cherry picked from commit 0c3ea3023878f5ad5ca4680d5510da1fe208cbfa)
Co-authored-by: Serhiy Storchaka <storch...@gmail.com>
files:
M Lib/pickle.py
M Lib/test/pickletester.py
M Modules/_pickle.c
diff --git a/Lib/pickle.py b/Lib/pickle.py
index c4d6e658216f17..01c1a102794d57 100644
--- a/Lib/pickle.py
+++ b/Lib/pickle.py
@@ -397,6 +397,8 @@ def decode_long(data):
return int.from_bytes(data, byteorder='little', signed=True)
+_NoValue = object()
+
# Pickling machinery
class _Pickler:
@@ -1091,11 +1093,16 @@ def save_global(self, obj, name=None):
(obj, module_name, name))
if self.proto >= 2:
- code = _extension_registry.get((module_name, name))
- if code:
- assert code > 0
+ code = _extension_registry.get((module_name, name), _NoValue)
+ if code is not _NoValue:
if code <= 0xff:
- write(EXT1 + pack("<B", code))
+ data = pack("<B", code)
+ if data == b'\0':
+ # Should never happen in normal circumstances,
+ # since the type and the value of the code are
+ # checked in copyreg.add_extension().
+ raise RuntimeError("extension code 0 is out of range")
+ write(EXT1 + data)
elif code <= 0xffff:
write(EXT2 + pack("<H", code))
else:
@@ -1589,9 +1596,8 @@ def load_ext4(self):
dispatch[EXT4[0]] = load_ext4
def get_extension(self, code):
- nil = []
- obj = _extension_cache.get(code, nil)
- if obj is not nil:
+ obj = _extension_cache.get(code, _NoValue)
+ if obj is not _NoValue:
self.append(obj)
return
key = _inverted_registry.get(code)
diff --git a/Lib/test/pickletester.py b/Lib/test/pickletester.py
index 733ee8f50b6444..4a5976afa75118 100644
--- a/Lib/test/pickletester.py
+++ b/Lib/test/pickletester.py
@@ -1297,6 +1297,35 @@ def find_class(module_name, global_name):
self.assertEqual(loads(b'cmath\nlog\n.'), ('math', 'log'))
self.assertEqual(loads(b'\x8c\x04math\x8c\x03log\x93.'), ('math',
'log'))
+ def test_bad_ext_code(self):
+ # unregistered extension code
+ self.check_unpickling_error(ValueError, b'\x82\x01.')
+ self.check_unpickling_error(ValueError, b'\x82\xff.')
+ self.check_unpickling_error(ValueError, b'\x83\x01\x00.')
+ self.check_unpickling_error(ValueError, b'\x83\xff\xff.')
+ self.check_unpickling_error(ValueError, b'\x84\x01\x00\x00\x00.')
+ self.check_unpickling_error(ValueError, b'\x84\xff\xff\xff\x7f.')
+ # EXT specifies code <= 0
+ self.check_unpickling_error(pickle.UnpicklingError, b'\x82\x00.')
+ self.check_unpickling_error(pickle.UnpicklingError, b'\x83\x00\x00.')
+ self.check_unpickling_error(pickle.UnpicklingError,
b'\x84\x00\x00\x00\x00.')
+ self.check_unpickling_error(pickle.UnpicklingError,
b'\x84\x00\x00\x00\x80.')
+ self.check_unpickling_error(pickle.UnpicklingError,
b'\x84\xff\xff\xff\xff.')
+
+ @support.cpython_only
+ def test_bad_ext_inverted_registry(self):
+ code = 1
+ def check(key, exc):
+ with support.swap_item(copyreg._inverted_registry, code, key):
+ with self.assertRaises(exc):
+ self.loads(b'\x82\x01.')
+ check(None, ValueError)
+ check((), ValueError)
+ check((__name__,), (TypeError, ValueError))
+ check((__name__, "MyList", "x"), (TypeError, ValueError))
+ check((__name__, None), (TypeError, ValueError))
+ check((None, "MyList"), (TypeError, ValueError))
+
def test_bad_reduce(self):
self.assertEqual(self.loads(b'cbuiltins\nint\n)R.'), 0)
self.check_unpickling_error(TypeError, b'N)R.')
@@ -2033,6 +2062,28 @@ def persistent_id(self, obj):
check({Clearer(): 1, Clearer(): 2})
check({1: Clearer(), 2: Clearer()})
+ @support.cpython_only
+ def test_bad_ext_code(self):
+ # This should never happen in normal circumstances, because the type
+ # and the value of the extesion code is checked in
copyreg.add_extension().
+ key = (__name__, 'MyList')
+ def check(code, exc):
+ assert key not in copyreg._extension_registry
+ assert code not in copyreg._inverted_registry
+ with (support.swap_item(copyreg._extension_registry, key, code),
+ support.swap_item(copyreg._inverted_registry, code, key)):
+ for proto in protocols[2:]:
+ with self.assertRaises(exc):
+ self.dumps(MyList, proto)
+
+ check(object(), TypeError)
+ check(None, TypeError)
+ check(-1, (RuntimeError, struct.error))
+ check(0, RuntimeError)
+ check(2**31, (RuntimeError, OverflowError, struct.error))
+ check(2**1000, (OverflowError, struct.error))
+ check(-2**1000, (OverflowError, struct.error))
+
class AbstractPickleTests:
# Subclass must define self.dumps, self.loads.
diff --git a/Modules/_pickle.c b/Modules/_pickle.c
index 96534a565b3a83..831d53bc82f848 100644
--- a/Modules/_pickle.c
+++ b/Modules/_pickle.c
@@ -3725,31 +3725,23 @@ save_global(PickleState *st, PicklerObject *self,
PyObject *obj,
code_obj = PyDict_GetItemWithError(st->extension_registry,
extension_key);
Py_DECREF(extension_key);
- /* The object is not registered in the extension registry.
- This is the most likely code path. */
if (code_obj == NULL) {
if (PyErr_Occurred()) {
goto error;
}
+ /* The object is not registered in the extension registry.
+ This is the most likely code path. */
goto gen_global;
}
- /* XXX: pickle.py doesn't check neither the type, nor the range
- of the value returned by the extension_registry. It should for
- consistency. */
-
- /* Verify code_obj has the right type and value. */
- if (!PyLong_Check(code_obj)) {
- PyErr_Format(st->PicklingError,
- "Can't pickle %R: extension code %R isn't an integer",
- obj, code_obj);
- goto error;
- }
- code = PyLong_AS_LONG(code_obj);
+ Py_INCREF(code_obj);
+ code = PyLong_AsLong(code_obj);
+ Py_DECREF(code_obj);
if (code <= 0 || code > 0x7fffffffL) {
+ /* Should never happen in normal circumstances, since the type and
+ the value of the code are checked in copyreg.add_extension(). */
if (!PyErr_Occurred())
- PyErr_Format(st->PicklingError, "Can't pickle %R: extension "
- "code %ld is out of range", obj, code);
+ PyErr_Format(PyExc_RuntimeError, "extension code %ld is out of
range", code);
goto error;
}
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
