Autorizar solicitações de envio

As solicitações enviadas para o FCM do servidor do app ou do ambiente confiável precisam ser autorizadas. Observe essas diferenças importantes entre a API HTTP legada descontinuada e a autorização da API HTTP v1:

  • A API HTTP v1 do FCM autoriza solicitações com um token de acesso OAuth 2.0 de curta duração. Para produzir esse token, você pode usar o Application Default Credentials do Google (em ambientes de servidor do Google) e/ou conseguir manualmente as credenciais necessárias de um arquivo de chave privada JSON gerado para uma conta de serviço. Se você estiver usando o Firebase Admin SDK para enviar mensagens, a biblioteca vai processar o token para você.
  • Os protocolos legados descontinuados podem usar apenas chaves de API de longa duração recuperadas do Console do Firebase.

Autorizar solicitações de envio HTTP v1

Dependendo dos detalhes do seu ambiente de servidor, use uma combinação destas estratégias para autorizar as solicitações do servidor para os serviços do Firebase:

  • Application Default Credentials (ADC) do Google
  • Um arquivo JSON da conta de serviço
  • Um token de acesso OAuth 2.0 de curta duração derivado de uma conta de serviço

Se o aplicativo estiver sendo executado no Compute Engine, Google Kubernetes Engine, App Engine ou Cloud Functions, incluindo o Cloud Functions for Firebase, use o Application Default Credentials (ADC). O ADC usa sua conta de serviço padrão para receber credenciais e autorizar solicitações. Além disso, esse serviço permite testes locais flexíveis usando a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS. Para uma automação mais completa do fluxo de autorização, use o ADC com as bibliotecas de servidor do SDK Admin.

Caso o seu aplicativo esteja sendo executado em um ambiente de servidor que não seja do Google, você precisará fazer o download de um arquivo JSON da conta de serviço do seu projeto do Firebase. Se você tiver acesso a um sistema de arquivos com o arquivo de chave privada, você poderá usar a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS para autorizar solicitações com as credenciais recebidas manualmente. Se você não tiver acesso a esse arquivo, será preciso referenciar o arquivo da conta de serviço no seu código. Tenha muito cuidado ao fazer isso, porque há risco de suas credenciais serem expostas.

Fornecer credenciais usando o ADC

O Application Default Credentials (ADC) do Google verifica suas credenciais na seguinte ordem:

  1. O ADC verifica se a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS está configurada. Caso esteja, o arquivo da conta de serviço indicado pela variável será usado.

  2. Se a variável de ambiente não estiver definida, o ADC usará a conta de serviço padrão que Compute Engine, Google Kubernetes Engine, App Engine, e o Cloud Functions fornecem para aplicativos executados nesses serviços.

  3. Se o ADC não puder usar nenhuma das credenciais acima, o sistema emitirá um erro.

O exemplo de código do SDK Admin a seguir ilustra essa estratégia. O exemplo não especifica explicitamente as credenciais do aplicativo. No entanto, o ADC consegue encontrar as credenciais, desde que a variável de ambiente esteja configurada ou o aplicativo esteja em execução no Compute Engine, Google Kubernetes Engine, App Engine ou Cloud Functions.

Node.js

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
    .build();

FirebaseApp.initializeApp(options);

Python

default_app = firebase_admin.initialize_app()

Go

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}
init.go

C#

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});

Fornecer credenciais manualmente

Os projetos do Firebase oferecem suporte a contas de serviço do Google, que você pode usar para chamar APIs do servidor do Firebase usando seu servidor de aplicativos ou um ambiente confiável. Se você estiver desenvolvendo código ou implantando o aplicativo localmente, será possível usar credenciais recebidas por essa conta de serviço para autorizar solicitações do servidor.

Para autenticar uma conta de serviço e autorizá-la para acessar os serviços do Firebase, gere um arquivo de chave privada no formato JSON.

Para gerar um arquivo de chave privada da conta de serviço, siga estas etapas:

  1. No console Firebase, abra Configurações > Contas de serviço.

  2. Clique em Gerar nova chave privada e selecione Gerar chave para confirmar.

  3. Armazene com segurança o arquivo JSON que contém a chave.

Ao autorizar usando uma conta de serviço, existem duas opções para fornecer as credenciais ao seu aplicativo. Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS ou transmita explicitamente o caminho para a chave da conta de serviço no código. A primeira opção é mais segura e é altamente recomendável.

