> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Коллекция Tokens

`tokens` хранит одноразовые токены: секрет в ссылке, по которой можно задать пароль. Один документ соответствует одному токену. Модели Mongoose нет; web пишет в коллекцию через `services/web/app/src/Features/Security/OneTimeTokenHandler.mjs` нативным драйвером.

#### Поля

| Поле | Тип | Значение | Источник |
| - | - | - | - |
| `_id` | ObjectId | Id документа. | `OneTimeTokenHandler.mjs:40` |
| `use` | String | Назначение токена, см. [Назначения](#uses) ниже. Каждый поиск фильтрует по нему. | `OneTimeTokenHandler.mjs:41` |
| `token` | String | Секрет в ссылке: 32 случайных байта в виде 64 шестнадцатеричных символов, хранится как есть. | `OneTimeTokenHandler.mjs:38,42` |
| `data` | Object | То, что представляет токен; возвращается при его использовании. | `OneTimeTokenHandler.mjs:43` |
| `data.user_id` | String | Id пользователя, каждый вызывающий код записывает его строкой. | `services/web/app/src/Features/PasswordReset/PasswordResetHandler.mjs:27`, `services/web/app/src/Features/User/UserRegistrationHandler.mjs:117`, `services/web/modules/admin-tools/app/src/AdminUserManager.mjs:79` |
| `data.email` | String | Email пользователя на момент создания токена. Сброс пароля ищет пользователя по этому основному email (`PasswordResetHandler.mjs:66-70`). | как у `data.user_id` |
| `createdAt` | Date | Время создания. TTL-индекс удаляет токен через 90 дней. | `OneTimeTokenHandler.mjs:36,44` |
| `expiresAt` | Date | `createdAt` плюс `expiresIn` секунд: по умолчанию 1 час, 1 неделя для ссылки активации. После этого поиски игнорируют токен. | `OneTimeTokenHandler.mjs:35-37,45` |
| `peekCount` | Number | Сколько раз токен просматривали, не используя. Каждый `peekValueFromToken` прибавляет 1; при 4 (`MAX_PEEKS`) токен перестаёт работать. | `OneTimeTokenHandler.mjs:8-31,107` |
| `usedAt` | Date | Время, когда токен был использован или отменён. Поиски игнорируют токен с этим полем. | `OneTimeTokenHandler.mjs:51-104` |

#### Назначения

| `use` | Функция | Срок действия | Код |
| - | - | - | - |
| `password` | Письмо для сброса пароля со страницы «Забыли пароль» | 1 час | `PasswordResetHandler.mjs:14-42` |
| `password` | Ссылка активации: аккаунт создаётся со случайным паролем, затем приходит ссылка, чтобы задать свой. Используется публичной регистрацией (`services/web/modules/login-register/app/src/RegisterController.mjs:65`), страницей регистрации администратором из `user-activate` (`services/web/modules/user-activate/app/src/UserActivateController.mjs:27-30`) и скриптом `create-user` (`services/web/modules/server-ce-scripts/scripts/create-user.mjs:21`) | 1 неделя | `UserRegistrationHandler.mjs:97-130` |
| `password` | Ссылка активации или сброса пароля, отправленная из панели администратора (модуль `admin-tools`) | 1 неделя (активация), 1 час (сброс) | `AdminUserManager.mjs:76-103,196-206` |
| `email_confirmation` | Ссылка подтверждения email. Только читается: ничто в этом репозитории больше не создаёт такие токены, так как подтверждение теперь отправляет 6-значный код (`services/web/app/src/Features/User/UserEmailsConfirmationHandler.mjs:15-35`) | | `UserEmailsConfirmationHandler.mjs:12,37-66` |

#### Кто пишет

| Код | Что делает |
| - | - |
| `OneTimeTokenHandler.mjs:34-49` (`getNewToken`) | Вставляет токен. Вызывающие: `PasswordResetHandler.mjs:28`, `UserRegistrationHandler.mjs:115-119`, `AdminUserManager.mjs:77-81`. |
| `OneTimeTokenHandler.mjs:8-32` (`peekValueFromToken`) | Возвращает `data` действительного токена и прибавляет 1 к `peekCount`. Используется при открытии страницы сброса пароля (`services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208`), повторно при установке нового пароля (`PasswordResetHandler.mjs:94-96`) и при подтверждении email (`UserEmailsConfirmationHandler.mjs:38-41`). |
| `OneTimeTokenHandler.mjs:75-88` (`expireToken`) | Устанавливает `usedAt` у одного токена: после установки нового пароля (`PasswordResetHandler.mjs:44-48,119`) или подтверждения email (`UserEmailsConfirmationHandler.mjs:65`). |
| `OneTimeTokenHandler.mjs:90-104` (`expireAllTokensForUser`) | Устанавливает `usedAt` у всех открытых токенов `password` пользователя, когда пользователь меняет пароль в настройках (`services/web/app/src/Features/User/UserController.mjs:146-149`) или администратор задаёт его в панели администратора (`AdminUserManager.mjs:479-488`). |

#### Кто читает

| Код | Что делает |
| - | - |
| `PasswordResetHandler.mjs:50-70,94-119` | По токену сброса или активации находит пользователя, затем задаёт пароль. Страница активации из `user-activate` только передаёт токен в эту форму. |
| `UserEmailsConfirmationHandler.mjs:37-66` | Подтверждает email по токену `email_confirmation` вошедшего пользователя. |
| `AdminUserManager.mjs:213-223` (module `admin-tools`) | Находит открытый токен активации пользователя, чтобы снова показать ссылку активации в панели администратора. Читает `db.tokens` напрямую. |

#### Индексы

| Имя | Ключи | Параметры | Миграция |
| - | - | - | - |
| `token_1_use_1` | `{ token: 1, use: 1 }` | уникальный | `20190912145031_create_tokens_indexes.mjs` |
| `createdAt_1` | `{ createdAt: 1 }` | TTL, `expireAfterSeconds: 7776000` (90 дней) | `20210407085118_token-expiry-with-ttl-index.mjs` |
| `data.user_id_1` | `{ "data.user_id": 1 }` | | `20231113173237_tokens_user_id_index.mjs` |

Миграции находятся в `tools/migrations/`.

#### Примечания

* Использованный или просроченный токен не удаляется сразу: он остаётся с `usedAt` или прошедшим `expiresAt`, пока TTL-индекс не удалит его через 90 дней после `createdAt`.
* В `OneTimeTokenHandler` есть также `getValueFromTokenAndExpire` (`OneTimeTokenHandler.mjs:51-73`), но его никто не вызывает.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.