Obedecer às políticas do OAuth 2.0

Este guia descreve como resolver os problemas mais comuns encontrados pelos desenvolvedores ao preparar o app para produção.

Visão geral

Quando você estiver pronto para implantar a solução implementada além do ambiente de desenvolvimento para os usuários do app, talvez seja necessário seguir outras etapas para obedecer às políticas do OAuth 2.0 do Google. Neste guia, descrevemos como resolver os problemas mais comuns encontrados pelos desenvolvedores ao preparar o app para produção. Isso ajuda você a alcançar o maior público possível com erros limitados.

Usar projetos separados para teste e produção

As políticas do OAuth do Google exigem projetos separados para teste e produção. Algumas políticas e requisitos só se aplicam a apps de produção. Talvez seja necessário criar e configurar um projeto separado que inclua clientes OAuth correspondentes à versão de produção do app disponível para todas as Contas do Google.

Os clientes OAuth do Google usados em produção ajudam a fornecer um ambiente de coleta de dados e armazenamento mais estável, previsível e seguro do que clientes OAuth semelhantes que testam ou depuram o mesmo aplicativo. O projeto de produção pode ser enviado para verificação e, portanto, estar sujeito a outros requisitos para escopos de API específicos, que podem incluir avaliações de segurança de terceiros.

  1. Vá para o Console de APIs do Google. Clique em Criar projeto , insira um nome e clique em Criar.
  2. Analise os clientes OAuth nesse projeto que podem estar associados ao nível de teste. Se aplicável, crie clientes OAuth semelhantes para os clientes de produção no projeto de produção.
  3. Ative todas as APIs em uso pelos clientes.
  4. Analise a configuração da tela de permissão OAuth do novo projeto na página Marca do Console do Cloud.

Os clientes OAuth do Google usados na produção não podem conter ambientes de teste, URIs de redirecionamento ou origens JavaScript disponíveis apenas para você ou sua equipe de desenvolvimento. Confira alguns exemplos:

  • Os servidores de teste de desenvolvedores individuais
  • Versões de teste ou pré-lançamento do app

Manter uma lista de contatos relevantes para o projeto

O Google e as APIs individuais ativadas podem precisar entrar em contato com você sobre mudanças nos serviços ou novas configurações necessárias para o projeto e os clientes. Analise as listagens de IAM do projeto para garantir que as pessoas relevantes da sua equipe tenham acesso para editar ou visualizar a configuração do projeto. Essas contas também podem receber e-mails sobre mudanças necessárias no projeto.

Um papel contém um conjunto de permissões que permitem realizar ações específicas nos recursos do projeto. Os editores de projetos têm permissões para ações que modificam o estado, como a capacidade de fazer mudanças na tela de permissão OAuth do projeto. Os proprietários de projetos que têm todas as permissões de editor podem adicionar ou remover contas associadas ao projeto ou excluir o projeto. Os proprietários de projetos também podem fornecer contexto sobre o motivo pelo qual as informações de faturamento podem ser definidas. Os proprietários de projetos podem configurar informações de faturamento para um projeto que usa APIs pagas.

Os proprietários e editores de projetos precisam estar atualizados. É possível adicionar várias contas relevantes ao projeto para garantir o acesso contínuo ao projeto e à manutenção relacionada. Enviamos e-mails para essas contas quando há notificações sobre o projeto ou atualizações nos nossos serviços. Os administradores da organização do Google Cloud precisam garantir que um contato acessível esteja associado a cada projeto na organização. Se não tivermos informações de contato atualizadas para o projeto, você poderá perder mensagens importantes que exigem sua ação.

Representar sua identidade com precisão

Forneça um nome de app válido e, opcionalmente, um logotipo para mostrar aos usuários. Essas informações de marca precisam representar com precisão a identidade do aplicativo. As informações de marca do app são configuradas na página "Marca OAuth".

Para apps de produção, as informações de marca definidas na tela de permissão OAuth precisam ser verificadas antes de serem mostradas aos usuários. É mais provável que os usuários concedam acesso ao app depois que ele concluir a verificação da marca. As informações básicas do aplicativo, que incluem o nome, a página inicial, os Termos de Serviço e a Política de Privacidade do app, são mostradas aos usuários na tela de concessão, quando eles analisam as concessões atuais ou para administradores do Google Workspace que analisam o uso do app pela organização.

