org.commonmark.renderer.html

Interface UrlSanitizer

All Known Implementing Classes:

DefaultUrlSanitizer

public interface UrlSanitizer

Sanitizes urls for img and a elements by whitelisting protocols. This is intended to prevent XSS payloads like [Click this totally safe url](javascript:document.xss=true;)

Implementation based on https://github.com/OWASP/java-html-sanitizer/blob/f07e44b034a45d94d6fd010279073c38b6933072/src/main/java/org/owasp/html/FilterUrlByProtocolAttributePolicy.java

Since:

0.14.0

Method Summary

Modifier and Type	Method and Description
String	sanitizeImageUrl(String url) Sanitize a url for use in the src attribute of a Image.
String	sanitizeLinkUrl(String url) Sanitize a url for use in the href attribute of a Link.

Method Detail

sanitizeLinkUrl

String sanitizeLinkUrl(String url)

Sanitize a url for use in the href attribute of a Link.

Parameters:

url - Link to sanitize

Returns:

Sanitized link

sanitizeImageUrl

String sanitizeImageUrl(String url)

Sanitize a url for use in the src attribute of a Image.

Parameters:

url - Link to sanitize

Returns:

Sanitized link Image