GitHub OAuth2

O login GitHub é opcional e controlado por GITHUB_AUTH_ENABLED. Quando desligado, os endpoints GitHub 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 o Google.

• • Ativado por feature flag no ambiente
• • Passport GitHub strategy + GithubAuthGuard
• • Allowlist de redirect evita open redirects
• • Mesmo formato de tokens do POST /auth/login

Crie um OAuth App em GitHub → Settings → Developer settings → OAuth Apps. Defina Authorization callback URL igual a GITHUB_CALLBACK_URL.

1. Abra https://github.com/settings/developers → OAuth Apps → New OAuth App
2. Defina Application name e Homepage URL
3. Defina Authorization callback URL (ex.: http://localhost:3000/api/v1/auth/github/callback)
4. Copie Client ID e gere um Client Secret para o .env
5. Garanta o scope user:email (necessário para e-mail)

Carregadas do .env via src/config/github-oauth.config.ts (namespace githubOAuth no ConfigService). Veja .env.example.

GITHUB_AUTH_ENABLED=true
GITHUB_CLIENT_ID=your-github-client-id
GITHUB_CLIENT_SECRET=your-github-client-secret
GITHUB_CALLBACK_URL=http://localhost:3000/api/v1/auth/github/callback
GITHUB_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback
GITHUB_OAUTH_DEFAULT_ROLES=

Novos usuários GitHub recebem roles: [] por padrão (igual ao register). Defina GITHUB_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/github?redirect=<URL na allowlist>
2. Usuário consente no GitHub; o browser chama GET /api/v1/auth/github/callback
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: o botão inicia OAuth na mesma janela (ou popup); a rota de callback no 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 → GitHub → de volta à SPA
window.location.href = `${API}/auth/github?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 como sua app exigir
sessionStorage.setItem('accessToken', accessToken);
console.log('signed in', user.email);

• • Inclua a URL de callback do frontend em GITHUB_REDIRECT_ALLOWLIST (ex.: http://localhost:5173/auth/callback)
• • GITHUB_CALLBACK_URL aponta para a API Nest, não para a SPA
• • Armazene accessToken / refreshToken com segurança

Use um scheme customizado (ou universal link) na allowlist. Após o GitHub, 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 signInWithGitHub() {
  const url = `${API}/auth/github?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 na base URL da API

• • URLs de redirect devem casar com prefixos de GITHUB_REDIRECT_ALLOWLIST
• • Códigos de exchange são de uso único e expiram em 60 segundos (Redis)
• • Usuários locais existentes são vinculados pelo e-mail verificado do GitHub (githubId; roles inalteradas)
• • Usuários só-GitHub têm password null — login/change-password com senha falham até haver senha
• • Permissão email é obrigatória; o login falha se o GitHub não devolver e-mail

Campos da entity/interface usados pelo login GitHub:

• • githubId — ID GitHub único e nullable
• • password — nullable para contas só OAuth
• • isActive — true para novos usuários GitHub
• • roles — de GITHUB_OAUTH_DEFAULT_ROLES no env (padrão [])

• Hub de Autenticação Social
• Guia Google OAuth2
• Guia Facebook OAuth2
• Guia X / Twitter 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