Merge pull request #13 from ArielMAJ/feat/#10/add-authentication

feat(#10): add authentication process

Author: ArielMAJ

.env.example

@@ -11,3 +11,7 @@ POSTGRES_PORT=5432
 
 POSTGRES_ECHO=true
 DATABASE_ENABLE_CONNECTION_POOLING=true
+
+SECRET_KEY=
+ALGORITHM=
+ACCESS_TOKEN_EXPIRE_MINUTES=

api/config.py

@@ -58,6 +58,12 @@ class DatabaseConfig:
     }
 
 
+class AuthConfig:
+    SECRET_KEY: str = os.getenv("SECRET_KEY")
+    ALGORITHM: str = os.getenv("ALGORITHM")
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = int(os.getenv("ACCESS_TOKEN_EXPIRE_MINUTES"))
+
+
 class Config:
     """Base configuration."""
 
@@ -74,6 +80,7 @@ class Config:
     APPLICATION_ROOT = os.getenv("APPLICATION_ROOT", "")
 
     DATABASE: DatabaseConfig = DatabaseConfig()
+    AUTH: AuthConfig = AuthConfig()
 
 
 class TestConfig(Config):

api/database/models/users.py

@@ -1,6 +1,9 @@
+from typing import Union
+
 from api.database.models.model_base import ModelBase
 from sqlalchemy import String
 from sqlalchemy.orm import Mapped, mapped_column
+from typing_extensions import Self
 
 
 class User(ModelBase):
@@ -13,3 +16,7 @@ class User(ModelBase):
         String(255), nullable=False, unique=False, index=True
     )
     password: Mapped[str] = mapped_column(String(255), nullable=False, index=True)
+
+    @classmethod
+    async def get_by_email(cls, email: str) -> Union[Self, None]:
+        return await cls.get(cls.email == email)

api/entrypoints/auth.py

@@ -0,0 +1,25 @@
+from typing import Annotated, Union
+
+from api.database.models.users import User
+from api.exceptions.http_exceptions import CredentialsException
+from api.schemas.auth import Token
+from api.services.auth import AuthService
+from fastapi import APIRouter, Depends
+from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
+
+router = APIRouter()
+
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/token")
+
+
+@router.post("/token", response_model=Token)
+async def login_for_access_token(
+    form_data: Annotated[OAuth2PasswordRequestForm, Depends()],
+) -> Token:
+    user: Union[User, None] = await AuthService.authenticate_user(
+        form_data.username, form_data.password
+    )
+    if not user:
+        raise CredentialsException()
+    access_token, expires_at = AuthService.create_access_token(data={"sub": user.email})
+    return Token(access_token=access_token, token_type="bearer", expires_at=expires_at)

api/entrypoints/router.py

@@ -1,10 +1,13 @@
-from api.entrypoints import monitoring, random_response, root_response, user
+from api.entrypoints import auth, monitoring, random_response, root_response, user
 from fastapi.routing import APIRouter
 
+user.router.include_router(user.authenticated_router)
+
 router = APIRouter()
 router.include_router(monitoring.router, tags=["Monitoring"])
 router.include_router(
     random_response.router, prefix="/random_number", tags=["Random Number"]
 )
 router.include_router(root_response.router, prefix="", tags=["Root Response"])
 router.include_router(user.router, prefix="/user", tags=["User"])
+router.include_router(auth.router, prefix="/auth", tags=["Auth"])

api/entrypoints/user.py

@@ -1,13 +1,18 @@
-from typing import List
+from typing import Annotated, List
 
+from api.database.models.users import User
 from api.schemas.user import UserCreate, UserOut
+from api.services.auth import AuthService
 from api.services.user_service import UserService
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
 
 router = APIRouter()
+authenticated_router = APIRouter(
+    dependencies=[Depends(AuthService.get_current_active_user)]
+)
 
 
-@router.get("/", response_model=List[UserOut])
+@authenticated_router.get("/", response_model=List[UserOut])
 async def get_users() -> List[UserOut]:
     """
     Retrieve a list of all users.
@@ -18,7 +23,17 @@ async def get_users() -> List[UserOut]:
     return await UserService().get_all()
 
 
-@router.get("/{user_id}", response_model=UserOut)
+@router.get("/me", response_model=UserOut)
+async def read_user_me(
+    current_user: Annotated[User, Depends(AuthService.get_current_active_user)]
+):
+    """
+    Retrieve the currently authenticated user by Bearer token.
+    """
+    return current_user
+
+
+@authenticated_router.get("/{user_id}", response_model=UserOut)
 async def get_user(user_id: int) -> UserOut:
     """
     Retrieve a user by ID.
@@ -46,7 +61,7 @@ async def create_user(user: UserCreate):
     return await UserService().create_user(user)
 
 
-@router.put("/{user_id}", response_model=None)
+@authenticated_router.put("/{user_id}", response_model=None)
 async def update_user(user_id: int, user: UserCreate) -> None:
     """
     Update a user by ID.
@@ -61,7 +76,7 @@ async def update_user(user_id: int, user: UserCreate) -> None:
     return await UserService().update_user(user_id, user)
 
 
-@router.delete("/{user_id}", response_model=None)
+@authenticated_router.delete("/{user_id}", response_model=None)
 async def delete_user(user_id: int) -> None:
     """
     Delete a user by ID.

api/exceptions/http_exceptions.py

@@ -8,3 +8,12 @@ def __init__(self, model: ModelBase):
             status_code=status.HTTP_404_NOT_FOUND,
             detail=f"{model.__name__} not found",
         )
+
+
+class CredentialsException(HTTPException):
+    def __init__(self):
+        super().__init__(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Could not validate credentials",
+            headers={"WWW-Authenticate": "Bearer"},
+        )

api/schemas/auth.py

@@ -0,0 +1,18 @@
+from datetime import datetime
+from typing import Union
+
+from pydantic import BaseModel, field_serializer
+
+
+class Token(BaseModel):
+    access_token: str
+    token_type: str
+    expires_at: datetime
+
+    @field_serializer("expires_at")
+    def serialize_expires_at(self, value: datetime):
+        return value.strftime("%d-%m-%Y %H:%M:%S")
+
+
+class TokenData(BaseModel):
+    email: Union[str, None] = None

api/schemas/base_db_schema.py

@@ -11,7 +11,7 @@ class BaseDBSchema(BaseModel):
     deleted_at: Optional[datetime]
 
     class Config:
-        orm_mode = True
+        from_attributes = True
 
     @field_serializer("created_at", "updated_at", "deleted_at")
     def serialize_dt(self, dt: Optional[datetime]):

api/schemas/user.py

@@ -1,13 +1,22 @@
 from api.schemas.base_db_schema import BaseDBSchema
-from pydantic import BaseModel
+from api.services.auth import AuthService
+from pydantic import BaseModel, field_serializer
 
 
 class UserCreate(BaseModel):
     name: str
     email: str
     password: str
 
+    @field_serializer("password")
+    def hash_password(self, password: str) -> str:
+        return AuthService.get_password_hash(password)
+
 
 class UserOut(BaseDBSchema):
     name: str
     email: str
+
+
+class UserInDB(UserOut):
+    hashed_password: str