diff options
| author | Ronald Oussoren <ronaldoussoren@mac.com> | 2023-12-23 12:33:34 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-23 12:33:34 (GMT) |
| commit | 593b4d81d276b428f926debfe70d56ba94edf0e1 (patch) | |
| tree | 1fd46d8f7a6685552afa58bf521b2726d800f31d | |
| parent | 6e02d79f96b30bacdbc7a85e42040920b3dee915 (diff) | |
| download | cpython-593b4d81d276b428f926debfe70d56ba94edf0e1.zip cpython-593b4d81d276b428f926debfe70d56ba94edf0e1.tar.gz cpython-593b4d81d276b428f926debfe70d56ba94edf0e1.tar.bz2 | |
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>
| -rw-r--r-- | Doc/library/dbm.rst | 7 | ||||
| -rw-r--r-- | Doc/library/shelve.rst | 3 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/macOS/2023-12-21-11-53-47.gh-issue-74573.MA6Vys.rst | 3 |
3 files changed, 13 insertions, 0 deletions
diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 766847b..cb95c61 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -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 diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index 88802d7..95c5499 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -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') diff --git a/Misc/NEWS.d/next/macOS/2023-12-21-11-53-47.gh-issue-74573.MA6Vys.rst b/Misc/NEWS.d/next/macOS/2023-12-21-11-53-47.gh-issue-74573.MA6Vys.rst new file mode 100644 index 0000000..96dcd47 --- /dev/null +++ b/Misc/NEWS.d/next/macOS/2023-12-21-11-53-47.gh-issue-74573.MA6Vys.rst @@ -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) |