เริ่มต้นอย่างรวดเร็ว: Next.js
เพิ่มการลงชื่อเข้าให้แอป Next.js ที่ใช้ App Router SDK @usher/nextjs กำลังจะมา ระหว่างที่รอ คู่มือนี้ใช้โฟลว์ OpenID Connect มาตรฐาน ซึ่งก็คือสิ่งที่ SDK จะทำแทนคุณนั่นเอง
ก่อนเริ่มต้น
- แอป Next.js 15 หรือ 16 ที่ใช้ App Router
- สภาพแวดล้อม Usher ใน Usher Console ให้เปิดโปรเจกต์ของคุณ เลือกสภาพแวดล้อม แล้วจด Issuer ของสภาพแวดล้อมนั้นไว้
ลงทะเบียนแอปของคุณ
ใน Console ไปที่ แอปพลิเคชัน แล้วสร้าง เว็บแอป จากนั้นเพิ่ม Redirect URI นี้ให้ตรงทุกตัวอักษร:
http://localhost:3000/auth/callbackคัดลอก Client ID และ Client secret ไว้ Client secret จะแสดงเพียงครั้งเดียว
เพิ่มตัวแปรสภาพแวดล้อม
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 ซึ่งจัดการ Discovery, PKCE และการตรวจสอบโทเค็นให้
pnpm add openid-clientค้นหาข้อมูลของ Issuer
Discovery อ่านเอนด์พอยต์และคีย์ของ Issuer เพียงครั้งเดียว จึงไม่ต้องเขียนค่าใดตายตัวไว้ในโค้ด
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
Route handler จะสร้าง PKCE verifier และค่า state เก็บไว้ในคุกกี้อายุสั้น แล้วเปลี่ยนเส้นทางไปยัง Lobby
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)
}จัดการ Callback
Usher ส่งผู้ใช้กลับมาพร้อมรหัส ให้นำรหัสไปแลกเป็นโทเค็น โดย openid-client จะตรวจสอบ state, PKCE verifier และลายเซ็นของโทเค็น ID ให้คุณ
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('/')
}ลงชื่อออก
ยุติเซสชันของผู้ใช้ในแอปของคุณ แล้วส่งผู้ใช้ไปยังเอนด์พอยต์ end-session ของ Usher เพื่อให้ Lobby ลืมผู้ใช้ด้วย
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/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 />
}