Vereditos de integridade

Esta página descreve como interpretar e trabalhar com o veredito de integridade retornado. Se você fizer uma solicitação de API padrão ou clássica, o veredito de integridade será retornado no mesmo formato com conteúdo semelhante. O veredito de integridade comunica informações sobre a validade de dispositivos, apps e contas. O servidor do app pode usar o payload resultante em um veredito descriptografado e verificado para determinar a melhor forma de prosseguir com uma ação ou solicitação específica no app.

Formato de veredito de integridade retornado

O payload é JSON em texto simples e contém sinais de integridade e informações fornecidas pelo desenvolvedor.

A estrutura geral do payload é esta:

{
  requestDetails: { ... }
  appIntegrity: { ... }
  deviceIntegrity: { ... }
  accountDetails: { ... }
  environmentDetails: { ... }
}

Primeiro, confira se os valores no campo requestDetails correspondem aos da solicitação original antes de verificar cada veredito de integridade. As seções abaixo descrevem cada campo em mais detalhes.

Campo de detalhes da solicitação

O campo requestDetails contém informações sobre a solicitação, incluindo informações fornecidas pelo desenvolvedor no requestHash para solicitações padrão e no nonce para solicitações clássicas.

Para solicitações de API padrão:

requestDetails: {
  // Application package name this attestation was requested for.
  // Note that this field might be spoofed in the middle of the request.
  requestPackageName: "com.package.name"
  // Request hash provided by the developer.
  requestHash: "aGVsbG8gd29scmQgdGhlcmU"
  // The timestamp in milliseconds when the integrity token
  // was requested.
  timestampMillis: "1675655009345"
}

Esses valores precisam corresponder aos da solicitação original. Verifique a parte requestDetails do payload JSON, garantindo que o requestPackageName e o requestHash correspondam ao que foi enviado na solicitação original, conforme mostrado no snippet de código abaixo:

val requestDetails = JSONObject(payload).getJSONObject("requestDetails")
val requestPackageName = requestDetails.getString("requestPackageName")
val requestHash = requestDetails.getString("requestHash")
val timestampMillis = requestDetails.getLong("timestampMillis")
val currentTimestampMillis = ...

// Ensure the token is from your app.
if (!requestPackageName.equals(expectedPackageName)
        // Ensure the token is for this specific request
    || !requestHash.equals(expectedRequestHash)
        // Ensure the freshness of the token.
    || currentTimestampMillis - timestampMillis > ALLOWED_WINDOW_MILLIS) {
        // The token is invalid! See below for further checks.
        ...
}

RequestDetails requestDetails =
    decodeIntegrityTokenResponse
    .getTokenPayloadExternal()
    .getRequestDetails();
String requestPackageName = requestDetails.getRequestPackageName();
String requestHash = requestDetails.getRequestHash();
long timestampMillis = requestDetails.getTimestampMillis();
long currentTimestampMillis = ...;

// Ensure the token is from your app.
if (!requestPackageName.equals(expectedPackageName)
        // Ensure the token is for this specific request.
    || !requestHash.equals(expectedRequestHash)
        // Ensure the freshness of the token.
    || currentTimestampMillis - timestampMillis > ALLOWED_WINDOW_MILLIS) {
        // The token is invalid! See below for further checks.
        ...
}

Para solicitações de API clássicas:

requestDetails: {
  // Application package name this attestation was requested for.
  // Note that this field might be spoofed in the middle of the
  // request.
  requestPackageName: "com.package.name"
  // base64-encoded URL-safe no-wrap nonce provided by the developer.
  nonce: "aGVsbG8gd29scmQgdGhlcmU"
  // The timestamp in milliseconds when the request was made
  // (computed on the server).
  timestampMillis: "1617893780"
}

Esses valores precisam corresponder aos da solicitação original. Portanto, verifique a parte requestDetails do payload JSON, garantindo que requestPackageName e nonce correspondam ao que foi enviado na solicitação original, conforme mostrado no snippet de código abaixo:

