選取平台: Android iOS JavaScript

使用應用程式檢查服務保護 API 金鑰安全

Firebase App Check 可封鎖來自正當應用程式以外來源的流量,保護應用程式對 Google 地圖平台發出的呼叫。方法是檢查認證供應商 (例如 reCAPTCHA Enterprise) 的權杖。將應用程式與 App Check 整合,有助於防範惡意要求,避免因未經授權的 API 呼叫而產生費用。

我適合使用 App Check 嗎?

在大多數情況下,建議使用應用程式檢查,但在下列情況下,則不需要或不支援應用程式檢查:

  • 私人或實驗性應用程式。如果應用程式不開放公眾存取,則不需要使用應用程式檢查。
  • 如果應用程式只用於伺服器對伺服器通訊,則不需要應用程式檢查。不過,如果與 GMP 通訊的伺服器是由公開用戶端 (例如行動應用程式) 使用,建議使用 App Check 保護該伺服器,而非 GMP。

導入步驟總覽

如要整合應用程式與應用程式檢查,大致上需要按照下列步驟操作:

  1. 將 Firebase 新增至應用程式。
  2. 新增並初始化 App Check 程式庫。
  3. 在應用程式中新增權杖供應商。
  4. 初始化 Maps JS 和 App Check API。
  5. 啟用偵錯功能。
  6. 監控應用程式要求,並決定是否要強制執行。

整合 App Check 後,您就能在 Firebase 控制台查看後端流量指標。這些指標會根據要求是否附上有效的 App Check 權杖,提供要求詳細資料。詳情請參閱 Firebase App Check 說明文件

確認大部分要求來自合法來源,且使用者已更新至包含 App Check 實作的最新版應用程式後,即可啟用強制執行功能。強制執行後,App Check 會拒絕所有不具備有效 App Check 權杖的流量。

規劃整合 App Check 時的注意事項

規劃整合時,請考量下列事項:

  • 我們建議的認證供應商之一 reCAPTCHA Enterprise,每月評估次數超過 10,000 次時會收取費用。

    我們建議的另一個認證供應商 reCAPTCHA v3 有配額限制,超過配額的流量不會經過評估。

    您可以選擇使用自訂認證供應商,但這是進階用途。詳情請參閱 App Check 說明文件

  • 應用程式啟動時,使用者會遇到一些延遲。不過,之後的定期重新認證會在背景執行,使用者應不會再遇到任何延遲問題。啟動時的確切延遲時間取決於您選擇的認證供應商。

    App Check 權杖的效期 (即存留時間或 TTL) 決定了重新驗證的頻率。您可以在 Firebase 控制台中設定這段時間。當 TTL 大約過了一半時,就會重新認證。詳情請參閱驗證供應商的 Firebase 文件

將應用程式與 App Check 整合

必要條件和規定

  • 應用程式載入最新每週或每季版本的 Maps JS API 和 Core 程式庫。
  • 已啟用 Maps JS API 的 Cloud 專案。
  • 您必須是 Cloud 控制台中應用程式的擁有者。
  • 您需要 Cloud 控制台中的應用程式專案 ID

步驟 1:將 Firebase 新增至應用程式

按照 Firebase 開發人員說明文件中的操作說明,將 Firebase 新增至應用程式。

步驟 2:加入 App Check 程式庫並初始化 App Check

Firebase 會提供各個預設認證供應商的操作說明。這些操作說明會引導您設定 Firebase 專案,並將應用程式檢查程式庫新增至應用程式。請按照提供的程式碼範例初始化應用程式檢查。

步驟 3:載入 Maps JS API 程式庫

  1. 載入核心和 Maps 程式庫,如下列程式碼片段所示。如需更多資訊和操作說明,請參閱 Maps JavaScript API 說明文件

    async function init() {
      const {Settings} = await google.maps.importLibrary('core');
      const {Map} = await google.maps.importLibrary('maps');
    }  

步驟 4:初始化 Maps 和 App Check API

  1. 使用 Firebase 控制台提供的設定初始化 App Check。
  2. 確認傳送至 Maps JS API 的要求都附有 App Check 權杖:
      import {initializeApp} from 'firebase/app';
      import {
        getToken,
        initializeAppCheck,
        ReCaptchaEnterpriseProvider,
      } from 'firebase/app-check';
        
      async function init() {
        const {Settings} = await google.maps.importLibrary('core');
        const {Map} = await google.maps.importLibrary('maps');
      
        const app = initializeApp({
          // Your firebase configuration object
        });
      
        // Pass your reCAPTCHA Enterprise site key to initializeAppCheck().
        const appCheck = initializeAppCheck(app, {
          provider: new ReCaptchaEnterpriseProvider(
            'abcdefghijklmnopqrstuvwxy-1234567890abcd',
          ),
      
          // Optional argument. If true, the SDK automatically refreshes App Check
          // tokens as needed.
          isTokenAutoRefreshEnabled: true,
        });
      
        Settings.getInstance().fetchAppCheckToken = () =>
            getToken(appCheck, /* forceRefresh = */ false);
      
        // Load a map
        map = new Map(document.getElementById("map"), {
          center: { lat: 37.4161493, lng: -122.0812166 },
          zoom: 8,
        });
      }  
      

步驟 5:啟用偵錯功能 (選用)

如要在本機開發及測試應用程式,或在持續整合 (CI) 環境中執行應用程式,可以建立應用程式的偵錯版本,並使用偵錯密鑰取得有效的應用程式檢查權杖。這樣您就能避免在偵錯版本中使用真實的認證提供者。

如要在本機測試應用程式:

  • 啟用偵錯供應器以進行開發。
  • 您會從 SDK 的偵錯記錄中,收到系統自動產生的隨機 UUID4 (在 App Check 文件中稱為「偵錯權杖」)。將這個權杖新增至 Firebase 控制台。
  • 如需更多資訊和操作說明,請參閱 App Check 說明文件

如要在 CI 環境中執行應用程式,請按照下列步驟操作:

  • 在 Firebase 控制台中產生隨機 UUID4。
  • 將 UUID4 新增為偵錯權杖,然後複製到 CI 測試每次執行時都會存取的密碼存放區。
  • 如需更多資訊和操作說明,請參閱 App Check 說明文件

步驟 6:監控應用程式要求並決定強制執行方式

開始強制執行前,請先確認不會影響應用程式的合法使用者。為此,請前往「應用程式檢查」指標畫面,查看應用程式流量中,已驗證、過時或違法的流量百分比。確認大部分流量都已通過驗證後,即可啟用強制執行功能。

如需更多資訊和操作說明,請參閱 Firebase App Check 說明文件