mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-14 18:58:10 +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>
101 lines
2.5 KiB
Python
101 lines
2.5 KiB
Python
from typing import Awaitable, Type
|
|
|
|
try:
|
|
from typing import Protocol
|
|
except ImportError:
|
|
from typing_extensions import Protocol # type: ignore
|
|
|
|
from pydantic import EmailStr
|
|
|
|
from fastapi_users import models
|
|
from fastapi_users.db import BaseUserDatabase
|
|
from fastapi_users.password import get_password_hash
|
|
|
|
|
|
class UserAlreadyExists(Exception):
|
|
pass
|
|
|
|
|
|
class UserNotExists(Exception):
|
|
pass
|
|
|
|
|
|
class UserAlreadyVerified(Exception):
|
|
pass
|
|
|
|
|
|
class CreateUserProtocol(Protocol): # pragma: no cover
|
|
def __call__(
|
|
self,
|
|
user: models.BaseUserCreate,
|
|
safe: bool = False,
|
|
is_active: bool = None,
|
|
is_verified: bool = None,
|
|
) -> Awaitable[models.BaseUserDB]:
|
|
pass
|
|
|
|
|
|
def get_create_user(
|
|
user_db: BaseUserDatabase[models.BaseUserDB],
|
|
user_db_model: Type[models.BaseUserDB],
|
|
) -> CreateUserProtocol:
|
|
async def create_user(
|
|
user: models.BaseUserCreate,
|
|
safe: bool = False,
|
|
is_active: bool = None,
|
|
is_verified: bool = None,
|
|
) -> models.BaseUserDB:
|
|
existing_user = await user_db.get_by_email(user.email)
|
|
|
|
if existing_user is not None:
|
|
raise UserAlreadyExists()
|
|
|
|
hashed_password = get_password_hash(user.password)
|
|
user_dict = (
|
|
user.create_update_dict() if safe else user.create_update_dict_superuser()
|
|
)
|
|
db_user = user_db_model(**user_dict, hashed_password=hashed_password)
|
|
return await user_db.create(db_user)
|
|
|
|
return create_user
|
|
|
|
|
|
class VerifyUserProtocol(Protocol): # pragma: no cover
|
|
def __call__(self, user: models.BaseUserDB) -> Awaitable[models.BaseUserDB]:
|
|
pass
|
|
|
|
|
|
def get_verify_user(
|
|
user_db: BaseUserDatabase[models.BaseUserDB],
|
|
) -> VerifyUserProtocol:
|
|
async def verify_user(user: models.BaseUserDB) -> models.BaseUserDB:
|
|
if user.is_verified:
|
|
raise UserAlreadyVerified()
|
|
|
|
user.is_verified = True
|
|
return await user_db.update(user)
|
|
|
|
return verify_user
|
|
|
|
|
|
class GetUserProtocol(Protocol): # pragma: no cover
|
|
def __call__(self, user_email: EmailStr) -> Awaitable[models.BaseUserDB]:
|
|
pass
|
|
|
|
|
|
def get_get_user(
|
|
user_db: BaseUserDatabase[models.BaseUserDB],
|
|
) -> GetUserProtocol:
|
|
async def get_user(user_email: EmailStr) -> models.BaseUserDB:
|
|
if not (user_email == EmailStr(user_email)):
|
|
raise UserNotExists()
|
|
|
|
user = await user_db.get_by_email(user_email)
|
|
|
|
if user is None:
|
|
raise UserNotExists()
|
|
|
|
return user
|
|
|
|
return get_user
|