-
Notifications
You must be signed in to change notification settings - Fork 356
Add TOTP configuration documentation for WSO2 IS 7.1.0 #5596
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Copilot
wants to merge
3
commits into
master
Choose a base branch
from
copilot/fix-f41fdd78-3374-46a5-9699-e3118429fe63
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
145 changes: 145 additions & 0 deletions
145
en/identity-server/7.1.0/docs/guides/authentication/mfa/totp-config-advanced.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
# TOTP configurations | ||
|
||
This page lists all the advanced configurations related to TOTP (Time-based One-Time Password) authentication. | ||
|
||
## Default TOTP configuration | ||
|
||
The following code snippet shows a sample TOTP configuration in the `<IS_HOME>/repository/conf/deployment.toml` file: | ||
|
||
```toml | ||
[authentication.authenticator.totp.parameters] | ||
encodingMethod="Base32" | ||
timeStepSize="30" | ||
windowSize="3" | ||
authenticationMandatory=true | ||
enrolUserInAuthenticationFlow=true | ||
usecase="local" | ||
secondaryUserstore="primary" | ||
TOTPAuthenticationEndpointURL="authenticationendpoint/totp.do" | ||
TOTPAuthenticationEndpointErrorPage="authenticationendpoint/totp_error.do" | ||
TOTPAuthenticationEndpointEnableTOTPPage="authenticationendpoint/totp_enroll.do" | ||
Issuer="WSO2" | ||
UseCommonIssuer=true | ||
``` | ||
|
||
The parameter values above show the **default** configurations in WSO2 Identity Server. | ||
|
||
## Update TOTP configuration | ||
|
||
To change a parameter value from the default value, add the configuration to the `deployment.toml` file using the following format: | ||
|
||
```toml | ||
[authentication.authenticator.totp.parameters] | ||
<Property-name> = <Property-value> | ||
``` | ||
|
||
## Configuration parameters | ||
|
||
Learn about each TOTP configuration parameter and how to customize them. | ||
|
||
### encodingMethod | ||
|
||
**Description:** The encoding method used to generate the TOTP. | ||
|
||
**Default value:** `Base32` | ||
|
||
--- | ||
|
||
### timeStepSize | ||
|
||
**Description:** The time step size (in seconds) used to validate the TOTP. | ||
|
||
**Default value:** `30` | ||
|
||
--- | ||
|
||
### windowSize | ||
|
||
**Description:** The window size used to validate the TOTP. This determines how many time steps before and after the current time step are accepted. | ||
pavinduLakshan marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
**Default value:** `3` | ||
|
||
--- | ||
|
||
### authenticationMandatory | ||
|
||
**Description:** If this value is `true`, TOTP authentication will be enforced as a second step. | ||
|
||
**Default value:** `true` | ||
|
||
--- | ||
|
||
### enrolUserInAuthenticationFlow | ||
|
||
**Description:** If this value is `true`, it will ask users to enable the TOTP authenticator during the authentication flow. | ||
|
||
**Default value:** `true` | ||
|
||
--- | ||
|
||
### usecase | ||
|
||
**Description:** This field can take one of the following values: `local`, `association`, `userAttribute`, `subjectUri`. If you do not specify any usecase, the default value is `local`. | ||
|
||
**Default value:** `local` | ||
|
||
If you choose `userAttribute` as the usecase, add the following parameter to specify the user attribute: | ||
|
||
```toml | ||
userAttribute = "http://wso2.org/foursquare/claims/email" | ||
``` | ||
|
||
--- | ||
|
||
### secondaryUserstore | ||
|
||
**Description:** If you use secondary user stores, enter all the user store values for the particular tenant as comma-separated values. | ||
|
||
**Default value:** `primary` | ||
|
||
**Example:** | ||
|
||
```toml | ||
[authentication.authenticator.totp.parameters] | ||
secondaryUserstore= "jdbc, abc, xyz" | ||
``` | ||
|
||
--- | ||
|
||
### TOTPAuthenticationEndpointURL | ||
|
||
**Description:** The endpoint of the UI used to gather the TOTP. | ||
|
||
**Default value:** `authenticationendpoint/totp.do` | ||
|
||
--- | ||
|
||
### TOTPAuthenticationEndpointErrorPage | ||
|
||
**Description:** The endpoint of the error page. | ||
|
||
**Default value:** `authenticationendpoint/totp_error.do` | ||
|
||
--- | ||
|
||
### TOTPAuthenticationEndpointEnableTOTPPage | ||
|
||
**Description:** The endpoint of the TOTP authenticator enrollment page. | ||
|
||
**Default value:** `authenticationendpoint/totp_enroll.do` | ||
|
||
--- | ||
|
||
### Issuer | ||
|
||
**Description:** The issuer name that will be shown on the mobile authenticator application. If this parameter is not configured, the tenant domain will be shown. | ||
|
||
**Default value:** `WSO2` | ||
|
||
--- | ||
|
||
### UseCommonIssuer | ||
|
||
**Description:** If set to `true`, the issuer name defined in the `deployment.toml` file will be used as the issuer for all tenants. | ||
|
||
**Default value:** `true` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -153,7 +153,6 @@ plugins: | |
"guides/mfa/2fa-fido.md": "guides/authentication/mfa/add-passkey-login.md" | ||
"guides/mfa/x509.md": "guides/authentication/mfa/add-x509-login.md" | ||
"guides/mfa/email-otp-config-advanced.md": "guides/authentication/mfa/add-emailotp-login.md" | ||
"guides/mfa/totp-config-advanced.md": "guides/authentication/mfa/add-totp-login.md" | ||
"guides/mfa/sms-otp-config-advanced.md": "guides/authentication/mfa/add-smsotp-login.md" | ||
"guides/adaptive-auth/configure-adaptive-auth.md": "guides/authentication/conditional-auth/index.md" | ||
"guides/adaptive-auth/adaptive-auth-overview.md": "guides/authentication/conditional-auth/configure-conditional-auth.md" | ||
|
@@ -513,6 +512,7 @@ nav: | |
- Add multi-factor authentication: | ||
- Add multi-factor authentication: guides/authentication/mfa/index.md | ||
- Add TOTP: guides/authentication/mfa/add-totp-login.md | ||
- TOTP configurations: guides/authentication/mfa/totp-config-advanced.md | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @copilot instead of adding a new page, let's update the |
||
- Add Email OTP: guides/authentication/mfa/add-emailotp-login.md | ||
- Add Passkey: guides/authentication/mfa/add-passkey-login.md | ||
- Add SMS OTP: guides/authentication/mfa/add-smsotp-login.md | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.