Para definir a variável de ambiente:

Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém a chave da conta de serviço. Essa variável só se aplica à sessão de shell atual. Dessa maneira, se você abrir uma nova sessão, defina a variável novamente.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

Windows

Com o PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

Depois de concluir as etapas acima, o Application Default Credentials (ADC) pode determinar implicitamente suas credenciais, permitindo que você use as credenciais da conta de serviço ao testar ou executar em ambientes que não são do Google.

Usar credenciais para produzir tokens de acesso

A menos que você esteja usando o SDK Admin, que gerencia a autorização automaticamente, será necessário gerar o token de acesso e adicioná-lo para enviar solicitações.

Use as credenciais do Firebase com a Biblioteca do Google Auth para sua linguagem preferida e recupere um token de acesso do OAuth 2.0 de curta duração:

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    const key = require('../placeholders/service-account.json');
    const jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}
index.js

Neste exemplo, a biblioteca de cliente da API do Google autentica a solicitação com um token JSON da Web ou JWT. Para mais informações, consulte tokens JSON da web.

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = service_account.Credentials.from_service_account_file(
    'service-account.json', scopes=SCOPES)
  request = google.auth.transport.requests.Request()
  credentials.refresh(request)
  return credentials.token
messaging.py

Java

private static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refresh();
  return googleCredentials.getAccessToken().getTokenValue();
}
Messaging.java

O método de atualização de token é chamado automaticamente para recuperar um token atualizado após o de acesso expirar.

Para autorizar o acesso ao FCM, solicite o escopo https://www.googleapis.com/auth/firebase.messaging.

Para adicionar o token de acesso a um cabeçalho da solicitação HTTP:

Adicione o token como o valor do cabeçalho Authorization no formato Authorization: Bearer <access_token>:

node.js

headers: {
  'Authorization': 'Bearer ' + accessToken
}
index.js

Python

headers = {
  'Authorization': 'Bearer ' + _get_access_token(),
  'Content-Type': 'application/json; UTF-8',
}
messaging.py

Java

URL url = new URL(BASE_URL + FCM_SEND_ENDPOINT);
HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
httpURLConnection.setRequestProperty("Authorization", "Bearer " + getServiceAccountAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;
FirebaseMessagingSnippets.java

Autorizar solicitações de envio de protocolo legado

Com o protocolo HTTP legado, cada solicitação precisa conter a chave do servidor disponível na guia Cloud Messaging do painel Configurações no Console do Firebase. Para o XMPP, é preciso usar a mesma chave do servidor para estabelecer uma conexão.

Migrar chaves de servidor legadas

Desde março de 2020, o FCM parou de criar chaves de servidor legadas. As chaves de servidor legadas existentes continuarão funcionando, mas recomendamos que você use a versão mais recente da chave denominada Chave do servidor no Console do Firebase.

Se você quiser excluir uma chave de servidor legada atual, use o Console do Google Cloud.

Autorizar solicitações HTTP

Uma solicitação de mensagem consiste em duas partes: o cabeçalho HTTP e o corpo HTTP. O cabeçalho HTTP precisa conter os seguintes cabeçalhos:

  • Authorization: key=YOUR_SERVER_KEY
    Verifique se essa é a chave do servidor, que tem o valor disponível na guia Cloud Messaging do painel Configurações do Console do Firebase. As chaves das plataformas Android e Apple e do navegador são rejeitadas pelo FCM.
  • Content-Type: application/json para JSON, e application/x-www-form-urlencoded;charset=UTF-8 para texto simples.
    Se Content-Type for omitido, o formato será considerado texto simples.

Por exemplo:

Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
  "data" : {
    ...
  },
}

Consulte Criar solicitações de envio para detalhes completos sobre a criação de solicitações de envio. A Referência do protocolo HTTP legado oferece uma lista com todos os parâmetros que sua mensagem pode conter.

Verificar a validade de uma chave de servidor

Se você encontrar erros de autenticação durante o envio de mensagens, verifique a validade da chave de servidor. Por exemplo, no Linux, execute o seguinte comando:

api_key=YOUR_SERVER_KEY

