NOTE: 2023-01-23: Bleach is deprecated. See issue: https://github.com/mozilla/bleach/issues/698
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
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.
- Issue tracker
Apache License v2; see LICENSE file
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.
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
the Security issues section. We include any relevant CVE links.
Bleach is available on PyPI, so you can install it with
$ pip install bleach
The simplest way to use Bleach is:
>>> import bleach >>> bleach.clean('an <script>evil()</script> example') u'an <script>evil()</script> 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 CODE_OF_CONDUCT.md
- Sanitizing text fragments
- Linkifying text fragments
- Goals of Bleach
- Bleach development
- Bleach changes
- Version 6.0.0 (January 23rd, 2023)
- Version 5.0.1 (June 27th, 2022)
- Version 5.0.0 (April 7th, 2022)
- Version 4.1.0 (August 25th, 2021)
- Version 4.0.0 (August 3rd, 2021)
- Version 3.3.1 (July 14th, 2021)
- Version 3.3.0 (February 1st, 2021)
- Version 3.2.3 (January 26th, 2021)
- Version 3.2.2 (January 20th, 2021)
- Version 3.2.1 (September 18th, 2020)
- Version 3.2.0 (September 16th, 2020)
- Version 3.1.5 (April 29th, 2020)
- Version 3.1.4 (March 24th, 2020)
- Version 3.1.3 (March 17th, 2020)
- Version 3.1.2 (March 11th, 2020)
- Version 3.1.1 (February 13th, 2020)
- Version 3.1.0 (January 9th, 2019)
- Version 3.0.2 (October 11th, 2018)
- Version 3.0.1 (October 9th, 2018)
- Version 3.0.0 (October 3rd, 2018)
- Version 2.1.4 (August 16th, 2018)
- Version 2.1.3 (March 5th, 2018)
- Version 2.1.2 (December 7th, 2017)
- Version 2.1.1 (October 2nd, 2017)
- Version 2.1 (September 28th, 2017)
- Version 2.0 (March 8th, 2017)
- Version 1.5 (November 4th, 2016)
- Version 1.4.3 (May 23rd, 2016)
- Version 1.4.2 (September 11, 2015)
- Version 1.4.1 (December 15, 2014)
- Version 1.4 (January 12, 2014)
- Version 1.3
- Version 1.2.2 (May 18, 2013)
- Version 1.2.1 (February 19, 2013)
- Version 1.2 (January 28, 2013)
- Version 1.1.5
- Version 1.1.4
- Version 1.1.3 (July 10, 2012)
- Version 1.1.2 (June 1, 2012)
- Version 1.1.1 (February 17, 2012)
- Version 1.1.0 (October 24, 2011)
- Version 1.0.4 (September 2, 2011)
- Version 1.0.3 (June 14, 2011)
- Version 1.0.2 (June 6, 2011)
- Version 1.0.1 (April 12, 2011)
- Migrating from the html5lib sanitizer