Przewodnik po podpisie cyfrowym

Podpisz cyfrowo żądanie za pomocą klucza interfejsu API

W zależności od sposobu użycia do uwierzytelniania żądań może być wymagana podpis cyfrowy oprócz klucza interfejsu API. Zapoznaj się z tymi artykułami:

Jak działają podpisy cyfrowe

Cyfrowe podpisy są generowane za pomocą tajemnego klucza do podpisywania adresów URL, który jest dostępny w konsoli Google Cloud. Ten obiekt tajny to klucz prywatny, który jest udostępniany tylko Tobie i Google. Jest on unikalny dla Twojego projektu.

Proces podpisywania używa algorytmu szyfrowania do połączenia adresu URL i wspólnego tajnego klucza. Uzyskany unikalny podpis pozwala naszym serwerom weryfikować, czy witryna generująca żądania przy użyciu klucza interfejsu API ma do tego uprawnienia.

Ograniczanie liczby niewymagających podpisu żądań

Aby mieć pewność, że klucz interfejsu API akceptuje tylko podpisane żądania:

  1. W konsoli Cloud otwórz stronę Limity Maps Platform.
  2. Kliknij menu projektu i wybierz ten sam projekt, którego użyto do utworzenia klucza API dla aplikacji lub witryny.
  3. W menu interfejsów API wybierz Map Static API lub Street View Static API.
  4. Rozwiń sekcję Niepodpisane żądania.
  5. W tabeli Nazwa limitu kliknij przycisk edycji obok limitu, który chcesz edytować. Na przykład Niepodpisane żądania dziennie.
  6. W panelu Edytuj limit zaktualizuj Limit przydziału.
  7. Kliknij Zapisz.

Podpisywanie próśb

Aby podpisać żądania, wykonaj te czynności:

Krok 1. Uzyskaj klucz tajny do podpisywania adresów URL

Aby uzyskać klucz tajny do podpisywania adresów URL projektu:

  1. Otwórz stronę Dane logowania do Google Maps Platform w konsoli Cloud.
  2. W menu projektu wybierz ten sam projekt, który został użyty podczas tworzenia klucza API do interfejsu Maps Static API lub Street View Static API.
  3. Przewiń w dół do karty Generator haseł. Pole Obecny tajny klucz zawiera bieżący tajny klucz podpisywania URL-a.
  4. Na stronie znajduje się też widżet Podpisz URL teraz, który umożliwia automatyczne podpisywanie żądania interfejsu Maps Static API lub Street View Static API za pomocą bieżącego tajnego klucza podpisywania. Aby uzyskać do niego dostęp, przewiń w dół do karty Podpisz URL teraz.

Aby uzyskać nowy tajny klucz do podpisywania adresów URL, wybierz Wygeneruj ponownie tajny klucz. Poprzedni obiekt tajny wygaśnie 24 godziny po wygenerowaniu nowego. Po upływie 24 godzin prośby zawierające stary klucz tajny nie będą już działać.

Krok 2. Utwórz niezaszyfrowane żądanie

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

Podsumowanie prawidłowych znaków w adresach URL
Do startuznakówUżycie 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 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 ciągi tekstowe, użycie schematu (http), port (8080) itp.
Niezarezerwowane - _ . ~ Teksty
Zarezerwowane ! * ' ( ) ; : @ & = + $ , / ? % # [ ] znaki sterujące lub ciągi tekstowe;

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

Utwórz adres URL niewymagający podpisu bez podpisu. Instrukcje znajdziesz w tych dokumentach dla programistów:

Pamiętaj, aby w parametrze key podać też klucz API. Na przykład:

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

Wygeneruj podpisane żądanie

W przypadku jednorazowego użycia, np. hostowania prostego obrazu interfejsu Maps Static API lub Street View Static API na stronie internetowej, lub w celu rozwiązywania problemów możesz wygenerować podpis cyfrowy automatycznie za pomocą dostępnego widgetu Podpisz URL teraz.

