User authentication with tests.

gns3server/api/routes/controller/dependencies/authentication.py

@@ -23,12 +23,15 @@ from gns3server import schemas
 from gns3server.db.repositories.users import UsersRepository
 from gns3server.services import auth_service
 
+from .database import get_repository
 
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/v3/users/login")  # FIXME: URL prefix
 
 
-async def get_user_from_token(token: str = Depends(oauth2_scheme),
-                              user_repo: UsersRepository = Depends()) -> schemas.User:
+async def get_user_from_token(
+        token: str = Depends(oauth2_scheme),
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
 
     username = auth_service.get_username_from_token(token)
     user = await user_repo.get_user_by_username(username)

gns3server/api/routes/controller/dependencies/database.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+# -*- coding: utf-8 -*-
 #
 # Copyright (C) 2020 GNS3 Technologies Inc.
 #
@@ -15,12 +15,24 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import os
+from typing import Callable, Type
+from fastapi import Depends, Request
+from sqlalchemy.ext.asyncio import AsyncSession
 
-from sqlalchemy.ext.asyncio import create_async_engine
-from sqlalchemy.orm import declarative_base
+from gns3server.db.repositories.base import BaseRepository
 
-SQLALCHEMY_DATABASE_URL = os.environ.get("DATABASE_URI", "sqlite:///./sql_app.db")
 
-engine = create_async_engine(SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False})
-Base = declarative_base()
+async def get_db_session(request: Request) -> AsyncSession:
+
+    session = AsyncSession(request.app.state._db_engine)
+    try:
+        yield session
+    finally:
+        await session.close()
+
+
+def get_repository(repo: Type[BaseRepository]) -> Callable:
+
+    def get_repo(db_session: AsyncSession = Depends(get_db_session)) -> Type[BaseRepository]:
+        return repo(db_session)
+    return get_repo

gns3server/api/routes/controller/users.py

