-
Notifications
You must be signed in to change notification settings - Fork 434
Add docs for enumeration and account status controls in password recovery flow #6227
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
Open
VIHANGAGIT
wants to merge
1
commit into
wso2:master
Choose a base branch
from
VIHANGAGIT:recovery-flow-enumeration-controls
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.
Open
Changes from all commits
Commits
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
Binary file added
BIN
+284 KB
...docs/assets/img/guides/flows/flow-password-recovery-resolve-user-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+284 KB
...docs/assets/img/guides/flows/flow-password-recovery-resolve-user-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+284 KB
...docs/assets/img/guides/flows/flow-password-recovery-resolve-user-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+284 KB
...docs/assets/img/guides/flows/flow-password-recovery-resolve-user-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
|---|---|---|
|
|
@@ -92,6 +92,31 @@ Follow the steps below: | |
|
|
||
| Users can now enter any of their configured alternative login identifiers (such as email address) on the **Forgot Password?** page to start password recovery. | ||
|
|
||
| ## Control account information disclosure | ||
|
|
||
| The **Resolve User** step (the first step, where the user submits their identifier) has two settings that control how much the recovery flow reveals about an account: | ||
|
|
||
| - **Notify User Existence**: Reveals whether the submitted identifier matches an existing account. | ||
| - **Notify User Account Status**: Reveals whether the account is locked or disabled. | ||
|
|
||
| Both settings are **disabled by default** to prevent user enumeration. For the full behavior of each option, see [Resolve user properties](#resolve-user-properties). | ||
|
|
||
| !!! warning | ||
| Enabling these notifications reveals account information (whether an account exists and its lock/disable status) and may lead to **user enumeration**. Keep them disabled unless immediate user feedback (such as catching a mistyped identifier) outweighs that risk. | ||
|
|
||
| To enable the notifications: | ||
|
|
||
| 1. On the **Edit Password Recovery Flow** canvas, in the first step (where the user is resolved), hover over the action button (for example, **Continue**) and click the pencil icon that appears to open the button's **Properties** panel. | ||
|
|
||
| {: width="400" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|
|
||
| 2. Under **Resolve User**, enable the required checkboxes: | ||
|
|
||
| - **Notify User Existence** | ||
| - **Notify User Account Status** | ||
|
|
||
| 3. Click **Save Draft**, then publish the flow. | ||
|
|
||
| ## Reference | ||
|
|
||
| This section provides details on the configuration options available in the Password Recovery Flow. | ||
|
|
@@ -102,3 +127,10 @@ The Flow Completion Properties, configured on the End node, define the final act | |
|
|
||
| - **Auto Login**: If enabled, the user is automatically logged into their account immediately after successfully completing the password recovery flow. | ||
| - **Send a notification email on flow completion:** When enabled, the user will receive an email confirming that their password recovery is complete and their account is ready to use. | ||
|
|
||
| ### Resolve user properties | ||
|
Contributor
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. Add a pointer |
||
|
|
||
| The Resolve User properties, configured on the action button of the first step, control what the recovery flow reveals when a user submits an identifier. Both are **disabled by default** — the secure posture, where every identifier (valid, non-existent, locked, or disabled) produces the same response, protecting the recovery form against user enumeration attacks. These controls apply regardless of whether the user starts recovery with a username or an [alternative login identifier](#configure-for-alternative-login-identifiers) such as an email address or mobile number. | ||
|
|
||
| - **Notify User Existence**: When enabled, submitting an identifier that doesn't match any account shows a *"User does not exist"* error. When disabled, the flow continues to the next step (for example, the OTP screen) exactly as it would for a valid user, so it isn't possible to tell whether an account exists. | ||
| - **Notify User Account Status**: When enabled, a user with a locked or disabled account sees a specific error (for example, *"The account is locked"*, with reason-specific variants). When disabled, the account status is not revealed and the flow continues. | ||
Oops, something went wrong.
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.