Przewodnik po podpisie cyfrowym

Podpisz cyfrowo żądanie za pomocą klucza interfejsu API

W zależności od użycia podpis cyfrowy może być wymagany do uwierzytelniania żądań. Zobacz poniższe informacje artykuły:

Jak działają podpisy cyfrowe

Podpisy cyfrowe są generowane przy użyciu tajnego klucza podpisywania URL-a, który jest dostępny na Konsola Google Cloud. Jest to klucz prywatny, który jest dzielony tylko między Tobą a Google. który jest unikalny w Twoim projekcie.

Proces podpisywania za pomocą algorytmu szyfrowania łączy adres URL i Twoje udostępniony tajny klucz. Powstały unikalny podpis pozwala naszym serwerom na weryfikację że każda witryna generująca żądania przy użyciu Twojego klucza interfejsu API jest do tego uprawniona.

Ogranicz niepodpisane żądania

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

  1. Otwórz stronę Limity Google Maps Platform w konsoli Cloud.
  2. Kliknij menu projektu i wybierz ten sam projekt, który został użyty do utworzenia projektu. klucz interfejsu API aplikacji lub witryny.
  3. Z menu interfejsów API wybierz Maps 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 zwiększyć. edytować. Na przykład Niepodpisane żądania dziennie.
  6. Zaktualizuj Limit limitu w panelu Edytuj limit.
  7. Kliknij Zapisz.

Podpisywanie próśb

Podpisanie prośby obejmuje te kroki:

Krok 1. Uzyskaj tajny klucz podpisywania URL-a

Aby uzyskać tajny klucz podpisywania adresu URL projektu:

  1. Przejdź do Strona danych logowania do Google Maps Platform w konsoli Cloud.
  2. Kliknij menu projektu i wybierz ten sam projekt, który został użyty podczas tworzenia klucza interfejsu API. dla interfejsu Maps Static API lub Street View Static API.
  3. Przewiń w dół do karty Secret Generator. Pole Bieżący obiekt tajny zawiera bieżącego tajnego klucza podpisywania URL-a.
  4. Na stronie znajduje się też widżet Podpisz adres URL, który umożliwia automatyczne podpisywanie żądania Maps Static API lub Street View Static API przy użyciu aktualnego tajnego klucza podpisywania. Przewiń w dół do karty Podpisz adres URL teraz, aby uzyskać do niej dostęp.

Aby uzyskać nowy tajny klucz podpisywania URL-a, wybierz Ponownie wygeneruj tajny klucz. Poprzedni obiekt tajny wygaśnie 24 godziny po wygenerowaniu nowego obiektu tajnego. Po upływie 24 godzin żądania zawierające stary obiekt tajny przestaną działać.

Krok 2. Utwórz niepodpisane żądanie

Znaki, które nie są wymienione w tabeli poniżej, muszą być zakodowane na potrzeby adresu URL:

Podsumowanie prawidłowych znaków adresu URL
UstawznakówUżycie adresu URL
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 3 4 5 6 7 8 9 Ciągi tekstowe, wykorzystanie schematu (http), port (8080) itp.
Niezarezerwowane - _ . ~ Ciągi tekstowe
Zarezerwowane ! * ( ) ; : @ & = + $ , / ? % # [ ] Znaki kontrolne lub ciągi tekstowe

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

Utwórz URL niepodpisanego żądania bez podpisu. Instrukcje znajdziesz w tej dokumentacji dla programistów:

Pamiętaj, aby umieścić klucz interfejsu API również w atrybucie key. Na przykład:

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

Generowanie podpisanego żądania

Do jednorazowych zastosowań, takich jak hostowanie prostego Mapy Google Static API lub Street View static API na Twoim lub do rozwiązywania problemów, możesz wygenerować podpis cyfrowy, automatycznie za pomocą Widżet Podpisz adres URL.