val requestDetails = JSONObject(payload).getJSONObject("requestDetails")
val requestPackageName = requestDetails.getString("requestPackageName")
val nonce = requestDetails.getString("nonce")
val timestampMillis = requestDetails.getLong("timestampMillis")
val currentTimestampMillis = ...

// Ensure the token is from your app.
if (!requestPackageName.equals(expectedPackageName)
        // Ensure the token is for this specific request. See 'Generate a nonce'
        // section of the doc on how to store/compute the expected nonce.
    || !nonce.equals(expectedNonce)
        // Ensure the freshness of the token.
    || currentTimestampMillis - timestampMillis > ALLOWED_WINDOW_MILLIS) {
        // The token is invalid! See below for further checks.
        ...
}

JSONObject requestDetails =
    new JSONObject(payload).getJSONObject("requestDetails");
String requestPackageName = requestDetails.getString("requestPackageName");
String nonce = requestDetails.getString("nonce");
long timestampMillis = requestDetails.getLong("timestampMillis");
long currentTimestampMillis = ...;

// Ensure the token is from your app.
if (!requestPackageName.equals(expectedPackageName)
        // Ensure the token is for this specific request. See 'Generate a nonce'
        // section of the doc on how to store/compute the expected nonce.
    || !nonce.equals(expectedNonce)
        // Ensure the freshness of the token.
    || currentTimestampMillis - timestampMillis > ALLOWED_WINDOW_MILLIS) {
        // The token is invalid! See below for further checks.
        ...
}

Campo de integridade do aplicativo

O campo appIntegrity contém informações relacionadas ao pacote.

appIntegrity: {
  // PLAY_RECOGNIZED, UNRECOGNIZED_VERSION, or UNEVALUATED.
  appRecognitionVerdict: "PLAY_RECOGNIZED"
  // The package name of the app.
  // This field is populated iff appRecognitionVerdict != UNEVALUATED.
  packageName: "com.package.name"
  // The sha256 digest of app certificates (base64-encoded URL-safe).
  // This field is populated iff appRecognitionVerdict != UNEVALUATED.
  certificateSha256Digest: ["6a6a1474b5cbbb2b1aa57e0bc3"]
  // The version of the app.
  // This field is populated iff appRecognitionVerdict != UNEVALUATED.
  versionCode: "42"
}

appRecognitionVerdict pode ter estes valores:

PLAY_RECOGNIZED

O app e o certificado correspondem às versões distribuídas pelo Google Play.

UNRECOGNIZED_VERSION

O nome do certificado ou do pacote não corresponde aos registros do Google Play.

UNEVALUATED

A integridade do aplicativo não foi avaliada. Um requisito necessário está ausente, por exemplo, o dispositivo não é confiável o suficiente.

Para garantir que o token tenha sido gerado por um app criado por você, confira se a integridade do aplicativo está de acordo com o esperado, conforme mostrado no snippet de código abaixo:

val appIntegrity = JSONObject(payload).getJSONObject("appIntegrity")
val appRecognitionVerdict = appIntegrity.getString("appRecognitionVerdict")

if (appRecognitionVerdict == "PLAY_RECOGNIZED") {
    // Looks good!
}

JSONObject appIntegrity =
    new JSONObject(payload).getJSONObject("appIntegrity");
String appRecognitionVerdict =
    appIntegrity.getString("appRecognitionVerdict");

if (appRecognitionVerdict.equals("PLAY_RECOGNIZED")) {
    // Looks good!
}

Também é possível conferir manualmente o nome do pacote, a versão e os certificados do app.

Campo de integridade do dispositivo

O campo deviceIntegrity pode conter um único valor, deviceRecognitionVerdict, que tem um ou mais identificadores que representam a capacidade de um dispositivo de garantir a integridade do app. Se um dispositivo não atender aos critérios de algum identificador, o campo deviceIntegrity vai ficar vazio.

deviceIntegrity: {
  // "MEETS_DEVICE_INTEGRITY" is one of several possible values.
  deviceRecognitionVerdict: ["MEETS_DEVICE_INTEGRITY"]
}

Por padrão, deviceRecognitionVerdict pode conter o seguinte:

