Швидкий старт: Next.js

Додайте вхід у програму Next.js з App Router. SDK @usher/nextjs на підході; доки його немає, цей посібник використовує стандартний потік OpenID Connect — саме те, що SDK робитиме за вас.

Перш ніж почати

Програма на Next.js 15 або 16 з App Router.
Середовище Usher. В Usher Console відкрийте свій проєкт, виберіть середовище й запишіть його видавця.

Зареєструйте свою програму

У Console перейдіть до розділу Програми і створіть вебпрограму. Додайте точно такий URI переспрямування:

http://localhost:3000/auth/callback

Скопіюйте ID клієнта та секрет клієнта. Секрет показується лише один раз.

Додайте змінні середовища

.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

Обробник маршруту створює верифікатор 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)
}

Обробіть зворотний виклик

Usher повертає людину з кодом. Обміняйте його на токени; openid-client сам перевірить state, верифікатор PKCE і підпис 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('/')
}

Вихід

Завершіть сеанс людини у своїй програмі, а потім надішліть її до кінцевої точки завершення сеансу 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Налаштування, якщо ви використовуєте іншу мову чи фреймворк. Основні поняттяВидавці, Lobby і те, скільки діє кожен токен.