O Google pode revogar ou suspender o acesso aos Serviços de API do Google e a outros produtos e serviços do Google para apps que representam mal a identidade ou tentam enganar os usuários.

Solicitar apenas os escopos necessários

Durante o desenvolvimento do aplicativo, você pode ter usado um escopo de exemplo fornecido pela API para criar uma prova de conceito no aplicativo e saber mais sobre os recursos e a funcionalidade da API. Esses escopos de exemplo geralmente solicitam mais informações do que a implementação final do app precisa, porque oferecem cobertura abrangente de todas as ações possíveis para uma API específica. Por exemplo, o escopo de exemplo pode solicitar permissões de leitura, gravação e exclusão, enquanto o aplicativo exige apenas permissões de leitura. Solicite permissões relevantes que sejam limitadas às informações críticas necessárias para implementar o aplicativo.

Analise a documentação de referência dos endpoints da API que o app chama e observe os escopos necessários para acessar os dados relevantes de que o app precisa. Analise todos os guias de autorização oferecidos pela API e descreva os escopos com mais detalhes para incluir o uso mais comum. Escolha o acesso mínimo aos dados de que o aplicativo precisa para ativar os recursos relacionados.

Para mais informações sobre esse requisito, leia a seção "Solicitar apenas os escopos necessários" das políticas do OAuth 2.0, além da seção "Solicitar permissões relevantes" da Política de dados do usuário dos Serviços de API do Google.

Enviar apps de produção que usam escopos não sensíveis ou não restritos para verificação

O recurso "Fazer login com o Google" não solicita escopos sensíveis e restritos ao autenticar um usuário. Se o aplicativo usar o recurso "Fazer login com o Google" apenas para autenticação, envie o aplicativo para verificação de marca. É possível enviar para verificação no Console do Google Cloud na página "Marca". Essa verificação é necessária para mostrar elementos de marca do app, incluindo o nome, o logotipo, a Política de Privacidade, os Termos de Serviço e os escopos, na tela de permissão.

Recomendamos que o app siga as diretrizes oficiais de marca para posicionar o botão "Fazer login".

Usar apenas domínios próprios

O processo de verificação da tela de permissão OAuth do Google exige a verificação de todos os domínios associados à página inicial, à Política de Privacidade, aos Termos de Serviço, aos URIs de redirecionamento autorizados ou às origens JavaScript autorizadas do projeto. Analise a lista de domínios em uso pelo app, resumida na seção Domínios autorizados do editor da tela de permissão OAuth, e identifique todos os domínios que você não possui e, portanto, não pode verificar. Para verificar a propriedade dos domínios autorizados do projeto, use o Google Search Console. Use uma Conta do Google associada ao projeto do Console de APIs como proprietário ou editor.

Se o projeto usar um provedor de serviços com um domínio comum e compartilhado, recomendamos que você ative configurações que permitam o uso do seu próprio domínio. Alguns provedores oferecem o mapeamento dos serviços para um subdomínio de um domínio que você já possui.

Hospedar uma página inicial para apps de produção

Todo app de produção que usa o OAuth 2.0 precisa ter uma página inicial acessível publicamente. Os usuários em potencial do app podem acessar a página inicial para saber mais sobre os recursos e a funcionalidade oferecidos pelo app. Os usuários atuais podem analisar a lista de concessões atuais e acessar a página inicial do app como um lembrete do uso contínuo da sua oferta.

A página inicial do aplicativo precisa incluir uma descrição da funcionalidade do app, bem como links para uma Política de Privacidade e Termos de Serviço opcionais. A página inicial precisa existir em um domínio verificado de sua propriedade.

Usar URIs de redirecionamento e origens JavaScript seguros

Os clientes OAuth 2.0 para apps da Web precisam proteger os dados usando URIs de redirecionamento HTTPS e origens JavaScript, não HTTP simples. O Google pode rejeitar solicitações OAuth que não se originam ou não são resolvidas em um contexto seguro.

Considere quais aplicativos e scripts de terceiros podem ter acesso a tokens e outras credenciais de usuário que retornam à sua página. Limite o acesso a dados sensíveis com locais de URI de redirecionamento que são limitados à verificação e ao armazenamento de dados de token.

Próximas etapas

Depois de garantir que o app obedece às políticas do OAuth 2.0 nesta página, consulte Enviar para verificação de marca para mais detalhes sobre o processo de verificação.