feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

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

feat(ui): add a Back action to the authenticator app verification step#9626

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
paulogdm merged 14 commits into from
Sep 3, 2026
Merged

feat(ui): add a Back action to the authenticator app verification step #9626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6f71a36
feat(ui): add mobile deep-link for authenticator app QR setup
paulogdm Aug 31, 2026
fd74200
chore(localizations): regenerate locale files
paulogdm Aug 31, 2026
d34547d
fix(ui): center the open-in-authenticator-app action under the QR code
paulogdm Sep 1, 2026
41d2a2f
feat(ui): add a Back action to the authenticator app verification step
paulogdm Sep 1, 2026
f5b84aa
refactor(shared): make the new authenticator-app localization keys re…
paulogdm Sep 1, 2026
382a5ee
feat(localizations): translate buttonOpenInAuthenticatorApp__nonPrimary
paulogdm Sep 1, 2026
8eeedbd
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 1, 2026
24e6c4e
revert(ui): drop the open-in-authenticator-app deep link
paulogdm Sep 3, 2026
f441817
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
c61c4cd
refactor(ui): tighten the new MFA TOTP props and reuse the backLink d…
paulogdm Sep 3, 2026
40c89f0
Merge branch 'main' into fix/mfa-totp-qr-mobile-authenticator-link
paulogdm Sep 3, 2026
ac3e88c
refactor(ui): split the MFA TOTP ref into pending and verified
paulogdm Sep 3, 2026
bc399bf
Merge branch 'fix/mfa-totp-qr-mobile-authenticator-link' of https://g…
paulogdm Sep 3, 2026
ed2a64b
refactor(ui): drop redundant ref comments in MfaTOTPScreen
paulogdm Sep 3, 2026
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
5 changes: 5 additions & 0 deletions .changeset/mfa-totp-verify-back-button.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add a "Back" action to the authenticator-app verification step in `<UserProfile />`, so a user who needs to re-scan can return to the QR code instead of cancelling the whole setup. Going back now reuses the TOTP secret already issued rather than generating a new one, keeping any code the user has already scanned valid.
17 changes: 14 additions & 3 deletions packages/ui/src/components/UserProfile/AddAuthenticatorApp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,17 +18,18 @@ import { useActionContext } from '../../elements/Action/ActionRoot';

type AddAuthenticatorAppProps = FormProps & {
title: LocalizationKey;
pendingTotpRef: React.MutableRefObject<TOTPResource | undefined>;
};

type DisplayFormat = 'qr' | 'uri';

