Uwierzytelnianie żądań REST

Pakiety SDK Firebase obsługują w Twoim imieniu całe uwierzytelnianie i komunikację z Firebase Realtime Database. Jeśli jednak znajdujesz się w środowisku, które nie ma pakietu SDK klienta, lub chcesz uniknąć narzutu związanego ze stałym połączeniem z bazą danych, możesz użyć interfejsu Realtime Database REST API do odczytu i zapisu danych.

Uwierzytelnij użytkowników za pomocą jednej z tych metod:

  1. Tokeny dostępu Google OAuth2 – zwykle możliwość odczytu i zapisu w Realtime Database jest regulowana przez reguły Realtime Database. Możesz jednak uzyskać dostęp do danych z serwera i przyznać mu pełny dostęp do odczytu i zapisu danych za pomocą tokena dostępu Google OAuth2 wygenerowanego z konta usługi.

  2. Tokeny identyfikacji Firebase – możesz też wysyłać żądania uwierzytelnione jako pojedynczy użytkownik, na przykład ograniczając dostęp za pomocą reguł Realtime Database w pakietach SDK klienta. Interfejs REST API akceptuje te same tokeny identyfikatora Firebase, których używają pakiety SDK klienta.

Tokeny dostępu Google OAuth2

Wszystkie dane, które zgodnie z regułami Realtime Database można publicznie odczytywać lub zapisywać, można też odczytywać i zapisywać za pomocą interfejsu REST API bez uwierzytelniania. Jeśli jednak chcesz, aby serwer pomijał reguły Realtime Database, musisz uwierzytelniać żądania odczytu i zapisu. Uwierzytelnianie za pomocą Google OAuth2 wymaga wykonania tych czynności:

  1. Wygeneruj token dostępu.
  2. Uwierzytelnij się za pomocą tego tokena dostępu.

Wygeneruj token dostępu

Interfejs Realtime Database REST API akceptuje standardowe tokeny dostępu Google OAuth2. Tokeny dostępu można wygenerować za pomocą konta usługi z odpowiednimi uprawnieniami do Realtime Database. Kliknięcie przycisku Wygeneruj nowy klucz prywatny u dołu sekcji Konta usługi w konsoli Firebase umożliwia łatwe wygenerowanie nowego pliku klucza konta usługi, jeśli jeszcze go nie masz.

Gdy masz plik klucza konta usługi, możesz użyć jednej z bibliotek klienta interfejsów API Google, aby wygenerować token dostępu Google OAuth2 z tymi wymaganymi zakresami:

  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/firebase.database

Oto kilka przykładowych implementacji, które pokazują, jak tworzyć tokeny dostępu Google OAuth2 do uwierzytelniania w interfejsie API REST Realtime Database w różnych językach:

Node.js

Używanie biblioteki klienta interfejsu API Google dla języka Node.js:

var {google} = require("googleapis");

// Load the service account key JSON file.
var serviceAccount = require("path/to/serviceAccountKey.json");

// Define the required scopes.
var scopes = [
  "https://www.googleapis.com/auth/userinfo.email",
  "https://www.googleapis.com/auth/firebase.database"
];

// Authenticate a JWT client with the service account.
var jwtClient = new google.auth.JWT(
  serviceAccount.client_email,
  null,
  serviceAccount.private_key,
  scopes
);

// Use the JWT client to generate an access token.
jwtClient.authorize(function(error, tokens) {
  if (error) {
    console.log("Error making request to generate access token:", error);
  } else if (tokens.access_token === null) {
    console.log("Provided service account does not have permission to generate access tokens");
  } else {
    var accessToken = tokens.access_token;

    // See the "Using the access token" section below for information
    // on how to use the access token to send authenticated requests to
    // the Realtime Database REST API.
  }
});

Java

Używanie biblioteki klienta interfejsów API Google do języka Java:

// Load the service account key JSON file
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json");

// Authenticate a Google credential with the service account
GoogleCredential googleCred = GoogleCredential.fromStream(serviceAccount);

// Add the required scopes to the Google credential
GoogleCredential scoped = googleCred.createScoped(
    Arrays.asList(
      "https://www.googleapis.com/auth/firebase.database",
      "https://www.googleapis.com/auth/userinfo.email"
    )
);

