feat: login and registration (#195)

Author: kobyfogel

.gitignore

@@ -145,6 +145,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+
+# register stuff
+run.txt
 # VScode
 .vscode/
 app/.vscode/

README.md

@@ -35,6 +35,8 @@ virtualenv env
 pip install -r requirements.txt
 # Copy app\config.py.example to app\config.py.
 # Edit the variables' values.
+# Rendering JWT_KEY:
+python -c "import secrets; from pathlib import Path; f = Path('app/config.py'); f.write_text(f.read_text().replace('JWT_KEY_PLACEHOLDER', secrets.token_hex(32), 1));"
 uvicorn app.main:app --reload
 ```
 
@@ -45,12 +47,8 @@ source venv/bin/activate
 pip install -r requirements.txt
 cp app/config.py.example app/config.py
 # Edit the variables' values.
-uvicorn app.main:app --reload
-```
-### Running tests
-```shell
-python -m pytest --cov-report term-missing --cov=app tests
-```
+# Rendering JWT_KEY:
+python -c "import secrets; from pathlib import Path; f = Path('app/config.py'); f.write_text(f.read_text().replace('JWT_KEY_PLACEHOLDER', secrets.token_hex(32), 1));"
 
 ## Contributing
 View [contributing guidelines](https://github.com/PythonFreeCourse/calendar/blob/master/CONTRIBUTING.md).

app/config.py.example

@@ -52,6 +52,11 @@ email_conf = ConnectionConfig(
     USE_CREDENTIALS=True,
 )
 
+
+# security
+JWT_KEY = "JWT_KEY_PLACEHOLDER"
+JWT_ALGORITHM = "HS256"
+JWT_MIN_EXP = 60 * 24 * 7
 templates = Jinja2Templates(directory=os.path.join("app", "templates"))
 
 # application name

app/database/models.py

@@ -31,6 +31,7 @@ class User(Base):
     avatar = Column(String, default="profile.png")
     telegram_id = Column(String, unique=True)
     is_active = Column(Boolean, default=False)
+    is_manager = Column(Boolean, default=False)
     language_id = Column(Integer, ForeignKey("languages.id"))
 
     owned_events = relationship(
@@ -47,6 +48,12 @@ class User(Base):
     def __repr__(self):
         return f'<User {self.id}>'
 
+    @staticmethod
+    async def get_by_username(db: Session, username: str) -> User:
+        """query database for a user by unique username"""
+        return db.query(User).filter(
+            User.username == username).first()
+
 
 class Event(Base):
     __tablename__ = "events"

app/database/schemas.py

@@ -0,0 +1,90 @@
+from typing import Optional, Union
+from pydantic import BaseModel, validator, EmailStr, EmailError
+
+
+EMPTY_FIELD_STRING = 'field is required'
+MIN_FIELD_LENGTH = 3
+MAX_FIELD_LENGTH = 20
+
+
+def fields_not_empty(field: Optional[str]) -> Union[ValueError, str]:
+    """Global function to validate fields are not empty."""
+    if not field:
+        raise ValueError(EMPTY_FIELD_STRING)
+    return field
+
+
+class UserBase(BaseModel):
+    """
+    Validating fields types
+    Returns a User object without sensitive information
+    """
+    username: str
+    email: str
+    full_name: str
+    description: Optional[str] = None
+
+    class Config:
+        orm_mode = True
+
+
+class UserCreate(UserBase):
+    """Validating fields types"""
+    password: str
+    confirm_password: str
+
+    """
+    Calling to field_not_empty validaion function,
+    for each required field.
+    """
+    _fields_not_empty_username = validator(
+        'username', allow_reuse=True)(fields_not_empty)
+    _fields_not_empty_full_name = validator(
+        'full_name', allow_reuse=True)(fields_not_empty)
+    _fields_not_empty_password = validator(
+        'password', allow_reuse=True)(fields_not_empty)
+    _fields_not_empty_confirm_password = validator(
+        'confirm_password', allow_reuse=True)(fields_not_empty)
+    _fields_not_empty_email = validator(
+        'email', allow_reuse=True)(fields_not_empty)
+
+    @validator('confirm_password')
+    def passwords_match(
+            cls, confirm_password: str,
+            values: UserBase) -> Union[ValueError, str]:
+        """Validating passwords fields identical."""
+        if 'password' in values and confirm_password != values['password']:
+            raise ValueError("doesn't match to password")
+        return confirm_password
+
+    @validator('username')
+    def username_length(cls, username: str) -> Union[ValueError, str]:
+        """Validating username length is legal"""
+        if not (MIN_FIELD_LENGTH < len(username) < MAX_FIELD_LENGTH):
+            raise ValueError("must contain between 3 to 20 charactars")
+        return username
+
+    @validator('password')
+    def password_length(cls, password: str) -> Union[ValueError, str]:
+        """Validating username length is legal"""
+        if not (MIN_FIELD_LENGTH < len(password) < MAX_FIELD_LENGTH):
+            raise ValueError("must contain between 3 to 20 charactars")
+        return password
+
+    @validator('email')
+    def confirm_mail(cls, email: str) -> Union[ValueError, str]:
+        """Validating email is valid mail address."""
+        try:
+            EmailStr.validate(email)
+            return email
+        except EmailError:
+            raise ValueError("address is not valid")
+
+
+class User(UserBase):
+    """
+    Validating fields types
+    Returns a User object without sensitive information
+    """
+    id: int
+    is_active: bool

app/internal/security/__init__.py

@@ -0,0 +1,25 @@
+from starlette.requests import Request
+
+from app.dependencies import get_db
+from app.internal.security.ouath2 import (
+    Depends, Session, check_jwt_token, get_authorization_cookie)
+
+
+async def is_logged_in(
+    request: Request, db: Session = Depends(get_db),
+        jwt: str = Depends(get_authorization_cookie)) -> bool:
+    """
+    A dependency function protecting routes for only logged in user
+    """
+    await check_jwt_token(db, jwt)
+    return True
+
+
+async def is_manager(
+    request: Request, db: Session = Depends(get_db),
+        jwt: str = Depends(get_authorization_cookie)) -> bool:
+    """
+    A dependency function protecting routes for only logged in manager
+    """
+    await check_jwt_token(db, jwt, manager=True)
+    return True

app/internal/security/dependancies.py

@@ -0,0 +1,122 @@
+from datetime import datetime, timedelta
+from typing import Union
+
+from passlib.context import CryptContext
+from fastapi import Depends, HTTPException
+from fastapi.security import OAuth2PasswordBearer
+import jwt
+from jwt.exceptions import InvalidSignatureError
+from sqlalchemy.orm import Session
+from starlette.requests import Request
+from starlette.responses import RedirectResponse
+from starlette.status import HTTP_401_UNAUTHORIZED
+from . import schema
+
+from app.config import JWT_ALGORITHM, JWT_KEY, JWT_MIN_EXP
+from app.database.models import User
+
+
+pwd_context = CryptContext(schemes=["bcrypt"])
+oauth_schema = OAuth2PasswordBearer(tokenUrl="/login")
+
+
+def get_hashed_password(password: str) -> str:
+    """Hashing user password"""
+    return pwd_context.hash(password)
+
+
+def verify_password(plain_password: str, hashed_password: str) -> bool:
+    """Verifying password and hashed password are equal"""
+    return pwd_context.verify(plain_password, hashed_password)
+
+
+async def authenticate_user(
+    db: Session, new_user: schema.LoginUser,
+) -> Union[schema.LoginUser, bool]:
+    """Verifying user is in database and password is correct"""
+    db_user = await User.get_by_username(db=db, username=new_user.username)
+    if db_user and verify_password(new_user.password, db_user.password):
+        return schema.LoginUser(
+            user_id=db_user.id, is_manager=db_user.is_manager,
+            username=new_user.username, password=db_user.password)
+    return False
+
+
+def create_jwt_token(
+        user: schema.LoginUser, jwt_min_exp: int = JWT_MIN_EXP,
+        jwt_key: str = JWT_KEY) -> str:
+    """Creating jwt-token out of user unique data"""
+    expiration = datetime.utcnow() + timedelta(minutes=jwt_min_exp)
+    jwt_payload = {
+        "sub": user.username,
+        "user_id": user.user_id,
+        "is_manager": user.is_manager,
+        "exp": expiration}
+    jwt_token = jwt.encode(
+        jwt_payload, jwt_key, algorithm=JWT_ALGORITHM)
+    return jwt_token
+
+
+async def check_jwt_token(
+    db: Session,
+        token: str = Depends(oauth_schema), path: bool = None,
+        manager: bool = False) -> User:
+    """
+    Check whether JWT token is correct.
+    Returns jwt payloads if correct.
+    Raises HTTPException if fails to decode.
+    """
+    try:
+        jwt_payload = jwt.decode(
+            token, JWT_KEY, algorithms=JWT_ALGORITHM)
+        if not manager:
+            return True
+        if jwt_payload.get("is_manager"):
+            return True
+        raise HTTPException(
+                status_code=HTTP_401_UNAUTHORIZED,
+                headers=path,
+                detail="You don't have a permition to enter this page")
+    except InvalidSignatureError:
+        raise HTTPException(
+                status_code=HTTP_401_UNAUTHORIZED,
+                headers=path,
+                detail="Your token is incorrect. Please log in again")
+    except jwt.ExpiredSignatureError:
+        raise HTTPException(
+            status_code=HTTP_401_UNAUTHORIZED,
+            headers=path,
+            detail="Your token has expired. Please log in again")
+    except jwt.DecodeError:
+        raise HTTPException(
+            status_code=HTTP_401_UNAUTHORIZED,
+            headers=path,
+            detail="Your token is incorrect. Please log in again")
+
+
+async def get_authorization_cookie(request: Request) -> str:
+    """
+    Extracts jwt from HTTPONLY cookie, if exists.
+    Raises HTTPException if not.
+    """
+    if 'Authorization' in request.cookies:
+        return request.cookies['Authorization']
+    raise HTTPException(
+        status_code=HTTP_401_UNAUTHORIZED,
+        headers=request.url.path,
+        detail="Please log in to enter this page")
+
+
+async def auth_exception_handler(
+        request: Request,
+        exc: HTTP_401_UNAUTHORIZED) -> RedirectResponse:
+    """
+    Whenever HTTP_401_UNAUTHORIZED is raised,
+    redirecting to login route, with original requested url,
+    and details for why original request failed.
+    """
+    paramas = f"?next={exc.headers}&message={exc.detail}"
+    url = f"/login{paramas}"
+    response = RedirectResponse(url=url)
+    response.delete_cookie('Authorization')
+    return response

app/internal/security/ouath2.py

@@ -0,0 +1,17 @@
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class LoginUser(BaseModel):
+    """
+    Validating fields types
+    Returns a User object for signing in.
+    """
+    user_id: Optional[int]
+    is_manager: Optional[bool]
+    username: str
+    password: str
+
+    class Config:
+        orm_mode = True

app/internal/security/schema.py

@@ -1,14 +1,15 @@
-from fastapi import Depends, FastAPI, Request
-from fastapi.staticfiles import StaticFiles
-from sqlalchemy.orm import Session
-
 from app import config
 from app.database import engine, models
 from app.dependencies import get_db, logger, MEDIA_PATH, STATIC_PATH, templates
 from app.internal import daily_quotes, json_data_loader
 
 from app.internal.languages import set_ui_language
+from app.internal.security.ouath2 import auth_exception_handler
 from app.routers.salary import routes as salary
+from fastapi import Depends, FastAPI, Request
+from fastapi.staticfiles import StaticFiles
+from starlette.status import HTTP_401_UNAUTHORIZED
+from sqlalchemy.orm import Session
 
 
 def create_tables(engine, psql_environment):
@@ -29,6 +30,7 @@ def create_tables(engine, psql_environment):
 app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")
 app.logger = logger
 
+app.add_exception_handler(HTTP_401_UNAUTHORIZED, auth_exception_handler)
 
 json_data_loader.load_to_db(next(get_db()))
 # This MUST come before the app.routers imports.
@@ -38,8 +40,8 @@ def create_tables(engine, psql_environment):
 from app.routers import (  # noqa: E402
 
     agenda, calendar, categories, celebrity, currency, dayview,
-    email, event, export, four_o_four, invitation, profile, search,
-    weekview, telegram, whatsapp,
+    email, event, export, four_o_four, invitation, login, logout, profile,
+    register, search, telegram, weekview, whatsapp,
 )
 
 json_data_loader.load_to_db(next(get_db()))
@@ -57,7 +59,10 @@ def create_tables(engine, psql_environment):
     export.router,
     four_o_four.router,
     invitation.router,
+    login.router,
+    logout.router,
     profile.router,
+    register.router,
     salary.router,
     search.router,
     telegram.router,