A simple FastAPI auth module with signup/signin routes
Project description
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
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fastapi_bearer_auth-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5603cc8c97a740fdc3a2059731f5e935a0960cdfa6d303acbcfcc54a5ff0fa7 |
|
MD5 | e7c4e81859f12cd4cdb9d336a372cb6b |
|
BLAKE2b-256 | 7e47b7b7937ac37362dcfb5e74833bf315e64fd3dfd8068a058d4e9a3b6cc535 |
Hashes for fastapi_bearer_auth-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 073e511eab62d1edd190803f80653c0b0b50eaf56d13ed0a72d0ae40ecbef514 |
|
MD5 | a650564d0618158770611073a88a9b30 |
|
BLAKE2b-256 | 432d0885186d8bf01ffe3d81e30e896ec96bae28092efb5b8ef4f2170da3626e |