As we build increasingly complex applications with NextJS 14, it's crucial to implement authentication and authorization correctly. Developers know that Identity Management and Authentication (IAM) is a revenue driver. Users need easy security they can place confidence in, and companies need organizational architectures and compliance.
Are you looking for a modern, easy-to-implement IAM that supports NextJS 14 application design and best practices? This article guides you through integrating Userfront authentication into your NextJS 14 app, focusing on security best practices.
We'll start by covering the basics of Userfront integration, but our main goal is to dive deep into the implementation of a secure, production-ready authentication system. We explore:
- Client-side authentication flows using Userfront's components
- Secure routing and protected layouts in NextJS 14
- Implementing server-side verification for sensitive data access, ensuring authorization checks are performed close to the data source
Throughout, we emphasize the separation of concerns between client and server, the importance of server-side validation, and the proper handling of JWTs.
Let's begin by setting up Userfront in a NextJS 14 project, and then we'll progressively build out our secure authentication infrastructure.
Get started with Userfront for NextJS 14
The Userfront Next SDK integrates seamlessly with NextJS, allowing developers to implement secure authentication quickly and efficiently. Userfront provides a comprehensive solution for adding authentication to your NextJS 14 application. It offers:
- A generous free tier with a user data source prepopulated
- Plug-and-play components
- A range of sign-on methods from emails to SSO
- Custom JWTs for the fields you want to capture
- Multi-tenancy
Here are four essential resources to get you started with Userfront in your NextJS 14 project:
- @userfront/next package on npm provides a set of components and hooks that make it easy to add authentication to your Next.js app.
- Quick Start guide walks you through the basics of setting up Userfront in your project, including:
- Installing the Userfront Next.js library
- Adding the Userfront provider to your layout
- Creating login, signup, and dashboard pages
- Userfront Next.js Guide is a more in-depth look at integrating Userfront with Next.js. This guide covers:
- Installation and setup
- Using the UserfrontProvider
- Client-side components and hooks
- Server-side methods and authentication
- Userfront NextJS 14 example on GitHub is a fully functional authentication setup using Userfront in a NextJS 14 application.
Build on the Userfront NextJS 14 example
Now that we've covered the basics, let's dive into some best practices for using Userfront with NextJS 14. We'll focus on understanding NextJS 14's design principles and how to keep sensitive data secure to ensure that:
- Only requests with valid JWTs can access the protected data
- The server verifies the user's identity before returning any sensitive information
- The client-side component (
UserDataComponent
) can't access this data without a valid token
Set up the project
First, make sure you have a Next.js 14 project set up with Userfront installed. If you haven't done this yet, you can grab the example from GitHub by downloading the folder. For example, you can go to download-directory and enter the NextJS project: https://github.com/userfront/examples/tree/main/next-14
.
Open the project up and install it with:
npm install
Run the example:
npm run dev
Next, we’ll add a header that changes based on the user login state, a secured router, and a dashboard page that fetches user data if the JWT is verified.
Create a Header component
Let's start by creating a header component that changes based on the user's authentication status:
// app/_components/Header.tsx
"use client";
import Link from 'next/link';
import { useUserfront } from "@userfront/next/client";
export default function Header() {
const { isAuthenticated, logout } = useUserfront();
return (
<header className="p-4">
<nav className="flex justify-between items-center">
<Link href="/" className="text-lg font-bold">My App</Link>
<div>
{isAuthenticated ? (
<>
<Link href="/dashboard" className="mr-4">Dashboard</Link>
<button onClick={() => logout({ redirect: '/' })} className="bg-blue-500 text-white px-4 py-2 rounded">Logout</button>
</>
) : (
<>
<Link href="/login" className="mr-4">Login</Link>
<Link href="/signup" className="mr-4">Signup</Link>
</>
)}
</div>
</nav>
</header>
);
}
This header component uses the useUserfront hook to determine if the user is authenticated and displays appropriate navigation links.
Then, we’ll update the app layout to include that header. Replace the contents of app/layout.tsx with the following code:
import type { Metadata } from "next";
import { Inter } from "next/font/google";
import "./globals.css";
import { UserfrontProvider } from "@userfront/next/client";
import Header from './_components/Header';
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body className="flex justify-center">
<div className="w-full max-w-5xl px-4 pt-8">
<UserfrontProvider tenantId={process.env.NEXT_PUBLIC_USERFRONT_TENANT_ID!}>
<Header />
{children}
</UserfrontProvider>
</div>
</body>
</html>
);
}
Secure routes with layout
Next, let's create a secure layout that protects our dashboard and other sensitive pages. Secure layouts provide a client-side redirect for unauthenticated users, but remember that true security should be implemented server-side.
// app/(secure)/layout.tsx
"use client";
import * as React from "react";
import { useRouter } from "next/navigation";
import { useUserfront } from "@userfront/next/client";
export default function SecureLayout({ children }: { children: React.ReactNode }) {
const router = useRouter();
const { isAuthenticated, isLoading } = useUserfront();
React.useEffect(() => {
if (isAuthenticated || isLoading || !router) return;
router.push("/login");
}, [isAuthenticated, isLoading, router]);
if (!isAuthenticated || isLoading) {
return null;
}
return children;
}
This layout ensures that only authenticated users can access the pages within the
(secure) folder.
Fetch Userfront data as server-side call
To fetch data on the server, we’ll can the UserfrontClient along with the Userfront Admin API key and Tenant ID, which are found in the dashboard.
"use server";
import { UserfrontClient } from "@userfront/next/server";
import Image from "next/image";
// Initialize the Userfront client
const Userfront = new UserfrontClient({
apiKey: process.env.USERFRONT_API_KEY,
tenantId: process.env.NEXT_PUBLIC_USERFRONT_TENANT_ID,
});
export default async function ServerPage() {
try {
// Get the tenant information
const tenant = await Userfront.getTenant(process.env.NEXT_PUBLIC_USERFRONT_TENANT_ID);
return (
<div className="container">
<h1>Server Example with Data Fetching</h1>
{tenant.image && (
<div style={{ marginBottom: '20px' }}>
<Image
src={tenant.image}
alt="Tenant Image"
width={100}
height={100}
/>
</div>
)}
<h2>Tenant Information:</h2>
<pre>{JSON.stringify(tenant, null, 2)}</pre>
</div>
);
} catch (error) {
console.error("Error fetching tenant:", error);
return (
<div>
<h1>Server Example with Data Fetching</h1>
<p>Error: Unable to fetch tenant information</p>
</div>
);
}
}
We’ll also add Cloudinary as an image in the root next.config.mjs file:
/** @type {import('next').NextConfig} */
const nextConfig = {
images: {
domains: ['res.cloudinary.com'],
},
};
export default nextConfig;
Now if you run the app, login, and go to the Dashboard, the link Server Example with Data Fetching takes you to a page that displays administrative data about the tenancy.
This is admin data. Dashboards usually display user data, but should do so only if the user’s JWT token has been verified. Next, we’ll create:
- A protected route that verifies the user before exposing the component
- A
UserDataComponent
that relies on that protected route
An updated dashboard that displays the UserDataComponent
Implement a protected API route
This protected API route implements server-side JWT verification, which is crucial for securing server-side data access. We’ll need the jsonwebtoken package to verify the access token:
npm install jsonwebtoken
To securely handle sensitive user data, we'll create a new app/api/protected-route/route.ts file that is protected API route when the JWT token is verified:
// app/api/protected-route/route.ts
import { NextRequest, NextResponse } from 'next/server';
import { UserfrontClient } from "@userfront/next/server";
import jwt, { JwtPayload } from 'jsonwebtoken'; // requires install of this package
const userfront = new UserfrontClient({
tenantId: process.env.NEXT_PUBLIC_USERFRONT_TENANT_ID!,
});
const JWT_PUBLIC_KEY = process.env.USERFRONT_JWT_PUBLIC_KEY!;
interface UserFrontJwtPayload extends JwtPayload {
userId?: string;
}
export async function GET(request: NextRequest) {
try {
const authHeader = request.headers.get('authorization');
if (!authHeader) {
return NextResponse.json({ error: 'No authorization header' }, { status: 401 });
}
const token = authHeader.split(' ')[1];
// Verify the JWT
const decoded = jwt.verify(token, JWT_PUBLIC_KEY, { algorithms: ['RS256'] }) as UserFrontJwtPayload;
if (typeof decoded === 'string' || !decoded.userId) {
throw new Error('Invalid token payload');
}
const userId = decoded.userId;
// Fetch additional user data if needed
const userData = await userfront.getUser(userId);
return NextResponse.json({ userData });
} catch (error) {
console.error('Authentication error:', error);
return NextResponse.json({ error: 'Authentication failed' }, { status: 401 });
}
}
Fetch sensitive user Data
UserDataComponent
demonstrates client-side API calls with authentication tokens, aligning with the 'HTTP APIs' approach. However, it relies on proper server-side implementation for actual security. For fetching sensitive user data, we'll create a separate component that makes an authenticated API call. Create a new app/(secure)/dashboard/UserDataComponent.tsx
file with the following code:
// app/(secure)/dashboard/UserDataComponent.tsx
'use client';
import { useState, useEffect } from 'react';
import { useUserfront } from "@userfront/next/client";
interface UserData {
userId: string;
email: string;
username?: string;
}
export default function UserDataComponent() {
const [userData, setUserData] = useState<UserData | null>(null);
const [loading, setLoading] = useState(true);
const [error, setError] = useState<string | null>(null);
const userfront = useUserfront();
useEffect(() => {
async function fetchUserData() {
const accessToken = userfront.accessToken();
if (!accessToken) {
setLoading(false);
setError('Not authenticated');
return;
}
try {
const response = await fetch('/api/protected-route', {
headers: {
'Authorization': `Bearer ${accessToken}`,
},
});
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
const data = await response.json();
setUserData(data.userData);
} catch (err) {
setError(`Error fetching user data: ${err instanceof Error ? err.message : String(err)}`);
} finally {
setLoading(false);
}
}
fetchUserData();
}, [userfront]);
if (loading) return <div>Loading additional user data...</div>;
if (error) return <div>Error loading additional data: {error}</div>;
if (!userData) return <div>No additional user data available</div>;
return (
<div className="mt-4">
<h2 className="text-xl font-semibold">Additional User Information</h2>
<p>User ID: {userData.userId}</p>
<p>Username: {userData.username}</p>
</div>
);
}
Update the dashboard with the user data component
Now, let's update the dashboard page to display user information. This dashboard component uses client-side data from Userfront, but doesn't inherently provide security. It should be used in conjunction with server-side protections.
// app/(secure)/dashboard/page.tsx
"use client";
import * as React from "react";
import { useUserfront } from "@userfront/next/client";
import UserDataComponent from './UserDataComponent';
export default function DashboardPage() {
const { user } = useUserfront();
return (
<div className="container mx-auto p-4">
<h1 className="text-2xl font-bold mb-4">Dashboard</h1>
<p>Hello, {user.email}</p>
<UserDataComponent />
<LogoutButton />
<Link href="/server">Server Example with Async Data Fetching →</Link>
</div>
);
}
Security-charged component
Now you have server-side JWT verification in the protected API route that provides the necessary security for the UserDataComponent
. Here's why:
- Token Verification: The API route verifies the JWT using the Userfront JWT public key, ensuring the token is valid and hasn't been tampered with.
- User Authentication: After verifying the token, it extracts the
userId
from the decoded token payload, confirming the user's identity. - Authorization: While not explicitly shown in our example, the
userfront.getUser(userId)
call could be used to fetch user-specific data. - Data Protection: Only after successful verification and potential authorization does the route return user data.
However, it's worth noting:
- The security of this system relies on proper management of the JWT public key and other environment variables.
- Additional authorization checks might be necessary depending on the specific requirements of your application (e.g., checking user roles or permissions).
- While this setup provides good security, always remember that security is a multi-layered concern. This should be part of a comprehensive security strategy including secure coding practices, regular audits, and following the principle of least privilege.
Conclusion
By following these steps and best practices, you can create a secure, authenticated Next.js 14 application using Userfront. Remember to always verify JWTs on the server-side before granting access to sensitive data or protected routes.
Some key takeaways:
- Use the
UserfrontProvider
to wrap your application and provide authentication context. - Implement protected layouts to secure entire sections of your app.
- Always verify JWTs on the server-side before returning sensitive data.
- Use tools like environment variables to store sensitive information like API keys and JWT public keys and exclude them from check-ins.
- Take advantage of Next.js 14's built-in API routes for server-side operations.
By understanding and implementing these concepts, you'll be well on your way to creating secure, scalable Next.js applications with Userfront authentication.