X / Twitter OAuth2

O login X / Twitter é opcional e controlado por TWITTER_AUTH_ENABLED. Quando desligado, os endpoints Twitter respondem 503 Service Unavailable. JWTs nunca vão na URL de redirect; a API emite um exchangeCode de uso único (Redis, 60 segundos). O mesmo POST /auth/exchange é compartilhado com Google e Facebook. O X exige PKCE, por isso a API usa session Fastify (@fastify/session) com cookie SameSite=Lax (necessário para o round-trip do PKCE).

• • Ativado por feature flag no ambiente
• • Passport Twitter OAuth2 (@superfaceai) + TwitterAuthGuard
• • PKCE com session Fastify
• • Allowlist de redirect evita open redirects
• • Mesmo formato de tokens do POST /auth/login

Crie um Project e App com OAuth 2.0, ative Request email from users e configure o Callback URI igual a TWITTER_CALLBACK_URL.

1. Abra developer.x.com → Projects & Apps → crie um Project e App
2. Em User authentication settings, habilite OAuth 2.0
3. Ative “Request email from users” (necessário para users.email / confirmed_email)
4. Defina Callback URI / Redirect URL (ex.: http://localhost:3000/api/v1/auth/twitter/callback)
5. Copie Client ID e Client Secret para o .env
6. Scopes usados por esta API: tweet.read, users.read, offline.access, users.email

Carregadas do .env via src/config/twitter-oauth.config.ts (namespace twitterOAuth no ConfigService). Veja .env.example. Defina SESSION_SECRET (ou use JWT_SECRET) para as sessions do PKCE.

TWITTER_AUTH_ENABLED=true
TWITTER_CLIENT_ID=your-twitter-client-id
TWITTER_CLIENT_SECRET=your-twitter-client-secret
TWITTER_CALLBACK_URL=http://localhost:3000/api/v1/auth/twitter/callback
TWITTER_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback
TWITTER_OAUTH_DEFAULT_ROLES=
# SESSION_SECRET=optional-session-secret

Novos usuários Twitter recebem roles: [] por padrão (igual ao register). Defina TWITTER_OAUTH_DEFAULT_ROLES no .env como lista separada por vírgula (ex.: user ou user,manager). Usuários existentes vinculados por e-mail mantêm as roles atuais.

1. Cliente abre GET /api/v1/auth/twitter?redirect=<URL na allowlist>
2. Usuário consente no X; o browser chama GET /api/v1/auth/twitter/callback (PKCE via session)
3. API faz upsert do usuário, grava exchangeCode no Redis e redireciona para redirect?code=...
4. Cliente faz POST { code } em /api/v1/auth/exchange e recebe os JWTs

Fluxo típico: botão inicia OAuth na mesma janela (ou popup); uma rota de callback no origin do frontend lê code da query e chama exchange.

const API = 'http://localhost:3000/api/v1';
const redirect = encodeURIComponent(
  'http://localhost:5173/auth/callback'
);

// Redirect de página inteira: Nest → X → de volta à SPA
window.location.href = `${API}/auth/twitter?redirect=${redirect}`;

// /auth/callback na SPA
const params = new URLSearchParams(window.location.search);
const code = params.get('code');
if (!code) throw new Error('Missing exchange code');

const res = await fetch('http://localhost:3000/api/v1/auth/exchange', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ code }),
});
if (!res.ok) throw new Error(await res.text());

const { user, accessToken, refreshToken } = await res.json();
// persista os tokens conforme o app
sessionStorage.setItem('accessToken', accessToken);
console.log('signed in', user.email);

• • Adicione a URL de callback do frontend em TWITTER_REDIRECT_ALLOWLIST (ex.: http://localhost:5173/auth/callback)
• • TWITTER_CALLBACK_URL deve apontar para a API Nest, não para a SPA
• • Guarde accessToken / refreshToken com segurança (memória + cookie httpOnly, conforme o app)

Use um scheme customizado (ou universal link) na allowlist. Após o X, a API redireciona para myapp://success?code=.... O app abre, lê o código e chama exchange.

import * as Linking from 'expo-linking';
import * as WebBrowser from 'expo-web-browser';

const API = 'https://api.example.com/api/v1';
const redirect = encodeURIComponent('myapp://success');

async function signInWithTwitter() {
  const url = `${API}/auth/twitter?redirect=${redirect}`;
  await WebBrowser.openAuthSessionAsync(url, 'myapp://success');
}

import * as Linking from 'expo-linking';

async function exchangeFromUrl(url) {
  const { queryParams } = Linking.parse(url);
  const code = queryParams?.code;
  if (!code) return;

  const res = await fetch(`${API}/auth/exchange`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ code }),
  });
  const data = await res.json();
  // data.accessToken, data.refreshToken, data.user
  return data;
}

Linking.addEventListener('url', ({ url }) => {
  exchangeFromUrl(url);
});

• • Registre o scheme no SO / Expo app.json
• • Prefira Linking.addEventListener('url', ...) e getInitialURL()
• • Faça o exchange via HTTPS contra a base URL da API

• • URLs de redirect devem bater com prefixos de TWITTER_REDIRECT_ALLOWLIST
• • Códigos de exchange são de uso único e expiram em 60 segundos (Redis)
• • O code_verifier do PKCE fica na cookie de session Fastify (SameSite=Lax)
• • Usuários locais existentes são vinculados pelo e-mail verificado do Twitter (twitterId; roles inalteradas)
• • Usuários só-Twitter têm password null — login/change-password com senha falham até haver senha
• • users.email + confirmed_email são obrigatórios; o login falha se o X não devolver e-mail

Campos da entity/interface usados pelo login X / Twitter:

• • twitterId — ID X / Twitter único e nullable
• • password — nullable para contas só OAuth
• • isActive — true para novos usuários Twitter
• • roles — de TWITTER_OAUTH_DEFAULT_ROLES no env (padrão [])

• Hub de Autenticação Social
• Guia Google OAuth2
• Guia Facebook OAuth2
• Guia GitHub OAuth2
• Guia Figma OAuth2
• Guia LinkedIn OpenID Connect
• Guia Slack OpenID Connect
• Guia Atlassian OAuth 2.0 (3LO)
• Guia GitLab OAuth2
• Guia Bitbucket OAuth2
• Guia Discord OAuth2
• Guia Twitch OAuth2
• Guia Steam OpenID 2.0
• Guia Reddit OAuth2
• Auth & JWT