W przypadku żądań generowanych dynamicznie musisz zastosować podpisywanie po stronie serwera, co wymaga wykonania kilku dodatkowych czynności pośrednich.

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

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
Korzystanie z widżetu Podpisz URL teraz

Aby wygenerować podpis cyfrowy za pomocą klucza API za pomocą widżetu Podpisz URL teraz w konsoli Google Cloud:

  1. Znajdź widżet Podpisz URL teraz, korzystając z instrukcji z kroku 1: Pobierz tajny klucz do podpisywania URL-i.
  2. W polu URL wklej adres URL niezatwierdzonego żądania z kroku 2: ułóż niezatwierdzone żądanie.
  3. Pojawi się pole Twój podpisany URL, w którym znajdzie się podpisany cyfrowo adres URL. Utwórz kopię.
Generowanie podpisów cyfrowych po stronie serwera

W porównaniu z widżetem Podpisz URL teraz podczas generowania podpisów cyfrowych po stronie serwera musisz wykonać kilka dodatkowych czynności:

  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&key=YOUR_API_KEY

  2. Wyświetlany tajny klucz do podpisywania adresów URL jest kodowany w zmodyfikowanym formacie Base64 dla adresów URL.

    Ponieważ większość bibliotek kryptograficznych wymaga, aby klucz był w postaci surowych bajtów, przed podpisaniem musisz prawdopodobnie zdekodować tajny klucz podpisywania adresów URL do jego pierwotnego formatu surowego.

  3. Podpisz żądanie z usuniętymi danymi za pomocą funkcji HMAC-SHA1.

  4. Ponieważ większość bibliotek kryptograficznych generuje podpis w postaci surowych bajtów, musisz przekonwertować uzyskany podpis binarny za pomocą zmodyfikowanego Base64 w przypadku adresów URL, aby przekonwertować go na coś, co można przekazać w adresie URL.

  5. Dołącz podpis zakodowany w formacie Base64 do pierwotnego adresu URL żądania bez podpisu w parametrze signature. Na przykład:

    https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&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.

Przykładowy kod do podpisywania adresów URL

W następnych sekcjach znajdziesz sposoby implementowania podpisywania adresów URL za pomocą kodu po stronie serwera. Adresy URL powinny być zawsze podpisywane po stronie serwera, aby uniknąć ujawnienia użytkownikom tajnego klucza do podpisywania adresów URL.

Python

Przykład poniżej używa 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

Przykład poniżej używa klasy java.util.Base64 dostępnej od JDK 1.8. W starszych wersjach może być konieczne użycie Apache Commons lub podobnej biblioteki. (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

Przykład poniżej używa natywnych modułów Node do podpisywania adresu URL. (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 do podpisywania żądania URL domyślnej biblioteki System.Security.Cryptography. Pamiętaj, że musimy przekonwertować domyślne kodowanie Base64, aby zaimplementować wersję bezpieczną w adresie URL. (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 obejmujące więcej 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, gdy używany sekret podpisywania nie jest powiązany z kluczem API lub gdy dane wejściowe inne niż ASCII nie są zakodowane w formacie URL przed podpisaniem.

Aby rozwiązać ten problem, skopiuj adres URL żądania, usuń parametr zapytania signature i wygeneruj prawidłowy podpis, wykonując podane niżej instrukcje:

Aby wygenerować podpis cyfrowy za pomocą klucza API za pomocą widżetu Podpisz URL teraz w konsoli Google Cloud:

  1. Znajdź widżet Podpisz URL teraz, korzystając z instrukcji z kroku 1: Pobierz tajny klucz do podpisywania URL-i.
  2. W polu URL wklej adres URL niezatwierdzonego żądania z kroku 2: ułóż niepotwierdzone żądanie.
  3. Pojawi się pole Twój podpisany URL, w którym znajdzie się podpisany cyfrowo URL. Utwórz kopię.