Validar callbacks de verificação do lado do servidor (SSV, na sigla em inglês)

Os callbacks de verificação no lado do servidor são solicitações de URL com parâmetros de consulta expandidos pelo Google. Eles são enviados pelo Google a um sistema externo para notificar que um usuário precisa ser recompensado por interagir com um anúncio intersticial premiado ou com recompensa. Os callbacks de SSV (verificação do lado do servidor) premiados oferecem uma camada extra de proteção contra falsificação de callbacks do lado do cliente para recompensar os usuários.

Este guia mostra como verificar callbacks de SSV premiados usando a biblioteca criptográfica de terceiros Tink Java Apps para garantir que os parâmetros de consulta no callback sejam valores legítimos. Embora a Tink seja usada para os fins deste guia, você pode usar qualquer biblioteca de terceiros que ofereça suporte a ECDSA. Você também pode testar seu servidor com a ferramenta de teste na interface da AdMob.

Confira o Exemplo de SSV premiada usando Java spring-boot.

Pré-requisitos

• Ative a verificação de recompensa do lado do servidor no seu bloco de anúncios.

Usar o RewardedAdsVerifier da biblioteca Tink Java Apps

O repositório do GitHub Tink Java Apps inclui uma classe auxiliar RewardedAdsVerifier para reduzir o código necessário para verificar um callback de SSV premiado. Usar essa classe permite verificar um URL de callback com o seguinte código.

RewardedAdsVerifier verifier = new RewardedAdsVerifier.Builder()
    .fetchVerifyingPublicKeysWith(
        RewardedAdsVerifier.KEYS_DOWNLOADER_INSTANCE_PROD)
    .build();
String rewardUrl = ...;
verifier.verify(rewardUrl);

Se o método verify() for executado sem gerar uma exceção, o URL de callback terá sido verificado. A seção Recompensar o usuário detalha as práticas recomendadas sobre quando os usuários devem ser recompensados. Para conferir um detalhamento das etapas realizadas por essa classe para verificar callbacks de SSV premiados, leia a seção Verificação manual de SSV premiados.

Parâmetros de callback SSV

Os callbacks de verificação no lado do servidor contêm parâmetros de consulta que descrevem a interação com o anúncio premiado. Os nomes, as descrições e os valores de exemplo dos parâmetros estão listados abaixo. Os parâmetros são enviados em ordem alfabética.

Identificadores de origem do anúncio

Recompensar o usuário

É importante equilibrar a experiência do usuário e a validação da recompensa ao decidir quando recompensar um usuário. Os callbacks do lado do servidor podem sofrer atrasos antes de chegar a sistemas externos. Portanto, a prática recomendada é usar o callback do lado do cliente para recompensar o usuário imediatamente, enquanto realiza a validação de todas as recompensas após o recebimento dos callbacks do lado do servidor. Essa abordagem oferece uma boa experiência do usuário e garante a validade das recompensas concedidas.

No entanto, para aplicativos em que a validade da recompensa é essencial (por exemplo, a recompensa afeta a economia no jogo do app) e atrasos na concessão de recompensas são aceitáveis, aguardar o callback verificado do lado do servidor pode ser a melhor abordagem.

Dados personalizados

Os apps que exigem dados extras em callbacks de verificação do lado do servidor precisam usar o recurso de dados personalizados dos anúncios premiados. Qualquer valor de string definido em um objeto de anúncio premiado é transmitido ao parâmetro de consulta custom_data do callback da SSV. Se nenhum valor de dados personalizado for definido, o valor do parâmetro de consulta custom_data não estará presente no callback da SSV.

O exemplo a seguir define as opções de SSV depois que o anúncio premiado é carregado:

RewardedAd.load(MainActivity.this, "AD_UNIT_ID",
    new AdRequest.Builder().build(),  new RewardedAdLoadCallback() {
  @Override
  public void onAdLoaded(RewardedAd ad) {
    Log.d(TAG, "Ad was loaded.");
    rewardedAd = ad;
    ServerSideVerificationOptions options = new ServerSideVerificationOptions
        .Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build();
    rewardedAd.setServerSideVerificationOptions(options);
  }
  @Override
  public void onAdFailedToLoad(LoadAdError loadAdError) {
    Log.d(TAG, loadAdError.toString());
    rewardedAd = null;
  }
});

