diff --git a/REPORT.md b/REPORT.md index 6d8a14de..0a06b471 100644 --- a/REPORT.md +++ b/REPORT.md @@ -1,8 +1,8 @@ # Отчёт — лабораторная 2 - Автор, группа: Стругов Максим БПИ2303 -- Целевая оценка **4** -- Использованные источники, библиотеки и помощь ИИ: контракт курса (`contracts/openapi.json`, `contracts/README.md`, `contracts/infrastructure.json`); реализация написана с помощью Claude (Anthropic); библиотеки — `github.com/jackc/pgx/v5` + `pgxpool` (драйвер и пул соединений PostgreSQL — выбран как актуальный, активно поддерживаемый драйвер с нативным пулом и поддержкой PostgreSQL-типов, рекомендуемый в официальном Go PostgreSQL wiki), `github.com/golang-migrate/migrate/v4` (миграции — стандартный, широко используемый инструмент), `github.com/redis/go-redis/v9`, `golang.org/x/crypto/argon2` (KDF паролей). Миграции хранятся как `.sql`-файлы, встроенные в бинарь через `//go:embed` (источник `iofs` для `golang-migrate`) — это не свой раннер, просто способ доставки файлов миграций без зависимости от файловой системы хоста. +- Целевая оценка: **4** +- Использованные источники, библиотеки и помощь ИИ: контракт курса (`contracts/openapi.json`, `contracts/README.md`, `contracts/infrastructure.json`); реализация написана с помощью Claude (Anthropic); библиотеки — `github.com/jackc/pgx/v5` + `pgxpool` (драйвер и пул соединений PostgreSQL — выбран как актуальный, активно поддерживаемый драйвер с нативным пулом и поддержкой PostgreSQL-типов, рекомендуемый в официальном Go PostgreSQL wiki), `github.com/golang-migrate/migrate/v4` (миграции — стандартный, широко используемый инструмент, а не самодельное решение), `github.com/redis/go-redis/v9`, `golang.org/x/crypto/argon2` (KDF паролей). Миграции хранятся как `.sql`-файлы, встроенные в бинарь через `//go:embed` (источник `iofs` для `golang-migrate`) — это не свой раннер, просто способ доставки файлов миграций без зависимости от файловой системы хоста. ## Запуск из чистого clone @@ -67,11 +67,11 @@ Prerequisites: Docker + Docker Compose v2. | Схема/индексы спроектированы до запросов | — | Все таблицы, constraint'ы, индексы и транзакционные границы описаны и обоснованы заранее | `db/README.md` | | PostgreSQL вместо in-memory, параметризованные запросы, пул соединений с таймаутами | — | Все запросы через `$N`-параметры (`pgx/v5`); `pgxpool.Config.MaxConns`/`MinConns`/`MaxConnLifetime`/`MaxConnIdleTime`; `context.WithTimeout` на каждый вызов; `go vet`/`gofmt -l` чисто | `src/db.go`, `src/store.go` | | Пароли — библиотечный KDF, не SHA-256/plaintext | — | Argon2id, самоописывающийся формат хэша (`$argon2id$v=...$m=...,t=...,p=...$salt$hash`), `crypto/subtle.ConstantTimeCompare` при проверке | `src/auth.go` | -| Сессии: Basic-логин → Bearer, logout, TTL из `SESSION_TTL_SECONDS` | `go test -race -count=1 ./...` → `ok messenger 41.458s` | Покрыто тестами входа/выхода/истечения/неверного пароля | `src/api_test.go` | +| Сессии: Basic-логин → Bearer, logout, TTL из `SESSION_TTL_SECONDS` | `go test -race -count=1 ./...` → `ok messenger 24.439s` (последний прогон после всех исправлений) | Покрыто тестами входа/выхода/истечения/неверного пароля | `src/api_test.go` | | Redis как кэш сессий (уровень 4) | `go test` | `TestSessionCacheHitMatchesDatabase`, `TestSessionCacheInvalidatedOnLogout` — пройдены | `src/api_test.go`, `src/cache.go` | | Устойчивость к падению Redis (уровень 4) | `go test` | `TestSessionValidationSurvivesRedisOutage` — действительная сессия продолжает проверяться напрямую в Postgres, Redis-ошибка никогда не трактуется как «сессия валидна» | `src/api_test.go` | | Устойчивость к падению Postgres | `go test` | `TestReadyAndAuthReturnUnavailableWhenPostgresDown` — `/health/ready` и защищённые endpoint отдают `503`, а не ложный `200`/анонимный доступ | `src/api_test.go` | -| Отзыв токена при отказе Redis | `go test` | `TestRevokedTokenRejectedWhenRedisDelFails` (ACL `-del`: надгробие), `TestRevokedTokenRejectedWhenRedisDelAndSetFail` (ACL `-del -set`: локальный deny-list): после logout чтение истории, `GET /users/me` и отправка сообщения → `401` | `src/api_test.go`, `src/cache.go`, `src/store.go` | +| Отзыв токена при отказе Redis | `go test` | `TestRevokedTokenRejectedWhenRedisDelFails` (ACL `-del`: надгробие), `TestRevokedTokenRejectedWhenRedisDelAndSetFail` (ACL `-del -set`: локальный deny-list), `TestRevokedTokenStaysRevokedAfterAPIRestart` (права Redis возвращены, перезапущен только API → сверка при старте), `TestRevokedTokenStaysRevokedAfterRestartWhileRedisStillDenies` (рестарт при всё ещё запрещённых `DEL`/`SET` → deny-list из PostgreSQL): после logout чтение истории, `GET /users/me` и отправка сообщения → `401` | `src/api_test.go`, `src/cache.go`, `src/store.go` | | Отказ PostgreSQL при прогретой сессии | `go test` | `TestPostgresDownWithWarmSessionReturns503`: история, отправка, список чатов, `GET /chats/{id}` и вход (Basic) → `503 unavailable`, не `404`/`500`; анонимного доступа нет | `src/api_test.go`, `src/handlers.go` | | Race на регистрацию username (уровень 4) | `go test -race` | 10 конкурентных регистраций одного username → ровно одна `201`, остальные `409` (защита на `UNIQUE INDEX`, не app-level) | `src/api_test.go` | | Атомарность создания чата + rollback на неизвестного участника (уровень 4) | `go test` | Прямой `SELECT count(*) FROM chats WHERE title = $1` в общей тестовой БД подтверждает: при неизвестном `member_id` чат не создаётся вообще | `src/api_test.go` | @@ -90,13 +90,13 @@ Prerequisites: Docker + Docker Compose v2. | 10 параллельных регистраций одного username | Ровно одна `201`, остальные `409` | Подтверждено (race-тест, `-race` чист) | — | | Полный `docker compose down && up` (без `-v`) | Пользователи/чаты/сообщения/валидные сессии на месте; TTL сессии не продлён рестартом | Подтверждено: `make test-persistence` с хуком `scripts/restart.sh` — `PASS` | Потери данных нет; время восстановления не замерялось | -Условия всех прогонов: локальный PostgreSQL 16 и Redis 7, без искусственной конкурентной нагрузки на сам сервер (цель — корректность поведения при сбое зависимости, не пропускная способность). `go test -race -count=1 ./...` → `ok messenger 41.458s`, `go vet ./...` и `gofmt -l .` — чисто. +Условия всех прогонов: локальный PostgreSQL 16 и Redis 7, без искусственной конкурентной нагрузки на сам сервер (цель — корректность поведения при сбое зависимости, не пропускная способность). `go test -race -count=1 ./...` → `ok messenger 24.439s` (последний прогон после всех исправлений), `go vet ./...` и `gofmt -l .` — чисто. ## Ограничения и следующие шаги **Выдерживается:** race на регистрацию username; атомарность создания чата с rollback; деградация при падении Redis (без ложного "valid") и при падении Postgres (503, не анонимный доступ); персистентность данных на уровне схемы (обычные таблицы в volume, не in-memory структуры). -**Отзыв токена не зависит от успеха операций с Redis.** Порядок logout: (1) `revoked_at` в PostgreSQL (источник истины); (2) инвалидация кэша — `DEL`; если `DEL` не прошёл (отказ связи, ACL `-del`) — запись заменяется «надгробием» (`revoked=true`) обычным `SET`, и чтение, увидев надгробие, не доверяет кэшу, а идёт в PostgreSQL; (3) если не прошёл и `SET` — токен попадает в локальный in-memory deny-list `Store` и отклоняется с `401` до конца срока сессии. Дополнительно TTL записи кэша ограничен `min(остаток сессии, 1 минута)`, поэтому даже при отказе всех трёх шагов (другая реплика с тем же Redis) окно устаревания не превышает минуту. Прежняя формулировка «осознанного ограничения» (отозванный токен может отвечать из кэша) снята: она была ошибкой, проверяющий воспроизвёл её сценарием `ACL SETUSER default -del`. +**Отзыв токена не зависит от успеха операций с Redis.** Порядок logout: (1) `revoked_at` в PostgreSQL (источник истины); (2) инвалидация кэша — `DEL`; если `DEL` не прошёл (отказ связи, ACL `-del`) — запись заменяется «надгробием» (`revoked=true`) обычным `SET`, и чтение, увидев надгробие, не доверяет кэшу, а идёт в PostgreSQL; (3) если не прошёл и `SET` — токен попадает в локальный in-memory deny-list `Store` и отклоняется с `401` до конца срока сессии; (4) deny-list и надгробия не переживают рестарт процесса, а запись в Redis, которую не удалось инвалидировать, переживает — поэтому при старте API, до приёма запросов, `Store.ReconcileRevoked` читает из PostgreSQL все отозванные и ещё не истёкшие сессии (`revoked_at IS NOT NULL AND expires_at > now()`) и повторяет для них инвалидацию кэша (`DEL` → надгробие → deny-list уже из БД). Ошибка чтения из PostgreSQL на этом шаге фатальна для старта. Дополнительно TTL записи кэша ограничен `min(остаток сессии, 1 минута)`, поэтому даже при отказе всех трёх шагов (другая реплика с тем же Redis) окно устаревания не превышает минуту. Прежняя формулировка «осознанного ограничения» (отозванный токен может отвечать из кэша) снята: она была ошибкой, проверяющий воспроизвёл её сценарием `ACL SETUSER default -del`. **Остаточный риск, который остаётся:** гонка «запрос прочитал валидную сессию из PostgreSQL → параллельный logout отозвал и инвалидировал кэш → запрос записал в кэш устаревшую запись». Её окно ограничено `cacheMaxTTL` (1 минута), надгробие её не закрывает. diff --git a/evidence/manual_revocation_restart.txt b/evidence/manual_revocation_restart.txt new file mode 100644 index 00000000..f630d082 --- /dev/null +++ b/evidence/manual_revocation_restart.txt @@ -0,0 +1,5 @@ +Сценарий: логин -> прогрев кэша -> ACL SETUSER default -del -set -> logout -> ACL SETUSER default +del +set -> docker compose restart api -> тот же токен + +GET /users/me до logout: 200 +DELETE /auth/sessions/current: 204 +GET /users/me после restart api: 401 diff --git a/src/api_test.go b/src/api_test.go index 131ee95e..ea669527 100644 --- a/src/api_test.go +++ b/src/api_test.go @@ -876,7 +876,7 @@ func TestEmptyListsAreJSONArraysNotNull(t *testing.T) { // denyRedisCommands запрещает команды default-пользователю Redis (как в // сценарии проверяющего: ACL SETUSER default -del) и возвращает их при Cleanup. -func denyRedisCommands(t *testing.T, e *testEnv, cmds ...string) { +func denyRedisCommands(t *testing.T, e *testEnv, cmds ...string) (restore func()) { t.Helper() addr := os.Getenv("TEST_CACHE_URL") if addr == "" { @@ -888,18 +888,20 @@ func denyRedisCommands(t *testing.T, e *testEnv, cmds ...string) { } admin := redis.NewClient(opt) args := []any{"ACL", "SETUSER", "default"} - restore := []any{"ACL", "SETUSER", "default"} + back := []any{"ACL", "SETUSER", "default"} for _, c := range cmds { args = append(args, "-"+c) - restore = append(restore, "+"+c) + back = append(back, "+"+c) } if err := admin.Do(context.Background(), args...).Err(); err != nil { t.Fatalf("ACL SETUSER: %v", err) } + restore = func() { admin.Do(context.Background(), back...) } t.Cleanup(func() { - admin.Do(context.Background(), restore...) + restore() admin.Close() }) + return restore } func assertRevoked(t *testing.T, e *testEnv, a actor, chatID string) { @@ -984,3 +986,66 @@ func TestPostgresDownWithWarmSessionReturns503(t *testing.T) { t.Fatalf("вход при недоступной БД: статус %d, ожидали 503", status) } } + +// restartedAPI имитирует `docker compose restart api` при работающих +// PostgreSQL и Redis: новый Store (пустой deny-list в памяти) над теми же +// БД и Redis, со сверкой отозванных сессий при старте, как в main(). +func restartedAPI(t *testing.T) *testEnv { + t.Helper() + addr := os.Getenv("TEST_CACHE_URL") + if addr == "" { + addr = "redis://localhost:6379/0" + } + cache, err := newSessionCache(addr) + if err != nil { + t.Fatal(err) + } + t.Cleanup(func() { cache.Close() }) + store := NewStore(sharedDB, cache, time.Hour) + if err := store.ReconcileRevoked(context.Background()); err != nil { + t.Fatalf("ReconcileRevoked: %v", err) + } + srv := httptest.NewServer((&api{store: store}).routes()) + t.Cleanup(srv.Close) + return &testEnv{t: t, url: srv.URL} +} + +// Сценарий проверяющего: DEL и SET запрещены, logout -> 204, права +// возвращены, перезапуск ТОЛЬКО API (PostgreSQL и Redis живы). Старая запись +// осталась в Redis, но отозванный токен обязан получать 401. +func TestRevokedTokenStaysRevokedAfterAPIRestart(t *testing.T) { + e := newTestEnvWithCache(t) + alice := e.mustActor("alice") + c := e.mustChat(alice, "Чат") + e.expectJSON(http.StatusOK, &User{}, "GET", "/api/v1/users/me", alice.token, nil) // прогрев кэша + + restore := denyRedisCommands(t, e, "del", "set") + status, _, _ := e.do("DELETE", "/api/v1/auth/sessions/current", alice.token, nil) + if status != http.StatusNoContent { + t.Fatalf("logout: статус %d", status) + } + assertRevoked(t, e, alice, c.ID) // до рестарта — 401 (локальный deny-list) + restore() + + after := restartedAPI(t) + assertRevoked(t, after, alice, c.ID) +} + +// Тот же рестарт, но права Redis так и не вернули: при старте нельзя ни +// удалить запись, ни поставить надгробие — токен закрывается deny-list'ом, +// собранным из PostgreSQL. +func TestRevokedTokenStaysRevokedAfterRestartWhileRedisStillDenies(t *testing.T) { + e := newTestEnvWithCache(t) + alice := e.mustActor("alice") + c := e.mustChat(alice, "Чат") + e.expectJSON(http.StatusOK, &User{}, "GET", "/api/v1/users/me", alice.token, nil) + + denyRedisCommands(t, e, "del", "set") + status, _, _ := e.do("DELETE", "/api/v1/auth/sessions/current", alice.token, nil) + if status != http.StatusNoContent { + t.Fatalf("logout: статус %d", status) + } + + after := restartedAPI(t) // права Redis всё ещё запрещены + assertRevoked(t, after, alice, c.ID) +} \ No newline at end of file diff --git a/src/main.go b/src/main.go index b2134f4e..92f2793a 100644 --- a/src/main.go +++ b/src/main.go @@ -112,6 +112,16 @@ func main() { store := NewStore(db, cache, time.Duration(ttlSeconds)*time.Second) + // Отзыв токена должен переживать рестарт API: до приёма запросов + // повторяем инвалидацию кэша для всех отозванных, но не истёкших сессий. + rctx, rcancel := context.WithTimeout(context.Background(), 30*time.Second) + if err := store.ReconcileRevoked(rctx); err != nil { + rcancel() + slog.Error("не удалось сверить отозванные сессии с кэшем", "err", err) + os.Exit(1) + } + rcancel() + srv := &http.Server{ Addr: net.JoinHostPort(host, port), Handler: (&api{store: store}).routes(), @@ -148,4 +158,4 @@ func main() { srv.Close() } slog.Info("stopped") -} +} \ No newline at end of file diff --git a/src/store.go b/src/store.go index 50559f6a..39847baa 100644 --- a/src/store.go +++ b/src/store.go @@ -4,6 +4,7 @@ import ( "context" "encoding/base64" "errors" + "log/slog" "strings" "sync" "time" @@ -495,6 +496,51 @@ func (s *Store) denyLocally(hash []byte, until time.Time) { s.revoked.Store(string(hash), until) } +// ReconcileRevoked вызывается при старте процесса, ДО приёма запросов. +// Локальный deny-list и надгробия живут недолго или только в памяти и не +// переживают рестарт API, а запись в Redis, которую logout не смог +// инвалидировать, — переживает. Источник истины об отзыве — Postgres +// (revoked_at), поэтому для каждой отозванной и ещё не истёкшей сессии +// повторяем инвалидацию кэша; если Redis по-прежнему не даёт ни DEL, ни +// SET — токен заносится в локальный deny-list уже из БД. Ошибка чтения из +// Postgres фатальна для старта: без неё нельзя гарантировать, что отозванный +// токен не оживёт из кэша. +func (s *Store) ReconcileRevoked(ctx context.Context) error { + if s.cache == nil { + return nil + } + rows, err := s.db.Query(ctx, + `SELECT token_hash, expires_at FROM sessions + WHERE revoked_at IS NOT NULL AND expires_at > now()`) + if err != nil { + return err + } + type revokedSession struct { + hash []byte + expiresAt time.Time + } + var revoked []revokedSession + for rows.Next() { + var r revokedSession + if err := rows.Scan(&r.hash, &r.expiresAt); err != nil { + rows.Close() + return err + } + revoked = append(revoked, r) + } + rows.Close() // освобождаем соединение до походов в Redis + if err := rows.Err(); err != nil { + return err + } + for _, r := range revoked { + if !s.cache.invalidate(ctx, r.hash, time.Until(r.expiresAt)) { + s.denyLocally(r.hash, r.expiresAt) + } + } + slog.Info("отозванные сессии сверены с кэшем", "count", len(revoked)) + return nil +} + func (s *Store) locallyRevoked(hash []byte) bool { v, ok := s.revoked.Load(string(hash)) if !ok { @@ -546,4 +592,4 @@ func decodeCursor(scope, raw string) (*pos, bool) { return nil, false } return &pos{ts: parts[1], id: parts[2]}, true -} +} \ No newline at end of file