Changed and added comments in the database files

src/bot/handlers.py

@@ -9,10 +9,10 @@ from .. import cryptography, database
 from .utils import (
     accounts_to_json,
     base_handler,
+    check_account,
     check_account_name,
     check_login,
     check_passwd,
-    check_account,
     get_all_accounts,
     json_to_accounts,
     send_tmp_message,
@@ -225,7 +225,7 @@ def _add_account5(
     name, login, passwd = data["name"], data["login"], data["passwd"]
 
     enc_login, enc_pass, salt = cryptography.other_accounts.encrypt_account_info(
-        login, passwd, text.encode("utf-8")
+        login, passwd, text
     )
 
     result = database.add.add_account(
@@ -288,7 +288,7 @@ def _get_account3(
         engine, mes.from_user.id, name
     )
     login, passwd = cryptography.other_accounts.decrypt_account_info(
-        enc_login, enc_pass, text.encode("utf-8"), salt
+        enc_login, enc_pass, text, salt
     )
     send_tmp_message(
         bot,
@@ -456,7 +456,7 @@ def _import3(
             failed.append(name)
             continue
         enc_login, enc_passwd, salt = cryptography.other_accounts.encrypt_account_info(
-            login, passwd, text.encode("utf-8")
+            login, passwd, text
         )
         result = database.add.add_account(
             engine, mes.from_user.id, name, salt, enc_login, enc_passwd

src/bot/utils.py

@@ -59,7 +59,6 @@ def get_all_accounts(
     engine: Engine, user_id: int, master_pass: str
 ) -> list[tuple[str, str, str]]:
     accounts: list[tuple[str, str, str]] = []
-    master_pass = master_pass.encode("utf-8")
     for account_name in database.get.get_accounts(engine, user_id):
         salt, enc_login, enc_passwd = database.get.get_account_info(
             engine, user_id, account_name

src/cryptography/master_pass.py

@@ -3,14 +3,14 @@ import os
 from cryptography.exceptions import InvalidKey
 from cryptography.hazmat.primitives.kdf.scrypt import Scrypt
 
-_memory_use = 2**14
+MEMORY_USAGE = 2**14
 
 
 def _get_kdf(salt: bytes) -> Scrypt:
     kdf = Scrypt(
         salt=salt,
         length=128,
-        n=_memory_use,
+        n=MEMORY_USAGE,
         r=8,
         p=1,
     )

src/cryptography/other_accounts.py

@@ -20,12 +20,12 @@ def _generate_key(salt: bytes, master_pass: bytes) -> bytes:
 
 
 def encrypt_account_info(
-    login: str, passwd: str, master_pass: bytes
+    login: str, passwd: str, master_pass: str
 ) -> tuple[bytes, bytes, bytes]:
     """Encrypts login and password of a user using their master password as a key.
     Returns a tuple of encrypted login, password and salt"""
     salt = os.urandom(64)
-    key = _generate_key(salt, master_pass)
+    key = _generate_key(salt, master_pass.encode("utf-8"))
     f = Fernet(key)
     enc_login = f.encrypt(login.encode("utf-8"))
     enc_passwd = f.encrypt(passwd.encode("utf-8"))
@@ -33,11 +33,11 @@ def encrypt_account_info(
 
 
 def decrypt_account_info(
-    enc_login: bytes, enc_pass: bytes, master_pass: bytes, salt: bytes
+    enc_login: bytes, enc_pass: bytes, master_pass: str, salt: bytes
 ) -> tuple[str, str]:
     """Decrypts login and password using their master password as a key.
     Returns a tuple of decrypted login and password"""
-    key = _generate_key(salt, master_pass)
+    key = _generate_key(salt, master_pass.encode("utf-8"))
     f = Fernet(key)
     login_bytes = f.decrypt(enc_login)
     pass_bytes = f.decrypt(enc_pass)

src/database/add.py

@@ -13,7 +13,7 @@ def add_account(
     enc_login: bytes,
     enc_pass: bytes,
 ) -> bool:
-    """Adds account to db. Returns true, if on success"""
+    """Adds account to the database. Returns true on success, false otherwise"""
     account = models.Account(
         user_id=user_id, name=name, salt=salt, enc_login=enc_login, enc_pass=enc_pass
     )
@@ -28,7 +28,7 @@ def add_account(
 
 
 def add_master_pass(engine: Engine, user_id: int, salt: bytes, passwd: bytes) -> bool:
-    """Adds master password to db. Returns true, if on success"""
+    """Adds master password the database. Returns true on success, false otherwise"""
     master_pass = models.MasterPass(user_id=user_id, salt=salt, passwd=passwd)
     try:
         with sqlmodel.Session(engine) as session:

src/database/change.py

@@ -7,6 +7,7 @@ from . import models
 def change_master_pass(
     engine: Engine, user_id: int, salt: bytes, passwd: bytes
 ) -> None:
+    """Changes master password and salt in the database"""
     statement = (
         sqlmodel.update(models.MasterPass)
         .where(models.MasterPass.user_id == user_id)

src/database/delete.py

@@ -5,6 +5,7 @@ from . import models
 
 
 def purge_accounts(engine: Engine, user_id: int) -> None:
+    """Deletes all user's accounts"""
     statement = sqlmodel.delete(models.Account).where(models.Account.user_id == user_id)
     with sqlmodel.Session(engine) as session:
         session.exec(statement)
@@ -12,6 +13,7 @@ def purge_accounts(engine: Engine, user_id: int) -> None:
 
 
 def delete_master_pass(engine: Engine, user_id: int) -> None:
+    """Delets master password of the user"""
     statement = sqlmodel.delete(models.MasterPass).where(
         models.MasterPass.user_id == user_id
     )
@@ -21,6 +23,7 @@ def delete_master_pass(engine: Engine, user_id: int) -> None:
 
 
 def delete_account(engine: Engine, user_id: int, name: str) -> None:
+    """Deletes specific user account"""
     statement = sqlmodel.delete(models.Account).where(
         models.Account.user_id == user_id, models.Account.name == name
     )

src/database/get.py

@@ -5,7 +5,8 @@ from . import models
 
 
 def get_master_pass(engine: Engine, user_id: int) -> tuple[bytes, bytes] | None:
-    """Gets master pass. Returns tuple of salt and password"""
+    """Gets master pass. Returns tuple of salt and password
+    or None if it wasn't found"""
     statement = sqlmodel.select(models.MasterPass).where(
         models.MasterPass.user_id == user_id
     )
@@ -27,7 +28,8 @@ def get_accounts(engine: Engine, user_id: int) -> list[str]:
 def get_account_info(
     engine: Engine, user_id: int, name: str
 ) -> tuple[bytes, bytes, bytes]:
-    """Gets account info. Returns tuple of salt, login and password"""
+    """Gets account info. Returns tuple of salt, login and password
+    or None if it wasn't found"""
     statement = sqlmodel.select(models.Account).where(
         models.Account.user_id == user_id, models.Account.name == name
     )

src/database/prepare.py

@@ -5,9 +5,11 @@ from . import models
 
 
 def get_engine(host: str, user: str, passwd: str, db: str) -> Engine:
+    """Creates an engine for mariadb with pymysql as connector"""
     engine = sqlmodel.create_engine(f"mariadb+pymysql://{user}:{passwd}@{host}/{db}")
     return engine
 
 
 def prepare(engine: Engine) -> None:
+    """Creates all tables, indexes and constrains in the database"""
     sqlmodel.SQLModel.metadata.create_all(engine)