Skip to content

feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

Sign up for GitHub

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

Merged
yourtallness merged 1 commit into from
Mar 29, 2024
Merged

feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… #3034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/flat-geese-applaud.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.
68 changes: 53 additions & 15 deletions packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
onBackLinkClick: React.MouseEventHandler | undefined;
onFactorSelected: (factor: SignInFactor) => void;
currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
const card = useCardState();
const resetPasswordFactor = useResetPasswordFactor();
const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
filterOutFactor: props?.currentFactor,
});

const flowPart = determineFlowPart(mode);
const cardTitleKey = determineTitle(mode);
const isReset = determineIsReset(mode);

return (
<Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
<Flow.Part part={flowPart}>
<Card.Root>
<Card.Content>
<Header.Root showLogo>
<Header.Title
localizationKey={localizationKeys(
asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
)}
/>
{!asForgotPassword && (
<Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
)}
<Header.Title localizationKey={cardTitleKey} />
{!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
</Header.Root>
<Card.Alert>{card.error}</Card.Alert>
{/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
elementDescriptor={descriptors.main}
gap={6}
>
{asForgotPassword && resetPasswordFactor && (
{isReset && resetPasswordFactor && (
<Button
localizationKey={getButtonLabel(resetPasswordFactor)}
elementDescriptor={descriptors.alternativeMethodsBlockButton}
isDisabled={card.isLoading}
onClick={() => onFactorSelected(resetPasswordFactor)}
onClick={() => {
card.setError(undefined);
onFactorSelected(resetPasswordFactor);
}}
/>
)}
{asForgotPassword && hasAnyStrategy && (
{isReset && hasAnyStrategy && (
<Divider
dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
/>
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
key={i}
textVariant='buttonLarge'
isDisabled={card.isLoading}
onClick={() => onFactorSelected(factor)}
onClick={() => {
card.setError(undefined);
onFactorSelected(factor);
}}
/>
))}
</Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
switch (mode) {
case 'forgot':
return 'forgotPasswordMethods';
case 'pwned':
return 'passwordPwnedMethods';
default:
return 'alternativeMethods';
}
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
switch (mode) {
case 'forgot':
return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
case 'pwned':
return localizationKeys('signIn.passwordPwned.title');
default:
return localizationKeys('signIn.alternativeMethods.title');
}
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
switch (mode) {
case 'forgot':
case 'pwned':
return true;
default:
return false;
}
}
20 changes: 17 additions & 3 deletions packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
const { preferredSignInStrategy } = useEnvironment().displayConfig;
const availableFactors = signIn.supportedFirstFactors;
const router = useRouter();
const card = useCardState();

const lastPreparedFactorKeyRef = React.useRef('');
const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

React.useEffect(() => {
// Handle the case where a user lands on alternative methods screen,
// clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
const canGoBack = factorHasLocalStrategy(currentFactor);

const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
const backHandler = () => {
card.setError(undefined);
setIsPasswordPwned(false);
toggle?.();
};

const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

return (
<AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
onBackLinkClick={canGoBack ? backHandler : undefined}
onFactorSelected={f => {
selectFactor(f);
toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
}}
onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
onShowAlternativeMethodsClick={toggleAllStrategies}
onPasswordPwned={() => {
setIsPasswordPwned(true);
toggleForgotPasswordStrategies();

@yourtallnessyourtallnessMar 22, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.

@desiprisgdesiprisgMar 22, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed

}}
/>
);
case 'email_code':
Expand Down
11 changes: 9 additions & 2 deletions packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
const { onShowAlternativeMethodsClick } = props;
const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
const card = useCardState();
const { setActive } = useClerk();
const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
return clerk.__internal_navigateWithError('..', err.errors[0]);
}

if (isPasswordPwnedError(err) && onPasswordPwned) {
card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
onPasswordPwned();
return;
}

handleError(err, [passwordControl], card.setError);
});
};
Expand Down
147 changes: 147 additions & 0 deletions packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
});
});
});

