Руководство по работе с цифровой подписью

Как добавить цифровую подпись в запрос с помощью ключа API

В зависимости от того, как вы используете запросы, для их аутентификации в дополнение к ключу API может понадобиться цифровая подпись. Ознакомьтесь со следующими статьями:

• Другие лимиты на использование Maps Static API
• Другие лимиты на использование Street View Static API

Как работают цифровые подписи

Для создания цифровых подписей используется секрет для подписания URL, который можно найти в Google Cloud Console. Он представляет собой закрытый ключ, доступ к которому есть только у вас и у Google. Ключ уникален для каждого проекта.

В процессе подписания секретный ключ объединяется с URL и зашифровывается. Полученная уникальная подпись позволяет нашим серверам проверять наличие требуемых прав у сайта, который создает запросы с помощью вашего ключа API.

Как установить лимиты на количество запросов без подписи

Чтобы ваш ключ API принимал только подписанные запросы, выполните следующие действия:

1. Откройте Cloud Console и перейдите на страницу квот платформы Google Карт.
2. В раскрывающемся меню проектов выберите проект, который вы использовали при создании ключа API для приложения или сайта.
3. В раскрывающемся меню API выберите Maps Static API или Street View Static API.
4. Разверните раздел Unsigned requests (Неподписанные запросы).
5. В таблице Quota Name (Название квоты) нажмите кнопку редактирования рядом с нужной квотой, например Unsigned requests per day (Количество неподписанных запросов в день).
6. Измените значение Quota limit (Размер квоты) на панели Edit Quota Limit (Изменить размер квоты).
7. Нажмите Save (Сохранить).

Как подписать запрос

Чтобы подписать запрос:

• Шаг 1. Получите секрет для подписания URL.
• Шаг 2. Создайте неподписанный запрос.
• Шаг 3. Сформируйте подписанный запрос.

Шаг 1. Получите секрет для подписания URL

Чтобы получить секрет для подписания URL, выполните следующие действия:

1. Откройте Cloud Console и перейдите на страницу учетных данных платформы Google Карт.
2. В раскрывающемся меню проектов выберите проект, который вы использовали при создании ключа API для Maps Static API или Street View Static API.
3. Найдите карточку Secret Generator (Генератор секретов). В поле Current secret (Текущий секрет) вы найдете текущий секрет для подписания URL.
4. На странице также есть виджет Sign a URL now (Подписать URL), с помощью которого можно автоматически подписать запрос Maps Static API или Street View Static API, используя текущий секрет для подписания. Он находится на карточке Sign a URL now (Подписать URL).

Чтобы получить новый секрет для подписания URL, выберите Regenerate Secret (Создать новый секрет). После создания нового секрета старый станет недействительным через 24 часа, а запросы, содержащие старый секрет, перестанут работать.

Шаг 2. Создайте неподписанный запрос

Для символов, не указанных в таблице, необходимо использовать кодирование URL.

Это также относится ко всем символам из набора зарезервированных если они присутствуют в текстовой строке. Подробнее о специальных символах…

Создайте URL запроса без подписи. Инструкции приведены в документации для разработчиков:

• Maps Static API
• Street View Static API

В качестве параметра key должен быть указан ключ API. Пример:

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

Сформируйте подписанный запрос

Когда цифровую подпись нужно использовать один раз, например разместить простое изображение Maps Static API или Street View Static API на веб-странице или устранить ошибку, вы можете создать ее автоматически с помощью виджета Sign a URL now (Подписать URL).

Для динамических запросов подпись создается на сервере, поэтому вам потребуется выполнить несколько дополнительных шагов.

В обоих случаях вам нужно получить URL запроса с параметром signature в конце. Пример:

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

Как использовать виджет Sign a URL now (Подписать URL)

Чтобы создать цифровую подпись с помощью ключа API, используя виджет Sign a URL now (Подписать URL) в Google Cloud Console, выполните следующие действия:

1. Найдите виджет Sign a URL now (Подписать URL), как описано в разделе Шаг 1. Получите секрет для подписания URL.
2. В поле URL вставьте адрес, созданный на шаге 2.
3. В появившемся поле Your Signed URL (Подписанный URL) будет указан подписанный URL. Сохраните его.

Как создать цифровую подпись на сервере

Если вы создаете цифровую подпись на сервере, вам придется выполнить больше действий, чем при использовании виджета Подписать URL.

1. Удалите из URL сведения о протоколе и хосте, оставив только путь и запрос:

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

2. Ваш секрет для подписания URL закодирован в измененном формате Base64 для URL.

   Так как для большинства криптографических библиотек требуются ключи в исходном байтовом формате, перед подписанием вам, возможно, потребуется декодировать секрет в этот формат.

3. Запрос, из которого удалены сведения о протоколе и хосте, вам нужно подписать с помощью алгоритма HMAC-SHA1.

4. Так как большинство криптографических библиотек создают подписи в байтовом формате, вам будет нужно преобразовать двоичную подпись с помощью измененного формата Base64 для URL в другой поддерживаемый формат.

5. Добавьте подпись, закодированную в формате Base64, в параметр signature исходного URL неподписанного запроса. Пример:

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

Примеры подписания URL с помощью серверного кода приводятся в следующем разделе.

Образец кода для подписания URL

В этом разделе показано, как подписать URL с помощью серверного кода. URL должны всегда подписываться на стороне сервера, чтобы секрет для подписания не был раскрыт.

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

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

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

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

Примеры на других языках

Примеры на других языках доступны в проекте подписи URL.

Устранение неполадок

Если в запросе будет неверная подпись, API вернет ошибку HTTP 403 (Forbidden). Такая ошибка чаще всего возникает, если используемый для подписи секрет не связан с переданным ключом API или если входные данные в формате, не соответствующем ASCII, не закодированы в URL до подписания.

Чтобы устранить эту неполадку, скопируйте URL запроса, удалите из него часть с параметром signature и повторно сформируйте подпись согласно инструкциям ниже.

Чтобы создать цифровую подпись с помощью ключа API, используя виджет Sign a URL now (Подписать URL) в Google Cloud Console, выполните следующие действия:

1. Найдите виджет Sign a URL now (Подписать URL), как описано в разделе Шаг 1. Получите секрет для подписания URL.
2. В поле URL вставьте адрес, созданный на шаге 2.
3. В появившемся поле Your Signed URL (Подписанный URL) будет указан подписанный URL. Сохраните его.