Google OAuth2
Authorization Code Exchange para web e mobile — setup no Google, referência da API e exemplos de frontend.
Visão geral
O login Google é opcional e controlado por GOOGLE_AUTH_ENABLED. Quando desligado, os endpoints Google respondem 503 Service Unavailable. JWTs nunca vão na URL de redirect; a API emite um exchangeCode de uso único (Redis, 60 segundos).
- • Ativado por feature flag no ambiente
- • Passport Google strategy + GoogleAuthGuard
- • Allowlist de redirect evita open redirects
- • Mesmo formato de tokens do POST /auth/login
Google Cloud Console
Crie (ou edite) um ID do cliente OAuth do tipo Aplicativo da Web. A URI de redirecionamento autorizada deve ser exatamente igual a GOOGLE_CALLBACK_URL.
1. Acessar as credenciais
- Abra o Google Cloud Console e selecione o projeto no menu superior
- No menu lateral: APIs e serviços → Credenciais
- Clique no ícone de lápis (Editar) ao lado do ID do cliente OAuth já criado, ou em + Criar credenciais → ID do cliente OAuth (Tipo: Aplicativo da Web)
2. Configurar as URLs
Na página de edição do aplicativo web, preencha as seções de links assim (use o host e a porta desta API).
Origens JavaScript autorizadas
URL base desta API Nest, incluindo a porta — sem path.
http://localhost:3000
URIs de redirecionamento autorizados
Rota exata de callback nesta API (mesmo valor de GOOGLE_CALLBACK_URL). Não use a rota da SPA aqui.
http://localhost:3000/api/v1/auth/google/callback
Depois de salvar, copie Client ID e Client Secret para o .env. URLs de pós-login do frontend ficam em GOOGLE_REDIRECT_ALLOWLIST, não na lista de redirect do Google.
Variáveis de ambiente
Carregadas do .env via src/config/google-oauth.config.ts (namespace googleOAuth no ConfigService). Veja .env.example.
GOOGLE_AUTH_ENABLED=true GOOGLE_CLIENT_ID=your-client-id.apps.googleusercontent.com GOOGLE_CLIENT_SECRET=your-client-secret GOOGLE_CALLBACK_URL=http://localhost:3000/api/v1/auth/google/callback GOOGLE_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback GOOGLE_OAUTH_DEFAULT_ROLES=
Roles padrão para novos usuários Google
Novos usuários Google recebem roles: [] por padrão (igual ao register). Defina GOOGLE_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.
Sequência
- Cliente abre GET /api/v1/auth/google?redirect=<URL na allowlist>
- Usuário consente no Google; o browser chama GET /api/v1/auth/google/callback
- API faz upsert do usuário, grava exchangeCode no Redis e redireciona para redirect?code=...
- Cliente faz POST { code } em /api/v1/auth/exchange e recebe os JWTs
Referência da API
1. Iniciar OAuth
Abre o consentimento do Google. O query redirect deve bater com um prefixo de GOOGLE_REDIRECT_ALLOWLIST (ou omita para usar a primeira entrada).
GET /api/v1/auth/google?redirect=http%3A%2F%2Flocalhost%3A5173%2Fauth%2Fcallback
400 redirect inválido · 503 feature desligada
2. Callback
Tratado pela API. Redireciona para o app com ?code= (ou &code= se a URL já tiver query).
GET /api/v1/auth/google/callback?code=GOOGLE_AUTH_CODE&state=... → 302 Location: http://localhost:5173/auth/callback?code=EXCHANGE_CODE
3. Trocar o código
Endpoint público. Consome o código (uso único) e devolve o mesmo formato do login.
POST /api/v1/auth/exchange
Content-Type: application/json
{
"code": "EXCHANGE_CODE"
}{
"user": {
"id": "...",
"email": "[email protected]",
"firstName": "Jane",
"lastName": "Doe",
"roles": [],
"googleId": "1082...",
"isActive": true
},
"accessToken": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}401 código inválido/expirado/já usado · 503 feature desligada
Frontend — Web (SPA)
Fluxo típico: botão inicia OAuth na mesma janela (ou popup); uma rota de callback na origem do frontend lê code da query e chama o exchange.
const API = 'http://localhost:3000/api/v1';
const redirect = encodeURIComponent(
'http://localhost:5173/auth/callback'
);
// Redirect de página inteira: Nest → Google → de volta à SPA
window.location.href = `${API}/auth/google?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 GOOGLE_REDIRECT_ALLOWLIST (ex.: http://localhost:5173/auth/callback)
- • GOOGLE_CALLBACK_URL aponta para a API Nest, não para a SPA
- • Guarde accessToken / refreshToken de forma segura (memória + cookie httpOnly, conforme o app)
Frontend — Mobile (deep link)
Use um scheme customizado (ou universal link) na allowlist. Depois do Google, a API redireciona para myapp://success?code=.... O app abre, lê o código e chama o 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 signInWithGoogle() {
const url = `${API}/auth/google?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
Segurança
- • URLs de redirect devem casar com prefixos de GOOGLE_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 Google (googleId; roles inalteradas)
- • Usuários só-Google têm password null — login/change-password com senha falham até definir senha
Modelo de usuário
Campos da entity/interface usados pelo login Google:
- • googleId — subject ID do Google, único e nullable
- • password — nullable para contas só OAuth
- • isActive — true para novos usuários Google (e-mail verificado pelo Google)
- • roles — de GOOGLE_OAUTH_DEFAULT_ROLES no env (padrão [])
Relacionados
- Hub de Autenticação Social
- Guia Facebook OAuth2
- Guia X / Twitter 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