MEETS_DEVICE_INTEGRITY

O app está em execução em um dispositivo Android com o Google Play Services. O dispositivo é aprovado nas verificações de integridade do sistema e atende aos requisitos de compatibilidade do Android.

Vazio (um valor em branco)

O app está sendo executado em um dispositivo que tem sinais de ataque, como hooks de API, ou comprometimentos do sistema, como acesso root. Ou, então, o app não está sendo executado em um dispositivo físico, mas sim, por exemplo, em um emulador que falha nas verificações de integridade do Google Play.

Para garantir que o token veio de um dispositivo confiável, verifique se o deviceRecognitionVerdict está de acordo com o esperado, conforme mostrado no snippet de código abaixo:

val deviceIntegrity =
    JSONObject(payload).getJSONObject("deviceIntegrity")
val deviceRecognitionVerdict =
    if (deviceIntegrity.has("deviceRecognitionVerdict")) {
        deviceIntegrity.getJSONArray("deviceRecognitionVerdict").toString()
    } else {
        ""
    }

if (deviceRecognitionVerdict.contains("MEETS_DEVICE_INTEGRITY")) {
    // Looks good!
}

JSONObject deviceIntegrity =
    new JSONObject(payload).getJSONObject("deviceIntegrity");
String deviceRecognitionVerdict =
    deviceIntegrity.has("deviceRecognitionVerdict")
    ? deviceIntegrity.getJSONArray("deviceRecognitionVerdict").toString()
    : "";

if (deviceRecognitionVerdict.contains("MEETS_DEVICE_INTEGRITY")) {
    // Looks good!
}

Se você tiver problemas em atender aos requisitos de integridade com o dispositivo de teste, confira se a ROM de fábrica está instalada, por exemplo, redefinindo o dispositivo para as configurações originais, e se o carregador de inicialização está bloqueado. Você também pode criar testes da Play Integrity no Play Console.

Identificadores de dispositivos condicionais

Se o app estiver sendo lançado no Google Play Games para PC, o deviceRecognitionVerdict também pode conter o seguinte identificador:

MEETS_VIRTUAL_INTEGRITY

O app está em execução em um dispositivo Android com o Google Play Services. O emulador foi aprovado nas verificações de integridade do sistema e atende aos principais requisitos de compatibilidade do Android.

Informações opcionais do dispositivo

Se você aceitar receber outros identificadores no veredito de integridade, o campo deviceRecognitionVerdict poderá ter os indicadores abaixo:

MEETS_BASIC_INTEGRITY

O app está sendo executado em um dispositivo que é aprovado nas verificações básicas de integridade do sistema. O dispositivo pode não atender aos requisitos de compatibilidade do Android e não ser aprovado para executar o Google Play Services. Por exemplo, o dispositivo pode estar executando uma versão não reconhecida do Android, ter um carregador de inicialização desbloqueado ou não ter sido certificado pelo fabricante.

MEETS_STRONG_INTEGRITY

O app está sendo executado em um dispositivo Android com o Google Play Services e tem uma forte garantia de integridade do sistema, como uma prova de integridade da inicialização protegida por hardware. O dispositivo é aprovado nas verificações de integridade do sistema e atende aos requisitos de compatibilidade do Android.

Um único dispositivo vai retornar vários identificadores de dispositivo no veredito de integridade se cada um dos critérios do identificador for atendido.

Atividade recente do dispositivo

Você também pode ativar a atividade recente do dispositivo, que informa quantas vezes seu app solicitou um token de integridade em um dispositivo específico na última hora. É possível usar a atividade recente do dispositivo para proteger seu app contra dispositivos hiperativos inesperados que podem indicar um ataque ativo. Também é possível decidir o quanto confiar em cada nível de atividade recente do dispositivo com base em quantas vezes você espera que o app instalado em um dispositivo comum solicite um token de integridade a cada hora.

Se você ativar o recebimento de recentDeviceActivity, o campo deviceIntegrity terá dois valores:

