Comece a usar o App Check com o Play Integrity no Android

Esta página mostra como ativar o App Check em um aplicativo Android, usando o provedor Play Integrity integrado. Ao ativar o App Check, você ajuda a garantir que apenas seu aplicativo possa acessar os recursos do Firebase do seu projeto. Veja uma visão geral deste recurso.

Atualmente, o provedor integrado Play Integrity suporta apenas aplicativos Android distribuídos pelo Google Play. Para usar os recursos fora do Play Integrity ou para usar o App Check com seu próprio provedor personalizado, consulte Implementar um provedor personalizado de App Check .

1. Configure seu projeto do Firebase

1. Adicione o Firebase ao seu projeto Android, caso ainda não o tenha feito.

2. Ative a API Play Integrity:

   1. No Google Play Console , selecione seu aplicativo ou adicione-o, caso ainda não o tenha feito.

   2. Na seção Versão , clique em Configuração > Integridade do aplicativo .

   3. Na página Integrity API , clique em Vincular projeto e selecione seu projeto do Firebase na lista de projetos do Google Cloud.

      O projeto que você selecionar aqui deve ser o mesmo projeto do Firebase em que você registrou seu aplicativo (consulte a próxima etapa).

3. Registre seus aplicativos para usar o App Check com o provedor Play Integrity na seção App Check do Firebase console. Você precisará fornecer a impressão digital SHA-256 do certificado de assinatura do seu aplicativo.

   Normalmente, você precisa registrar todos os aplicativos do seu projeto, porque depois de habilitar a imposição para um produto Firebase, apenas os aplicativos registrados poderão acessar os recursos de back-end do produto.

4. Opcional : nas configurações de registro do aplicativo, defina uma vida útil (TTL) personalizada para tokens do App Check emitidos pelo provedor. Você pode definir o TTL para qualquer valor entre 30 minutos e 7 dias. Ao alterar esse valor, esteja ciente das seguintes compensações:

   • Segurança: TTLs mais curtos fornecem segurança mais forte, porque reduzem a janela na qual um token vazado ou interceptado pode ser abusado por um invasor.
   • Desempenho: TTLs mais curtos significam que seu aplicativo realizará atestados com mais frequência. Como o processo de atestado do aplicativo adiciona latência às solicitações de rede sempre que é executado, um TTL curto pode afetar o desempenho do seu aplicativo.
   • Cota e custo: TTLs mais curtos e reatestações frequentes esgotam sua cota mais rapidamente e, para serviços pagos, podem custar mais. Consulte Cotas e limites .

   O TTL padrão de 1 hora é razoável para a maioria dos aplicativos. Observe que a biblioteca do App Check atualiza os tokens em aproximadamente metade da duração do TTL.

2. Adicione a biblioteca App Check ao seu aplicativo

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

3. Inicialize a verificação do aplicativo

Adicione o seguinte código de inicialização ao seu aplicativo para que ele seja executado antes de usar qualquer outro SDK do Firebase:

FirebaseApp.initializeApp(/*context=*/this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance()
)

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());

Próximos passos

Depois que a biblioteca do App Check estiver instalada em seu aplicativo, comece a distribuir o aplicativo atualizado para seus usuários.

O aplicativo cliente atualizado começará a enviar tokens do App Check junto com todas as solicitações feitas ao Firebase, mas os produtos Firebase não exigirão que os tokens sejam válidos até que você habilite a aplicação na seção App Check do console do Firebase.

Monitore as métricas e habilite a aplicação

Antes de habilitar a imposição, no entanto, certifique-se de que isso não interromperá seus usuários legítimos existentes. Por outro lado, se você perceber o uso suspeito dos recursos do seu aplicativo, convém ativar a aplicação mais cedo.

Para ajudar a tomar essa decisão, você pode consultar as métricas do App Check para os serviços que usa:

• Monitore as métricas de solicitação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Monitore as métricas de solicitação de verificação de aplicativo para Cloud Functions .

Ativar a aplicação do App Check

Quando você entender como o App Check afetará seus usuários e estiver pronto para prosseguir, poderá ativar a aplicação do App Check:

• Ative a aplicação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Ative a aplicação do App Check para Cloud Functions .

Use o App Check em ambientes de depuração

Se, depois de registrar seu aplicativo no App Check, você quiser executá-lo em um ambiente que o App Check normalmente não classificaria como válido, como um emulador durante o desenvolvimento ou a partir de um ambiente de integração contínua (CI), você pode crie uma compilação de depuração de seu aplicativo que use o provedor de depuração do App Check em vez de um provedor de atestado real.

Consulte Use App Check com o provedor de depuração no Android .

Esta página mostra como ativar o App Check em um aplicativo Android, usando o provedor Play Integrity integrado. Ao ativar o App Check, você ajuda a garantir que apenas seu aplicativo possa acessar os recursos do Firebase do seu projeto. Veja uma visão geral deste recurso.

