tests two factor

Author: dfm88

docker/Dockerfile

@@ -2,7 +2,7 @@
 # set common builds arguments
 ##############################
 # constants args
-ARG DEFAULT_IMAGE_NAME=fastapi-2fa
+ARG DEFAULT_IMAGE_NAME=fastapi_2fa
 ARG DEFAULT_POETRY_VERSION=1.2.1
 
 ##############################
@@ -76,5 +76,7 @@ WORKDIR /${IMAGE_NAME}
 COPY . ./
 
 RUN chmod +x /${IMAGE_NAME}/scripts/entrypoint.sh
+RUN chmod +x /${IMAGE_NAME}/scripts/start_celery_worker.sh
+RUN chmod +x /${IMAGE_NAME}/scripts/start_celery_flower.sh
 
 ENTRYPOINT ["sh", "scripts/entrypoint.sh"]

docker/docker-compose.yaml

@@ -2,78 +2,94 @@ version: '3.7'
 
 services:
 ## WEB APP
-
+  web:
+    build:
+      context: ..
+      dockerfile: ./docker/Dockerfile
+    image: fastapi_2fa
+    container_name: fastapi_2fa
+    entrypoint: ./scripts/entrypoint.sh
+    # stdin_open: true
+    # tty: true
+    ports:
+      - "5555:5555"
+    env_file:
+      - ../env/.env
+    depends_on:
+      - db
+      - redis
+      - rabbitmq
+      - celery_worker
 
 ## POSTGRESQL
   db:
     image: postgres
-    container_name: fastapi-2fa-db
+    container_name: fastapi_2fa-db
     restart: always
-    volumes:
-      - ./data/pgdata:/var/lib/postgresql/my_data
+    # volumes:
+    #   - ./data/pgdata:/var/lib/postgresql/my_data
     env_file:
       - ../env/.env
-    environment:
-      - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi-2fa-db:5432/postgres
-      - CELERY_BROKER_URL=amqp://admin:admin@fastapi-2fa-rabbitmq:5672/
-      - result_backend=redis://fastapi-2fa-cache:6379/0
-
+    # environment:
+    #   - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi_2fa-db:5432/postgres
+    #   - CELERY_BROKER_URL=amqp://admin:admin@fastapi_2fa-rabbitmq:5672/
+    #   - result_backend=redis://fastapi_2fa-cache:6379/0
     ports:
       - "5454:5432"
 
 ## REDIS
   redis:
     image: redis:alpine
-    container_name: fastapi-2fa-cache
+    container_name: fastapi_2fa-cache
     restart: always
     env_file:
       - ../env/.env
-    environment:
-      - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi-2fa-db:5432/postgres
-      - CELERY_BROKER_URL=amqp://admin:admin@fastapi-2fa-rabbitmq:5672/
-      - result_backend=redis://fastapi-2fa-cache:6379/0
+    # environment:
+    #   - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi_2fa-db:5432/postgres
+    #   - CELERY_BROKER_URL=amqp://admin:admin@fastapi_2fa-rabbitmq:5672/
+    #   - result_backend=redis://fastapi_2fa-cache:6379/0
     ports:
       - "6389:6379"
 
   rabbitmq:
-    container_name: fastapi-2fa-rabbitmq
+    container_name: fastapi_2fa-rabbitmq
     image: rabbitmq:3-management
     env_file:
       - ../env/.env
-    environment:
-      - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi-2fa-db:5432/postgres
-      - CELERY_BROKER_URL=amqp://admin:admin@fastapi-2fa-rabbitmq:5672/
-      - result_backend=redis://fastapi-2fa-cache:6379/0
+    # environment:
+    #   - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi_2fa-db:5432/postgres
+    #   - CELERY_BROKER_URL=amqp://admin:admin@fastapi_2fa-rabbitmq:5672/
+    #   - result_backend=redis://fastapi_2fa-cache:6379/0
     ports:
       - "5672:5672"
 
   celery_worker:
-    container_name: fastapi-2fa-celery
+    container_name: fastapi_2fa-celery
     build:
       context: ..
       dockerfile: ./docker/Dockerfile
     image: fastapi_2fa_celery_worker
-    entrypoint: /scripts/start_celery_worker.sh
+    entrypoint: ./scripts/start_celery_worker.sh
     env_file:
       - ../env/.env
-    environment:
-      - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi-2fa-db:5432/postgres
-      - CELERY_BROKER_URL=amqp://admin:admin@fastapi-2fa-rabbitmq:5672/
-      - result_backend=redis://fastapi-2fa-cache:6379/0
+    # environment:
+    #   - SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi_2fa-db:5432/postgres
+    #   - CELERY_BROKER_URL=amqp://admin:admin@fastapi_2fa-rabbitmq:5672/
+    #   - result_backend=redis://fastapi_2fa-cache:6379/0
     depends_on:
         - redis
         - db
         - rabbitmq
 
   flower:
-    container_name: fastapi-2fa-flower
+    container_name: fastapi_2fa-flower
     build:
       context: ..
       dockerfile: ./docker/Dockerfile
     image: fastapi_2fa_celery_flower
