Sử dụng tính năng Kiểm tra ứng dụng để bảo mật khoá API

Firebase App Check bảo vệ các lệnh gọi từ ứng dụng của bạn đến Nền tảng Google Maps bằng cách chặn lưu lượng truy cập đến từ các nguồn không phải là ứng dụng hợp pháp. Tính năng này thực hiện việc này bằng cách kiểm tra mã thông báo từ một nhà cung cấp dịch vụ chứng thực như Chứng thực ứng dụng. Việc tích hợp ứng dụng với tính năng Kiểm tra ứng dụng giúp bảo vệ khỏi các yêu cầu độc hại, nhờ đó bạn sẽ không bị tính phí cho các lệnh gọi API trái phép.

Tính năng Kiểm tra ứng dụng có phù hợp với tôi không?

Bạn nên sử dụng tính năng Kiểm tra ứng dụng trong hầu hết các trường hợp. Tuy nhiên, bạn không cần hoặc không được hỗ trợ sử dụng tính năng này trong các trường hợp sau:

• Bạn đang sử dụng SDK Places ban đầu. Công cụ kiểm tra ứng dụng chỉ được hỗ trợ cho SDK Địa điểm (Mới).
• Ứng dụng riêng tư hoặc thử nghiệm. Nếu ứng dụng của bạn không được công khai, thì bạn không cần phải sử dụng tính năng Kiểm tra ứng dụng.
• Nếu ứng dụng của bạn chỉ được dùng giữa các máy chủ, thì bạn không cần phải sử dụng tính năng Kiểm tra ứng dụng. Tuy nhiên, nếu máy chủ giao tiếp với GMP được các ứng dụng công khai (chẳng hạn như ứng dụng di động) sử dụng, hãy cân nhắc sử dụng tính năng Kiểm tra ứng dụng để bảo vệ máy chủ đó thay vì GMP.
• Các nhà cung cấp chứng thực được đề xuất của App Check sẽ không hoạt động trên những thiết bị mà nhà cung cấp chứng thực của bạn coi là bị xâm phạm hoặc không đáng tin cậy. Nếu cần hỗ trợ các thiết bị như vậy, bạn có thể triển khai dịch vụ chứng thực tuỳ chỉnh. Để biết thêm thông tin, hãy xem hướng dẫn.

Tổng quan về các bước triển khai

Nhìn chung, đây là các bước bạn sẽ thực hiện để tích hợp ứng dụng với tính năng Kiểm tra ứng dụng:

1. Thêm Firebase vào ứng dụng.
2. Thêm và khởi chạy thư viện Kiểm tra ứng dụng.
3. Thêm trình cung cấp mã thông báo vào ứng dụng.
4. Khởi chạy API Địa điểm và API Kiểm tra ứng dụng.
5. Bật tính năng gỡ lỗi.
6. Theo dõi các yêu cầu của ứng dụng và quyết định biện pháp thực thi.

Sau khi tích hợp với tính năng Kiểm tra ứng dụng, bạn sẽ có thể xem các chỉ số lưu lượng truy cập phụ trợ trên bảng điều khiển Firebase. Các chỉ số này cung cấp thông tin chi tiết về các yêu cầu theo việc chúng có đi kèm mã thông báo App Check hợp lệ hay không. Hãy xem tài liệu về tính năng Kiểm tra ứng dụng Firebase để biết thêm thông tin.

Khi chắc chắn rằng hầu hết các yêu cầu đều đến từ các nguồn hợp pháp và người dùng đã cập nhật lên phiên bản mới nhất của ứng dụng (bao gồm cả việc triển khai tính năng Kiểm tra ứng dụng), bạn có thể bật tính năng thực thi. Sau khi bạn bật tính năng thực thi, tính năng Kiểm tra ứng dụng sẽ từ chối tất cả lưu lượng truy cập không có mã thông báo Kiểm tra ứng dụng hợp lệ.

Lưu ý: Tính năng thực thi quy trình kiểm tra ứng dụng không được bật theo mặc định.

