Skip to content

Add data to DefaultUrlSanitizer protocols #329

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.

Sign up for GitHub

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

Merged
robinst merged 2 commits into from
Jul 7, 2024
Merged

Add data to DefaultUrlSanitizer protocols #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79e1aed
Add data to DefaultUrlSanitizer protocols
AnzhiZhang May 14, 2024
804e83c
Update tests for DefaultUrlSanitizer
AnzhiZhang Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions commonmark/src/main/java/org/commonmark/renderer/html/DefaultUrlSanitizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

/**
*
* Allows http, https and mailto protocols for url.
* Allows http, https, mailto, and data protocols for url.
* Also allows protocol relative urls, and relative urls.
* Implementation based on https://github.com/OWASP/java-html-sanitizer/blob/f07e44b034a45d94d6fd010279073c38b6933072/src/main/java/org/owasp/html/FilterUrlByProtocolAttributePolicy.java
*/
public class DefaultUrlSanitizer implements UrlSanitizer {
private Set<String> protocols;

public DefaultUrlSanitizer() {
this(List.of("http", "https", "mailto"));
this(List.of("http", "https", "mailto", "data"));
}

public DefaultUrlSanitizer(Collection<String> protocols) {
Expand Down
34 changes: 34 additions & 0 deletions commonmark/src/test/java/org/commonmark/test/HtmlRendererTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,47 @@ public void sanitizedUrlsShouldSetRelNoFollow() {
assertEquals("<p><a rel=\"nofollow\" href=\"https://google.com\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));
}

@Test
public void sanitizedUrlsShouldAllowSafeProtocols() {
Paragraph paragraph = new Paragraph();
Link link = new Link();
link.setDestination("http://google.com");
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"http://google.com\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));

paragraph = new Paragraph();
link = new Link();
link.setDestination("https://google.com");
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"https://google.com\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));

paragraph = new Paragraph();
link = new Link();
link.setDestination("mailto:foo@bar.example.com");
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"mailto:foo@bar.example.com\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));

String image = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAFiUAABYlAUlSJPAAAAAQSURBVBhXY/iPBVBf8P9/AG8TY51nJdgkAAAAAElFTkSuQmCC";
paragraph = new Paragraph();
link = new Link();
link.setDestination(image);
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"" + image + "\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));
}

@Test
public void sanitizedUrlsShouldFilterDangerousProtocols() {
Paragraph paragraph = new Paragraph();
Link link = new Link();
link.setDestination("javascript:alert(5);");
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));

paragraph = new Paragraph();
link = new Link();
link.setDestination("ftp://google.com");
paragraph.appendChild(link);
assertEquals("<p><a rel=\"nofollow\" href=\"\"></a></p>\n", sanitizeUrlsRenderer().render(paragraph));
}

@Test
Expand Down