Aggiungi l'SDK Admin Firebase al server

L'Admin SDK è un insieme di librerie server che ti consente di interagire con Firebase da ambienti privilegiati per eseguire azioni come:

  • Esegui query e mutazioni su un servizio Firebase Data Connect per la gestione collettiva dei dati e altre operazioni con privilegi amministrativi completi.
  • Leggi e scrivi dati Realtime Database con privilegi amministrativi completi.
  • Inviare messaggi Firebase Cloud Messaging a livello di programmazione utilizzando un approccio semplice e alternativo ai protocolli del server Firebase Cloud Messaging.
  • Genera e verifica i token di autenticazione Firebase.
  • Accedi alle risorse Google Cloud come bucket Cloud Storage e database Cloud Firestore associati ai tuoi progetti Firebase.
  • Crea una tua Console di amministrazione semplificata per eseguire operazioni come cercare i dati degli utenti o modificare l'indirizzo email di un utente per l'autenticazione.

Se ti interessa utilizzare l'SDK Node.js come client per l'accesso degli utenti finali (ad esempio, in un'applicazione Node.js desktop o IoT), anziché l'accesso amministrativo da un ambiente privilegiato (come un server), devi seguire le istruzioni per configurare l'SDK JavaScript client.

Ecco una matrice delle funzionalità che mostra quali funzionalità di Firebase sono supportate in ogni lingua:

Funzionalità Node.js Java Python Vai C#
Custom Token Minting
Verifica del token ID
Gestione utenti
Controllare l'accesso con rivendicazioni personalizzate
Revoca del token di aggiornamento
Importa utenti
Gestione dei cookie di sessione
Generare link di azione email
Gestione delle configurazioni dei provider SAML/OIDC
Supporto multi-tenant
Firebase Data Connect
Realtime Database *
Firebase Cloud Messaging
FCM Multicast
Gestisci gli abbonamenti agli argomenti di FCM
Cloud Storage
Cloud Firestore
Mettere in coda le funzioni con Cloud Tasks
Project management
Regole di sicurezza
Gestione dei modelli ML
Firebase Remote Config
Firebase App Check
Firebase Extensions

Per saperne di più sull'integrazione di Admin SDK per questi utilizzi, consulta la documentazione Realtime Database, FCM, Authentication, Remote Config e Cloud Storage. Il resto di questa pagina è incentrato sulla configurazione di base di Admin SDK.

Prerequisiti

  • Assicurati di avere un'app server.

  • Assicurati che il server esegua quanto segue a seconda del Admin SDK che utilizzi:

    • SDK Node.js Admin - Node.js 18+
    • SDK Java Admin - Java 8+
    • SDK Python Admin: Python 3.9+ (consigliato Python 3.10+)
      Il supporto di Python 3.9 è deprecato.
    • SDK Admin Go: Go 1.23+
    • SDK .NET per amministratori: .NET Framework 4.6.2+ o .NET Standard 2.0 per .NET 6.0+

Configura un progetto Firebase e un service account

Per utilizzare Firebase Admin SDK, devi disporre di quanto segue:

  • Un progetto Firebase.
  • Un service account SDK Firebase Admin per comunicare con Firebase. Questo service account viene creato automaticamente quando crei un progetto Firebase o aggiungi Firebase a un progetto Google Cloud.
  • Un file di configurazione con le credenziali del service account.

Se non hai ancora un progetto Firebase, devi crearne uno nella console Firebase. Visita la pagina Informazioni sui progetti Firebase per scoprire di più sui progetti Firebase.

Aggiungi l'SDK

Se stai configurando un nuovo progetto, devi installare l'SDK per la lingua che preferisci.

Node.js

L'SDK Firebase Admin Node.js è disponibile su npm. Se non hai già un file package.json, creane uno tramite npm init. Poi, installa il pacchetto npm firebase-admin e salvalo in package.json:

npm install firebase-admin --save

Per utilizzare il modulo nella tua applicazione, require da qualsiasi file JavaScript:

const { initializeApp } = require('firebase-admin/app');

Se utilizzi ES2015, puoi import il modulo:

import { initializeApp } from 'firebase-admin/app';

Java

L'SDK Firebase Admin Java è pubblicato nel repository centrale Maven. Per installare la libreria, dichiarala come dipendenza nel file build.gradle:

dependencies {
  implementation 'com.google.firebase:firebase-admin:9.5.0'
}

Se utilizzi Maven per creare la tua applicazione, puoi aggiungere la seguente dipendenza al file pom.xml:

<dependency>
  <groupId>com.google.firebase</groupId>
  <artifactId>firebase-admin</artifactId>
  <version>9.5.0</version>
</dependency>

Python

L'SDK Firebase Admin Python è disponibile tramite pip. Puoi installare la libreria per tutti gli utenti tramite sudo:

sudo pip install firebase-admin

In alternativa, puoi installare la libreria solo per l'utente corrente passando il flag --user:

pip install --user firebase-admin

Vai

Admin SDK Go può essere installato utilizzando l'utilità go get:

# Install the latest version:
go get firebase.google.com/go/v4@latest

# Or install a specific version:
go get firebase.google.com/go/v4@4.17.0

C#

.NET Admin SDK può essere installato utilizzando il gestore di pacchetti .NET:

Install-Package FirebaseAdmin -Version 3.3.0

In alternativa, installalo utilizzando l'utilità a riga di comando dotnet:

dotnet add package FirebaseAdmin --version 3.3.0

In alternativa, puoi installarlo aggiungendo la seguente voce di riferimento del pacchetto al file .csproj:

<ItemGroup>
  <PackageReference Include="FirebaseAdmin" Version="3.3.0" />
</ItemGroup>

Inizializza l'SDK

Una volta creato un progetto Firebase, puoi inizializzare l'SDK con le credenziali predefinite dell'applicazione Google. Poiché la ricerca delle credenziali predefinite è completamente automatizzata negli ambienti Google, senza la necessità di fornire variabili di ambiente o altre configurazioni, questo modo di inizializzare l'SDK è fortemente consigliato per le applicazioni in esecuzione in ambienti Google come Firebase App Hosting, Cloud Run, App Engine e Cloud Functions for Firebase.

Per specificare facoltativamente le opzioni di inizializzazione per servizi come Realtime Database, Cloud Storage o Cloud Functions, utilizza la variabile di ambiente FIREBASE_CONFIG. Se il contenuto della variabile FIREBASE_CONFIG inizia con {, verrà analizzato come oggetto JSON. In caso contrario, l'SDK presuppone che la stringa sia il percorso di un file JSON contenente le opzioni.

Node.js

const app = initializeApp();

Java

FirebaseApp.initializeApp();

Python

default_app = firebase_admin.initialize_app()

Vai

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

C#

FirebaseApp.Create();

Una volta inizializzato, puoi utilizzare Admin SDK per svolgere i seguenti tipi di attività:

Utilizzare un token di aggiornamento OAuth 2.0

Admin SDK fornisce anche una credenziale che consente di eseguire l'autenticazione con un token di aggiornamento Google OAuth2:

Node.js

const myRefreshToken = '...'; // Get refresh token from OAuth2 flow

initializeApp({
  credential: refreshToken(myRefreshToken),
  databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});

Java

FileInputStream refreshToken = new FileInputStream("path/to/refreshToken.json");

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

FirebaseApp.initializeApp(options);

Python

cred = credentials.RefreshToken('path/to/refreshToken.json')
default_app = firebase_admin.initialize_app(cred)

Vai

opt := option.WithCredentialsFile("path/to/refreshToken.json")
config := &firebase.Config{ProjectID: "my-project-id"}
app, err := firebase.NewApp(context.Background(), config, opt)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C#

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.FromFile("path/to/refreshToken.json"),
});

