Skip to main content

HTTP authentication for Flask routes

Project description


Build status codecov

Simple extension that provides Basic and Digest HTTP authentication for Flask routes.


The easiest way to install this is through pip.

pip install Flask-HTTPAuth

Basic authentication example

from flask import Flask
from flask_httpauth import HTTPBasicAuth
from import generate_password_hash, check_password_hash

app = Flask(__name__)
auth = HTTPBasicAuth()

users = {
    "john": generate_password_hash("hello"),
    "susan": generate_password_hash("bye")

def verify_password(username, password):
    if username in users and \
            check_password_hash(users.get(username), password):
        return username

def index():
    return "Hello, %s!" % auth.current_user()

if __name__ == '__main__':

Note: See the documentation for more complex examples that involve password hashing and custom verification callbacks.

Digest authentication example

from flask import Flask
from flask_httpauth import HTTPDigestAuth

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret key here'
auth = HTTPDigestAuth()

users = {
    "john": "hello",
    "susan": "bye"

def get_pw(username):
    if username in users:
        return users.get(username)
    return None

def index():
    return "Hello, %s!" % auth.username()

if __name__ == '__main__':


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Flask-HTTPAuth, version 4.5.0
Filename, size File type Python version Upload date Hashes
Filename, size Flask_HTTPAuth-4.5.0-py3-none-any.whl (6.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size Flask-HTTPAuth-4.5.0.tar.gz (36.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page