tokens sisältää kertakäyttöisiä tunnuksia: linkin salaisuuden, jolla joku voi asettaa salasanan. Yksi dokumentti on yksi tunnus. Mongoose-mallia ei ole; web kirjoittaa kokoelmaan tiedoston services/web/app/src/Features/Security/OneTimeTokenHandler.mjs kautta natiivilla ajurilla.
Kentät
| Kenttä | Tyyppi | Merkitys | Lähde |
|---|---|---|---|
_id | ObjectId | Dokumentin id. | OneTimeTokenHandler.mjs:40 |
use | String | Mihin tunnus on tarkoitettu, katso Käyttötarkoitukset alla. Jokainen haku suodattaa sen mukaan. | OneTimeTokenHandler.mjs:41 |
token | String | Linkin salaisuus: 32 satunnaista tavua 64 heksamerkkinä, tallennettuna sellaisenaan. | OneTimeTokenHandler.mjs:38,42 |
data | Object | Mitä tunnus edustaa; palautetaan, kun tunnus käytetään. | OneTimeTokenHandler.mjs:43 |
data.user_id | String | Käyttäjän id, jonka jokainen kutsuja kirjoittaa merkkijonona. | 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 | Käyttäjän sähköpostiosoite tunnuksen luontihetkellä. Salasanan palautus hakee käyttäjän tällä ensisijaisella osoitteella (PasswordResetHandler.mjs:66-70). | sama kuin data.user_id |
createdAt | Date | Luontiaika. TTL-indeksi poistaa tunnuksen 90 päivää myöhemmin. | OneTimeTokenHandler.mjs:36,44 |
expiresAt | Date | createdAt plus expiresIn sekuntia: oletuksena 1 tunti, aktivointilinkille 1 viikko. Haut ohittavat tunnuksen tämän jälkeen. | OneTimeTokenHandler.mjs:35-37,45 |
peekCount | Number | Kuinka monta kertaa tunnusta on katsottu käyttämättä sitä. Jokainen peekValueFromToken lisää 1; arvolla 4 (MAX_PEEKS) tunnus lakkaa toimimasta. | OneTimeTokenHandler.mjs:8-31,107 |
usedAt | Date | Aika, jolloin tunnus käytettiin tai peruttiin. Haut ohittavat tunnuksen, jolla tämä kenttä on. | OneTimeTokenHandler.mjs:51-104 |
Käyttötarkoitukset
use | Toiminto | Voimassa | Koodi |
|---|---|---|---|
password | Salasanan palautussähköposti “unohtuiko salasana” -sivulta | 1 tunti | PasswordResetHandler.mjs:14-42 |
password | Aktivointilinkki: tili luodaan satunnaisella salasanalla, minkä jälkeen tulee linkki oman salasanan asettamiseen. Käyttäjiä ovat julkinen rekisteröityminen (services/web/modules/login-register/app/src/RegisterController.mjs:65), user-activate-moduulin ylläpitäjän rekisteröintisivu (services/web/modules/user-activate/app/src/UserActivateController.mjs:27-30) ja skripti create-user (services/web/modules/server-ce-scripts/scripts/create-user.mjs:21) | 1 viikko | UserRegistrationHandler.mjs:97-130 |
password | Hallintapaneelista lähetetty aktivointi- tai salasanan palautuslinkki (moduuli admin-tools) | 1 viikko (aktivointi), 1 tunti (palautus) | AdminUserManager.mjs:76-103,196-206 |
email_confirmation | Sähköpostin vahvistuslinkki. Vain luetaan: mikään tässä repositoriossa ei enää luo tällaisia tunnuksia, koska vahvistus lähettää nyt 6-numeroisen koodin (services/web/app/src/Features/User/UserEmailsConfirmationHandler.mjs:15-35) | UserEmailsConfirmationHandler.mjs:12,37-66 |
Kuka kirjoittaa
| Koodi | Mitä se tekee |
|---|---|
OneTimeTokenHandler.mjs:34-49 (getNewToken) | Lisää tunnuksen. Kutsujat: PasswordResetHandler.mjs:28, UserRegistrationHandler.mjs:115-119, AdminUserManager.mjs:77-81. |
OneTimeTokenHandler.mjs:8-32 (peekValueFromToken) | Palauttaa kelvollisen tunnuksen data-kentän ja lisää 1 kenttään peekCount. Käytetään, kun salasanan palautussivu avataan (services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208), uudelleen kun uusi salasana asetetaan (PasswordResetHandler.mjs:94-96), sekä sähköpostin vahvistuksessa (UserEmailsConfirmationHandler.mjs:38-41). |
OneTimeTokenHandler.mjs:75-88 (expireToken) | Asettaa usedAt-kentän yhdelle tunnukselle: kun uusi salasana on asetettu (PasswordResetHandler.mjs:44-48,119) tai sähköposti vahvistettu (UserEmailsConfirmationHandler.mjs:65). |
OneTimeTokenHandler.mjs:90-104 (expireAllTokensForUser) | Asettaa usedAt-kentän käyttäjän jokaiselle avoimelle password-tunnukselle, kun käyttäjä vaihtaa salasanan asetuksissa (services/web/app/src/Features/User/UserController.mjs:146-149) tai ylläpitäjä asettaa sen hallintapaneelissa (AdminUserManager.mjs:479-488). |
Kuka lukee
| Koodi | Mitä se tekee |
|---|---|
PasswordResetHandler.mjs:50-70,94-119 | Selvittää palautus- tai aktivointitunnuksesta käyttäjän ja asettaa sitten salasanan. user-activate-moduulin aktivointisivu vain välittää tunnuksen tälle lomakkeelle. |
UserEmailsConfirmationHandler.mjs:37-66 | Vahvistaa sähköpostin kirjautuneen käyttäjän email_confirmation-tunnuksella. |
AdminUserManager.mjs:213-223 (module admin-tools) | Etsii käyttäjän avoimen aktivointitunnuksen, jotta aktivointilinkki voidaan näyttää uudelleen hallintapaneelissa. Lukee db.tokens-kokoelmaa suoraan. |
Indeksit
| Nimi | Avaimet | Asetukset | Migraatio |
|---|---|---|---|
token_1_use_1 | { token: 1, use: 1 } | yksilöllinen | 20190912145031_create_tokens_indexes.mjs |
createdAt_1 | { createdAt: 1 } | TTL, expireAfterSeconds: 7776000 (90 päivää) | 20210407085118_token-expiry-with-ttl-index.mjs |
data.user_id_1 | { "data.user_id": 1 } | 20231113173237_tokens_user_id_index.mjs |
tools/migrations/.
Huomautukset
- Käytettyä tai vanhentunutta tunnusta ei poisteta heti: se jää paikalleen kentällä
usedAttai menneelläexpiresAt-arvolla, kunnes TTL-indeksi poistaa sen 90 päivää kentäncreatedAtjälkeen. OneTimeTokenHandlersisältää myös funktiongetValueFromTokenAndExpire(OneTimeTokenHandler.mjs:51-73), mutta mikään ei kutsu sitä.

