Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix Force MFA Guide #1834

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 0 additions & 48 deletions docs/custom-flows/manage-totp-based-mfa.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -305,54 +305,6 @@ One of the options that Clerk supports for MFA is **Authenticator applications (
```
</Tab>
</Tabs>

### Force MFA (optional)

While Clerk does not natively enforce MFA for all users, you can implement this functionality by using `clerkMiddleware()` to check whether a user has MFA enabled.

The following example demonstrates how to force MFA for all users. It uses `clerkMiddleware()` to intercept all requests and check whether a user has MFA enabled. If the user does not have MFA enabled, `clerkMiddleware()` redirects them to the `/mfa` page where they can set up MFA.

```tsx {{ filename: 'middleware.ts', collapsible: true }}
import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server'
import { NextResponse } from 'next/server'

const isMFARoute = createRouteMatcher(['/account/manage-mfa/add(.*)'])
const isSignInRoute = createRouteMatcher(['/sign-in(.*)'])

export default clerkMiddleware(async (auth, req) => {
const { userId } = await auth()

// Redirect to homepage if the user is signed in and on the sign-in page
if (userId !== null && isSignInRoute(req) && !isMFARoute(req)) {
return NextResponse.redirect(new URL('/', req.url))
}

// Check if the user is signed in and not on the MFA page
if (userId !== null && !isMFARoute(req)) {
const res = await fetch(`https://api.clerk.com/v1/users/${userId}`, {
headers: {
Authorization: `Bearer ${process.env.CLERK_SECRET_KEY}`,
},
})

const userData = await res.json()

// Redirect to MFA setup page if MFA is not enabled
if (userData.two_factor_enabled === false) {
return NextResponse.redirect(new URL('/account/manage-mfa/add', req.url))
}
}
})

export const config = {
matcher: [
// Skip Next.js internals and all static files, unless found in search params
'/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)',
// Always run for API routes
'/(api|trpc)(.*)',
],
}
```
</Tab>

<Tab>
Expand Down
70 changes: 70 additions & 0 deletions docs/guides/force-mfa.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Force MFA for all users
description: Learn how to force Multi-Factor Authentication in your Clerk application.
---

<TutorialHero
beforeYouStart={[
{
title: "Customize your session token",
link: "/docs/backend-requests/making/custom-session-token",
icon: "clerk",
},
{
title: "Build a custom flow for managing TOTP-based multi-factor authentication",
link: "/docs/custom-flows/manage-totp-based-mfa",
icon: "globe",
}
]}
>
- Detect if a user has MFA enabled or not
- Redirect users to set up MFA if it is not enabled
</TutorialHero>

While Clerk does not natively enforce MFA for all users, you can implement this functionality by using `clerkMiddleware()` to check whether a user has MFA enabled.

The following example demonstrates how to force MFA for all users. It uses `clerkMiddleware()` to intercept all requests and check whether a user has MFA enabled. If the user does not have MFA enabled, `clerkMiddleware()` redirects them to the `/mfa` page where they can set up MFA.

<Steps>
## Customize the Session Token to Include `two_factor_enabled` Property

1. In the Clerk Dashboard, navigate to the [**Sessions**](https://dashboard.clerk.com/last-active?path=sessions) page.
1. In the **Customize your session token** section, click the **Edit** button.
1. In the modal that opens, add the `two_factor_enabled` property to the session token.

![Clerk Dashboard showing the custom claim modal](/docs/images/guides/force-mfa/edit-session-token.png)

## Create a Middleware to Check if MFA is Enabled

After you followed this guide [here](/docs/backend-requests/making/custom-session-token), you should have a middleware that checks if a user is logged in. You can add the following code to that middleware to check if the user has MFA enabled.

```tsx {{ filename: 'middleware.ts', collapsible: true }}
import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server'
import { NextResponse } from 'next/server'

const isMFARoute = createRouteMatcher(['/mfa(.*)'])
const isSignInRoute = createRouteMatcher(['/sign-in(.*)'])
export default clerkMiddleware(async (auth, req) => {
const { userId, sessionClaims } = await auth()

if (userId !== null && isSignInRoute(req) && !isMFARoute(req)) {
// redirect to root if logged in
return NextResponse.redirect(new URL('/', req.url))
}
if (userId !== null && !isMFARoute(req)) {
if (sessionClaims.isMfa === false) {
return NextResponse.redirect(new URL('/mfa', req.url))
}
}
})

export const config = {
matcher: [
// Skip Next.js internals and all static files, unless found in search params
'/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)',
// Always run for API routes
'/(api|trpc)(.*)',
],
}
```
</Steps>
4 changes: 4 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,10 @@
{
"title": "Override Clerk interfaces with custom types",
"href": "/docs/guides/custom-types"
},
{
"title": "Force MFA",
"href": "/docs/guides/force-mfa"
}
]
]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading