-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Fixes 25682: Add server-side XSS sanitization for user input #25683
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.
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
GhaziBenDahmane
wants to merge
2
commits into
open-metadata:main
Choose a base branch
from
GhaziBenDahmane:fix/server-side-xss-sanitization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
openmetadata-service/src/main/java/org/openmetadata/service/util/InputSanitizer.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright 2021 Collate | ||
| * Licensed 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. | ||
| */ | ||
|
|
||
| package org.openmetadata.service.util; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
| import lombok.experimental.UtilityClass; | ||
| import org.owasp.html.HtmlPolicyBuilder; | ||
| import org.owasp.html.PolicyFactory; | ||
|
|
||
| /** | ||
| * Utility class for sanitizing user input to prevent XSS attacks. This sanitization is applied | ||
| * server-side to ensure security regardless of whether requests come from the UI or direct API | ||
| * calls. | ||
| */ | ||
| @UtilityClass | ||
| public class InputSanitizer { | ||
|
|
||
| private static final Pattern ENTITY_LINK_PATTERN = Pattern.compile("<#E::[^>]+>"); | ||
| private static final String ENTITY_LINK_PLACEHOLDER = "__OM_ENTITY_LINK_%d__"; | ||
|
|
||
| private static final PolicyFactory CONTENT_POLICY = | ||
| new HtmlPolicyBuilder() | ||
| .allowElements("p", "br", "div", "span") | ||
| .allowAttributes("style", "class") | ||
| .onElements("div", "span", "p", "pre", "code") | ||
| .allowElements("ul", "ol", "li") | ||
| .allowElements("strong", "b", "em", "i", "u", "s", "del", "mark") | ||
| .allowElements("pre", "code") | ||
| .allowElements("blockquote") | ||
| .allowElements("h1", "h2", "h3", "h4", "h5", "h6") | ||
| .allowElements("table", "thead", "tbody", "tr", "td", "th") | ||
| .allowAttributes("class") | ||
| .onElements("table", "thead", "tbody", "tr", "td", "th") | ||
| .allowElements("a") | ||
| .allowAttributes("href", "title", "target") | ||
| .onElements("a") | ||
| .allowElements("img") | ||
| .allowAttributes("src", "alt", "title", "width", "height") | ||
| .onElements("img") | ||
| .allowUrlProtocols("https", "http") | ||
| .requireRelNofollowOnLinks() | ||
| .toFactory(); | ||
|
|
||
| /** | ||
| * Sanitizes HTML content to prevent XSS attacks while preserving OpenMetadata entity links. | ||
| * Entity links have the format {@code <#E::entityType::fqn>} and are used for rich content | ||
| * referencing entities. | ||
| * | ||
| * @param content the content to sanitize | ||
| * @return sanitized content with entity links preserved | ||
| */ | ||
| public static String sanitize(String content) { | ||
| if (content == null || content.isEmpty()) { | ||
| return content; | ||
| } | ||
|
|
||
| List<String> entityLinks = new ArrayList<>(); | ||
| Matcher matcher = ENTITY_LINK_PATTERN.matcher(content); | ||
| StringBuffer protectedContent = new StringBuffer(); | ||
| int index = 0; | ||
|
|
||
| while (matcher.find()) { | ||
| entityLinks.add(matcher.group()); | ||
| matcher.appendReplacement(protectedContent, String.format(ENTITY_LINK_PLACEHOLDER, index++)); | ||
| } | ||
| matcher.appendTail(protectedContent); | ||
|
|
||
| String sanitized = CONTENT_POLICY.sanitize(protectedContent.toString()); | ||
|
|
||
| for (int i = 0; i < entityLinks.size(); i++) { | ||
| sanitized = sanitized.replace(String.format(ENTITY_LINK_PLACEHOLDER, i), entityLinks.get(i)); | ||
| } | ||
|
|
||
| return sanitized; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
styleattribute enables CSS-based attacksDetails
The
styleattribute is allowed on multiple elements (div,span,p,pre,code), which can enable CSS-based attacks. While the OWASP HTML Sanitizer provides some protection, allowing arbitrarystylevalues can lead to:url()in backgroundsRecommendation: Either remove the
styleattribute entirely, or use.allowStyling(CssSchema.DEFAULT)which provides safer CSS handling. If custom styling is required, consider allowlisting specific CSS properties:Alternatively, rely on
classattributes (which are already allowed) with predefined CSS classes for styling.Was this helpful? React with 👍 / 👎