tokens には使い捨てトークンが格納されます。これは、誰かがパスワードを設定できるリンクに含まれる秘密の値です。1 つのドキュメントが 1 つのトークンです。Mongoose モデルはなく、web は services/web/app/src/Features/Security/OneTimeTokenHandler.mjs を通じてネイティブドライバーでコレクションに書き込みます。
フィールド
| フィールド | 型 | 意味 | 出典 |
|---|---|---|---|
_id | ObjectId | ドキュメント id。 | OneTimeTokenHandler.mjs:40 |
use | String | トークンの用途。下の用途を参照してください。すべての検索がこれで絞り込みます。 | OneTimeTokenHandler.mjs:41 |
token | String | リンク内の秘密の値。ランダムな 32 バイトを 16 進数 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 | トークン作成時のユーザーのメールアドレス。パスワードのリセットは、このメインのメールアドレスでユーザーを探します(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 | メールアドレスの確認リンク。読み取られるだけです。確認では現在 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 を返し、peekCount に 1 を加えます。パスワードリセットページを開いたとき(services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208)、新しいパスワードを設定するときに再度(PasswordResetHandler.mjs:94-96)、そしてメール確認(UserEmailsConfirmationHandler.mjs:38-41)で使われます。 |
OneTimeTokenHandler.mjs:75-88 (expireToken) | 1 つのトークンに usedAt を設定します。新しいパスワードの設定後(PasswordResetHandler.mjs:44-48,119)またはメールアドレスの確認後(UserEmailsConfirmationHandler.mjs:65)です。 |
OneTimeTokenHandler.mjs:90-104 (expireAllTokensForUser) | ユーザーが設定でパスワードを変更したとき(services/web/app/src/Features/User/UserController.mjs:146-149)や、管理者が管理パネルで設定したとき(AdminUserManager.mjs:479-488)に、そのユーザーの未使用の password トークンすべてに usedAt を設定します。 |
読み取り元
| コード | 処理内容 |
|---|---|
PasswordResetHandler.mjs:50-70,94-119 | リセットまたは有効化トークンからユーザーを特定し、パスワードを設定します。user-activate の有効化ページは、トークンをこのフォームに渡すだけです。 |
UserEmailsConfirmationHandler.mjs:37-66 | ログイン中のユーザーの 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を持ったまま残り、createdAtから 90 日後に TTL インデックスが削除します。 OneTimeTokenHandlerにはgetValueFromTokenAndExpire(OneTimeTokenHandler.mjs:51-73)もありますが、呼び出すものはありません。