Atualmente, o provedor integrado Play Integrity suporta apenas aplicativos Android distribuídos pelo Google Play. Para usar os recursos fora do Play Integrity ou para usar o App Check com seu próprio provedor personalizado, consulte Implementar um provedor personalizado de App Check .

1. Configure seu projeto do Firebase

1. Adicione o Firebase ao seu projeto Android, caso ainda não o tenha feito.

2. Ative a API Play Integrity:

   1. No Google Play Console , selecione seu aplicativo ou adicione-o, caso ainda não o tenha feito.

   2. Na seção Versão , clique em Configuração > Integridade do aplicativo .

   3. Na página Integrity API , clique em Vincular projeto e selecione seu projeto do Firebase na lista de projetos do Google Cloud.

      O projeto que você selecionar aqui deve ser o mesmo projeto do Firebase em que você registrou seu aplicativo (consulte a próxima etapa).

3. Registre seus aplicativos para usar o App Check com o provedor Play Integrity na seção App Check do Firebase console. Você precisará fornecer a impressão digital SHA-256 do certificado de assinatura do seu aplicativo.

   Normalmente, você precisa registrar todos os aplicativos do seu projeto, porque depois de habilitar a imposição para um produto Firebase, apenas os aplicativos registrados poderão acessar os recursos de back-end do produto.

4. Opcional : nas configurações de registro do aplicativo, defina uma vida útil (TTL) personalizada para tokens do App Check emitidos pelo provedor. Você pode definir o TTL para qualquer valor entre 30 minutos e 7 dias. Ao alterar esse valor, esteja ciente das seguintes compensações:

   • Segurança: TTLs mais curtos fornecem segurança mais forte, porque reduzem a janela na qual um token vazado ou interceptado pode ser abusado por um invasor.
   • Desempenho: TTLs mais curtos significam que seu aplicativo realizará atestados com mais frequência. Como o processo de atestado do aplicativo adiciona latência às solicitações de rede sempre que é executado, um TTL curto pode afetar o desempenho do seu aplicativo.
   • Cota e custo: TTLs mais curtos e reatestações frequentes esgotam sua cota mais rapidamente e, para serviços pagos, podem custar mais. Consulte Cotas e limites .

   O TTL padrão de 1 hora é razoável para a maioria dos aplicativos. Observe que a biblioteca do App Check atualiza os tokens em aproximadamente metade da duração do TTL.

2. Adicione a biblioteca App Check ao seu aplicativo

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

3. Inicialize a verificação do aplicativo

Adicione o seguinte código de inicialização ao seu aplicativo para que ele seja executado antes de usar qualquer outro SDK do Firebase:

FirebaseApp.initializeApp(/*context=*/this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance()
)

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());

Próximos passos

Depois que a biblioteca do App Check estiver instalada em seu aplicativo, comece a distribuir o aplicativo atualizado para seus usuários.

O aplicativo cliente atualizado começará a enviar tokens do App Check junto com todas as solicitações feitas ao Firebase, mas os produtos Firebase não exigirão que os tokens sejam válidos até que você habilite a aplicação na seção App Check do console do Firebase.

Monitore as métricas e habilite a aplicação

Antes de habilitar a imposição, no entanto, certifique-se de que isso não interromperá seus usuários legítimos existentes. Por outro lado, se você perceber o uso suspeito dos recursos do seu aplicativo, convém ativar a aplicação mais cedo.

Para ajudar a tomar essa decisão, você pode consultar as métricas do App Check para os serviços que usa:

• Monitore as métricas de solicitação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Monitore as métricas de solicitação de verificação de aplicativo para Cloud Functions .

Ativar a aplicação do App Check

Quando você entender como o App Check afetará seus usuários e estiver pronto para prosseguir, poderá ativar a aplicação do App Check:

• Ative a aplicação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Ative a aplicação do App Check para Cloud Functions .

Use o App Check em ambientes de depuração

Se, depois de registrar seu aplicativo no App Check, você quiser executá-lo em um ambiente que o App Check normalmente não classificaria como válido, como um emulador durante o desenvolvimento ou a partir de um ambiente de integração contínua (CI), você pode crie uma compilação de depuração de seu aplicativo que use o provedor de depuração do App Check em vez de um provedor de atestado real.

Consulte Use App Check com o provedor de depuração no Android .

Esta página mostra como ativar o App Check em um aplicativo Android, usando o provedor Play Integrity integrado. Ao ativar o App Check, você ajuda a garantir que apenas seu aplicativo possa acessar os recursos do Firebase do seu projeto. Veja uma visão geral deste recurso.

