Skip to content

Mask Connection password in Task SDK #71306

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.

Sign up for GitHub

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

Open
roshanprabu wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Open

Mask Connection password in Task SDK #71306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions task-sdk/src/airflow/sdk/definitions/connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,12 @@ def __init__(self, *, conn_id: str, uri: str | None = None, **kwargs) -> None:
else:
self.__dict__.update(attrs.asdict(self.from_uri(uri, conn_id=conn_id), recurse=False))

if self.password:
from airflow.sdk.log import mask_secret

mask_secret(self.password)
mask_secret(quote(self.password))

def get_uri(self) -> str:
"""Generate and return connection in URI format."""
from urllib.parse import parse_qsl
Expand Down
15 changes: 15 additions & 0 deletions task-sdk/tests/task_sdk/definitions/test_connection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,21 @@ def test_extra_dejson_property(self):
connection.extra = '{"auth": {"type": "oauth"}, "headers": {"User-Agent": "Airflow"}}'
assert connection.extra_dejson == {"auth": {"type": "oauth"}, "headers": {"User-Agent": "Airflow"}}

def test_password_is_masked(self):
"""Test that the password is masked, whether set via kwargs or a URI."""
from airflow.sdk._shared.secrets_masker import _secrets_masker

masker = _secrets_masker()
masker.reset_masker()

Connection(conn_id="test_conn", conn_type="azure", login="client_id", password="sp-secret")
assert masker.redact("sp-secret") == "***"

masker.reset_masker()

Connection.from_uri("azure://client_id:sp-secret@?tenantId=tenant", conn_id="test_conn")
assert masker.redact("sp-secret") == "***"


class TestConnectionsFromSecrets:
def test_get_connection_secrets_backend(self, mock_supervisor_comms, tmp_path):
Expand Down