darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-01-30 06:21:50 -05:00
Code Issues Packages Projects Releases Wiki Activity

punycode encode emails before sending

Browse Source 
amazon SES only accepts domains encoded in punycode, an encoding that
converts utf-8 into an ascii encoding that browsers and mailservers
recognise.

We currently just send through emails as we store them (in full
unicode), which means any rogue characters break SES and cause us to
put the email in technical-failure. Most of these appear to be typos
and rogue control characters, but there is a small chance that it could
be a real domain (eg https://🅂𝖍𝐤ₛᵖ𝒓.ⓜ𝕠𝒃𝓲/🆆🆃🅵/).

We should encode to and reply-to-address emails as punycode to make
sure that they can always be sent. The chance that anyone actually uses
a unicode domain name for their email is probably pretty low, but we
should allow it for completeness.
This commit is contained in:
Leo Hemsted
2019-08-12 13:53:22 +01:00
parent 4056e335cc
commit 09d6c60ff1
2 changed files with 40 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
tests/app/clients/test_aws_ses.py
View File

@@ -45,21 +45,21 @@ def test_should_be_none_if_unrecognised_status_code():
assert '99' in str(e.value)
@pytest.mark.parametrize(
'reply_to_address, expected_value',
[(None, []), ('foo@bar.com', ['foo@bar.com'])],
ids=['empty', 'single_email']
)
@pytest.mark.parametrize('reply_to_address, expected_value', [
(None, []),
('foo@bar.com', ['foo@bar.com']),
('føøøø@bååååår.com', ['føøøø@xn--br-yiaaaaa.com'])
], ids=['empty', 'single_email', 'punycode'])
def test_send_email_handles_reply_to_address(notify_api, mocker, reply_to_address, expected_value):
boto_mock = mocker.patch.object(aws_ses_client, '_client', create=True)
mocker.patch.object(aws_ses_client, 'statsd_client', create=True)
with notify_api.app_context():
aws_ses_client.send_email(
Mock(),
Mock(),
Mock(),
Mock(),
source=Mock(),
to_addresses='to@address.com',
subject=Mock(),
body=Mock(),
reply_to_address=reply_to_address
)
@@ -71,6 +71,26 @@ def test_send_email_handles_reply_to_address(notify_api, mocker, reply_to_addres
)
def test_send_email_handles_punycode_to_address(notify_api, mocker):
boto_mock = mocker.patch.object(aws_ses_client, '_client', create=True)
mocker.patch.object(aws_ses_client, 'statsd_client', create=True)
with notify_api.app_context():
aws_ses_client.send_email(
Mock(),
to_addresses='føøøø@bååååår.com',
subject=Mock(),
body=Mock()
)
boto_mock.send_email.assert_called_once_with(
Source=ANY,
Destination={'ToAddresses': ['føøøø@xn--br-yiaaaaa.com'], 'CcAddresses': [], 'BccAddresses': []},
Message=ANY,
ReplyToAddresses=ANY
)
def test_send_email_raises_bad_email_as_InvalidEmailError(mocker):
boto_mock = mocker.patch.object(aws_ses_client, '_client', create=True)
mocker.patch.object(aws_ses_client, 'statsd_client', create=True)
@@ -87,13 +107,13 @@ def test_send_email_raises_bad_email_as_InvalidEmailError(mocker):
with pytest.raises(InvalidEmailError) as excinfo:
aws_ses_client.send_email(
source=Mock(),
to_addresses='clearly@invalid@email.com',
to_addresses='definitely@invalid_email.com',
subject=Mock(),
body=Mock()
)
assert 'some error message from amazon' in str(excinfo.value)
assert 'clearly@invalid@email.com' in str(excinfo.value)
assert 'definitely@invalid_email.com' in str(excinfo.value)
def test_send_email_raises_other_errs_as_AwsSesClientException(mocker):
@@ -112,7 +132,7 @@ def test_send_email_raises_other_errs_as_AwsSesClientException(mocker):
with pytest.raises(AwsSesClientException) as excinfo:
aws_ses_client.send_email(
source=Mock(),
to_addresses=Mock(),
to_addresses='foo@bar.com',
subject=Mock(),
body=Mock()
)