Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ POSTGRES_USER=pdm
POSTGRES_PASSWORD=pdm
POSTGRES_DB=pdm
POSTGRES_PORT=5432
BACKEND_PORT=8000
FRONTEND_PORT=5173
DATABASE_URL=postgresql+psycopg://pdm:pdm@localhost:5432/pdm
SIMULATOR_WAIT_TIME=30
WORKER_POLL_INTERVAL=30
Expand All @@ -14,3 +16,6 @@ WEATHER_LATITUDE=55.7558
WEATHER_LONGITUDE=37.6173
BOT_TOKEN=
CHAT_ID=
# Required: persistent random signing secret, at least 32 bytes (not a user password).
JWT_SECRET=
JWT_EXPIRE_MINUTES=1440
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ jobs:
working-directory: backend
run: alembic check

- name: Test backend including authorization and physics
working-directory: backend
env:
TEST_DATABASE_URL: postgresql+psycopg://pdm:pdm@localhost:5432/pdm
run: pytest -q

model:
runs-on: ubuntu-latest
timeout-minutes: 10
Expand Down Expand Up @@ -217,6 +223,7 @@ jobs:
echo "RUL_WARNING=75"
echo "RUL_CRITICAL=30"
echo "RUL_CLIP=125"
python3 -c 'import secrets; print("JWT_SECRET=" + secrets.token_urlsafe(48))'
} > .env

- name: Validate docker-compose.yml
Expand All @@ -234,6 +241,22 @@ jobs:
- name: Frontend is served
run: curl -fsS -o /dev/null http://localhost:5173/

- name: Create account for API smoke
run: |
SMOKE_PASSWORD=$(python3 -c 'import secrets; print(secrets.token_urlsafe(24))')
echo "::add-mask::$SMOKE_PASSWORD"
echo "SMOKE_PASSWORD=$SMOKE_PASSWORD" >> "$GITHUB_ENV"
export SMOKE_PASSWORD
docker compose exec -T -e SMOKE_PASSWORD backend python - <<'PYTHON'
import os
from app.core.db import engine
from app.services.auth_service import create_user
with engine.connect() as db:
user = create_user(db, "ci.smoke", os.environ["SMOKE_PASSWORD"])
if user is None:
raise SystemExit("Smoke-test login already exists")
PYTHON

- name: API smoke
run: python3 scripts/api_smoke.py http://localhost:8000 240