W przypadku żądań generowanych dynamicznie potrzebne są dane po stronie serwera. co wymaga wykonania kilku dodatkowych czynności pośrednich.

W obu przypadkach otrzymasz URL żądania z parametrem signature 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

Do wygenerowania podpisu cyfrowego za pomocą klucz interfejsu API za pomocą widżetu Podpisz adres URL w konsoli Google Cloud:

  1. Znajdź widżet Podpisz URL teraz. zgodnie z opisem w sekcji Krok 1. Uzyskaj tajny klucz podpisywania adresu URL.
  2. W polu URL wklej adres URL niepodpisanego żądania Krok 2. Utwórz niepodpisane żądanie.
  3. W wyświetlonym polu Twój podpisany adres URL znajdziesz adres URL podpisany cyfrowo. Pamiętaj, aby zrobić jego kopię.
Generowanie podpisów cyfrowych po stronie serwera

W porównaniu z widżetem Podpisz URL teraz trzeba wykonać dodatkowe czynności. działania podczas generowania podpisów cyfrowych po stronie serwera:

  1. Usuń schemat protokołu i fragmenty adresu URL związane z hostami, 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 podpisywania URL-a jest zakodowany w zmodyfikowanym Base64 w przypadku adresów URL.

    Większość bibliotek kryptograficznych wymaga, by klucz był w nieprzetworzonym formacie bajtowym, więc prawdopodobnie musisz zdekodować tajny klucz logowania URL do jego pierwotnego, nieprzetworzonego formatu przed podpisem.

  3. Podpisz usunięte wcześniej żądanie za pomocą algorytmu HMAC-SHA1.

  4. Większość bibliotek kryptograficznych generuje podpis w nieprzetworzonym formacie bajtowym, więc skonwertuj wynikowy podpis binarny za pomocą zmodyfikowanego Base64 w przypadku adresów URL, które mają być konwertowane. do czegoś, co przekazuje się w adresie URL.

  5. Dołącz podpis zakodowany w Base64 do pierwotnego adresu URL niepodpisanego żądania w 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 URL-i za pomocą kodu po stronie serwera znajdziesz tutaj Przykładowy kod do podpisywania URL-a poniżej.

Przykładowy kod do podpisywania URL-a

W sekcjach poniżej znajdziesz sposoby implementacji podpisywania URL-i za pomocą po stronie serwera. Adresy URL powinny być zawsze podpisane po stronie serwera, aby uniknąć ujawnianie użytkownikom tajnego klucza podpisywania URL-a.

Python

W przykładzie poniżej użyto standardowych bibliotek Pythona do podpisania 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żyto dostępnej klasy java.util.Base64 od JDK 1.8 – w starszych wersjach może być konieczne korzystanie z Apache Commons lub podobnej platformy. (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 użyto natywnych modułów węzła do podpisania 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#

W przykładzie poniżej użyto wartości domyślnej System.Security.Cryptography, aby podpisać żądanie adresu URL. Pamiętaj, że musimy przekonwertować domyślne kodowanie Base64, aby zaimplementować Wersja bezpieczna 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, które obejmują więcej języków, są dostępne w url-signing w projektach AI.

Rozwiązywanie problemów

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

Aby rozwiązać ten problem, skopiuj adres URL żądania i usuń zapytanie signature i ponownie wygeneruj prawidłowy podpis, wykonując te instrukcje:

Do wygenerowania podpisu cyfrowego za pomocą klucz interfejsu API za pomocą widżetu Podpisz adres URL w konsoli Google Cloud:

  1. Znajdź widżet Podpisz URL teraz. zgodnie z opisem w sekcji Krok 1. Uzyskaj tajny klucz podpisywania adresu URL.
  2. W polu URL wklej adres URL niepodpisanego żądania Krok 2. Utwórz niepodpisane żądanie.
  3. W wyświetlonym polu Twój podpisany adres URL znajdziesz adres URL podpisany cyfrowo. Pamiętaj, aby zrobić jego kopię.