Inizializzare l'SDK in ambienti non Google

Se lavori in un ambiente server non Google in cui la ricerca delle credenziali predefinite non può essere completamente automatizzata, puoi inizializzare l'SDK con un file di chiave dell'account di servizio esportato.

I progetti Firebase supportano gli account di servizio Google, che puoi utilizzare per chiamare le API server Firebase dal server delle app o dall'ambiente attendibile. Se stai sviluppando codice localmente o eseguendo il deployment della tua applicazione on-premise, puoi utilizzare le credenziali ottenute tramite questo service account per autorizzare le richieste del server.

Per autenticare un service account e autorizzarlo ad accedere ai servizi Firebase, devi generare un file della chiave privata in formato JSON.

Per generare un file della chiave privata per il tuo service account:

  1. Nella console Firebase, apri Impostazioni > Service account.

  2. Fai clic su Genera nuova chiave privata, poi conferma facendo clic su Genera chiave.

  3. Archivia in modo sicuro il file JSON contenente la chiave.

Quando autorizzi tramite un service account, hai due opzioni per fornire le credenziali alla tua applicazione. Puoi impostare la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS oppure passare esplicitamente il percorso della chiave del service account nel codice. La prima opzione è più sicura ed è vivamente consigliata.

Per impostare la variabile di ambiente:

Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso del file JSON contenente la chiave dell'account di servizio. Questa variabile si applica solo alla sessione di shell corrente, quindi se apri una nuova sessione, imposta di nuovo la variabile.

