Szybki start: Next.js

Dodaj logowanie do aplikacji Next.js korzystającej z App Router. SDK @usher/nextjs jest w drodze; dopóki się nie pojawi, ten przewodnik korzysta ze standardowego przepływu OpenID Connect, czyli dokładnie z tego, co SDK zrobi za Ciebie.

Zanim zaczniesz

Aplikacja Next.js 15 lub 16 korzystająca z App Router.
Środowisko Usher. W Usher Console otwórz projekt, wybierz środowisko i zanotuj jego wystawcę (issuer).

Zarejestruj aplikację

W Console przejdź do sekcji Aplikacje i utwórz aplikację internetową. Dodaj dokładnie ten URI przekierowania:

http://localhost:3000/auth/callback

Skopiuj identyfikator klienta i sekret klienta. Sekret jest wyświetlany tylko raz.

Dodaj zmienne środowiskowe

.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

Zainstaluj klienta OpenID Connect

Działa każdy certyfikowany klient. Ten przewodnik korzysta z biblioteki openid-client, która obsługuje wykrywanie, PKCE i walidację tokenów.

Terminal

pnpm add openid-client

Wykryj konfigurację wystawcy

Wykrywanie jednorazowo odczytuje punkty końcowe i klucze wystawcy, więc nic nie jest zakodowane na sztywno.

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`

Skieruj ludzi do Lobby

Procedura obsługi trasy (route handler) tworzy weryfikator PKCE i wartość state, przechowuje je w krótkotrwałym pliku cookie i przekierowuje do 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)
}

Obsłuż wywołanie zwrotne

Usher odsyła daną osobę z kodem. Wymień go na tokeny; openid-client sprawdzi za Ciebie wartość state, weryfikator PKCE i podpis tokenu 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('/')
}

Wyloguj

Zakończ sesję danej osoby w swojej aplikacji, a następnie skieruj ją do punktu końcowego zakończenia sesji Usher, aby Lobby również o niej zapomniało.

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)
}

Z SDK

Gdy @usher/nextjs zostanie opublikowany, ta sama aplikacja będzie wyglądać tak. Poniższy podgląd może się zmienić przed wydaniem.

app/layout.tsx · app/page.tsx (podgląd)

// 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 />
}

Dalsze kroki

Dowolna biblioteka OIDCUstawienia, jeśli korzystasz z innego języka lub frameworka. PojęciaWystawcy, Lobby i czas ważności poszczególnych tokenów.