Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions Lib/smtplib.py
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ def getreply(self):

def docmd(self, cmd, args=""):
"""Send a command, and return its response code."""

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this empty line to maintain the convention used in this file.

self.putcmd(cmd, args)
return self.getreply()

Expand Down Expand Up @@ -627,15 +628,15 @@ def auth(self, mechanism, authobject, *, initial_response_ok=True):
mechanism = mechanism.upper()
initial_response = (authobject() if initial_response_ok else None)
if initial_response is not None:
response = encode_base64(initial_response.encode('ascii'), eol='')
response = encode_base64(initial_response.encode('utf-8'), eol='')
(code, resp) = self.docmd("AUTH", mechanism + " " + response)
else:
(code, resp) = self.docmd("AUTH", mechanism)
# If server responds with a challenge, send the response.
if code == 334:
challenge = base64.decodebytes(resp)
response = encode_base64(
authobject(challenge).encode('ascii'), eol='')
authobject(challenge).encode('utf-8'), eol='')
(code, resp) = self.docmd(response)
if code in (235, 503):
return (code, resp)
Expand All @@ -648,7 +649,7 @@ def auth_cram_md5(self, challenge=None):
if challenge is None:
return None
return self.user + " " + hmac.HMAC(
self.password.encode('ascii'), challenge, 'md5').hexdigest()
self.password.encode('utf-8'), challenge, 'md5').hexdigest()

