mirror of https://github.com/python/cpython
gh-74573: document that ndbm can silently corrupt databases on macOS (#113354)
* gh-74573: document that ndbm can silently corrupt databases on macOS The system ndbm implementation on macOS has an undocumented limitation on the size of values and can silently corrupt database files when those are exceeded. Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
This commit is contained in:
parent
6e02d79f96
commit
593b4d81d2
|
@ -272,6 +272,13 @@ This module can be used with the "classic" ndbm interface or the GNU GDBM
|
|||
compatibility interface. On Unix, the :program:`configure` script will attempt
|
||||
to locate the appropriate header file to simplify building this module.
|
||||
|
||||
.. warning::
|
||||
|
||||
The ndbm library shipped as part of macOS has an undocumented limitation on the
|
||||
size of values, which can result in corrupted database files
|
||||
when storing values larger than this limit. Reading such corrupted files can
|
||||
result in a hard crash (segmentation fault).
|
||||
|
||||
.. exception:: error
|
||||
|
||||
Raised on :mod:`dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
|
||||
|
|
|
@ -113,6 +113,9 @@ Restrictions
|
|||
differs across Unix versions and requires knowledge about the database
|
||||
implementation used.
|
||||
|
||||
* On macOS :mod:`dbm.ndbm` can silently corrupt the database file on updates,
|
||||
which can cause hard crashes when trying to read from the database.
|
||||
|
||||
|
||||
.. class:: Shelf(dict, protocol=None, writeback=False, keyencoding='utf-8')
|
||||
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
Document that :mod:`dbm.ndbm` can silently corrupt DBM files on updates when
|
||||
exceeding undocumented platform limits, and can crash (segmentation fault)
|
||||
when reading such a corrupted file. (FB8919203)
|
Loading…
Reference in New Issue