Sử dụng tính năng Kiểm tra ứng dụng để bảo mật khoá API
Tính năng Kiểm tra ứng dụng 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 pháp. Để làm việc này, máy chủ sẽ kiểm tra mã thông báo của một nhà cung cấp dịch vụ chứng thực như Play Integrity. 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ệ ứng dụng 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 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ợ Kiểm tra ứng dụng trong các trường hợp sau:
- Bạn đang sử dụng Places SDK ban đầu. Tính năng Kiểm tra ứng dụng chỉ được hỗ trợ cho Places SDK (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 cung cấp công khai, thì bạn không cần 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 máy chủ với máy chủ, thì bạn không cần dù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 dịch vụ chứng thực được đề xuất của Kiểm tra ứng dụng sẽ không hoạt động trên những thiết bị mà nhà cung cấp dịch vụ chứng thực của bạn cho 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 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, sau đâ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 Kiểm tra ứng dụng:
- Thêm Firebase vào ứng dụng của bạn.
- Thêm và khởi chạy thư viện Kiểm tra ứng dụng.
- Thêm nhà cung cấp mã thông báo.
- Bật tính năng gỡ lỗi.
- 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 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 dựa trên việc chúng có đi kèm mã thông báo Kiểm tra ứng dụng hợp lệ hay không. Hãy xem tài liệu về 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 (có chứa bản triển khai Kiểm tra ứng dụng), bạn có thể bật chế độ thực thi. Sau khi bạn bật chế độ thực thi, 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ệ.
Những điều cần cân nhắc khi lên kế hoạch tích hợp 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:
Nhà cung cấp dịch vụ chứng thực mà chúng tôi đề xuất, Play Integrity, có giới hạn về số lệnh gọi hằng ngày cho cấp sử dụng API tiêu chuẩn. Để biết thêm thông tin về giới hạn lệnh gọi, hãy xem trang Thiết lập trong tài liệu dành cho nhà phát triển về Google Play Integrity.
Bạn cũng có thể chọn sử dụng một nhà cung cấp dịch vụ chứng thực tuỳ chỉnh, mặc dù đây là trường hợp sử dụng nâng cao. Để biết thêm thông tin, hãy xem bài viết Triển khai nhà cung cấp Kiểm tra ứng dụng tuỳ chỉnh.
-
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 ở chế độ nền và người dùng sẽ không còn gặp phải độ trễ nữa. Mức độ trễ chính xác khi khởi động phụ thuộc vào nhà cung cấp dịch vụ chứng thực mà bạn chọn.
Khoảng thời gian mà mã thông báo 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 thời lượng 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 cho nhà cung cấp dịch vụ chứng thực của bạn.
Tích hợp ứng dụng với tính năng Kiểm tra ứng dụng
Điều kiện tiên quyết và yêu cầu
- Một ứng dụng đã tích hợp SDK Địa điểm phiên bản 4.1 trở lên.
- Vân tay số SHA-256 cho ứng dụng của bạn.
- Tên gói của ứng dụng.
- 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 của bạn
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.
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
Để biết thông tin về cách sử dụng Play Integrity (nhà cung cấp dịch vụ chứng thực mặc định), hãy xem bài viết Bắt đầu sử dụng tính năng Kiểm tra ứng dụng bằng Play Integrity trên Android.
- Nếu bạn chưa làm, hãy tích hợp SDK Địa điểm vào ứng dụng của bạn.
Tiếp theo, hãy khởi chạy Kiểm tra ứng dụng và Ứng dụng Địa điểm.
// Initialize App Check FirebaseApp.initializeApp(/* context= */ this); FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance(); firebaseAppCheck.installAppCheckProviderFactory( PlayIntegrityAppCheckProviderFactory.getInstance()); // Initialize Places SDK Places.initializeWithNewPlacesApiEnabled(context, API_KEY); PlacesClient client = Places.createClient(context);.
Bước 3: Thêm nhà cung cấp mã thông báo
Sau khi khởi chạy Places API, hãy gọi setPlacesAppCheckTokenProvider() để đặt PlacesAppCheckTokenProvider.
Places.initializeWithNewPlacesApiEnabled(context, API_KEY); Places.setPlacesAppCheckTokenProvider(new TokenProvider()); PlacesClient client = Places.createClient(context);.
Dưới đây là ví dụ về cách triển khai giao diện trình tìm nạp mã thông báo:
/** Sample client implementation of App Check token fetcher interface. */ static class TokenProvider implements PlacesAppCheckTokenProvider { @Override public ListenableFuture<String> fetchAppCheckToken() { SettableFuture<String> future = SettableFuture.create(); FirebaseAppCheck.getInstance() .getAppCheckToken(false) .addOnSuccessListener( appCheckToken -> { future.set(appCheckToken.getToken()); }) .addOnFailureListener( ex -> { future.setException(ex); }); return future; } }
Bước 4: Bật tính năng gỡ lỗi (không bắt buộc)
Nếu muốn phát triển và thử nghiệm ứng dụng trên thiết bị của mình 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 khoá bí mật gỡ lỗi để lấy mã thông báo Kiểm tra ứng dụng hợp lệ. Nhờ đó, bạn có thể tránh sử dụng các nhà cung cấp dịch vụ chứng thực thực tế trong bản gỡ lỗi.
Cách chạy ứng dụng trong trình mô phỏng hoặc trên thiết bị thử nghiệm:
- Thêm thư viện Kiểm tra ứng dụng vào tệp
build.gradle. - Định cấu hình Kiểm tra ứng dụng để sử dụng nhà máy của nhà cung cấp dịch vụ gỡ lỗi trong bản gỡ lỗi.
- Chạy ứng dụng để tạo mã thông báo gỡ lỗi cục bộ. 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ề 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 của Firebase rồi thêm mã đó vào kho khoá bảo mật của hệ thống CI.
- Thêm thư viện Kiểm tra ứng dụng vào tệp
build.gradle. - Định cấu hình biến thể bản dựng CI để sử dụng mã thông báo gỡ lỗi.
- Gói mã trong các lớp kiểm thử cần có mã thông báo Kiểm tra ứng dụng bằng
DebugAppCheckTestHelper. - Để biết thêm thông tin và hướng dẫn, hãy xem tài liệu về Kiểm tra ứng dụng.
Bước 5: 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 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ố của 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ệ. Sau 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 chế độ thực thi.
Hãy xem tài liệu về Kiểm tra ứng dụng Firebase để biết thêm thông tin và hướng dẫn.