// Use the Google credential to generate an access token
scoped.refreshToken();
String token = scoped.getAccessToken();

// See the "Using the access token" section below for information
// on how to use the access token to send authenticated requests to the
// Realtime Database REST API.

Python

Za pomocą biblioteki google-auth:

from google.oauth2 import service_account
from google.auth.transport.requests import AuthorizedSession

# Define the required scopes
scopes = [
  "https://www.googleapis.com/auth/userinfo.email",
  "https://www.googleapis.com/auth/firebase.database"
]

# Authenticate a credential with the service account
credentials = service_account.Credentials.from_service_account_file(
    "path/to/serviceAccountKey.json", scopes=scopes)

# Use the credentials object to authenticate a Requests session.
authed_session = AuthorizedSession(credentials)
response = authed_session.get(
    "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json")

# Or, use the token directly, as described in the "Authenticate with an
# access token" section below. (not recommended)
request = google.auth.transport.requests.Request()
credentials.refresh(request)
access_token = credentials.token

Uwierzytelnianie za pomocą tokena dostępu

Aby wysyłać uwierzytelnione żądania do interfejsu API REST Realtime Database, przekaż wygenerowany powyżej token dostępu Google OAuth2 jako nagłówek Authorization: Bearer <ACCESS_TOKEN> lub parametr ciągu zapytania access_token=<ACCESS_TOKEN>. Oto przykładowe żądanie curl odczytu imienia Ada:

curl "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json?access_token=<ACCESS_TOKEN>"

Zastąp <DATABASE_NAME> nazwą swojego Realtime Database, a <ACCESS_TOKEN> tokenem dostępu Google OAuth2.

Pomyślne żądanie zostanie oznaczone kodem stanu HTTP 200 OK. Odpowiedź zawiera pobierane dane:

{"first":"Ada","last":"Lovelace"}

Tokeny identyfikatora Firebase

Gdy użytkownik lub urządzenie loguje się za pomocą Firebase Authentication, Firebase tworzy odpowiedni token identyfikacji, który jednoznacznie identyfikuje użytkownika lub urządzenie i zapewnia dostęp do kilku zasobów, takich jak Realtime Database i Cloud Storage. Możesz ponownie użyć tego tokena identyfikacji, aby uwierzytelnić interfejs API REST Realtime Database i wysyłać żądania w imieniu tego użytkownika.

Generowanie tokena identyfikacji

Aby pobrać token identyfikatora Firebase z klienta, wykonaj czynności opisane w artykule Pobieranie tokenów identyfikatora na klientach.

Pamiętaj, że tokeny identyfikacji wygasają po krótkim czasie i należy ich użyć jak najszybciej po ich pobraniu.

Uwierzytelnianie za pomocą tokena identyfikacji

Aby wysyłać uwierzytelnione żądania do interfejsu API REST Realtime Database, przekaż wygenerowany powyżej token identyfikacji jako parametr ciągu zapytania auth=<ID_TOKEN>. Oto przykładowe żądanie curl, które odczytuje imię Ada:

curl "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json?auth=<ID_TOKEN>"

Pamiętaj, aby zastąpić <DATABASE_NAME> nazwą Realtime Database, a <ID_TOKEN> tokenem identyfikatora Firebase.

Pomyślne żądanie zostanie oznaczone kodem stanu HTTP 200 OK. Odpowiedź zawiera pobierane dane:

{"first":"Ada","last":"Lovelace"}

Starsze tokeny

Jeśli nadal używasz starszych tokenów uwierzytelniania Firebase, zalecamy zaktualizowanie uwierzytelniania REST do jednej z metod uwierzytelniania opisanych powyżej.

Interfejs API REST Realtime Database nadal obsługuje uwierzytelnianie za pomocą starszych tokenów uwierzytelniania, w tym tajnych kluczy. Klucze tajne Realtime Database znajdziesz w sekcji Konta usługi konsoli Firebase.

Obiekty tajne to długotrwałe dane logowania. Zalecamy wygenerowanie nowego obiektu tajnego i unieważnienie istniejącego podczas usuwania z projektu użytkowników z dostępem do obiektu tajnego (np. właścicieli).