Hurtigstart: Next.js

Legg til pålogging i en Next.js-app med App Router. SDK-en @usher/nextjs er på vei; til den kommer, bruker denne veiledningen standard OpenID Connect-flyt, som er akkurat det SDK-en kommer til å gjøre for deg.

Før du begynner

En Next.js 15- eller 16-app som bruker App Router.
Et Usher-miljø. I Usher Console åpner du prosjektet ditt, velger et miljø og noterer utstederen.

Registrer appen din

I Console går du til Apper og oppretter en nettapp. Legg til akkurat denne omdirigerings-URI-en:

http://localhost:3000/auth/callback

Kopier klient-ID og klienthemmelighet. Hemmeligheten vises bare én gang.

Legg til miljøvariablene dine

.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

Installer en OpenID Connect-klient

Alle sertifiserte klienter fungerer. Denne veiledningen bruker openid-client, som tar seg av discovery, PKCE og validering av tokener.

Terminal

pnpm add openid-client

Finn utstederen din

Discovery leser utstederens endepunkter og nøkler én gang, så ingenting er hardkodet.

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`

Send folk til Lobbyen

En route handler lager en PKCE-verifikator og en state-verdi, lagrer dem i en kortlivet informasjonskapsel og sender videre til Lobbyen.

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

Håndter callback-en

Usher sender personen tilbake med en kode. Bytt den mot tokener; openid-client sjekker state-verdien, PKCE-verifikatoren og signaturen til ID-tokenet for deg.

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

Logg ut

Avslutt personens økt i appen din, og send dem deretter til Ushers end-session-endepunkt, så Lobbyen også glemmer dem.

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

Med SDK-en

Når @usher/nextjs er publisert, ser den samme appen slik ut. Forhåndsvisningen nedenfor kan endres før lansering.

app/layout.tsx · app/page.tsx (forhåndsvisning)

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

Neste trinn

Alle OIDC-bibliotekerInnstillingene, hvis du bruker et annet språk eller rammeverk. KonsepterUtstedere, Lobbyen og hvor lenge hvert token varer.