fastapi-bearer-auth 0.1.2

A simple FastAPI auth module with signup/signin routes

FastAPI Bearer Auth

A simple FastAPI auth module implementing OAuth2 with Password (and hashing), Bearer with JWT tokens, including user signup, signin routes.

Installing

Works on python3.6+

pip install fastapi-bearer-auth

Example of using

from fastapi import FastAPI, Depends

import fastapi_bearer_auth as fba


app = FastAPI(title='Test App')
app.include_router(fba.user_router, prefix='/user', tags=['User'])
# simple in-memory db
users = {}


@fba.handle_get_user_by_name
async def get_user_by_name(name):
    return users.get(name)


@fba.handle_create_user
async def create_user(username, password):
    if await get_user_by_name(username):
        raise ValueError('Username {} exists'.format(username))
    user = {
        'username': username,
        'password': await fba.call_config('get_password_hash', password),
    }
    users[username] = user
    return user


@app.get('/test')
async def test(user: dict = Depends(fba.get_current_user)):
    return user

Now head to http://127.0.0.1:8000/docs to test the API. Note the test route, using fba.get_current_user dependency to restrict resource for authenticated user.

There's a simple command to achive this without writing any code:

uvicorn fastapi_bearer_auth.test:app

Customize

In addition to get_user_by_name(name) and create_user(username, password), there're other functions can be override (with handle_ prefix):

• authenticate(username, password)
• verify_password(plain_password, hashed_password)
• get_password_hash(password)

You can call all those functions with fba.call_config(name, *args, **kwargs).

Also some params:

• ACCESS_TOKEN_EXPIRE_MINUTES
• ALGORITHM
• SECRET_KEY

Use something like fba.set_config({'SECRET_KEY': 'xxx', ...}) to change it.

The default tokenUrl for openapi docs is user/signin, you can override this by setting env var TOKEN_URL.

Events

To get notified before or after user signuped:

@fba.on_event('before_user_signup')
def before_user_signup(request, username, password):
    print('user signed-up')


@fba.on_event('after_user_signup')
def after_user_signup(request, user):
    print('user signed-up')

Complete list of events and their params:

• before_user_signup(request, username, password)
• after_user_signup(request, user)
• before_user_signin(request, username, password)
• after_user_signin(request, user)

To abort the request (stop signup/signin), raise a ValueError in your event handler, like:

@fba.on_event('before_user_signin')
def before_user_signin(request, a, b):
    if request.client.host != '127.0.0.1':
        raise ValueError('restrict!')