Linux o macOS

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

Windows

Con PowerShell:

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

Dopo aver completato i passaggi precedenti, le credenziali predefinite dell'applicazione (ADC) sono in grado di determinare implicitamente le tue credenziali, consentendoti di utilizzare le credenziali dell'account di servizio durante i test o l'esecuzione in ambienti non Google.

Inizializza l'SDK come mostrato di seguito:

Node.js

initializeApp({
    credential: applicationDefault(),
    databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});

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()

Vai

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(),
    ProjectId = "my-project-id",
});

Inizializzare più app

Nella maggior parte dei casi, devi inizializzare una sola app predefinita. Puoi accedere ai servizi da questa app in due modi equivalenti:

Node.js

// Initialize the default app
const defaultApp = initializeApp(defaultAppConfig);

console.log(defaultApp.name);  // '[DEFAULT]'

// Retrieve services via the defaultApp variable...
let defaultAuth = getAuth(defaultApp);
let defaultDatabase = getDatabase(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = getAuth();
defaultDatabase = getDatabase();

Java

// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);

System.out.println(defaultApp.getName());  // "[DEFAULT]"

// Retrieve services by passing the defaultApp variable...
FirebaseAuth defaultAuth = FirebaseAuth.getInstance(defaultApp);
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.getInstance();
defaultDatabase = FirebaseDatabase.getInstance();

Python

# Import the Firebase service
from firebase_admin import auth

# Initialize the default app
default_app = firebase_admin.initialize_app(cred)
print(default_app.name)  # "[DEFAULT]"

# Retrieve services via the auth package...
# auth.create_custom_token(...)

Vai

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

// Access auth service from the default app
client, err := app.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

C#

// Initialize the default app
var defaultApp = FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});
Console.WriteLine(defaultApp.Name); // "[DEFAULT]"

