从 Python 字符串中删除不在允许列表中的 HTML 标记

我有一个包含文本和 HTML 的字符串。我想删除或以其他方式禁用一些 HTML 标记，如 <script>，而允许其他，以便我可以在网页上呈现它安全。我有一个允许标记的列表，我如何处理字符串以删除任何其他标记？

44786 次浏览
小开
最佳答案

下面是一个使用 美味汤的简单解决方案:

from bs4 import BeautifulSoup


VALID_TAGS = ['strong', 'em', 'p', 'ul', 'li', 'br']


def sanitize_html(value):


soup = BeautifulSoup(value)


for tag in soup.findAll(True):
if tag.name not in VALID_TAGS:
tag.hidden = True


return soup.renderContents()

如果您还想删除无效标记的内容，请用 tag.extract()代替 tag.hidden。

您还可以考虑使用 Lxml和 整洁。

小开

以上的解决方案通过美丽的汤不会工作。您也许可以使用 Beautiful Soup 在它们之上或之外修改一些内容，因为 Beautiful Soup 提供了对解析树的访问。过一会儿，我想我会试着正确地解决这个问题，但是这是一个为期一周左右的项目，而且我很快就没有一周的空闲时间了。

具体来说，Beautiful Soup 不仅会为一些上面的代码没有捕捉到的解析错误抛出异常，而且还有很多非常真实的 XSS 漏洞没有捕捉到，比如:

<<script>script> alert("Haha, I hacked your page."); </</script>script>

也许您能做的最好的事情是去掉 <元素作为 &lt;，禁止 所有 HTML，然后使用一个受限子集(如 Markdown)来正确地呈现格式。特别是，您还可以返回并使用正则表达式重新引入 HTML 的常见部分。这个过程大致是这样的:

_lt_     = re.compile('<')
_tc_ = '~(lt)~'   # or whatever, so long as markdown doesn't mangle it.
_ok_ = re.compile(_tc_ + '(/?(?:u|b|i|em|strong|sup|sub|p|br|q|blockquote|code))>', re.I)
_sqrt_ = re.compile(_tc_ + 'sqrt>', re.I)     #just to give an example of extending
_endsqrt_ = re.compile(_tc_ + '/sqrt>', re.I) #html syntax with your own elements.
_tcre_ = re.compile(_tc_)


def sanitize(text):
text = _lt_.sub(_tc_, text)
text = markdown(text)
text = _ok_.sub(r'<\1>', text)
text = _sqrt_.sub(r'&radic;<span style="text-decoration:overline;">', text)
text = _endsqrt_.sub(r'</span>', text)
return _tcre_.sub('&lt;', text)

我还没有测试代码，所以可能有错误。但是您可以看到总体思路: 在将 ok 内容列入白名单之前，必须将所有 HTML 列入黑名单。

小开

下面是我在自己的项目中使用的方法。

from BeautifulSoup import BeautifulSoup


acceptable_elements = ['a', 'abbr', 'acronym', 'address', 'area', 'b', 'big',
'blockquote', 'br', 'button', 'caption', 'center', 'cite', 'code', 'col',
'colgroup', 'dd', 'del', 'dfn', 'dir', 'div', 'dl', 'dt', 'em',
'font', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img',
'ins', 'kbd', 'label', 'legend', 'li', 'map', 'menu', 'ol',
'p', 'pre', 'q', 's', 'samp', 'small', 'span', 'strike',
'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th',
'thead', 'tr', 'tt', 'u', 'ul', 'var']


acceptable_attributes = ['abbr', 'accept', 'accept-charset', 'accesskey',
'action', 'align', 'alt', 'axis', 'border', 'cellpadding', 'cellspacing',
'char', 'charoff', 'charset', 'checked', 'cite', 'clear', 'cols',
'colspan', 'color', 'compact', 'coords', 'datetime', 'dir',
'enctype', 'for', 'headers', 'height', 'href', 'hreflang', 'hspace',
'id', 'ismap', 'label', 'lang', 'longdesc', 'maxlength', 'method',
'multiple', 'name', 'nohref', 'noshade', 'nowrap', 'prompt',
'rel', 'rev', 'rows', 'rowspan', 'rules', 'scope', 'shape', 'size',
'span', 'src', 'start', 'summary', 'tabindex', 'target', 'title', 'type',
'usemap', 'valign', 'value', 'vspace', 'width']


def clean_html( fragment ):
while True:
soup = BeautifulSoup( fragment )
removed = False
for tag in soup.findAll(True): # find all tags
if tag.name not in acceptable_elements:
tag.extract() # remove the bad ones
removed = True
else: # it might have bad attributes
# a better way to get all attributes?
for attr in tag._getAttrMap().keys():
if attr not in acceptable_attributes:
del tag[attr]


# turn it back to html
fragment = unicode(soup)


if removed:
# we removed tags and tricky can could exploit that!
# we need to reparse the html until it stops changing
continue # next round


return fragment

通过一些小测试来确保这种行为是正确的:

tests = [   #text should work
('<p>this is text</p>but this too', '<p>this is text</p>but this too'),
# make sure we cant exploit removal of tags
('<<script></script>script> alert("Haha, I hacked your page."); <<script></script>/script>', ''),
# try the same trick with attributes, gives an Exception
('<div on<script></script>load="alert("Haha, I hacked your page.");">1</div>',  Exception),
# no tags should be skipped
('<script>bad</script><script>bad</script><script>bad</script>', ''),
# leave valid tags but remove bad attributes
('<a href="good" onload="bad" onclick="bad" alt="good">1</div>', '<a href="good" alt="good">1</a>'),
]


