Skip to content

Commit ddc0ba7

Browse files
committed
Add auth_protocol support to SambaHook for Kerberos authentication apache#29590
1 parent 1b28933 commit ddc0ba7

4 files changed

Lines changed: 157 additions & 10 deletions

File tree

‎providers/samba/pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ dependencies = [
7070
"google" = [
7171
"apache-airflow-providers-google"
7272
]
73+
"kerberos" = [
74+
"smbprotocol[kerberos]>=1.5.0",
75+
]
7376

7477
[dependency-groups]
7578
dev = [

‎providers/samba/src/airflow/providers/samba/hooks/samba.py‎

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
import smbclient
2626

27-
from airflow.providers.common.compat.sdk import BaseHook
27+
from airflow.providers.common.compat.sdk import AirflowOptionalProviderFeatureException, BaseHook
2828

2929
if TYPE_CHECKING:
3030
import smbprotocol.connection
@@ -43,29 +43,55 @@ class SambaHook(BaseHook):
4343
the connection is used in its place.
4444
:param share_type:
4545
An optional share type name. If this is unset then it will assume a posix share type.
46+
:param auth_protocol:
47+
An optional authentication protocol. If this is unset then it defaults to negotiate.
4648
"""
4749

4850
conn_name_attr = "samba_conn_id"
4951
default_conn_name = "samba_default"
5052
conn_type = "samba"
5153
hook_name = "Samba"
5254

55+
VALID_AUTH_PROTOCOLS = {"negotiate", "ntlm", "kerberos"}
56+
5357
def __init__(
5458
self,
5559
samba_conn_id: str = default_conn_name,
5660
share: str | None = None,
5761
share_type: Literal["posix", "windows"] | None = None,
62+
auth_protocol: Literal["negotiate", "ntlm", "kerberos"] | None = None,
5863
) -> None:
5964
super().__init__()
6065
conn = self.get_connection(samba_conn_id)
66+
extra = conn.extra_dejson
67+
68+
self._auth_protocol: str = (
69+
auth_protocol or extra.get("auth_protocol") or extra.get("auth") or "negotiate"
70+
)
71+
if self._auth_protocol not in self.VALID_AUTH_PROTOCOLS:
72+
raise ValueError(
73+
f"Invalid auth_protocol '{self._auth_protocol}'. "
74+
f"Must be one of {sorted(self.VALID_AUTH_PROTOCOLS)}."
75+
)
6176

62-
if not conn.login:
77+
uses_kerberos = self._auth_protocol == "kerberos"
78+
79+
if uses_kerberos:
80+
try:
81+
import krb5 # noqa: F401
82+
except ImportError:
83+
raise AirflowOptionalProviderFeatureException(
84+
"Kerberos authentication requires the 'krb5' package. "
85+
"Install it with: pip install 'apache-airflow-providers-samba[kerberos]'"
86+
)
87+
88+
if not conn.login and not uses_kerberos:
6389
self.log.info("Login not provided")
6490

65-
if not conn.password:
91+
if not conn.password and not uses_kerberos:
6692
self.log.info("Password not provided")
6793

68-
self._share_type = share_type or conn.extra_dejson.get("share_type", "posix")
94+
self._share_type = share_type or extra.get("share_type", "posix")
6995
if self._share_type not in {"posix", "windows"}:
7096
self._share_type = "posix"
7197
self.log.warning(
@@ -77,11 +103,12 @@ def __init__(
77103
self._host = conn.host
78104
self._share = share or conn.schema
79105
self._connection_cache = connection_cache
80-
self._conn_kwargs = {
106+
self._conn_kwargs: dict[str, Any] = {
81107
"username": conn.login,
82108
"password": conn.password,
83109
"port": conn.port or 445,
84110
"connection_cache": connection_cache,
111+
"auth_protocol": self._auth_protocol,
85112
}
86113

87114
def __enter__(self):
@@ -325,12 +352,22 @@ def get_ui_field_behaviour(cls) -> dict[str, Any]:
325352
def get_connection_form_widgets(cls) -> dict[str, Any]:
326353
"""Return connection widgets to add to connection form."""
327354
from flask_babel import lazy_gettext
328-
from wtforms import StringField
355+
from wtforms import SelectField, StringField
329356

330357
return {
331358
"share_type": StringField(
332359
label=lazy_gettext("Share Type"),
333360
description="The share OS type (`posix` or `windows`). Used to determine the formatting of file and folder paths.",
334361
default="posix",
335-
)
362+
),
363+
"auth_protocol": SelectField(
364+
label=lazy_gettext("Auth Protocol"),
365+
description=(
366+
"Authentication protocol: `negotiate` (auto-select, default), "
367+
"`ntlm`, or `kerberos`. When using `kerberos`, the system's "
368+
"Kerberos ticket cache is used and username/password are optional."
369+
),
370+
choices=["negotiate", "ntlm", "kerberos"],
371+
default="negotiate",
372+
),
336373
}

‎providers/samba/tests/unit/samba/hooks/test_samba.py‎

Lines changed: 99 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323
import pytest
2424

2525
from airflow.models import Connection
26-
from airflow.providers.common.compat.sdk import AirflowNotFoundException
26+
from airflow.providers.common.compat.sdk import (
27+
AirflowNotFoundException,
28+
AirflowOptionalProviderFeatureException,
29+
)
2730
from airflow.providers.samba.hooks.samba import SambaHook
2831

2932
try:
@@ -63,6 +66,7 @@ def test_context_manager(self, get_conn_mock, register_session):
6366
"password": CONNECTION.password,
6467
"port": 445,
6568
"connection_cache": {},
69+
"auth_protocol": "negotiate",
6670
}
6771
cache = kwargs.get("connection_cache")
6872
mock_connection = mock.Mock()
@@ -117,6 +121,7 @@ def test_method(self, get_conn_mock, name):
117121
"username": CONNECTION.login,
118122
"password": CONNECTION.password,
119123
"port": 445,
124+
"auth_protocol": "negotiate",
120125
}
121126
with mock.patch("smbclient." + name) as p:
122127
kwargs = {}
@@ -191,6 +196,99 @@ def test__join_path(
191196
hook = SambaHook("samba_default", share_type=path_type)
192197
assert hook._join_path(path) == full_path
193198

199+
@mock.patch.dict("sys.modules", {"krb5": mock.MagicMock()})
200+
@mock.patch("smbclient.register_session")
201+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
202+
def test_kerberos_auth_via_extra(self, get_conn_mock, register_session):
203+
"""Test that auth_protocol='kerberos' from extra is passed to smbclient."""
204+
connection = Connection(
205+
host="kerb-host.example.com",
206+
schema="share",
207+
extra='{"auth_protocol": "kerberos"}',
208+
)
209+
get_conn_mock.return_value = connection
210+
register_session.return_value = None
211+
with SambaHook("samba_default"):
212+
_, kwargs = tuple(register_session.call_args_list[0])
213+
assert kwargs["auth_protocol"] == "kerberos"
214+
assert kwargs["username"] is None
215+
assert kwargs["password"] is None
216+
217+
@mock.patch.dict("sys.modules", {"krb5": mock.MagicMock()})
218+
@mock.patch("smbclient.register_session")
219+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
220+
def test_kerberos_auth_via_legacy_auth_key(self, get_conn_mock, register_session):
221+
"""Test backward compat: extra {"auth": "kerberos"} is recognized."""
222+
connection = Connection(
223+
host="kerb-host.example.com",
224+
schema="share",
225+
extra='{"auth": "kerberos"}',
226+
)
227+
get_conn_mock.return_value = connection
228+
register_session.return_value = None
229+
with SambaHook("samba_default"):
230+
_, kwargs = tuple(register_session.call_args_list[0])
231+
assert kwargs["auth_protocol"] == "kerberos"
232+
233+
@mock.patch.dict("sys.modules", {"krb5": mock.MagicMock()})
234+
@mock.patch("smbclient.register_session")
235+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
236+
def test_kerberos_auth_via_constructor(self, get_conn_mock, register_session):
237+
"""Test that constructor auth_protocol overrides extra."""
238+
connection = Connection(
239+
host="kerb-host.example.com",
240+
schema="share",
241+
login="user",
242+
password="pass",
243+
)
244+
get_conn_mock.return_value = connection
245+
register_session.return_value = None
246+
with SambaHook("samba_default", auth_protocol="kerberos"):
247+
_, kwargs = tuple(register_session.call_args_list[0])
248+
assert kwargs["auth_protocol"] == "kerberos"
249+
250+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
251+
def test_invalid_auth_protocol_raises(self, get_conn_mock):
252+
"""Test that an invalid auth_protocol raises ValueError."""
253+
connection = Connection(
254+
host="host",
255+
schema="share",
256+
extra='{"auth_protocol": "invalid"}',
257+
)
258+
get_conn_mock.return_value = connection
259+
with pytest.raises(ValueError, match="Invalid auth_protocol 'invalid'"):
260+
SambaHook("samba_default")
261+
262+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
263+
def test_kerberos_without_dependency_raises(self, get_conn_mock):
264+
"""Test that kerberos auth without krb5 installed raises AirflowOptionalProviderFeatureException."""
265+
connection = Connection(
266+
host="kerb-host.example.com",
267+
schema="share",
268+
extra='{"auth_protocol": "kerberos"}',
269+
)
270+
get_conn_mock.return_value = connection
271+
with mock.patch.dict("sys.modules", {"krb5": None}):
272+
with pytest.raises(AirflowOptionalProviderFeatureException, match="krb5"):
273+
SambaHook("samba_default")
274+
275+
@mock.patch("smbclient.register_session")
276+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
277+
def test_ntlm_auth(self, get_conn_mock, register_session):
278+
"""Test that auth_protocol='ntlm' is passed correctly."""
279+
connection = Connection(
280+
host="host",
281+
schema="share",
282+
login="user",
283+
password="pass",
284+
extra='{"auth_protocol": "ntlm"}',
285+
)
286+
get_conn_mock.return_value = connection
287+
register_session.return_value = None
288+
with SambaHook("samba_default"):
289+
_, kwargs = tuple(register_session.call_args_list[0])
290+
assert kwargs["auth_protocol"] == "ntlm"
291+
194292
@mock.patch("airflow.providers.samba.hooks.samba.smbclient.open_file", return_value=mock.Mock())
195293
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
196294
def test_open_file(self, get_conn_mock, open_file_mock):

‎uv.lock‎

Lines changed: 11 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)