דף זה תורגם על ידי Cloud Translation API.

חתימת בקשה של מזהה לקוח

חשוב: תוכנית הפרימיום של הפלטפורמה של מפות Google לא זמינה יותר להרשמה או ללקוחות חדשים.

חתימות דיגיטליות

איך פועלות חתימות דיגיטליות

חתימות דיגיטליות נוצרות באמצעות סוד לחתימה על כתובות URL או מפתח קריפטוגרפי, שזמין במסוף Google Cloud. הסוד הזה הוא בעצם מפתח פרטי, שמשותף רק בינך לבין Google, והוא ייחודי למזהה הלקוח שלך.

בתהליך החתימה נעשה שימוש באלגוריתם הצפנה כדי לשלב את כתובת ה-URL עם הסוד המשותף שלכם. החתימה הייחודית שמתקבלת מאפשרת לשרתים שלנו לאמת שכל אתר שיוצר בקשות באמצעות מזהה הלקוח שלך מורשה לעשות זאת.

חתימה על הבקשות שלך

חתימה על הבקשות שלכם באופן הבא:

שלב 1: קביעת סוד החתימה על כתובת ה-URL
שלב 2: יצירה של בקשה לא חתומה
שלב 3: יוצרים את הבקשה החתומה

שלב 1: יצירת הסוד לחתימה על כתובת ה-URL

כדי לקבל את הסוד לחתימה על כתובת ה-URL של הפרויקט:

נכנסים לדף Client ID במסוף Cloud.
השדה Key מכיל את סוד החתימה הנוכחי של כתובת ה-URL של מזהה הלקוח.

אם אתם צריכים ליצור מחדש את סוד החתימה של כתובת ה-URL של מזהה הלקוח, פנו לתמיכה.

שלב 2: בונים את הבקשה הלא חתומה

התווים שלא מופיעים בטבלה הבאה חייבים להיות בקידודי תווים שמתאימים לכתובות URL:

סיכום תווים חוקיים של כתובת URL

סיום	תווים	שימוש בכתובת URL
אלפאנומרי	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 X Y Z 0 1 2 3	מחרוזות טקסט, שימוש בסכמה (`http`), יציאה (`8080`) וכו'.
לא שמור	- _ . ~	מחרוזות טקסט
בוצעה הזמנה	! * ' ( ) ; : @ & = + $ , / ? % # [ ]	תווי בקרה ו/או מחרוזות טקסט

אותו עיקרון חל על כל התווים בקבוצה Reserve, אם הם מועברים בתוך מחרוזת טקסט. מידע נוסף זמין במאמר תווים מיוחדים.

בנייה של כתובת ה-URL הלא חתומה של הבקשה ללא החתימה.

חשוב לכלול גם את מזהה הלקוח בפרמטר client. למשל:

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

יצירת הבקשה החתומה

כדי לפתור בעיות, אפשר ליצור חתימה דיגיטלית באופן אוטומטי באמצעות הווידג'ט Sign a URL now הזמין.

לבקשות שנוצרות באופן דינמי נדרשת חתימה בצד השרת, שדורשת כמה שלבי ביניים נוספים

בכל מקרה, בסוף צריכה להיות לכם כתובת URL של בקשה שמצורף אליה פרמטר signature. למשל:

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

מסירים את סכימת הפרוטוקול ואת החלקים של המארח בכתובת ה-URL, ומשאירים רק את הנתיב ואת השאילתה:

/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID

הסוד לחתימה על כתובת ה-URL המוצג מקודד ב-Base64 שעבר שינוי עבור כתובות ה-URL.

