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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

סיכום תווים חוקיים של כתובת URL
סיוםתוויםשימוש בכתובת URL
אלפאנומרי a b c d f g h i j k l m. מ י ד י נ ת ח י ם A B C D E F G H I J K L M N O P Q R S T U W X Y Z 0 1 2 3 4 5 6 7 8 9 מחרוזות טקסט, שימוש בסכמה (http), יציאה (8080) וכו'.
לא שמור - _ . ~ מחרוזות טקסט
בוצעה הזמנה ! * ' ( ) ; : @ & = + $ , / ? % # [ ] תווי בקרה ו/או מחרוזות טקסט

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

בנייה של כתובת ה-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 ב או כדי לפתור בעיות, תוכלו ליצור חתימה דיגיטלית באופן אוטומטי באמצעות הווידג'ט חתימה על כתובת URL עכשיו.

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

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

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

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

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

בהשוואה לווידג'ט חתימה על כתובת 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 לכתובת האתר המקורית שאינה חתומה ב- הפרמטר 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 שזמינה מאז 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)). סביר להניח שהשגיאה הזאת מתרחשת אם נעשה שימוש בחתימה הסוד לא מקושר למפתח ה-API שהועבר, או אם קלט שאינו ASCII לא מקודד בכתובת URL לפני החתימה.

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

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

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