授權傳送要求

從應用程式伺服器或受信任環境傳送至 FCM 的要求必須經過授權。

授權 HTTP v1 傳送要求

視伺服器環境的詳細資料而定,請同時採用下列策略,授權伺服器要求存取 Firebase 服務:

  • Google 應用程式預設憑證 (ADC)
  • 服務帳戶 JSON 檔案
  • 由服務帳戶衍生的短期 OAuth 2.0 存取權杖

如果應用程式在 Compute EngineGoogle Kubernetes EngineApp Engine 或 Cloud Functions (包括 Cloud Functions for Firebase) 上執行,請使用應用程式預設憑證 (ADC)。ADC 會使用您現有的預設服務帳戶取得憑證,以便授權要求,並透過 GOOGLE_APPLICATION_CREDENTIALS 環境變數啟用彈性的本機測試。如要將授權流程自動化,請搭配使用 ADC 和 Admin SDK 伺服器程式庫。

如果應用程式在非 Google 伺服器環境中執行,您必須從 Firebase 專案下載服務帳戶 JSON 檔案。只要您可以存取包含私密金鑰檔案的檔案系統,就可以使用環境變數 GOOGLE_APPLICATION_CREDENTIALS,透過手動取得的憑證授權要求。如果您沒有這類檔案存取權,就必須在程式碼中參照服務帳戶檔案,但這可能會洩漏您的憑證,因此請務必格外小心。

使用 ADC 提供憑證

Google 應用程式預設憑證 (ADC) 會依照以下順序檢查您的憑證:

  1. ADC 會檢查是否已設定 GOOGLE_APPLICATION_CREDENTIALS 環境變數。如有,ADC 就會使用該項變數所指的服務帳戶檔案。

  2. 如未設定環境變數,ADC 會使用 Compute EngineGoogle Kubernetes EngineApp Engine 和 Cloud Functions 針對當中運作的應用程式提供的預設服務帳戶。

  3. 如果 ADC 無法使用上述任一項憑證,系統會擲回錯誤。

以下 Admin SDK 程式碼範例說明這項策略。這個範例並未明確指定應用程式憑證,不過只要已設有環境變數,或者應用程式是在 Compute EngineGoogle Kubernetes EngineApp Engine 或 Cloud Functions 中運作,ADC 就能以隱密的方式找到憑證。

Node.js

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

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

Go

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(),
});

手動提供憑證

Firebase 專案支援 Google 服務帳戶,您可以透過這些帳戶從應用程式伺服器或信任環境呼叫 Firebase 伺服器 API。如果您在本機開發程式碼,或將應用程式部署到內部部署,則可以使用透過此服務帳戶取得的憑證,授權伺服器要求。

如要驗證服務帳戶並授權存取 Firebase 服務,您必須以 JSON 格式產生私密金鑰檔案。

如何為服務帳戶產生私密金鑰檔案:

  1. Firebase 主控台中,依序開啟「設定」>「服務帳戶」

  2. 按一下「產生新的私密金鑰」,然後按一下「產生金鑰」確認。

  3. 妥善儲存含有金鑰的 JSON 檔案。

透過服務帳戶授權時,您可以透過兩種方式向應用程式提供憑證。您可以設定 GOOGLE_APPLICATION_CREDENTIALS 環境變數,也可以在程式碼中明確傳遞服務帳戶金鑰的路徑。第一個選項較為安全,強烈建議您採用。

如何設定環境變數:

將環境變數 GOOGLE_APPLICATION_CREDENTIALS 設為包含服務帳戶金鑰的 JSON 檔案路徑。此變數僅適用於您目前的殼層工作階段,因此如果您開啟新的工作階段,就必須再次設定變數。

Linux 或 macOS

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

Windows

使用 PowerShell:

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

完成上述步驟後,應用程式預設憑證 (ADC) 就能以隱密的方式判斷您的憑證,讓您在非 Google 環境中測試或執行時使用服務帳戶憑證。

使用憑證鑄造存取權杖

除非您使用會自動處理授權的 Admin SDK,否則您必須鑄造存取權權杖,並將其新增至傳送要求。

請使用 Firebase 憑證搭配偏好語言的 Google 驗證程式庫,擷取短期 OAuth 2.0 存取權杖:

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    const key = require('../placeholders/service-account.json');
    const jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

在這個範例中,Google API 用戶端程式庫會使用 JSON Web Token (JWT) 驗證要求。詳情請參閱「JSON Web 權杖」。

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = service_account.Credentials.from_service_account_file(
    'service-account.json', scopes=SCOPES)
  request = google.auth.transport.requests.Request()
  credentials.refresh(request)
  return credentials.token

Java

private static String getAccessToken() throws IOException {
  GoogleCredentials googleCredentials = GoogleCredentials
          .fromStream(new FileInputStream("service-account.json"))
          .createScoped(Arrays.asList(SCOPES));
  googleCredentials.refresh();
  return googleCredentials.getAccessToken().getTokenValue();
}

存取權杖到期後,系統會自動呼叫權杖重新整理方法,以便擷取更新的存取權杖。

如要授權存取 FCM,請要求範圍 https://www.googleapis.com/auth/firebase.messaging

如何將存取權杖新增至 HTTP 要求標頭:

Authorization: Bearer <access_token> 格式將權杖新增為 Authorization 標頭的值:

node.js

headers: {
  'Authorization': 'Bearer ' + accessToken
}

Python

headers = {
  'Authorization': 'Bearer ' + _get_access_token(),
  'Content-Type': 'application/json; UTF-8',
}

Java

URL url = new URL(BASE_URL + FCM_SEND_ENDPOINT);
HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
httpURLConnection.setRequestProperty("Authorization", "Bearer " + getServiceAccountAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;