רוב הספריות הקריפטוגרפיות מחייבות שהמפתח יהיה בפורמט בייט גולמי, ולכן סביר להניח שתצטרכו לפענח את סוד החתימה של כתובת ה-URL לפורמט הגולמי המקורי שלו, לפני החתימה.
חותמים על הבקשה שהוסרה שלמעלה באמצעות HMAC-SHA1.
רוב הספריות הקריפטוגרפיות יוצרות חתימה בפורמט בייטים גולמיים, ולכן תצטרכו להמיר את החתימה הבינארית שמתקבלת באמצעות Base64 שהשתנתה כדי שכתובות ה-URL ימירו אותה למשהו שניתן להעביר בתוך כתובת ה-URL.

הערה: ערך Base64 שעבר שינוי עבור כתובות URL מחליף את התווים + ו-/ של התווים הרגילים ב-Base64 ב-- וב-_ בהתאמה, כך שכבר אין צורך בקידוד של כתובות URL האלה ב-Base64.
מוסיפים את החתימה בקידוד Base64 לכתובת ה-URL המקורית שאינה חתומה בפרמטר signature. למשל:
```
https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
&signature=BASE64_SIGNATURE
```

לקבלת דוגמאות להטמעה של חתימה על כתובות URL באמצעות קוד בצד השרת, אפשר לעיין בהמשך בקטע קוד לדוגמה לחתימה על כתובת URL.

קוד לדוגמה לחתימה על כתובת URL

בקטעים הבאים מוצגות דרכים להטמעת חתימה על כתובות URL באמצעות קוד בצד השרת. כתובות URL צריכות תמיד להיות חתומות בצד השרת כדי לא לחשוף את הסוד לחתימה על כתובות URL למשתמשים.

Python

הדוגמה הבאה משתמשת בספריות Python רגילות כדי לחתום על כתובת 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))

Java

הדוגמה הבאה משתמשת במחלקה java.util.Base64 שזמינה החל מ-JDK 1.8 – ייתכן שבגרסאות ישנות יותר צריך להשתמש ב-Apache Commons או דומה. (מורידים את הקוד).

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

בדוגמה הבאה נעשה שימוש במודולים מקוריים של צומת כדי לחתום על כתובת URL. (מורידים את הקוד).

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

בדוגמה הבאה משתמשים בספריית ברירת המחדל System.Security.Cryptography כדי לחתום על בקשה לכתובת URL. שימו לב שאנחנו צריכים להמיר את קידוד ברירת המחדל של Base64 כדי להטמיע גרסה שבטוחה לכתובת URL. (מורידים את הקוד).

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-signing.

פתרון בעיות

אם הבקשה כוללת חתימה לא חוקית, ה-API יחזיר שגיאת HTTP 403 (Forbidden). השגיאה הזו צפויה בדרך כלל אם סוד החתימה ששימש לא מקושר למזהה הלקוח שהועבר, או אם קלט שאינו ASCII לא מקודד בכתובת URL לפני החתימה.

כדי לפתור את הבעיה, מעתיקים את כתובת ה-URL של הבקשה, מסירים את הפרמטר signature של השאילתה ויוצרים מחדש חתימה תקינה לפי ההוראות הבאות:

כדי ליצור חתימה דיגיטלית עם מזהה הלקוח שלך באמצעות הווידג'ט Sign a URL now (חתימת כתובת URL) שבהמשך:

מאחזרים את סוד החתימה על כתובת ה-URL של מזהה הלקוח, כפי שמתואר בשלב 1: קבלת סוד החתימה על כתובת ה-URL.
בשדה URL, מדביקים את כתובת ה-URL הלא חתומה של הבקשה משלב 2: בניית הבקשה הלא חתומה.
בשדה URL Signing Secret (סוד חתימה על כתובת URL), מדביקים את הסוד לחתימה על כתובת ה-URL משלב 2.
נוצרת חתימה דיגיטלית על סמך כתובת ה-URL הלא חתומה של הבקשה וסוד החתימה, והיא מצורפת לכתובת ה-URL המקורית.
השדה כתובת ה-URL החתומה שלך יכיל את כתובת ה-URL החתומה דיגיטלית.