Guida alla firma digitale

Firmare digitalmente la richiesta con una chiave API

A seconda dell'utilizzo, per autenticare le richieste potrebbe essere necessaria una firma digitale, oltre a una chiave API. Consulta i seguenti articoli:

Come funzionano le firme digitali

Le firme digitali vengono generate utilizzando un segreto per la firma dell'URL, disponibile nella console Google Cloud. Questo secret è essenzialmente una chiave privata, condivisa solo tra te e Google, ed è univoca per il tuo progetto.

La procedura di firma utilizza un algoritmo di crittografia per combinare l'URL e il segreto condiviso. La firma univoca risultante consente ai nostri server di verificare che qualsiasi sito che genera richieste utilizzando la tua chiave API sia autorizzato a farlo.

Limita le richieste non firmate

Per assicurarti che la chiave API accetti solo richieste firmate:

  1. Vai alla pagina Quote di Google Maps Platform nella console Cloud.
  2. Fai clic sul menu a discesa del progetto e seleziona lo stesso progetto utilizzato per creare la chiave API per la tua applicazione o il tuo sito.
  3. Seleziona l'API Maps Static o l'API Street View Static dal menu a discesa API.
  4. Espandi la sezione Richieste non firmate.
  5. Nella tabella Nome quota, fai clic sul pulsante di modifica accanto alla quota da modificare. Ad esempio, Richieste non firmate al giorno.
  6. Aggiorna Limite quota nel riquadro Modifica limite quota.
  7. Seleziona Salva.

Firmare le richieste

La firma delle richieste prevede i seguenti passaggi:

Passaggio 1: ottieni il segreto per la firma dell'URL

Per ottenere la chiave di firma dell'URL del progetto:

  1. Vai alla pagina Credenziali della piattaforma Google Maps nella console Cloud.
  2. Seleziona il menu a discesa del progetto e seleziona lo stesso progetto utilizzato per creare la chiave API per l'API Maps Static o l'API Street View Static.
  3. Scorri verso il basso fino alla scheda Generatore di secret. Il campo Secret attuale contiene il tuo secret di firma URL attuale.
  4. La pagina include anche il widget Firma subito un URL che ti consente di firmare automaticamente la richiesta dell'API Maps Static o dell'API Street View Static utilizzando il tuo attuale segreto di firma. Scorri verso il basso fino alla scheda Firma un URL ora per accedervi.

Per ottenere un nuovo segreto per la firma dell'URL, seleziona Rigenera segreto. Il secret precedente scadrà 24 ore dopo che avrai generato un nuovo secret. Una volta trascorse le 24 ore, le richieste contenenti il vecchio segreto non funzionano più.

Passaggio 2: crea la richiesta non firmata

I caratteri non elencati nella tabella seguente devono essere codificati per l'URL:

Riepilogo dei caratteri validi per gli URL
PartenzacaratteriUtilizzo degli URL
Alfanumerico a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 Stringhe di testo, utilizzo dello schema (http), porta (8080) e così via.
Non prenotato - _ . ~ Stringhe di testo
Prenotato ! * ' ( ) ; : @ & = + $ , / ? % # [ ] Caratteri di controllo e/o stringhe di testo

Lo stesso vale per tutti i caratteri dell'insieme Riservati, se vengono passati all'interno di una stringa di testo. Per ulteriori informazioni, consulta Caratteri speciali.

Crea l'URL della richiesta non firmato senza la firma. Per le istruzioni, consulta la seguente documentazione per sviluppatori:

Assicurati di includere anche la chiave API nel parametro key. Ad esempio:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY

Genera la richiesta firmata

Per casi d'uso una tantum, come l'hosting di un'immagine semplice dell'API Maps Static o dell'API Street View Static sulla tua pagina web o per la risoluzione dei problemi, puoi generare automaticamente una firma digitale utilizzando il widget Firma subito un URL disponibile.

Per le richieste generate dinamicamente, è necessaria la firma lato server, che richiede alcuni passaggi intermedi aggiuntivi

In entrambi i casi, dovresti ottenere un URL richiesta con un parametro signature aggiunto alla fine. Ad esempio:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
Utilizzare il widget Firma un URL ora

