name : DOMSanitizer.php <?php /** * @package Rhukster\DomSanitizer * * @copyright Copyright (c) Andy Miller. All rights reserved. * @license MIT License; see LICENSE file for details. */ namespace Rhukster\DomSanitizer; class DOMSanitizer { const HTML = 1; const SVG = 2; const MATHML = 3; const EXTERNAL_URL = "/url\(\s*('|\")\s*(ftp:\/\/|http:\/\/|https:\/\/|\/\/)/i"; const JAVASCRIPT_ATTR = "/(\s(?:href|xlink\:href)\s*=\s*\"javascript:.*?\")/i"; const SNEAKY_ONLOAD = "/(\s(?:href|xlink\:href)\s*=\s*\"data:.*onload.*?\")/i"; const NAMESPACE_TAGS = '/xmlns[^=]*="[^"]*"/i'; const HTML_TAGS = "~<(?:!DOCTYPE|/?(?:html|body))[^>]*>\s*~i"; const PHP_TAGS = '/<\?(=|php)(.+?)\?>/i'; const XML_TAGS = '/<\?xml.*\?>/i'; const WHITESPACE_FROM = ['/\>[^\S ]+/s', '/[^\S ]+\</s', '/(\s)+/s', '/> </s']; const WHITESPACE_TO = ['>', '<', '\\1', '><']; const HTML_COMMENTS = '/<!--.*?-->/s'; private static $root = ['html', 'body']; private static $html = ['a', 'abbr', 'acronym', 'address', 'area', 'article', 'aside', 'audio', 'b', 'bdi', 'bdo', 'big', 'blink', 'blockquote', 'body', 'br', 'button', 'canvas', 'caption', 'center', 'cite', 'code', 'col', 'colgroup', 'content', 'data', 'datalist', 'dd', 'decorator', 'del', 'details', 'dfn', 'dialog', 'dir', 'div', 'dl', 'dt', 'element', 'em', 'fieldset', 'figcaption', 'figure', 'font', 'footer', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'head', 'header', 'hgroup', 'hr', 'html', 'i', 'img', 'input', 'ins', 'kbd', 'label', 'legend', 'li', 'main', 'map', 'mark', 'marquee', 'menu', 'menuitem', 'meter', 'nav', 'nobr', 'ol', 'optgroup', 'option', 'output', 'p', 'picture', 'pre', 'progress', 'q', 'rp', 'rt', 'ruby', 's', 'samp', 'section', 'select', 'shadow', 'small', 'source', 'spacer', 'span', 'strike', 'strong', 'style', 'sub', 'summary', 'sup', 'table', 'tbody', 'td', 'template', 'textarea', 'tfoot', 'th', 'thead', 'time', 'tr', 'track', 'tt', 'u', 'ul', 'var', 'video', 'wbr']; private static $svg = ['svg', 'a', 'altglyph', 'altglyphdef', 'altglyphitem', 'animatecolor', 'animatemotion', 'animatetransform', 'circle', 'clippath', 'defs', 'desc', 'ellipse', 'filter', 'font', 'g', 'glyph', 'glyphref', 'hkern', 'image', 'line', 'lineargradient', 'marker', 'mask', 'metadata', 'mpath', 'path', 'pattern', 'polygon', 'polyline', 'radialgradient', 'rect', 'stop', 'style', 'switch', 'symbol', 'text', 'textpath', 'title', 'tref', 'tspan', 'view', 'vkern']; private static $svg_filters = ['feBlend', 'feColorMatrix', 'feComponentTransfer', 'feComposite', 'feConvolveMatrix', 'feDiffuseLighting', 'feDisplacementMap', 'feDistantLight', 'feFlood', 'feFuncA', 'feFuncB', 'feFuncG', 'feFuncR', 'feGaussianBlur', 'feMerge', 'feMergeNode', 'feMorphology', 'feOffset', 'fePointLight', 'feSpecularLighting', 'feSpotLight', 'feTile', 'feTurbulence']; private static $svg_disallowed = ['animate', 'color-profile', 'cursor', 'discard', 'fedropshadow', 'feimage', 'font-face', 'font-face-format', 'font-face-name', 'font-face-src', 'font-face-uri', 'foreignobject', 'hatch', 'hatchpath', 'mesh', 'meshgradient', 'meshpatch', 'meshrow', 'missing-glyph', 'script', 'set', 'solidcolor', 'unknown', 'use']; private static $math_ml = ['math', 'menclose', 'merror', 'mfenced', 'mfrac', 'mglyph', 'mi', 'mlabeledtr', 'mmultiscripts', 'mn', 'mo', 'mover', 'mpadded', 'mphantom', 'mroot', 'mrow', 'ms', 'mspace', 'msqrt', 'mstyle', 'msub', 'msup', 'msubsup', 'mtable', 'mtd', 'mtext', 'mtr', 'munder', 'munderover']; private static $math_ml_disallowed = ['maction', 'maligngroup', 'malignmark', 'mlongdiv', 'mscarries', 'mscarry', 'msgroup', 'mstack', 'msline', 'msrow', 'semantics', 'annotation', 'annotation-xml', 'mprescripts', 'none']; private static $html_attr = ['accept', 'action', 'align', 'alt', 'autocapitalize', 'autocomplete', 'autopictureinpicture', 'autoplay', 'background', 'bgcolor', 'border', 'capture', 'cellpadding', 'cellspacing', 'checked', 'cite', 'class', 'clear', 'color', 'cols', 'colspan', 'controls', 'controlslist', 'coords', 'crossorigin', 'datetime', 'decoding', 'default', 'dir', 'disabled', 'disablepictureinpicture', 'disableremoteplayback', 'download', 'draggable', 'enctype', 'enterkeyhint', 'face', 'for', 'headers', 'height', 'hidden', 'high', 'href', 'hreflang', 'id', 'inputmode', 'integrity', 'ismap', 'kind', 'label', 'lang', 'list', 'loading', 'loop', 'low', 'max', 'maxlength', 'media', 'method', 'min', 'minlength', 'multiple', 'muted', 'name', 'noshade', 'novalidate', 'nowrap', 'open', 'optimum', 'pattern', 'placeholder', 'playsinline', 'poster', 'preload', 'pubdate', 'radiogroup', 'readonly', 'rel', 'required', 'rev', 'reversed', 'role', 'rows', 'rowspan', 'spellcheck', 'scope', 'selected', 'shape', 'size', 'sizes', 'span', 'srclang', 'start', 'src', 'srcset', 'step', 'style', 'summary', 'tabindex', 'title', 'translate', 'type', 'usemap', 'valign', 'value', 'width', 'xmlns', 'slot']; private static $svg_attr = ['accent-height', 'accumulate', 'additive', 'alignment-baseline', 'ascent', 'attributename', 'attributetype', 'azimuth', 'basefrequency', 'baseline-shift', 'begin', 'bias', 'by', 'class', 'clip', 'clippathunits', 'clip-path', 'clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cx', 'cy', 'd', 'dx', 'dy', 'diffuseconstant', 'direction', 'display', 'divisor', 'dur', 'edgemode', 'elevation', 'end', 'fill', 'fill-opacity', 'fill-rule', 'filter', 'filterunits', 'flood-color', 'flood-opacity', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'fx', 'fy', 'g1', 'g2', 'glyph-name', 'glyphref', 'gradientunits', 'gradienttransform', 'height', 'href', 'id', 'image-rendering', 'in', 'in2', 'k', 'k1', 'k2', 'k3', 'k4', 'kerning', 'keypoints', 'keysplines', 'keytimes', 'lang', 'lengthadjust', 'letter-spacing', 'kernelmatrix', 'kernelunitlength', 'lighting-color', 'local', 'marker-end', 'marker-mid', 'marker-start', 'markerheight', 'markerunits', 'markerwidth', 'maskcontentunits', 'maskunits', 'max', 'mask', 'media', 'method', 'mode', 'min', 'name', 'numoctaves', 'offset', 'operator', 'opacity', 'order', 'orient', 'orientation', 'origin', 'overflow', 'paint-order', 'path', 'pathlength', 'patterncontentunits', 'patterntransform', 'patternunits', 'points', 'preservealpha', 'preserveaspectratio', 'primitiveunits', 'r', 'rx', 'ry', 'radius', 'refx', 'refy', 'repeatcount', 'repeatdur', 'restart', 'result', 'rotate', 'scale', 'seed', 'shape-rendering', 'specularconstant', 'specularexponent', 'spreadmethod', 'startoffset', 'stddeviation', 'stitchtiles', 'stop-color', 'stop-opacity', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke', 'stroke-width', 'style', 'surfacescale', 'systemlanguage', 'tabindex', 'targetx', 'targety', 'transform', 'text-anchor', 'text-decoration', 'text-rendering', 'textlength', 'type', 'u1', 'u2', 'unicode', 'values', 'viewbox', 'visibility', 'version', 'vert-adv-y', 'vert-origin-x', 'vert-origin-y', 'width', 'word-spacing', 'wrap', 'writing-mode', 'xchannelselector', 'ychannelselector', 'x', 'x1', 'x2', 'xmlns', 'xlink:href', 'y', 'y1', 'y2', 'z', 'zoomandpan']; private static $math_ml_attr = ['accent', 'accentunder', 'align', 'bevelled', 'close', 'columnsalign', 'columnlines', 'columnspan', 'denomalign', 'depth', 'dir', 'display', 'displaystyle', 'encoding', 'fence', 'frame', 'height', 'href', 'id', 'largeop', 'length', 'linethickness', 'lspace', 'lquote', 'mathbackground', 'mathcolor', 'mathsize', 'mathvariant', 'maxsize', 'minsize', 'movablelimits', 'notation', 'numalign', 'open', 'rowalign', 'rowlines', 'rowspacing', 'rowspan', 'rspace', 'rquote', 'scriptlevel', 'scriptminsize', 'scriptsizemultiplier', 'selection', 'separator', 'separators', 'stretchy', 'subscriptshift', 'supscriptshift', 'symmetric', 'voffset', 'width', 'xmlns']; private static $special_cases = ['data-', 'aria-']; protected $document_type; protected $allowed_tags = []; protected $allowed_attributes = []; protected $disallowed_tags = []; protected $disallowed_attributes = []; protected $options = [ 'remove-namespaces' => false, 'remove-php-tags' => true, 'remove-html-tags' => true, 'remove-xml-tags' => true, 'compress-output' => true, ]; /** * Constructor that takes an optional DOM type * * @param int $type The type of DOM you will be sanitizing HTML/SVG/MathML */ public function __construct(int $type = self::HTML) { $this->document_type = $type; switch ($type) { case self::SVG: $this->allowed_tags = array_unique(array_merge(self::$root, self::$svg, self::$svg_filters)); $this->allowed_attributes = self::$svg_attr; $this->disallowed_tags = self::$svg_disallowed; break; case self::MATHML: $this->allowed_tags = array_unique(array_merge(self::$root, self::$math_ml)); $this->allowed_attributes = self::$math_ml_attr; $this->disallowed_tags = self::$math_ml_disallowed; break; default: $this->allowed_tags = array_unique(array_merge(self::$root, self::$html, self::$svg, self::$svg_filters, self::$math_ml)); $this->allowed_attributes = array_unique(array_merge(self::$html_attr, self::$svg_attr, self::$math_ml_attr)); $this->disallowed_tags = array_unique(array_merge(self::$svg_disallowed, self::$math_ml_disallowed)); } } /** * Sanitize an HTML-style DOM string * * @param string $dom_content * @param array $options * @return string */ public function sanitize(string $dom_content, array $options = []): string { $options = array_merge($this->options, $options); if ($options['remove-namespaces']) { $dom_content = preg_replace(self::NAMESPACE_TAGS, '', $dom_content); } if ($options['remove-php-tags']) { $dom_content = preg_replace(self::PHP_TAGS, '', $dom_content); } $document = $this->loadDocument($dom_content); $document->preserveWhiteSpace = false; $document->strictErrorChecking = false; $document->formatOutput = true; $tags = array_diff($this->allowed_tags, $this->disallowed_tags); $attributes = array_diff($this->allowed_attributes, $this->disallowed_attributes); $elements = $document->getElementsByTagName('*'); for($i = $elements->length; --$i >= 0;) { $element = $elements->item($i); $tag_name = $element->tagName; if(in_array(strtolower($tag_name), $tags)) { for($j = $element->attributes->length; --$j >= 0;) { $attr_name = $element->attributes->item($j)->name; $attr_value = $element->attributes->item($j)->textContent; if((!in_array(strtolower($attr_name), $attributes) && !$this->isSpecialCase($attr_name)) || $this->isExternalUrl($attr_value)) { $element->removeAttribute($attr_name); } } } else { $element->parentNode->removeChild($element); } } $output = $this->saveDocument($document); $output = $this->regexCleaning($output); if ($options['remove-html-tags']) { $output = preg_replace(self::HTML_TAGS, '', $output); } if ($options['remove-xml-tags']) { $output = preg_replace(self::XML_TAGS, '', $output); } if ($options['compress-output']) { $output = preg_replace(self::WHITESPACE_FROM, self::WHITESPACE_TO, $output); } if ($options['compress-output']) { $output = preg_replace(self::WHITESPACE_FROM, self::WHITESPACE_TO, $output); } return trim($output); } /** * Add new additional supported tags * * @param array $allowed_tags */ public function addAllowedTags(array $allowed_tags): void { $this->allowed_tags = array_unique(array_merge(array_map('strtolower', $allowed_tags), $this->allowed_tags)); } /** * Add new additional supported attributes * * @param array $allowed_attributes */ public function addAllowedAttributes(array $allowed_attributes): void { $this->allowed_attributes = array_unique(array_merge(array_map('strtolower', $allowed_attributes), $this->allowed_attributes)); } /** * Add new additional unsupported tags * * @param array $disallowed_tags */ public function addDisallowedTags(array $disallowed_tags): void { $this->disallowed_tags = array_unique(array_merge(array_map('strtolower', $disallowed_tags), $this->disallowed_tags)); } /** * Add new additional unsupported attributes * * @param array $disallowed_attributes */ public function addDisallowedAttributes(array $disallowed_attributes): void { $this->disallowed_attributes = array_unique(array_merge(array_map('strtolower', $disallowed_attributes), $this->disallowed_attributes)); } /** * Get all the current allowed tags * * @return array|string[] */ public function getAllowedTags(): array { return $this->allowed_tags; } /** * Sets the current allowed tags * * @param array|string[] $allowed_tags */ public function setAllowedTags(array $allowed_tags): void { $this->allowed_tags = $allowed_tags; } /** * Get all the current allowed attributes * * @return array|string[] */ public function getAllowedAttributes(): array { return $this->allowed_attributes; } /** * Sets the current allowed attributes * * @param array|string[] $allowed_attributes */ public function setAllowedAttributes(array $allowed_attributes): void { $this->allowed_attributes = $allowed_attributes; } /** * Gets all the current disallowed tags * * @return array|string[] */ public function getDisallowedTags(): array { return $this->disallowed_tags; } /** * Sets the current disallowed tags * * @param array|string[] $disallowed_tags */ public function setDisallowedTags(array $disallowed_tags): void { $this->disallowed_tags = $disallowed_tags; } /** * Gets all the current disallowed attributes * * @return array|string[] */ public function getDisallowedAttributes(): array { return $this->disallowed_attributes; } /** * Sets the current disallowed attributes * * @param array|string[] $disallowed_attributes */ public function setDisallowedAttributes($disallowed_attributes): void { $this->disallowed_attributes = $disallowed_attributes; } /** * Determines if the attribute is a special case, e.g. (data-, aria-) * * @param $attr_name * @return bool */ protected function isSpecialCase($attr_name): bool { return $this->startsWith($attr_name, self::$special_cases); } /** * Determines if the attribute value is an external link * * @param $attr_value * @return bool */ protected function isExternalUrl($attr_value): bool { return preg_match(self::EXTERNAL_URL, $attr_value); } /** * Does various regex cleanup * * @param $output * @return string */ protected function regexCleaning(string $output): string { $output = preg_replace(self::JAVASCRIPT_ATTR, '', $output); $output = preg_replace(self::SNEAKY_ONLOAD, '', $output); $output = preg_replace(self::HTML_COMMENTS, '', $output); return $output; } /** * Loads appropriate DOMDocument object * * @param string $content * @return \DOMDocument */ protected function loadDocument(string $content): \DOMDocument { $document = new \DOMDocument(); $internalErrors = libxml_use_internal_errors(true); libxml_clear_errors(); switch ($this->document_type) { case self::SVG: case self::MATHML: @$document->loadXML($content); break; default: @$document->loadHTML($content); } libxml_use_internal_errors($internalErrors); return $document; } /** * Saves appropriate DOMDocument object * * @param \DOMDocument $document * @return false|string */ protected function saveDocument(\DOMDocument $document) { switch ($this->document_type) { case self::SVG: case self::MATHML: $content = $document->saveXML($document); break; default: $content = $document->saveHTML($document); } return $content; } /** * Helper method to provide str_starts_with functionality that can take an array of needles * * @param string $haystack * @param $needle * @param bool $case_sensitive * @return bool */ protected function startsWith(string $haystack, $needle, bool $case_sensitive = true): bool { $status = false; $compare_func = $case_sensitive ? 'mb_strpos' : 'mb_stripos'; foreach ((array)$needle as $each_needle) { $status = $each_needle === '' || $compare_func($haystack, $each_needle) === 0; if ($status) { break; } } return $status; } }