מדריך לחתימה דיגיטלית

חתימה דיגיטלית על הבקשה באמצעות מפתח API

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

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

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

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

הגבלת בקשות לא חתומות

כדי לוודא שמפתח ה-API מקבל רק בקשות חתומות:

  1. נכנסים לדף Quotas Platform של מפות Google במסוף Cloud.
  2. לוחצים על התפריט הנפתח של הפרויקט ובוחרים את הפרויקט שבו השתמשתם כשיצרתם את מפתח ה-API לאפליקציה או לאתר.
  3. בתפריט הנפתח של ממשקי ה-API, בוחרים באפשרות Maps Static API או Street View Static API.
  4. מרחיבים את הקטע בקשות לא חתומות.
  5. בטבלה Quota Name לוחצים על לחצן העריכה ליד המכסה שרוצים לערוך. לדוגמה, בקשות לא חתומות ביום.
  6. מעדכנים את Quota limit בחלונית Edit Quota Limit.
  7. לוחצים על שמירה.

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

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

שלב 1: משיגים את הסוד לחתימה על כתובת ה-URL

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

  1. נכנסים לדף Google Maps Platform Credentials במסוף Cloud.
  2. בוחרים את התפריט הנפתח של הפרויקט ובוחרים את אותו הפרויקט שבו השתמשתם כשיצרתם את מפתח ה-API עבור Maps Static API או Street View Static API.
  3. גוללים למטה לכרטיס Secret Generator. השדה הסוד הנוכחי מכיל את הסוד לחתימה על כתובת ה-URL הנוכחית.
  4. הדף כולל גם את הווידג'ט חתימה על כתובת URL, שמאפשר לחתום באופן אוטומטי על בקשת ה-API הסטטי של מפות Google או על בקשת ה-Street View Static API באמצעות סוד החתימה הנוכחי. גוללים למטה לכרטיס חתימה על כתובת URL כדי לגשת אליו.

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

שלב 2: יצירת הבקשה הלא חתומה

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

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

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

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

חשוב לכלול גם את מפתח ה-API בפרמטר key. למשל:

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 של הבקשה עם פרמטר signature בסוף. למשל:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
באמצעות הווידג'ט 'חתימה על כתובת URL עכשיו'

כדי ליצור חתימה דיגיטלית עם מפתח API באמצעות הווידג'ט Sign a URL now במסוף Google Cloud:

  1. מוצאים את הווידג'ט חתימה על כתובת URL, כפי שמתואר בשלב 1: קבלת הסוד לחתימה על כתובת ה-URL.
  2. בשדה URL מדביקים את כתובת ה-URL של הבקשה הלא חתומה משלב 2: בניית הבקשה הלא חתומה.
  3. השדה כתובת ה-URL החתומה שיופיע יכיל את כתובת ה-URL עם החתימה הדיגיטלית. חשוב ליצור עותק.
יצירת חתימות דיגיטליות בצד השרת

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

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

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

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

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

  3. חותמים על הבקשה שהוסרה באמצעות HMAC-SHA1.

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

  5. יש לצרף את החתימה בקידוד Base64 לכתובת ה-URL המקורית של הבקשה הלא חתומה בפרמטר signature. למשל:

    https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&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 הזמין החל מגרסה 1.8 של JDK. יכול להיות שבגרסאות ישנות יותר יהיה צורך להשתמש ב-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). סביר להניח שהשגיאה הזו תופיע אם סוד החתימה שבשימוש לא מקושר למפתח ה-API שהועבר, או אם קלט שאינו ASCII לא מקודד בכתובת ה-URL לפני החתימה.

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

כדי ליצור חתימה דיגיטלית עם מפתח API באמצעות הווידג'ט Sign a URL now במסוף Google Cloud:

  1. מוצאים את הווידג'ט חתימה על כתובת URL, כפי שמתואר בשלב 1: קבלת הסוד לחתימה על כתובת ה-URL.
  2. בשדה URL מדביקים את כתובת ה-URL של הבקשה הלא חתומה משלב 2: בניית הבקשה הלא חתומה.
  3. השדה כתובת ה-URL החתומה שיופיע יכיל את כתובת ה-URL עם החתימה הדיגיטלית. חשוב ליצור עותק.