Importante: El plan Premium de Google Maps Platform ya no está disponible para registros o clientes nuevos.
Firmas digitales
Cómo funcionan las firmas digitales
Las firmas digitales se generan mediante un Secreto de firma de URL, o clave criptográfica, que está disponible en la consola de Google Cloud. Básicamente, este secreto es una clave privada que solo comparten Google y tú, y es exclusivo para tu ID de cliente.
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 ID de cliente estén autorizados para hacerlo.
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
Para obtener el Secreto de firma de URL de tu proyecto, haz lo siguiente:
- Ve a la página ID de cliente en la consola de Cloud.
- El campo Clave contiene el Secreto de firma de URL de tu ID de cliente actual.
Si necesitas volver a generar el Secreto de firma de URL de tu ID de cliente, comunícate con el equipo de asistencia.
Paso 2: Crea una solicitud no firmada
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.
Asegúrate de incluir también el ID de cliente en el parámetro client. Por ejemplo:
https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
Genera la solicitud firmada
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&size=400x400&client=YOUR_CLIENT_ID &signature=BASE64_SIGNATURE
-
Quita el esquema de protocolo y las partes de host de la URL, y deja solo la ruta de acceso y la búsqueda:
-
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.
- Usa el algoritmo HMAC-SHA1 para firmar la solicitud depurada que se indica arriba.
-
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.
-
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&size=400x400&client=YOUR_CLIENT_ID &signature=BASE64_SIGNATURE
/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
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
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 al ID de cliente pasado 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 consulta 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 tu ID de cliente, usa el widget Firmar una URL ahora como se indica a continuación:
- Recupera el Secreto de firma de URL de tu ID de cliente, como se describe en el Paso 1: Obtén tu Secreto de firma de URL.
- En el campo URL, pega la URL de solicitud sin firmar del Paso 2: Crea una solicitud no firmada.
- En el campo Secreto de firma de URL, pega el secreto del paso 2.
Se generará una firma digital basada en la URL de solicitud no firmada y el secreto de firma, y se adjuntará a tu URL original. - El campo Tu URL firmada que aparece contendrá tu URL con firma digital.