اصالت‌سنجی کردن درخواست‌های REST

کیت‌های توسعه نرم‌افزار Firebase همه اصالت‌سنجی‌ها و ارتباطات با Firebase Realtime Database را ازطرف شما انجام می‌دهند. بااین‌حال، وقتی در محیطی هستید که کیت توسعه نرم‌افزار کارخواه ندارد یا می‌خواهید از سربار اتصال پایگاه داده پایدار اجتناب کنید، می‌توانید از Realtime Database REST API برای خواندن و نوشتن داده‌ها استفاده کنید.

استفاده کند.

اصالت‌سنجی کاربران ازطریق یکی از روش‌های زیر:

  1. کدهای دسترسی Google OAuth2 - معمولاً، توانایی خواندن از و نوشتن در Realtime Database تحت کنترل قوانین Realtime Database است. اما می‌توانید ازطریق سرور به داده‌هایتان دسترسی داشته باشید و با کد دسترسی Google OAuth2 که از حساب سرویس تولید شده است، به آن سرور دسترسی کامل خواندن و نوشتن به داده‌هایتان را اعطا کنید.

  2. نشان‌های شناسه Firebase - همچنین ممکن است بخواهید درخواست‌های اصالت‌سنجی‌شده را به‌عنوان کاربر فردی ارسال کنید، مانند محدود کردن دسترسی با Realtime Database قوانین در کیت‌های توسعه نرم‌افزار مشتری. REST API همان کدهای Firebase ID را می‌پذیرد که توسط کیت‌های توسعه نرم‌افزار کارخواه استفاده می‌شود.

کدهای دسترسی Google OAuth2

هر داده‌ای که طبق Realtime Databaseقوانین شما به‌صورت عمومی قابل‌خواندن یا قابل‌نوشتن باشد، ازطریق REST API نیز بدون هیچ‌گونه اصالت‌سنجی قابل‌خواندن و قابل‌نوشتن است. بااین‌حال، اگر می‌خواهید سرورتان Realtime Database Rules را دور بزند، باید درخواست‌های خواندن و نوشتن را اصالت‌سنجی کنید. اصالت‌سنجی ازطریق Google OAuth2 به مراحل زیر نیاز دارد:

  1. کد دسترسی تولید کنید.
  2. با آن کد دسترسی اصالت‌سنجی کنید.

تولید کد دسترسی

Realtime Database REST API کدهای دسترسی استاندارد Google OAuth2 را می‌پذیرد. کدهای دسترسی را می‌توان بااستفاده از حساب خدمات با اجازه‌های مناسب برای Realtime Database شما تولید کرد. با کلیک کردن روی دکمه تولید کلید خصوصی جدید در پایین بخش حساب‌های سرویس در کنسول Firebase، می‌توانید به‌راحتی فایل کلید حساب سرویس جدیدی تولید کنید (اگر قبلاً این کار را نکرده‌اید).

وقتی فایل کلید حساب خدمات را دریافت کردید، می‌توانید از یکی از کتابخانه‌های کارخواه Google API استفاده کنید تا کد دسترسی Google OAuth2 را با دامنه‌های الزامی زیر تولید کنید:

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

در اینجا چند نمونه پیاده‌سازی آورده شده است که نحوه ایجاد کردن کد دسترسی Google OAuth2 برای اصالت‌سنجی در Realtime Database REST API را در زبان‌های مختلف نشان می‌دهد:

Node.js

بااستفاده از کتابخانه کارخواه Google API برای 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.
  }
});

جاوا

استفاده از کتابخانه کارخواه Google API برای 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.

پایتون

بااستفاده از کتابخانه 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

اصالت‌سنجی با کد دسترسی

برای ارسال درخواست‌های اصالت‌سنجی‌شده به Realtime Database REST API، کد دسترسی Google OAuth2 را که در بالا تولید شده است به‌عنوان سرصفحه Authorization: Bearer <ACCESS_TOKEN> یا پارامتر رشته پُرسمان access_token=<ACCESS_TOKEN> ارسال کنید. در اینجا نمونه‌ای از درخواست curl برای خواندن نام آدا آورده شده است:

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

حتماً <DATABASE_NAME> را با نام Realtime Database و <ACCESS_TOKEN> را با کد دسترسی Google OAuth2 جایگزین کنید.

درخواست موفق با رمز وضعیت اچ‌تی‌تی‌پی 200 OK نشان داده می‌شود. پاسخ حاوی داده‌هایی است که بازیابی می‌شود:

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

نشان‌های شناسه Firebase

وقتی کاربر یا دستگاهی بااستفاده از Firebase Authentication به سیستم وارد می‌شود، Firebase یک کد شناسه متناظر ایجاد می‌کند که به‌طور منحصربه‌فرد آن‌ها را شناسایی می‌کند و به آن‌ها اجازه دسترسی به چندین منبع، ازجمله Realtime Database و Cloud Storage، می‌دهد. می‌توانید از آن کد شناسه برای اصالت‌سنجی Realtime Database REST API و ارسال درخواست ازطرف آن کاربر استفاده کنید.

تولید کردن کد شناسه

برای بازیابی کد شناسه Firebase از کارخواه، مراحل موجود در بازیابی کدهای شناسه در کارخواه‌ها را دنبال کنید.

توجه داشته باشید که توکن‌های شناسه پس‌از مدت کوتاهی منقضی می‌شوند و باید در اسرع وقت پس‌از بازیابی استفاده شوند.

اصالت‌سنجی با شناسه ID

برای ارسال درخواست‌های اصالت‌سنجی‌شده به Realtime Database REST API، شناسه تولیدشده در بالا را به‌عنوان پارامتر رشته پُرسمان auth=<ID_TOKEN> ارسال کنید. در اینجا نمونه‌ای از درخواست curl برای خواندن نام آدا آورده شده است:

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

حتماً <DATABASE_NAME> را با نام Realtime Database و <ID_TOKEN> را با یک کد Firebase ID جایگزین کنید.

درخواست موفق با رمز وضعیت اچ‌تی‌تی‌پی 200 OK نشان داده می‌شود. پاسخ حاوی داده‌هایی است که بازیابی می‌شود:

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

کدهای قدیمی

اگر هنوز از کدهای اصالت‌سنجی Firebase قدیمی استفاده می‌کنید، توصیه می‌کنیم اصالت‌سنجی REST خود را به یکی از روش‌های اصالت‌سنجی شرح‌داده‌شده در بالا به‌روز کنید.

‫Realtime Database REST API همچنان از اصالت‌سنجی ازطریق توکن‌های اصالت‌سنجی قدیمی، ازجمله رازها، پشتیبانی می‌کند. Realtime Database محرمانه شما را می‌توان در بخش حساب‌های سرویس کنسول Firebase پیدا کرد.

رازها اعتبارنامه‌هایی با طول عمر زیاد هستند. توصیه می‌کنیم هنگام برداشتن کاربران دارای دسترسی به رمز (مثل مالکان) از پروژه، رمز جدیدی تولید کنید و رمز موجود را لغو کنید.