diff options
author | Serhiy Storchaka <storchaka@gmail.com> | 2024-08-29 05:26:16 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-08-29 05:26:16 (GMT) |
commit | 0c3ea3023878f5ad5ca4680d5510da1fe208cbfa (patch) | |
tree | 0c7a53b10e14015079acd427e32c2db480a73075 | |
parent | c9930f5022f5e7a290896522280e47a1fecba38a (diff) | |
download | cpython-0c3ea3023878f5ad5ca4680d5510da1fe208cbfa.zip cpython-0c3ea3023878f5ad5ca4680d5510da1fe208cbfa.tar.gz cpython-0c3ea3023878f5ad5ca4680d5510da1fe208cbfa.tar.bz2 |
gh-123431: Harmonize extension code checks in pickle (GH-123434)
This checks are redundant in normal circumstances and can only work if
the extension registry was intentionally broken.
* The Python implementation now raises exception for the extension code
with false boolean value.
* Simplify the C code. RuntimeError is now raised in explicit checks.
* Add many tests.
-rw-r--r-- | Lib/pickle.py | 18 | ||||
-rw-r--r-- | Lib/test/pickletester.py | 51 | ||||
-rw-r--r-- | Modules/_pickle.c | 32 |
3 files changed, 73 insertions, 28 deletions
diff --git a/Lib/pickle.py b/Lib/pickle.py index b8e114a..ade0491 100644 --- a/Lib/pickle.py +++ b/Lib/pickle.py @@ -1086,11 +1086,16 @@ class _Pickler: module_name = whichmodule(obj, 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: @@ -1581,9 +1586,8 @@ class _Unpickler: 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 db42f13..2e16b6b 100644 --- a/Lib/test/pickletester.py +++ b/Lib/test/pickletester.py @@ -1311,6 +1311,35 @@ class AbstractUnpickleTests: 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.') @@ -2163,6 +2192,28 @@ class AbstractPicklingErrorTests: 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 dc0ef0a..3efc05e 100644 --- a/Modules/_pickle.c +++ b/Modules/_pickle.c @@ -3650,34 +3650,24 @@ save_global(PickleState *st, PicklerObject *self, PyObject *obj, if (extension_key == NULL) { goto error; } - code_obj = PyDict_GetItemWithError(st->extension_registry, - extension_key); + if (PyDict_GetItemRef(st->extension_registry, extension_key, &code_obj) < 0) { + Py_DECREF(extension_key); + goto error; + } 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); + 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; } |