deviceIntegrity: {
  deviceRecognitionVerdict: ["MEETS_DEVICE_INTEGRITY"]
  recentDeviceActivity: {
    // "LEVEL_2" is one of several possible values.
    deviceActivityLevel: "LEVEL_2"
  }
}

As definições de deviceActivityLevel são diferentes entre os modos e podem ter um dos seguintes valores:

Atributos do dispositivo

Você também pode ativar os atributos do dispositivo, que informam a versão do SDK do Android do SO Android em execução no dispositivo. No futuro, ele poderá ser estendido com outros atributos de dispositivo.

O valor da versão do SDK é o número da versão do SDK do Android definido em Build.VERSION_CODES. A versão do SDK não é avaliada se um requisito necessário estiver ausente. Nesse caso, o campo sdkVersion não está definido. Portanto, o campo deviceAttributes está vazio. Isso pode acontecer porque:

• O dispositivo não é confiável o suficiente.
• A versão do app instalada no dispositivo é desconhecida para o Google Play.
• Houve problemas técnicos no dispositivo.

Se você ativar o recebimento de deviceAttributes, o campo deviceIntegrity terá o seguinte campo extra:

deviceIntegrity: {
  deviceRecognitionVerdict: ["MEETS_DEVICE_INTEGRITY"]
  deviceAttributes: {
    // 33 is one possible value, which represents Android 13 (Tiramisu).
    sdkVersion: 33
  }
}

Caso a versão do SDK não seja avaliada, o campo deviceAttributes será definido da seguinte maneira:

deviceIntegrity: {
  deviceRecognitionVerdict: ["MEETS_DEVICE_INTEGRITY"]
  deviceAttributes: {}  // sdkVersion field is not set.
}

Campo de detalhes da conta

O campo accountDetails contém um único valor, appLicensingVerdict, que representa o status de licenciamento do app no Google Play para a conta de usuário que está conectada no dispositivo. Se a conta de usuário tiver a licença do Play para o app, significa que ele foi transferido por download ou comprado no Google Play.

accountDetails: {
  // This field can be LICENSED, UNLICENSED, or UNEVALUATED.
  appLicensingVerdict: "LICENSED"
}

O appLicensingVerdict pode ter um destes valores:

LICENSED

O usuário tem direito de acesso ao app. Em outras palavras, o usuário instalou ou atualizou o app no Google Play no dispositivo.

UNLICENSED

O usuário não tem a titularidade do app. Isso acontece quando, por exemplo, o usuário transfere o app por sideload ou não o adquire pelo Google Play. Você pode mostrar a caixa de diálogo GET_LICENSED aos usuários para resolver isso.

UNEVALUATED

Os detalhes de licenciamento não foram avaliados porque um requisito necessário está ausente.

Isso pode acontecer por vários motivos, incluindo:

• O dispositivo não é confiável o suficiente.
• A versão do app instalada no dispositivo não é reconhecida pelo Google Play.
• O usuário não está conectado ao Google Play.

Para conferir se o usuário tem direito de acesso ao app, confira se o appLicensingVerdict está de acordo com o esperado, conforme mostrado no snippet de código abaixo.

val accountDetails = JSONObject(payload).getJSONObject("accountDetails")
val appLicensingVerdict = accountDetails.getString("appLicensingVerdict")

if (appLicensingVerdict == "LICENSED") {
    // Looks good!
}

JSONObject accountDetails =
    new JSONObject(payload).getJSONObject("accountDetails");
String appLicensingVerdict = accountDetails.getString("appLicensingVerdict");

if (appLicensingVerdict.equals("LICENSED")) {
    // Looks good!
}

Campo de detalhes do ambiente

Você também pode ativar outros indicadores sobre o ambiente. O risco de acesso ao app informa se há outros apps em execução que podem ser usados para capturar a tela, mostrar sobreposições ou controlar o dispositivo. O veredito do Play Protect informa se o Google Play Protect está ativado no dispositivo e se ele encontrou malware conhecido.

Se você tiver ativado o veredito de indicador de risco de acesso a apps ou o veredito do Play Protect no Google Play Console, a resposta da API vai incluir o campo environmentDetails. O campo environmentDetails pode conter dois valores, appAccessRiskVerdict e playProtectVerdict.

