Skip to content

Commit fd0f7e2

Browse files
Add auth_protocol support to SambaHook for Kerberos authentication #29590 (#64643)
1 parent 3c37b47 commit fd0f7e2

7 files changed

Lines changed: 210 additions & 15 deletions

File tree

‎providers/samba/docs/index.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,12 @@ Install them when installing from PyPI. For example:
134134
pip install apache-airflow-providers-samba[google]
135135
136136
137-
========== ===================================
138-
Extra Dependencies
139-
========== ===================================
140-
``google`` ``apache-airflow-providers-google``
141-
========== ===================================
137+
============ ==========================================
138+
Extra Dependencies
139+
============ ==========================================
140+
``google`` ``apache-airflow-providers-google``
141+
``kerberos`` ``krb5``, ``smbprotocol[kerberos]>=1.5.0``
142+
============ ==========================================
142143

143144
Downloading official packages
144145
-----------------------------

‎providers/samba/provider.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,20 @@ connection-types:
9898
description: >-
9999
The share OS type (`posix` or `windows`).
100100
Used to determine the formatting of file and folder paths.
101+
auth_protocol:
102+
label: Auth Protocol
103+
schema:
104+
type:
105+
- string
106+
- 'null'
107+
default: negotiate
108+
enum:
109+
- negotiate
110+
- ntlm
111+
- kerberos
112+
description: >-
113+
Must be one of: negotiate, ntlm, kerberos. With `kerberos`, the system's
114+
ticket cache is used and login/password are optional.
101115
ui-field-behaviour:
102116
hidden-fields: []
103117
relabeling:

‎providers/samba/pyproject.toml‎

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

7478
[dependency-groups]
7579
dev = [

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,16 @@ def get_provider_info():
5353
"label": "Share Type",
5454
"schema": {"type": ["string", "null"], "default": "posix"},
5555
"description": "The share OS type (`posix` or `windows`). Used to determine the formatting of file and folder paths.",
56-
}
56+
},
57+
"auth_protocol": {
58+
"label": "Auth Protocol",
59+
"schema": {
60+
"type": ["string", "null"],
61+
"default": "negotiate",
62+
"enum": ["negotiate", "ntlm", "kerberos"],
63+
},
64+
"description": "Must be one of: negotiate, ntlm, kerberos. With `kerberos`, the system's ticket cache is used and login/password are optional.",
65+
},
5766
},
5867
"ui-field-behaviour": {"hidden-fields": [], "relabeling": {"schema": "Share"}},
5968
}

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

Lines changed: 48 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,59 @@ 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+
legacy_auth = extra.get("auth")
69+
legacy_auth_protocol = (
70+
legacy_auth
71+
if isinstance(legacy_auth, str) and legacy_auth in self.VALID_AUTH_PROTOCOLS
72+
else "negotiate"
73+
)
74+
self._auth_protocol: str = auth_protocol or extra.get("auth_protocol", legacy_auth_protocol)
75+
if self._auth_protocol not in self.VALID_AUTH_PROTOCOLS:
76+
raise ValueError(
77+
f"Invalid auth_protocol '{self._auth_protocol}'. "
78+
f"Must be one of {sorted(self.VALID_AUTH_PROTOCOLS)}."
79+
)
6180

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

65-
if not conn.password:
95+
if not conn.password and not uses_kerberos:
6696
self.log.info("Password not provided")
6797

