Skip to content
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
43b3f1b
WIP register - not finished
kobyfogel Jan 19, 2021
d211377
register before updated pull
kobyfogel Jan 22, 2021
2f0501a
register for review
kobyfogel Jan 22, 2021
a5a1a04
register fixed errors
kobyfogel Jan 23, 2021
5d2c52e
register fixed flake-8
kobyfogel Jan 23, 2021
eafbe37
register fixed tests flake8
kobyfogel Jan 23, 2021
56d0ca3
register fixed tests issues
kobyfogel Jan 23, 2021
00d9e7d
register placeholders fix
kobyfogel Jan 23, 2021
c9c777e
register flake8 fix
kobyfogel Jan 23, 2021
bb2b52d
register flake8 more fixes
kobyfogel Jan 23, 2021
a32c9c4
fixed CR suggestions
kobyfogel Jan 24, 2021
deee638
first commit
kobyfogel Jan 24, 2021
7ca40e1
fixed check_jwt_token
kobyfogel Jan 25, 2021
1bdbc54
Not Finshed
kobyfogel Jan 26, 2021
eed52e2
minor fix
kobyfogel Jan 26, 2021
b793e2c
starting dependancy
kobyfogel Jan 31, 2021
46820e1
dependancies working
kobyfogel Feb 1, 2021
68e40fe
redirectin and user messages
kobyfogel Feb 1, 2021
b7e7e60
async fixing
kobyfogel Feb 1, 2021
e3c620a
exception handler
kobyfogel Feb 1, 2021
b6b7441
quary parameters
kobyfogel Feb 2, 2021
d1849bb
Documentation added
kobyfogel Feb 3, 2021
8d7f135
after pull and fixing conflicts
kobyfogel Feb 3, 2021
84db349
fixed pep8
kobyfogel Feb 3, 2021
d9ae477
pep8 more fixes
kobyfogel Feb 3, 2021
d7465b5
pep8 config fix
kobyfogel Feb 3, 2021
9d735b1
pep8 jwt fix
kobyfogel Feb 3, 2021
4f5a127
pep8 jwt final fix
kobyfogel Feb 3, 2021
4392974
pep8 final fix
kobyfogel Feb 3, 2021
b9ee9d3
CR fixes, tests added
kobyfogel Feb 7, 2021
94eb29a
after merge conflicts
kobyfogel Feb 7, 2021
97d8aff
flake8 fixes
kobyfogel Feb 7, 2021
8b54f67
flake8 fixes2
kobyfogel Feb 7, 2021
b46d679
updating requirements
kobyfogel Feb 7, 2021
73f53c1
test added
kobyfogel Feb 7, 2021
c15a451
conflicts fixed
kobyfogel Feb 7, 2021
c3cad9d
flake8 fix
kobyfogel Feb 7, 2021
befd5f9
CR fixing
kobyfogel Feb 9, 2021
063489f
conflicts fixed
kobyfogel Feb 9, 2021
da12351
flake8 fixes
kobyfogel Feb 9, 2021
cc4fdae
flake8 fix2
kobyfogel Feb 9, 2021
0ae794a
flake8 fixes3
kobyfogel Feb 9, 2021
7a47985
flake8 fixes4
kobyfogel Feb 9, 2021
e7bc55a
flake8 fixes5
kobyfogel Feb 9, 2021
8fbe36a
CR fix
kobyfogel Feb 9, 2021
f203c38
Revert "CR fix"
kobyfogel Feb 9, 2021
bbb241b
CR fixes
kobyfogel Feb 10, 2021
b00439d
conflicts fix
kobyfogel Feb 10, 2021
84a6fa7
Merge branch 'develop' of https://github.com/PythonFreeCourse/calenda…
kobyfogel Feb 10, 2021
5f3e3e1
many CR fixes
kobyfogel Feb 11, 2021
5d47833
conflicts fixed
kobyfogel Feb 11, 2021
2488679
CR fixes
kobyfogel Feb 12, 2021
7d5395c
changed dependencies according to CR
kobyfogel Feb 14, 2021
8f59086
fix conflicts
kobyfogel Feb 14, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
DATABASE_CONNECTION_STRING = "sqlite:///calendar.db"
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ dmypy.json
# Pyre type checker
.pyre/


# register stuff
run.txt
# VScode
.vscode/
app/.vscode/
Expand Down
6 changes: 6 additions & 0 deletions app/config.py.example
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ email_conf = ConnectionConfig(
USE_CREDENTIALS=True,
)