Những điều cần cân nhắc khi lên kế hoạch tích hợp tính năng Kiểm tra ứng dụng

Sau đây là một số điều cần cân nhắc khi bạn lên kế hoạch tích hợp:

• Các nhà cung cấp chứng thực mà chúng tôi đề xuất, Device Check (Kiểm tra thiết bị) hoặc App Attest (Chứng thực ứng dụng), phải tuân thủ hạn mức và giới hạn do Apple đặt ra.

  Bạn có thể chọn sử dụng nhà cung cấp chứng thực tuỳ chỉnh, mặc dù đây là trường hợp sử dụng nâng cao. Hãy xem tài liệu về tính năng Kiểm tra ứng dụng Firebase để biết thêm thông tin.

• Người dùng ứng dụng của bạn sẽ gặp phải một chút độ trễ khi khởi động. Tuy nhiên, sau đó, mọi hoạt động chứng thực lại định kỳ sẽ diễn ra ở chế độ nền và người dùng sẽ không còn phải chờ đợi nữa. Độ trễ chính xác khi khởi động phụ thuộc vào nhà cung cấp chứng thực mà bạn chọn.

  Khoảng thời gian mã thông báo của tính năng Kiểm tra ứng dụng có hiệu lực (thời gian tồn tại hoặc TTL) xác định tần suất chứng thực lại. Bạn có thể định cấu hình khoảng thời gian này trong bảng điều khiển của Firebase. Quá trình chứng thực lại diễn ra khi khoảng một nửa TTL đã trôi qua. Để biết thêm thông tin, hãy xem tài liệu về Firebase dành cho trình cung cấp chứng thực của bạn.

Tích hợp ứng dụng của bạn với tính năng Kiểm tra ứng dụng

Lưu ý: Nhận sự trợ giúp nhanh hơn! Để được hỗ trợ về các phần liên quan đến Firebase trong quy trình này, hãy xem phần Hỗ trợ Firebase. Để được hỗ trợ về SDK Địa điểm của Google dành cho iOS, hãy xem phần Hỗ trợ Nền tảng Google Maps.

Điều kiện tiên quyết và yêu cầu

• Một ứng dụng đã cài đặt SDK Địa điểm phiên bản 9.2 trở lên.
• Mã nhận dạng gói của ứng dụng.
• Mã nhóm của bạn trong phần Gói thành viên trên Trung tâm thành viên của Apple.
• Nếu bạn dự định sử dụng tính năng Kiểm tra thiết bị, hãy chuẩn bị tệp khoá riêng tư và mã khoá.
• Bạn phải là chủ sở hữu của ứng dụng trong Cloud Console.
• Bạn sẽ cần mã dự án của ứng dụng trong Cloud Console

Bước 1: Thêm Firebase vào ứng dụng

Làm theo hướng dẫn trong tài liệu dành cho nhà phát triển Firebase để thêm Firebase vào ứng dụng của bạn.

Khi đăng ký ứng dụng, bạn sẽ nhận được một tệp cấu hình, GoogleService-Info.plist. Thêm tệp này (chưa sửa đổi) vào cấp gốc của ứng dụng.

Lưu ý: Trong bước 5 của tài liệu dành cho nhà phát triển Firebase, nơi bạn thêm các mô-đun Firebase vào tệp AppDelegate, hãy thêm các mô-đun sau:

Swift

import FirebaseCore
import FirebaseAppCheck
import GooglePlaces

Objective-C

@import FirebaseCore;      
@import FirebaseAppCheck;
@import GooglePlaces;

Bước 2: Thêm thư viện Kiểm tra ứng dụng và khởi chạy tính năng Kiểm tra ứng dụng

Firebase cung cấp hướng dẫn cho từng nhà cung cấp chứng thực mặc định. Hướng dẫn này cho bạn biết cách thiết lập dự án Firebase và thêm thư viện Kiểm tra ứng dụng vào ứng dụng. Hãy làm theo các mã mẫu được cung cấp để khởi chạy tính năng Kiểm tra ứng dụng.