RewardedAd.load(this, "AD_UNIT_ID",
    AdRequest.Builder().build(), object : RewardedAdLoadCallback() {
  override fun onAdLoaded(ad: RewardedAd) {
    Log.d(TAG, "Ad was loaded.")
    rewardedInterstitialAd = ad
    val options = ServerSideVerificationOptions.Builder()
        .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
        .build()
    rewardedAd.setServerSideVerificationOptions(options)
  }

  override fun onAdFailedToLoad(adError: LoadAdError) {
    Log.d(TAG, adError?.toString())
    rewardedAd = null
  }
})

Se quiser definir a string de recompensa personalizada, faça isso antes de mostrar o anúncio.

Verificação manual da SSV premiada

As etapas realizadas pela classe RewardedAdsVerifier para verificar uma SSV premiada estão descritas abaixo. Embora os snippets de código incluídos estejam em Java e usem a biblioteca de terceiros Tink, essas etapas podem ser implementadas por você na linguagem de sua escolha, usando qualquer biblioteca de terceiros que ofereça suporte a ECDSA.

Buscar chaves públicas

Para verificar um callback de SSV premiado, você precisa de uma chave pública fornecida pela AdMob.

Uma lista de chaves públicas usadas para validar os callbacks de SSV premiados pode ser buscada no servidor de chaves da AdMob. A lista de chaves públicas é fornecida como uma representação JSON com um formato semelhante a este:

{
 "keys": [
    {
      keyId: 1916455855,
      pem: "-----BEGIN PUBLIC KEY-----\nMF...YTPcw==\n-----END PUBLIC KEY-----"
      base64: "MFkwEwYHKoZIzj0CAQYI...ltS4nzc9yjmhgVQOlmSS6unqvN9t8sqajRTPcw=="
    },
    {
      keyId: 3901585526,
      pem: "-----BEGIN PUBLIC KEY-----\nMF...aDUsw==\n-----END PUBLIC KEY-----"
      base64: "MFYwEAYHKoZIzj0CAQYF...4akdWbWDCUrMMGIV27/3/e7UuKSEonjGvaDUsw=="
    },
  ],
}

Para recuperar as chaves públicas, conecte-se ao servidor de chaves da AdMob e faça o download delas. O código a seguir realiza essa tarefa e salva a representação JSON das chaves na variável data.

String url = ...;
NetHttpTransport httpTransport = new NetHttpTransport.Builder().build();
HttpRequest httpRequest =
    httpTransport.createRequestFactory().buildGetRequest(new GenericUrl(url));
HttpResponse httpResponse = httpRequest.execute();
if (httpResponse.getStatusCode() != HttpStatusCodes.STATUS_CODE_OK) {
  throw new IOException("Unexpected status code = " + httpResponse.getStatusCode());
}
String data;
InputStream contentStream = httpResponse.getContent();
try {
  InputStreamReader reader = new InputStreamReader(contentStream, UTF_8);
  data = readerToString(reader);
} finally {
  contentStream.close();
}

As chaves públicas são trocadas regularmente. Você vai receber um e-mail informando sobre uma rotação futura. Se você estiver armazenando chaves públicas em cache, atualize-as ao receber este e-mail.

Depois que as chaves públicas são buscadas, elas precisam ser analisadas. O método parsePublicKeysJson abaixo usa uma string JSON, como o exemplo acima, como entrada e cria um mapeamento de valores key_id para chaves públicas, que são encapsuladas como objetos ECPublicKey da biblioteca Tink.

private static Map<Integer, ECPublicKey> parsePublicKeysJson(String publicKeysJson)
    throws GeneralSecurityException {
  Map<Integer, ECPublicKey> publicKeys = new HashMap<>();
  try {
    JSONArray keys = new JSONObject(publicKeysJson).getJSONArray("keys");
    for (int i = 0; i < keys.length(); i++) {
      JSONObject key = keys.getJSONObject(i);
      publicKeys.put(
          key.getInt("keyId"),
          EllipticCurves.getEcPublicKey(Base64.decode(key.getString("base64"))));
    }
  } catch (JSONException e) {
    throw new GeneralSecurityException("failed to extract trusted signing public keys", e);
  }
  if (publicKeys.isEmpty()) {
    throw new GeneralSecurityException("No trusted keys are available.");
  }
  return publicKeys;
}

Receber conteúdo para verificação