Veredito de risco de acesso ao app

Depois da ativação, o campo environmentDetails no payload da API Play Integrity vai conter o novo veredito do indicador de risco de acesso a apps.

{
  requestDetails: { ... }
  appIntegrity: { ... }
  deviceIntegrity: { ... }
  accountDetails: { ... }
  environmentDetails: {
      appAccessRiskVerdict: {
          // This field contains one or more responses, for example the following.
          appsDetected: ["KNOWN_INSTALLED", "UNKNOWN_INSTALLED", "UNKNOWN_CAPTURING"]
      }
 }
}

Se o risco de acesso a apps foi avaliado, appAccessRiskVerdict contém o campo appsDetected com uma ou mais respostas. Essas respostas se enquadram em um dos dois grupos a seguir, dependendo da origem de instalação dos apps detectados:

• Apps do sistema ou do Google Play: apps instalados pelo Google Play ou pré-carregados pelo fabricante do dispositivo na partição do sistema (identificados com FLAG_SYSTEM). As respostas para esses apps têm o prefixo KNOWN_.

• Outros apps: são apps que não são instalados pelo Google Play. Isso exclui apps pré-carregados na partição do sistema pelo fabricante do dispositivo. As respostas para esses apps têm o prefixo UNKNOWN_.

As seguintes respostas podem ser retornadas:

KNOWN_INSTALLED, UNKNOWN_INSTALLED

Alguns apps instalados correspondem à origem de instalação correspondente.

KNOWN_CAPTURING, UNKNOWN_CAPTURING

Há apps em execução com permissões ativadas que podem ser usadas para visualizar a tela enquanto o app está em execução. Isso exclui todos os serviços de acessibilidade verificados conhecidos pelo Google Play em execução no dispositivo.

KNOWN_CONTROLLING, UNKNOWN_CONTROLLING

Há apps em execução com permissões ativadas que podem ser usadas para controlar o dispositivo e controlar diretamente as entradas feitas no seu app para capturar entradas e saídas do app. Isso exclui qualquer serviço de acessibilidade verificado conhecido pelo Google Play em execução no dispositivo.

KNOWN_OVERLAYS, UNKNOWN_OVERLAYS

Há apps em execução com permissões ativadas que podem ser usadas para mostrar sobreposições no seu app. Isso exclui qualquer serviço de acessibilidade verificado conhecido pelo Google Play em execução no dispositivo.

Vazio (um valor em branco)

O indicador de risco de acesso a apps não é avaliado se um requisito necessário estiver ausente. Nesse caso, o campo appAccessRiskVerdict está vazio. Isso pode acontecer por vários motivos, incluindo:

• O dispositivo não é confiável o suficiente.
• O formato do dispositivo não é um smartphone, tablet ou dobrável.
• O dispositivo não está executando o Android 6 (nível 23 da API) ou mais recente.
• A versão do app instalada no dispositivo é desconhecida para o Google Play.
• A versão da Google Play Store no dispositivo está desatualizada.
• Somente para jogos: a conta de usuário não tem uma licença do Google Play para o jogo.
• Uma solicitação padrão foi usada com o parâmetro verdictOptOut.
• Uma solicitação padrão foi usada com uma versão da biblioteca da API Play Integrity que ainda não oferece suporte ao indicador de risco de acesso a apps para solicitações padrão.

O risco de acesso a apps exclui automaticamente os serviços de acessibilidade verificados que passaram por uma análise aprimorada de acessibilidade do Google Play (instalada por qualquer app store no dispositivo). "Excluído" significa que os serviços de acessibilidade verificados em execução no dispositivo não vão gerar uma resposta de captura, controle ou sobreposição no veredito de risco de acesso a apps. Para solicitar uma análise aprimorada de acessibilidade do Google Play para seu app de acessibilidade, publique-o no Google Play, garantindo que a flag isAccessibilityTool esteja definida como "true" no manifesto do app, ou solicite uma análise.

