jwt-authenticator 1.11.1

Simple JWT token flask service security library.

[

jwt_authenticator

jwt_authenticator is a simply python library for adding JWT token authentication/authorization in flask web sites/services. It controls access either by checking for just a validated token, or optionally, a single role claim from the token. Access is controlled by decorating the endpoint functions with an attribute.

Installation

Use the package manager pip to install jwt_authenticator.

pip install jwt-authenticator

If using RS256, you must also:

pip install cryptography

Usage

In the main application initialization area

from flask import Flask
from jwt_authenticator import AuthenticationHandler

APP = Flask(__name__)
AuthenticationHandler.load_configuration(APP)

In the endpoints

from jwt_authenticator import AuthenticationHandler, AuthError

@api.route('/<name>', methods=['GET'])
@AuthenticationHandler.requires_auth("admin")
def get_one(name):
    return f"Hello {name}"

@api.route('/<name>', methods=['GET'])
@AuthenticationHandler.requires_auth()
def get_one(name):
    return f"Hello {name}"

Configuration

jwt_authenticator requires two configuration values to work. These can be specified either in the normal Flask application configuration or as environment variables. Environment variable values will override application configuration values, when

AuthenticationHanlder.load_configuration(app)

is called.

APP.config (i.e. flask application configuration)

• SECRET - the key used to sign the JWT token. Option if JWKS_URL specified.
• AUDIENCE - the audience claim used in the JWT token
• JKWS_URL - [OPTIONAL] OIDC key discovery URL
• GROUPS_CLAIM - [OPTIONAL] which claim has the list of groups. Defaults to "groups"

Environment Variables

• JWT_SECRET - will override SECRET
• JWT_AUDIENCE - will override AUDIENCE
• JWKS_URL - will override JWKS_URL
• GROUPS_CLAIM - will override GROUPS_CLAIM

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.

Building

• Requires 'make'

make init
make test
make package

License

MIT