Данный сервис представляет собой RESTful API для управления аутентификацией и авторизацией пользователей. Основная цель — предоставить безопасный механизм регистрации, входа, обновления сессий и выхода из системы с использованием JSON Web Tokens (JWT).
- Особенности
- Технологический стек
- Концепции аутентификации и авторизации
- Быстрый старт
- Ручная сборка проекта на OC Linux Ubuntu
- Обновление системы
- Установка Python с необходимыми пакетами
- Установка curl, необходимого для менеджера пакетов uv
- Установка UV - менеджера управления зависимостями
- Клонирование репозитория
- Создание виртуального окружения при помощи UV и его активация
- Установка зависимостей из файла pyproject.toml
- Настройка файла окружения (.env)
- Работа с Docker
- Участие в разработке
- Регистрация пользователей: Создание новых пользователей с помощью
/API/v0.1/register. - Вход пользователей: Аутентификация пользователей и получение JWT-токенов с помощью
/API/v0.1/login. - Защищенные маршруты: Доступ к данным пользователя с помощью
/API/v0.1/meс использованием JWT. - Доступ на основе ролей: Поддерживает роли
userиadmin(с возможностью расширения до/admin-only). - Тесты: Полный набор тестов с
pytest. - Поддержка докеров: Готовность к контейнерному развертыванию.
FastAPI, SQLAlchemy, PostgreSQL, JWT, Pytest
Access Token (токен доступа) Краткосрочный токен, используемый для аутентификации запросов к защищённым эндпоинтам.
- Предоставляет доступ к защищённым ресурсам (например,
/me) на основе валидного токена - Передаётся в заголовке Authorization: Bearer .
Refresh Token (токен обновления) Долгосрочный токен, хранящийся в базе данных, позволяющий обновлять Access Token без повторного ввода логина и пароля.
- Используется для получения нового Access Token, когда старый истёк.
- Refresh Token позволяет продлевать сессию без повторной аутентификации, снижая нагрузку на пользователя, но требует безопасного хранения в базе данных.
- Пользователь аутентифицируется через
/login, получая оба токена. - Access Token используется для доступа к API до истечения срока действия.
- При истечении Access Token пользователь отправляет Refresh Token на
/refresh, получая новые токены. - Выход через
/logoutудаляет Refresh Token из базы, завершая сессию.
1. Клонируйте репозиторий
git clone https://github.com/heavenyoung1/auth_service.git2. Установите и запустите docker-compose
Важно! Устанавливать docker-compose через curl, из GitHub. Данного пакета нет в apt. Команда для установки ниже, актуальная версия на данный момент 2.36.0
sudo curl -L "https://github.com/docker/compose/releases/download/v2.36.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
3. Сборка проекта
docker-compose up --build -d
Примечание! Для удобства в docker-compose добавлен Portainer, при помощи которого можно удобно управлять контейнерами, просматривать логи через графический интерфейс. Он стартует при сборке докера и доступен по адресу https://localhost:9443.
sudo apt update && sudo apt upgrade -y
sudo apt install python3 python3-pip python3-venv -y
python3 --version
sudo apt install curl
curl --version
curl -LsSf https://astral.sh/uv/install.sh | sh
uv --version
Перейдите в директорию, куда вы хотите клонировать репозиторий
git clone https://github.com/heavenyoung1/auth_service.git
Важно! Переоткройте терминал и продолжите выполнение
uv venv
source .venv/bin/activate
uv sync --all-extras
Для работы проекта необходимо настроить переменные окружения, которые используются для подключения к базе данных и других конфигураций. Эти переменные хранятся в файле .env, который должен быть создан в папке auth_service/.
- Перейдите в директорию проекта:
cd auth_service
- Создайте файл
.env:
touch .env
- Откройте файл .env в текстовом редакторе (например,
nano):
nano .env
- Добавьте в файл следующие переменные окружения, заменив значения на ваши данные:
!!! Для docker-compose вместо <host> прописать название сервера, в данном случае db
# URL для подключения к основной базе данных
DATABASE_URL="postgresql+psycopg2://<user>:<password>@<host>:<port>/<database_name>"
# URL для подключения к тестовой базе данных
TEST_DATABASE_URL="postgresql+psycopg2://<user>:<password>@<host>:<port>/<test_database_name>"
# Секретный ключ для подписи JWT-токенов
SECRET_KEY=<your-secret-key>
# Параметры подключения к PostgreSQL
PG_HOST="<database-host>"
PG_DB="<database-name>"
PG_PORT="<port>"
PG_USER="<username>"
PG_PASSWORD="<password>"
- Cохраните файл и закройте редактор нажмите
Ctrl + O, затемEnter
# URL для подключения к основной базе данных
DATABASE_URL="postgresql+psycopg2://dbuser:securepass123@192.168.1.100:5432/main_db"
# URL для подключения к тестовой базе данных
TEST_DATABASE_URL="postgresql+psycopg2://dbuser:securepass123@192.168.1.100:5432/test_db"
# Секретный ключ для подписи JWT-токенов
SECRET_KEY=my-super-secret-key-987654321
# Параметры подключения к PostgreSQL
PG_HOST="192.168.1.100"
PG_DB="main_db"
PG_PORT="5432"
PG_USER="dbuser"
PG_PASSWORD="securepass123"
docker network create auth-network
docker run -d \
--name auth-postgres \
--network auth-network \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=P@ssw0rd \
-e POSTGRES_DB=auth_db \
-p 5432:5432 \
postgres:latest
docker run -d \
--name pgadmin \
--network auth-network \
-e PGADMIN_DEFAULT_EMAIL=admin@admin.com \
-e PGADMIN_DEFAULT_PASSWORD=1234 \
-p 8080:80 \
dpage/pgadmin4
docker ps
alembic upgrade head
pytest tests -v
uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
--host 0.0.0.0 разрешает подключения со всех интерфейсов
--port 8000 явное указание порта
- Создайте форк репозитория.
- Создайте ветку:
git checkout -b feature/новая-фича. - Сделайте коммиты с понятными сообщениями (например,
feat: добавлена новая фича). - Отправьте PR в ветку
devс описанием изменений. - Убедитесь, что CI проходит успешно.
uv add requests