@@ -20,7 +20,7 @@ API routes for users.
 """
 
 from fastapi import APIRouter, Depends, HTTPException, status
-from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
+from fastapi.security import OAuth2PasswordRequestForm
 from uuid import UUID
 from typing import List
 
@@ -30,6 +30,7 @@ from gns3server.db.repositories.users import UsersRepository
 from gns3server.services import auth_service
 
 from .dependencies.authentication import get_current_active_user
+from .dependencies.database import get_repository
 
 import logging
 log = logging.getLogger(__name__)
@@ -38,7 +39,7 @@ router = APIRouter()
 
 
 @router.get("", response_model=List[schemas.User])
-async def get_users(user_repo: UsersRepository = Depends()) -> List[schemas.User]:
+async def get_users(user_repo: UsersRepository = Depends(get_repository(UsersRepository))) -> List[schemas.User]:
     """
     Get all users.
     """
@@ -48,7 +49,10 @@ async def get_users(user_repo: UsersRepository = Depends()) -> List[schemas.User
 
 
 @router.post("", response_model=schemas.User, status_code=status.HTTP_201_CREATED)
-async def create_user(new_user: schemas.UserCreate, user_repo: UsersRepository = Depends()) -> schemas.User:
+async def create_user(
+        new_user: schemas.UserCreate,
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
     """
     Create a new user.
     """
@@ -63,7 +67,10 @@ async def create_user(new_user: schemas.UserCreate, user_repo: UsersRepository =
 
 
 @router.get("/{user_id}", response_model=schemas.User)
-async def get_user(user_id: UUID, user_repo: UsersRepository = Depends()) -> schemas.User:
+async def get_user(
+        user_id: UUID,
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
     """
     Get an user.
     """
@@ -75,9 +82,11 @@ async def get_user(user_id: UUID, user_repo: UsersRepository = Depends()) -> sch
 
 
 @router.put("/{user_id}", response_model=schemas.User)
-async def update_user(user_id: UUID,
-                      update_user: schemas.UserUpdate,
-                      user_repo: UsersRepository = Depends()) -> schemas.User:
+async def update_user(
+        user_id: UUID,
+        update_user: schemas.UserUpdate,
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository))
+) -> schemas.User:
     """
     Update an user.
     """
@@ -89,7 +98,7 @@ async def update_user(user_id: UUID,
 
 
 @router.delete("/{user_id}", status_code=status.HTTP_204_NO_CONTENT)
-async def delete_user(user_id: UUID, user_repo: UsersRepository = Depends()):
+async def delete_user(user_id: UUID, user_repo: UsersRepository = Depends(get_repository(UsersRepository))):
     """
     Delete an user.
     """
@@ -100,8 +109,10 @@ async def delete_user(user_id: UUID, user_repo: UsersRepository = Depends()):
 
 
 @router.post("/login", response_model=schemas.Token)
-async def login(user_repo: UsersRepository = Depends(),
-                form_data: OAuth2PasswordRequestForm = Depends()) -> schemas.Token:
+async def login(
+        user_repo: UsersRepository = Depends(get_repository(UsersRepository)),
+        form_data: OAuth2PasswordRequestForm = Depends()
+) -> schemas.Token:
     """
     User login.
     """

gns3server/api/server.py

@@ -45,34 +45,43 @@ import logging
 log = logging.getLogger(__name__)
 
 
-app = FastAPI(title="GNS3 controller API",
-              description="This page describes the public controller API for GNS3",
-              version="v3")
+def get_application() -> FastAPI:
 
-origins = [
-    "http://127.0.0.1",
-    "http://localhost",
-    "http://127.0.0.1:8080",
-    "http://localhost:8080",
-    "http://127.0.0.1:3080",
-    "http://localhost:3080",
-    "http://gns3.github.io",
-    "https://gns3.github.io"
-]
+    application = FastAPI(
+        title="GNS3 controller API",
+        description="This page describes the public controller API for GNS3",
+        version="v3"
+    )
 
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=origins,
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-)
+    origins = [
+        "http://127.0.0.1",
+        "http://localhost",
+        "http://127.0.0.1:8080",
+        "http://localhost:8080",
+        "http://127.0.0.1:3080",
+        "http://localhost:3080",
+        "http://gns3.github.io",
+        "https://gns3.github.io"
+    ]
 
-app.add_event_handler("startup", tasks.create_startup_handler(app))
-app.add_event_handler("shutdown", tasks.create_shutdown_handler(app))
-app.include_router(index.router, tags=["Index"])
-app.include_router(controller.router, prefix="/v3")
-app.mount("/v3/compute", compute_api)
+    application.add_middleware(
+            CORSMiddleware,
+            allow_origins=origins,
+            allow_credentials=True,
+            allow_methods=["*"],
+            allow_headers=["*"],
+        )
+
+    application.add_event_handler("startup", tasks.create_startup_handler(application))
+    application.add_event_handler("shutdown", tasks.create_shutdown_handler(application))
+    application.include_router(index.router, tags=["Index"])
+    application.include_router(controller.router, prefix="/v3")
+    application.mount("/v3/compute", compute_api)
+
+    return application
+
+
+app = get_application()
 
 
 @app.exception_handler(ControllerError)

gns3server/core/tasks.py

@@ -55,7 +55,7 @@ def create_startup_handler(app: FastAPI) -> Callable:
             loop.set_debug(True)
 
         # connect to the database
-        await connect_to_db()
+        await connect_to_db(app)
 
         await Controller.instance().start()
         # Because with a large image collection

gns3server/db/models.py

@@ -21,7 +21,10 @@ from sqlalchemy import Boolean, Column, ForeignKey, Integer, String, DateTime, f
 from sqlalchemy.orm import relationship
 from sqlalchemy.types import TypeDecorator, CHAR
 from sqlalchemy.dialects.postgresql import UUID
-from .database import Base
+
+from sqlalchemy.orm import declarative_base
+
+Base = declarative_base()
 
 
 class GUID(TypeDecorator):
@@ -68,11 +71,14 @@ class BaseTable(Base):
                         onupdate=func.current_timestamp())
 
 
+def generate_uuid():
+    return str(uuid.uuid4())
+
 class User(BaseTable):
 
     __tablename__ = "users"
 
-    user_id = Column(GUID, primary_key=True, default=str(uuid.uuid4()))
+    user_id = Column(GUID, primary_key=True, default=generate_uuid)
     username = Column(String, unique=True, index=True)
     email = Column(String, unique=True, index=True)
     full_name = Column(String)

gns3server/db/repositories/base.py

@@ -16,14 +16,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from sqlalchemy.ext.asyncio import AsyncSession
-from ..database import engine
 
 
 class BaseRepository:
 
-    async def db(self):
-        session = AsyncSession(engine)
-        try:
-            yield session
-        finally:
-            await session.close()
+    def __init__(self, db_session: AsyncSession) -> None:
+
+        self._db_session = db_session

gns3server/db/repositories/users.py

@@ -20,7 +20,6 @@ from typing import Optional, List
 from sqlalchemy import select, update, delete
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from ..database import engine
 from .base import BaseRepository
 
 import gns3server.db.models as models
@@ -30,73 +29,66 @@ from gns3server.services import auth_service
 
 class UsersRepository(BaseRepository):
 
-    def __init__(self) -> None:
+    def __init__(self, db_session: AsyncSession) -> None:
 
-        super().__init__()
+        super().__init__(db_session)
         self._auth_service = auth_service
 
     async def get_user(self, user_id: UUID) -> Optional[models.User]:
 
-        async with AsyncSession(engine) as session:
-            result = await session.execute(select(models.User).where(models.User.user_id == user_id))
-            return result.scalars().first()
+        result = await self._db_session.execute(select(models.User).where(models.User.user_id == user_id))
+        return result.scalars().first()
 
     async def get_user_by_username(self, username: str) -> Optional[models.User]:
 
-        async with AsyncSession(engine) as session:
-            result = await session.execute(select(models.User).where(models.User.username == username))
-            return result.scalars().first()
+        result = await self._db_session.execute(select(models.User).where(models.User.username == username))
+        return result.scalars().first()
 
     async def get_user_by_email(self, email: str) -> Optional[models.User]:
 
-        async with AsyncSession(engine) as session:
-            result = await session.execute(select(models.User).where(models.User.email == email))
-            return result.scalars().first()
+        result = await self._db_session.execute(select(models.User).where(models.User.email == email))
+        return result.scalars().first()
 
     async def get_users(self) -> List[models.User]:
 
-        async with AsyncSession(engine) as session:
-            result = await session.execute(select(models.User))
-            return result.scalars().all()
+        result = await self._db_session.execute(select(models.User))
+        return result.scalars().all()
 
     async def create_user(self, user: schemas.UserCreate) -> models.User:
 
-        async with AsyncSession(engine) as session:
-            hashed_password = self._auth_service.hash_password(user.password)
-            db_user = models.User(username=user.username,
-                                  email=user.email,
-                                  full_name=user.full_name,
-                                  hashed_password=hashed_password)
-            session.add(db_user)
-            await session.commit()
-            await session.refresh(db_user)
-            return db_user
+        hashed_password = self._auth_service.hash_password(user.password)
+        db_user = models.User(
+            username=user.username,
+            email=user.email,
+            full_name=user.full_name,
+            hashed_password=hashed_password
+        )
+        self._db_session.add(db_user)
+        await self._db_session.commit()
+        await self._db_session.refresh(db_user)
+        return db_user
 
     async def update_user(self, user_id: UUID, user_update: schemas.UserUpdate) -> Optional[models.User]:
 
-        async with AsyncSession(engine) as session:
+        update_values = user_update.dict(exclude_unset=True)
+        password = update_values.pop("password", None)
+        if password:
+            update_values["hashed_password"] = self._auth_service.hash_password(password=password)
 
-            update_values = user_update.dict(exclude_unset=True)
-            password = update_values.pop("password", None)
-            if password:
-                update_values["hashed_password"] = self._auth_service.hash_password(password=password)
+        query = update(models.User) \
+            .where(models.User.user_id == user_id) \
+            .values(update_values)
 
-            print(update_values)
-            query = update(models.User) \
-                .where(models.User.user_id == user_id) \
-                .values(update_values)
-
-            await session.execute(query)
-            await session.commit()
-            return await self.get_user(user_id)
+        await self._db_session.execute(query)
+        await self._db_session.commit()
+        return await self.get_user(user_id)
 
     async def delete_user(self, user_id: UUID) -> bool:
 
-        async with AsyncSession(engine) as session:
-            query = delete(models.User).where(models.User.user_id == user_id)
-            result = await session.execute(query)
-            await session.commit()
-            return result.rowcount > 0
+        query = delete(models.User).where(models.User.user_id == user_id)
+        result = await self._db_session.execute(query)
+        await self._db_session.commit()
+        return result.rowcount > 0
             #except:
             #    await session.rollback()
 

gns3server/db/tasks.py

@@ -15,20 +15,26 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from sqlalchemy.exc import SQLAlchemyError
+import os
+
+from fastapi import FastAPI
+from sqlalchemy.exc import SQLAlchemyError
+from sqlalchemy.ext.asyncio import create_async_engine
 
-from .database import engine
 from .models import Base
 
 import logging
 log = logging.getLogger(__name__)
 
 
-async def connect_to_db() -> None:
+async def connect_to_db(app: FastAPI) -> None:
 
+    db_url = os.environ.get("GNS3_DATABASE_URI", "sqlite:///./sql_app.db")
+    engine = create_async_engine(db_url, connect_args={"check_same_thread": False}, future=True)
     try:
         async with engine.begin() as conn:
             await conn.run_sync(Base.metadata.create_all)
             log.info("Successfully connected to the database")
+        app.state._db_engine = engine
     except SQLAlchemyError as e:
         log.error(f"Error while connecting to the database: {e}")

gns3server/services/authentication.py

@@ -35,10 +35,6 @@ ACCESS_TOKEN_EXPIRE_MINUTES = 30
 pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
 
 
-#class AuthException(BaseException):
-#    pass
-
-
 class AuthService:
 
     def hash_password(self, password: str) -> str:
@@ -49,14 +45,19 @@ class AuthService:
 
         return pwd_context.verify(password, hashed_password)
 
-    def create_access_token(self, username):
+    def create_access_token(
+            self,
+            username,
+            secret_key: str = SECRET_KEY,
+            expires_in: int = ACCESS_TOKEN_EXPIRE_MINUTES
+    ) -> str:
 
-        expire = datetime.utcnow() + timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
+        expire = datetime.utcnow() + timedelta(minutes=expires_in)
         to_encode = {"sub": username, "exp": expire}
-        encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
+        encoded_jwt = jwt.encode(to_encode, secret_key, algorithm=ALGORITHM)
         return encoded_jwt
 
-    def get_username_from_token(self, token: str) -> Optional[str]:
+    def get_username_from_token(self, token: str, secret_key: str = SECRET_KEY) -> Optional[str]:
 
         credentials_exception = HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
@@ -64,7 +65,7 @@ class AuthService:
             headers={"WWW-Authenticate": "Bearer"},
         )
         try:
-            payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
+            payload = jwt.decode(token, secret_key, algorithms=[ALGORITHM])
             username: str = payload.get("sub")
             if username is None:
                 raise credentials_exception