Skip to content

gh-130637: Add validation for numeric response data in stat() method #130646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 2, 2025
Merged

gh-130637: Add validation for numeric response data in stat() method #130646

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
18dfd83
gh-130637: Add validation for numeric response data in `stat()` method
Mr-Sunglasses Feb 27, 2025
f23be89
tests: Add tests for numeric response data in `stat()` method
Mr-Sunglasses Feb 28, 2025
46bc8bd
fix: add doc comment to ensures compliance with RFC 1939
Mr-Sunglasses Feb 28, 2025
a43b2ae
tests: Add tests to ensure it follows RFC 1939
Mr-Sunglasses Feb 28, 2025
513af11
chore: add NEWS entry for the change
Mr-Sunglasses Feb 28, 2025
dadeef1
fix: linting errors
Mr-Sunglasses Feb 28, 2025
782d075
Merge branch 'main' into fix/130637
ericvsmith Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Lib/poplib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,16 @@ def stat(self):
retval = self._shortcmd('STAT')
rets = retval.split()
if self._debugging: print('*stat*', repr(rets))
numMessages = int(rets[1])
sizeMessages = int(rets[2])

if len(rets) < 3:
raise error_proto("Invalid STAT response format")

try:
numMessages = int(rets[1])
sizeMessages = int(rets[2])
except ValueError:
raise error_proto("Invalid STAT response data: non-numeric values")

return (numMessages, sizeMessages)


Expand Down
21 changes: 21 additions & 0 deletions Lib/test/test_poplib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,27 @@ def test_pass_(self):
def test_stat(self):
self.assertEqual(self.client.stat(), (10, 100))

original_shortcmd = self.client._shortcmd
def mock_shortcmd_invalid_format(cmd):
if cmd == 'STAT':
return b'+OK'
return original_shortcmd(cmd)

self.client._shortcmd = mock_shortcmd_invalid_format
with self.assertRaises(poplib.error_proto):
self.client.stat()

def mock_shortcmd_invalid_data(cmd):
if cmd == 'STAT':
return b'+OK abc def'
return original_shortcmd(cmd)

self.client._shortcmd = mock_shortcmd_invalid_data
with self.assertRaises(poplib.error_proto):
self.client.stat()

self.client._shortcmd = original_shortcmd

def test_list(self):
self.assertEqual(self.client.list()[1:],
([b'1 1', b'2 2', b'3 3', b'4 4', b'5 5'],
Expand Down
Loading