it('Prompts the user to reset their password via email if it has been pwned', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withEmailAddress();
f.withPassword();
f.withPreferredSignInStrategy({ strategy: 'password' });
f.startSignInWithEmailAddress({
supportPassword: true,
supportEmailCode: true,
supportResetPassword: true,
});
});
fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

const errJSON = {
code: 'form_password_pwned',
long_message:
'Password has been found in an online data breach. For account safety, please reset your password.',
message: 'Password has been found in an online data breach. For account safety, please reset your password.',
meta: { param_name: 'password' },
};

fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
new ClerkAPIResponseError('Error', {
data: [errJSON],
status: 422,
}),
);

await runFakeTimers(async () => {
const { userEvent } = render(<SignInFactorOne />, { wrapper });
await userEvent.type(screen.getByLabelText('Password'), '123456');
await userEvent.click(screen.getByText('Continue'));

await waitFor(() => {
screen.getByText('Password compromised');
screen.getByText(
'This password has been found as part of a breach and can not be used, please reset your password.',
);
screen.getByText('Or, sign in with another method');
});

await userEvent.click(screen.getByText('Reset your password'));
screen.getByText('First, enter the code sent to your email ID');
});
});

it('Prompts the user to reset their password via phone if it has been pwned', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withEmailAddress();
f.withPassword();
f.withPreferredSignInStrategy({ strategy: 'password' });
f.startSignInWithPhoneNumber({
supportPassword: true,
supportPhoneCode: true,
supportResetPassword: true,
});
});
fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

const errJSON = {
code: 'form_password_pwned',
long_message:
'Password has been found in an online data breach. For account safety, please reset your password.',
message: 'Password has been found in an online data breach. For account safety, please reset your password.',
meta: { param_name: 'password' },
};

fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
new ClerkAPIResponseError('Error', {
data: [errJSON],
status: 422,
}),
);

await runFakeTimers(async () => {
const { userEvent } = render(<SignInFactorOne />, { wrapper });
await userEvent.type(screen.getByLabelText('Password'), '123456');
await userEvent.click(screen.getByText('Continue'));

await waitFor(() => {
screen.getByText('Password compromised');
screen.getByText(
'This password has been found as part of a breach and can not be used, please reset your password.',
);
screen.getByText('Or, sign in with another method');
});

await userEvent.click(screen.getByText('Reset your password'));
screen.getByText('First, enter the code sent to your phone');
});
});

it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withEmailAddress();
f.withPassword();
f.withPreferredSignInStrategy({ strategy: 'password' });
f.startSignInWithEmailAddress({
supportPassword: true,
supportEmailCode: true,
supportResetPassword: true,
});
});
fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

const errJSON = {
code: 'form_password_pwned',
long_message:
'Password has been found in an online data breach. For account safety, please reset your password.',
message: 'Password has been found in an online data breach. For account safety, please reset your password.',
meta: { param_name: 'password' },
};

fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
new ClerkAPIResponseError('Error', {
data: [errJSON],
status: 422,
}),
);

await runFakeTimers(async () => {
const { userEvent } = render(<SignInFactorOne />, { wrapper });
await userEvent.type(screen.getByLabelText('Password'), '123456');
await userEvent.click(screen.getByText('Continue'));

await waitFor(() => {
screen.getByText('Password compromised');
screen.getByText(
'This password has been found as part of a breach and can not be used, please reset your password.',
);
screen.getByText('Or, sign in with another method');
});

// Go back
await userEvent.click(screen.getByText('Back'));

// Choose to reset password via "Forgot password" instead
await userEvent.click(screen.getByText(/Forgot password/i));
screen.getByText('Forgot Password?');
expect(
screen.queryByText(
'This password has been found as part of a breach and can not be used, please reset your password.',
),
).not.toBeInTheDocument();
});
});
});

