Skip to content
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.

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

Handle encoded password in EMAIL_URL #433

Merged
merged 2 commits into from
Oct 2, 2023
Merged
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
13 changes: 8 additions & 5 deletions fittrackee/emails/email.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
from typing import Dict, List, Optional, Type, Union
from urllib.parse import unquote

from babel.support import Translations
from flask import Flask
Expand Down Expand Up @@ -131,18 +132,20 @@ def parse_email_url(email_url: str) -> Dict:
parsed_url = parse_url(email_url)
if parsed_url.scheme != 'smtp':
raise InvalidEmailUrlScheme()
credentials = (
username, password = (
parsed_url.auth.split(':')
if parsed_url.auth
else [None, None] # type: ignore
)
return {
'host': parsed_url.host,
'port': 25 if parsed_url.port is None else parsed_url.port,
'use_tls': True if parsed_url.query == 'tls=True' else False,
'use_ssl': True if parsed_url.query == 'ssl=True' else False,
'username': credentials[0],
'password': credentials[1],
'use_tls': parsed_url.query == 'tls=True',
'use_ssl': parsed_url.query == 'ssl=True',
'username': username,
'password': (
unquote(password) if isinstance(password, str) else password
),
}

@property
Expand Down
23 changes: 23 additions & 0 deletions fittrackee/tests/emails/test_email_service.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from unittest.mock import Mock, patch
from urllib.parse import quote

import pytest
from flask import Flask
Expand Down Expand Up @@ -43,6 +44,7 @@ def test_it_raises_error_if_url_scheme_is_invalid(self) -> None:
@staticmethod
def assert_parsed_email(url: str) -> None:
parsed_email = email_service.parse_email_url(url)

assert parsed_email['username'] is None
assert parsed_email['password'] is None
assert parsed_email['host'] == 'localhost'
Expand All @@ -60,7 +62,9 @@ def test_it_parses_email_url_without_authentication(self) -> None:

def test_it_parses_email_url(self) -> None:
url = 'smtp://[email protected]:12345678@localhost:25'

parsed_email = email_service.parse_email_url(url)

assert parsed_email['username'] == '[email protected]'
assert parsed_email['password'] == '12345678'
assert parsed_email['host'] == 'localhost'
Expand All @@ -70,7 +74,9 @@ def test_it_parses_email_url(self) -> None:

def test_it_parses_email_url_with_tls(self) -> None:
url = 'smtp://[email protected]:12345678@localhost:587?tls=True'

parsed_email = email_service.parse_email_url(url)

assert parsed_email['username'] == '[email protected]'
assert parsed_email['password'] == '12345678'
assert parsed_email['host'] == 'localhost'
Expand All @@ -80,14 +86,31 @@ def test_it_parses_email_url_with_tls(self) -> None:

def test_it_parses_email_url_with_ssl(self) -> None:
url = 'smtp://[email protected]:12345678@localhost:465?ssl=True'

parsed_email = email_service.parse_email_url(url)

assert parsed_email['username'] == '[email protected]'
assert parsed_email['password'] == '12345678'
assert parsed_email['host'] == 'localhost'
assert parsed_email['port'] == 465
assert parsed_email['use_tls'] is False
assert parsed_email['use_ssl'] is True

def test_it_parses_email_url_with_encoded_password(self) -> None:
username = "[email protected]"
password = "passwordWith@And&And?"
encoded_password = quote(password)
url = f"smtp://{username}:{encoded_password}@localhost:465?ssl=True"

parsed_email = email_service.parse_email_url(url)

assert parsed_email['username'] == username
assert parsed_email['password'] == password
assert parsed_email['host'] == 'localhost'
assert parsed_email['port'] == 465
assert parsed_email['use_tls'] is False
assert parsed_email['use_ssl'] is True


class TestEmailServiceSend(CallArgsMixin):
email_data = {
Expand Down