| |
| new file mode 100644 |
| |
| |
| |
| @@ -0,0 +1,213 @@ |
| +<?php |
| + |
| +namespace SilverStripe\Core; |
| + |
| +use DOMAttr; |
| +use DOMElement; |
| +use SilverStripe\Core\Injector\Injectable; |
| +use SilverStripe\View\Parsers\HTMLValue; |
| + |
| +/** |
| + * Sanitises HTML to prevent XSS attacks. |
| + */ |
| +class XssSanitiser |
| +{ |
| + use Injectable; |
| + |
| + /** |
| + * Attributes which will be removed from any element. |
| + * If an asterisk is at the start of the attribute name, all attributes ending with this name will be removed. |
| + * If an asterisk is at the end of the attribute name, all attributes starting with this name will be removed. |
| + * For example `on*` will remove `onerror`, `onmouseover`, etc |
| + */ |
| + private array $attributesToRemove = [ |
| + 'on*', |
| + 'accesskey', |
| + ]; |
| + |
| + private array $elementsToRemove = [ |
| + 'embed', |
| + 'object', |
| + 'script', |
| + 'style', |
| + 'svg', |
| + ]; |
| + |
| + private bool $keepInnerHtmlOnRemoveElement = true; |
| + |
| + private bool $removeDataSvg = true; |
| + |
| + private bool $removeSvgFile = true; |
| + |
| + /** |
| + * Remove XSS attack vectors from an HTML fragment string |
| + */ |
| + public function sanitiseString(string $html): string |
| + { |
| + $htmlValue = HTMLValue::create($html); |
| + $this->sanitiseHtmlValue($htmlValue); |
| + return $htmlValue->getContent(); |
| + } |
| + |
| + /** |
| + * Remove XSS attack vectors from HTMLValue content |
| + */ |
| + public function sanitiseHtmlValue(HTMLValue $html): void |
| + { |
| + foreach ($html->query('//*') as $element) { |
| + if (!is_a($element, DOMElement::class)) { |
| + continue; |
| + } |
| + $this->sanitiseElement($element); |
| + } |
| + } |
| + |
| + /** |
| + * Remove XSS attack vectors from a DOMElement |
| + */ |
| + public function sanitiseElement(DOMElement $element): void |
| + { |
| + // Remove elements first - if we remove the element, we don't have any attributes to check so exit early |
| + $removed = $this->stripElement($element); |
| + if ($removed) { |
| + return; |
| + } |
| + $this->stripAttributes($element); |
| + $this->stripAttributeContents($element); |
| + } |
| + |
| + /** |
| + * Get the names of elements which will be removed. |
| + */ |
| + public function getElementsToRemove(): array |
| + { |
| + return $this->elementsToRemove; |
| + } |
| + |
| + /** |
| + * Set the names of elements which will be removed. |
| + * Note that allowing the elements which are included in the default list could result in XSS vulnerabilities. |
| + */ |
| + public function setElementsToRemove(array $elements): static |
| + { |
| + $this->elementsToRemove = $elements; |
| + return $this; |
| + } |
| + |
| + /** |
| + * Get the names of attributes which will be removed from any elements that have them. |
| + */ |
| + public function getAttributesToRemove(): array |
| + { |
| + return $this->attributesToRemove; |
| + } |
| + |
| + /** |
| + * Set the names of attributes which will be removed from any elements that have them. |
| + * Note that allowing the attributes which are included in the default list could result in XSS vulnerabilities. |
| + */ |
| + public function setAttributesToRemove(array $attributes): static |
| + { |
| + $this->attributesToRemove = $attributes; |
| + return $this; |
| + } |
| + |
| + /** |
| + * Get whether the inner contents of an element will be kept for elements that get removed. |
| + */ |
| + public function getKeepInnerHtmlOnRemoveElement(): bool |
| + { |
| + return $this->keepInnerHtmlOnRemoveElement; |
| + } |
| + |
| + /** |
| + * Set whether to keep the inner contents of an element if it gets removed. |
| + */ |
| + public function setKeepInnerHtmlOnRemoveElement(bool $keep): static |
| + { |
| + $this->keepInnerHtmlOnRemoveElement = $keep; |
| + return $this; |
| + } |
| + |
| + /** |
| + * If $element is one of the elements in $elementsToRemove, replace it |
| + * with a text node. |
| + */ |
| + private function stripElement(DOMElement $element): bool |
| + { |
| + if (!in_array($element->tagName, $this->getElementsToRemove())) { |
| + return false; |
| + } |
| + // Make sure we don't remove any child nodes |
| + $parentNode = $element->parentNode; |
| + if ($this->getKeepInnerHtmlOnRemoveElement() && $parentNode && $element->hasChildNodes()) { |
| + // We can't just iterate through $node->childNodes because that seems to skip some children |
| + while ($element->hasChildNodes()) { |
| + $parentNode->insertBefore($element->firstChild, $element); |
| + } |
| + } |
| + $element->remove(); |
| + return true; |
| + } |
| + |
| + /** |
| + * Remove all attributes in $attributesToRemove from the element. |
| + */ |
| + private function stripAttributes(DOMElement $element): void |
| + { |
| + $attributesToRemove = $this->getAttributesToRemove(); |
| + if (empty($attributesToRemove)) { |
| + return; |
| + } |
| + $attributes = $element->attributes; |
| + for ($i = count($attributes) - 1; $i >= 0; $i--) { |
| + /** @var DOMAttr $attr */ |
| + $attr = $attributes->item($i); |
| + foreach ($attributesToRemove as $toRemove) { |
| + if (str_starts_with($toRemove, '*') && str_ends_with($attr->name, str_replace('*', '', $toRemove))) { |
| + $element->removeAttributeNode($attr); |
| + } elseif (str_ends_with($toRemove, '*') && str_starts_with($attr->name, str_replace('*', '', $toRemove))) { |
| + $element->removeAttributeNode($attr); |
| + } elseif (!str_contains($toRemove, '*') && $attr->name === $toRemove) { |
| + $element->removeAttributeNode($attr); |
| + } |
| + } |
| + } |
| + } |
| + |
| + /** |
| + * Strip out attributes which have dangerous content which might otherwise execute javascript. |
| + * This is content that we will always remove regardless of whether the attributes and elements in question |
| + * are otherwise allowed, e.g. via WYSIWYG configuration. |
| + */ |
| + private function stripAttributeContents(DOMElement $element): void |
| + { |
| + $regex = $this->getStripAttributeContentsRegex(); |
| + foreach (['lowsrc', 'src', 'href', 'data'] as $dangerAttribute) { |
| + if ($element->hasAttribute($dangerAttribute)) { |
| + $attrContent = $element->getAttribute($dangerAttribute); |
| + if (preg_match($regex, $attrContent)) { |
| + $element->removeAttribute($dangerAttribute); |
| + } |
| + } |
| + } |
| + } |
| + |
| + private function getStripAttributeContentsRegex(): string |
| + { |
| + $regexes = [ |
| + $this->splitWithWhitespaceRegex('javascript:'), |
| + $this->splitWithWhitespaceRegex('data:text/html'), |
| + $this->splitWithWhitespaceRegex('vbscript:'), |
| + ]; |
| + // Regex is "starts with any of these, with optional whitespace at the start, case insensitive" |
| + return '#^\s*(' . implode('|', $regexes) . ')#iu'; |
| + } |
| + |
| + private function splitWithWhitespaceRegex(string $string): string |
| + { |
| + // Note that `\s` explicitly includes ALL invisible characters when used with the `u` modifier. |
| + // That includes unicode characters like the non-breaking space. |
| + return implode('\s*', str_split($string)); |
| + } |
| +} |
| |
| |
| |
| |
| @@ -3,6 +3,7 @@ |
| namespace SilverStripe\Forms; |
| |
| use InvalidArgumentException; |
| +use SilverStripe\Core\XssSanitiser; |
| use SilverStripe\ORM\ValidationResult; |
| use SilverStripe\View\ViewableData; |
| |
| @@ -33,6 +34,7 @@ trait FormMessage |
| |
| /** |
| * Returns the field message, used by form validation. |
| + * If the current cast is ValidationResult::CAST_HTML, the message will be sanitised. |
| * |
| * Use {@link setError()} to set this property. |
| * |
| @@ -40,7 +42,11 @@ trait FormMessage |
| */ |
| public function getMessage() |
| { |
| - return $this->message; |
| + $message = $this->message; |
| + if ($this->getMessageCast() === ValidationResult::CAST_HTML) { |
| + $message = XssSanitiser::create()->sanitiseString($message); |
| + } |
| + return $message; |
| } |
| |
| /** |
| |
| |
| |
| |
| @@ -6,6 +6,7 @@ |
| use DOMElement; |
| use SilverStripe\Core\Config\Configurable; |
| use SilverStripe\Core\Injector\Injectable; |
| +use SilverStripe\Core\XssSanitiser; |
| use SilverStripe\View\Parsers\HTMLValue; |
| use stdClass; |
| |
| @@ -289,6 +290,10 @@ public function sanitise(HTMLValue $html) |
| { |
| $linkRelValue = $this->config()->get('link_rel_value'); |
| $doc = $html->getDocument(); |
| + // Get a sanitiser but don't deny any specific attributes or elements, since that's |
| + // handled as part of the element rules. |
| + $xssSanitiser = XssSanitiser::create(); |
| + $xssSanitiser->setElementsToRemove([])->setAttributesToRemove([]); |
| |
| /** @var DOMElement $el */ |
| foreach ($html->query('//body//*') as $el) { |
| @@ -342,16 +347,8 @@ public function sanitise(HTMLValue $html) |
| $el->setAttribute($attr, $forced); |
| } |
| |
| - // Matches "javascript:" with any arbitrary linebreaks inbetween the characters. |
| - $regex = '#^\s*(' . implode('\s*', str_split('javascript:')) . '|' . implode('\s*', str_split('data:text/html;')) . ')#i'; |
| - // Strip out javascript execution in href or src attributes. |
| - foreach (['src', 'href', 'data'] as $dangerAttribute) { |
| - if ($el->hasAttribute($dangerAttribute)) { |
| - if (preg_match($regex, $el->getAttribute($dangerAttribute))) { |
| - $el->removeAttribute($dangerAttribute); |
| - } |
| - } |
| - } |
| + // Explicit XSS sanitisation for anything that there's really no sensible use case for in a WYSIWYG |
| + $xssSanitiser->sanitiseElement($el); |
| } |
| |
| if ($el->tagName |
| |
| new file mode 100644 |
| |
| |
| |
| @@ -0,0 +1,463 @@ |
| +<?php |
| + |
| +namespace SilverStripe\Core\Tests; |
| + |
| +use DOMElement; |
| +use SilverStripe\Core\XssSanitiser; |
| +use SilverStripe\Dev\SapphireTest; |
| +use SilverStripe\View\Parsers\HTMLValue; |
| + |
| +class XssSanitiserTest extends SapphireTest |
| +{ |
| + protected $usesDatabase = false; |
| + |
| + public function provideSanitise(): array |
| + { |
| + // Most of these scenarios are inspired by Symfony's HtmlSanitizerAllTest scenarios |
| + return [ |
| + // Text |
| + [ |
| + 'input' => '', |
| + 'expected' => '', |
| + ], |
| + [ |
| + 'input' => 'hello world', |
| + 'expected' => 'hello world', |
| + ], |
| + [ |
| + 'input' => '<hello world>', |
| + 'expected' => '<hello world>', |
| + ], |
| + [ |
| + 'input' => '< Hello', |
| + 'expected' => ' Hello', |
| + ], |
| + [ |
| + 'input' => 'Lorem & Ipsum', |
| + 'expected' => 'Lorem & Ipsum', |
| + ], |
| + // Unknown tag |
| + [ |
| + 'input' => '<unknown>Lorem ipsum</unknown>', |
| + 'expected' => '<unknown>Lorem ipsum</unknown>', |
| + ], |
| + // Scripts |
| + [ |
| + 'input' => '<script>alert(\'ok\');</script>', |
| + 'expected' => 'alert(\'ok\');', |
| + ], |
| + [ |
| + 'input' => 'javascript:/*--></title></style></textarea></script></xmp><svg/onload=\'+/"/+/onmouseover=1/+/[*/[]/+alert(1)//\'>', |
| + 'expected' => 'javascript:/*-->', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<scr<script>ipt>alert(1)</script>', |
| + 'expected' => '<scr>ipt>alert(1)</scr>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<scr<a>ipt>alert(1)</script>', |
| + 'expected' => '<scr><a>ipt>alert(1)</a></scr>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<noscript>Lorem ipsum</noscript>', |
| + 'expected' => '<noscript>Lorem ipsum</noscript>', |
| + ], |
| + [ |
| + 'input' => '<div>Lorem ipsum dolor sit amet, consectetur adipisicing elit.<script>alert(\'ok\');</script></div>', |
| + 'expected' => '<div>Lorem ipsum dolor sit amet, consectetur adipisicing elit.alert(\'ok\');</div>', |
| + ], |
| + [ |
| + 'input' => '<a href="javascript:alert(\'ok\')">Lorem ipsum dolor sit amet, consectetur adipisicing elit.</a>', |
| + 'expected' => '<a>Lorem ipsum dolor sit amet, consectetur adipisicing elit.</a>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<<a href="javascript:evil"/>a href="javascript:evil"/>', |
| + 'expected' => '<a>a href="javascript:evil"/></a>', |
| + ], |
| + [ |
| + 'input' => '<a href="javascript:alert(\'ok\')">Test</a>', |
| + 'expected' => '<a>Test</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="javascript://%0Aalert(document.cookie)">Test</a>', |
| + 'expected' => '<a>Test</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="javascript:alert('XSS')">Lorem ipsum</a>', |
| + 'expected' => '<a>Lorem ipsum</a>', |
| + ], |
| + [ |
| + // Note this includes U+200A, U+202F, U+205F, U+2000, U+2001, U+2002, U+2003, U+2004, U+2005, U+2006, U+2007, U+2008, U+2009, U+3000 |
| + 'input' => "<a href=\"ja\tva\v\r\n sc r i pt:alert('foo')\">Lorem ipsum</a>", |
| + 'expected' => '<a>Lorem ipsum</a>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<a href= onmouseover="alert(\\\'XSS\\\');">Lorem ipsum</a>', |
| + 'expected' => '<a href="onmouseover="alert(\'XSS\');"">Lorem ipsum</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="http://example.com" onclick="alert(\'ok\')">Test</a>', |
| + 'expected' => '<a href="http://example.com">Test</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="javascript:" title="Link title">Lorem ipsum</a>', |
| + 'expected' => '<a title="Link title">Lorem ipsum</a>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<figure><img src="https://example.com/img/example.jpg" onclick="alert(\'ok\')" /></figure>', |
| + 'expected' => '<figure><img src="https://example.com/img/example.jpg"></figure>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<img src= onmouseover="alert(\'XSS\');">', |
| + 'expected' => '<img src="onmouseover="alert('XSS');"">', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<<img src="javascript:evil"/>iframe src="javascript:evil"/>', |
| + 'expected' => '<img>iframe src="javascript:evil"/>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<<img src="javascript:evil"/>img src="javascript:evil"/>', |
| + 'expected' => '<img>img src="javascript:evil"/>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC="javascript:alert(\'XSS\');">', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=javascript:alert(\'XSS\')>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=JaVaScRiPt:alert(\'XSS\')>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=javascript:alert("XSS")>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<IMG SRC=`javascript:alert("RSnake says, \'XSS\'")`>', |
| + 'expected' => '<img src="`javascript:alert("RSnake">', |
| + ], |
| + [ |
| + 'input' => '<IMG """><SCRIPT>alert("XSS")</SCRIPT>"\>', |
| + 'expected' => '<img>alert("XSS")"\>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=javascript:alert(String.fromCharCode(88,83,83))>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=# onmouseover="alert(\'xxs\')">', |
| + 'expected' => '<img src="#">', |
| + ], |
| + [ |
| + 'input' => '<img src=x onerror="javascript:alert('XSS')">', |
| + 'expected' => '<img src="x">', |
| + ], |
| + [ |
| + // decodes to `javascript:alert('XSS')` |
| + 'input' => '<IMG SRC=javascript:alert('XSS')>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<IMG SRC=javascript:alert('XSS')>', |
| + 'expected' => '<img src="&#0000106&#0000097&#0000118&#0000097&#0000115&#0000099&#0000114&#0000105&#0000112&#0000116&#0000058&#0000097&#0000108&#0000101&#0000114&#0000116&#0000040&#0000039&#0000088&#0000083&#0000083&#0000039&#0000041">', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<IMG SRC=javascript:alert('XSS')>', |
| + 'expected' => '<img src="&#x6A&#x61&#x76&#x61&#x73&#x63&#x72&#x69&#x70&#x74&#x3A&#x61&#x6C&#x65&#x72&#x74&#x28&#x27&#x58&#x53&#x53&#x27&#x29">', |
| + ], |
| + [ |
| + // Decodes to a SVG with `<script type="text/ecmascript">alert("XSS");</script>` inside it |
| + // But that's not actually exploitable XSS |
| + 'input' => '<IMG SRC="data:image/svg+xml;base64,PHN2ZyB4bWxuczpzdmc9Imh0dH A6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcv MjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hs aW5rIiB2ZXJzaW9uPSIxLjAiIHg9IjAiIHk9IjAiIHdpZHRoPSIxOTQiIGhlaWdodD0iMjAw IiBpZD0ieHNzIj48c2NyaXB0IHR5cGU9InRleHQvZWNtYXNjcmlwdCI+YWxlcnQoIlh TUyIpOzwvc2NyaXB0Pjwvc3ZnPg==">', |
| + 'expected' => '<img src="data:image/svg+xml;base64,PHN2ZyB4bWxuczpzdmc9Imh0dH A6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcv MjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hs aW5rIiB2ZXJzaW9uPSIxLjAiIHg9IjAiIHk9IjAiIHdpZHRoPSIxOTQiIGhlaWdodD0iMjAw IiBpZD0ieHNzIj48c2NyaXB0IHR5cGU9InRleHQvZWNtYXNjcmlwdCI+YWxlcnQoIlh TUyIpOzwvc2NyaXB0Pjwvc3ZnPg==">', |
| + ], |
| + [ |
| + 'input' => '<IMG LOWSRC="javascript:alert(\'XSS\')">', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<IMG SRC=\'vbscript:msgbox(\"XSS")\'>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<img src="javascript:" alt="Image alternative text" title="Image title">', |
| + 'expected' => '<img alt="Image alternative text" title="Image title">', |
| + ], |
| + [ |
| + 'input' => '<svg/onload=alert(\'XSS\')>', |
| + 'expected' => '', |
| + ], |
| + [ |
| + 'input' => '<BGSOUND SRC="javascript:alert(\'XSS\');">', |
| + 'expected' => '<bgsound></bgsound>', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '<BR SIZE="&{alert(\'XSS\')}">', |
| + 'expected' => '<br size="&{alert('XSS')}">', |
| + ], |
| + [ |
| + 'input' => '<BR></br>', |
| + 'expected' => '<br><br>', |
| + ], |
| + |
| + [ |
| + 'input' => '<OBJECT TYPE="text/x-scriptlet" DATA="http://xss.rocks/scriptlet.html"></OBJECT>', |
| + 'expected' => '', |
| + ], |
| + [ |
| + // Decodes to a SVG with `<script type="text/ecmascript">alert("XSS");</script>` inside it |
| + 'input' => '<EMBED SRC="data:image/svg+xml;base64,PHN2ZyB4bWxuczpzdmc9Imh0dH A6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcv MjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hs aW5rIiB2ZXJzaW9uPSIxLjAiIHg9IjAiIHk9IjAiIHdpZHRoPSIxOTQiIGhlaWdodD0iMjAw IiBpZD0ieHNzIj48c2NyaXB0IHR5cGU9InRleHQvZWNtYXNjcmlwdCI+YWxlcnQoIlh TUyIpOzwvc2NyaXB0Pjwvc3ZnPg==" type="image/svg+xml" AllowScriptAccess="always"></EMBED>', |
| + 'expected' => '', |
| + ], |
| + [ |
| + // Not exploitable XSS |
| + 'input' => '!<textarea></textarea><svg/onload=prompt`xs`></textarea>!', |
| + 'expected' => '!<textarea></textarea><svg/onload=prompt`xs`></textarea>!', |
| + ], |
| + [ |
| + 'input' => '!<textarea></textarea><svg/onload=prompt`xs`></textarea>!', |
| + 'expected' => '!<textarea></textarea>!', |
| + ], |
| + [ |
| + 'input' => '"><svg/onload=confirm(1)>"@x.y', |
| + 'expected' => '">"@x.y', |
| + ], |
| + [ |
| + 'input' => '<div class="some-class"><img src="https://example.com/image.jpg"><span id="something025">one</span><script>2</script>two<span id="something026">three</span></div>', |
| + 'expected' => '<div class="some-class"><img src="https://example.com/image.jpg"><span id="something025">one</span>2two<span id="something026">three</span></div>', |
| + ], |
| + // Styles |
| + [ |
| + 'input' => '<style>body { background: red; }</style>', |
| + 'expected' => 'body { background: red; }', |
| + ], |
| + [ |
| + 'input' => '<div>Lorem ipsum dolor sit amet, consectetur.<style>body { background: red; }</style></div>', |
| + 'expected' => '<div>Lorem ipsum dolor sit amet, consectetur.body { background: red; }</div>', |
| + ], |
| + [ |
| + 'input' => '<img src="https://example.com/img/example.jpg" style="position:absolute;top:0;left:0;width:9000px;height:9000px;">', |
| + 'expected' => '<img src="https://example.com/img/example.jpg" style="position:absolute;top:0;left:0;width:9000px;height:9000px;">', |
| + ], |
| + [ |
| + 'input' => '<a style="font-size: 40px; color: red;">Lorem ipsum dolor sit amet, consectetur.</a>', |
| + 'expected' => '<a style="font-size: 40px; color: red;">Lorem ipsum dolor sit amet, consectetur.</a>', |
| + ], |
| + // Comments |
| + [ |
| + // Not exploitable XSS |
| + 'input' => 'Lorem ipsum dolor sit amet, consectetur<!--if[true]> <script>alert(1337)</script> -->', |
| + 'expected' => 'Lorem ipsum dolor sit amet, consectetur<!--if[true]> <script>alert(1337)</script> -->', |
| + ], |
| + [ |
| + 'input' => 'Lorem ipsum<![CDATA[ <!-- ]]> <script>alert(1337)</script> <!-- -->', |
| + 'expected' => 'Lorem ipsum <!-- alert(1337) <!-- -->', |
| + ], |
| + // Normal tags (just checking they don't get mangled) |
| + [ |
| + 'input' => '<a>Lorem ipsum</a>', |
| + 'expected' => '<a>Lorem ipsum</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="/img/example.jpg" title="Link title">Lorem ipsum</a>', |
| + 'expected' => '<a href="/img/example.jpg" title="Link title">Lorem ipsum</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="http://example.com/index.html#this:stuff">Lorem ipsum</a>', |
| + 'expected' => '<a href="http://example.com/index.html#this:stuff">Lorem ipsum</a>', |
| + ], |
| + [ |
| + 'input' => '<a href="mailto:test@example.com" title="Link title">Lorem ipsum</a>', |
| + 'expected' => '<a href="mailto:test@example.com" title="Link title">Lorem ipsum</a>', |
| + ], |
| + [ |
| + 'input' => '<img src="/img/example.jpg" onanything="" alt="Image alternative text" title="Image title" height="150" width="300">', |
| + 'expected' => '<img src="/img/example.jpg" alt="Image alternative text" title="Image title" height="150" width="300">', |
| + ], |
| + [ |
| + 'input' => '<img src="http://example.com/img/examp:le.jpg" alt="Image alternative text" title="Image title">', |
| + 'expected' => '<img src="http://example.com/img/examp:le.jpg" alt="Image alternative text" title="Image title">', |
| + ], |
| + [ |
| + 'input' => '<img>', |
| + 'expected' => '<img>', |
| + ], |
| + [ |
| + 'input' => '<div class="some-class"><img src="https://example.com/image.jpg"><span id="something025">one</span>two<span id="something026">three</span></div>', |
| + 'expected' => '<div class="some-class"><img src="https://example.com/image.jpg"><span id="something025">one</span>two<span id="something026">three</span></div>', |
| + ], |
| + ]; |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitise |
| + */ |
| + public function testSanitiseString(string $input, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + $this->assertSame($expected, $sanitiser->sanitiseString($input)); |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitise |
| + */ |
| + public function testSanitiseHtmlValue(string $input, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + $htmlValue = new HTMLValue($input); |
| + $sanitiser->sanitiseHtmlValue($htmlValue); |
| + $this->assertSame($expected, $htmlValue->getContent()); |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitise |
| + */ |
| + public function testSanitiseElement(string $input, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + $htmlValue = new HTMLValue($input); |
| + foreach ($htmlValue->query('//*') as $element) { |
| + if (!is_a($element, DOMElement::class)) { |
| + continue; |
| + } |
| + $element = $sanitiser->sanitiseElement($element); |
| + } |
| + $this->assertSame($expected, $htmlValue->getContent()); |
| + } |
| + |
| + public function provideSanitiseElementsAllowed(): array |
| + { |
| + return [ |
| + 'disallow these by default' => [ |
| + 'input' => '<script>alert("one");</script><svg><circle cx="50" cy="50" r="40" /></svg><embed src="image.jpg"></embed><object data="image.jpg"></object>', |
| + 'removeElements' => null, |
| + 'expected' => 'alert("one");<circle cx="50" cy="50" r="40"></circle>', |
| + ], |
| + 'allow all' => [ |
| + 'input' => '<script>alert("one");</script><svg><circle cx="50" cy="50" r="40" /></svg><embed src="image.jpg"></embed><object data="image.jpg"></object>', |
| + 'removeElements' => [], |
| + 'expected' => '<script>alert("one");</script><svg><circle cx="50" cy="50" r="40"></circle></svg><embed src="image.jpg"></embed><object data="image.jpg"></object>', |
| + ], |
| + 'disallow circle' => [ |
| + 'input' => '<script>alert("one");</script><svg><circle cx="50" cy="50" r="40" /></svg><embed src="image.jpg"></embed><object data="image.jpg"></object>', |
| + 'removeElements' => ['circle'], |
| + 'expected' => '<script>alert("one");</script><svg></svg><embed src="image.jpg"></embed><object data="image.jpg"></object>', |
| + ], |
| + ]; |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitiseElementsAllowed |
| + */ |
| + public function testSanitiseElementsAllowed(string $input, ?array $removeElements, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + if ($removeElements !== null) { |
| + $sanitiser->setElementsToRemove($removeElements); |
| + } |
| + $this->assertSame($expected, $sanitiser->sanitiseString($input)); |
| + } |
| + |
| + public function provideSanitiseAttributesAllowed(): array |
| + { |
| + return [ |
| + 'disallow these by default' => [ |
| + 'input' => '<span class="my-class" onanything onerror onclick onetc="anything" accesskey="A">abcd</span>', |
| + 'removeAttributes' => null, |
| + 'expected' => '<span class="my-class">abcd</span>', |
| + ], |
| + 'allow all' => [ |
| + 'input' => '<span class="my-class" onanything onerror onclick onetc="anything" accesskey="A">abcd</span>', |
| + 'removeAttributes' => [], |
| + 'expected' => '<span class="my-class" onanything="" onerror="" onclick="" onetc="anything" accesskey="A">abcd</span>', |
| + ], |
| + 'disallow class' => [ |
| + 'input' => '<span class="my-class" onanything onerror onclick onetc="anything" accesskey="A">abcd</span>', |
| + 'removeAttributes' => ['class'], |
| + 'expected' => '<span onanything="" onerror="" onclick="" onetc="anything" accesskey="A">abcd</span>', |
| + ], |
| + 'wildcard attributes' => [ |
| + 'input' => '<span class="my-class" title="my title" cattle="something" car="a thing" clap="nope" clop="yep" disabled="true">abcd</span>', |
| + 'removeAttributes' => [ |
| + 'cla*', |
| + '*tle', |
| + // this one specifically won't do anything |
| + 'di*ed', |
| + ], |
| + 'expected' => '<span car="a thing" clop="yep" disabled>abcd</span>', |
| + ], |
| + // Not sure why you'd do this, but this functionality is a natural consequence of how `*something` and `something*` are implemented. |
| + 'remove all attributes' => [ |
| + 'input' => '<span class="my-class" title="my title" cattle="something" car="a thing" clap="nope" clop="yep" disabled="true">abcd</span>', |
| + 'removeAttributes' => [ |
| + '*', |
| + ], |
| + 'expected' => '<span>abcd</span>', |
| + ], |
| + ]; |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitiseAttributesAllowed |
| + */ |
| + public function testSanitiseAttributesAllowed(string $input, ?array $removeAttributes, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + if ($removeAttributes !== null) { |
| + $sanitiser->setAttributesToRemove($removeAttributes); |
| + } |
| + $this->assertSame($expected, $sanitiser->sanitiseString($input)); |
| + } |
| + |
| + public function provideSanitiseNoKeepInnerHtml(): array |
| + { |
| + return [ |
| + 'keeps inner html' => [ |
| + 'input' => '<section>something first<div>Keep this<span>and this</span></div><span>something last</span></section>', |
| + 'keepInnerHtml' => true, |
| + 'expected' => '<section>something firstKeep this<span>and this</span><span>something last</span></section>', |
| + ], |
| + 'discards inner html' => [ |
| + 'input' => '<section>something first<div>Keep this<span>and this</span></div><span>something last</span></section>', |
| + 'keepInnerHtml' => false, |
| + 'expected' => '<section>something first<span>something last</span></section>', |
| + ], |
| + 'multiple and nested disallowed elements (keep inner html)' => [ |
| + 'input' => '<section>something<div></div><div><div><div>nested </div><div>nested2</div></div></div><span>last</span></section>', |
| + 'keepInnerHtml' => true, |
| + 'expected' => '<section>somethingnested nested2<span>last</span></section>', |
| + ], |
| + 'multiple and nested disallowed elements (discard inner html)' => [ |
| + 'input' => '<section>something<div></div><div><div><div>nested </div><div>nested2</div></div></div><span>last</span></section>', |
| + 'keepInnerHtml' => false, |
| + 'expected' => '<section>something<span>last</span></section>', |
| + ], |
| + ]; |
| + } |
| + |
| + /** |
| + * @dataProvider provideSanitiseNoKeepInnerHtml |
| + */ |
| + public function testSanitiseNoKeepInnerHtml(string $input, bool $keepInnerHtml, string $expected): void |
| + { |
| + $sanitiser = new XssSanitiser(); |
| + $sanitiser->setElementsToRemove(['div'])->setKeepInnerHtmlOnRemoveElement($keepInnerHtml); |
| + $this->assertSame($expected, $sanitiser->sanitiseString($input)); |
| + } |
| +} |
| |
| new file mode 100644 |
| |
| |
| |
| @@ -0,0 +1,100 @@ |
| +<?php |
| + |
| +namespace SilverStripe\Forms\Tests; |
| + |
| +use SilverStripe\Core\Injector\Injector; |
| +use SilverStripe\Core\XssSanitiser; |
| +use SilverStripe\Dev\SapphireTest; |
| +use SilverStripe\Forms\Tests\FormMessageTest\TestFormMessage; |
| +use SilverStripe\ORM\ValidationResult; |
| + |
| +class FormMessageTest extends SapphireTest |
| +{ |
| + protected $usesDatabase = false; |
| + |
| + public function provideGetMessage(): array |
| + { |
| + return [ |
| + 'empty HTML' => [ |
| + 'message' => '', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_HTML, |
| + 'expected' => '', |
| + ], |
| + 'empty plain text' => [ |
| + 'message' => '', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_TEXT, |
| + 'expected' => '', |
| + ], |
| + 'plain HTML' => [ |
| + 'message' => 'just some text', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_HTML, |
| + 'expected' => 'just some text', |
| + ], |
| + 'plain plain text' => [ |
| + 'message' => 'just some text', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_TEXT, |
| + 'expected' => 'just some text', |
| + ], |
| + 'HTML in HTML' => [ |
| + 'message' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_HTML, |
| + 'expected' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + ], |
| + 'HTML in plain text' => [ |
| + 'message' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + 'type' => '', |
| + 'casting' => ValidationResult::CAST_TEXT, |
| + 'expected' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + ], |
| + 'Type doesnt matter HTML' => [ |
| + 'message' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + 'type' => 'an arbitrary string here', |
| + 'casting' => ValidationResult::CAST_HTML, |
| + 'expected' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + ], |
| + 'Type doesnt matter text' => [ |
| + 'message' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + 'type' => 'an arbitrary string here', |
| + 'casting' => ValidationResult::CAST_TEXT, |
| + 'expected' => '<div class="js-my-div"><a href="https://example.com">link</a></div>', |
| + ], |
| + ]; |
| + } |
| + |
| + /** |
| + * Test that getMessage() generally works and calls the sanitiser as appropriate. |
| + * Note we don't actually test the sanitisation here, as that is handled by the sanitiser's unit tests. |
| + * @dataProvider provideGetMessage |
| + */ |
| + public function testGetMessage(string $message, string $type, string $casting, string $expected): void |
| + { |
| + $mockSanitiserClass = get_class(new class extends XssSanitiser { |
| + public static int $called = 0; |
| + public function sanitiseString(string $html): string |
| + { |
| + static::$called++; |
| + return parent::sanitiseString($html); |
| + } |
| + }); |
| + Injector::inst()->load([ |
| + XssSanitiser::class => [ |
| + 'class' => $mockSanitiserClass, |
| + ], |
| + ]); |
| + $expectedSanitisationCount = $casting === ValidationResult::CAST_HTML ? 1 : 0; |
| + |
| + try { |
| + $formMessage = new TestFormMessage(); |
| + $formMessage->setMessage($message, $type, $casting); |
| + $this->assertSame($expected, $formMessage->getMessage()); |
| + $this->assertSame($expectedSanitisationCount, $mockSanitiserClass::$called); |
| + } finally { |
| + $mockSanitiserClass::$called = 0; |
| + } |
| + } |
| +} |
| |
| new file mode 100644 |
| |
| |
| |
| @@ -0,0 +1,14 @@ |
| +<?php |
| + |
| +namespace SilverStripe\Forms\Tests\FormMessageTest; |
| + |
| +use SilverStripe\Dev\TestOnly; |
| +use SilverStripe\Forms\FormMessage; |
| + |
| +/** |
| + * FormMessage is a trait, so we need a class that uses it to test it. |
| + */ |
| +class TestFormMessage implements TestOnly |
| +{ |
| + use FormMessage; |
| +} |
|
|
