Verifica lato server

I callback di verifica lato server sono richieste di URL, con parametri di query espansi da Google, che vengono inviati da Google a un sistema esterno per comunicare che un utente deve ricevere un premio per aver interagito con un annuncio con premio o annuncio interstitial con premio. I callback di verifica lato server (SSV) con premio forniscono un ulteriore livello di protezione contro lo spoofing dei callback lato client per premiare gli utenti.

Questa guida mostra come verificare i callback SSV con premio utilizzando la libreria di crittografia di terze parti Tink Java Apps per assicurarti che i parametri di query nel callback siano valori legittimi. Anche se in questa guida viene utilizzato Tink, puoi utilizzare qualsiasi libreria di terze parti che supporti ECDSA. Puoi anche testare il tuo server con lo strumento di test nell'interfaccia utente di AdMob.

Prerequisiti

• Attiva la verifica lato server degli annunci con premio nell'unità pubblicitaria.

Utilizza RewardedAdsVerifier dalla libreria Tink Java Apps

Il repository GitHub Tink Java Apps include una classe helper RewardedAdsVerifier per ridurre il codice necessario per verificare un callback SSV con premio. L'utilizzo di questa classe consente di verificare un URL di callback con il seguente codice.

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

Se il metodo verify() viene eseguito senza generare un'eccezione, l'URL di callback è stato verificato correttamente. La sezione Premiare l'utente descrive le best practice relative a quando gli utenti devono essere premiati. Per un'analisi dettagliata dei passaggi eseguiti da questa classe per verificare i callback SSV con premio, puoi leggere la sezione Verifica manuale di SSV con premio.

Parametri di callback SSV

I callback di verifica lato server contengono parametri di query che descrivono l'interazione con l'annuncio con premio. I nomi, le descrizioni e i valori di esempio dei parametri sono elencati di seguito. I parametri vengono inviati in ordine alfabetico.

Identificatori delle origini annuncio

Premiare l'utente

È importante trovare un equilibrio tra l'esperienza utente e la convalida del premio quando decidi quando premiare un utente. I callback lato server potrebbero subire ritardi prima di raggiungere i sistemi esterni. Pertanto, la best practice consigliata è utilizzare il callback lato client per premiare immediatamente l'utente, eseguendo al contempo la convalida di tutti i premi alla ricezione dei callback lato server. Questo approccio offre un'esperienza utente positiva, garantendo al contempo la validità dei premi concessi.

Tuttavia, per le applicazioni in cui la validità del premio è fondamentale (ad esempio, il premio influisce sull'economia in-game della tua app) e i ritardi nell'assegnazione dei premi sono accettabili, l'approccio migliore potrebbe essere attendere il callback lato server verificato.

Dati personalizzati

Le app che richiedono dati aggiuntivi nei callback di verifica lato server devono utilizzare la funzionalità dei dati personalizzati degli annunci con premio. Qualsiasi valore di stringa impostato su un oggetto annuncio con premio viene passato al parametro di query custom_data del callback SSV. Se non viene impostato alcun valore dei dati personalizzati, il valore del parametro di query custom_data non sarà presente nel callback SSV.

L'esempio seguente imposta le opzioni SSV dopo il caricamento dell'annuncio con premio:

RewardedAd.load(with:"AD_UNIT_ID",
                       request: request,
                       completionHandler: { [self] ad, error in
      if let error != error {
      rewardedAd = ad
      let options = ServerSideVerificationOptions()
      options.customRewardString = "SAMPLE_CUSTOM_DATA_STRING"
      rewardedAd.serverSideVerificationOptions = options
    }
})

GADRequest *request = [GADRequest request];
[GADRewardedAd loadWithAdUnitID:@"AD_UNIT_ID"
                        request:request
              completionHandler:^(GADRewardedAd *ad, NSError *error) {
                if (error) {
                  // Handle Error
                  return;
                }
                self.rewardedAd = ad;
                GADServerSideVerificationOptions *options =
                    [[GADServerSideVerificationOptions alloc] init];
                options.customRewardString = @"SAMPLE_CUSTOM_DATA_STRING";
                ad.serverSideVerificationOptions = options;
              }];

Verifica manuale della SSV con premio

Di seguito sono riportati i passaggi eseguiti dalla classe RewardedAdsVerifier per verificare una SSV con premio. Sebbene gli snippet di codice inclusi siano in Java e utilizzino la libreria di terze parti Tink, questi passaggi possono essere implementati da te nel linguaggio che preferisci, utilizzando qualsiasi libreria di terze parti che supporti ECDSA.

Recupera chiavi pubbliche

Per verificare un callback SSV con premio, devi disporre di una chiave pubblica fornita da AdMob.

Un elenco di chiavi pubbliche da utilizzare per convalidare i callback SSV con premio può essere recuperato dal server di chiavi AdMob. L'elenco delle chiavi pubbliche viene fornito come rappresentazione JSON con un formato simile al seguente:

{
 "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=="
    },
  ],
}