export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticatorAppProps) => {
const { title, onSuccess, onReset } = props;
const { title, onSuccess, onReset, pendingTotpRef } = props;
const { user } = useUser();
const card = useCardState();
const createTOTP = useReverification(() => user?.createTOTP());
const { close } = useActionContext();
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(undefined);
const [totp, setTOTP] = React.useState<TOTPResource | undefined>(pendingTotpRef.current);
const [displayFormat, setDisplayFormat] = React.useState<DisplayFormat>('qr');

// TODO: React18
Expand All@@ -38,8 +39,18 @@ export const AddAuthenticatorApp = withCardStateProvider((props: AddAuthenticato
return;
}

// Each createTOTP() mints a new secret server-side, so reuse the one already
// issued this session — otherwise navigating back here invalidates the QR the
// user has scanned.
if (pendingTotpRef.current) {
return;
}

void createTOTP()
.then(totp => setTOTP(totp))
.then(totp => {
pendingTotpRef.current = totp;
setTOTP(totp);
})
.catch(err => {
if (isClerkRuntimeError(err) && err.code === 'reverification_cancelled') {
return close();
Expand Down
9 changes: 6 additions & 3 deletions packages/ui/src/components/UserProfile/MfaTOTPScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,20 +15,23 @@ type MfaTOTPFormProps = FormProps;
export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) => {
const { onReset } = props;
const wizard = useWizard();
const ref = React.useRef<TOTPResource>();
const pendingTotpRef = React.useRef<TOTPResource>();
const verifiedTotpRef = React.useRef<TOTPResource>();

return (
<Wizard {...wizard.props}>
<AddAuthenticatorApp
title={localizationKeys('userProfile.mfaTOTPPage.title')}
onSuccess={wizard.nextStep}
onReset={onReset}
pendingTotpRef={pendingTotpRef}
/>

<VerifyTOTP
onSuccess={wizard.nextStep}
onReset={onReset}
resourceRef={ref}
onBack={wizard.prevStep}
verifiedTotpRef={verifiedTotpRef}
/>

<SuccessPage
Expand All@@ -38,7 +41,7 @@ export const MfaTOTPScreen = withCardStateProvider((props: MfaTOTPFormProps) =>
contents={
<MfaBackupCodeList
subtitle={localizationKeys('userProfile.backupCodePage.successSubtitle')}
backupCodes={ref.current?.backupCodes}
backupCodes={verifiedTotpRef.current?.backupCodes}
/>
}
/>
Expand Down
15 changes: 12 additions & 3 deletions packages/ui/src/components/UserProfile/VerifyTOTP.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,11 +12,12 @@ import { FormContainer } from '@/ui/elements/FormContainer';
import { Button, Col, descriptors, localizationKeys } from '../../customizables';

type VerifyTOTPProps = FormProps & {
resourceRef: React.MutableRefObject<TOTPResource | undefined>;
verifiedTotpRef: React.MutableRefObject<TOTPResource | undefined>;
onBack: () => void;
};

export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
const { onSuccess, onReset, resourceRef } = props;
const { onSuccess, onReset, onBack, verifiedTotpRef } = props;
const { user } = useUser();

const otp = useFieldOTP<TOTPResource>({
Expand All@@ -27,7 +28,7 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
.catch(reject);
},
onResolve: a => {
resourceRef.current = a;
verifiedTotpRef.current = a;
onSuccess();
},
});
Expand All@@ -50,6 +51,14 @@ export const VerifyTOTP = withCardStateProvider((props: VerifyTOTPProps) => {
localizationKey={localizationKeys('userProfile.formButtonReset')}
elementDescriptor={descriptors.formButtonReset}
/>

<Button
onClick={onBack}
variant='ghost'
isDisabled={otp.isLoading}
localizationKey={localizationKeys('backButton')}
elementDescriptor={descriptors.backLink}
/>
</FormButtonContainer>
</FormContainer>
);
Expand Down
57 changes: 57 additions & 0 deletions packages/ui/src/components/UserProfile/__tests__/MfaTOTPScreen.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
import type { TOTPResource } from '@clerk/shared/types';
import { act } from '@testing-library/react';
import { afterEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render } from '@/test/utils';
import { ActionRoot } from '@/ui/elements/Action/ActionRoot';

import { MfaTOTPScreen } from '../MfaTOTPScreen';

const { createFixtures } = bindCreateFixtures('UserProfile');

const totp = {
uri: 'otpauth://totp/Test:test@clerk.com?secret=TESTSECRET&issuer=Test',
secret: 'TESTSECRET',
} as TOTPResource;

describe('MfaTOTPScreen', () => {
afterEach(() => {
vi.clearAllMocks();
});

it('keeps the same TOTP secret when navigating back from the verification step', async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withAuthenticatorApp();
f.withUser({ two_factor_enabled: true });
});

fixtures.clerk.user?.createTOTP.mockResolvedValue(totp);

const { findByText, findByRole, getByRole, userEvent } = render(
<ActionRoot>
<MfaTOTPScreen
onSuccess={vi.fn()}
onReset={vi.fn()}
/>
</ActionRoot>,
{ wrapper },
);

await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);

await act(async () => {
await userEvent.click(getByRole('button', { name: /continue/i }));
});

await act(async () => {
await userEvent.click(await findByRole('button', { name: /^back$/i }));
});

// Back returns to the QR step without minting a new secret, so the code the
// user already scanned stays valid.
await findByText(/scan the following QR code/i);
expect(fixtures.clerk.user?.createTOTP).toHaveBeenCalledTimes(1);
});
});
Loading