curl --header "Authorization: key=$api_key" \
     --header Content-Type:"application/json" \
     https://fcm.googleapis.com/fcm/send \
     -d "{\"registration_ids\":[\"ABC\"]}"

Se você receber um código de status HTTP 401, a chave do servidor é inválida.

Autorizar uma conexão XMPP

Com o XMPP, você pode manter uma conexão permanente, assíncrona e bidirecional com servidores FCM. A conexão pode ser usada para enviar e receber mensagens entre o servidor e os dispositivos conectados ao FCM dos seus usuários.

É possível usar a maioria das bibliotecas XMPP para gerenciar uma conexão de longa duração com o FCM. O endpoint XMPP é executado em fcm-xmpp.googleapis.com:5235. Para testar a funcionalidade com usuários fora do ambiente de produção, conecte-se ao servidor de pré-produção em fcm-xmpp.googleapis.com:5236 (observe que a porta é diferente).

O benefício do teste normal em pré-produção (um ambiente menor com os builds mais recentes do FCM em execução) é isolar os usuários reais do código de teste. O código e os dispositivos de teste conectados a fcm-xmpp.googleapis.com:5236 precisam usar um ID do remetente do FCM diferente para evitar o risco de enviar mensagens de teste aos usuários em produção ou de enviar mensagens upstream do tráfego de produção usando conexões de teste.

A conexão tem dois requisitos importantes:

  • É preciso iniciar uma conexão com o protocolo TLS. No momento, o FCM não tem suporte à extensão STARTTLS.
  • O FCM exige um mecanismo de autenticação SASL PLAIN que usa <your_FCM_Sender_Id>@fcm.googleapis.com (FCM ID do remetente) e a chave do servidor como senha. Esses valores estão disponíveis na guia do Cloud Messaging do painel Configurações do Console do Firebase.

Se a conexão falhar em algum momento, será preciso reconectar imediatamente. Não é preciso esperar após uma desconexão que ocorra depois da autenticação. Para cada ID de remetente, o FCM permite 2.500 conexões em paralelo.

Os snippets a seguir ilustram como executar autenticação e autorização para uma conexão XMPP ao FCM.

Servidor XMPP

O servidor XMPP solicita uma conexão com o FCM.

<stream:stream to="fcm.googleapis.com"
        version="1.0" xmlns="jabber:client"
        xmlns:stream="http://etherx.jabber.org/streams">

FCM

O FCM abre a conexão e solicita um mecanismo auth, incluindo o método PLAIN.

<stream:features>
  <mechanisms xmlns="urn:ietf:params:xml:ns:xmpp-sasl">
    <mechanism>X-OAUTH2</mechanism>
    <mechanism>X-GOOGLE-TOKEN</mechanism>
    <mechanism>PLAIN</mechanism>
  </mechanisms>
</stream:features>

Servidor XMPP

O servidor XMPP precisa responder usando o método de autenticação PLAIN, fornecendo a chave do servidor da guia Cloud Messaging do painel Configurações do Console do Firebase.

<auth mechanism="PLAIN"
xmlns="urn:ietf:params:xml:ns:xmpp-sasl">MTI2MjAwMzQ3OTMzQHByb2plY3RzLmdjbS5hb
mFTeUIzcmNaTmtmbnFLZEZiOW1oekNCaVlwT1JEQTJKV1d0dw==</auth>

FCM

<success xmlns="urn:ietf:params:xml:ns:xmpp-sasl"/>

Servidor XMPP

<stream:stream to="fcm.googleapis.com"
        version="1.0" xmlns="jabber:client"
        xmlns:stream="http://etherx.jabber.org/streams">

FCM

<stream:features>
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"/>
  <session xmlns="urn:ietf:params:xml:ns:xmpp-session"/>
</stream:features>

Servidor XMPP

<iq type="set">
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind"></bind>
</iq>

FCM

<iq type="result">
  <bind xmlns="urn:ietf:params:xml:ns:xmpp-bind">
    <jid>SENDER_ID@fcm.googleapis.com/RESOURCE</jid>
  </bind>
</iq>

Observação: o FCM não usa o recurso vinculado ao encaminhar mensagens.

Consulte Criar solicitações de envio para detalhes completos sobre a criação de solicitações de envio. Na Referência do protocolo XMPP legado, você encontra uma lista de todos os parâmetros que sua mensagem pode conter.