Per recuperare le chiavi pubbliche, connettiti al server delle chiavi AdMob e scarica le chiavi. Il codice seguente esegue questa attività e salva la rappresentazione JSON delle chiavi nella variabile 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();
}

Tieni presente che le chiavi pubbliche vengono ruotate regolarmente. Riceverai un'email per informarti di una rotazione imminente. Se memorizzi nella cache le chiavi pubbliche, devi aggiornarle quando ricevi questa email.

Una volta recuperate, le chiavi pubbliche devono essere analizzate. Il metodo parsePublicKeysJson di seguito accetta come input una stringa JSON, come l'esempio precedente, e crea una mappatura dai valori key_id alle chiavi pubbliche, che vengono incapsulate come oggetti ECPublicKey dalla libreria 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;
}

Recupera i contenuti da verificare

Gli ultimi due parametri di query dei callback SSV con premio sono sempre signature e key_id, in quest'ordine. I restanti parametri di query specificano i contenuti da verificare. Supponiamo che tu abbia configurato AdMob per inviare callback dei premi a https://www.myserver.com/mypath. Lo snippet di seguito mostra un esempio di callback SSV con premio con i contenuti da verificare evidenziati.

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

Il codice seguente mostra come analizzare i contenuti da verificare da un URL di callback come array di byte 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"));

Recupera la firma e il key_id dall'URL di callback

Utilizzando il valore queryString del passaggio precedente, analizza i parametri di query signature e key_id dall'URL di callback come mostrato di seguito:

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()));

Esegui la verifica

Il passaggio finale consiste nel verificare i contenuti dell'URL di callback con la chiave pubblica appropriata. Prendi la mappatura restituita dal metodo parsePublicKeysJson e utilizza il parametro key_id dell'URL di callback per ottenere la chiave pubblica da quella mappatura. Poi verifica la firma con la chiave pubblica. Questi passaggi sono illustrati di seguito nel metodo 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 il metodo viene eseguito senza generare un'eccezione, l'URL di callback è stato verificato correttamente.

Domande frequenti

Posso memorizzare nella cache la chiave pubblica fornita dal server chiavi di AdMob?

Ti consigliamo di memorizzare nella cache la chiave pubblica fornita dal server chiavi AdMob per ridurre il numero di operazioni necessarie per convalidare i callback SSV. Tuttavia, tieni presente che le chiavi pubbliche vengono ruotate regolarmente e non devono essere memorizzate nella cache per più di 24 ore.

Con quale frequenza vengono ruotate le chiavi pubbliche fornite dal server chiavi AdMob?

Le chiavi pubbliche fornite dal server chiavi di AdMob vengono ruotate in base a una pianificazione variabile. Per garantire che la verifica dei callback SSV continui a funzionare come previsto, le chiavi pubbliche non devono essere memorizzate nella cache per più di 24 ore.

Che cosa succede se il mio server non è raggiungibile?

Google si aspetta un codice di risposta di stato di esito positivo HTTP 200 OK per i callback SSV. Se il tuo server non è raggiungibile o non fornisce la risposta prevista, Google tenterà di inviare nuovamente i callback SSV fino a cinque volte a intervalli di un secondo.

Come faccio a verificare che i callback di SSV provengano da Google?

Utilizza la ricerca DNS inversa per verificare che i callback SSV provengano da Google.