68-
self._share_type = share_type or conn.extra_dejson.get("share_type", "posix")
98+
self._share_type = share_type or extra.get("share_type", "posix")
6999
if self._share_type not in {"posix", "windows"}:
70100
self._share_type = "posix"
71101
self.log.warning(
@@ -77,11 +107,12 @@ def __init__(
77107
self._host = conn.host
78108
self._share = share or conn.schema
79109
self._connection_cache = connection_cache
80-
self._conn_kwargs = {
110+
self._conn_kwargs: dict[str, Any] = {
81111
"username": conn.login,
82112
"password": conn.password,
83113
"port": conn.port or 445,
84114
"connection_cache": connection_cache,
115+
"auth_protocol": self._auth_protocol,
85116
}
86117

87118
def __enter__(self):
@@ -325,12 +356,22 @@ def get_ui_field_behaviour(cls) -> dict[str, Any]:
325356
def get_connection_form_widgets(cls) -> dict[str, Any]:
326357
"""Return connection widgets to add to connection form."""
327358
from flask_babel import lazy_gettext
328-
from wtforms import StringField
359+
from wtforms import SelectField, StringField
329360

330361
return {
331362
"share_type": StringField(
332363
label=lazy_gettext("Share Type"),
333364
description="The share OS type (`posix` or `windows`). Used to determine the formatting of file and folder paths.",
334365
default="posix",
335-
)
366+
),
367+
"auth_protocol": SelectField(
368+
label=lazy_gettext("Auth Protocol"),
369+
description=(
370+
"Authentication protocol: `negotiate` (auto-select, default), "
371+
"`ntlm`, or `kerberos`. When using `kerberos`, the system's "
372+
"Kerberos ticket cache is used and username/password are optional."
373+
),
374+
choices=["negotiate", "ntlm", "kerberos"],
375+
default="negotiate",
376+
),
336377
}

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

Lines changed: 116 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,116 @@ 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("smbclient.register_session")
251+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
252+
def test_legacy_auth_key_ignored_when_invalid(self, get_conn_mock, register_session):
253+
"""Test that extra {"auth": "basic"} is ignored and defaults to negotiate."""
254+
connection = Connection(
255+
host="host",
256+
schema="share",
257+
login="user",
258+
password="pass",
259+
extra='{"auth": "basic"}',
260+
)
261+
get_conn_mock.return_value = connection
262+
register_session.return_value = None
263+
with SambaHook("samba_default"):
264+
_, kwargs = tuple(register_session.call_args_list[0])
265+
assert kwargs["auth_protocol"] == "negotiate"
266+
267+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
268+
def test_invalid_auth_protocol_raises(self, get_conn_mock):
269+
"""Test that an invalid auth_protocol raises ValueError."""
270+
connection = Connection(
271+
host="host",
272+
schema="share",
273+
extra='{"auth_protocol": "invalid"}',
274+
)
275+
get_conn_mock.return_value = connection
276+
with pytest.raises(ValueError, match="Invalid auth_protocol 'invalid'"):
277+
SambaHook("samba_default")
278+
279+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
280+
def test_kerberos_without_dependency_raises(self, get_conn_mock):
281+
"""Test that kerberos auth without krb5 installed raises AirflowOptionalProviderFeatureException."""
282+
connection = Connection(
283+
host="kerb-host.example.com",
284+
schema="share",
285+
extra='{"auth_protocol": "kerberos"}',
286+
)
287+
get_conn_mock.return_value = connection
288+
with mock.patch.dict("sys.modules", {"krb5": None}):
289+
with pytest.raises(AirflowOptionalProviderFeatureException, match="krb5"):
290+
SambaHook("samba_default")
291+
292+
@mock.patch("smbclient.register_session")
293+
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
294+
def test_ntlm_auth(self, get_conn_mock, register_session):
295+
"""Test that auth_protocol='ntlm' is passed correctly."""
296+
connection = Connection(
297+
host="host",
298+
schema="share",
299+
login="user",
300+
password="pass",
301+
extra='{"auth_protocol": "ntlm"}',
302+
)
303+
get_conn_mock.return_value = connection
304+
register_session.return_value = None
305+
with SambaHook("samba_default"):
306+
_, kwargs = tuple(register_session.call_args_list[0])
307+
assert kwargs["auth_protocol"] == "ntlm"
308+
194309
@mock.patch("airflow.providers.samba.hooks.samba.smbclient.open_file", return_value=mock.Mock())
195310
@mock.patch(f"{BASEHOOK_PATCH_PATH}.get_connection")
196311
def test_open_file(self, get_conn_mock, open_file_mock):

‎uv.lock‎

Lines changed: 12 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)