-    entrypoint: /scripts/start_celery_flower.sh
-    volumes:
-        - flower_db:/app/flower_db
+    entrypoint: ./scripts/start_celery_flower.sh
+    # volumes:
+    #     - flower_db:/app/flower_db
     env_file:
       - ../env/.env
     ports:
@@ -84,6 +100,6 @@ services:
         - rabbitmq
         - celery_worker
 
-volumes:
-   pgdata:
-   flower_db:
+# volumes:
+#    pgdata:
+#    flower_db:

docs/two_factor_flowchart.drawio.png

@@ -1,15 +1,16 @@
 FASTAPI_CONFIG=development
 FAKE_EMAIL_SENDER=[email protected]
 API_V1_STR=/api/v1
-PROJECT_NAME=fastapi-2fa
+PROJECT_NAME=fastapi_2fa
 
 # # JWT
 JWT_SECRET_KEY=9d58ca3446806034a68b02cbcdf69d8f
 JWT_SECRET_KEY_REFRESH=mXuqbFTs2kTmz+6rBpJh1B4T+zHQh8Nq1nc7BOrWTb4=
 PRE_TFA_SECRET_KEY=11rWUgZLTckPHI7KO1SPbFgG1OILrDQjI7v9Q7KgYZw=
 ALGORITHM=HS256
 ACCESS_TOKEN_EXPIRE_MINUTES=30
-REFRESH_TOKEN_EXPIRE_MINUTES=1440  # 24 h
+# 24 h
+REFRESH_TOKEN_EXPIRE_MINUTES=1440
 
 # # 2 FACTOR AUTHENTICATION
 FERNET_KEY_TFA_TOKEN=J_TYpprFmoLlVM0MNZElt8IwEkvEEhAwCmb8P_f7Fro=
@@ -28,18 +29,29 @@ BACKEND_CORS_ORIGINS=http://localhost:5555
 # # DB
 POSTGRES_USER=admin
 POSTGRES_PASSWORD=admin
-POSTGRES_HOST=localhost
+# local dev
+# POSTGRES_HOST=localhost
+# container
+POSTGRES_HOST=fastapi_2fa-db
 POSTGRES_PORT=5432
 POSTGRES_DB=postgres
-SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@localhost:5454/postgres
+# local dev
+# SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@localhost:5454/postgres
+# container
+SQLALCHEMY_DATABASE_URI=postgresql+asyncpg://admin:admin@fastapi_2fa-db:5432/postgres
 
 # # RABBIT MQ
 RABBITMQ_DEFAULT_USER=admin
 RABBITMQ_DEFAULT_PASS=admin
 
 # # CELERY
-CELERY_BROKER_URL=amqp://admin:admin@localhost:5672/
-result_backend=redis://localhost:6389/0
+# local dev
+# CELERY_BROKER_URL=amqp://admin:admin@localhost:5672/  # local dev
+# container
+CELERY_BROKER_URL=amqp://admin:admin@fastapi_2fa-rabbitmq:5672/
+# result_backend=redis://localhost:6389/0  # local dev
+# container
+result_backend=redis://fastapi_2fa-cache:6379/0
 
 # # FLOWER
 CELERY_FLOWER_USER=admin

env/.env

@@ -71,8 +71,8 @@ def assemble_db_connection(cls, v: Optional[str], values: Dict[str, Any]) -> Any
     # Celery ACK the queue only when task is completed
     CELERY_TASK_ACKS_LATE = True
     imports = ("fastapi_2fa.tasks.tasks",)
-    task_serializer = "pickle"
-    accept_content = ('pickle', 'json',)
+    task_serializer = 'json'
+    accept_content = ('json',)
 
     class Config:
         case_sensitive = True
@@ -115,5 +115,7 @@ def get_settings():
     config_cls = config_cls_dict[config_name]
     return config_cls()
 
+print(os.environ)
 
 settings = get_settings()
+

fastapi_2fa/core/config.py

@@ -10,10 +10,27 @@
 
 
 def get_password_hash(password: str) -> str:
+    """Returns the hashed version of a string
+
+    Args:
+        password (str)
+
+    Returns:
+        str: hashed psw
+    """
     return pwd_context.hash(password)
 
 
 def verify_password(password: str, hashed_password: str) -> bool:
+    """Check password hash with given hashed value
+
+    Args:
+        password (str): raw password
+        hashed_password (str): hashed version of raw password
+
+    Returns:
+        bool: True if passwords match hashed password
+    """
     return pwd_context.verify(password, hashed_password)
 
 
@@ -22,6 +39,16 @@ def _create_token(
     expire_minutes: int,
     key: str,
 ) -> str:
+    """Create a JWT token
+
+    Args:
+        subject (int | Any)
+        expire_minutes (int)
+        key (str): key to do the encoding/decoding
+
+    Returns:
+        str: encoded jwt
+    """
     expires_delta = datetime.utcnow() + timedelta(minutes=expire_minutes)
     to_encode = {
         "sub": str(subject),