Files
mtusi2026lab3/openspec/specs/users/spec.md
T
ricoromaandClaude Opus 5.5 af4bca08c9 feat: carry lab 2 over and add X-Instance-Id and idempotency keys
- carry the lab 2 solution over and plan lab 3 (PLAN.md, OpenSpec
  change instance-id-idempotency)
- rename the compose project to mtusi-lab3 and the image to :lab3
- add X-Instance-Id to every response and instance_id to every log
  record ([app] instance_id, hostname by default)
- require Idempotency-Key on POST messages: keys table in Postgres,
  key and message in one transaction, replay returns the same 201,
  another body gets 409, TTL from [idempotency] ttl_seconds
- send the key from student-tests, k6 scenarios and the skill driver;
  add idempotency, X-Instance-Id, key race and fault tests

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 19:42:36 +03:00

131 lines
5.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# users Specification
## Purpose
Регистрация пользователей мессенджера и получение текущего
пользователя. Пользователь — участник чатов и отправитель сообщений.
## Requirements
### Requirement: Регистрация пользователя
`POST /api/v1/users` SHALL быть публичным и принимать тело
`{"username": ..., "display_name": ..., "password": ...}`. При успехе
сервис SHALL отвечать 201 с объектом `User`: `id`, `username`,
`display_name`, `created_at`, без других полей: пароля и его хэша в
ответе нет. `id` и `created_at` назначает сервер.
#### Scenario: Успешная регистрация
- **WHEN** клиент отправляет `{"username": "alice", "display_name":
"Алиса", "password": ...}` с допустимым паролем
- **THEN** ответ 201, `username` и `display_name` совпадают с
отправленными, `id` — новый UUID, полей кроме четырёх полей `User` нет
### Requirement: Формат username
`username` SHALL целиком соответствовать `^[a-z0-9_]{3,32}$`. Иначе
сервис SHALL отвечать 400 `invalid_request`.
#### Scenario: Заглавные буквы
- **WHEN** `username` равен `Alice`
- **THEN** ответ 400
#### Scenario: Слишком короткий
- **WHEN** `username` равен `ab`
- **THEN** ответ 400
#### Scenario: Перевод строки в конце
- **WHEN** `username` равен `"alice\n"`
- **THEN** ответ 400
### Requirement: Формат display_name
`display_name` SHALL содержать от 1 до 100 Unicode code points и MUST
NOT состоять только из пробельных символов. Значение SHALL сохраняться
без изменений, в том числе без обрезки пробелов.
#### Scenario: Граница длины
- **WHEN** `display_name` из 100 code points, затем из 101
- **THEN** первый запрос даёт 201, второй — 400
#### Scenario: Только пробелы
- **WHEN** `display_name` равен `" "`
- **THEN** ответ 400
### Requirement: Формат пароля
`password` SHALL содержать от 12 до 128 Unicode code points и MUST NOT
состоять только из пробельных символов. Допустимы любые символы
Unicode, в том числе `:`. Значение SHALL использоваться без изменений:
без обрезки, нормализации и усечения по байтам. Иначе сервис SHALL
отвечать 400 `invalid_request`.
#### Scenario: Нет пароля
- **WHEN** тело регистрации не содержит `password`
- **THEN** ответ 400
#### Scenario: Граница длины пароля
- **WHEN** `password` из 11 code points, затем из 12, из 128 и из 129
- **THEN** первый и последний запросы дают 400, остальные — 201
#### Scenario: Пароль из пробелов
- **WHEN** `password` из 12 пробелов
- **THEN** ответ 400
#### Scenario: Длинный пароль в UTF-8 целиком
- **WHEN** пользователь зарегистрировался с паролем из 128 кириллических
символов, затем входит с паролем, где изменён только последний символ
- **THEN** вход отклонён 401: пароль сравнивается целиком, а не по
первым байтам
### Requirement: Пароль хранится только хэшем
Сервис SHALL хранить пароль только как результат библиотечного password
KDF с солью. Пароль MUST NOT храниться в открытом виде или как быстрый
хэш (SHA-256 и подобные) и MUST NOT попадать в ответы API и журнал.
#### Scenario: Хэш в БД
- **WHEN** пользователь зарегистрирован с паролем P
- **THEN** в его строке в PostgreSQL нет P, а хранимое значение — строка
KDF с параметрами и солью; у двух пользователей с одинаковым паролем
хранимые значения разные
### Requirement: Уникальность username
`username` SHALL быть уникальным. Повторная регистрация занятого
`username` SHALL давать 409 с `code` `conflict`. При одновременной
регистрации одного `username` несколькими клиентами MUST успешно
завершиться ровно одна.
#### Scenario: Повтор username
- **WHEN** клиент повторно регистрирует уже занятый `username`
- **THEN** ответ 409 с `code` `conflict`
#### Scenario: Одновременная регистрация
- **WHEN** 10 клиентов одновременно регистрируют одинаковый `username`
- **THEN** ровно один получает 201, остальные — 409
### Requirement: Текущий пользователь
`GET /api/v1/users/me` SHALL возвращать 200 с объектом `User` владельца
сессии, чей токен передан (capability `identification`).
#### Scenario: Совпадает с регистрацией
- **WHEN** пользователь запрашивает `GET /api/v1/users/me` со своим
токеном
- **THEN** тело ответа равно телу ответа на его регистрацию