Chọn nền tảng: Android iOS JavaScript

Sử dụng App Check để bảo mật khoá API

Tính năng Kiểm tra ứng dụng của Firebase giúp bảo vệ các lệnh gọi từ ứng dụng của bạn đến Google Maps Platform 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 lệ. Để thực hiện việc này, ứng dụng sẽ kiểm tra mã thông báo từ một nhà cung cấp dịch vụ chứng thực như App Attest. Việc tích hợp ứng dụng của bạn 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 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 dùng App Check 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ợ dùng App Check trong các trường hợp sau:

• Bạn đang sử dụng Places SDK ban đầu. App Check chỉ được hỗ trợ cho Places SDK (Mới).
• Ứng dụng riêng tư hoặc ứng dụng thử nghiệm. Nếu ứng dụng của bạn không truy cập được công khai, thì bạn không cần App Check.
• Nếu ứng dụng của bạn chỉ được dùng cho máy chủ với máy chủ, thì bạn không cần App Check. Tuy nhiên, nếu máy chủ giao tiếp với GMP được dùng bởi các ứng dụng công khai (chẳng hạn như ứng dụng di động), hãy cân nhắc sử dụng App Check để bảo vệ máy chủ đó thay vì GMP.
• Các nhà cung cấp chứng thực được App Check đề xuất 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 cho là bị xâm nhập hoặc không đáng tin cậy. Nếu cần hỗ trợ những thiết bị như vậy, bạn có thể triển khai một 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 của mình với App Check:

1. Thêm Firebase vào ứng dụng của bạn.
2. Thêm và khởi chạy thư viện Kiểm tra ứng dụng.
3. Thêm nhà cung cấp mã thông báo vào ứng dụng của bạn.
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. Giám sát các yêu cầu của ứng dụng và quyết định 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 của 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 yêu cầu đó có đi kèm với 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 của 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 lệ và người dùng đã cập nhật lên phiên bản mới nhất của ứng dụng (có bao gồm việc triển khai App Check), bạn có thể bật chế độ thực thi. Sau khi bạn bật chế độ thực thi, App Check sẽ từ chối tất cả lưu lượng truy cập không có mã thông báo App Check hợp lệ.

Lưu ý: Theo mặc định, tính năng thực thi kiểm tra ứng dụng sẽ không được bật.

Những điều cần cân nhắc khi lên kế hoạch tích hợp App Check

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 hoặc App Attest) phải tuân theo hạn mức và giới hạn do Apple đặt ra.

  Bạn có thể chọn sử dụng một nhà cung cấp chứng thực tuỳ chỉnh, mặc dù đây là một 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 của 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 số độ 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 trong nền và người dùng sẽ không còn gặp phải bất kỳ độ trễ nào 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à mã thông báo App Check 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. Quy trình chứng thực lại xảy ra khi khoảng một nửa thời gian TTL đã trôi qua. Để biết thêm thông tin, hãy xem tài liệu của Firebase cho trình chứng thực của bạn.

Tích hợp ứng dụng của bạn với App Check

Lưu ý: Nhận 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ợ của Firebase. Để được hỗ trợ về Google Places SDK cho iOS, hãy xem phần Dịch vụ hỗ trợ của 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 Places SDK 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 Apple Member Center, trong phần Membership (Gói thành viên).
• Nếu bạn dự định sử dụng Device Check, hãy dùng tệp khoá riêng tư và mã khoá.
• Bạn phải là chủ sở hữu của ứng dụng trong Bảng điều khiển Google Cloud.
• 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 của bạn

Làm theo hướng dẫn trong tài liệu dành cho nhà phát triển của 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 (không 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, khi bạn thêm các mô-đun Firebase vào tệp AppDelegate, hãy thêm các mô-đun sau:

Places Swift SDK dành cho iOS

import FirebaseCore
import FirebaseAppCheck
import GooglePlacesSwift

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 Kiểm tra ứng dụng

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

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 về App Attest.
   • Hướng dẫn sử dụng Device Check.
2. Chạy tính năng Kiểm tra ứng dụng.
   • Nếu bạn đang sử dụng App Attest, hãy làm theo tài liệu dành cho nhà phát triển Firebase về App Attest.

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

     Places Swift SDK dành cho iOS

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

     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 Device Check, hãy thêm nội dung sau vào AppDelegate:

     Places Swift SDK dành cho iOS

     AppCheck.setAppCheckProviderFactory(DeviceCheckProviderFactory())

     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, hãy tạo 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:

Places Swift SDK dành cho iOS

// AppCheckTokenProvider.swift

import FirebaseAppCheck
import Foundation
import GooglePlacesSwift
      
struct TokenProvider: AppCheckTokenProvider {
  func fetchAppCheckToken() async throws -> String {
    return try await AppCheck.appCheck().token(forcingRefresh: false).token
  }
}
      

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 Địa điểm và API Kiểm tra ứng dụng

1. Trong tệp AppDelegate, hãy khởi chạy Places API:

   Places Swift SDK dành cho iOS

   PlacesClient.provideAPIKey("YOUR_API_KEY")

   Swift

   GMSPlacesClient.provideAPIKey("YOUR_API_KEY")

   Objective-C

   [GMSPlacesClient provideAPIKey:@"YOUR_API_KEY"];

2. Sau đó, hãy khởi chạy App Check API:

   Places Swift SDK dành cho iOS

   PlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

   Swift

   GMSPlacesClient.setAppCheckTokenProvider(AppCheckTokenProvider())

   Objective-C

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

Bước 5: Bật chế độ gỡ lỗi (không bắt buộc)

Nếu muốn phát triển và kiểm thử ứng dụng cục bộ 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 một bản gỡ lỗi của ứng dụng sử dụng một khoá bí mật 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 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ẫu mã này xử lý cả hai trường hợp gỡ lỗi và sản xuất:

  Places Swift SDK dành cho iOS

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

  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, khởi chạy ứng dụng và tìm mã 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ề App Check.

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 của 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 chương trình kiểm thử của bạn với tên FIRAAppCheckDebugToken và $(APP_CHECK_DEBUG_TOKEN) (hoặc tên tương tự) làm giá trị.
• 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ột môi trường

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

  Mẫu mã này xử lý cả hai trường hợp gỡ lỗi và sản xuất:

  Places Swift SDK dành cho iOS

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

  Swift

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

  Objective-C

  #if DEBUG
  id<FIRAppCheckProviderFactory> providerFactory =
      [[FIRAppCheckDebugProviderFactory alloc] init];
  #else  // DEBUG
  id<FIRAppCheckProviderFactory> providerFactory =
      [[YourAppCheckProviderFactory alloc] init];
  #endif  // DEBUG
  AppCheck.setAppCheckProviderFactory(providerFactory)

• Để biết thêm thông tin và hướng dẫn, hãy xem tài liệu về App Check.

Bước 6: Giám sát các yêu cầu của ứng dụng và quyết định về việc thực thi

Trước khi bắt đầu thực thi, bạn cần đảm bảo rằng bạn 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ố App Check để 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 pháp. Sau khi thấy rằng phần lớn lưu lượng truy cập của bạn đã được xác minh, bạn có thể bật chế độ thực thi.

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

Trước khi thực thi App Check, hãy đảm bảo mọi lệnh gọi Dịch vụ web trong dự án Cloud của bạn đều sử dụng OAuth.