This is an example of OAuth 2.0 server in Authlib.
If you are looking for old Flask-OAuthlib implementation, check the
flask-oauthlib branch.
- Documentation: https://docs.authlib.org/en/latest/flask/2/
- Authlib Repo: https://github.com/lepture/authlib
 |
If you want to quickly add secure token-based authentication to Python projects, feel free to check Auth0's Python SDK and free plan at auth0.com/overview. |
This is a ready to run example, let's take a quick experience at first. To run the example, we need to install all the dependencies:
$ pip install -r requirements.txtSet Flask and Authlib environment variables:
# disable check https (DO NOT SET THIS IN PRODUCTION)
$ export AUTHLIB_INSECURE_TRANSPORT=1Create Database and run the development server:
$ flask runNow, you can open your browser with http://127.0.0.1:5000/, login with any
name you want.
Before testing, we need to create a client:
Get your client_id and client_secret for testing. In this example, we
have enabled password grant types, let's try:
$ curl -u ${client_id}:${client_secret} -XPOST http://127.0.0.1:5000/oauth/token -F grant_type=password -F username=${username} -F password=valid -F scope=profile
Because this is an example, every user's password is valid. Now you can access /api/me:
$ curl -H "Authorization: Bearer ${access_token}" http://127.0.0.1:5000/api/meTo test the authorization code flow, you can just open this URL in your browser.
$ open http://127.0.0.1:5000/oauth/authorize?response_type=code&client_id=${client_id}&scope=profileAfter granting the authorization, you should be redirected to ${redirect_uri}/?code=${code}
Then your app can send the code to the authorization server to get an access token:
$ curl -u ${client_id}:${client_secret} -XPOST http://127.0.0.1:5000/oauth/token -F grant_type=authorization_code -F scope=profile -F code=${code}Now you can access /api/me:
$ curl -H "Authorization: Bearer ${access_token}" http://127.0.0.1:5000/api/meFor now, you can read the source in example or follow the long boring tutorial below.
IMPORTANT: To test implicit grant, you need to token_endpoint_auth_method to none.
Assume this example doesn't exist at all. Let's write an OAuth 2.0 server from scratch step by step.
Here is our Flask website structure:
app.py --- FLASK_APP
website/
app.py --- Flask App Factory
__init__.py --- module initialization (empty)
models.py --- SQLAlchemy Models
oauth2.py --- OAuth 2.0 Provider Configuration
routes.py --- Routes views
templates/
Create a virtualenv and install all the requirements. You can also put the
dependencies into requirements.txt:
Flask
Flask-SQLAlchemy
Authlib
Create a home route view to say "Hello World!". It is used to test if things working well.
# website/routes.py
from flask import Blueprint
bp = Blueprint(__name__, 'home')
@bp.route('/')
def home():
return 'Hello World!'# website/app.py
from flask import Flask
from .routes import bp
def create_app(config=None):
app = Flask(__name__)
# load app sepcified configuration
if config is not None:
if isinstance(config, dict):
app.config.update(config)
elif config.endswith('.py'):
app.config.from_pyfile(config)
setup_app(app)
return app
def setup_app(app):
app.register_blueprint(bp, url_prefix='')# app.py
from website.app import create_app
app = create_app({
'SECRET_KEY': 'secret',
})Create an empty __init__.py file in the website folder.
The "Hello World!" example should run properly:
$ FLASK_APP=app.py flask run
We will use SQLAlchemy and SQLite for our models. You can also use other databases and other ORM engines. Authlib has some built-in SQLAlchemy mixins which will make it easier for creating models.
Let's create the models in website/models.py. We need four models, which are
- User: you need a user to test and create your application
- OAuth2Client: the oauth client model
- OAuth2AuthorizationCode: for
grant_type=codeflow - OAuth2Token: save the
access_tokenin this model.
Check how to define these models in website/models.py.
Once you've created your own website/models.py (or copied our version), you'll need to import the database object db. Add the line from .models import db just after from flask import Flask in your scratch-built version of website/app.py.
To initialize the database upon startup, if no tables exist, you'll add a few lines to the setup_app() function in website/app.py so that it now looks like:
def setup_app(app):
# Create tables if they do not exist already
@app.before_first_request
def create_tables():
db.create_all()
db.init_app(app)
app.register_blueprint(bp, url_prefix='')You can try running the app again as above to make sure it works.
The source code is in website/oauth2.py. There are four standard grant types:
- Authorization Code Grant
- Implicit Grant
- Client Credentials Grant
- Resource Owner Password Credentials Grant
And Refresh Token is implemented as a Grant in Authlib. You don't have to do
anything on Implicit and Client Credentials grants, but there are missing
methods to be implemented in other grants. Check out the source code in
website/oauth2.py.
Once you've created your own website/oauth2.py, import the oauth2 config object from the oauth2 module. Add the line from .oauth2 import config_oauth just after the import you added above in your scratch-built version of website/app.py.
To initialize the oauth object, add config_oauth(app) to the setup_app() function, just before the line that starts with app.register_blueprint so it looks like:
def setup_app(app):
# Create tables if they do not exist already
@app.before_first_request
def create_tables():
db.create_all()
db.init_app(app)
config_oauth(app)
app.register_blueprint(bp, url_prefix='')You can try running the app again as above to make sure it still works.
Authlib has provided a ResourceProtector for you to create the decorator
@require_oauth, which can be easily implemented:
from authlib.flask.oauth2 import ResourceProtector
require_oauth = ResourceProtector()For now, only Bearer Token is supported. Let's add bearer token validator to this ResourceProtector:
from authlib.flask.oauth2.sqla import create_bearer_token_validator
# helper function: create_bearer_token_validator
bearer_cls = create_bearer_token_validator(db.session, OAuth2Token)
require_oauth.register_token_validator(bearer_cls())Check the full implementation in website/oauth2.py.
For OAuth server itself, we only need to implement routes for authentication, and issuing tokens. Since we have added token revocation feature, we need a route for revoking too.
Checkout these routes in website/routes.py. Their path begin with /oauth/.
But that is not enough. In this demo, you will need to have some web pages to
create and manage your OAuth clients. Check that /create_client route.
And we have an API route for testing. Check the code of /api/me.
Here you go. You've got an OAuth 2.0 server.
Read more information on https://docs.authlib.org/.
Same license with Authlib.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
