שימוש בחתימה דיגיטלית

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

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

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

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

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

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

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

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

לפני שמתחילים

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

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

כדי לחתום על הבקשות, צריך לבצע את השלבים הבאים:

שלב 1: מקבלים את מפתח החתימה לכתובת ה-URL

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

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

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

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

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

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

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

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&zoom=12&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&zoom=12&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
שימוש בווידג'ט Sign a URL now (חתימה על כתובת URL עכשיו)

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

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

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

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

    2. /maps/api/staticmap?center=Z%C3%BCrich&zoom=12&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&zoom=12&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 available מאז 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

בדוגמה שלמטה נעשה שימוש במודולים מקוריים של Node כדי לחתום על כתובת 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. מאתרים את הווידג'ט Sign a URL now (חתימה על כתובת URL עכשיו), כמו שמתואר בשלב 1: קבלת מפתח חתימה לכתובת URL.
  2. בשדה URL, מדביקים את כתובת ה-URL של הבקשה הלא חתומה משלב 2: יצירת הבקשה הלא חתומה.
  3. בשדה כתובת ה-URL החתומה שלך שמופיע תופיע כתובת ה-URL החתומה דיגיטלית. חשוב ליצור עותק.