Lockana

Lockana — это высокобезопасное решение для хранения и управления секретными данными, разработанное для обеспечения конфиденциальности и безопасности доступа к данным. Приложение использует современную аутентификацию через одноразовые пароли (TOTP) для получения доступа к данным, что гарантирует, что только авторизованные пользователи могут получить доступ к секретной информации.

Основные особенности Lockana:

1. Безопасность на первом месте:

• Данные хранятся в зашифрованном виде.
• Доступ к данным возможен только после успешной аутентификации с использованием одноразового пароля (TOTP).
• Каждая попытка входа (успешная или неудачная) логируется для мониторинга активности и предупреждения о возможных угрозах.

2. Централизованное управление секретами:

• Секреты (например, API-ключи, пароли, ключи доступа) хранятся в одном месте, что упрощает управление.
• Возможность быстро обновлять или удалять секреты без необходимости изменения .env файлов или другого локального хранилища.

3. Простой и быстрый доступ:

• Запрос секретов осуществляется через API с использованием имени проекта и одноразового пароля.
• Возможность интеграции с различными сервисами и приложениями для безопасного доступа к данным.

4. Мгновенные уведомления:

• В случае любой попытки доступа (успешной или неуспешной) пользователю сразу отправляется уведомление, что обеспечивает дополнительный уровень безопасности.

5. Изоляция и безопасность:

• Lockana можно развернуть в изолированном окружении (например, в Docker), что минимизирует риски при эксплуатации.
• Логирование всех действий позволяет отслеживать, кто, когда и какие данные пытался получить.

Преимущества использования Lockana:

• Гибкость: Легко интегрируется с любыми проектами и сервисами.
• Простота использования: API предоставляет простой и удобный интерфейс для запросов и управления секретами.
• Конфиденциальность: Хранение секретов в зашифрованном виде и использование TOTP для аутентификации минимизируют риски утечек данных.
• Уведомления: Мгновенные уведомления о попытках доступа дают вам контроль и видимость над активностью.

Как работает Lockana:

1. Аутентификация: Пользователь отправляет запрос с именем проекта и одноразовым паролем (TOTP).
2. Проверка данных: API проверяет данные на сервере и, если всё верно, возвращает секреты, связанные с проектом.
3. Уведомления: В случае успешного или неудачного входа система отправляет уведомление пользователю.
4. Логирование: Все запросы и попытки доступа логируются для анализа безопасности.

Lockana идеально подходит для проектов, которым нужна безопасная и централизованная система для хранения и управления секретами, а также для тех, кто хочет избавиться от хранения чувствительных данных в файлах на сервере.

Ваши инструкции для установки выглядят в целом хорошо, но можно немного улучшить их для удобства и ясности. Вот несколько предложений:

1. Пояснение для создания окружения: Можно добавить, что при создании окружения лучше использовать python -m venv вместо python3 -m venv для большей совместимости, если на системе установлен только один Python 3.

2. Уточнение в экспорте переменных окружения: Можно добавить, что перед экспортом переменных нужно заменить YOUR_SUPER_USER, YOUR_SUPER_PASSWORD и YOUR_SUPER_SECRET на реальные значения.

3. Завершение "TODO": Можно дополнить описание в TODO для большей информативности.

Вот обновленная версия:

---

Установка

1. Клонируйте репозиторий:

   git clone https://github.com/FlacSy/Lockana.git
   cd Lockana

2. Создайте виртуальное окружение:

   python -m venv venv
   source venv/bin/activate

3. Установите зависимости:

   pip install -r requirements.txt

4. Добавьте переменные окружения: Замените YOUR_SUPER_USER, YOUR_SUPER_PASSWORD и YOUR_SUPER_SECRET на ваши реальные данные.

   export MYSQL_USER=YOUR_SUPER_USER
   export MYSQL_PASSWORD=YOUR_SUPER_PASSWORD
   export JWT_SECRET_KEY=YOUR_SUPER_SECRET

5. Запустите приложение:

   python app.py

API Документация

Для доступа к API используется аутентификация через одноразовые пароли (TOTP). API позволяет безопасно запрашивать и управлять секретами через защищённый интерфейс. Подробнее о маршрутах и запросах читайте в документации API.

Журнал изменений:

• beta v1 — Первая бета-версия API. Система пользователей с ролями, управление пользователями и секретами.

TODO:

• Система сообщений с уведомлением о входе с использованием Telegram.
• Возможность выбора типа шифрования данных (Cha20Cha20/RSA)