Compare commits

..

1 Commits

Author SHA1 Message Date
Claude Code
4debd2d01a fix(legacy-preset-chart-nvd3): sanitize tooltip HTML built from chart data
Several tooltip generators in this module build HTML strings from chart
data and return them to be rendered via D3 `.html()`, but did not run the
result through DOMPurify the way the sibling generators in the same file
already do. Apply `dompurify.sanitize()` to the returned HTML in
`generateBubbleTooltipContent`, `generateMultiLineTooltipContent`, and the
`tipFactory` annotation tooltip callback so data-derived values are
rendered as text rather than markup.

Adds regression tests asserting that script/handler markup in the
data-derived fields is stripped from the generated tooltip HTML.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-01 16:05:03 -07:00
4 changed files with 69 additions and 79 deletions

View File

@@ -162,7 +162,7 @@ export function generateMultiLineTooltipContent(d, xFormatter, yFormatters) {
tooltip += '</tbody></table>';
return tooltip;
return dompurify.sanitize(tooltip);
}
export function generateTimePivotTooltip(d, xFormatter, yFormatter) {
@@ -223,7 +223,7 @@ export function generateBubbleTooltipContent({
s += createHTMLRow(getLabel(sizeField), sizeFormatter(point.size));
s += '</table>';
return s;
return dompurify.sanitize(s);
}
// shouldRemove indicates whether the nvtooltips should be removed from the DOM
@@ -287,9 +287,11 @@ export function tipFactory(layer) {
? layer.descriptionColumns.map(c => d[c])
: Object.values(d);
return `<div><strong>${title}</strong></div><br/><div>${body.join(
', ',
)}</div>`;
return dompurify.sanitize(
`<div><strong>${title}</strong></div><br/><div>${body.join(
', ',
)}</div>`,
);
});
}

View File

@@ -26,6 +26,9 @@ import {
computeYDomain,
getTimeOrNumberFormatter,
formatLabel,
generateBubbleTooltipContent,
generateMultiLineTooltipContent,
tipFactory,
} from '../src/utils';
const DATA = [
@@ -181,4 +184,61 @@ describe('nvd3/utils', () => {
]);
});
});
describe('tooltip HTML sanitization', () => {
const identity = (v: unknown) => v;
test('generateBubbleTooltipContent strips scripts from entity/group', () => {
const html = generateBubbleTooltipContent({
point: {
name: '<img src=x onerror="alert(1)">',
group: '<script>alert(2)</script>',
color: 'red',
x: 1,
y: 2,
size: 3,
},
entity: 'name',
xField: 'x',
yField: 'y',
sizeField: 'size',
xFormatter: identity,
yFormatter: identity,
sizeFormatter: identity,
});
expect(html).not.toContain('onerror');
expect(html).not.toContain('<script>');
});
test('generateMultiLineTooltipContent strips scripts from series keys', () => {
const html = generateMultiLineTooltipContent(
{
value: 'x',
series: [
{ key: '<img src=x onerror="alert(1)">', color: 'red', value: 1 },
],
},
identity,
[identity],
);
expect(html).not.toContain('onerror');
});
test('tipFactory strips scripts from annotation data values', () => {
const tip = tipFactory({
titleColumn: 'title',
name: 'layer',
descriptionColumns: ['desc'],
});
const html = tip.html()({
title: '<img src=x onerror="alert(1)">',
desc: '<script>alert(2)</script>',
});
expect(html).not.toContain('onerror');
expect(html).not.toContain('<script>');
});
});
});

View File

@@ -119,21 +119,14 @@ class TaskResponseSchema(Schema):
return obj.payload_dict # type: ignore[attr-defined]
def get_properties(self, obj: object) -> dict[str, object]:
"""Get properties dict, filtering debugging details when SHOW_STACKTRACE
is disabled."""
"""Get properties dict, filtering stack_trace if SHOW_STACKTRACE is disabled."""
from flask import current_app
properties = dict(obj.properties_dict) # type: ignore[attr-defined]
# Remove internal debugging details unless SHOW_STACKTRACE is enabled.
# The full traceback and the raw exception class name disclose internal
# file paths, library versions, and architecture details (CWE-209), so
# they are gated behind the same flag that controls stack traces
# elsewhere in Superset. ``error_message`` is left in place as the
# consumer-facing failure reason.
# Remove stack_trace unless SHOW_STACKTRACE is enabled
if not current_app.config.get("SHOW_STACKTRACE", False):
properties.pop("stack_trace", None)
properties.pop("exception_type", None)
return properties

View File

@@ -1,65 +0,0 @@
# 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 types import SimpleNamespace
from flask import current_app
from pytest_mock import MockerFixture
from superset.tasks.schemas import TaskResponseSchema
def _task_with_error_properties() -> SimpleNamespace:
return SimpleNamespace(
properties_dict={
"is_abortable": True,
"progress_percent": 1.0,
"error_message": "boom",
"exception_type": "KeyError",
"stack_trace": 'Traceback (most recent call last):\n File "/app/x.py"',
}
)
def test_get_properties_hides_debug_fields_by_default(app_context: None) -> None:
"""
By default (SHOW_STACKTRACE disabled) the serialized task properties must
not disclose the stack trace or the raw exception class name (CWE-209),
while still returning consumer-safe fields like error_message.
"""
properties = TaskResponseSchema().get_properties(_task_with_error_properties())
assert "stack_trace" not in properties
assert "exception_type" not in properties
# consumer-safe fields are preserved
assert properties["error_message"] == "boom"
assert properties["is_abortable"] is True
assert properties["progress_percent"] == 1.0
def test_get_properties_exposes_debug_fields_when_show_stacktrace(
app_context: None, mocker: MockerFixture
) -> None:
"""
When SHOW_STACKTRACE is explicitly enabled, the debugging fields are
returned (parity with how Superset surfaces stack traces elsewhere).
"""
mocker.patch.dict(current_app.config, {"SHOW_STACKTRACE": True})
properties = TaskResponseSchema().get_properties(_task_with_error_properties())
assert properties["exception_type"] == "KeyError"
assert str(properties["stack_trace"]).startswith("Traceback")