Fixed a typo in README and changed one of the phrase to be more correct

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-slim
+FROM python:3.11-slim
 
 # Keeps Python from generating .pyc files in the container
 ENV PYTHONDONTWRITEBYTECODE=1
@@ -6,6 +6,11 @@ ENV PYTHONDONTWRITEBYTECODE=1
 # Turns off buffering for easier container logging
 ENV PYTHONUNBUFFERED=1
 
+WORKDIR /app
+
+# Creates new user
+RUN adduser -u 1000 --disabled-password --gecos "" appuser && chown -R appuser /app
+
 # Install deps
 RUN apt update && apt full-upgrade -y
 RUN apt install curl gcc -y
@@ -16,11 +21,8 @@ RUN apt install libmariadb3 libmariadb-dev -y
 COPY requirements.txt .
 RUN python -m pip install -r requirements.txt
 
-
-WORKDIR /app
 COPY . /app
 
-RUN adduser -u 1000 --disabled-password --gecos "" appuser && chown -R appuser /app
 USER appuser
 
 CMD ["python", "main.py"]

README.md

@@ -1,18 +1,35 @@
 # PassManager
 
-### Цель
+## Описание
 
-**Создать бота для сохранения, созания паролей в зашифрованой базе данных.**
+Менеджер паролей для телеграм, где все пароли надёжно зашифрованы
 
-### Задачи
+## Документация
 
-* Создать телеграм бота
+### База данных
-* Научить его работать с БД (MariaDB)
-* Зашифровать БД
-* Сделать общедоступным
 
-### Инструменты
+В качестве базы данных данный бот использует mariadb, к которой бот должен иметь доступ всегда
 
-* Язык программирования Python
+### Команды и их синтаксис
-* PyTelegramBotAPI
+
-* MariaDB
+- /set_master_pass - установить мастер пароль
+- /add_account - создать аккаунт
+- /get_accounts - получить список аккаунтов
+- /get_account - получить логин и пароль аккаунта
+- /delete_account - удалить аккаунт
+- /delete_all - удалить все аккаунты и мастер пароль
+- /reset_master_pass- удалить все аккаунты и изменить мастер пароль
+- /cancel - отмена текущего действия
+- /help - помощь
+
+### Настройка
+
+Настройка производится через переменные среды. Их можно прописать в файле .env, если не хотите задавать их каждый раз в случае, если вы не используете Docker
+
+#### Переменные среды
+
+- DB_HOST - ip адрес базы данных
+- DB_USER - пользователь базы данных
+- DB_PASS - пароль пользователя базы данных
+- DB_NAME - название базы данных
+- TG_TOKEN - токен телеграма, его следует указать в файле .env в формате TG_TOKEN={токен}

compose.yaml

@@ -13,7 +13,7 @@ services:
       DB_USER: manager
       DB_PASS: passwd123!
       DB_NAME: passmanager
-      TG_TOKEN: 12345
+      TG_TOKEN: ${TG_TOKEN}
     depends_on:
       - db
     networks:

src/bot/__init__.py

@@ -2,7 +2,6 @@ import functools
 
 import mariadb
 import telebot
-from sqlalchemy.future import Engine
 
 from . import handlers
 
@@ -22,7 +21,7 @@ def create_bot(token: str, engine: mariadb.Connection) -> telebot.TeleBot:
         functools.partial(handlers.get_accounts, bot, engine), commands=["get_accounts"]
     )
     bot.register_message_handler(
-        functools.partial(handlers.add_record, bot, engine), commands=["add_account"]
+        functools.partial(handlers.add_account, bot, engine), commands=["add_account"]
     )
     bot.register_message_handler(
         functools.partial(handlers.delete_all, bot, engine), commands=["delete_all"]
@@ -35,4 +34,10 @@ def create_bot(token: str, engine: mariadb.Connection) -> telebot.TeleBot:
         functools.partial(handlers.delete_account, bot, engine),
         commands=["delete_account"],
     )
+    bot.register_message_handler(
+        functools.partial(handlers.help, bot), commands=["help", "start"]
+    )
+    bot.register_message_handler(
+        functools.partial(handlers.cancel, bot), commands=["cancel"]
+    )
     return bot

src/bot/handlers.py

