Skip to content
Bleach is an allowed-list-based HTML sanitizing library that escapes or strips markup and attributes
Branch: master
Clone or download
Latest commit 613d64a Jan 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bleach fix #426 (#434) Jan 18, 2019
docs Fix doctest failures Jan 8, 2019
scripts Fix vendor_verify.sh problems with RECORD Oct 8, 2018
tests
tests_website Fix MANIFEST and data_to_json.py related to recent changes Mar 3, 2018
.gitignore vendor html5lib 1.0.1 Aug 27, 2018
.travis.yml
CHANGES Update for 3.1.0 release Jan 9, 2019
CODE_OF_CONDUCT.rst Add code of conduct blurb, move some docs around Sep 20, 2017
CONTRIBUTING.rst Add section for security-related bug disclosure Oct 26, 2015
CONTRIBUTORS
LICENSE
MANIFEST.in Add vendor verify Aug 28, 2018
README.rst Move security text higher in README; fix typo Sep 27, 2018
requirements-dev.txt
setup.cfg
setup.py
tox.ini Add Python 3.7 environment to tox and Travis Oct 8, 2018

README.rst

Bleach

https://travis-ci.org/mozilla/bleach.svg?branch=master

Bleach is an allowed-list-based HTML sanitizing library that escapes or strips markup and attributes.

Bleach can also linkify text safely, applying filters that Django's urlize filter cannot, and optionally setting rel attributes, even on links already in the text.

Bleach is intended for sanitizing text from untrusted sources. If you find yourself jumping through hoops to allow your site administrators to do lots of things, you're probably outside the use cases. Either trust those users, or don't.

Because it relies on html5lib, Bleach is as good as modern browsers at dealing with weird, quirky HTML fragments. And any of Bleach's methods will fix unbalanced or mis-nested tags.

The version on GitHub is the most up-to-date and contains the latest bug fixes. You can find full documentation on ReadTheDocs.

Code:https://github.com/mozilla/bleach
Documentation:https://bleach.readthedocs.io/
Issue tracker:https://github.com/mozilla/bleach/issues
IRC:#bleach on irc.mozilla.org
License:Apache License v2; see LICENSE file

Reporting Bugs

For regular bugs, please report them in our issue tracker.

If you believe that you've found a security vulnerability, please file a secure bug report in our bug tracker or send an email to security AT mozilla DOT org.

For more information on security-related bug disclosure and the PGP key to use for sending encrypted mail or to verify responses received from that address, please read our wiki page at https://www.mozilla.org/en-US/security/#For_Developers.

Security

Bleach is a security-focused library.

We have a responsible security vulnerability reporting process. Please use that if you're reporting a security issue.

Security issues are fixed in private. After we land such a fix, we'll do a release.

For every release, we mark security issues we've fixed in the CHANGES in the Security issues section. We include any relevant CVE links.

Installing Bleach

Bleach is available on PyPI, so you can install it with pip:

$ pip install bleach

Upgrading Bleach

Warning

Before doing any upgrades, read through Bleach Changes for backwards incompatible changes, newer versions, etc.

Basic use

The simplest way to use Bleach is:

>>> import bleach

>>> bleach.clean('an <script>evil()</script> example')
u'an &lt;script&gt;evil()&lt;/script&gt; example'

>>> bleach.linkify('an http://example.com url')
u'an <a href="http://example.com" rel="nofollow">http://example.com</a> url

Code of conduct

This project and repository is governed by Mozilla's code of conduct and etiquette guidelines. For more details please see the Mozilla Community Participation Guidelines and Developer Etiquette Guidelines.

You can’t perform that action at this time.