1. Làm theo hướng dẫn của Firebase để thêm thư viện Kiểm tra ứng dụng:
   • Hướng dẫn xác thực ứng dụng.
   • Hướng dẫn kiểm tra thiết bị.
2. Khởi chạy tính năng Kiểm tra ứng dụng.
   • Nếu bạn đang sử dụng tính năng Chứng thực ứng dụng, hãy làm theo tài liệu dành cho nhà phát triển Firebase về tính năng Chứng thực ứng dụng.

     Làm theo hướng dẫn về tính năng Kiểm tra ứng dụng Firebase để tạo một cách triển khai AppCheckProviderFactory và thêm cách triển khai đó vào tệp AppDelegate.

     Swift

     let providerFactory = YourAppCheckProviderFactory()
     AppCheck.setAppCheckProviderFactory(providerFactory)

     Objective-C

     YourAppCheckProviderFactory *providerFactory =
         [[YourAppCheckProviderFactory alloc] init];
     [FIRAppCheck setAppCheckProviderFactory:providerFactory];
        

   • Nếu bạn đang sử dụng tính năng Kiểm tra thiết bị, hãy thêm nội dung sau vào AppDelegate:

     Swift

     AppCheck.setAppCheckProviderFactory(DeviceCheckProviderFactory())

     Objective-C

     [FIRAppCheck setAppCheckProviderFactory:providerFactory];
           

Bước 3: Thêm trình cung cấp mã thông báo

Tạo một tệp có tên là AppCheckTokenProvider (hoặc nếu bạn đang sử dụng Objective-C, hai tệp có tên là AppCheckTokenProvider.h và AppCheckTokenProvider.m) ở cấp gốc của ứng dụng. Thêm các câu lệnh nhập và định nghĩa lớp sau:

Swift

// AppCheckTokenProvider.swift

import FirebaseAppCheck
import Foundation
import GooglePlaces

class AppCheckTokenProvider: NSObject, GMSPlacesAppCheckTokenProvider {
  func fetchAppCheckToken() async throws -> String {
    return try await AppCheck.appCheck().token(forcingRefresh: false).token
  }
}

Objective-C

// AppCheckTokenProvider.h

@import Foundation;
@import GooglePlaces;

@interface AppCheckTokenProvider : NSObject <GMSPlacesAppCheckTokenProvider>
@end

// AppCheckTokenProvider.m

#import "AppCheckTokenProvider.h"

@import FirebaseAppCheck;

@implementation AppCheckTokenProvider

- (void)fetchAppCheckTokenWithCompletion:(nonnull GMSAppCheckTokenCompletion)completion {
  [[FIRAppCheck appCheck]
      tokenForcingRefresh:NO
               completion:^(FIRAppCheckToken *_Nullable token, NSError *_Nullable error) {
                 if (token) {
                   completion(token.token, nil);
                 } else {
                   completion(nil, error);
                 }
               }];
}

@end

Bước 4: Khởi chạy API Kiểm tra ứng dụng và API Địa điểm

