jason810496 commented on code in PR #64148:
URL: https://github.com/apache/airflow/pull/64148#discussion_r2999103502
##########
airflow-core/src/airflow/api_fastapi/core_api/datamodels/xcom.py:
##########
@@ -90,6 +90,29 @@ class XComCreateBody(StrictBaseModel):
value: Any
map_index: int = -1
+ @field_validator("value")
+ @classmethod
+ def _check_forbidden_keys(cls, value: Any) -> Any:
+ """Recursively check for forbidden deserialization keys in
user-provided XCom data."""
+ from airflow._shared.serialization import FORBIDDEN_XCOM_KEYS
+
+ def _check_forbidden_keys(obj: Any, path: str = "value") -> None:
+ if isinstance(obj, dict):
+ found = FORBIDDEN_XCOM_KEYS & obj.keys()
+ if found:
+ raise ValueError(
+ f"XCom {path} contains reserved serialization keys:
{', '.join(sorted(found))}. "
+ f"These keys are reserved for internal use."
+ )
+ for k, v in obj.items():
+ _check_forbidden_keys(v, f"{path}.{k}")
+ elif isinstance(obj, (list, tuple)):
+ for i, item in enumerate(obj):
+ _check_forbidden_keys(item, f"{path}[{i}]")
+
+ _check_forbidden_keys(value)
+ return value
Review Comment:
Minor suggestion on the inner helper name as it's same as the outer method
name.
```suggestion
def _check_forbidden_keys(cls, value: Any) -> Any:
"""Recursively check for forbidden deserialization keys in
user-provided XCom data."""
from airflow._shared.serialization import FORBIDDEN_XCOM_KEYS
def _walk_forbidden_keys(obj: Any, path: str = "value") -> None:
if isinstance(obj, dict):
found = FORBIDDEN_XCOM_KEYS & obj.keys()
if found:
raise ValueError(
f"XCom {path} contains reserved serialization keys:
{', '.join(sorted(found))}. "
f"These keys are reserved for internal use."
)
for k, v in obj.items():
_walk_forbidden_keys(v, f"{path}.{k}")
elif isinstance(obj, (list, tuple)):
for i, item in enumerate(obj):
_walk_forbidden_keys(item, f"{path}[{i}]")
_walk_forbidden_keys(value)
return value
```
##########
shared/serialization/src/airflow_shared/serialization/__init__.py:
##########
@@ -0,0 +1,43 @@
+# 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.
+from __future__ import annotations
+
+# Current serialization format keys
+CLASSNAME = "__classname__"
+VERSION = "__version__"
+DATA = "__data__"
+SCHEMA_ID = "__id__"
+CACHE = "__cache__"
+
+# Legacy serialization format keys (processed by serde for backwards
compatibility)
+OLD_TYPE = "__type"
+OLD_SOURCE = "__source"
+OLD_DATA = "__var"
+OLD_DICT = "dict"
+
+FORBIDDEN_XCOM_KEYS = frozenset(
Review Comment:
Perhaps it would be better to add more context to the further reviewers?
```suggestion
# To prevent CWE-502
FORBIDDEN_XCOM_KEYS = frozenset(
```
--
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]
