本頁面說明如何使用自訂 App Check 供應器,在 Apple 應用程式中啟用 App Check。啟用 App Check,可確保只有您的應用程式能存取專案的 Firebase 資源。
如要搭配內建供應器使用 App Check,請參閱「搭配 App Attest 使用 App Check」和「搭配 DeviceCheck 使用 App Check」說明文件。
事前準備
如果您尚未將 Firebase 新增至 Apple 專案,請先新增。
1. 將 App Check 程式庫新增至應用程式
使用 Swift Package Manager 安裝及管理 Firebase 依附元件。
在 Xcode 中開啟應用程式專案,依序點選「File」>「Add Packages」,新增 Firebase Apple 平台 SDK 存放區 (
https://github.com/firebase/firebase-ios-sdk),然後選擇「FirebaseAppCheck」程式庫。
2. 實作 App Check 協定
首先,您需要建立實作 AppCheckProvider 和 AppCheckProviderFactory 通訊協定的類別。
AppCheckProvider 類別必須有 getToken(completion:) 方法,用於收集自訂 App Check 供應商所需的資訊,做為真實性證明,並將資訊傳送至權杖取得服務,以換取 App Check 權杖。App Check SDK 會處理權杖快取,因此請務必在 getToken(completion:) 實作中取得新權杖。
Swift
class YourCustomAppCheckProvider: NSObject, AppCheckProvider { var app: FirebaseApp init(withFirebaseApp app: FirebaseApp) { self.app = app super.init() } func getToken() async throws -> AppCheckToken { let getTokenTask = Task { () -> AppCheckToken in // ... // Create AppCheckToken object. let exp = Date(timeIntervalSince1970: expirationFromServer) let token = AppCheckToken( token: tokenFromServer, expirationDate: exp ) if Date() > exp { throw NSError(domain: "ExampleError", code: 1, userInfo: nil) } return token } return try await getTokenTask.value } }
Objective-C
@interface YourCustomAppCheckProvider : NSObject <FIRAppCheckProvider> @property FIRApp *app; - (id)initWithApp:(FIRApp *)app; @end @implementation YourCustomAppCheckProvider - (id)initWithApp:app { self = [super init]; if (self) { self.app = app; } return self; } - (void)getTokenWithCompletion:(nonnull void (^)(FIRAppCheckToken * _Nullable, NSError * _Nullable))handler { dispatch_async(dispatch_get_main_queue(), ^{ // Logic to exchange proof of authenticity for an App Check token. // ... // Create FIRAppCheckToken object. NSTimeInterval exp = expirationFromServer; FIRAppCheckToken *token = [[FIRAppCheckToken alloc] initWithToken:tokenFromServer expirationDate:[NSDate dateWithTimeIntervalSince1970:exp]]; // Pass the token or error to the completion handler. handler(token, nil); }); } @end
此外,請實作 AppCheckProviderFactory 類別,建立 AppCheckProvider 實作的例項:
Swift
class YourCustomAppCheckProviderFactory: NSObject, AppCheckProviderFactory { func createProvider(with app: FirebaseApp) -> AppCheckProvider? { return YourCustomAppCheckProvider(withFirebaseApp: app) } }
Objective-C
@interface YourCustomAppCheckProviderFactory : NSObject <FIRAppCheckProviderFactory> @end @implementation YourCustomAppCheckProviderFactory - (nullable id<FIRAppCheckProvider>)createProviderWithApp:(FIRApp *)app { return [[YourCustomAppCheckProvider alloc] initWithApp:app]; } @end
3. 初始化 App Check
在應用程式委派或應用程式初始化工具中,加入下列初始化程式碼:
Swift
let providerFactory = YourAppCheckProviderFactory() AppCheck.setAppCheckProviderFactory(providerFactory) FirebaseApp.configure()
Objective-C
YourAppCheckProviderFactory *providerFactory = [[YourAppCheckProviderFactory alloc] init]; [FIRAppCheck setAppCheckProviderFactory:providerFactory]; [FIRApp configure];
後續步驟
在應用程式中安裝 App Check 程式庫後,請開始向使用者發布更新後的應用程式。
更新後的用戶端應用程式會開始在向 Firebase 提出的每項要求中,一併傳送 App Check 權杖,但 Firebase 產品不會要求權杖必須有效,除非您在 Firebase 控制台的「App Check」部分啟用強制執行功能。
監控指標並啟用強制執行
不過,在啟用強制執行之前,請務必確認這樣做不會干擾現有的合法使用者。另一方面,如果發現應用程式資源有可疑的使用情形,建議您盡快啟用強制執行功能。
為協助您做出這項決定,您可以查看所用服務的 App Check 指標:
- 監控 App Check 要求指標:Firebase AI Logic、SQL Connect、Realtime Database、Cloud Firestore、Cloud Storage、Authentication、Google Identity for iOS、Maps JavaScript API 和 Places API (新版)。
- 監控 Cloud Functions 的 App Check 要求指標。
啟用App Check違規處置
瞭解 App Check 對使用者的影響,並準備好繼續操作後,即可啟用 App Check 強制執行:
- 啟用 App Check 違規處置:Firebase AI Logic、SQL Connect、Realtime Database、Cloud Firestore、Cloud Storage、Authentication、Google Identity for iOS、Maps JavaScript API 和 Places API (新版)。
- 為 Cloud Functions 啟用 App Check 違規處置。
在偵錯環境中使用 App Check
為應用程式註冊 App Check 後,如果您想在 App Check 通常不會歸類為有效的環境中執行應用程式,例如開發期間的模擬器,或持續整合 (CI) 環境,可以建立應用程式的偵錯版本,使用 App Check 偵錯服務,而非實際認證服務。
請參閱「在 Apple 平台搭配偵錯服務使用 App Check」。