// Retrieve services by passing the defaultApp variable...
var defaultAuth = FirebaseAuth.GetAuth(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.DefaultInstance;

Alcuni casi d'uso richiedono di creare più app contemporaneamente. Ad esempio, potresti voler leggere i dati da Realtime Database di un progetto Firebase e creare token personalizzati per un altro progetto. In alternativa, potresti voler autenticare due app con credenziali separate. L'SDK Firebase ti consente di creare più app contemporaneamente, ognuna con le proprie informazioni di configurazione.

Node.js

// Initialize the default app
initializeApp(defaultAppConfig);

// Initialize another app with a different config
var otherApp = initializeApp(otherAppConfig, 'other');

console.log(getApp().name);  // '[DEFAULT]'
console.log(otherApp.name);     // 'other'

// Use the shorthand notation to retrieve the default app's services
const defaultAuth = getAuth();
const defaultDatabase = getDatabase();

// Use the otherApp variable to retrieve the other app's services
const otherAuth = getAuth(otherApp);
const otherDatabase = getDatabase(otherApp);

Java

// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);

// Initialize another app with a different config
FirebaseApp otherApp = FirebaseApp.initializeApp(otherAppConfig, "other");

System.out.println(defaultApp.getName());  // "[DEFAULT]"
System.out.println(otherApp.getName());    // "other"

// Use the shorthand notation to retrieve the default app's services
FirebaseAuth defaultAuth = FirebaseAuth.getInstance();
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance();

// Use the otherApp variable to retrieve the other app's services
FirebaseAuth otherAuth = FirebaseAuth.getInstance(otherApp);
FirebaseDatabase otherDatabase = FirebaseDatabase.getInstance(otherApp);

Python

# Initialize the default app
default_app = firebase_admin.initialize_app(cred)

#  Initialize another app with a different config
other_app = firebase_admin.initialize_app(cred, name='other')

print(default_app.name)    # "[DEFAULT]"
print(other_app.name)      # "other"

# Retrieve default services via the auth package...
# auth.create_custom_token(...)

# Use the `app` argument to retrieve the other app's services
# auth.create_custom_token(..., app=other_app)

Vai

// Initialize the default app
defaultApp, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

// Initialize another app with a different config
opt := option.WithCredentialsFile("service-account-other.json")
otherApp, err := firebase.NewApp(context.Background(), nil, opt)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

// Access Auth service from default app
defaultClient, err := defaultApp.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

// Access auth service from other app
otherClient, err := otherApp.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

C#

// Initialize the default app
var defaultApp = FirebaseApp.Create(defaultOptions);

// Initialize another app with a different config
var otherApp = FirebaseApp.Create(otherAppConfig, "other");

Console.WriteLine(defaultApp.Name); // "[DEFAULT]"
Console.WriteLine(otherApp.Name); // "other"

// Use the shorthand notation to retrieve the default app's services
var defaultAuth = FirebaseAuth.DefaultInstance;

// Use the otherApp variable to retrieve the other app's services
var otherAuth = FirebaseAuth.GetAuth(otherApp);

Imposta gli ambiti per Realtime Database e Authentication

Se utilizzi una VM Google Compute Engine con le credenziali predefinite dell'applicazione Google per Realtime Database o Authentication, assicurati di impostare anche gli ambiti di accesso corretti. Per Realtime Database e Authentication, devi utilizzare ambiti che terminano con userinfo.email e cloud-platform o firebase.database. Per controllare gli ambiti di accesso esistenti e modificarli, esegui i seguenti comandi utilizzando gcloud.

gcloud

# Check the existing access scopes
gcloud compute instances describe [INSTANCE_NAME] --format json

# The above command returns the service account information. For example:
  "serviceAccounts": [
   {
    "email": "your.gserviceaccount.com",
    "scopes": [
     "https://www.googleapis.com/auth/cloud-platform",
     "https://www.googleapis.com/auth/userinfo.email"
     ]
    }
  ],

# Stop the VM, then run the following command, using the service account
# that gcloud returned when you checked the scopes.

gcloud compute instances set-service-account [INSTANCE_NAME] --service-account "your.gserviceaccount.com" --scopes "https://www.googleapis.com/auth/firebase.database,https://www.googleapis.com/auth/userinfo.email"

Test con le credenziali utente finale gcloud

Quando testi Admin SDK localmente con credenziali predefinite dell'applicazione Google ottenute eseguendo gcloud auth application-default login, sono necessari ulteriori modifiche per utilizzare Firebase Authentication a causa di quanto segue:

  • Firebase Authentication non accetta le credenziali utente finale gcloud generate utilizzando l'ID client OAuth gcloud.
  • Firebase Authentication richiede che l'ID progetto venga fornito all'inizializzazione per questo tipo di credenziali dell'utente finale.

Come soluzione alternativa, puoi generare le credenziali predefinite dell'applicazione Google in gcloud utilizzando il tuo ID client OAuth 2.0. L'ID client OAuth deve essere di tipo App desktop.

gcloud

gcloud auth application-default login --client-id-file=[/path/to/client/id/file]

Puoi specificare l'ID progetto in modo esplicito durante l'inizializzazione dell'app o utilizzare semplicemente la variabile di ambiente GOOGLE_CLOUD_PROJECT. In questo modo, non è necessario apportare ulteriori modifiche per testare il codice.

Per specificare esplicitamente l'ID progetto:

Node.js

import { initializeApp, applicationDefault } from 'firebase-admin/app';

initializeApp({
  credential: applicationDefault(),
  projectId: '<FIREBASE_PROJECT_ID>',
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setProjectId("<FIREBASE_PROJECT_ID>")
    .build();

FirebaseApp.initializeApp(options);

Python

app_options = {'projectId': '<FIREBASE_PROJECT_ID>'}
default_app = firebase_admin.initialize_app(options=app_options)

Vai

config := &firebase.Config{ProjectID: "<FIREBASE_PROJECT_ID>"}
app, err := firebase.NewApp(context.Background(), config)
if err != nil {
        log.Fatalf("error initializing app: %v\n", err)
}

C#

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
    ProjectId = "<FIREBASE_PROJECT_ID>",
});

Passaggi successivi

Scopri di più su Firebase:

Aggiungi funzionalità Firebase alla tua app: