Usa una firma digital

La API de Maps Static no tiene vencimiento las firmas digitales.

Firma digitalmente tu solicitud con una clave de API

Según tu uso, es posible que se requiera una firma digital, además de la clave de API, para autenticar las solicitudes. Consulta lo siguiente artículo:

• API de Maps Static: otros límites de uso

Cómo funcionan las firmas digitales

Las firmas digitales se generan mediante un secreto de firma de URL, que está disponible en la consola de Google Cloud. Básicamente, este secreto es una clave privada que solo Google y tú comparten. Además, es exclusivo para tu proyecto.

El proceso de firma usa un algoritmo de encriptación para combinar la URL y tu secreto compartido. La firma única resultante permite que nuestros servidores verifiquen que los sitios que generan solicitudes con tu clave de API estén autorizados para hacerlo.

Te recomendamos que utilices tanto una clave de API como una firma digital, sin importar tu uso.

Cómo limitar las solicitudes sin firmar

Para garantizar que tu clave de API solo acepte solicitudes firmadas, sigue estos pasos:

1. Ve a la página Cuotas de Google Maps Platform en la consola de Cloud.
2. Haz clic en el menú desplegable de proyectos y selecciona el mismo que utilizaste al crear la clave de API de tu aplicación o sitio.
3. Selecciona API de Maps Static en el menú desplegable de APIs.
4. Expande la sección Unsigned requests.
5. En la tabla Nombre de la cuota, haz clic en el botón de edición junto a la cuota que deseas modificar, por ejemplo, Unsigned requests per day.
6. Actualiza Límite de cuota en el panel Editar el límite de cuota.
7. Selecciona Guardar.

Antes de comenzar

Antes de comenzar, averigua la URL de la página web que contiene tu mapa estático. Esta URL es la que se firma de manera digital.

Cómo firmar tus solicitudes

El proceso para firmar tus solicitudes implica los siguientes pasos:

• Paso 1: Obtén tu Secreto de firma de URL.
• Paso 2: Crea una solicitud no firmada.
• Paso 3: Genera la solicitud firmada.

Paso 1: Obtén tu Secreto de firma de URL

Advertencia: Mantén tu Secreto de firma de URL protegido. No debes pasarlo en solicitudes, almacenarlo en sitios web ni publicarlo en foros públicos. Cualquier persona que obtenga tu secreto de firma de URL podría usar tu identidad para falsificar solicitudes.

Para obtener el secreto de firma de URL de tu proyecto, haz lo siguiente:

1. Ve a la página Credenciales de Google Maps Platform en la consola de Cloud.
2. Selecciona el menú desplegable de proyectos y elige el mismo proyecto que usaste cuando creaste la clave de API para la API de Maps Static.
3. Desplázate hacia abajo hasta la tarjeta Generador de secretos. El campo Secreto actual contiene tu secreto de firma de URL actual.
4. La página también muestra el widget Firmar una URL ahora, que te permite firmar automáticamente. la solicitud a la API de Maps Static mediante tu secreto de firma actual. Desplázate hacia abajo hasta la tarjeta Firmar una URL ahora para acceder.

Para obtener un nuevo secreto de firma de URL, haz clic en Volver a generar secreto. El secreto anterior vencerá 24 horas después de que generes uno nuevo. Una vez pasado ese tiempo, las solicitudes que contengan el secreto anterior ya no funcionarán.

Paso 2: Crea una solicitud no firmada

Advertencia: Las solicitudes que contienen un ID de cliente y una clave de API pueden provocar un comportamiento inesperado de la API o un comportamiento de facturación no deseado. Para evitar esto, asegúrate de que tus solicitudes usen solo uno de estos parámetros.

Importante: Todos los servicios de Google deben contar con la codificación de caracteres UTF-8 (que, implícitamente, incluye ASCII). Si tus aplicaciones funcionan con grupos de caracteres que no son ASCII, asegúrate de que creen URLs con caracteres UTF-8 y que los codifiquen en formato URL correctamente.

Los caracteres que no se mencionan en la siguiente tabla deben estar codificados en formato URL:

Conjunto	caracteres	Uso en la URL
Alfanuméricos	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	Cadenas de texto, uso de esquemas (http), puerto (8080), etcétera
No reservados	- _ . ~	Cadenas de texto
Reservados	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	Caracteres de control o cadenas de texto

Lo mismo se aplica a cualquier carácter del conjunto Reservado si se pasa dentro de una cadena de texto. Para obtener más información, consulta Caracteres especiales.

Crea tu URL de solicitud no firmada. Para obtener instrucciones, consulta la siguiente documentación para desarrolladores:

• API de Maps Static

