本頁向您展示如何使用自訂 App Check 提供者在 Apple 應用程式中啟用 App Check。啟用應用程式檢查後,您可以協助確保只有您的應用程式可以存取專案的 Firebase 資源。
如果您想將 App Check 與內建提供者一起使用,請參閱App Check 與 App Attest和App Check 與 DeviceCheck的文檔。
在你開始之前
1. 將 App Check 庫加入您的應用程式中
將 App Check 的依賴項新增至專案的
Podfile
:pod 'FirebaseAppCheck'
或者,您也可以使用Swift Package Manager 。
另外,請確保您使用的是您所依賴的任何 Firebase 服務用戶端程式庫的最新版本。
運行
pod install
並開啟建立的.xcworkspace
檔。
2. 實施App Check協議
首先,您需要建立實作AppCheckProvider
和AppCheckProviderFactory
協定的類別。
您的AppCheckProvider
類別必須具有getToken(completion:)
方法,該方法收集您的自訂App Check 提供者所需的任何資訊作為真實性證明,並將其發送到您的令牌獲取服務以換取App Check 令牌。 App Check SDK 處理令牌緩存,因此始終在getToken(completion:)
的實作中取得新令牌。
迅速
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
實作的實例:
迅速
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. 初始化應用檢查
將以下初始化程式碼新增至您的應用程式委託或應用程式初始化程式:
迅速
let providerFactory = YourAppCheckProviderFactory() AppCheck.setAppCheckProviderFactory(providerFactory) FirebaseApp.configure()
Objective-C
YourAppCheckProviderFactory *providerFactory = [[YourAppCheckProviderFactory alloc] init]; [FIRAppCheck setAppCheckProviderFactory:providerFactory]; [FIRApp configure];
下一步
在您的應用程式中安裝 App Check 庫後,開始向您的用戶分發更新的應用程式。
更新後的客戶端應用程式將開始發送應用程式檢查令牌及其向Firebase 發出的每個請求,但Firebase 產品不會要求令牌有效,直到您在Firebase 控制台的應用程式檢查部分中啟用強制執行。
監控指標並啟用執行
但是,在啟用強制執行之前,您應該確保這樣做不會幹擾您現有的合法使用者。另一方面,如果您發現應用程式資源的可疑使用,您可能希望盡快啟用強制執行。
為了幫助做出此決定,您可以查看您使用的服務的 App Check 指標:
啟用應用程式檢查強制執行
當您了解 App Check 將如何影響您的使用者並且準備好繼續操作時,您可以啟用 App Check 強制執行:
- 為即時資料庫、Cloud Firestore、雲端儲存和驗證(測試版)啟用應用程式檢查強制執行。
- 為 Cloud Functions 啟用應用程式檢查強制執行。
在調試環境中使用 App Check
如果在為App Check 註冊您的應用程式後,您希望在App Check 通常不會歸類為有效的環境中運行您的應用程序,例如開發期間的模擬器,或在持續整合(CI) 環境中,您可以建立應用程式的偵錯版本,該版本使用 App Check 偵錯提供者而不是真正的證明提供者。
請參閱在 Apple 平台上使用 App Check 與偵錯提供者。