Le richieste inviate a FCM dal server dell'app o dall'ambiente attendibile devono essere autorizzate. Tieni presenti queste importanti differenze tra l'API HTTP legacy deprecata e l'autorizzazione dell'API HTTP v1:
- L'API HTTP v1 di FCM autorizza le richieste con un token di accesso OAuth 2.0 di breve durata. Per coniare questo token, puoi utilizzare le credenziali predefinite dell'applicazione Google (negli ambienti server di Google) e/o ottenere manualmente le credenziali richieste da un file di chiave privata JSON generato per un account di servizio. Se utilizzi Firebase Admin SDK per inviare messaggi, la libreria gestisce il token per te.
- I protocolli legacy deprecati possono utilizzare solo chiavi API di lunga durata ottenute dalla console Firebase.
Autorizza le richieste di invio HTTP v1
A seconda dei dettagli del tuo ambiente server, utilizza una combinazione di queste strategie per autorizzare le richieste del server ai servizi Firebase:
- Credenziali predefinite dell'applicazione Google (ADC)
- Un file JSON dell'account di servizio
- Un token di accesso OAuth 2.0 di breve durata derivato da un account di servizio
Se la tua applicazione è in esecuzione su Compute Engine, Google Kubernetes Engine, App Engine o Cloud Functions (incluso Cloud Functions for Firebase), utilizza le credenziali predefinite dell'applicazione (ADC). ADC utilizza l'account di servizio predefinito esistente per ottenere le credenziali per autorizzare le richieste e ADC consente test locali flessibili tramite la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS . Per la massima automazione del flusso di autorizzazione, utilizza ADC insieme alle librerie del server Admin SDK.
Se la tua applicazione è in esecuzione su un ambiente server non Google , dovrai scaricare un file JSON dell'account di servizio dal tuo progetto Firebase. Finché hai accesso a un file system contenente il file della chiave privata, puoi utilizzare la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS per autorizzare le richieste con queste credenziali ottenute manualmente. Se non disponi di tale accesso ai file, devi fare riferimento al file dell'account di servizio nel tuo codice, operazione che dovrebbe essere eseguita con estrema attenzione a causa del rischio di esporre le tue credenziali.
Fornire le credenziali utilizzando ADC
Google Application Default Credentials (ADC) verifica le tue credenziali nel seguente ordine:
ADC controlla se la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS è impostata. Se la variabile è impostata, ADC utilizza il file dell'account di servizio a cui punta la variabile.
Se la variabile di ambiente non è impostata, ADC utilizza l'account di servizio predefinito fornito da Compute Engine, Google Kubernetes Engine, App Engine e Cloud Functions per le applicazioni eseguite su tali servizi.
Se ADC non può utilizzare nessuna delle credenziali di cui sopra, il sistema genera un errore.
Il seguente esempio di codice Admin SDK illustra questa strategia. L'esempio non specifica in modo esplicito le credenziali dell'applicazione. Tuttavia, ADC è in grado di trovare implicitamente le credenziali finché la variabile di ambiente è impostata o finché l'applicazione è in esecuzione su Compute Engine, Google Kubernetes Engine, App Engine o Cloud Functions.
Node.js
admin.initializeApp({
credential: admin.credential.applicationDefault(),
});
Giava
FirebaseOptions options = FirebaseOptions.builder()
.setCredentials(GoogleCredentials.getApplicationDefault())
.setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
.build();
FirebaseApp.initializeApp(options);
Pitone
default_app = firebase_admin.initialize_app()
Andare
app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
log.Fatalf("error initializing app: %v\n", err)
}
C#
FirebaseApp.Create(new AppOptions()
{
Credential = GoogleCredential.GetApplicationDefault(),
});
Fornire le credenziali manualmente
I progetti Firebase supportano gli account di servizio Google, che puoi utilizzare per chiamare le API del server Firebase dal server dell'app o dall'ambiente attendibile. Se stai sviluppando codice localmente o distribuendo la tua applicazione in locale, puoi utilizzare le credenziali ottenute tramite questo account di servizio per autorizzare le richieste del server.
Per autenticare un account di servizio e autorizzarlo ad accedere ai servizi Firebase, devi generare un file di chiave privata in formato JSON.
Per generare un file di chiave privata per il tuo account di servizio:
Nella console Firebase, apri Impostazioni > Account di servizio .
Fare clic su Genera nuova chiave privata , quindi confermare facendo clic su Genera chiave .
Archivia in modo sicuro il file JSON contenente la chiave.
Quando esegui l'autorizzazione tramite un account di servizio, hai due scelte per fornire le credenziali alla tua applicazione. Puoi impostare la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS oppure passare esplicitamente il percorso alla chiave dell'account di servizio nel codice. La prima opzione è più sicura ed è fortemente consigliata.
Per impostare la variabile d'ambiente:
Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso del file JSON che contiene la chiave dell'account di servizio. Questa variabile si applica solo alla sessione corrente della shell, quindi se apri una nuova sessione, imposta nuovamente la variabile.
Linux o macOS
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
finestre
Con PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
Dopo aver completato i passaggi precedenti, Application Default Credentials (ADC) è in grado di determinare implicitamente le tue credenziali, consentendoti di utilizzare le credenziali dell'account di servizio durante il test o l'esecuzione in ambienti non Google.
Utilizza le credenziali per coniare token di accesso
A meno che non utilizzi Admin SDK , che gestisce l'autorizzazione automaticamente, dovrai coniare il token di accesso e aggiungerlo per inviare le richieste.
Utilizza le tue credenziali Firebase insieme alla libreria Auth di Google per la tua lingua preferita per recuperare un token di accesso OAuth 2.0 di breve durata:
nodo.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);
});
});
}
In questo esempio, la libreria client dell'API di Google autentica la richiesta con un token Web JSON o JWT. Per ulteriori informazioni, consulta Token Web JSON .
Pitone
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
Giava
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();
}
Dopo la scadenza del token di accesso, il metodo di aggiornamento del token viene chiamato automaticamente per recuperare un token di accesso aggiornato.
Per autorizzare l'accesso a FCM, richiedere l'ambito https://www.googleapis.com/auth/firebase.messaging .
Per aggiungere il token di accesso a un'intestazione di richiesta HTTP:
Aggiungi il token come valore dell'intestazione Authorization nel formato Authorization: Bearer <access_token> :
nodo.js
headers: {
'Authorization': 'Bearer ' + accessToken
}
Pitone
headers = {
'Authorization': 'Bearer ' + _get_access_token(),
'Content-Type': 'application/json; UTF-8',
}
Giava
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;
Autorizza le richieste di invio del protocollo legacy
Con il protocollo legacy HTTP, ogni richiesta deve contenere la chiave del server dalla scheda Messaggistica cloud del riquadro Impostazioni della console Firebase. Per XMPP, è necessario utilizzare la stessa chiave del server per stabilire una connessione.
Migrare le chiavi del server legacy
A partire da marzo 2020, FCM ha smesso di creare chiavi server legacy. Le chiavi del server legacy esistenti continueranno a funzionare, ma ti consigliamo di utilizzare invece la versione più recente della chiave denominata Chiave server nella console Firebase .
Se desideri eliminare una chiave del server legacy esistente, puoi farlo in Google Cloud Console .
Autorizza le richieste HTTP
Una richiesta di messaggio è composta da due parti: l'intestazione HTTP e il corpo HTTP. L'intestazione HTTP deve contenere le seguenti intestazioni:
-
Authorization: chiave=IL TUO_SERVER_KEY
Assicurati che questa sia la chiave del server , il cui valore è disponibile nella scheda Messaggistica cloud del riquadro Impostazioni della console Firebase. Le chiavi Android, piattaforma Apple e browser vengono rifiutate da FCM. -
Content-Type:application/jsonper JSON;application/x-www-form-urlencoded;charset=UTF-8per testo semplice.
SeContent-Typeviene omesso, si presuppone che il formato sia testo semplice.
Per esempio:
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA
{
"to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
"data" : {
...
},
}Consulta Creare richieste di invio per i dettagli completi sulla creazione delle richieste di invio. Il Legacy HTTP Protocol Reference fornisce un elenco di tutti i parametri che il tuo messaggio può contenere.
Verifica della validità di una chiave del server
Se ricevi errori di autenticazione durante l'invio di messaggi, controlla la validità della tua chiave Server. Ad esempio, su Linux, esegui il comando seguente:
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 ricevi un codice di stato HTTP 401, la chiave del tuo server non è valida.
Autorizzare una connessione XMPP
Con XMPP puoi mantenere una connessione persistente, asincrona e bidirezionale ai server FCM. La connessione può essere utilizzata per inviare e ricevere messaggi tra il tuo server e i dispositivi connessi a FCM dei tuoi utenti.
Puoi utilizzare la maggior parte delle librerie XMPP per gestire una connessione di lunga durata a FCM. L'endpoint XMPP viene eseguito su fcm-xmpp.googleapis.com:5235 . Quando testi la funzionalità con utenti non di produzione, dovresti invece connetterti al server di pre-produzione su fcm-xmpp.googleapis.com:5236 (nota la porta diversa).
Test regolari in pre-produzione (un ambiente più piccolo in cui vengono eseguite le ultime build FCM) sono utili per isolare gli utenti reali dal codice di test. I dispositivi di test e il codice di test che si collegano a fcm-xmpp.googleapis.com:5236 devono utilizzare un ID mittente FCM diverso per evitare qualsiasi rischio di invio di messaggi di test a utenti di produzione o di invio di messaggi upstream dal traffico di produzione su connessioni di test.
La connessione ha due requisiti importanti:
- È necessario avviare una connessione TLS (Transport Layer Security). Tieni presente che FCM attualmente non supporta l' estensione STARTTLS .
- FCM richiede un meccanismo di autenticazione SASL PLAIN utilizzando
<your_FCM_Sender_Id>@fcm.googleapis.com( ID mittente FCM) e la chiave del server come password. Questi valori sono disponibili nella scheda Messaggistica cloud del riquadro Impostazioni della console Firebase.
Se in qualsiasi momento la connessione fallisce, dovresti riconnetterti immediatamente. Non è necessario tornare indietro dopo una disconnessione avvenuta dopo l'autenticazione. Per ciascun ID mittente , FCM consente 2500 connessioni in parallelo.
I seguenti frammenti illustrano come eseguire l'autenticazione e l'autorizzazione per una connessione XMPP a FCM.
serverXMPP
Il server XMPP richiede una connessione a FCM
<stream:stream to="fcm.googleapis.com"
version="1.0" xmlns="jabber:client"
xmlns:stream="http://etherx.jabber.org/streams">
FCM
FCM apre la connessione e richiede un meccanismo di autenticazione, incluso il metodo 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>
serverXMPP
Il server XMPP deve rispondere utilizzando il metodo di autenticazione PLAIN , fornendo la chiave del server dalla scheda Messaggistica cloud del riquadro Impostazioni della console 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"/>
serverXMPP
<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>
serverXMPP
<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>
Nota: FCM non utilizza la risorsa associata durante l'instradamento dei messaggi.
Consulta Creare richieste di invio per i dettagli completi sulla creazione delle richieste di invio. Il riferimento al protocollo Legacy XMPP fornisce un elenco di tutti i parametri che il messaggio può contenere.