Zum Inhalt springen
Dokumentation · Next.js

Schnellstart: Next.js

Füge einer Next.js-App mit dem App Router eine Anmeldung hinzu. Das SDK @usher/nextjs ist unterwegs; bis es da ist, nutzt diese Anleitung den standardmäßigen OpenID-Connect-Flow – genau das, was das SDK später für dich erledigt.

Bevor du anfängst

  • Eine Next.js-App (Version 15 oder 16) mit dem App Router.
  • Eine Usher-Umgebung. Öffne in Usher Console dein Projekt, wähle eine Umgebung und notiere dir ihren Issuer.

Registriere deine App

Öffne in Console Anwendungen und lege eine Webanwendung an. Füge genau diese Redirect-URI hinzu:

http://localhost:3000/auth/callback

Kopiere die Client-ID und das Client-Secret. Das Secret wird nur einmal angezeigt.

Lege deine Umgebungsvariablen an

.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

Installiere einen OpenID-Connect-Client

Jeder zertifizierte Client funktioniert. Diese Anleitung nutzt openid-client, das sich um Discovery, PKCE und die Prüfung der Tokens kümmert.

Terminal
pnpm add openid-client

Lies deinen Issuer per Discovery ein

Discovery liest die Endpunkte und Schlüssel des Issuers einmal ein, sodass nichts fest im Code steht.

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`

Schick Menschen zur Lobby

Ein Route Handler erzeugt einen PKCE-Verifier und einen State-Wert, legt beide in einem kurzlebigen Cookie ab und leitet zur Lobby weiter.

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

Verarbeite den Callback

Usher schickt die Person mit einem Code zurück. Tausche ihn gegen Tokens; openid-client prüft dabei den State, den PKCE-Verifier und die Signatur des ID-Tokens für dich.

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

Abmelden

Beende die Sitzung der Person in deiner App und schick sie dann zum End-Session-Endpunkt von Usher, damit auch die Lobby sie vergisst.

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

Mit dem SDK

Sobald @usher/nextjs veröffentlicht ist, sieht dieselbe App so aus. Die Vorschau unten kann sich bis zur Veröffentlichung noch ändern.

app/layout.tsx · app/page.tsx (Vorschau)
// 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 />
}

Nächste Schritte