for text, out in tests:
try:
res = clean_html(text)
assert res == out, "%s => %s != %s" % (text, res, out)
except out, e:
assert isinstance(e, out), "Wrong exception %r" % e
小开

使用 lxml.html.clean! 这是非常容易的！

from lxml.html.clean import clean_html
print clean_html(html)

假设下面的 html:

html = '''\
<html>
<head>
<script type="text/javascript" src="evil-site"></script>
<link rel="alternate" type="text/rss" src="evil-rss">
<style>
body {background-image: url(javascript:do_evil)};
div {color: expression(evil)};
</style>
</head>
<body onload="evil_function()">
<!-- I am interpreted for EVIL! -->
<a href="javascript:evil_function()">a link</a>
<a href="#" onclick="evil_function()">another link</a>
<p onclick="evil_function()">a paragraph</p>
<div style="display: none">secret EVIL!</div>
<object> of EVIL! </object>
<iframe src="evil-site"></iframe>
<form action="evil-site">
Password: <input type="password" name="password">
</form>
<blink>annoying EVIL!</blink>
<a href="evil-site">spam spam SPAM!</a>
<image src="evil!">
</body>
</html>'''

结果..。

<html>
<body>
<div>
<style>/* deleted */</style>
<a href="">a link</a>
<a href="#">another link</a>
<p>a paragraph</p>
<div>secret EVIL!</div>
of EVIL!
Password:
annoying EVIL!
<a href="evil-site">spam spam SPAM!</a>
<img src="evil!">
</div>
</body>
</html>

您可以自定义要清理的元素等等。

小开

我更喜欢 lxml.html.clean解决方案，比如 Nosklo 指出。这里还要去掉一些空标签:

from lxml import etree
from lxml.html import clean, fromstring, tostring


remove_attrs = ['class']
remove_tags = ['table', 'tr', 'td']
nonempty_tags = ['a', 'p', 'span', 'div']


cleaner = clean.Cleaner(remove_tags=remove_tags)


def squeaky_clean(html):
clean_html = cleaner.clean_html(html)
# now remove the useless empty tags
root = fromstring(clean_html)
context = etree.iterwalk(root) # just the end tag event
for action, elem in context:
clean_text = elem.text and elem.text.strip(' \t\r\n')
if elem.tag in nonempty_tags and \
not (len(elem) or clean_text): # no children nor text
elem.getparent().remove(elem)
continue
elem.text = clean_text # if you want
# and if you also wanna remove some attrs:
for badattr in remove_attrs:
if elem.attrib.has_key(badattr):
del elem.attrib[badattr]
return tostring(root)
小开

我修改了 布莱恩的 解决方案与美丽的汤来处理 克里斯 · 德罗斯特提出的问题。有点粗糙，但是起到了作用:

from BeautifulSoup import BeautifulSoup, Comment


VALID_TAGS = {'strong': [],
'em': [],
'p': [],
'ol': [],
'ul': [],
'li': [],
'br': [],
'a': ['href', 'title']
}


def sanitize_html(value, valid_tags=VALID_TAGS):
soup = BeautifulSoup(value)
comments = soup.findAll(text=lambda text:isinstance(text, Comment))
[comment.extract() for comment in comments]
# Some markup can be crafted to slip through BeautifulSoup's parser, so
# we run this repeatedly until it generates the same output twice.
newoutput = soup.renderContents()
while 1:
oldoutput = newoutput
soup = BeautifulSoup(newoutput)
for tag in soup.findAll(True):
if tag.name not in valid_tags:
tag.hidden = True
else:
tag.attrs = [(attr, value) for attr, value in tag.attrs if attr in valid_tags[tag.name]]
newoutput = soup.renderContents()
if oldoutput == newoutput:
break
return newoutput

编辑: 更新以支持有效属性。

小开

我用 过滤 HTML。它很简单，允许您定义一个控制良好的白名单，擦除 URL，甚至将属性值与正则表达式匹配，或者为每个属性定制过滤函数。如果使用谨慎，它可能是一个安全的解决方案。下面是自述文件中的一个简化例子:

import FilterHTML


# only allow:
#   <a> tags with valid href URLs
#   <img> tags with valid src URLs and measurements
whitelist = {
'a': {
'href': 'url',
'target': [
'_blank',
'_self'
],
'class': [
'button'
]
},
'img': {
'src': 'url',
'width': 'measurement',
'height': 'measurement'
},
}


filtered_html = FilterHTML.filter_html(unfiltered_html, whitelist)
小开

您可以使用 Html5lib，它使用一个白名单来消毒。

举个例子:

import html5lib
from html5lib import sanitizer, treebuilders, treewalkers, serializer


def clean_html(buf):
"""Cleans HTML of dangerous tags and content."""
buf = buf.strip()
if not buf:
return buf


p = html5lib.HTMLParser(tree=treebuilders.getTreeBuilder("dom"),
tokenizer=sanitizer.HTMLSanitizer)
dom_tree = p.parseFragment(buf)


walker = treewalkers.getTreeWalker("dom")
stream = walker(dom_tree)


s = serializer.htmlserializer.HTMLSerializer(
omit_optional_tags=False,
quote_attr_values=True)
return s.render(stream)
小开

Bleach 使用更有用的选项效果更好。它构建在 html5lib 上，可以投入生产。检查 bleach.clean函数的文档。它的默认配置避免使用不安全的标记(如 <script>) ，同时允许使用有用的标记(如 <a>)。

import bleach
bleach.clean("<script>evil</script> <a href='http://example.com'>example</a>")
# '&lt;script&gt;evil&lt;/script&gt; <a href="http://example.com">example</a>'

提交答案