Fix buffer overflow in get_term_size() when using TIOCGWINSZ ioctl #342
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes a
SystemError: buffer overflowthat occurs when the dashboard tries to get the terminal size usingfcntl.ioctl()withTIOCGWINSZ.Problem
The current implementation allocates a 4-byte buffer for the
TIOCGWINSZioctl call:However,
TIOCGWINSZreturns a completestruct winsizewhich is 8 bytes, not 4 bytes. According to the man page, the structure contains:ws_row(2 bytes) - terminal rowsws_col(2 bytes) - terminal columnsws_xpixel(2 bytes) - horizontal pixelsws_ypixel(2 bytes) - vertical pixelsWhen the ioctl attempts to write 8 bytes into a 4-byte buffer, Python raises a buffer overflow error.
Solution
Changed the buffer size from 4 bytes to 8 bytes to accommodate the full
struct winsize:The code still only unpacks the first two shorts (height and width) as intended, but now provides adequate buffer space for the entire structure.
Also, we catch
SystemErrorin theexceptblock to fallback to the hardcoded values.