Skip to content

Commit

Permalink
feat: add support for EXTERNAL auth without uid (#193)
Browse files Browse the repository at this point in the history
  • Loading branch information
mvn23 committed Jan 7, 2023
1 parent 4c9a8fe commit 4939ef8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
10 changes: 10 additions & 0 deletions src/dbus_fast/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

from .errors import AuthError

UID_NOT_SPECIFIED = -1

# The auth interface here is unstable. I would like to eventually open this up
# for people to define their own custom authentication protocols, but I'm not
# familiar with what's needed for that exactly. To work with any message bus
Expand Down Expand Up @@ -57,6 +59,9 @@ class AuthExternal(Authenticator):
"""An authenticator class for the external auth protocol for use with the
:class:`MessageBus <dbus_fast.message_bus.BaseMessageBus>`.
:param uid: The uid to use when connecting to the message bus. Use UID_NOT_SPECIFIED to use the uid known to the kernel.
:vartype uid: int
:sealso: https://dbus.freedesktop.org/doc/dbus-specification.html#auth-protocol
"""

Expand All @@ -68,6 +73,8 @@ def __init__(self, uid: int = None) -> None:
def _authentication_start(self, negotiate_unix_fd: bool = False) -> str:
self.negotiate_unix_fd = negotiate_unix_fd
uid = self.uid
if uid == UID_NOT_SPECIFIED:
return "AUTH EXTERNAL"
if uid is None:
uid = os.getuid()
hex_uid = str(uid).encode().hex()
Expand All @@ -86,6 +93,9 @@ def _receive_line(self, line: str) -> str:
if response is _AuthResponse.AGREE_UNIX_FD:
return "BEGIN"

if response is _AuthResponse.DATA and self.uid == UID_NOT_SPECIFIED:
return "DATA"

raise AuthError(f"authentication failed: {response.value}: {args}")


Expand Down
12 changes: 11 additions & 1 deletion tests/test_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,19 @@

import pytest

from dbus_fast.auth import AuthExternal
from dbus_fast.auth import UID_NOT_SPECIFIED, AuthExternal
from dbus_fast.errors import AuthError


def test_uid_is_set():
auth = AuthExternal(uid=999)
assert auth._authentication_start() == "AUTH EXTERNAL 393939"


def test_auth_external_no_uid():
"""Test AuthExternal with UID_NOT_SPECIFIED"""
auth = AuthExternal(uid=UID_NOT_SPECIFIED)
assert auth._authentication_start() == "AUTH EXTERNAL"
assert auth._receive_line("DATA") == "DATA"
with pytest.raises(AuthError):
auth._receive_line("REJECTED")

0 comments on commit 4939ef8

Please sign in to comment.