快速入门:Next.js
为使用 App Router 的 Next.js App 添加登录功能。@usher/nextjs SDK 即将推出;在它推出之前,本指南使用标准的 OpenID Connect 流程,这也正是 SDK 将会替你完成的事情。
开始之前
- 一个使用 App Router 的 Next.js 15 或 16 App。
- 一个 Usher 环境。在 Usher Console 中打开你的项目,选择一个环境,并记下它的颁发者。
注册你的 App
在 Console 中前往 应用,创建一个 Web 应用。完全按照下面的内容添加这个重定向 URI:
http://localhost:3000/auth/callback拷贝客户端 ID 和客户端机密。机密只会显示一次。
添加环境变量
.env.local
USHER_ISSUER=https://acme.usherid.com
USHER_CLIENT_ID=your_client_id
USHER_CLIENT_SECRET=your_client_secret
APP_URL=http://localhost:3000安装 OpenID Connect 客户端
任何经过认证的客户端都可以使用。本指南使用 openid-client,它负责处理发现、PKCE 和令牌验证。
终端
pnpm add openid-client发现你的颁发者
发现过程会一次性读取颁发者的端点和密钥,因此无需硬编码任何内容。
lib/usher.ts
import * as client from 'openid-client'
let config: Promise<client.Configuration> | undefined
export function usher() {
config ??= client.discovery(
new URL(process.env.USHER_ISSUER!),
process.env.USHER_CLIENT_ID!,
process.env.USHER_CLIENT_SECRET!,
)
return config
}
export const redirectUri = `${process.env.APP_URL}/auth/callback`将用户送往 Lobby
一个路由处理程序生成 PKCE 验证器和 state 值,将它们保存在一个短期有效的 Cookie 中,然后重定向到 Lobby。
app/auth/sign-in/route.ts
import * as client from 'openid-client'
import { cookies } from 'next/headers'
import { redirect } from 'next/navigation'
import { redirectUri, usher } from '@/lib/usher'
export async function GET() {
const config = await usher()
const codeVerifier = client.randomPKCECodeVerifier()
const state = client.randomState()
const jar = await cookies()
jar.set('usher_flow', JSON.stringify({ codeVerifier, state }), {
httpOnly: true,
secure: process.env.NODE_ENV === 'production',
sameSite: 'lax',
path: '/auth',
maxAge: 600,
})
const url = client.buildAuthorizationUrl(config, {
redirect_uri: redirectUri,
scope: 'openid profile email offline_access',
code_challenge: await client.calculatePKCECodeChallenge(codeVerifier),
code_challenge_method: 'S256',
state,
})
redirect(url.href)
}处理回调
Usher 会带着授权码把用户送回来。用它换取令牌;openid-client 会替你检查 state、PKCE 验证器和 ID 令牌的签名。
app/auth/callback/route.ts
import * as client from 'openid-client'
import { cookies } from 'next/headers'
import { redirect } from 'next/navigation'
import { usher } from '@/lib/usher'
export async function GET(request: Request) {
const config = await usher()
const jar = await cookies()
const flow = JSON.parse(jar.get('usher_flow')?.value ?? '{}')
jar.delete('usher_flow')
const tokens = await client.authorizationCodeGrant(config, new URL(request.url), {
pkceCodeVerifier: flow.codeVerifier,
expectedState: flow.state,
})
const claims = tokens.claims()! // sub, email, name, …
// start your own session here: store claims.sub, and keep the refresh token server-side
redirect('/')
}退出登录
先在你的 App 中结束用户的会话,然后将用户送往 Usher 的结束会话端点,让 Lobby 也忘记他们。
app/auth/sign-out/route.ts
import * as client from 'openid-client'
import { redirect } from 'next/navigation'
import { usher } from '@/lib/usher'
export async function GET() {
const config = await usher()
// clear your own session first
const url = client.buildEndSessionUrl(config, {
post_logout_redirect_uri: process.env.APP_URL!,
})
redirect(url.href)
}使用 SDK
@usher/nextjs 发布后,同一个 App 会是下面这个样子。以下预览在正式发布前可能会有变化。
app/layout.tsx · app/page.tsx(预览)
// app/layout.tsx
import { UsherProvider } from '@usher/nextjs'
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<body>
<UsherProvider>{children}</UsherProvider>
</body>
</html>
)
}
// app/page.tsx
import { SignIn, UserButton, currentUser } from '@usher/nextjs'
export default async function Page() {
const user = await currentUser()
return user ? <UserButton /> : <SignIn />
}