amoghrajesh opened a new pull request, #59566:
URL: https://github.com/apache/airflow/pull/59566
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
### Problem & Solution
When rendered template fields in a dag exceed the max_templated_field_length
(default is 4096 characters), data could be exposed in cleartext in the
Rendered Templates UI. This occurred because serialization of those fields
while sending to API server used a secret masker instance without patterns
registered via mask_secret() calls (ie, it used core secrets masker but
patterns were registered against sdk secrets masker). This was a ripple effect
of moving secrets masker onto the shared library:
https://github.com/apache/airflow/pull/54449
The fix is to create a local `_serialize_template_field()` function in
task_runner that uses the SDK secrets masker, which contains patterns
registered via `mask_secret()` calls in user dag code. This ensures secrets are
properly masked before truncation occurs.
This fix is anyways in line with our 3.2 goal of client server separation by
getting rid of the `serialize_template_field` import from airflow core in task
sdk.
### Testing
Defined a macro via a plugin like this:
```python
from airflow.plugins_manager import AirflowPlugin
from airflow.sdk.log import mask_secret
def mask_str(var: str):
"""
Takes a string and masks it.
Returns the same string for templating.
"""
mask_secret(var)
return var
class TruncMacrosPlugin(AirflowPlugin):
name = "trunc_macro"
macros = [mask_str]
```
DAG:
```python
import json
from datetime import datetime
from airflow.providers.standard.operators.bash import BashOperator
from airflow.sdk import DAG
with DAG('trunc_dag', start_date=datetime(2024, 1, 1), schedule=None) as dag:
env = {}
secret = "postgresql+psycopg2://username:testpass123@host/db"
for i in range(70):
env[f"URL_{i}"] = f"{{{{ macros.trunc_macro.mask_str('{secret}')
}}}}"
print("len of env is", len(json.dumps(env, indent=4)))
task = BashOperator(
task_id="example",
bash_command="echo done",
env=env,
)
```
Before:
<img width="2466" height="1242" alt="image"
src="https://github.com/user-attachments/assets/aefc1c8b-4a7e-4ee2-8bc5-a88d5d2439bc";
/>
After:
<img width="2466" height="1242" alt="image"
src="https://github.com/user-attachments/assets/acc39412-8bc0-4b96-a360-c3e4a53b50a3";
/>
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
