Podpisywanie żądań identyfikatora klienta

Ważne: abonament Premium Google Maps Platform nie jest już dostępny dla rejestracji ani nowych klientów.

Podpisy cyfrowe

Jak działają podpisy cyfrowe

Podpisy cyfrowe są generowane za pomocą tajnego klucza podpisywania URL-a lub klucza kryptograficznego dostępnego w konsoli Google Cloud. Zasadniczo jest to klucz prywatny, który jest wspólny dla Ciebie i Google tylko między Tobą a Google i jest unikalny dla Twojego identyfikatora klienta.

W procesie podpisywania używany jest algorytm szyfrowania, który łączy adres URL i Twój udostępniony tajny klucz. Powstały w ten sposób unikalny podpis pozwala naszym serwerom sprawdzić, czy każda witryna generująca żądania przy użyciu Twojego identyfikatora klienta jest do tego uprawniona.

Podpisywanie żądań

Podpisanie wniosków obejmuje następujące kroki:

Krok 1. Pobierz tajny klucz podpisywania URL-a

Aby uzyskać tajny klucz podpisywania adresu URL projektu:

  1. Otwórz stronę identyfikatora klienta w konsoli Cloud.
  2. Pole Klucz zawiera aktualny tajny klucz podpisywania adresu URL identyfikatora klienta.

Jeśli chcesz ponownie wygenerować tajny klucz podpisywania URL-a identyfikatora klienta, skontaktuj się z zespołem pomocy.

Krok 2. Utwórz niepodpisane żądanie

Znaki nie wymienione w tabeli poniżej muszą być zakodowane na potrzeby adresu URL:

Podsumowanie prawidłowych znaków w adresie URL
UstawpostacieWykorzystanie adresu URL
Znaki alfanumeryczne a b c d e f g h i j k l m n o p q r s t u v 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 9 4 5 6 7 8 Ciągi tekstowe, użycie schematu (http), port (8080) itp.
Niezarezerwowane - _ . ~ Ciągi tekstowe
Zarezerwowano ! * ' ( ) ; : @ & = + $ , / ? % [ ] Znaki sterujące i/lub ciągi tekstowe

To samo dotyczy wszystkich znaków w zestawie Zarezerwowane, jeśli są przekazywane w ciągu tekstowym. Więcej informacji znajdziesz w sekcji Znaki specjalne.

Utwórz niepodpisany adres URL żądania bez podpisu.

Pamiętaj też, aby w parametrze client podać identyfikator klienta. Na przykład:

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

Generowanie podpisanego żądania

Aby rozwiązać problemy, możesz automatycznie wygenerować podpis cyfrowy za pomocą dostępnego widżetu Podpisz URL teraz.

W przypadku żądań generowanych dynamicznie potrzebujesz podpisywania po stronie serwera, co wymaga kilku dodatkowych kroków pośrednich

W obu przypadkach adres URL żądania powinien mieć na końcu parametr signature. Na przykład:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
&signature=BASE64_SIGNATURE
  1. Usuń z adresu URL schemat protokołu i hosta, pozostawiając tylko ścieżkę i zapytanie:

  2. /maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
    
  3. Wyświetlany obiekt tajny podpisywania adresu URL jest zakodowany w zmodyfikowanym formacie Base64 na potrzeby adresów URL.

    Większość bibliotek kryptograficznych wymaga, aby klucz miał format nieprzetworzonych bajtów, dlatego przed podpisaniem musisz prawdopodobnie zdekodować tajny klucz logowania URL do jego pierwotnego formatu nieprzetworzonego.

  4. Podpisz powyżej usunięte żądanie za pomocą algorytmu HMAC-SHA1.
  5. Większość bibliotek kryptograficznych generuje podpis w formacie nieprzetworzonych bajtów, więc wynikowy podpis binarny trzeba przekonwertować za pomocą zmodyfikowanego Base64 pod kątem adresów URL, aby uzyskać taką możliwość w postaci elementu, który można przekazać w adresie URL.

  6. Dołącz podpis zakodowany w Base64 do pierwotnego niepodpisanego adresu URL żądania w parametrze signature. Na przykład:

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

Przykłady implementacji podpisywania adresów URL za pomocą kodu po stronie serwera znajdziesz w sekcji Przykładowy kod do podpisywania adresów URL poniżej.

Przykładowy kod do podpisywania adresów URL

W sekcjach poniżej pokazujemy, jak wdrożyć podpisywanie adresów URL za pomocą kodu po stronie serwera. Adresy URL zawsze powinny być podpisane po stronie serwera, aby uniknąć ujawnienia użytkownikom Twojego tajnego klucza podpisywania URL.

Python

W przykładzie poniżej używasz standardowych bibliotek Pythona do podpisywania adresu URL. (Pobierz kod).

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

W przykładzie poniżej użyliśmy klasy java.util.Base64 dostępnej od czasu JDK 1.8. W starszych wersjach może być konieczne użycie licencji Apache Commons lub podobnej. (Pobierz kod).

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

W przykładzie poniżej do podpisywania adresu URL używane są natywne moduły węzłów. (Pobierz kod).

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

Przykład poniżej używa domyślnej biblioteki System.Security.Cryptography do podpisywania żądania adresu URL. Pamiętaj, że aby zaimplementować wersję do wykorzystania w adresie URL, musimy przekonwertować domyślne kodowanie Base64. (Pobierz kod).

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

Przykłady w dodatkowych językach

Przykłady dotyczące większej liczby języków są dostępne w projekcie url-signing.

Rozwiązywanie problemów

Jeśli żądanie zawiera nieprawidłowy podpis, interfejs API zwraca błąd HTTP 403 (Forbidden). Ten błąd występuje najprawdopodobniej wtedy, gdy używany tajny klucz podpisywania nie jest połączony z przekazanym identyfikatorem klienta lub gdy dane wejściowe spoza zestawu ASCII nie są zakodowane przed podpisaniem adresu URL.

Aby rozwiązać ten problem, skopiuj adres URL żądania, usuń parametr zapytania signature i ponownie wygeneruj prawidłowy podpis, postępując zgodnie z tymi instrukcjami:

Aby wygenerować podpis cyfrowy z identyfikatorem klienta za pomocą widżetu Podpisz URL teraz poniżej:

  1. Pobierz tajny klucz podpisywania URL-a identyfikatora klienta zgodnie z opisem w sekcji Krok 1. Pobierz tajny klucz podpisywania URL-a.
  2. W polu URL wklej niepodpisany adres URL żądania z kroku 2. Utwórz niepodpisane żądanie.
  3. W polu Tajny klucz podpisywania URL-a wklej swój tajny klucz podpisywania URL uzyskany w kroku 2.
    Podpis cyfrowy jest generowany na podstawie niepodpisanego adresu URL żądania i tajnego klucza podpisywania oraz dołączany do pierwotnego adresu URL.
  4. Pojawi się pole Twój podpisany adres URL zawierające adres URL podpisany cyfrowo.