> ## 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.

# Collection Tokens

`tokens` lưu các token dùng một lần: bí mật trong một liên kết cho phép ai đó đặt mật khẩu. Mỗi document là một token. Không có model Mongoose; web ghi vào collection qua `services/web/app/src/Features/Security/OneTimeTokenHandler.mjs` bằng driver gốc.

#### Các trường

| Trường | Kiểu | Ý nghĩa | Nguồn |
| - | - | - | - |
| `_id` | ObjectId | Id document. | `OneTimeTokenHandler.mjs:40` |
| `use` | String | Token dùng để làm gì, xem [Mục đích sử dụng](#uses) bên dưới. Mọi truy vấn đều lọc theo trường này. | `OneTimeTokenHandler.mjs:41` |
| `token` | String | Bí mật trong liên kết: 32 byte ngẫu nhiên dưới dạng 64 ký tự hex, lưu nguyên dạng. | `OneTimeTokenHandler.mjs:38,42` |
| `data` | Object | Những gì token đại diện, được trả về khi token được dùng. | `OneTimeTokenHandler.mjs:43` |
| `data.user_id` | String | Id người dùng, mọi nơi gọi đều ghi dưới dạng chuỗi. | `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 của người dùng khi token được tạo. Việc đặt lại mật khẩu tìm người dùng theo email chính này (`PasswordResetHandler.mjs:66-70`). | giống `data.user_id` |
| `createdAt` | Date | Thời điểm tạo. Chỉ mục TTL xóa token sau 90 ngày. | `OneTimeTokenHandler.mjs:36,44` |
| `expiresAt` | Date | `createdAt` cộng `expiresIn` giây: mặc định 1 giờ, 1 tuần với liên kết kích hoạt. Sau thời điểm này các truy vấn bỏ qua token. | `OneTimeTokenHandler.mjs:35-37,45` |
| `peekCount` | Number | Số lần token được xem mà không được dùng. Mỗi `peekValueFromToken` cộng 1; khi đạt 4 (`MAX_PEEKS`) token ngừng hoạt động. | `OneTimeTokenHandler.mjs:8-31,107` |
| `usedAt` | Date | Thời điểm token được dùng hoặc bị hủy. Các truy vấn bỏ qua token có trường này. | `OneTimeTokenHandler.mjs:51-104` |

#### Mục đích sử dụng

| `use` | Tính năng | Hết hạn | Mã |
| - | - | - | - |
| `password` | Email đặt lại mật khẩu, từ trang "quên mật khẩu" | 1 giờ | `PasswordResetHandler.mjs:14-42` |
| `password` | Liên kết kích hoạt: tài khoản được tạo với mật khẩu ngẫu nhiên, sau đó là liên kết để đặt mật khẩu. Được dùng bởi đăng ký công khai (`services/web/modules/login-register/app/src/RegisterController.mjs:65`), trang đăng ký của quản trị viên trong `user-activate` (`services/web/modules/user-activate/app/src/UserActivateController.mjs:27-30`) và script `create-user` (`services/web/modules/server-ce-scripts/scripts/create-user.mjs:21`) | 1 tuần | `UserRegistrationHandler.mjs:97-130` |
| `password` | Liên kết kích hoạt hoặc đặt lại mật khẩu gửi từ bảng quản trị (module `admin-tools`) | 1 tuần (kích hoạt), 1 giờ (đặt lại) | `AdminUserManager.mjs:76-103,196-206` |
| `email_confirmation` | Liên kết xác nhận email. Chỉ được đọc: không còn gì trong repo này tạo loại token này, vì việc xác nhận hiện gửi mã 6 chữ số (`services/web/app/src/Features/User/UserEmailsConfirmationHandler.mjs:15-35`) | | `UserEmailsConfirmationHandler.mjs:12,37-66` |

#### Ai ghi

| Mã | Chức năng |
| - | - |
| `OneTimeTokenHandler.mjs:34-49` (`getNewToken`) | Chèn một token. Nơi gọi: `PasswordResetHandler.mjs:28`, `UserRegistrationHandler.mjs:115-119`, `AdminUserManager.mjs:77-81`. |
| `OneTimeTokenHandler.mjs:8-32` (`peekValueFromToken`) | Trả về `data` của token hợp lệ và cộng 1 vào `peekCount`. Được dùng khi mở trang đặt lại mật khẩu (`services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208`), lần nữa khi đặt mật khẩu mới (`PasswordResetHandler.mjs:94-96`), và khi xác nhận email (`UserEmailsConfirmationHandler.mjs:38-41`). |
| `OneTimeTokenHandler.mjs:75-88` (`expireToken`) | Đặt `usedAt` cho một token: sau khi đặt mật khẩu mới (`PasswordResetHandler.mjs:44-48,119`) hoặc xác nhận email (`UserEmailsConfirmationHandler.mjs:65`). |
| `OneTimeTokenHandler.mjs:90-104` (`expireAllTokensForUser`) | Đặt `usedAt` cho mọi token `password` còn mở của người dùng, khi người dùng đổi mật khẩu trong phần cài đặt (`services/web/app/src/Features/User/UserController.mjs:146-149`) hoặc quản trị viên đặt nó trong bảng quản trị (`AdminUserManager.mjs:479-488`). |

#### Ai đọc

| Mã | Chức năng |
| - | - |
| `PasswordResetHandler.mjs:50-70,94-119` | Từ token đặt lại hoặc kích hoạt tìm ra người dùng, rồi đặt mật khẩu. Trang kích hoạt của `user-activate` chỉ chuyển token sang biểu mẫu này. |
| `UserEmailsConfirmationHandler.mjs:37-66` | Xác nhận email từ token `email_confirmation` của người dùng đang đăng nhập. |
| `AdminUserManager.mjs:213-223` (module `admin-tools`) | Tìm token kích hoạt còn mở của người dùng để hiển thị lại liên kết kích hoạt trong bảng quản trị. Đọc trực tiếp `db.tokens`. |

#### Chỉ mục

| Tên | Khóa | Tùy chọn | Migration |
| - | - | - | - |
| `token_1_use_1` | `{ token: 1, use: 1 }` | duy nhất | `20190912145031_create_tokens_indexes.mjs` |
| `createdAt_1` | `{ createdAt: 1 }` | TTL, `expireAfterSeconds: 7776000` (90 ngày) | `20210407085118_token-expiry-with-ttl-index.mjs` |
| `data.user_id_1` | `{ "data.user_id": 1 }` | | `20231113173237_tokens_user_id_index.mjs` |

Các migration nằm trong `tools/migrations/`.

#### Ghi chú

* Token đã dùng hoặc hết hạn không bị xóa ngay: nó vẫn còn, với `usedAt` hoặc `expiresAt` đã qua, cho tới khi chỉ mục TTL xóa nó sau `createdAt` 90 ngày.
* `OneTimeTokenHandler` còn có `getValueFromTokenAndExpire` (`OneTimeTokenHandler.mjs:51-73`), nhưng không có gì gọi nó.


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