התחלה מהירה: Next.js

הוספת התחברות לאפליקציית Next.js עם ה-App Router. ה-SDK @usher/nextjs בדרך; עד שיגיע, המדריך הזה משתמש בזרימת OpenID Connect הסטנדרטית, שזה בדיוק מה שה-SDK יעשה בשבילך.

לפני שמתחילים

אפליקציית Next.js 15 או 16 שמשתמשת ב-App Router.
סביבת Usher. ב-Usher Console, פותחים את הפרויקט, בוחרים סביבה ורושמים בצד את המנפיק שלה.

רישום האפליקציה

ב-Console, עוברים אל אפליקציות ויוצרים אפליקציית אינטרנט. מוסיפים בדיוק את כתובת ההפניה (redirect URI) הזו:

http://localhost:3000/auth/callback

מעתיקים את מזהה לקוח ואת סוד לקוח. הסוד מוצג פעם אחת בלבד.

הוספת משתני הסביבה

.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

ה-route handler יוצר verifier של 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)
}

טיפול ב-callback

Usher מחזיר את האדם עם קוד. מחליפים אותו באסימונים; openid-client בודק בשבילך את ה-state, את ה-verifier של PKCE ואת החתימה של אסימון הזהות.

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('/')
}

התנתקות

מסיימים את הסשן של האדם באפליקציה שלך, ואז שולחים אותו לנקודת הקצה של סיום הסשן ב-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/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 />
}

השלבים הבאים

כל ספריית OIDCההגדרות, אם עובדים בשפה או ב-framework אחרים. מושגיםמנפיקים, ה-Lobby, וכמה זמן כל אסימון תקף.