Per generare una firma digitale con una chiave API utilizzando il widget Firma subito un URL nella console Google Cloud:

  1. Individua il widget Firma un URL ora, come descritto nel passaggio 1: ottieni la chiave segreta per la firma dell'URL.
  2. Nel campo URL, incolla l'URL della richiesta non firmata di Passaggio 2: crea la richiesta non firmata.
  3. Il campo Il tuo URL firmato visualizzato conterrà l'URL firmato digitalmente. Assicurati di creare una copia.
Generare firme digitali lato server

Rispetto al widget Firma un URL ora, dovrai eseguire alcune azioni aggiuntive per la generazione delle firme digitali lato server:

  1. Rimuovi lo schema del protocollo e le parti dell'host dell'URL, lasciando solo il percorso e la query:

    2. /maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY

  2. Il segreto di firma dell'URL visualizzato è codificato in un formato Base64 modificato per gli URL.

    Poiché la maggior parte delle librerie di crittografia richiede che la chiave sia in formato di byte non elaborato, probabilmente dovrai decodificare il segreto di firma dell'URL nel formato non elaborato originale prima della firma.

  3. Firma la richiesta sopra destrutturata utilizzando HMAC-SHA1.

  4. Poiché la maggior parte delle librerie di crittografia genera una firma in formato byte non elaborato, dovrai convertire la firma binaria risultante utilizzando il formato Base64 modificato per gli URL per convertirla in un formato che possa essere passato all'interno dell'URL.

  5. Aggiungi la firma con codifica Base64 all'URL di richiesta originale non firmato nel parammetro signature. Ad esempio:

    https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE

Per esempi che mostrano i modi per implementare la firma dell'URL utilizzando il codice lato server, consulta Codice di esempio per la firma dell'URL di seguito.

Codice di esempio per la firma dell'URL

Le sezioni seguenti mostrano i modi per implementare la firma dell'URL utilizzando il codice lato server. Gli URL devono sempre essere firmati lato server per evitare di esporre il segreto di firma dell'URL agli utenti.

Python

L'esempio seguente utilizza le librerie Python standard per firmare un URL. Scarica il codice.

#!/usr/bin/python
# -*- coding: utf-8 -*-
""" Signs a URL using a URL signing secret """

import hashlib
import hmac
import base64
import urllib.parse as urlparse


def sign_url(input_url=None, secret=None):
    """ Sign a request URL with a URL signing secret.
      Usage:
      from urlsigner import sign_url
      signed_url = sign_url(input_url=my_url, secret=SECRET)
      Args:
      input_url - The URL to sign
      secret    - Your URL signing secret
      Returns:
      The signed request URL
  """

    if not input_url or not secret:
        raise Exception("Both input_url and secret are required")

    url = urlparse.urlparse(input_url)

    # We only need to sign the path+query part of the string
    url_to_sign = url.path + "?" + url.query

    # Decode the private key into its binary format
    # We need to decode the URL-encoded private key
    decoded_key = base64.urlsafe_b64decode(secret)

    # Create a signature using the private key and the URL-encoded
    # string using HMAC SHA1. This signature will be binary.
    signature = hmac.new(decoded_key, str.encode(url_to_sign), hashlib.sha1)

    # Encode the binary signature into base64 for use within a URL
    encoded_signature = base64.urlsafe_b64encode(signature.digest())

    original_url = url.scheme + "://" + url.netloc + url.path + "?" + url.query

    # Return signed URL
    return original_url + "&signature=" + encoded_signature.decode()


if __name__ == "__main__":
    input_url = input("URL to Sign: ")
    secret = input("URL signing secret: ")
    print("Signed URL: " + sign_url(input_url, secret))

Java

L'esempio seguente utilizza la classe java.util.Base64 disponibile da JDK 1.8. Per le versioni precedenti potrebbe essere necessario utilizzare Apache Commons o un software simile. Scarica il codice.

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;  // JDK 1.8 only - older versions may need to use Apache Commons or similar.
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.net.URL;
import java.io.BufferedReader;
import java.io.InputStreamReader;

public class UrlSigner {

  // Note: Generally, you should store your private key someplace safe
  // and read them into your code

  private static String keyString = "YOUR_PRIVATE_KEY";
  
