mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2026-03-13 07:49:55 +08:00
373157c284
* Add routes for user activation (#403) * Add routes for user activation Generate a token after creating the user in register route, passing to `activation_callback`, if `activation_callback` supplied Create new `/activate` route that will verify the token and activate the user Add new error codes to `fastapi_users/router/common.py` Update documentation Add tests Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Rework routes for user activation * Separate verification logic and token generation into `/fastapi_users/router/verify.py`, with per-route callbacks for custom behaviour * Return register router to original state * Added `is_verified` property to user models * Added `requires_verification` argument to `get_users_router`and `get_auth_router` * Additional dependencies added for verification in `fastapi_users/authentication/__init__.py` * Update tests for new behaviour * Update `README.md` to describe a workaround for possible problems during testing, by exceeding ulimit file descriptor limit Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Restored docs to original state. * All other modifications reqested added Kebab-case on request-verify-token SECRET now used as test string Other minor changes Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Embed token in body in verify route * Reorganize checks in verify route and add unit test * Ignore coverage on Protocol classes * Tweak verify_user function to take full user in parameter * Improve unit tests structure regarding parametrized test client * Make after_verification_request optional to be more consistent with other routers * Tweak status codes on verify routes * Write documentation for verification feature * Add not released warning on verify docs Co-authored-by: Edd Salkield <edd@salkield.uk> Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>
102 lines
2.4 KiB
Python
102 lines
2.4 KiB
Python
import databases
|
|
import sqlalchemy
|
|
from fastapi import FastAPI, Request
|
|
from fastapi_users import FastAPIUsers, models
|
|
from fastapi_users.authentication import JWTAuthentication
|
|
from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase
|
|
from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
|
|
|
|
DATABASE_URL = "sqlite:///./test.db"
|
|
SECRET = "SECRET"
|
|
|
|
|
|
class User(models.BaseUser):
|
|
pass
|
|
|
|
|
|
class UserCreate(models.BaseUserCreate):
|
|
pass
|
|
|
|
|
|
class UserUpdate(User, models.BaseUserUpdate):
|
|
pass
|
|
|
|
|
|
class UserDB(User, models.BaseUserDB):
|
|
pass
|
|
|
|
|
|
database = databases.Database(DATABASE_URL)
|
|
Base: DeclarativeMeta = declarative_base()
|
|
|
|
|
|
class UserTable(Base, SQLAlchemyBaseUserTable):
|
|
pass
|
|
|
|
|
|
engine = sqlalchemy.create_engine(
|
|
DATABASE_URL, connect_args={"check_same_thread": False}
|
|
)
|
|
Base.metadata.create_all(engine)
|
|
|
|
users = UserTable.__table__
|
|
user_db = SQLAlchemyUserDatabase(UserDB, database, users)
|
|
|
|
|
|
def on_after_register(user: UserDB, request: Request):
|
|
print(f"User {user.id} has registered.")
|
|
|
|
|
|
def on_after_forgot_password(user: UserDB, token: str, request: Request):
|
|
print(f"User {user.id} has forgot their password. Reset token: {token}")
|
|
|
|
|
|
def after_verification_request(user: UserDB, token: str, request: Request):
|
|
print(f"Verification requested for user {user.id}. Verification token: {token}")
|
|
|
|
|
|
jwt_authentication = JWTAuthentication(
|
|
secret=SECRET, lifetime_seconds=3600, tokenUrl="/auth/jwt/login"
|
|
)
|
|
|
|
app = FastAPI()
|
|
fastapi_users = FastAPIUsers(
|
|
user_db,
|
|
[jwt_authentication],
|
|
User,
|
|
UserCreate,
|
|
UserUpdate,
|
|
UserDB,
|
|
)
|
|
app.include_router(
|
|
fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
|
|
)
|
|
app.include_router(
|
|
fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
|
|
)
|
|
app.include_router(
|
|
fastapi_users.get_reset_password_router(
|
|
SECRET, after_forgot_password=on_after_forgot_password
|
|
),
|
|
prefix="/auth",
|
|
tags=["auth"],
|
|
)
|
|
app.include_router(
|
|
fastapi_users.get_verify_router(
|
|
SECRET, after_verification_request=after_verification_request
|
|
),
|
|
prefix="/auth",
|
|
tags=["auth"],
|
|
)
|
|
app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])
|
|
|
|
|
|
@app.on_event("startup")
|
|
async def startup():
|
|
await database.connect()
|
|
|
|
|
|
@app.on_event("shutdown")
|
|
async def shutdown():
|
|
await database.disconnect()
|