docs(auth): clarify fetchSignInMethodsForEmail behavior with email enumeration protection#8518
Merged
Conversation
…umeration protection This update enhances the JSDoc comment for fetchSignInMethodsForEmail by explaining its behavior when "Email Enumeration Protection" is enabled in Firebase Authentication settings (which is the default). It notes that the method may return an empty array even for existing accounts when called from an unauthenticated context. This clarification aims to prevent confusion and potential misuse that could lead to security vulnerabilities.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
mikehardy
reviewed
May 12, 2025
Collaborator
|
Passed lint now - no way a jsdoc can fail native code stuff, merging 🚂 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docs(auth): clarify fetchSignInMethodsForEmail behavior with email enumeration protection
Description
This pull request clarifies the behavior of
fetchSignInMethodsForEmailin the context of Firebase Authentication when Email Enumeration Protection is enabled (which is the default setting in Firebase).The updated JSDoc comment explains that:
The goal is to help developers understand the limitations of this method and avoid using its result for direct user feedback about account existence, which could lead to security vulnerabilities.
Related issues
None reported, but this clarification aligns with security considerations discussed in firebase/firebase-js-sdk#4514.
Release Summary
Clarified the JSDoc for
fetchSignInMethodsForEmailin the Auth module to include a note about email enumeration protection and its effects.Checklist
packages/**/e2epackages/**/__tests__Test Plan
No code changes — documentation only.
Think
react-native-firebaseis great? Please consider supporting the project: