Flask-BasicAuth is a Flask extension that provides an easy way to protect certain views or your whole application with HTTP basic access authentication.
The easiest way to install Flask-BasicAuth is with pip:
pip install Flask-BasicAuthUsage of Flask-BasicAuth is simple:
from flask import Flask, render_template
from flask.ext.basicauth import BasicAuth
app = Flask(__name__)
app.config['BASIC_AUTH_USERNAME'] = 'john'
app.config['BASIC_AUTH_PASSWORD'] = 'matrix'
basic_auth = BasicAuth(app)
@app.route('/secret')
@basic_auth.required
def secret_view():
return render_template('secret.html')If you would like to protect you entire site with basic access authentication, just set BASIC_AUTH_FORCE configuration variable to `True`:
app.config['BASIC_AUTH_FORCE'] = TrueYou might find this useful, for example, if you would like to protect your staging server from uninvited guests.
Warning
Please make sure that you use SSL/TLS (HTTPS) to encrypt the connection between the client and the server, when using basic access authentication. In basic access authentication username and password are sent in cleartext, and if SSL/TLS is not used, the credentials could be easily intercepted.
The following configuration values exist for Flask-BasicAuth. Flask-BasicAuth loads these values from your main Flask config which can be populated in various ways.
A list of configuration keys currently understood by the extension:
BASIC_AUTH_FORCEIf set to True, makes the whole site require HTTP basic access authentication.
Defaults to False.
BASIC_AUTH_REALMThe authentication realm used for the challenge. This is typically a description of the system being accessed.
Defaults to
''.BASIC_AUTH_USERNAMEandBASIC_AUTH_PASSWORDThe correct username and password combination that grants access for the client to the protected resource.
You can override
BasicAuth.check_credentials <flask.ext.basicauth.BasicAuth.check_credentials>, if you need a different authentication logic for your application.
flask.ext.basicauth
This part of the documentation covers all the public classes and functions in Flask-BasicAuth.
BasicAuth