@@ -1,5 +1,5 @@
+import functools
 import gc
-import shlex
 import time
 
 import telebot
@@ -7,52 +7,17 @@ from sqlalchemy.future import Engine
 
 from .. import cryptography, database
 
+Message = telebot.types.Message
+
 
 def _send_tmp_message(
     bot: telebot.TeleBot, chat_id: telebot.types.Message, text: str, timeout: int = 5
 ) -> None:
-    bot_mes = bot.send_message(chat_id, text)
+    bot_mes = bot.send_message(chat_id, text, parse_mode="MarkdownV2")
     time.sleep(timeout)
     bot.delete_message(chat_id, bot_mes.id)
 
 
-def add_record(
-    bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
-) -> None:
-    data = shlex.split(mes.text)
-    bot.delete_message(mes.chat.id, mes.id)
-    if len(data) != 5:
-        return _send_tmp_message(bot, mes.chat.id, "Неправильное кол-во аргументов")
-
-    master_password = data[4]
-    master_password_from_db = database.get.get_master_pass(engine, mes.from_user.id)
-    if master_password_from_db is None:
-        return _send_tmp_message(bot, mes.chat.id, "Нет мастер пароля")
-
-    master_salt, hash_pass = master_password_from_db
-    if (
-        cryptography.master_pass.encrypt_master_pass_known_salt(
-            master_password, master_salt
-        )
-        != hash_pass
-    ):
-        return _send_tmp_message(bot, mes.chat.id, "Не подходит главный пароль")
-
-    enc_login, enc_pass, salt = cryptography.other_accounts.encrypt_account_info(
-        data[2], data[3], master_password.encode("utf-8")
-    )
-    result = database.add.add_account(
-        engine, mes.from_user.id, data[1], salt, enc_login, enc_pass
-    )
-    _send_tmp_message(
-        bot,
-        mes.chat.id,
-        "Успех" if result else "Ошибка, вероятно аккаунт с таким же именем существует",
-    )
-    del data, master_password, mes
-    gc.collect()
-
-
 def get_accounts(
     bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
 ) -> None:
@@ -63,106 +28,304 @@ def get_accounts(
         bot,
         mes.chat.id,
         "Ваши аккаунты:\n" + "\n".join(accounts) if accounts else "У вас нет аккаунтов",
+        timeout=30,
     )
 
 
-def set_master_password(
+def _base(bot: telebot.TeleBot, mes: Message, prev_mes: Message | None = None) -> None:
-    bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
-) -> None:
-    data = shlex.split(mes.text)
     bot.delete_message(mes.chat.id, mes.id)
-
+    if prev_mes is not None:
-    if database.get.get_master_pass(engine, mes.from_user.id) is not None:
+        bot.delete_message(prev_mes.chat.id, prev_mes.id)
-        return _send_tmp_message(bot, mes.chat.id, "У вас уже установлен мастер пароль")
-
-    if len(data) != 2:
-        return _send_tmp_message(bot, mes.chat.id, "Неправильное количество аргументов")
-
-    pass_, salt = cryptography.master_pass.encrypt_master_pass(data[1])
-    result = database.add.add_master_pass(engine, mes.from_user.id, salt, pass_)
-    _send_tmp_message(
-        bot,
-        mes.chat.id,
-        "Успех" if result else "Ошибка, вероятно аккаунт с таким же именем существует",
-    )
-
-    del data, mes
-    gc.collect()
-
-
-def get_account(
-    bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
-) -> None:
-    data = shlex.split(mes.text)
-    bot.delete_message(mes.chat.id, mes.id)
-
-    if len(data) != 3:
-        return _send_tmp_message(bot, mes.chat.id, "Неправильное количество аргументов")
-
-    master_pass = database.get.get_master_pass(engine, mes.from_user.id)
-    if master_pass is None:
-        return _send_tmp_message(bot, mes.chat.id, "Нет мастер пароля")
-    master_salt, hash_pass = master_pass
-
-    if data[1] not in database.get.get_accounts(engine, mes.from_user.id):
-        return _send_tmp_message(bot, mes.chat.id, "Нет такого аккаунта")
-
-    if (
-        cryptography.master_pass.encrypt_master_pass_known_salt(data[2], master_salt)
-        != hash_pass
-    ):
-        return _send_tmp_message(bot, mes.chat.id, "Не подходит главный пароль")
-
-    salt, enc_login, enc_pass = database.get.get_account_info(
-        engine, mes.from_user.id, data[1]
-    )
-    login, passwd = cryptography.other_accounts.decrypt_account_info(
-        enc_login, enc_pass, data[2].encode("utf-8"), salt
-    )
-    bot.send_message(mes.chat.id, f"Логин:\n{login}\nПароль:\n{passwd}")
-
-    del data, mes, passwd, login
-    gc.collect()
 
 
 def delete_all(
     bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
 ) -> None:
