2022-03-20 03:45:40 +00:00
|
|
|
"""
|
|
|
|
/user endpoints.
|
|
|
|
"""
|
|
|
|
|
2022-03-15 16:19:37 +00:00
|
|
|
from fastapi import APIRouter, Depends, HTTPException, status
|
2022-03-19 04:07:19 +00:00
|
|
|
from fastapi.security import OAuth2PasswordRequestForm
|
2022-03-15 16:19:37 +00:00
|
|
|
from pydantic import BaseModel
|
2022-03-18 23:04:28 +00:00
|
|
|
from sqlalchemy.orm import Session
|
2022-03-15 16:19:37 +00:00
|
|
|
|
2022-03-19 02:22:49 +00:00
|
|
|
from ..config import Config
|
2022-03-20 02:32:40 +00:00
|
|
|
from ..db import Connection
|
|
|
|
from ..db.schemas import User, UserCapability, UserCreate
|
2022-03-23 01:14:02 +00:00
|
|
|
from ._common import Responses, get_current_user, get_current_user_if_admin
|
2022-03-15 16:25:07 +00:00
|
|
|
|
2022-03-18 23:04:28 +00:00
|
|
|
router = APIRouter(prefix="/user")
|
2022-03-15 16:19:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
class Token(BaseModel):
|
2022-03-20 03:45:40 +00:00
|
|
|
"""
|
|
|
|
Response model for issuing tokens.
|
|
|
|
"""
|
|
|
|
|
2022-03-15 16:19:37 +00:00
|
|
|
access_token: str
|
|
|
|
token_type: str
|
|
|
|
|
|
|
|
|
2022-03-20 03:45:40 +00:00
|
|
|
@router.post("/authenticate", response_model=Token)
|
2022-03-18 23:45:09 +00:00
|
|
|
async def login(
|
2022-03-18 23:04:28 +00:00
|
|
|
form_data: OAuth2PasswordRequestForm = Depends(),
|
2022-03-19 04:07:19 +00:00
|
|
|
current_config: Config | None = Depends(Config.load),
|
|
|
|
db: Session | None = Depends(Connection.get),
|
2022-03-19 00:38:57 +00:00
|
|
|
):
|
2022-03-20 03:45:40 +00:00
|
|
|
"""
|
|
|
|
POST ./authenticate: Authenticate a user. Issues a bearer token.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# fail if not installed
|
2022-03-19 04:07:19 +00:00
|
|
|
if current_config is None:
|
|
|
|
raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST)
|
|
|
|
|
2022-03-20 03:45:40 +00:00
|
|
|
# try logging in
|
2022-03-20 04:00:14 +00:00
|
|
|
user = User(name=form_data.username)
|
|
|
|
if not user.authenticate(
|
2022-03-19 00:38:57 +00:00
|
|
|
db=db,
|
|
|
|
password=form_data.password,
|
2022-03-19 04:07:19 +00:00
|
|
|
crypt_context=await current_config.crypto.crypt_context,
|
2022-03-20 04:00:14 +00:00
|
|
|
):
|
|
|
|
# authentication failed
|
2022-03-19 00:38:57 +00:00
|
|
|
raise HTTPException(
|
|
|
|
status_code=status.HTTP_401_UNAUTHORIZED,
|
|
|
|
detail="Could not validate credentials",
|
|
|
|
headers={"WWW-Authenticate": "Bearer"},
|
|
|
|
)
|
|
|
|
|
2022-03-20 03:45:40 +00:00
|
|
|
# authentication succeeded
|
2022-03-19 04:07:19 +00:00
|
|
|
access_token = await current_config.jwt.create_token(user.name)
|
2022-03-19 00:38:57 +00:00
|
|
|
return {"access_token": access_token, "token_type": "bearer"}
|
|
|
|
|
|
|
|
|
2022-03-20 02:32:40 +00:00
|
|
|
@router.get("/current", response_model=User)
|
2022-03-19 00:38:57 +00:00
|
|
|
async def get_current_user(
|
2022-03-20 03:45:40 +00:00
|
|
|
current_user: User | None = Depends(get_current_user),
|
2022-03-19 00:38:57 +00:00
|
|
|
):
|
2022-03-20 03:45:40 +00:00
|
|
|
"""
|
|
|
|
GET ./current: Respond with the currently logged-in user.
|
|
|
|
"""
|
|
|
|
|
2022-03-19 00:38:57 +00:00
|
|
|
return current_user
|
2022-03-19 18:06:28 +00:00
|
|
|
|
|
|
|
|
|
|
|
@router.post(
|
2022-03-23 13:25:00 +00:00
|
|
|
"/",
|
2022-03-19 18:06:28 +00:00
|
|
|
responses={
|
2022-03-20 03:45:40 +00:00
|
|
|
status.HTTP_200_OK: Responses.OK,
|
|
|
|
status.HTTP_400_BAD_REQUEST: Responses.NOT_INSTALLED,
|
|
|
|
status.HTTP_401_UNAUTHORIZED: Responses.NEEDS_USER,
|
|
|
|
status.HTTP_403_FORBIDDEN: Responses.NEEDS_ADMIN,
|
|
|
|
status.HTTP_409_CONFLICT: Responses.ENTRY_EXISTS,
|
2022-03-19 18:06:28 +00:00
|
|
|
},
|
2022-03-20 02:32:40 +00:00
|
|
|
response_model=User,
|
2022-03-19 18:06:28 +00:00
|
|
|
)
|
|
|
|
async def add_user(
|
2022-03-20 02:32:40 +00:00
|
|
|
user: UserCreate,
|
2022-03-19 18:06:28 +00:00
|
|
|
current_config: Config | None = Depends(Config.load),
|
2022-03-23 01:14:02 +00:00
|
|
|
_: User = Depends(get_current_user_if_admin),
|
2022-03-19 18:06:28 +00:00
|
|
|
db: Session | None = Depends(Connection.get),
|
|
|
|
):
|
2022-03-20 03:45:40 +00:00
|
|
|
"""
|
2022-03-23 13:25:00 +00:00
|
|
|
POST ./: Create a new user in the database.
|
2022-03-20 03:45:40 +00:00
|
|
|
"""
|
|
|
|
|
|
|
|
# actually create the new user
|
2022-03-20 02:32:40 +00:00
|
|
|
new_user = User.create(
|
2022-03-19 18:06:28 +00:00
|
|
|
db=db,
|
|
|
|
user=user,
|
|
|
|
crypt_context=await current_config.crypto.crypt_context,
|
|
|
|
)
|
|
|
|
|
2022-03-20 03:45:40 +00:00
|
|
|
# fail if creation was unsuccessful
|
2022-03-19 18:06:28 +00:00
|
|
|
if new_user is None:
|
|
|
|
raise HTTPException(status_code=status.HTTP_409_CONFLICT)
|
|
|
|
|
2022-03-20 03:45:40 +00:00
|
|
|
# return the created user on success
|
2022-03-19 18:06:28 +00:00
|
|
|
return new_user
|
2022-03-23 00:39:19 +00:00
|
|
|
|
|
|
|
|
2022-03-23 13:25:00 +00:00
|
|
|
@router.delete(
|
|
|
|
"/{user_name}",
|
|
|
|
responses={
|
|
|
|
status.HTTP_200_OK: Responses.OK,
|
|
|
|
status.HTTP_400_BAD_REQUEST: Responses.NOT_INSTALLED,
|
|
|
|
status.HTTP_401_UNAUTHORIZED: Responses.NEEDS_USER,
|
|
|
|
status.HTTP_403_FORBIDDEN: Responses.NEEDS_ADMIN,
|
|
|
|
status.HTTP_409_CONFLICT: Responses.ENTRY_DOESNT_EXIST,
|
|
|
|
},
|
|
|
|
response_model=User,
|
|
|
|
)
|
|
|
|
async def remove_user(
|
|
|
|
user_name: str,
|
|
|
|
_: User = Depends(get_current_user_if_admin),
|
|
|
|
db: Session | None = Depends(Connection.get),
|
|
|
|
):
|
|
|
|
"""
|
|
|
|
DELETE ./{user_name}: Remove a user from the database.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# get the user
|
|
|
|
user = User.from_db(
|
|
|
|
db=db,
|
|
|
|
name=user_name,
|
|
|
|
)
|
|
|
|
|
|
|
|
# fail if deletion was unsuccessful
|
|
|
|
if not user.delete():
|
|
|
|
raise HTTPException(status_code=status.HTTP_409_CONFLICT)
|
|
|
|
|
|
|
|
|
2022-03-23 00:39:19 +00:00
|
|
|
@router.post(
|
|
|
|
"/{user_name}/capabilities",
|
|
|
|
responses={
|
|
|
|
status.HTTP_200_OK: Responses.OK,
|
|
|
|
status.HTTP_400_BAD_REQUEST: Responses.NOT_INSTALLED,
|
|
|
|
status.HTTP_401_UNAUTHORIZED: Responses.NEEDS_USER,
|
|
|
|
status.HTTP_403_FORBIDDEN: Responses.NEEDS_ADMIN,
|
|
|
|
},
|
|
|
|
)
|
|
|
|
async def extend_capabilities(
|
|
|
|
user_name: str,
|
|
|
|
capabilities: list[UserCapability],
|
2022-03-23 01:14:02 +00:00
|
|
|
_: User = Depends(get_current_user_if_admin),
|
2022-03-23 00:39:19 +00:00
|
|
|
db: Session | None = Depends(Connection.get),
|
|
|
|
):
|
|
|
|
"""
|
|
|
|
POST ./{user_name}/capabilities: Add capabilities to a user.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# get and change the user
|
|
|
|
user = User.from_db(
|
|
|
|
db=db,
|
|
|
|
name=user_name,
|
|
|
|
)
|
|
|
|
|
|
|
|
user.capabilities.extend(capabilities)
|
|
|
|
user.update(db)
|
|
|
|
|
|
|
|
|
|
|
|
@router.delete(
|
|
|
|
"/{user_name}/capabilities",
|
|
|
|
responses={
|
|
|
|
status.HTTP_200_OK: Responses.OK,
|
|
|
|
status.HTTP_400_BAD_REQUEST: Responses.NOT_INSTALLED,
|
|
|
|
status.HTTP_401_UNAUTHORIZED: Responses.NEEDS_USER,
|
|
|
|
status.HTTP_403_FORBIDDEN: Responses.NEEDS_ADMIN,
|
|
|
|
},
|
|
|
|
)
|
|
|
|
async def remove_capabilities(
|
|
|
|
user_name: str,
|
|
|
|
capabilities: list[UserCapability],
|
2022-03-23 01:14:02 +00:00
|
|
|
_: User = Depends(get_current_user_if_admin),
|
2022-03-23 00:39:19 +00:00
|
|
|
db: Session | None = Depends(Connection.get),
|
|
|
|
):
|
|
|
|
"""
|
2022-03-23 01:14:02 +00:00
|
|
|
DELETE ./{user_name}/capabilities: Remove capabilities from a user.
|
2022-03-23 00:39:19 +00:00
|
|
|
"""
|
|
|
|
|
|
|
|
# get and change the user
|
|
|
|
user = User.from_db(
|
|
|
|
db=db,
|
|
|
|
name=user_name,
|
|
|
|
)
|
|
|
|
|
|
|
|
for capability in capabilities:
|
|
|
|
user.capabilities.remove(capability)
|
|
|
|
|
|
|
|
user.update(db)
|