A tabela a seguir mostra alguns exemplos de vereditos e o que eles significam. Ela não lista todos os resultados possíveis:

Dependendo do seu nível de risco, é possível decidir qual combinação de vereditos é aceitável para prosseguir e para quais vereditos você quer tomar medidas. O snippet de código abaixo ilustra um exemplo de verificação de que não há apps em execução que possam capturar a tela ou controlar seu app:

val environmentDetails =
    JSONObject(payload).getJSONObject("environmentDetails")
val appAccessRiskVerdict =
    environmentDetails.getJSONObject("appAccessRiskVerdict")

if (appAccessRiskVerdict.has("appsDetected")) {
    val appsDetected = appAccessRiskVerdict.getJSONArray("appsDetected").toString()
    if (!appsDetected.contains("CAPTURING") && !appsDetected.contains("CONTROLLING")) {
        // Looks good!
    }
}

JSONObject environmentDetails =
    new JSONObject(payload).getJSONObject("environmentDetails");
JSONObject appAccessRiskVerdict =
    environmentDetails.getJSONObject("appAccessRiskVerdict");

if (appAccessRiskVerdict.has("appsDetected")) {
    String appsDetected = appAccessRiskVerdict.getJSONArray("appsDetected").toString()
    if (!appsDetected.contains("CAPTURING") && !appsDetected.contains("CONTROLLING")) {
        // Looks good!
    }
}

Corrigir os vereditos de risco de acesso a apps

Dependendo do seu nível de risco, é possível decidir para quais vereditos de risco de acesso a apps você quer tomar medidas antes de permitir que o usuário conclua uma solicitação ou ação. Há solicitações opcionais do Google Play que podem ser mostradas ao usuário depois de verificar o veredito do risco de acesso ao app. Você pode mostrar CLOSE_UNKNOWN_ACCESS_RISK para pedir que o usuário feche apps desconhecidos que estão causando o veredito de risco de acesso ao app ou mostrar CLOSE_ALL_ACCESS_RISK para pedir que o usuário feche todos os apps (conhecidos e desconhecidos) que estão causando o veredito de risco de acesso ao app.

Veredito do Play Protect

Depois da ativação, o campo environmentDetails no payload da API Play Integrity vai conter o veredito do Play Protect:

environmentDetails: {
  playProtectVerdict: "NO_ISSUES"
}

O playProtectVerdict pode ter um destes valores:

NO_ISSUES

O Play Protect está ativado e não encontrou problemas de apps no dispositivo.

NO_DATA

O Play Protect está ativado, mas nenhuma verificação foi realizada ainda. O dispositivo ou o app Play Store pode ter sido redefinido recentemente.

POSSIBLE_RISK

O Play Protect está desativado.

MEDIUM_RISK

O Play Protect está ativado e encontrou apps potencialmente nocivos instalados no dispositivo.

HIGH_RISK

O Play Protect está ativado e encontrou apps perigosos instalados no dispositivo.

UNEVALUATED

O veredito do Play Protect não foi avaliado.

Isso pode acontecer por vários motivos, incluindo:

• O dispositivo não é confiável o suficiente.
• Somente para jogos: a conta de usuário não tem uma licença do Google Play para o jogo.

Orientações sobre como usar o veredito do Play Protect

O servidor de back-end do app pode decidir o que fazer com base no veredito considerando sua tolerância a riscos. Aqui estão algumas sugestões e possíveis ações do usuário:

NO_ISSUES

O Play Protect está ativado e não encontrou problemas. Por isso, nenhuma ação do usuário é necessária.

POSSIBLE_RISK e NO_DATA

Ao receber esses vereditos, peça ao usuário para conferir se o Play Protect está ativado e se realizou uma verificação. NO_DATA pode aparecer apenas em raras circunstâncias.

MEDIUM_RISK e HIGH_RISK

Dependendo da sua tolerância a riscos, você pode pedir que o usuário abra o Play Protect e tome medidas em relação aos avisos mostrados. Se o usuário não conseguir cumprir esses requisitos, você poderá bloqueá-lo da ação do servidor.