Firebase ML Apple アプリの Cloud 認証情報を保護する

Apple アプリが Firebase ML の Cloud APIs のいずれかを使用している場合、本番環境でアプリをリリースする前に、不正な API アクセスを防ぐためにいくつかの追加手順を行う必要があります。

1. 既存の API キーの範囲を縮小する

まず、Cloud Vision API へのアクセスを許可しないように既存の API キーを構成します。

Google Cloud コンソールの認証情報ページを開きます。画面の指示に沿って、プロジェクトを選択します。
リスト内にある既存の API キーごとに、編集ビューを開きます。
[API の制限] セクションで [キーを制限] を選択し、API キーによるアクセスを許可するすべての API をリストに追加します。Cloud Vision API は含めないでください。

API キーの API の制限を構成することで、キーがアクセス権を持つ API を明示的に宣言します。デフォルトでは、[API の制限] セクションで [キーを制限しない] が選択されている場合、API キーを使用してプロジェクトで有効になっているすべての API にアクセスできます。

これで、既存の API キーはクラウド ML サービスへのアクセスを許可しなくなりますが、各キーは、API の制限リストに追加したすべての API で引き続き機能します。

今後 API を追加で有効にする場合は、該当する API キーの API の制限リストにそれらを追加する必要があります。

2. Firebase ML で使用する新しい API キーを作成する

次に、Cloud Vision API への呼び出しのみを許可する Firebase ML 用の新しい API キーを作成します。

認証情報ページに戻ります。Firebase プロジェクトが選択されていることを確認してください。
[認証情報を作成] > [API キー] の順にクリックします。新しい API キーをメモし、[キーを制限] をクリックします。
[API の制限] セクションで [キーを制限] を選択し、Cloud Vision API のみをリストに追加します。

この API キーは Cloud Vision API へのアクセスのみを許可し、Firebase ML がクラウドベースのモデルにアクセスするために使用できます。

3. 推奨: Cloud Vision API の割り当てを減らす

キーが不正使用された場合の影響を軽減するため、ユーザーごとの Cloud Vision API の割り当てをデフォルト設定より小さくすることをおすすめします。手順は次のとおりです。

Google Cloud コンソールの Cloud Vision API の [割り当て] ページを開きます。画面の指示に沿って、プロジェクトを選択します。
[リクエスト] セクションで、[Requests per minute per user] の割り当てを、アプリに適した値に設定します。たとえば、アプリでドキュメントの画像をアップロードしてそのテキストを取得する場合、ユーザーがその操作を行うのは多くても数秒に 1 回と想定されるため、割り当ては 30～40 あれば十分であると考えられます。

ここで、「ユーザーごとのリクエスト数」は、単一の IP アドレスからのリクエストを指すことに注意してください。複数のユーザーが NAT を通じて同時にアプリを使用することが想定される場合は、この点を考慮する必要があります。

4. Firebase ML API キーを使用して Cloud APIs を呼び出す

最後に、アプリで新しい API キーを使用するように Firebase ML を構成します。

Firebase ML の API キーは Cloud Vision API への認証されていないアクセスを許可するため、不正使用や請求先アカウントへの請求を防ぐために、キーを機密にしておくことが重要です。機密にするため、アプリのバイナリに API キーを含めないでください。代わりに、アプリのランタイム時に、既知の安全なユーザーがログインしていることを確認してから、サーバーから API キーを取得します。

これらの方法を守っても、API キーが侵害される可能性があります。上記のようにユーザーごとの API の割り当てを減らしたり、鍵のローテーションポリシーを実装したり、異なるユーザーグループに異なるキーを発行したりするなど、キーが不正使用された場合の影響を軽減する対策を講じてください。

アプリで API キーを安全に取得したら、Firebase ML の Cloud API を呼び出すときにキーを指定します。

Swift

if let cloudVisionKey = getYourApiKey() {  // See note above about securing your API key
    let options = VisionCloudDetectorOptions()
    options.apiKeyOverride = cloudVisionKey
    let cloudDetector = Vision.vision().cloudLandmarkDetector(options: options)
}

Objective-C

NSString *cloudVisionKey = [self getYourApiKey];  // See note above about securing your API key
if (cloudVisionKey != nil) {
    FIRVisionCloudDetectorOptions *options =
            [[FIRVisionCloudDetectorOptions alloc] init];
    options.APIKeyOverride = cloudVisionKey;
    FIRVisionCloudLandmarkDetector *landmarkDetector =
            [vision cloudLandmarkDetectorWithOptions:options];
}

また、API キーの保護の一般的なアドバイスに従ってください。

次のステップ

他の Firebase 機能を使用している場合のアプリのリリース準備方法については、リリースチェックリストをご覧ください。