Skip to content
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
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ supported, with a simulated behaviour for server that do not support
it.

For the ``AUTHENTICATE`` command, supported mechanisms are ``DIGEST-MD5``,
``PLAIN``, ``LOGIN`` and ``OAUTHBEARER``.
``PLAIN``, ``LOGIN``, ``OAUTHBEARER`` and ``XOAUTH2``.

Basic usage
^^^^^^^^^^^
Expand Down
23 changes: 22 additions & 1 deletion sievelib/managesieve.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"VERSION",
]

SUPPORTED_AUTH_MECHS = ["DIGEST-MD5", "PLAIN", "LOGIN", "OAUTHBEARER"]
SUPPORTED_AUTH_MECHS = ["DIGEST-MD5", "PLAIN", "LOGIN", "OAUTHBEARER", "XOAUTH2"]


class Error(Exception):
Expand Down Expand Up @@ -419,6 +419,27 @@
return True
return False

def _xoauth2_authentication(
self, login: bytes, password: bytes, authz_id: bytes = b""
) -> bool:
"""
OAUTHBEARER authentication.

:param login: username
:param password: access token
:return: True on success, False otherwise.
"""
if isinstance(login, str):
login = login.encode("utf-8")

Check warning on line 433 in sievelib/managesieve.py

View check run for this annotation

Codecov / codecov/patch

sievelib/managesieve.py#L433

Added line #L433 was not covered by tests
if isinstance(password, str):
password = password.encode("utf-8")

Check warning on line 435 in sievelib/managesieve.py

View check run for this annotation

Codecov / codecov/patch

sievelib/managesieve.py#L435

Added line #L435 was not covered by tests
token = b"user=" + login + b",\001auth=Bearer " + password + b"\001\001"
token = base64.b64encode(token)
code, data = self.__send_command("AUTHENTICATE", [b"XOAUTH2", token])
if code == "OK":
return True
return False

Check warning on line 441 in sievelib/managesieve.py

View check run for this annotation

Codecov / codecov/patch

sievelib/managesieve.py#L441

Added line #L441 was not covered by tests

def __authenticate(
self,
login: str,
Expand Down
9 changes: 7 additions & 2 deletions sievelib/tests/test_managesieve.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
CAPABILITIES = (
b'"IMPLEMENTATION" "Example1 ManageSieved v001"\r\n'
b'"VERSION" "1.0"\r\n'
b'"SASL" "PLAIN SCRAM-SHA-1 GSSAPI OAUTHBEARER"\r\n'
b'"SASL" "PLAIN SCRAM-SHA-1 GSSAPI OAUTHBEARER XOAUTH2"\r\n'
b'"SIEVE" "fileinto vacation"\r\n'
b'"STARTTLS"\r\n'
)

CAPABILITIES_WITHOUT_VERSION = (
b'"IMPLEMENTATION" "Example1 ManageSieved v001"\r\n'
b'"SASL" "PLAIN SCRAM-SHA-1 GSSAPI OAUTHBEARER"\r\n'
b'"SASL" "PLAIN SCRAM-SHA-1 GSSAPI OAUTHBEARER XOAUTH2"\r\n'
b'"SIEVE" "fileinto vacation"\r\n'
b'"STARTTLS"\r\n'
)
Expand Down Expand Up @@ -64,6 +64,11 @@ def test_auth_oauthbearer(self, mock_socket):
mock_socket.return_value.recv.side_effect = (AUTHENTICATION,)
self.assertTrue(self.client.connect("user", "token", authmech="OAUTHBEARER"))

def test_auth_xoauth2(self, mock_socket):
"""Test XOAUTH2 mechanism."""
mock_socket.return_value.recv.side_effect = (AUTHENTICATION,)
self.assertTrue(self.client.connect("user", "token", authmech="XOAUTH2"))

def test_capabilities(self, mock_socket):
"""Test capabilities command."""
self.authenticate(mock_socket)
Expand Down