# register
DATABASE_CONNECTION_STRING = "sqlite:///calendar.db"

# security
JWT_SECRET_KEY = "c06857128217c661de43d746ecdbe9f1dbc3b3685957fab64512456f639b1881"
JWT_ALGORITHM = "HS256"
templates = Jinja2Templates(directory=os.path.join("app", "templates"))

# application name
Expand Down
87 changes: 87 additions & 0 deletions app/database/schemas.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
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
Empty file.
27 changes: 27 additions & 0 deletions app/internal/security/dependancies.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
from typing import Union
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe some problems in this CR could be resolved with better naming.

We should also rethink a bit about the design: there are some functions that it's hard to tell why they're different one from another.

from starlette.requests import Request
from fastapi import Depends
from starlette.status import HTTP_401_UNAUTHORIZED
from app.internal.security.ouath2 import get_cookie, check_jwt_token, User


async def current_user_required(
request: Request, jwt: str = Depends(get_cookie)) -> Union[User, bool]:
'''A dependency function protecting routes for only logged in user'''
user = await check_jwt_token(jwt, path=request.url.path)
if user:
return user


async def current_user(request: Request) -> Union[User, bool]:
'''
A dependency function.
Returns logged in User object if exists.
None if not.
'''
if 'Authorization' in request.cookies:
jwt = request.cookies['Authorization']
else:
return None
user = await check_jwt_token(jwt, logged_in=True)
return user
108 changes: 108 additions & 0 deletions app/internal/security/ouath2.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
from typing import Union
from passlib.context import CryptContext
from .schema import LoginUser
from app.database.models import User
from fastapi import APIRouter, Depends, HTTPException
from app.dependencies import templates
from app.database.database import SessionLocal
from fastapi.security import OAuth2PasswordBearer
from datetime import datetime, timedelta
import jwt
from starlette.status import HTTP_401_UNAUTHORIZED
from app.config import JWT_ALGORITHM, JWT_SECRET_KEY
from starlette.requests import Request

from starlette.responses import RedirectResponse


JWT_MIN_EXP = 3
pwd_context = CryptContext(schemes=["bcrypt"])
oauth_schema = OAuth2PasswordBearer(tokenUrl="/login")


async def get_db_user_by_username(username: str) -> User:
'''Checking database for user by username field'''
session = SessionLocal()
return session.query(User).filter_by(username = username).first()


def get_hashed_password(password) -> str:
'''Hashing user password'''
return pwd_context.hash(password)


def verify_password(plain_password, hashed_password) -> bool:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add type annotations

'''Verifying password and hashed password are equal'''
try:
return pwd_context.verify(plain_password, hashed_password)
except Exception as e:
return False


async def authenticate_user(user: LoginUser) -> Union[LoginUser, bool]:
'''Verifying user is in database and password is correct'''
db_user = await get_db_user_by_username(username = user.username)
if db_user:
if verify_password(user.hashed_password, db_user.password):
return LoginUser(username=user.username, hashed_password=db_user.password)
return False


def create_jwt_token(user: LoginUser) -> str:
'''Creating jwt-token out of user unique data'''
expiration = datetime.utcnow() + timedelta(minutes=JWT_MIN_EXP )
jwt_payload = {"sub": user.username, "hashed_password": user.hashed_password, "exp": expiration}
jwt_token = jwt.encode(jwt_payload, JWT_SECRET_KEY, algorithm=JWT_ALGORITHM)
return jwt_token


async def check_jwt_token(
token: str = Depends(oauth_schema),
logged_in: bool = False, path: bool = None) -> Union[User, bool]:
'''
Check whether JWT token is correct. Returns User object if yes.
Returns None or raises HTTPException,
depanding which depandency activated this function.
'''
try:
jwt_payload = jwt.decode(token, JWT_SECRET_KEY, algorithms=JWT_ALGORITHM)
jwt_username = jwt_payload.get("sub")
jwt_hashed_password = jwt_payload.get("hashed_password")
jwt_expiration = jwt_payload.get("exp")
db_user = await get_db_user_by_username(username=jwt_username)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You usually don't want to talk with the database when checking the validity of the JWT token - that's one of the benefits of JWT.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validating the token is the lesser reason for that. I can do it by comparing to to the SECRET_KEY, and just by successfully decoding the token.
The main reason for that is: Already using the authentication function to return the User instance to the protected route. This way everybody can use it for other functionalities, without the need to query in each route. The dependency itself, is already returning the User object with all its parameters.
Do you prefer that i will change that?