Atualmente, o provedor integrado Play Integrity suporta apenas aplicativos Android distribuídos pelo Google Play. Para usar os recursos fora do Play Integrity ou para usar o App Check com seu próprio provedor personalizado, consulte Implementar um provedor personalizado de App Check .

1. Configure seu projeto do Firebase

1. Adicione o Firebase ao seu projeto Android, caso ainda não o tenha feito.

2. Ative a API Play Integrity:

   1. No Google Play Console , selecione seu aplicativo ou adicione-o, caso ainda não o tenha feito.

   2. Na seção Versão , clique em Configuração > Integridade do aplicativo .

   3. Na página Integrity API , clique em Vincular projeto e selecione seu projeto do Firebase na lista de projetos do Google Cloud.

      O projeto que você selecionar aqui deve ser o mesmo projeto do Firebase em que você registrou seu aplicativo (consulte a próxima etapa).

3. Registre seus aplicativos para usar o App Check com o provedor Play Integrity na seção App Check do Firebase console. Você precisará fornecer a impressão digital SHA-256 do certificado de assinatura do seu aplicativo.

   Normalmente, você precisa registrar todos os aplicativos do seu projeto, porque depois de habilitar a imposição para um produto Firebase, apenas os aplicativos registrados poderão acessar os recursos de back-end do produto.

4. Opcional : nas configurações de registro do aplicativo, defina uma vida útil (TTL) personalizada para tokens do App Check emitidos pelo provedor. Você pode definir o TTL para qualquer valor entre 30 minutos e 7 dias. Ao alterar esse valor, esteja ciente das seguintes compensações:

   • Segurança: TTLs mais curtos fornecem segurança mais forte, porque reduzem a janela na qual um token vazado ou interceptado pode ser abusado por um invasor.
   • Desempenho: TTLs mais curtos significam que seu aplicativo realizará atestados com mais frequência. Como o processo de atestado do aplicativo adiciona latência às solicitações de rede sempre que é executado, um TTL curto pode afetar o desempenho do seu aplicativo.
   • Cota e custo: TTLs mais curtos e reatestações frequentes esgotam sua cota mais rapidamente e, para serviços pagos, podem custar mais. Consulte Cotas e limites .

   O TTL padrão de 1 hora é razoável para a maioria dos aplicativos. Observe que a biblioteca do App Check atualiza os tokens em aproximadamente metade da duração do TTL.

2. Adicione a biblioteca App Check ao seu aplicativo

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:31.2.0')

    // Add the dependency for the App Check library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity'
}

dependencies {
    // Add the dependency for the App Check library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-appcheck-playintegrity:16.1.1'
}

3. Inicialize a verificação do aplicativo

Adicione o seguinte código de inicialização ao seu aplicativo para que ele seja executado antes de usar qualquer outro SDK do Firebase:

FirebaseApp.initializeApp(/*context=*/this)
val firebaseAppCheck = FirebaseAppCheck.getInstance()
firebaseAppCheck.installAppCheckProviderFactory(
    PlayIntegrityAppCheckProviderFactory.getInstance()
)

FirebaseApp.initializeApp(/*context=*/ this);
FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
firebaseAppCheck.installAppCheckProviderFactory(
        PlayIntegrityAppCheckProviderFactory.getInstance());

Próximos passos

Depois que a biblioteca do App Check estiver instalada em seu aplicativo, comece a distribuir o aplicativo atualizado para seus usuários.

O aplicativo cliente atualizado começará a enviar tokens do App Check junto com todas as solicitações feitas ao Firebase, mas os produtos Firebase não exigirão que os tokens sejam válidos até que você habilite a aplicação na seção App Check do console do Firebase.

Monitore as métricas e habilite a aplicação

Antes de habilitar a imposição, no entanto, certifique-se de que isso não interromperá seus usuários legítimos existentes. Por outro lado, se você perceber o uso suspeito dos recursos do seu aplicativo, convém ativar a aplicação mais cedo.

Para ajudar a tomar essa decisão, você pode consultar as métricas do App Check para os serviços que usa:

• Monitore as métricas de solicitação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Monitore as métricas de solicitação de verificação de aplicativo para Cloud Functions .

Ativar a aplicação do App Check

Quando você entender como o App Check afetará seus usuários e estiver pronto para prosseguir, poderá ativar a aplicação do App Check:

• Ative a aplicação do App Check para Realtime Database, Cloud Firestore e Cloud Storage.
• Ative a aplicação do App Check para Cloud Functions .

Use o App Check em ambientes de depuração

Se, depois de registrar seu aplicativo no App Check, você quiser executá-lo em um ambiente que o App Check normalmente não classificaria como válido, como um emulador durante o desenvolvimento ou a partir de um ambiente de integração contínua (CI), você pode crie uma compilação de depuração de seu aplicativo que use o provedor de depuração do App Check em vez de um provedor de atestado real.

Consulte Use App Check com o provedor de depuração no Android .