mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-22 21:08:47 +00:00
chore: renamed one time password to OTP (#11447)
# Which Problems Are Solved naming consistency for TOTP/OTP # How the Problems Are Solved # Additional Changes # Additional Context - Closes #11299 - Closes #11302 - Closes #11304 --------- Co-authored-by: Marco A. <[email protected]> Co-authored-by: Florian Forster <[email protected]> Co-authored-by: Copilot <[email protected]>
This commit is contained in:
co-authored by
Marco A.
Florian Forster
Copilot
parent
61d4060df3
commit
b99271755b
@@ -10,7 +10,8 @@
|
||||
"{workspaceRoot}/proto/**/*.go",
|
||||
"{workspaceRoot}/pkg/**/*.go",
|
||||
"{workspaceRoot}/main.go",
|
||||
"{workspaceRoot}/internal/**/*.yaml"
|
||||
"{workspaceRoot}/internal/**/*.yaml",
|
||||
"{workspaceRoot}/internal/**/*.json"
|
||||
],
|
||||
"runtime": [
|
||||
"sources",
|
||||
|
||||
@@ -9,7 +9,7 @@ The flow is represented by the following Ids in the API: `3`
|
||||
## Post Authentication
|
||||
|
||||
A user has authenticated directly at ZITADEL.
|
||||
ZITADEL validated the users inputs for password, one-time password or passkey.
|
||||
ZITADEL validated the users inputs for password, OTP or passkey.
|
||||
Each validation step triggers the action.
|
||||
|
||||
The trigger is represented by the following Ids in the API: `TRIGGER_TYPE_POST_AUTHENTICATION` or `1`.
|
||||
|
||||
@@ -91,9 +91,9 @@ The current password must be entered first.
|
||||
Users can set up and delete a second factor and FIDO Passkeys (Passwordless).
|
||||
Available authenticators are:
|
||||
|
||||
- Time-based one-time password (TOTP) (Which are Authenticator Apps like Google/Microsoft Authenticator, Authy, etc.)
|
||||
- One-time password sent as E-Mail
|
||||
- One-time password sent as SMS
|
||||
- TOTP (Which are Authenticator Apps like Google/Microsoft Authenticator, Authy, etc.)
|
||||
- OTP sent as Email
|
||||
- OTP sent as SMS
|
||||
- FIDO Universal Second Factor (U2F) (Security Keys, Device, etc.)
|
||||
- FIDO2 WebAuthN (Passkeys)
|
||||
|
||||
@@ -113,12 +113,12 @@ Users can change their profile information. This includes
|
||||
### Email Verification
|
||||
|
||||
Users can change their email address.
|
||||
The user receives a one-time password and can verify control over the given email address.
|
||||
The user receives an OTP and can verify control over the given email address.
|
||||
|
||||
### Phone Verification
|
||||
|
||||
Users can change their phone number.
|
||||
The user receives a one-time password and can verify control over the given phone number.
|
||||
The user receives an OTP and can verify control over the given phone number.
|
||||
|
||||
### Identity providers
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@ It is highly recommended to use MFA or [Passkeys](./passkey) to make your user a
|
||||
|
||||
ZITADEL supports different Methods:
|
||||
- Time-based one time password (TOTP), which are Authenticator apps like Google/Microsoft Authenticator, Authy, etc
|
||||
- One-time password sent as SMS
|
||||
- One-time password sent as E-Mail
|
||||
- OTP sent as SMS
|
||||
- OTP sent as Email
|
||||
- Universal Second Factor (U2F), which is authentication with your device like Windows Hello, Apple FaceID, Fingerprint, FIDO2 keys, Yubikey, etc.
|
||||
|
||||
## TOTP Registration
|
||||
@@ -29,7 +29,7 @@ ZITADEL supports different Methods:
|
||||
|
||||
### Start TOTP Registration
|
||||
|
||||
The user has selected to setup Time-based One-Time Password (TOTP).
|
||||
The user has selected to setup TOTP.
|
||||
To show the user the QR to register TOTP with his Authenticator App like Google/Microsoft Authenticator or Authy you have to start the registration on the ZITADEL API.
|
||||
Generate the QR Code with the URI from the response.
|
||||
For users that do not have a QR Code reader make sure to also show the secret, to enable manual configuration.
|
||||
@@ -205,7 +205,7 @@ curl --request POST \
|
||||
|
||||
### Add OTP SMS to the user
|
||||
|
||||
Now that the user has a verified phone number you can enable SMS OTP on the user.
|
||||
Now that the user has a verified phone number you can enable OTP SMS on the user.
|
||||
|
||||
More detailed information about the API: [Add OTP SMS for a user](/reference/api/user/zitadel.user.v2.UserService.AddOTPSMS)
|
||||
|
||||
|
||||
@@ -170,7 +170,7 @@ The following example shows you how you could use the events search to find out
|
||||
You have to include all the event types that tell you that a login attempt has failed.
|
||||
In this case these are the following events:
|
||||
- Password verification failed
|
||||
- One-time password (OTP) check failed (Authenticator Apps like Authy, Google Authenticator, etc)
|
||||
- OTP check failed (Authenticator Apps like Authy, Google Authenticator, etc)
|
||||
- Universal Second Factor (U2F) check failed (FaceID, WindowsHello, FingerPrint, etc)
|
||||
- Passkey check failed (FaceID, WindowsHello, FingerPrint, etc)
|
||||
|
||||
|
||||
@@ -189,8 +189,8 @@ Second factors (2FA):
|
||||
|
||||
- Time-based One Time Password (TOTP), Authenticator Apps like Google/Microsoft Authenticator, Authy, etc.
|
||||
- Universal Second Factor (U2F), e.g FaceID, WindowsHello, Fingerprint, Hardware tokens like Yubikey
|
||||
- One Time Password with Email (Email OTP)
|
||||
- One Time Password with SMS (SMS OTP)
|
||||
- One Time Password with Email (OTP Email)
|
||||
- One Time Password with SMS (OTP SMS)
|
||||
|
||||
Force a user to register and use a multifactor authentication, by checking the option "Force MFA".
|
||||
Ensure that you have added the MFA methods you want to allow.
|
||||
|
||||
@@ -86,12 +86,12 @@ test("username, password and email otp login, wrong code", async ({ user, page }
|
||||
|
||||
test("username, password and email otp login, multiple mfa options", async ({ page }) => {
|
||||
base.skip();
|
||||
// Given email otp and sms otp is enabled on the organization of the user
|
||||
// Given the user has email and sms otp configured as second factor
|
||||
// Given OTP Email and OTP SMS is enabled on the organization of the user
|
||||
// Given the user has OTP Email and OTP SMS configured as second factor
|
||||
// User enters username
|
||||
// User enters password
|
||||
// User receives an email with a verification code
|
||||
// User clicks button to use sms otp as second factor
|
||||
// User clicks button to use OTP SMS as second factor
|
||||
// User receives a sms with a verification code
|
||||
// User enters code in ui
|
||||
// User is redirected to the app (default redirect url)
|
||||
|
||||
@@ -31,9 +31,9 @@ const test = base.extend<{ user: PasswordUserWithOTP; sink: any }>({
|
||||
},
|
||||
});
|
||||
|
||||
test.skip("DOESN'T WORK: username, password and sms otp login, enter code manually", async ({ user, page }) => {
|
||||
// Given sms otp is enabled on the organization of the user
|
||||
// Given the user has only sms otp configured as second factor
|
||||
test.skip("DOESN'T WORK: username, password and OTP SMS login, enter code manually", async ({ user, page }) => {
|
||||
// Given OTP SMS is enabled on the organization of the user
|
||||
// Given the user has only OTP SMS configured as second factor
|
||||
// User enters username
|
||||
// User enters password
|
||||
// User receives a sms with a verification code
|
||||
@@ -43,9 +43,9 @@ test.skip("DOESN'T WORK: username, password and sms otp login, enter code manual
|
||||
await loginScreenExpect(page, user.getFullName());
|
||||
});
|
||||
|
||||
test.skip("DOESN'T WORK: username, password and sms otp login, resend code", async ({ user, page }) => {
|
||||
// Given sms otp is enabled on the organization of the user
|
||||
// Given the user has only sms otp configured as second factor
|
||||
test.skip("DOESN'T WORK: username, password and OTP SMS login, resend code", async ({ user, page }) => {
|
||||
// Given OTP SMS is enabled on the organization of the user
|
||||
// Given the user has only OTP SMS configured as second factor
|
||||
// User enters username
|
||||
// User enters password
|
||||
// User receives a sms with a verification code
|
||||
@@ -56,9 +56,9 @@ test.skip("DOESN'T WORK: username, password and sms otp login, resend code", asy
|
||||
await loginScreenExpect(page, user.getFullName());
|
||||
});
|
||||
|
||||
test("username, password and sms otp login, wrong code", async ({ user, page }) => {
|
||||
// Given sms otp is enabled on the organization of the user
|
||||
// Given the user has only sms otp configured as second factor
|
||||
test("username, password and OTP SMS login, wrong code", async ({ user, page }) => {
|
||||
// Given OTP SMS is enabled on the organization of the user
|
||||
// Given the user has only OTP SMS configured as second factor
|
||||
// User enters username
|
||||
// User enters password
|
||||
// User receives a sms with a verification code
|
||||
|
||||
@@ -795,7 +795,7 @@ describe("checkMFAFactors", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("should redirect to SMS OTP if only OTP_SMS is available", async () => {
|
||||
it("should redirect to OTP SMS if only OTP_SMS is available", async () => {
|
||||
const authMethods = [AuthenticationMethodType.OTP_SMS];
|
||||
|
||||
const result = await checkMFAFactors("https://example.com", mockSession, mockLoginSettings, authMethods);
|
||||
@@ -805,7 +805,7 @@ describe("checkMFAFactors", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("should redirect to Email OTP if only OTP_EMAIL is available", async () => {
|
||||
it("should redirect to OTP Email if only OTP_EMAIL is available", async () => {
|
||||
const authMethods = [AuthenticationMethodType.OTP_EMAIL];
|
||||
|
||||
const result = await checkMFAFactors("https://example.com", mockSession, mockLoginSettings, authMethods);
|
||||
|
||||
Reference in New Issue
Block a user