1. Trong tệp AppDelegate, hãy khởi chạy API Địa điểm:

   Swift

   GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

   Objective-C

   [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

2. Sau đó, hãy khởi chạy API Kiểm tra ứng dụng:

   Swift

   GMSPlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

   Objective-C

   [GMSPlacesClient setAppCheckTokenProvider:[[AppCheckTokenProvider alloc] init]];

Bước 5: Bật tính năng gỡ lỗi (không bắt buộc)

Nếu muốn phát triển và kiểm thử ứng dụng trên máy hoặc chạy ứng dụng trong môi trường tích hợp liên tục (CI), bạn có thể tạo bản gỡ lỗi của ứng dụng sử dụng khoá gỡ lỗi để lấy mã thông báo App Check hợp lệ. Điều này giúp bạn tránh sử dụng các trình cung cấp chứng thực thực trong bản gỡ lỗi.

Cách kiểm thử ứng dụng trong Trình mô phỏng hoặc trên thiết bị kiểm thử:

• Tạo và thiết lập nhà máy nhà cung cấp gỡ lỗi App Check.

  Mã mẫu này xử lý cả trường hợp gỡ lỗi và trường hợp phát hành công khai:

  Swift

  #if targetEnvironment(simulator)
        let providerFactory = AppCheckDebugProviderFactory()
  #else
        let providerFactory = YourAppCheckProviderFactory()
  #endif

  Objective-C

  if (targetEnvironment == simulator){
  
  FIRAppCheckDebugProviderFactory *providerFactory =
        [[FIRAppCheckDebugProviderFactory alloc] init];
  [FIRAppCheck setAppCheckProviderFactory:providerFactory];
  }
  
  else {
  
  YourAppCheckProviderFactory *providerFactory =
        [[YourAppCheckProviderFactory alloc] init];
  [FIRAppCheck setAppCheckProviderFactory:providerFactory];
  }
      

• Bật tính năng ghi nhật ký trên dự án Xcode, chạy ứng dụng và tìm mã thông báo gỡ lỗi cục bộ trong nhật ký.
• Thêm mã thông báo này vào bảng điều khiển của Firebase.
• Để biết thêm thông tin và hướng dẫn, hãy xem tài liệu về tính năng Kiểm tra ứng dụng.

Cách chạy ứng dụng trong môi trường CI:

• Tạo mã thông báo gỡ lỗi trong bảng điều khiển Firebase rồi thêm mã thông báo đó vào kho khoá bảo mật của hệ thống CI.
• Trong Xcode, hãy thêm một biến môi trường vào lược đồ kiểm thử của bạn với tên FIRAAppCheckDebugToken và $(APP_CHECK_DEBUG_TOKEN) (hoặc một giá trị tương tự).
• Trong tập lệnh kiểm thử CI, hãy truyền mã thông báo gỡ lỗi dưới dạng môi trường

• Tạo và thiết lập nhà máy nhà cung cấp gỡ lỗi App Check.

  Mã mẫu này xử lý cả trường hợp gỡ lỗi và trường hợp phát hành công khai:

  Swift

    #if targetEnvironment(ci)
          let providerFactory = AppCheckDebugProviderFactory()
          AppCheck.setAppCheckProviderFactory(providerFactory)
    #else
          let providerFactory = YourAppCheckProviderFactory()
    #endif
    

  Objective-C

  if (targetEnvironment == ci) {
  FIRAppCheckDebugProviderFactory *providerFactory =
        [[FIRAppCheckDebugProviderFactory alloc] init];
  [FIRAppCheck setAppCheckProviderFactory:providerFactory];
  }
  
  else {
  YourAppCheckProviderFactory *providerFactory =
        [[YourAppCheckProviderFactory alloc] init];
  [FIRAppCheck setAppCheckProviderFactory:providerFactory];
  }

• Để biết thêm thông tin và hướng dẫn, hãy xem tài liệu về tính năng Kiểm tra ứng dụng.

Bước 6: Theo dõi các yêu cầu của ứng dụng và quyết định biện pháp thực thi

Trước khi bắt đầu thực thi, bạn cần đảm bảo rằng mình sẽ không làm gián đoạn người dùng hợp pháp của ứng dụng. Để làm việc này, hãy truy cập vào màn hình chỉ số của Công cụ kiểm tra ứng dụng để xem tỷ lệ phần trăm lưu lượng truy cập của ứng dụng đã được xác minh, đã lỗi thời hoặc không hợp lệ. Khi thấy phần lớn lưu lượng truy cập của mình đã được xác minh, bạn có thể bật tính năng thực thi.

Hãy xem tài liệu về tính năng Kiểm tra ứng dụng Firebase để biết thêm thông tin và hướng dẫn.

Trước khi bạn thực thi tính năng Kiểm tra ứng dụng, hãy đảm bảo mọi lệnh gọi Dịch vụ web trong dự án trên Cloud đều sử dụng OAuth.