# Bleach

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.

## Installing Bleach

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

    $ pip install bleach

Or with `easy_install`:

    $ easy_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

## Security

Bleach is a security-related 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 relevant CVE links.

## 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.

## Contents

- Sanitizing text fragments
  - Allowed tags (`tags`)
  - Allowed Attributes (`attributes`)
  - Allowed styles (`styles`)
  - Allowed protocols (`protocols`)
  - Stripping markup (`strip`)
  - Stripping comments (`strip_comments`)
  - Using `bleach.sanitizer.Cleaner`
  - Using `bleach.sanitizer.BleachSanitizerFilter`
- Linkifying text fragments
  - Callbacks for adjusting attributes (`callbacks`)
  - Skipping links in specified tag blocks (`skip_tags`)
  - Linkifying email addresses (`parse_email`)
  - Using `bleach.linkifier.Linker`
  - Using `bleach.linkifier.LinkifyFilter`
- Goals of Bleach
  - Goals
  - Non-Goals
  - Bleach vs html5lib
- Bleach development
  - Install for development
  - Reporting Bugs
  - Code of conduct
  - Docs
  - Testing
  - Release process
- Bleach Changes
  - 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)

## Indices and tables

- Index
- Search Page