if db_user and db_user.password == jwt_hashed_password:
return db_user
else:
raise HTTPException(status_code=HTTP_401_UNAUTHORIZED, headers=path, detail="Your token is incorrect. Please log in again")
except Exception as e:
if logged_in:
return None
if type(e).__name__ == 'ExpiredSignatureError':
raise HTTPException(status_code=HTTP_401_UNAUTHORIZED, headers=path, detail="Your token has expired. Please log in again")
if type(e).__name__ == 'DecodeError':
raise HTTPException(status_code=HTTP_401_UNAUTHORIZED, headers=path, detail="Your token is incorrect. Please log in again")


async def get_cookie(request: Request) -> str:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name should be get_authorization_cookie (this function's purpose is not "getting any cookie")

'''
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 my_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

16 changes: 16 additions & 0 deletions app/internal/security/schema.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from typing import List, Optional, Union
from fastapi import Depends, Form, Query
from pydantic import BaseModel, validator



class LoginUser(BaseModel):
'''
Validating fields types
Returns a User object for signing in.
'''
username: str
hashed_password: str

class Config:
orm_mode = True
49 changes: 49 additions & 0 deletions app/internal/user.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
from app.database import models, schemas
from passlib.context import CryptContext
from sqlalchemy.orm import Session
from app.internal.security.ouath2 import pwd_context

# pwd_context = CryptContext(schemes=["bcrypt"])


def get_by_id(db: Session, user_id: int) -> models.User:
'''query database for a user by unique id'''
return db.query(models.User).filter(models.User.id == user_id).first()


def get_by_username(db: Session, username: str) -> models.User:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this function is different from get_db_user_by_username?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can use this one, but i tried to explain above why i did that.

'''query database for a user by unique username'''
return db.query(models.User).filter(
models.User.username == username).first()


def get_by_mail(db: Session, email: str) -> models.User:
'''query database for a user by unique email'''
return db.query(models.User).filter(models.User.email == email).first()


def create(db: Session, user: schemas.UserCreate) -> models.User:
'''
creating a new User object in the database, with hashed password
'''
unhashed_password = user.password.encode('utf-8')
hashed_password = pwd_context.hash(unhashed_password)
user_details = {
'username': user.username,
'full_name': user.full_name,
'email': user.email,
'password': hashed_password,
'description': user.description
}
db_user = models.User(**user_details)
db.add(db_user)
db.commit()
db.refresh(db_user)
return db_user


def delete_by_mail(db: Session, email: str) -> None:
'''deletes a user from database by unique email'''
db_user = get_by_mail(db=db, email=email)
db.delete(db_user)
db.commit()
33 changes: 25 additions & 8 deletions app/main.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
from fastapi import Depends, FastAPI, Request
from fastapi.staticfiles import StaticFiles
from sqlalchemy.orm import Session

from app.config import PSQL_ENVIRONMENT
from app.database import models
from app.database.database import engine, get_db
from app.dependencies import (logger, MEDIA_PATH, STATIC_PATH, templates)
from app.dependencies import (
logger, MEDIA_PATH, STATIC_PATH, templates)
from app.internal.quotes import daily_quotes, load_quotes
from app.internal.security.ouath2 import my_exception_handler
from app.routers import (
agenda, categories, dayview, email, event, invitation, profile, search,
telegram, whatsapp
)
agenda, categories, dayview, email,
event, invitation, login, profile,
register, search, telegram, whatsapp)
from app.telegram.bot import telegram_bot
from fastapi import Depends, FastAPI, Request, Response
from fastapi.staticfiles import StaticFiles
from starlette.status import HTTP_401_UNAUTHORIZED
from sqlalchemy.orm import Session



def create_tables(engine, psql_environment):
Expand All @@ -30,6 +33,18 @@ def create_tables(engine, psql_environment):
app.mount("/static", StaticFiles(directory=STATIC_PATH), name="static")
app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")

app.include_router(profile.router)
app.include_router(event.router)
app.include_router(agenda.router)
app.include_router(register.router)
app.include_router(email.router)
app.include_router(invitation.router)
app.include_router(login.router)




app.add_exception_handler(HTTP_401_UNAUTHORIZED, my_exception_handler)
load_quotes.load_daily_quotes(next(get_db()))

app.logger = logger
Expand All @@ -41,7 +56,9 @@ def create_tables(engine, psql_environment):
email.router,
event.router,
invitation.router,
login.router,
profile.router,
register.router,
search.router,
telegram.router,
whatsapp.router,
Expand Down
Loading