Uwierzytelnianie żądań REST

Pakiety SDK Firebase obsługują uwierzytelnianie i komunikację z Firebase Realtime Database. Jeśli jednak na koncie w środowisku, w którym nie ma pakietu SDK klienta lub chcesz uniknąć obciążenia trwałego połączenia z bazą danych, możesz użyć funkcji Interfejs API typu REST Realtime Database do odczytu i zapisu danych.

Uwaga: w każdym środowisku obsługującym żądania HTTPS możesz używać parametru Realtime Database API typu REST.

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

1. Tokeny dostępu Google OAuth2 – zwykle możliwość odczytu z zapis w Realtime Database podlega Realtime Database Reguły. Możesz jednak uzyskać dostęp do swoich danych z serwera i przyznaj mu pełne uprawnienia do odczytu i zapisu w swojej za pomocą tokena dostępu Google OAuth2 wygenerowanego na koncie usługi.

2. Tokeny identyfikatorów Firebase – możesz też wysyłać żądania uwierzytelnione. jako pojedynczy użytkownik, np. ograniczenie dostępu za pomocą reguł Realtime Database na stronie SDK klienta. Interfejs API REST akceptuje te same tokeny identyfikatora Firebase, których używa interfejs SDK klienta.

Tokeny dostępu Google OAuth2

Wszelkie dane, które są dostępne do odczytu lub zapisu zgodnie z Reguły Realtime Database też są czytelne i możliwe do zapisu za pomocą interfejsu API REST bez uwierzytelniania. Jeśli jednak chcesz, aby Twój serwer aby ominąć reguły Realtime Database, musisz uwierzytelnić odczyt i zapis żądań. Uwierzytelnianie przez Google OAuth2 obejmuje te czynności:

1. Wygeneruj token dostępu.
2. Uwierzytelnij się, korzystając z tego tokena dostępu.

Generowanie tokena dostępu

Interfejs API typu REST Realtime Database akceptuje standardowa Tokeny dostępu Google OAuth2. Tokeny dostępu można wygenerować za pomocą konta usługi o odpowiednim uprawnienia dostępu do Realtime Database. Kliknij przycisk Wygeneruj nową prywatną Key na dole Konta usługi konsoli Firebase umożliwia łatwe wygenerowanie nowej usługi z kluczem konta.

Ostrzeżenie: podczas obsługi konta usługi zachowaj szczególną ostrożność w kodzie. Nie wolno zatwierdź je w repozytorium publicznym, wdróż je w aplikacji klienckiej lub udostępnij je w żaden sposób, który mógłby zagrażać bezpieczeństwu Firebase w projektach AI.

Mając plik klucza konta usługi, możesz użyć jednej z Biblioteki 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ładów implementacji, które pokazują, jak utworzyć Google OAuth2 tokeny dostępu umożliwiające uwierzytelnianie w interfejsie API REST Realtime Database w różnych językach:

Node.js

Korzystanie z biblioteki klienta interfejsów API Google do 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

Korzystanie z biblioteki klienta interfejsów API Google do 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

Korzystanie z narzędzia google-auth biblioteka:

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

Uwierzytelniaj za pomocą tokena dostępu

Aby wysyłać uwierzytelnione żądania do interfejsu API REST Realtime Database, przekaż Token dostępu Google OAuth2 wygenerowany powyżej jako Authorization: Bearer <ACCESS_TOKEN> lub access_token=<ACCESS_TOKEN> parametr ciągu zapytania. Oto przykład: curl prośbę o odczytanie imienia i nazwiska Ady:

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

Pamiętaj, aby zastąpić <DATABASE_NAME> nazwą swojego Realtime Database i <ACCESS_TOKEN> z tokenem dostępu Google OAuth2.

Udane żądanie jest sygnalizowane 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 odpowiadający identyfikatorowi token, który jednoznacznie je identyfikuje i przyznaje dostęp kilka zasobów, takich jak Realtime Database i Cloud Storage. Możesz ponownie wykorzystać do uwierzytelniania interfejsu API REST Realtime Database i wysyłania żądań w imieniu tego użytkownika.

Generowanie tokena identyfikatora

Aby pobrać token identyfikatora Firebase z klienta, wykonaj czynności opisane w Pobieranie tokenów tożsamości z klientów

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

Uwierzytelnij za pomocą tokena identyfikatora

Aby wysyłać uwierzytelnione żądania do interfejsu API REST Realtime Database, przekaż Token identyfikatora wygenerowany powyżej jako parametr ciągu zapytania auth=<ID_TOKEN>. Tutaj to przykładowe żądanie curl odczytujące imię Ady:

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

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

Udane żądanie jest sygnalizowane 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 opisanych metod uwierzytelniania. powyżej.

Jeśli nie korzystasz ze starszych tokenów uwierzytelniania, pomiń tę sekcję.

Interfejs API typu REST Realtime Database nadal obsługuje uwierzytelnianie za pomocą starszej wersji tokeny uwierzytelniania, w tym obiekty tajne. Realtime Database tajne obiekty można znaleźć w Konta usługi w konsoli Firebase.

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