دليل التوقيع الرقمي

توقيع طلبك رقميًا باستخدام مفتاح واجهة برمجة التطبيقات

بناءً على معدّل استخدامك، قد يُطلب منك توقيع رقمي، بالإضافة إلى مفتاح واجهة برمجة التطبيقات، لمصادقة الطلبات. اطّلِع على المقالات التالية:

آلية عمل التوقيعات الرقمية

يتم إنشاء التوقيعات الرقمية باستخدام سر توقيع عنوان URL المتاح على Google Cloud Console. هذا المفتاح السرّي هو في الأساس مفتاح خاص، تتم مشاركته بينك وبين Google فقط، وهو فريد لمشروعك.

تستخدم عملية التوقيع خوارزمية تشفير للجمع بين عنوان URL والمفتاح السري المشترك. ويتيح التوقيع الفريد الناتج لخوادمنا التحقق من أنّ أي موقع إلكتروني ينشئ طلبات باستخدام مفتاح واجهة برمجة التطبيقات مسموح له بذلك.

الحدّ من الطلبات غير الموقَّعة

للتأكّد من أنّ مفتاح واجهة برمجة التطبيقات لا يقبل سوى الطلبات الموقَّعة:

  1. انتقِل إلى صفحة حصص "منصة خرائط Google" في Cloud Console.
  2. انقر على القائمة المنسدلة للمشروع واختَر المشروع نفسه الذي استخدمته عند إنشاء مفتاح واجهة برمجة التطبيقات لتطبيقك أو موقعك الإلكتروني.
  3. اختر واجهة برمجة التطبيقات الثابتة للخرائط أو واجهة برمجة التطبيقات الثابتة لميزة "التجوّل الافتراضي" من القائمة المنسدلة لواجهات برمجة التطبيقات.
  4. وسِّع قسم الطلبات غير المُوقَّعة.
  5. في جدول اسم الحصة، انقر على زر التعديل بجانب الحصة التي تريد تعديلها. على سبيل المثال، الطلبات غير المُوقَّعة في اليوم.
  6. عدِّل حدّ الحصة في لوحة تعديل الحدّ الأقصى للحصة.
  7. انقر على حفظ.

توقيع طلباتك

يتألف توقيع الطلبات من الخطوات التالية:

الخطوة 1: الحصول على الرمز السري لتوقيع عنوان URL

للحصول على سر توقيع عنوان URL للمشروع:

  1. انتقِل إلى صفحة بيانات الاعتماد في "منصة خرائط Google" في Cloud Console.
  2. اختَر القائمة المنسدلة للمشروع واختَر المشروع نفسه الذي استخدمته عند إنشاء مفتاح واجهة برمجة التطبيقات لـ Maps Static API أو Street View Static API.
  3. انتقِل للأسفل وصولاً إلى بطاقة المنشئ السري. يحتوي الحقل السؤال السرّي الحالي على الرمز السرّي الحالي لتوقيع عنوان URL.
  4. تحتوي الصفحة أيضًا على أداة تسجيل عنوان URL الآن التي تسمح لك بالتوقيع تلقائيًا على طلب واجهة برمجة التطبيقات الثابتة لـ "خرائط Google" أو واجهة برمجة التطبيقات الثابتة لميزة "التجوّل الافتراضي" باستخدام كلمة المرور الثابتة الحالية. انتقِل للأسفل وصولاً إلى بطاقة توقيع عنوان URL الآن.

للحصول على مفتاح سرّي جديد لتوقيع عنوان URL، اختَر إعادة إنشاء السر. ستنتهي صلاحية المفتاح السرّي السابق بعد 24 ساعة من إنشاء مفتاح سرّي جديد. بعد مرور 24 ساعة، لن تعود الطلبات التي تتضمّن السر القديم صالحة.

الخطوة 2: إنشاء طلبك غير الموقَّع

إنّ الأحرف التي غير الواردة في الجدول أدناه يجب أن تكون بترميز عنوان URL:

ملخّص أحرف عناوين URL الصالحة
ضبطالأحرفاستخدام عنوان URL
أحرف أبجدية رقمية ب السلاسل النصية واستخدام المخطط (http) والمنفذ (8080) وما إلى ذلك
غير محجوز - _ . ~ السلاسل النصية
تم الحجز ! * ' ( ) ; : @ & = + $ , / ? % # [ ] أحرف التحكّم و/أو سلاسل النص

