Guia rápido: Next.js

Adicione o início de sessão a uma app Next.js com o App Router. O SDK @usher/nextjs está a caminho; até chegar, este guia usa o fluxo normalizado do OpenID Connect, que é exatamente o que o SDK vai fazer por si.

Antes de começar

Uma app Next.js 15 ou 16 que use o App Router.
Um ambiente do Usher. Na Usher Console, abra o seu projeto, escolha um ambiente e tome nota do seu emissor.

Registe a sua app

Na Console, vá a Aplicações e crie uma aplicação web. Adicione exatamente este URI de redirecionamento:

http://localhost:3000/auth/callback

Copie o ID de cliente e o segredo de cliente. O segredo só é mostrado uma vez.

Adicione as variáveis de ambiente

.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

Instale um cliente OpenID Connect

Qualquer cliente certificado serve. Este guia usa o openid-client, que trata da descoberta, do PKCE e da validação dos tokens.

Terminal

pnpm add openid-client

Descubra o seu emissor

A descoberta lê os endpoints e as chaves do emissor uma vez, para que nada fique definido diretamente no código.

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`

Envie as pessoas para o Lobby

Um route handler cria um verificador PKCE e um valor de state, guarda-os num cookie de curta duração e redireciona para o 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)
}

Trate do callback

O Usher devolve a pessoa com um código. Troque-o por tokens; o openid-client verifica por si o state, o verificador PKCE e a assinatura do token de 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('/')
}

Termine a sessão

Termine a sessão da pessoa na sua app e depois envie-a para o endpoint de fim de sessão do Usher, para que o Lobby também se esqueça dela.

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

Com o SDK

Quando o @usher/nextjs for publicado, a mesma app vai ficar assim. A pré-visualização abaixo pode mudar antes do lançamento.

app/layout.tsx · app/page.tsx (pré-visualização)

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

Próximos passos

Qualquer biblioteca OIDCAs definições, se estiver a usar outra linguagem ou framework. ConceitosEmissores, o Lobby e quanto tempo dura cada token.