Uwierzytelnianie żądań REST

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

można używać w każdym środowisku, które obsługuje żądania HTTPS.

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

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

  2. Tokeny identyfikatora Firebase – możesz też wysyłać żądania uwierzytelnione jako pojedynczy użytkownik, np. ograniczać 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 są publicznie dostępne do odczytu lub zapisu zgodnie z Twoimi Realtime Database regułami są też dostępne do odczytu i zapisu za pomocą interfejsu REST API bez uwierzytelniania. Jeśli jednak chcesz, aby serwer pomijał reguły Realtime Database, musisz uwierzytelnić żą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.

Generowanie tokena 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. Jeśli nie masz jeszcze pliku klucza konta usługi, możesz go łatwo wygenerować, klikając przycisk Wygeneruj nowy klucz u dołu sekcji Konta usługi w konsoli Firebase.

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 utworzyć tokeny dostępu Google OAuth2 do uwierzytelniania w interfejsie Realtime Database REST API w różnych językach:

Node.js

Używanie biblioteki klienta interfejsów API Google do 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

Używanie 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 Realtime Database REST API, przekaż wygenerowany powyżej token dostępu Google OAuth2 jako Authorization: Bearer <ACCESS_TOKEN> nagłówek lub access_token=<ACCESS_TOKEN> parametr ciągu zapytania. Oto przykład żądania curl odczytania imienia Ady:

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

Zastąp <DATABASE_NAME> nazwą 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 identyfikatora, który jednoznacznie identyfikuje użytkownika i przyznaje mu dostęp do kilku zasobów, takich jak Realtime Database i Cloud Storage. Możesz ponownie użyć tego tokena identyfikatora, aby uwierzytelnić interfejs Realtime Database REST API i wysyłać żądania w imieniu tego użytkownika.

Generowanie tokena identyfikatora

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

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

Uwierzytelnianie za pomocą tokena identyfikatora

Aby wysyłać uwierzytelnione żądania do interfejsu Realtime Database REST API, przekaż wygenerowany powyżej token identyfikatora jako parametr ciągu zapytania auth=<ID_TOKEN>. Oto przykład żądania curl odczytania imienia Ady:

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

Zastąp <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 Realtime Database REST API nadal obsługuje uwierzytelnianie za pomocą starszych tokenów uwierzytelniania, w tym tajnych kodów. Tajne kody Realtime Database znajdziesz w sekcji Konta usługi w konsoli Firebase.

Tajne kody to dane logowania o długim okresie ważności. Zalecamy wygenerowanie nowego tajnego kodu i unieważnienie dotychczasowego, gdy usuwasz z projektu użytkowników z dostępem do tajnego kodu (np. właścicieli).