  // The URL shown in these examples is a static URL which should already
  // be URL-encoded. In practice, you will likely have code
  // which assembles your URL from user or web service input
  // and plugs those values into its parameters.
  private static String urlString = "YOUR_URL_TO_SIGN";

  // This variable stores the binary key, which is computed from the string (Base64) key
  private static byte[] key;
  
  public static void main(String[] args) throws IOException,
    InvalidKeyException, NoSuchAlgorithmException, URISyntaxException {
    
    BufferedReader input = new BufferedReader(new InputStreamReader(System.in));
    
    String inputUrl, inputKey = null;

    // For testing purposes, allow user input for the URL.
    // If no input is entered, use the static URL defined above.    
    System.out.println("Enter the URL (must be URL-encoded) to sign: ");
    inputUrl = input.readLine();
    if (inputUrl.equals("")) {
      inputUrl = urlString;
    }
    
    // Convert the string to a URL so we can parse it
    URL url = new URL(inputUrl);
 
    // For testing purposes, allow user input for the private key.
    // If no input is entered, use the static key defined above.   
    System.out.println("Enter the Private key to sign the URL: ");
    inputKey = input.readLine();
    if (inputKey.equals("")) {
      inputKey = keyString;
    }
    
    UrlSigner signer = new UrlSigner(inputKey);
    String request = signer.signRequest(url.getPath(),url.getQuery());
    
    System.out.println("Signed URL :" + url.getProtocol() + "://" + url.getHost() + request);
  }
  
  public UrlSigner(String keyString) throws IOException {
    // Convert the key from 'web safe' base 64 to binary
    keyString = keyString.replace('-', '+');
    keyString = keyString.replace('_', '/');
    System.out.println("Key: " + keyString);
    // Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
    this.key = Base64.getDecoder().decode(keyString);
  }

  public String signRequest(String path, String query) throws NoSuchAlgorithmException,
    InvalidKeyException, UnsupportedEncodingException, URISyntaxException {
    
    // Retrieve the proper URL components to sign
    String resource = path + '?' + query;
    
    // Get an HMAC-SHA1 signing key from the raw key bytes
    SecretKeySpec sha1Key = new SecretKeySpec(key, "HmacSHA1");

    // Get an HMAC-SHA1 Mac instance and initialize it with the HMAC-SHA1 key
    Mac mac = Mac.getInstance("HmacSHA1");
    mac.init(sha1Key);

    // compute the binary signature for the request
    byte[] sigBytes = mac.doFinal(resource.getBytes());

    // base 64 encode the binary signature
    // Base64 is JDK 1.8 only - older versions may need to use Apache Commons or similar.
    String signature = Base64.getEncoder().encodeToString(sigBytes);
    
    // convert the signature to 'web safe' base 64
    signature = signature.replace('+', '-');
    signature = signature.replace('/', '_');
    
    return resource + "&signature=" + signature;
  }
}

Node.js

L'esempio seguente utilizza i moduli Node nativi per firmare un URL. Scarica il codice.

'use strict'

const crypto = require('crypto');
const url = require('url');

/**
 * Convert from 'web safe' base64 to true base64.
 *
 * @param  {string} safeEncodedString The code you want to translate
 *                                    from a web safe form.
 * @return {string}
 */
function removeWebSafe(safeEncodedString) {
  return safeEncodedString.replace(/-/g, '+').replace(/_/g, '/');
}

/**
 * Convert from true base64 to 'web safe' base64
 *
 * @param  {string} encodedString The code you want to translate to a
 *                                web safe form.
 * @return {string}
 */