+    _base(bot, mes)
+    bot_mes = bot.send_message(
+        mes.chat.id,
+        "Вы действительно хотите удалить все ваши аккаунты? Это действие нельзя отменить. Отправьте YES для подтверждения",
+    )
+    bot.register_next_step_handler(
+        mes, functools.partial(_delete_all, bot, engine, bot_mes)
+    )
+
+
+def _delete_all(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "YES":
         database.delete.purge_accounts(engine, mes.from_user.id)
         database.delete.delete_master_pass(engine, mes.from_user.id)
-    bot.send_message(mes.chat.id, "Все ваши данные удалены из базы данных")
+        _send_tmp_message(bot, mes.chat.id, "Всё успешно удалено", timeout=10)
+    else:
+        _send_tmp_message(bot, mes.chat.id, "Вы отправили не YES, ничего не удалено")
 
 
-def reset_master_pass(
+def set_master_password(bot: telebot.TeleBot, engine: Engine, mes: Message) -> None:
-    bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
+    _base(bot, mes, None)
+    if database.get.get_master_pass(engine, mes.from_user.id) is not None:
+        return _send_tmp_message(bot, mes.chat.id, "Мастер пароль уже существует")
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте мастер пароль")
+    bot.register_next_step_handler(
+        mes, functools.partial(_set_master_pass2, bot, engine, bot_mes)
+    )
+
+
+def _set_master_pass2(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
 ) -> None:
-    data = shlex.split(mes.text)
+    _base(bot, mes, prev_mes)
-    if len(data) != 2:
+    text = mes.text.strip()
-        return _send_tmp_message(bot, mes.chat.id, "Неправильное количество аргументов")
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    hash_, salt = cryptography.master_pass.encrypt_master_pass(text)
+    database.add.add_master_pass(engine, mes.from_user.id, salt, hash_)
+    _send_tmp_message(bot, mes.chat.id, "Успех")
+    del mes, text
+    gc.collect()
+
+
+def reset_master_pass(bot: telebot.TeleBot, engine: Engine, mes: Message) -> None:
+    _base(bot, mes)
+    if database.get.get_master_pass(engine, mes.from_user.id) is None:
+        return _send_tmp_message(bot, mes.chat.id, "Мастер пароль не задан")
+    bot_mes = bot.send_message(
+        mes.chat.id,
+        "Отправьте новый мастер пароль, осторожно, все текущие аккаунты будут удалены навсегда",
+    )
+    bot.register_next_step_handler(
+        mes, functools.partial(_reset_master_pass2, bot, engine, bot_mes)
+    )
+
+
+def _reset_master_pass2(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    hash_, salt = cryptography.master_pass.encrypt_master_pass(text)
+    database.delete.purge_accounts(engine, mes.from_user.id)
+    database.change.change_master_pass(engine, mes.from_user.id, salt, hash_)
+    _send_tmp_message(
+        bot, mes.chat.id, "Все ваши аккаунты удалены, а мастер пароль изменён"
+    )
+    del mes, text
+    gc.collect()
+
+
+def add_account(bot: telebot.TeleBot, engine: Engine, mes: Message) -> None:
+    _base(bot, mes)
 
     master_password_from_db = database.get.get_master_pass(engine, mes.from_user.id)
     if master_password_from_db is None:
         return _send_tmp_message(bot, mes.chat.id, "Нет мастер пароля")
 
-    master_password = data[1]
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте название аккаунта")
-    enc_pass, salt = cryptography.master_pass.encrypt_master_pass(master_password)
+
-    database.delete.purge_accounts(engine, mes.from_user.id)
+    bot.register_next_step_handler(
-    database.change.change_master_pass(engine, mes.from_user.id, salt, enc_pass)
+        mes, functools.partial(_add_account2, bot, engine, bot_mes)
-    _send_tmp_message(
-        bot, mes.chat.id, "Все ваши аккаунты удалены, а мастер пароль изменён"
     )
 
 
-def delete_account(
+def _add_account2(
-    bot: telebot.TeleBot, engine: Engine, mes: telebot.types.Message
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
 ) -> None:
-    data = shlex.split(mes.text)
+    _base(bot, mes, prev_mes)
-    bot.delete_message(mes.chat.id, mes.id)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
 
-    if len(data) != 2:
+    if text in database.get.get_accounts(engine, mes.from_user.id):
-        return _send_tmp_message(bot, mes.chat.id, "Неправильное количество аргументов")
+        return _send_tmp_message(
+            bot, mes.chat.id, "Аккаунт с таким именем уже существует"
+        )
 
-    if data[1] not in database.get.get_accounts(engine, mes.from_user.id):
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте логин")
+    data = {"name": text}
+
+    bot.register_next_step_handler(
+        mes, functools.partial(_add_account3, bot, engine, bot_mes, data)
+    )
+
+
+def _add_account3(
+    bot: telebot.TeleBot,
+    engine: Engine,
+    prev_mes: Message,
+    data: dict[str, str],
+    mes: Message,
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    data["login"] = text
+
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте пароль от аккаунта")
+
+    bot.register_next_step_handler(
+        mes, functools.partial(_add_account4, bot, engine, bot_mes, data)
+    )
+
+
+def _add_account4(
+    bot: telebot.TeleBot,
+    engine: Engine,
+    prev_mes: Message,
+    data: dict[str, str],
+    mes: Message,
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    data["passwd"] = text
+
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте мастер пароль")
+
+    bot.register_next_step_handler(
+        mes, functools.partial(_add_account5, bot, engine, bot_mes, data)
+    )
+
+
+def _add_account5(
+    bot: telebot.TeleBot,
+    engine: Engine,
+    prev_mes: Message,
+    data: dict[str, str],
+    mes: Message,
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    salt, hash_ = database.get.get_master_pass(engine, mes.from_user.id)
+    if cryptography.master_pass.encrypt_master_pass(text, salt) != hash_:
+        return _send_tmp_message(bot, mes.chat.id, "Не подходит главный пароль")
+
+    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")
+    )
+
+    database.add.add_account(engine, mes.from_user.id, name, salt, enc_login, enc_pass)
+
+    _send_tmp_message(bot, mes.chat.id, "Успех")
+
+    del data, name, login, passwd, enc_login
+
+    gc.collect()
+
+
+def get_account(bot: telebot.TeleBot, engine: Engine, mes: Message) -> None:
+    _base(bot, mes)
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте название аккаунта")
+    bot.register_next_step_handler(
+        mes, functools.partial(_get_account2, bot, engine, bot_mes)
+    )
+
+
+def _get_account2(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    if text not in database.get.get_accounts(engine, mes.from_user.id):
         return _send_tmp_message(bot, mes.chat.id, "Нет такого аккаунта")
 
-    database.delete.delete_account(engine, mes.from_user.id, data[1])
+    bot_mes = bot.send_message(mes.chat.id, "Отправьте мастер пароль")
+    bot.register_next_step_handler(
+        mes, functools.partial(_get_account3, bot, engine, bot_mes, text)
+    )
+
+
+def _get_account3(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, name: str, mes: Message
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    master_pass = database.get.get_master_pass(engine, mes.from_user.id)
+    if master_pass is None:
+        return _send_tmp_message(bot, mes.chat.id, "Нет мастер пароля")
+
+    master_salt, hash_pass = master_pass
+
+    if cryptography.master_pass.encrypt_master_pass(text, master_salt) != hash_pass:
+        return _send_tmp_message(bot, mes.chat.id, "Не подходит мастер пароль")
+
+    salt, enc_login, enc_pass = database.get.get_account_info(
+        engine, mes.from_user.id, name
+    )
+    login, passwd = cryptography.other_accounts.decrypt_account_info(
+        enc_login, enc_pass, text.encode("utf-8"), salt
+    )
+    _send_tmp_message(
+        bot,
+        mes.chat.id,
+        f"Логин:\n`{login}`\nПароль:\n`{passwd}`\nНажмите на логин или пароль, чтобы скопировать",
+        30,
+    )
+
+    del text, mes, passwd, login
+    gc.collect()
+
+
+def delete_account(bot: telebot.TeleBot, engine: Engine, mes: Message) -> None:
+    _base(bot, mes)
+    bot_mes = bot.send_message(
+        mes.chat.id, "Отправьте название аккаунта, который вы хотите удалить"
+    )
+
+    bot.register_next_step_handler(
+        mes, functools.partial(_delete_account2, bot, engine, bot_mes)
+    )
+
+
+def _delete_account2(
+    bot: telebot.TeleBot, engine: Engine, prev_mes: Message, mes: Message
+) -> None:
+    _base(bot, mes, prev_mes)
+    text = mes.text.strip()
+    if text == "/cancel":
+        return _send_tmp_message(bot, mes.chat.id, "Успешная отмена")
+
+    if text not in database.get.get_accounts(engine, mes.from_user.id):
+        return _send_tmp_message(bot, mes.chat.id, "Нет такого аккаунта")
+
+    database.delete.delete_account(engine, mes.from_user.id, text)
+    _send_tmp_message(bot, mes.chat.id, "Аккаунт удалён")
+
+
+def help(bot: telebot.TeleBot, mes: telebot.types.Message) -> None:
+    message = """Команды:
+/set_master_pass - установить мастер пароль
+/add_account - создать аккаунт
+/get_accounts - получить список аккаунтов
+/get_account - получить логин и пароль аккаунта
+/delete_account - удалить аккаунт
+/delete_all - удалить все аккаунты и мастер пароль
+/reset_master_pass - удалить все аккаунты и изменить мастер пароль
+/cancel - отмена текущего действия
+/help - помощь"""
+    bot.send_message(mes.chat.id, message)
+
+
+def cancel(bot: telebot.TeleBot, mes: Message) -> None:
+    _send_tmp_message(bot, mes.chat.id, "Нет активного действия")

src/cryptography/master_pass.py

@@ -1,12 +1,26 @@
+from typing import overload
+
 import bcrypt
 
 
+@overload
+def encrypt_master_pass(passwd: str, salt: bytes) -> bytes:
+    ...
+
+
+@overload
 def encrypt_master_pass(passwd: str) -> tuple[bytes, bytes]:
+    ...
+
+
+def encrypt_master_pass(
+    passwd: str, salt: bytes | None = None
+) -> tuple[bytes, bytes] | bytes:
     """Hashes master password and return tuple of hashed password and salt"""
+    if salt is None:
         salt = bcrypt.gensalt()
+        gened_salt = True
+    else:
+        gened_salt = False
     hashed = bcrypt.hashpw(passwd.encode("utf-8"), salt)
-    return (hashed, salt)
+    return (hashed, salt) if gened_salt else hashed
-
-
-def encrypt_master_pass_known_salt(passwd: str, salt: bytes) -> bytes:
-    return bcrypt.hashpw(passwd.encode("utf-8"), salt)

src/database/change.py

@@ -14,3 +14,4 @@ def change_master_pass(
     )
     with sqlmodel.Session(engine) as session:
         session.exec(statement)
+        session.commit()

src/database/delete.py

@@ -8,6 +8,7 @@ def purge_accounts(engine: Engine, user_id: int) -> None:
     statement = sqlmodel.delete(models.Account).where(models.Account.user_id == user_id)
     with sqlmodel.Session(engine) as session:
         session.exec(statement)
+        session.commit()
 
 
 def delete_master_pass(engine: Engine, user_id: int) -> None:
@@ -16,11 +17,13 @@ def delete_master_pass(engine: Engine, user_id: int) -> None:
     )
     with sqlmodel.Session(engine) as session:
         session.exec(statement)
+        session.commit()
 
 
 def delete_account(engine: Engine, user_id: int, name: str) -> None:
     statement = sqlmodel.delete(models.Account).where(
-        models.Account.user_id == user_id and models.Account.name == name
+        models.Account.user_id == user_id, models.Account.name == name
     )
     with sqlmodel.Session(engine) as session:
         session.exec(statement)
+        session.commit()