describe('Forgot Password', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
| 'emailLinkStatus'
| 'alternativeMethods'
| 'forgotPasswordMethods'
| 'passwordPwnedMethods'
| 'havingTrouble'
| 'ssoCallback'
| 'popover'
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned… by yourtallness · Pull Request #3034 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…#3034

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.

 Sign up for GitHub

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

 Merged

yourtallness
merged 1 commit into

from

Mar 29, 2024
 Merged


feat(clerk-js,localizations,shared,types): Prompt user to reset pwned…
#3034
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


8 changes: 8 additions & 0 deletions
.changeset/flat-geese-applaud.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/types': minor
---

Support for prompting a user to reset their password if it is found to be compromised during sign-in.

68 changes: 53 additions & 15 deletions
packages/clerk-js/src/ui/components/SignIn/AlternativeMethods.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,13 @@ import { SignInSocialButtons } from './SignInSocialButtons';
import { useResetPasswordFactor } from './useResetPasswordFactor';
import { withHavingTrouble } from './withHavingTrouble';

type AlternativeMethodsMode = 'forgot' | 'pwned' | 'default';

export type AlternativeMethodsProps = {
 onBackLinkClick: React.MouseEventHandler | undefined;
 onFactorSelected: (factor: SignInFactor) => void;
 currentFactor: SignInFactor | undefined | null;
asForgotPassword?: boolean;
mode?: AlternativeMethodsMode;
};

export type AlternativeMethodListProps = AlternativeMethodsProps & { onHavingTroubleClick: React.MouseEventHandler };
Expand All@@ -28,26 +30,24 @@ export const AlternativeMethods = (props: AlternativeMethodsProps) => {
};

const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, asForgotPassword = false } = props;
 const { onBackLinkClick, onHavingTroubleClick, onFactorSelected, mode = 'default' } = props;
 const card = useCardState();
 const resetPasswordFactor = useResetPasswordFactor();
 const { firstPartyFactors, hasAnyStrategy } = useAlternativeStrategies({
 filterOutFactor: props?.currentFactor,
 });

 const flowPart = determineFlowPart(mode);
 const cardTitleKey = determineTitle(mode);
 const isReset = determineIsReset(mode);

 return (
 <Flow.Part part={asForgotPassword ? 'forgotPasswordMethods' : 'alternativeMethods'}>
 <Flow.Part part={flowPart}>
 <Card.Root>
 <Card.Content>
 <Header.Root showLogo>
 <Header.Title
 localizationKey={localizationKeys(
 asForgotPassword ? 'signIn.forgotPasswordAlternativeMethods.title' : 'signIn.alternativeMethods.title',
 )}
 />
 {!asForgotPassword && (
 <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />
 )}
 <Header.Title localizationKey={cardTitleKey} />
 {!isReset && <Header.Subtitle localizationKey={localizationKeys('signIn.alternativeMethods.subtitle')} />}
 </Header.Root>
 <Card.Alert>{card.error}</Card.Alert>
 {/*TODO: extract main in its own component */}
Expand All@@ -56,15 +56,18 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 elementDescriptor={descriptors.main}
 gap={6}
 >
 {asForgotPassword && resetPasswordFactor && (
 {isReset && resetPasswordFactor && (
 <Button
 localizationKey={getButtonLabel(resetPasswordFactor)}
 elementDescriptor={descriptors.alternativeMethodsBlockButton}
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(resetPasswordFactor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(resetPasswordFactor);
 }}
 />
 )}
 {asForgotPassword && hasAnyStrategy && (
 {isReset && hasAnyStrategy && (
 <Divider
 dividerText={localizationKeys('signIn.forgotPasswordAlternativeMethods.label__alternativeMethods')}
 />
Expand All@@ -90,7 +93,10 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
 key={i}
 textVariant='buttonLarge'
 isDisabled={card.isLoading}
 onClick={() => onFactorSelected(factor)}
 onClick={() => {
 card.setError(undefined);
 onFactorSelected(factor);
 }}
 />
 ))}
 </Flex>
Expand DownExpand Up@@ -161,3 +167,35 @@ export function getButtonIcon(factor: SignInFactor) {

 return icons[factor.strategy as keyof typeof icons];
}

function determineFlowPart(mode: AlternativeMethodsMode) {
 switch (mode) {
 case 'forgot':
 return 'forgotPasswordMethods';
 case 'pwned':
 return 'passwordPwnedMethods';
 default:
 return 'alternativeMethods';
 }
}

function determineTitle(mode: AlternativeMethodsMode): LocalizationKey {
 switch (mode) {
 case 'forgot':
 return localizationKeys('signIn.forgotPasswordAlternativeMethods.title');
 case 'pwned':
 return localizationKeys('signIn.passwordPwned.title');
 default:
 return localizationKeys('signIn.alternativeMethods.title');
 }
}

function determineIsReset(mode: AlternativeMethodsMode): boolean {
 switch (mode) {
 case 'forgot':
 case 'pwned':
 return true;
 default:
 return false;
 }
}

20 changes: 17 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOne.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import React from 'react';

import { withRedirectToAfterSignIn } from '../../common';
import { useCoreSignIn, useEnvironment } from '../../contexts';
import { ErrorCard, LoadingCard, withCardStateProvider } from '../../elements';
import { ErrorCard, LoadingCard, useCardState, withCardStateProvider } from '../../elements';
import { useAlternativeStrategies } from '../../hooks/useAlternativeStrategies';
import { localizationKeys } from '../../localization';
import { useRouter } from '../../router';
Expand DownExpand Up@@ -36,6 +36,7 @@ export function _SignInFactorOne(): JSX.Element {
 const { preferredSignInStrategy } = useEnvironment().displayConfig;
 const availableFactors = signIn.supportedFirstFactors;
 const router = useRouter();
 const card = useCardState();

 const lastPreparedFactorKeyRef = React.useRef('');
 const [{ currentFactor }, setFactor] = React.useState<{
Expand All@@ -58,6 +59,8 @@ export function _SignInFactorOne(): JSX.Element {

 const [showForgotPasswordStrategies, setShowForgotPasswordStrategies] = React.useState(false);

 const [isPasswordPwned, setIsPasswordPwned] = React.useState(false);

 React.useEffect(() => {
 // Handle the case where a user lands on alternative methods screen,
 // clicks a social button but then navigates back to sign in.
Expand DownExpand Up@@ -94,11 +97,18 @@ export function _SignInFactorOne(): JSX.Element {
 const canGoBack = factorHasLocalStrategy(currentFactor);

 const toggle = showAllStrategies ? toggleAllStrategies : toggleForgotPasswordStrategies;
 const backHandler = () => {
 card.setError(undefined);
 setIsPasswordPwned(false);
 toggle?.();
 };

 const mode = showForgotPasswordStrategies ? (isPasswordPwned ? 'pwned' : 'forgot') : 'default';

 return (
 <AlternativeMethods
asForgotPassword={showForgotPasswordStrategies}
 onBackLinkClick={canGoBack ? toggle : undefined}
mode={mode}
 onBackLinkClick={canGoBack ? backHandler : undefined}
 onFactorSelected={f => {
 selectFactor(f);
 toggle?.();
Expand DownExpand Up@@ -135,6 +145,10 @@ export function _SignInFactorOne(): JSX.Element {
 }}
 onForgotPasswordMethodClick={resetPasswordFactor ? toggleForgotPasswordStrategies : toggleAllStrategies}
 onShowAlternativeMethodsClick={toggleAllStrategies}
 onPasswordPwned={() => {
 setIsPasswordPwned(true);
 toggleForgotPasswordStrategies();
@yourtallnessyourtallnessMar 22, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could potentially also trigger the reset flow to start, but preferred to allow them to click it themselves.
@desiprisgdesiprisgMar 22, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed
 }}
 />
 );
 case 'email_code':
Expand Down

11 changes: 9 additions & 2 deletions
packages/clerk-js/src/ui/components/SignIn/SignInFactorOnePasswordCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { isUserLockedError } from '@clerk/shared/error';
import { isPasswordPwnedError, isUserLockedError } from '@clerk/shared/error';
import { useClerk } from '@clerk/shared/react';
import type { ResetPasswordCodeFactor } from '@clerk/types';
import React from 'react';
Expand All@@ -17,6 +17,7 @@ type SignInFactorOnePasswordProps = {
 onForgotPasswordMethodClick: React.MouseEventHandler | undefined;
 onShowAlternativeMethodsClick: React.MouseEventHandler | undefined;
 onFactorPrepare: (f: ResetPasswordCodeFactor) => void;
 onPasswordPwned?: () => void;
};

const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
Expand DownExpand Up@@ -45,7 +46,7 @@ const usePasswordControl = (props: SignInFactorOnePasswordProps) => {
};

export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps) => {
 const { onShowAlternativeMethodsClick } = props;
 const { onShowAlternativeMethodsClick, onPasswordPwned } = props;
 const card = useCardState();
 const { setActive } = useClerk();
 const signIn = useCoreSignIn();
Expand DownExpand Up@@ -81,6 +82,12 @@ export const SignInFactorOnePasswordCard = (props: SignInFactorOnePasswordProps)
 return clerk.__internal_navigateWithError('..', err.errors[0]);
 }

 if (isPasswordPwnedError(err) && onPasswordPwned) {
 card.setError({ ...err.errors[0], code: 'form_password_pwned__sign_in' });
 onPasswordPwned();
 return;
 }

 handleError(err, [passwordControl], card.setError);
 });
 };
Expand Down

147 changes: 147 additions & 0 deletions
packages/clerk-js/src/ui/components/SignIn/__tests__/SignInFactorOne.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -227,6 +227,153 @@ describe('SignInFactorOne', () => {
 });
 });
 });

 it('Prompts the user to reset their password via email if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your email ID');
 });
 });

 it('Prompts the user to reset their password via phone if it has been pwned', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithPhoneNumber({
 supportPassword: true,
 supportPhoneCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 await userEvent.click(screen.getByText('Reset your password'));
 screen.getByText('First, enter the code sent to your phone');
 });
 });

 it('entering a pwned password, then going back and clicking forgot password should result in the correct title', async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withEmailAddress();
 f.withPassword();
 f.withPreferredSignInStrategy({ strategy: 'password' });
 f.startSignInWithEmailAddress({
 supportPassword: true,
 supportEmailCode: true,
 supportResetPassword: true,
 });
 });
 fixtures.signIn.prepareFirstFactor.mockReturnValueOnce(Promise.resolve({} as SignInResource));

 const errJSON = {
 code: 'form_password_pwned',
 long_message:
 'Password has been found in an online data breach. For account safety, please reset your password.',
 message: 'Password has been found in an online data breach. For account safety, please reset your password.',
 meta: { param_name: 'password' },
 };

 fixtures.signIn.attemptFirstFactor.mockRejectedValueOnce(
 new ClerkAPIResponseError('Error', {
 data: [errJSON],
 status: 422,
 }),
 );

 await runFakeTimers(async () => {
 const { userEvent } = render(<SignInFactorOne />, { wrapper });
 await userEvent.type(screen.getByLabelText('Password'), '123456');
 await userEvent.click(screen.getByText('Continue'));

 await waitFor(() => {
 screen.getByText('Password compromised');
 screen.getByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 );
 screen.getByText('Or, sign in with another method');
 });

 // Go back
 await userEvent.click(screen.getByText('Back'));

 // Choose to reset password via "Forgot password" instead
 await userEvent.click(screen.getByText(/Forgot password/i));
 screen.getByText('Forgot Password?');
 expect(
 screen.queryByText(
 'This password has been found as part of a breach and can not be used, please reset your password.',
 ),
 ).not.toBeInTheDocument();
 });
 });
 });

 describe('Forgot Password', () => {
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/ui/elements/contexts/FlowMetadataContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,6 +25,7 @@ type FlowMetadata = {
 | 'emailLinkStatus'
 | 'alternativeMethods'
 | 'forgotPasswordMethods'
 | 'passwordPwnedMethods'
 | 'havingTrouble'
 | 'ssoCallback'
 | 'popover'
Expand Down
Loading