وينطبق ذلك أيضًا على أي أحرف في المجموعة محجوزة، إذا تم تمريرها داخل سلسلة نصية. لمزيد من المعلومات، يمكنك الاطّلاع على الرموز الخاصة.

يمكنك إنشاء عنوان URL لطلبك غير الموقَّع بدون التوقيع. للحصول على التعليمات، اطّلِع على مستندات المطوّرين التالية:

تأكَّد أيضًا من تضمين مفتاح واجهة برمجة التطبيقات في المعلَمة key. مثال:

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

إنشاء الطلب المُوقَّع

بالنسبة إلى حالات الاستخدام لمرة واحدة، مثل استضافة صورة واجهة برمجة تطبيقات ثابتة في "خرائط Google" أو صورة واجهة برمجة تطبيقات ثابتة لميزة "التجوّل الافتراضي" على صفحة الويب الخاصة بك أو لأغراض تحديد المشاكل وحلّها، يمكنك إنشاء توقيع رقمي تلقائيًا باستخدام أداة تسجيل عنوان URL الآن المتاحة.

بالنسبة إلى الطلبات التي يتم إنشاؤها ديناميكيًا، تحتاج إلى التوقيع من جهة الخادم، ما يتطلّب بضع خطوات وسيطة إضافية.

وفي كلتا الحالتَين، من المفترض أن ينتهي بك الأمر إلى الحصول على عنوان URL للطلب يحتوي على مَعلمة signature ملحقة بنهايةه. مثال:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
استخدام أداة "توقيع عنوان URL الآن"

لإنشاء توقيع رقمي باستخدام مفتاح واجهة برمجة التطبيقات باستخدام الأداة توقيع عنوان URL الآن في Google Cloud Console:

  1. حدِّد موقع أداة توقيع عنوان 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
    
  3. يتم ترميز سر توقيع عنوان URL المعروض في Base64 معدَّل لعناوين URL.

    بما أنّ معظم مكتبات التشفير تتطلّب أن يكون المفتاح بتنسيق بايت غير معدَّل، ستحتاج على الأرجح إلى فك ترميز الرمز السري لتوقيع عنوان URL إلى تنسيقه الأولي الأصلي قبل التوقيع.

  4. وقِّع على الطلب المجرد أعلاه باستخدام HMAC-SHA1.
  5. بما أنّ معظم مكتبات التشفير تنشئ توقيعًا بتنسيق بايت أولي، ستحتاج إلى تحويل التوقيع الثنائي الناتج باستخدام Base64 المعدّل لعناوين URL لتحويله إلى عنصر يمكن تمريره داخل عنوان URL.

  6. ألحِق التوقيع بترميز 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

يستخدم المثال أدناه مكتبات بايثون القياسية لتوقيع عنوان 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.

تحديد المشاكل وحلّها

وإذا كان الطلب يتضمّن توقيعًا غير صالح، ستعرض واجهة برمجة التطبيقات الخطأ HTTP 403 (Forbidden). يحدث هذا الخطأ على الأرجح إذا لم يكن مفتاح التوقيع السرّي المستخدم مرتبطًا بمفتاح واجهة برمجة التطبيقات الذي تم تمريره، أو إذا لم يتم ترميز الإدخال بغير ASCII بعنوان URL قبل التوقيع.

لتحديد المشكلة وحلّها، انسخ عنوان URL للطلب وأزِل معلَمة طلب البحث signature ثم أعِد إنشاء توقيع صالح باتّباع التعليمات التالية:

لإنشاء توقيع رقمي باستخدام مفتاح واجهة برمجة التطبيقات باستخدام الأداة توقيع عنوان URL الآن في Google Cloud Console:

  1. حدِّد موقع أداة توقيع عنوان URL الآن، كما هو موضّح في الخطوة 1: الحصول على المفتاح السري لتوقيع عنوان URL.
  2. في حقل عنوان URL، الصِق عنوان URL الخاص بالطلب الذي لم يتم توقيعه من الخطوة 2: إنشاء الطلب غير الموقَّع.
  3. سيحتوي حقل عنوان URL الموقَّع الذي سيظهر على عنوان URL الموقَّع رقميًا. احرص على إنشاء نسخة منه.