function makeWebSafe(encodedString) {
  return encodedString.replace(/\+/g, '-').replace(/\//g, '_');
}

/**
 * Takes a base64 code and decodes it.
 *
 * @param  {string} code The encoded data.
 * @return {string}
 */
function decodeBase64Hash(code) {
  // "new Buffer(...)" is deprecated. Use Buffer.from if it exists.
  return Buffer.from ? Buffer.from(code, 'base64') : new Buffer(code, 'base64');
}

/**
 * Takes a key and signs the data with it.
 *
 * @param  {string} key  Your unique secret key.
 * @param  {string} data The url to sign.
 * @return {string}
 */
function encodeBase64Hash(key, data) {
  return crypto.createHmac('sha1', key).update(data).digest('base64');
}

/**
 * Sign a URL using a secret key.
 *
 * @param  {string} path   The url you want to sign.
 * @param  {string} secret Your unique secret key.
 * @return {string}
 */
function sign(path, secret) {
  const uri = url.parse(path);
  const safeSecret = decodeBase64Hash(removeWebSafe(secret));
  const hashedSignature = makeWebSafe(encodeBase64Hash(safeSecret, uri.path));
  return url.format(uri) + '&signature=' + hashedSignature;
}

C#

L'esempio seguente utilizza la libreria System.Security.Cryptography predefinita per firmare una richiesta URL. Tieni presente che dobbiamo convertire la codifica Base64 predefinita per implementare una versione sicura per l'URL. Scarica il codice.

using System;
using System.Collections.Generic;
using System.Security.Cryptography;
using System.Text;
using System.Text.RegularExpressions;
using System.Web;

namespace SignUrl {

  public struct GoogleSignedUrl {

    public static string Sign(string url, string keyString) {
      ASCIIEncoding encoding = new ASCIIEncoding();

      // converting key to bytes will throw an exception, need to replace '-' and '_' characters first.
      string usablePrivateKey = keyString.Replace("-", "+").Replace("_", "/");
      byte[] privateKeyBytes = Convert.FromBase64String(usablePrivateKey);

      Uri uri = new Uri(url);
      byte[] encodedPathAndQueryBytes = encoding.GetBytes(uri.LocalPath + uri.Query);

      // compute the hash
      HMACSHA1 algorithm = new HMACSHA1(privateKeyBytes);
      byte[] hash = algorithm.ComputeHash(encodedPathAndQueryBytes);

      // convert the bytes to string and make url-safe by replacing '+' and '/' characters
      string signature = Convert.ToBase64String(hash).Replace("+", "-").Replace("/", "_");
            
      // Add the signature to the existing URI.
      return uri.Scheme+"://"+uri.Host+uri.LocalPath + uri.Query +"&signature=" + signature;
    }
  }

  class Program {

    static void Main() {
    
      // Note: Generally, you should store your private key someplace safe
      // and read them into your code

      const string keyString = "YOUR_PRIVATE_KEY";
  
      // The URL shown in these examples is a static URL which should already
      // be URL-encoded. In practice, you will likely have code
      // which assembles your URL from user or web service input
      // and plugs those values into its parameters.
      const  string urlString = "YOUR_URL_TO_SIGN";
      
      string inputUrl = null;
      string inputKey = null;
    
      Console.WriteLine("Enter the URL (must be URL-encoded) to sign: ");
      inputUrl = Console.ReadLine();
      if (inputUrl.Length == 0) {
        inputUrl = urlString;
      }     
    
      Console.WriteLine("Enter the Private key to sign the URL: ");
      inputKey = Console.ReadLine();
      if (inputKey.Length == 0) {
        inputKey = keyString;
      }
      
      Console.WriteLine(GoogleSignedUrl.Sign(inputUrl,inputKey));
    }
  }
}

Esempi in altre lingue

Esempi che coprono più lingue sono disponibili nel progetto url-signing.

Risoluzione dei problemi

Se la richiesta include una firma non valida, l'API restituisce un errore HTTP 403 (Forbidden). Questo errore si verifica molto probabilmente se il segreto di firma utilizzato non è collegato alla chiave API passata o se l'input non ASCII non è codificato in URL prima della firma.

Per risolvere il problema, copia l'URL della richiesta, rimuovi il parametro querysignature e rigenera una firma valida seguendo le istruzioni riportate di seguito:

Per generare una firma digitale con una chiave API utilizzando il widget Firma subito un URL nella console Google Cloud:

  1. Individua il widget Firma un URL ora, come descritto nel passaggio 1: ottieni la chiave segreta per la firma dell'URL.
  2. Nel campo URL, incolla l'URL della richiesta non firmata di Passaggio 2: crea la richiesta non firmata.
  3. Il campo Il tuo URL firmato visualizzato conterrà l'URL firmato digitalmente. Assicurati di creare una copia.