Dropbox

Dropbox OAuth2

Authorization Code Exchange para web e mobile — setup no console Dropbox, referência da API e exemplos de frontend.

Visão geral

O login Dropbox é opcional e controlado por DROPBOX_AUTH_ENABLED. Quando desligado, os endpoints Dropbox 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 os demais provedores sociais.

  • • Ativado por feature flag no ambiente
  • • Strategy passport-oauth2 customizada + DropboxAuthGuard
  • • Perfil obtido via POST https://api.dropboxapi.com/2/users/get_current_account after token exchange
  • • Scope account_info.read para perfil e e-mail
  • • Allowlist de redirect evita open redirects
  • • Mesmo formato de tokens do POST /auth/login

Dropbox App Console

Crie um app em https://www.dropbox.com/developers/apps. Defina OAuth 2 redirect URI igual a DROPBOX_CALLBACK_URL. Scope: account_info.read.

  1. Abra Dropbox App Console → Create app
  2. Escolha scoped access e o tipo de permissão necessário
  3. Adicione OAuth 2 redirect URI (ex.: http://localhost:3000/api/v1/auth/dropbox/callback)
  4. Copie App key / App secret para DROPBOX_CLIENT_ID / DROPBOX_CLIENT_SECRET
  5. Habilite account_info.read em Permissions
  6. Ative DROPBOX_AUTH_ENABLED=true no .env

Variáveis de ambiente

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

Environment.env
DROPBOX_AUTH_ENABLED=true
DROPBOX_CLIENT_ID=your-dropbox-app-key
DROPBOX_CLIENT_SECRET=your-dropbox-app-secret
DROPBOX_CALLBACK_URL=http://localhost:3000/api/v1/auth/dropbox/callback
DROPBOX_REDIRECT_ALLOWLIST=myapp://success,http://localhost:5173/auth/callback
DROPBOX_OAUTH_DEFAULT_ROLES=

Roles padrão para novos usuários Dropbox

Novos usuários Dropbox recebem roles: [] por padrão (igual ao register). Defina DROPBOX_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

  1. Cliente abre GET /api/v1/auth/dropbox?redirect=<URL na allowlist>
  2. Usuário consente no Dropbox; o browser chega em GET /api/v1/auth/dropbox/callback
  3. API chama https://api.dropboxapi.com/2/users/get_current_account, 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 JWTs

Referência da API

1. Iniciar OAuth

Abre o consentimento Dropbox em https://www.dropbox.com/oauth2/authorize. O query redirect deve corresponder a um prefixo em DROPBOX_REDIRECT_ALLOWLIST (ou omita para usar a primeira entrada). Scope: account_info.read.

HTTPGET /api/v1/auth/dropbox
GET /api/v1/auth/dropbox?redirect=http%3A%2F%2Flocalhost%3A5173%2Fauth%2Fcallback

400 redirect inválido · 503 feature desabilitada

2. Callback

Tratado pela API. A troca de token usa https://api.dropboxapi.com/oauth2/token. Redireciona para o app com ?code= (ou &code= se a URL já tiver query).

HTTPGET /api/v1/auth/dropbox/callback
GET /api/v1/auth/dropbox/callback?code=DROPBOX_AUTH_CODE&state=...
→ 302 Location: http://localhost:5173/auth/callback?code=EXCHANGE_CODE

3. Trocar o code

Endpoint público compartilhado com os demais provedores sociais. Consome o code (uso único) e devolve o mesmo formato do login.

HTTP RequestPOST /api/v1/auth/exchange
POST /api/v1/auth/exchange
Content-Type: application/json

{
  "code": "EXCHANGE_CODE"
}
HTTP Response200 OK
{
  "user": {
    "id": "...",
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "roles": [],
    "dropboxId": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
    "isActive": true
  },
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}

401 code inválido/expirado/usado · 503 social auth desabilitado

Frontend — Web (SPA)

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

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

// Redirect full-page Nest → Dropbox → de volta à SPA
window.location.href = `${API}/auth/dropbox?redirect=${redirect}`;
JavaScriptPágina de callback /auth/callback
// /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);
  • • Adicione a URL de callback do frontend em DROPBOX_REDIRECT_ALLOWLIST (ex.: http://localhost:5173/auth/callback)
  • • DROPBOX_CALLBACK_URL deve apontar para a API Nest, não para a SPA
  • • Armazene accessToken / refreshToken com segurança (memória + cookie httpOnly, conforme preferir)

Frontend — Mobile (deep link)

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

React NativeAbrir OAuth no browser
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 signInWithDropbox() {
  const url = `${API}/auth/dropbox?redirect=${redirect}`;
  await WebBrowser.openAuthSessionAsync(url, 'myapp://success');
}
React NativeDeep link + exchange
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 em HTTPS contra a URL base da API

Notas de segurança

  • • URLs de redirect devem corresponder a prefixos de DROPBOX_REDIRECT_ALLOWLIST
  • • Exchange codes são de uso único e expiram em 60 segundos (Redis)
  • • Usuários locais existentes são vinculados pelo e-mail verificado do Dropbox (dropboxId preenchido; roles inalteradas)
  • • Contas só-Dropbox têm password null — login / change-password falham até definir senha
  • • E-mail é obrigatório em https://api.dropboxapi.com/2/users/get_current_account; o login falha se Dropbox não retornar e-mail

Modelo de usuário

Campos da entity / interface usados no login Dropbox:

  • • dropboxId — id único nullable do Dropbox
  • • password — nullable para contas só-OAuth
  • • isActive — true para novos usuários Dropbox
  • • roles — de DROPBOX_OAUTH_DEFAULT_ROLES no env (padrão [])

Relacionados