Asegúrate de incluir también la clave de API en el parámetro key. Por ejemplo:

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

Genera la solicitud firmada

Para casos de uso únicos, como alojar una imagen simple de la API de Maps Static o Street View Static en tu página web, o bien para solucionar problemas, puedes generar automáticamente una firma digital con el widget disponible Firmar una URL ahora.

Para las solicitudes generadas de forma dinámica, necesitas la firma del servidor, que requiere algunos pasos intermedios adicionales.

De cualquier manera, deberías tener una URL de solicitud que presente un parámetro signature al final. Por ejemplo:

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

Cómo utilizar el widget Firmar una URL ahora

Para generar una firma digital con una clave de API a través del widget Firmar una URL ahora en la consola de Google Cloud, sigue estos pasos:

1. Accede al widget Firmar una URL ahora, tal como se describe en la sección Paso 1: Obtén tu secreto de firma de URL.
2. En el campo URL, pega la URL de solicitud sin firmar del Paso 2: Crea una solicitud no firmada.
3. El campo Tu URL firmada que aparece contendrá tu URL con firma digital. Asegúrate de hacer una copia.

Genera firmas digitales del servidor

En comparación con el widget Firmar una URL ahora, deberás realizar algunas acciones adicionales para generar firmas digitales del servidor:

1. Quita el esquema de protocolo y las partes de host de la URL, y deja solo la ruta de acceso y la búsqueda.

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

2. El Secreto de firma de URL que se muestra está codificado en un sistema Base64 modificado para URLs.

   Como la mayoría de las bibliotecas criptográficas requieren que la clave esté en formato de bytes sin procesar, es probable que debas decodificar tu Secreto de firma de URL y pasarlo al formato original sin procesar antes de la firma.

3. Usa el algoritmo HMAC-SHA1 para firmar la solicitud depurada que se indica arriba.

4. Dado que la mayoría de las bibliotecas criptográficas generan una firma en formato de bytes sin procesar, deberás convertir la firma binaria resultante con el sistema Base64 modificado para que las URLs puedan pasarla.

   Nota: El sistema Base64 modificado para URLs reemplaza los caracteres + y / del sistema Base64 estándar con - y _ respectivamente, de modo que ya no es necesario codificar en formato URL estas firmas de Base64.

5. Agrega la firma codificada en Base64 a la URL de solicitud original no firmada en el parámetro signature. Por ejemplo:

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

Si deseas ver muestras que ilustren diferentes maneras de implementar la firma de URL con código del servidor, consulta Código de muestra para la firma de URLs a continuación.

Código de muestra para la firma de URLs

En las siguientes secciones, se muestra cómo implementar una firma de URL con un código del servidor. Las URLs siempre deben contar con la firma del servidor para evitar exponer tu Secreto de firma de URL a los usuarios.

Python

El siguiente ejemplo usa bibliotecas Python estándares para firmar una URL (descarga el código).

#!/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

El siguiente ejemplo usa la clase java.util.Base64 disponible desde JDK 1.8. Es posible que las versiones anteriores necesiten usar Apache Commons o similares (descarga el código).

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

El siguiente ejemplo usa módulos de Node nativos para firmar una URL (descarga el código).

'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#

El siguiente ejemplo usa la biblioteca System.Security.Cryptography predeterminada para firmar una solicitud de URL. Ten en cuenta que debemos convertir la codificación Base64 predeterminada para implementar una versión compatible con URL (descarga el código).

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

Ejemplos en otros lenguajes

Encontrarás ejemplos que incluyen más lenguajes en el proyecto de firma de URL.

Solución de problemas

Importante: Verifica que el secreto de firma de URL y la clave de API utilizados correspondan al mismo proyecto de Google Cloud.

Si la solicitud incluye una firma no válida, la API mostrará un error HTTP 403 (Forbidden). Este error suele ocurrir cuando se utiliza un secreto de firma que no está vinculado a la clave de API pasada o cuando se ingresan caracteres ajenos a ASCII que no se codifican en el formato URL antes de la firma.

Para solucionar el problema, copia la URL de la solicitud, quita el parámetro de búsqueda signature y vuelve a generar una firma válida de acuerdo con las instrucciones que se indican a continuación:

Para generar una firma digital con una clave de API a través del widget Firmar una URL ahora en la consola de Google Cloud, sigue estos pasos:

1. Accede al widget Firmar una URL ahora, tal como se describe en la sección Paso 1: Obtén tu secreto de firma de URL.
2. En el campo URL, pega la URL de solicitud sin firmar del Paso 2: Crea una solicitud no firmada.
3. El campo Tu URL firmada que aparece contendrá tu URL con firma digital. Asegúrate de hacer una copia.