Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

fix(api): sanitize XLSX export cells to prevent formula injection (#9224)

sriram veeraghanta2f7941a17c8b
diff --git a/apps/api/plane/tests/unit/utils/test_csv_export_sanitization.py b/apps/api/plane/tests/unit/utils/test_csv_export_sanitization.py
new file mode 100644
index 0000000000..1290d5e270
--- /dev/null
+++ b/apps/api/plane/tests/unit/utils/test_csv_export_sanitization.py
@@ -0,0 +1,34 @@
+# Copyright (c) 2023-present Plane Software, Inc. and contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+# See the LICENSE file for details.
+
+import csv
+from io import StringIO
+
+import pytest
+
+from plane.utils.porters.formatters import CSVFormatter
+
+
+def _read_rows(content):
+ return list(csv.reader(StringIO(content)))
+
+
+class TestPorterCSVFormatterSanitization:
+ """CSV exports must not emit formula-triggering values, including in header rows."""
+
+ def test_data_values_are_sanitized(self):
+ content = CSVFormatter().encode([{"name": "=1+2"}])
+ rows = _read_rows(content)
+ assert rows[1][0] == "'=1+2"
+
+ def test_prettified_headers_are_sanitized(self):
+ content = CSVFormatter().encode([{"=evil_header": "value"}])
+ rows = _read_rows(content)
+ assert rows[0][0] == "'=Evil Header"
+
+ def test_raw_headers_are_sanitized(self):
+ content = CSVFormatter(prettify_headers=False).encode([{"=evil": "value"}])
+ rows = _read_rows(content)
+ assert rows[0][0] == "'=evil"
diff --git a/apps/api/plane/tests/unit/utils/test_xlsx_export_sanitization.py b/apps/api/plane/tests/unit/utils/test_xlsx_export_sanitization.py
new file mode 100644
index 0000000000..e1fd874f11
--- /dev/null
+++ b/apps/api/plane/tests/unit/utils/test_xlsx_export_sanitization.py
@@ -0,0 +1,115 @@
+# Copyright (c) 2023-present Plane Software, Inc. and contributors
+# SPDX-License-Identifier: AGPL-3.0-only
+# See the LICENSE file for details.
+
+from io import BytesIO
+
+import pytest
+from openpyxl import load_workbook
+
+from plane.utils.exporters.formatters import XLSXFormatter as SchemaXLSXFormatter
+from plane.utils.porters.formatters import XLSXFormatter as PorterXLSXFormatter
+
+# Characters that trigger formula evaluation in spreadsheet applications.
+# See: https://owasp.org/www-community/attacks/CSV_Injection
+FORMULA_TRIGGERS = ["=", "+", "-", "@", "\t", "\r", "\n"]
+
+HYPERLINK_PAYLOAD = '=HYPERLINK("https://example.com/poc","click")'
+
+
+def _load_cells(xlsx_bytes):
+ """Load XLSX bytes and return the active worksheet's cells (formulas not evaluated)."""
+ wb = load_workbook(filename=BytesIO(xlsx_bytes))
+ return wb.active
+
+
+class TestPorterXLSXFormatterSanitization:
+ """XLSX issue exports must not store user-controlled values as formula cells."""
+
+ def test_formula_payload_is_stored_as_text(self):
+ content = PorterXLSXFormatter().encode([{"name": HYPERLINK_PAYLOAD}])
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.data_type != "f"
+ assert cell.value == "'" + HYPERLINK_PAYLOAD
+
+ @pytest.mark.parametrize("trigger", FORMULA_TRIGGERS)
+ def test_all_formula_trigger_characters_are_escaped(self, trigger):
+ payload = trigger + "1+2"
+ content = PorterXLSXFormatter().encode([{"name": payload}])
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.data_type != "f"
+ assert cell.value == "'" + payload
+
+ def test_safe_string_is_unchanged(self):
+ content = PorterXLSXFormatter().encode([{"name": "Fix login bug"}])
+ ws = _load_cells(content)
+ assert ws.cell(row=2, column=1).value == "Fix login bug"
+
+ def test_non_string_values_are_preserved(self):
+ content = PorterXLSXFormatter().encode([{"estimate": 5}])
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.value == 5
+ assert cell.data_type == "n"
+
+ def test_list_value_joining_to_formula_is_escaped(self):
+ content = PorterXLSXFormatter().encode([{"labels": ["=cmd", "bug"]}])
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.data_type != "f"
+ assert cell.value == "'=cmd, bug"
+
+ def test_headers_are_sanitized(self):
+ content = PorterXLSXFormatter().encode([{"=evil_header": "value"}])
+ ws = _load_cells(content)
+ header = ws.cell(row=1, column=1)
+ assert header.data_type != "f"
+ assert header.value == "'=Evil Header"
+
+
+class _FakeField:
+ def __init__(self, label=None):
+ self.label = label
+
+
+class _FakeSchema:
+ _declared_fields = {
+ "name": _FakeField("Name"),
+ "estimate": _FakeField("=Estimate"),
+ }
+
+
+class TestSchemaXLSXFormatterSanitization:
+ """Schema-based XLSX exports must not store user-controlled values as formula cells."""
+
+ def test_formula_payload_is_stored_as_text(self):
+ _, content = SchemaXLSXFormatter().format("export", [{"name": HYPERLINK_PAYLOAD, "estimate": 5}], _FakeSchema)
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.data_type != "f"
+ assert cell.value == "'" + HYPERLINK_PAYLOAD
+
+ @pytest.mark.parametrize("trigger", FORMULA_TRIGGERS)
+ def test_all_formula_trigger_characters_are_escaped(self, trigger):
+ payload = trigger + "1+2"
+ _, content = SchemaXLSXFormatter().format("export", [{"name": payload, "estimate": 5}], _FakeSchema)
+ ws = _load_cells(content)
+ cell = ws.cell(row=2, column=1)
+ assert cell.data_type != "f"
+ assert cell.value == "'" + payload
+
+ def test_safe_string_is_unchanged(self):
+ _, content = SchemaXLSXFormatter().format("export", [{"name": "Fix login bug", "estimate": 5}], _FakeSchema)
+ ws = _load_cells(content)
+ assert ws.cell(row=2, column=1).value == "Fix login bug"
+
+ def test_headers_are_sanitized(self):
+ _, content = SchemaXLSXFormatter().format("export", [{"name": "ok", "estimate": 5}], _FakeSchema)
+ ws = _load_cells(content)
+ header = ws.cell(row=1, column=2)
+ assert header.data_type != "f"
+ assert header.value == "'=Estimate"
diff --git a/apps/api/plane/utils/csv_utils.py b/apps/api/plane/utils/csv_utils.py
index 26c6e89375..304f70fe59 100644
--- a/apps/api/plane/utils/csv_utils.py
+++ b/apps/api/plane/utils/csv_utils.py
@@ -2,13 +2,13 @@
# SPDX-License-Identifier: AGPL-3.0-only
# See the LICENSE file for details.
-# CSV utility functions for safe export
+# Utility functions for safe spreadsheet exports (CSV and XLSX)
# Characters that trigger formula evaluation in spreadsheet applications
_CSV_FORMULA_TRIGGERS = frozenset(("=", "+", "-", "@", "\t", "\r", "\n"))
def sanitize_csv_value(value):
- """Sanitize a value for CSV export to prevent formula injection.
+ """Sanitize a value for CSV/XLSX export to prevent formula injection.
Prefixes string values starting with formula-triggering characters
with a single quote so spreadsheet applications treat them as text
@@ -22,5 +22,5 @@ def sanitize_csv_value(value):
def sanitize_csv_row(row):
- """Sanitize all values in a CSV row."""
+ """Sanitize all values in a CSV/XLSX row."""
return [sanitize_csv_value(v) for v in row]
diff --git a/apps/api/plane/utils/exporters/formatters.py b/apps/api/plane/utils/exporters/formatters.py
index 611a60fca4..912c2b0a68 100644
--- a/apps/api/plane/utils/exporters/formatters.py
+++ b/apps/api/plane/utils/exporters/formatters.py
@@ -175,7 +175,7 @@ class XLSXFormatter(BaseFormatter):
wb = Workbook()
sh = wb.active
for row in data:
- sh.append(row)
+ sh.append(sanitize_csv_row(row))
out = io.BytesIO()
wb.save(out)
out.seek(0)
diff --git a/apps/api/plane/utils/porters/formatters.py b/apps/api/plane/utils/porters/formatters.py
index 461a6a5e42..c0f1f9b8e9 100644
--- a/apps/api/plane/utils/porters/formatters.py
+++ b/apps/api/plane/utils/porters/formatters.py
@@ -128,14 +128,14 @@ class CSVFormatter(BaseFormatter):
# Write pretty headers manually, then write data rows
writer = csv.writer(output, delimiter=self.delimiter)
- writer.writerow(pretty_headers)
+ writer.writerow(sanitize_csv_row(pretty_headers))
# Write data rows in the same field order
for row in data:
writer.writerow(sanitize_csv_row([row.get(key, "") for key in fieldnames]))
else:
writer = csv.DictWriter(output, fieldnames=fieldnames, delimiter=self.delimiter)
- writer.writeheader()
+ writer.writerow({k: sanitize_csv_value(k) for k in fieldnames})
for row in data:
writer.writerow({k: sanitize_csv_value(row.get(k, "")) for k in fieldnames})
@@ -219,11 +219,11 @@ class XLSXFormatter(BaseFormatter):
headers = [self._prettify_header(key) for key in fieldnames]
else:
headers = fieldnames
- ws.append(headers)
+ ws.append(sanitize_csv_row(headers))
# Write data rows
for row in data:
- ws.append([self._format_value(row.get(key, "")) for key in fieldnames])
+ ws.append(sanitize_csv_row([self._format_value(row.get(key, "")) for key in fieldnames]))
output = BytesIO()
wb.save(output)