本頁面說明如何使用自訂 App Check 供應器,在 Apple 應用程式中啟用 App Check。啟用 App Check 後,您就能確保只有您的應用程式可以存取專案的 Firebase 資源。
如果您想將 App Check 與內建提供者搭配使用,請參閱 App Check 與 App Attest 的說明文件,以及 App Check 與 DeviceCheck 搭配使用的說明文件。
事前準備
如果您尚未將 Firebase 新增至 Apple 專案,請先完成這項操作。
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:)
時,請一律取得新的權杖。
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 程式庫後,即可開始將更新過的應用程式發布給使用者。
更新後的用戶端應用程式將開始傳送 App Check 權杖,以及對 Firebase 發出的每個要求,但在您於 Firebase 控制台的 App Check 區段啟用強制執行之前,Firebase 產品將不需要權杖有效。
監控指標並啟用強制執行功能
不過,在強制執行之前,您應先確認這樣做不會影響現有的合法使用者。另一方面,如果您發現應用程式資源遭到濫用,建議您盡早啟用強制執行功能。
為協助您做出這項決定,您可以查看所用服務的 App Check 指標:
- 監控 Realtime Database、Cloud Firestore、Cloud Storage、Authentication (Beta 版) 和 Vertex AI in Firebase 的 App Check 要求指標。
- 監控「Cloud Functions」的 App Check 個要求指標。
啟用「App Check」強制執行功能
瞭解 App Check 對使用者的影響,您已準備好進行後續步驟時,可以啟用 App Check 強制執行:
- 為 Realtime Database、Cloud Firestore、Cloud Storage、Authentication (Beta 版) 和 Vertex AI in Firebase 啟用 App Check 強制執行功能。
- 為 Cloud Functions 啟用 App Check 強制執行功能。
在偵錯環境中使用 App Check
註冊應用程式 App Check 後,您希望在 App Check 通常不會歸類為有效的環境中 (例如開發期間的模擬器,或從持續整合 (CI) 環境) 執行應用程式,您可以建立使用 App Check 偵錯提供者 (而非實際認證提供者) 的應用程式偵錯版本。
請參閱「在 Apple 平台上使用 App Check 與偵錯提供者」。