Expand Down
61 changes: 59 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,57 @@ api/v1 (эндпоинты, валидация) → services (бизнес-ло

## Контракты API

Все эндпоинты — с префиксом `/api/v1`. Документация OpenAPI: `/docs`.
Ниже указаны пути backend. Frontend обращается к ним через прокси `/api` (например, `/api/auth/login`). Документация OpenAPI backend: `/docs`.

### Авторизация и управление аккаунтами

Публичной регистрации нет. Аккаунты выдаёт администратор; он вручную задаёт логин и постоянный пароль. Почтовая отправка не используется.

- `employee`: оборудование, история, графики, алерты и прогнозирование.
- `admin`: все возможности сотрудника, плюс список аккаунтов, создание сотрудников, сброс их паролей и блокировка/разблокировка.
- Логин: 3–64 символа, латинские буквы, цифры, `.`, `_`, `-`. Пробелы по краям убираются, регистр приводится к нижнему. Уникальность обеспечивает PostgreSQL.
- Новый пароль: от 12 символов, не более 72 байт UTF-8 (лимит bcrypt). Пробелы, регистр и спецсимволы сохраняются. В базе хранится только bcrypt-хеш с индивидуальной солью.
- JWT выдаётся только при входе и действует `JWT_EXPIRE_MINUTES` минут (по умолчанию 1440). Для запуска обязателен постоянный `JWT_SECRET` длиной минимум 32 байта. Он не является паролем пользователя.
- На каждом защищённом запросе backend сверяет пользователя, его состояние и версию токена с базой; административные операции дополнительно проверяют роль. Данные роли из браузера не принимаются.
- Сброс пароля и изменение блокировки увеличивают `token_version`. Старые токены больше не работают, в том числе после разблокировки. Сброс пароля не разблокирует аккаунт.
- Через панель можно изменять только сотрудников. Администратора нельзя заблокировать или изменить его пароль через эти endpoints.
- Лимит входа: 10 попыток на логин и 60 на адрес за 15 минут, включая успешные попытки. Счётчики атомарные, общие для процессов backend в PostgreSQL. Ответ `429` содержит `Retry-After`. Учитывается адрес подключения, не пользовательский `X-Forwarded-For`; за обратным прокси лимит адреса может быть общим для клиентов этого прокси.

| Метод | Путь | Доступ и действие |
| --- | --- | --- |
| POST | `/auth/login` | Публичный вход: `{ "login": "ivan.petrov", "password": "…" }` |
| GET | `/auth/me` | Текущий активный пользователь |
| GET | `/admin/users?limit=50&offset=0` | Администратор: список аккаунтов без паролей и хешей |
| POST | `/admin/users` | Администратор: `{ "login": "ivan.petrov", "password": "…" }`, создаёт только `employee` |
| PUT | `/admin/users/{id}/password` | Администратор: `{ "password": "…" }`, сброс пароля сотрудника и отзыв токенов |
| PUT | `/admin/users/{id}/status` | Администратор: `{ "is_active": false }` для блокировки, `true` для разблокировки |

Остальные рабочие endpoints тоже требуют `Authorization: Bearer <токен>`. Без действующего токена — `401`; сотруднику на административном endpoint — `403`; занятый логин — `409`. `/auth/register` удалён, отвечает `404`.

#### Запуск и первый администратор

1. Скопировать `.env.example` в `.env` и заполнить настройки. Секрет подписи сгенерировать командой `python3 -c "import secrets; print(secrets.token_urlsafe(32))"` и записать в `JWT_SECRET`. Файл `.env` не коммитить.
2. Запустить `docker compose up -d --build db backend frontend`. Backend применит миграции автоматически. Для данных симулятора и расчётов отдельно запустить нужные сервисы проекта.
3. Выполнить `docker compose exec backend python -m app.create_admin`. Вручную ввести логин и дважды пароль (ввод пароля скрыт). Повторение занятого логина не изменяет существующий аккаунт. Команда доступна только имеющему доступ к серверу; не принимает пароль аргументом командной строки.
4. Открыть `http://localhost:5173` (либо порт `FRONTEND_PORT`), войти администратором. В разделе «Пользователи» создать сотрудника и лично передать ему введённые данные.

При локальном запуске без Docker сначала выполнить `alembic upgrade head` из `backend`, затем `python -m app.create_admin` в том же окружении с настроенным `DATABASE_URL` и `JWT_SECRET`.

Миграция `b48a001` следует за миграцией PR #48 `1395cb8114bd`. Она рассчитана на согласованное отсутствие существующих аккаунтов: если `users` не пуста, миграция остановится без удаления данных. Не применять её к базе прежней локальной реализации с другой веткой миграций. Для параллельной проверки использовать отдельную базу/Compose-проект. Порты задаются `POSTGRES_PORT`, `BACKEND_PORT`, `FRONTEND_PORT`.

Для размещения вне локальной разработки требуется HTTPS. В этой версии сохранён способ хранения токена из #48 — localStorage; выход удаляет его из браузера, но сам по себе не отзывает скопированную копию токена. Серверный отзыв выполняется при сбросе пароля или блокировке. Администратор знает вручную заданный пароль сотрудника — это осознанное упрощение учебного проекта, обязательной смены пароля нет.

#### Проверки

Backend-тесты **очищают таблицы**. Указать отдельную тестовую базу:

```bash
cd backend
DATABASE_URL=postgresql+psycopg://pdm:pdm@localhost:5432/offtech_test alembic upgrade head
TEST_DATABASE_URL=postgresql+psycopg://pdm:pdm@localhost:5432/offtech_test pytest -q
```

Тесты задают тестовый ключ JWT самостоятельно. Проверяют обе роли, административные операции, прямой обход UI, блокировку, отзыв токенов, параллельные изменения, валидацию и лимиты входа. Проверка миграций: `alembic check`. Проверка frontend: `cd frontend && npm ci && npm run build`. Эти проверки также добавлены в CI.

### Оборудование

Expand Down Expand Up @@ -228,9 +278,16 @@ erDiagram
varchar severity "info warning critical"
text message
}

