Pika-aloitus: Next.js

Lisää kirjautuminen App Routeria käyttävään Next.js-sovellukseen. @usher/nextjs-SDK on tulossa; siihen asti tämä opas käyttää standardia OpenID Connect -kulkua, ja juuri sen SDK tulee tekemään puolestasi.

Ennen kuin aloitat

Next.js 15- tai 16-sovellus, joka käyttää App Routeria.
Usher-ympäristö. Avaa projektisi Usher Consolessa, valitse ympäristö ja kirjoita muistiin sen myöntäjä.

Rekisteröi sovelluksesi

Siirry Consolessa kohtaan Sovellukset ja luo verkkosovellus. Lisää tämä uudelleenohjaus-URI täsmälleen tällaisena:

http://localhost:3000/auth/callback

Kopioi asiakastunnus ja asiakassalaisuus. Salaisuus näytetään vain kerran.

Lisää ympäristömuuttujat

.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

Asenna OpenID Connect -asiakas

Mikä tahansa sertifioitu asiakas toimii. Tämä opas käyttää kirjastoa openid-client, joka hoitaa discoveryn, PKCE:n ja tunnusten validoinnin.

Pääte

pnpm add openid-client

Hae myöntäjän tiedot

Discovery lukee myöntäjän päätepisteet ja avaimet kerran, joten mitään ei tarvitse kovakoodata.

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`

Lähetä ihmiset Lobbyyn

Reitinkäsittelijä luo PKCE-todentajan ja state-arvon, säilyttää ne lyhytikäisessä evästeessä ja ohjaa Lobbyyn.

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

Käsittele takaisinkutsu

Usher lähettää ihmisen takaisin koodin kanssa. Vaihda koodi tunnuksiin; openid-client tarkistaa puolestasi state-arvon, PKCE-todentajan ja ID-tunnuksen allekirjoituksen.

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

Kirjaudu ulos

Lopeta ihmisen istunto sovelluksessasi ja lähetä hänet sitten Usherin istunnon lopetuspäätepisteeseen, jotta Lobbykin unohtaa hänet.

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:n kanssa

Kun @usher/nextjs on julkaistu, sama sovellus näyttää tältä. Alla oleva esikatselu voi muuttua ennen julkaisua.

app/layout.tsx · app/page.tsx (esikatselu)

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

Seuraavaksi

Mikä tahansa OIDC-kirjastoAsetukset, jos käytät jotakin muuta kieltä tai sovelluskehystä. KäsitteetMyöntäjät, Lobby ja kuinka kauan kukin tunnus on voimassa.