Read the docs: Flask-JWT-Router
Flask JWT Router
Flask JWT Router is a Python library that adds authorised routes to a Flask app. Both basic & Google's OAuth2.0 authentication is supported.
Google's OAuth2.0 supported
Google OAuth 2.0 Quick Start
Read the detailed instructions here: Flask-JWT-Router
oauth_options = {
"client_id": "<CLIENT_ID>",
"client_secret": "<CLIENT_SECRET>",
"redirect_uri": "http://localhost:3000",
"tablename": "users",
"email_field": "email",
"expires_in": 3600,
}
jwt_routes.init_app(app, google_oauth=oauth_options)
Now your front end needs a token. Create an endpoint & return a new access token from the clients header code. For Example::
from flask import request
@app.routes("/login", methods=["POST"])
def login():
jwt_routes.google.oauth_login(request) # Pass in Flask's request
Now, the next time your front-end requests authorised resources flask-jwt-router will authenticate with this access token until it expires.
Installation
Stable version
pip install flask-jwt-router
Basic Usage
from flask import Flask
from flask_jwt_router import JwtRoutes
app = Flask(__name__)
# You are required to always set a unique SECRET_KEY for your app
app.config["SECRET_KEY"] = "your_app_secret_key"
JwtRoutes(app)
# If you're using the Flask factory pattern:
jwt_routes = JwtRoutes() # Example with *entity_model - see below
def create_app(config):
...
jwt_routes.init_app(app)
Whitelist Routes
app.config["WHITE_LIST_ROUTES"] = [
("POST", "/register"),
]
@app.route("/register", methods=["POST"])
def register():
return "I don't need authorizing!"
Prefix your api name to whitelisted routes
# All routes will
app.config["JWT_ROUTER_API_NAME"] = "/api/v1"
app.config["WHITE_LIST_ROUTES"] = [
("POST", "/register"),
]
@app.route("/api/v1/register", methods=["POST"])
def register():
return "I don't need authorizing!"
Bypass Flask-JWT-Router on specified routes
# Define homepage template routes for example on JWT_IGNORE_ROUTES
# & still get to use the api name on request handlers returning resources
app.config["IGNORED_ROUTES"] = [
("GET", "/")
]
Declare an entity model
# Create your entity model (example uses Flask-SqlAlchemy)
class UserModel(db.Model):
__tablename__ = "users"
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String)
# You can define the primary key name with `ENTITY_KEY` on Flask's config
app.config["ENTITY_KEY"] = "user_id"
# (`id` is used by default)
JwtRoutes(app, entity_models=[UserModel, TeacherModel, ...etc])
# Or pass later with `init_app`
def create_app(config):
...
jwt_routes.init_app(app, entity_models=[UserModel, TeacherModel, ...etc])
Authorization
from your_app import jwt_routes
# white list the routes
app.config["WHITE_LIST_ROUTES"] = [
("POST", "/register"),
("POST", "/login"),
]
@app.route("/login", methods=["POST"])
def register():
"""I'm registering a new user & returning a token!"""
return jsonify({
"token": jwt_routes.create_token(entity_id=1, table_name='users')
})
@app.route("/your_resource", methods=["POST"])
def login():
"""I'm authorized & updating my token!"""
return jsonify({
"token": jwt_routes.update_token(entity_id=1)
})
*Warning: The table_name must be the same as your tablename or __tablename__ attribute's value. (With SqlAlchemy, you can define a __tablename__ attribute directly or else the name is derived from your entity’s database table name).
Setting the Token Expire Duration
There are two ways to set the expire duration of the JWT.
from your app config
# Set the token expire duration to 7 days
app.config["JWT_EXPIRE_DAYS"] = 7
calling the set_exp
# Set the token expire duration to 14 days
jwt_routes = JwtRoutes()
# jwt_routes.init_app( ...etc
jwt_routes.set_exp(expire_days=14)
By default the expire duration is set to 30 days
Create & update Tokens on Routes
Create a new entity & return a new token
@app.route("/register", methods=["POST"])
def register():
user_data = request.get_json()
try:
user = UserModel(**user_data)
user.create_user() # your entity creation logic
# Here we pass the id as a kwarg to `create_token`
token: str = jwt_routes.create_token(entity_id=user.id, table_name="users")
# Now we can return a new token!
return {
"message": "User successfully created.",
"token": str(token), # casting is optional
}, 200
Access entity on Flask's global context
from app import app, jwt_routes
# Example uses Marshmallow to serialize entity object
class EntitySchema(Schema):
id = fields.Integer()
name = fields.String()
@app.route("/login", methods=["GET"])
def login():
user_data = g.get("users") # This is your SqlAlchemy `__tablename__` or the default name.
try:
user_dumped = UserSchema().dump(user_data)
except ValidationError as _:
return {
"error": "User requested does not exist."
}, 401
return {
"data": user_dumped,
"token": jwt_routes.update_token(entity_id=user_data.id),
}, 200
If you are handling a request with a token in the headers you can call::
jwt_routes.update_token(entity_id=user_data.id)
If you are handling a request without a token in the headers you can call::
jwt_routes.create_token(entity_id=user_data.id, table_name="users")
An Example configuration for registering & logging in users of different types:
app.config["IGNORED_ROUTES"] = [("GET", "/")]
app.config["JWT_ROUTER_API_NAME"] = "/api/v1"
app.config["WHITE_LIST_ROUTES"] = [
("POST", "/auth/user"), ("POST", "/auth/user/login"),
("POST", "/auth/teacher"), ("POST", "/auth/teacher/login"),
]
# Optionally, you can pass your models to Flask's config:
app.config["ENTITY_MODELS"] = [ UserModel, TeacherModel, ...etc ]
JSON Web Token setup
To send the JSON web token from your front end, you will need to pass a Bearer string in your authorization header. For example:
fetch(url, {
headers: {
Authorization: "Bearer <my_token>",
}
})
Routing without headers
If you require calling a resource without passing headers, then you can use the auth query param (useful when streaming video files):
url = "http://example.com/cars?auth=my_token"
Google OAuth 2.0 with ReactJS
Flask-JWT-Router supports auth Google's OAuth 2.0 Single Sign On strategy if you are using React only. (We will provide Google's OAuth 2.0 Single Sign On strategy for server to server as soon as possible!).
Quick Start
Create a login route for Google's OAuth 2.0
@app.route("/api/v1/google_login", methods=["POST"])
def google_login():
data = jwt_routes.google.oauth_login(request)
return data, 200
We have created a ReactJS library specifically for Flask-JWT-Router - react-google-oauth2.0 In your React app directory install react-google-oauth2.0:
npm install react-google-oauth2 --save
Testing
Testing OAuth2.0 in a Flask app is non-trivial, especially if you rely on Flask-JWT-Router to append your user onto Flask's global context (or g). Therefore we have provided a utility method that returns a headers Dict that you can then use in your test view handler request. This example is using the Pytest library:
@pytest.fixture()
def client():
# See https://flask.palletsprojects.com/en/1.1.x/testing/ for details
def test_blogs(client):
user_headers = jwt_routes.google.create_test_headers(email="[email protected]")
rv = client.get("/blogs", headers=user_headers)
If you are not running a db in your tests, then you can use the entity kwarg. For example:
# user is an instantiated SqlAlchemy object
user_headers = jwt_routes.google.create_test_headers(email="[email protected]", entity=user)
# user_headers: { "X-Auth-Token": "Bearer <GOOGLE_OAUTH2_TEST>" }
If you require more than one request to a Flask view handler in a single unit test, then set the scope kwarg to application. (Default is function) For example:
_ = jwt_routes.google.create_test_headers(email="[email protected]", scope="application")
Authors
- joegasewicz - Initial work - @joegasewicz
- Kousik Mitra - Initial work - @kousikmitra
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Make sure you have Python versions: 3.6, 3.7, 3.8 Then run:
tox
To check the docs look good locally you can run:
make html
1k Dec 28, 2022
3 May 16, 2022
4 Oct 28, 2021
5 Jan 04, 2022
253 Nov 14, 2022
3.2k Dec 28, 2022
1k Dec 22, 2022
9 Sep 19, 2022
1 Aug 18, 2022
0 Jan 06, 2022
7.8k Jan 02, 2023
2.4k Jan 03, 2023
315 Dec 25, 2022
1 Dec 13, 2021
363 Dec 24, 2022
3k Jan 02, 2023
91 Nov 24, 2022
1 Feb 01, 2022
88 Jan 01, 2023