users {
int id PK
text email "уникальный, в нижнем регистре"
text password_hash "bcrypt"
timestamp created_at
}
```

Ограничения и индексы: `UNIQUE (dataset, unit_number)` в `equipment`; `UNIQUE (equipment_id, cycle)` в `sensor_readings`, `physics_predictions`, `ml_predictions`; индекс `alerts (equipment_id, triggered_at DESC)`. Показания хранятся широкой таблицей: набор из 14 датчиков фиксирован, так запросы истории не требуют `PIVOT`. Для других наборов (FD002–FD004) добавляются колонки миграцией; полный список датчиков и признак `is_used` лежат в `sensor_catalog`.
Ограничения и индексы: `UNIQUE (dataset, unit_number)` в `equipment`; `UNIQUE (equipment_id, cycle)` в `sensor_readings`, `physics_predictions`, `ml_predictions`; индекс `alerts (equipment_id, triggered_at DESC)`; `UNIQUE (email)` в `users`. Показания хранятся широкой таблицей: набор из 14 датчиков фиксирован, так запросы истории не требуют `PIVOT`. Для других наборов (FD002–FD004) добавляются колонки миграцией; полный список датчиков и признак `is_used` лежат в `sensor_catalog`.

При записи (40 записей/сек) все вставки идут в разные таблицы от фоновых процессов. 40 INSERT/сек — незначительная нагрузка для PostgreSQL.
При чтении (~10-20 RPS) PostgreSQL будет находить строки за O(log n). Проблем не возникнет.
Expand Down
38 changes: 38 additions & 0 deletions backend/alembic/versions/1395cb8114bd_add_users.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
"""add users

Revision ID: 1395cb8114bd
Revises: e74d5734bc65
Create Date: 2026-11-10 23:10:55.971571

"""
from collections.abc import Sequence

import sqlalchemy as sa
from alembic import op

# revision identifiers, used by Alembic.
revision: str = '1395cb8114bd'
down_revision: str | Sequence[str] | None = 'e74d5734bc65'
branch_labels: str | Sequence[str] | None = None
depends_on: str | Sequence[str] | None = None


def upgrade() -> None:
"""Upgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.create_table('users',
sa.Column('id', sa.Integer(), nullable=False),
sa.Column('email', sa.Text(), nullable=False),
sa.Column('password_hash', sa.Text(), nullable=False),
sa.Column('created_at', sa.DateTime(), server_default=sa.text('now()'), nullable=False),
sa.PrimaryKeyConstraint('id'),
sa.UniqueConstraint('email')
)
# ### end Alembic commands ###


def downgrade() -> None:
"""Downgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table('users')
# ### end Alembic commands ###
44 changes: 44 additions & 0 deletions backend/alembic/versions/b48a001_managed_accounts.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
"""Managed accounts: logins, roles, revocable tokens and login throttling.

Revision ID: b48a001
Revises: 1395cb8114bd
"""
import sqlalchemy as sa
from alembic import op

revision = "b48a001"
down_revision = "1395cb8114bd"
branch_labels = None
depends_on = None


def upgrade():
# This deployment has no existing accounts. Do not silently convert real emails.
if op.get_bind().execute(sa.text("SELECT EXISTS (SELECT 1 FROM users)")).scalar():
raise RuntimeError("Managed-account migration requires an empty users table; existing accounts need an explicit migration plan.")
op.drop_constraint("users_email_key", "users", type_="unique")
op.alter_column("users", "email", new_column_name="login", type_=sa.String(64), existing_type=sa.Text())
op.create_unique_constraint("users_login_key", "users", ["login"])
op.add_column("users", sa.Column("role", sa.String(16), nullable=False, server_default="employee"))
op.add_column("users", sa.Column("is_active", sa.Boolean(), nullable=False, server_default=sa.text("true")))
op.add_column("users", sa.Column("token_version", sa.Integer(), nullable=False, server_default="0"))
op.create_check_constraint("users_role_check", "users", "role IN ('admin', 'employee')")
op.create_check_constraint("users_login_check", "users", "login ~ '^[a-z0-9._-]{3,64}$'")
op.create_table("login_attempts",
sa.Column("key", sa.String(64), primary_key=True),
sa.Column("count", sa.Integer(), nullable=False),
sa.Column("expires_at", sa.DateTime(timezone=True), nullable=False),
)
op.create_index("ix_login_attempts_expires_at", "login_attempts", ["expires_at"])


def downgrade():
op.drop_table("login_attempts")
op.drop_constraint("users_login_check", "users", type_="check")
op.drop_constraint("users_role_check", "users", type_="check")
op.drop_column("users", "token_version")
op.drop_column("users", "is_active")
op.drop_column("users", "role")
op.drop_constraint("users_login_key", "users", type_="unique")
op.alter_column("users", "login", new_column_name="email", type_=sa.Text(), existing_type=sa.String(64))
op.create_unique_constraint("users_email_key", "users", ["email"])
50 changes: 50 additions & 0 deletions backend/app/api/auth.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
from typing import Annotated

from fastapi import APIRouter, Depends, HTTPException, Request
from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer

from app.core.db import DB
from app.core.login_throttle import check_login_attempt
from app.core.security import create_token, identity_from_token
from app.schemas.auth import AuthOut, LoginIn, UserOut
from app.services import auth_service

router = APIRouter(prefix="/auth", tags=["Авторизация"])
bearer = HTTPBearer(auto_error=False, description="Токен из /auth/login")
UNAUTHORIZED = {401: {"description": "Требуется действующий токен активного пользователя"}}


def _unauthorized(detail: str) -> HTTPException:
return HTTPException(401, detail, headers={"WWW-Authenticate": "Bearer"})


def get_current_user(db: DB, credentials: Annotated[HTTPAuthorizationCredentials | None, Depends(bearer)]) -> dict:
identity = identity_from_token(credentials.credentials) if credentials else None
user = auth_service.get_user(db, identity[0]) if identity else None
if user is None or not user["is_active"] or user["token_version"] != identity[1]:
raise _unauthorized("Требуется вход в систему")
return user


CurrentUser = Annotated[dict, Depends(get_current_user)]


def require_admin(user: CurrentUser) -> dict:
if user["role"] != "admin":
raise HTTPException(403, "Доступ разрешён только администратору")
return user


@router.post("/login", response_model=AuthOut, responses={**UNAUTHORIZED, 429: {"description": "Лимит попыток входа"}},
summary="Вход по логину и паролю")
def login(body: LoginIn, request: Request, db: DB):
check_login_attempt(request, body.login)
user = auth_service.authenticate(db, body.login, body.password)
if user is None:
raise _unauthorized("Неверный логин или пароль")
return {"access_token": create_token(user["id"], user["token_version"]), "token_type": "bearer", "user": user}


@router.get("/me", response_model=UserOut, responses=UNAUTHORIZED, summary="Текущий пользователь")
def me(user: CurrentUser):
return user
Loading
Loading