def auth_plain(self, challenge=None):
""" Authobject to use with PLAIN authentication. Requires self.user and
Expand Down
85 changes: 55 additions & 30 deletions Lib/test/test_smtplib.py
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,11 @@ def testLineTooLong(self):
'Mrs.C@somewhereesle.com':'Ruth C',
}

sim_auth = ('Mr.A@somewhere.com', 'somepassword')
sim_auth_latin = ('Mr.A@somewhere.com', 'somepassword')
sim_auth_nonlatin = ('Ms.D@example.com', 'p\u03B1sswor\u03B4')
sim_auth_nonvalid = ('Ms.E@example.com', '\ud800\ud800')

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "invalid" rather than "nonvalid", since "invalid" is actually a word.

sim_auth_lists = [sim_auth_latin, sim_auth_nonlatin]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be renamed to something like "valid_sim_auths".

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean rename sim_auth_lists to valid_sim_auths?


sim_cram_md5_challenge = ('PENCeUxFREJoU0NnbmhNWitOMjNGNn'
'dAZWx3b29kLmlubm9zb2Z0LmNvbT4=')
sim_lists = {'list-1':['Mr.A@somewhere.com','Mrs.C@somewhereesle.com'],
Expand Down Expand Up @@ -706,7 +710,7 @@ def _authenticated(self, user, valid):
self.smtp_state = self.COMMAND

def _decode_base64(self, string):
return base64.decodebytes(string.encode('ascii')).decode('utf-8')
return base64.decodebytes(string.encode('utf-8')).decode('utf-8')

def _auth_plain(self, arg=None):
if arg is None:
Expand All @@ -719,7 +723,7 @@ def _auth_plain(self, arg=None):
self.push('535 Splitting response {!r} into user and password'
' failed: {}'.format(logpass, e))
return
self._authenticated(user, password == sim_auth[1])
self._authenticated(user, password == self.sim_auth[1])

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using this sim_auth class attribute and changing it in test code is prone to side-effects, such as different tests affecting each other in a way that depends on the order they are run.

IMO it would be clearer if this were just a global variable.

Regardless, the tests should make sure to reset the global variable back to its default value when they are done, using a a helper method (utilizing .addCleanup()) or a context manager.


def _auth_login(self, arg=None):
if arg is None:
Expand All @@ -731,7 +735,7 @@ def _auth_login(self, arg=None):
self.push('334 UGFzc3dvcmQ6')
else:
password = self._decode_base64(arg)
self._authenticated(self._auth_login_user, password == sim_auth[1])
self._authenticated(self._auth_login_user, password == self.sim_auth[1])
del self._auth_login_user

def _auth_cram_md5(self, arg=None):
Expand All @@ -746,8 +750,8 @@ def _auth_cram_md5(self, arg=None):
'failed: {}'.format(logpass, e))
return False
valid_hashed_pass = hmac.HMAC(
sim_auth[1].encode('ascii'),
self._decode_base64(sim_cram_md5_challenge).encode('ascii'),
self.sim_auth[1].encode('utf-8'),
self._decode_base64(sim_cram_md5_challenge).encode('utf-8'),
'md5').hexdigest()
self._authenticated(user, hashed_pass == valid_hashed_pass)
# end AUTH related stuff.
Expand Down Expand Up @@ -920,57 +924,78 @@ def testEXPN(self):
users = []
for m in members:
users.append('%s %s' % (sim_users[m], smtplib.quoteaddr(m)))
expected_known = (250, bytes('\n'.join(users), "ascii"))
expected_known = (250, bytes('\n'.join(users), "utf-8"))
self.assertEqual(smtp.expn(listname), expected_known)

u = 'PSU-Members-List'
expected_unknown = (550, b'No access for you!')
self.assertEqual(smtp.expn(u), expected_unknown)
smtp.quit()

def testAUTH_PLAIN(self):
def testAUTH_PLAIN_nonvalid(self):
self.serv.add_feature("AUTH PLAIN")
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
with self.assertRaises(UnicodeEncodeError):
resp = smtp.login(sim_auth_nonvalid[0], sim_auth_nonvalid[1])
smtp.close()

def testAUTH_PLAIN(self):
self.serv.add_feature("AUTH PLAIN")
for sim_auth in sim_auth_lists:
with self.subTest(sim_auth=sim_auth):
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
SimSMTPChannel.sim_auth = sim_auth
resp = smtp.login(SimSMTPChannel.sim_auth[0], SimSMTPChannel.sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()

def testAUTH_LOGIN(self):
self.serv.add_feature("AUTH LOGIN")
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()
for sim_auth in sim_auth_lists:
with self.subTest(sim_auth=sim_auth):
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
SimSMTPChannel.sim_auth = sim_auth
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()

def testAUTH_CRAM_MD5(self):
self.serv.add_feature("AUTH CRAM-MD5")
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()
for sim_auth in sim_auth_lists:
with self.subTest(sim_auth=sim_auth):
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
SimSMTPChannel.sim_auth = sim_auth
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()

def testAUTH_multiple(self):
# Test that multiple authentication methods are tried.
self.serv.add_feature("AUTH BOGUS PLAIN LOGIN CRAM-MD5")
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()
for sim_auth in sim_auth_lists:
with self.subTest(sim_auth=sim_auth):
smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
SimSMTPChannel.sim_auth = sim_auth
resp = smtp.login(sim_auth[0], sim_auth[1])
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()

def test_auth_function(self):
supported = {'CRAM-MD5', 'PLAIN', 'LOGIN'}
for mechanism in supported:
self.serv.add_feature("AUTH {}".format(mechanism))
for mechanism in supported:
with self.subTest(mechanism=mechanism):
smtp = smtplib.SMTP(HOST, self.port,
local_hostname='localhost', timeout=15)
smtp.ehlo('foo')
smtp.user, smtp.password = sim_auth[0], sim_auth[1]
method = 'auth_' + mechanism.lower().replace('-', '_')
resp = smtp.auth(mechanism, getattr(smtp, method))
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()
for sim_auth in sim_auth_lists:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The with self.subTest(...) line should be in the internal loop, i.e. with self.subTest(mechanism=mechanism, sim_auth=sim_auth):

smtp = smtplib.SMTP(HOST, self.port,
local_hostname='localhost', timeout=15)
smtp.ehlo('foo')
SimSMTPChannel.sim_auth = sim_auth
smtp.user, smtp.password = sim_auth[0], sim_auth[1]
method = 'auth_' + mechanism.lower().replace('-', '_')
resp = smtp.auth(mechanism, getattr(smtp, method))
self.assertEqual(resp, (235, b'Authentication Succeeded'))
smtp.close()

def test_quit_resets_greeting(self):
smtp = smtplib.SMTP(HOST, self.port,
Expand Down