Os dois últimos parâmetros de consulta dos callbacks de SSV premiados são sempre signature e key_id, nessa ordem. Os parâmetros de consulta restantes especificam o conteúdo a ser verificado. Vamos supor que você configurou a AdMob para enviar callbacks de recompensa para https://www.myserver.com/mypath. O snippet abaixo mostra um exemplo de retorno de chamada de SSV premiado com o conteúdo a ser verificado destacado.

https://www.myserver.com/path?ad_network=54...55&ad_unit=12345678&reward_amount=10&reward_item=coins
&timestamp=150777823&transaction_id=12...DEF&user_id=1234567&signature=ME...Z1c&key_id=1268887

O código abaixo demonstra como analisar o conteúdo a ser verificado de um URL de callback como uma matriz de bytes UTF-8.

public static final String SIGNATURE_PARAM_NAME = "signature=";
...
URI uri;
try {
  uri = new URI(rewardUrl);
} catch (URISyntaxException ex) {
  throw new GeneralSecurityException(ex);
}
String queryString = uri.getQuery();
int i = queryString.indexOf(SIGNATURE_PARAM_NAME);
if (i == -1) {
  throw new GeneralSecurityException("needs a signature query parameter");
}
byte[] queryParamContentData =
    queryString
        .substring(0, i - 1)
        // i - 1 instead of i because of & in the query string
        .getBytes(Charset.forName("UTF-8"));

Receber assinatura e key_id do URL de callback

Usando o valor queryString da etapa anterior, analise os parâmetros de consulta signature e key_id do URL de retorno de chamada, conforme mostrado abaixo:

public static final String KEY_ID_PARAM_NAME = "key_id=";
...
String sigAndKeyId = queryString.substring(i);
i = sigAndKeyId.indexOf(KEY_ID_PARAM_NAME);
if (i == -1) {
  throw new GeneralSecurityException("needs a key_id query parameter");
}
String sig =
    sigAndKeyId.substring(
        SIGNATURE_PARAM_NAME.length(), i - 1 /* i - 1 instead of i because of & */);
int keyId = Integer.valueOf(sigAndKeyId.substring(i + KEY_ID_PARAM_NAME.length()));

Realizar verificação

A etapa final é verificar o conteúdo do URL de callback com a chave pública apropriada. Use o mapeamento retornado do método parsePublicKeysJson e o parâmetro key_id do URL de callback para receber a chave pública desse mapeamento. Em seguida, verifique a assinatura com essa chave pública. Essas etapas são demonstradas abaixo no método verify.

private void verify(final byte[] dataToVerify, int keyId, final byte[] signature)
    throws GeneralSecurityException {
  Map<Integer, ECPublicKey> publicKeys = parsePublicKeysJson();
  if (publicKeys.containsKey(keyId)) {
    foundKeyId = true;
    ECPublicKey publicKey = publicKeys.get(keyId);
    EcdsaVerifyJce verifier = new EcdsaVerifyJce(publicKey, HashType.SHA256, EcdsaEncoding.DER);
    verifier.verify(signature, dataToVerify);
  } else {
    throw new GeneralSecurityException("cannot find verifying key with key ID: " + keyId);
  }
}

Se o método for executado sem gerar uma exceção, o URL de callback terá sido verificado com sucesso.

Perguntas frequentes

Posso armazenar em cache a chave pública fornecida pelo servidor de chaves da AdMob?

Recomendamos armazenar em cache a chave pública fornecida pelo servidor de chaves da AdMob para reduzir o número de operações necessárias para validar os callbacks de SSV. No entanto, as chaves públicas são rotacionadas regularmente e não devem ser armazenadas em cache por mais de 24 horas.

Com que frequência as chaves públicas fornecidas pelo servidor de chaves da AdMob são trocadas?

As chaves públicas fornecidas pelo servidor de chaves da AdMob são alternadas em uma programação variável. Para garantir que a verificação dos callbacks de SSV continue funcionando conforme o esperado, as chaves públicas não podem ser armazenadas em cache por mais de 24 horas.

O que acontece se não for possível acessar meu servidor?

O Google espera um código de resposta de status de sucesso HTTP 200 OK para callbacks de SSV. Se o servidor não puder ser acessado ou não fornecer a resposta esperada, o Google vai tentar enviar callbacks de SSV até cinco vezes em intervalos de um segundo.

Como posso verificar se os callbacks da SSV vêm do Google?

Use a busca DNS reversa para verificar se os callbacks de SSV são originados do Google.