تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

توقيع طلب معرّف العميل

ملاحظة مهمة: لم تعد الخطة المميّزة في "منصة خرائط Google" متاحة للاشتراك أو للعملاء الجدد.

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

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

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

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

توقيع طلباتك

يتضمن توقيع طلباتك الخطوات التالية:

الخطوة 1: الحصول على المفتاح السرّي لتوقيع عنوان URL
الخطوة 2: إنشاء طلب غير موقَّع
الخطوة 3: إنشاء الطلب الموقَّع

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

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

انتقِل إلى صفحة Client ID في Cloud Console.
يحتوي حقل المفتاح على المفتاح السرّي لتوقيع عنوان URL الحالي لمعرّف العميل.

إذا كنت بحاجة إلى إعادة إنشاء كلمة سرّية لتوقيع عنوان URL لمعرّف العميل، يُرجى التواصل مع فريق الدعم.

الخطوة 2: إنشاء الطلب الذي لم يتم توقيعه

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

ملخّص أحرف عنوان URL الصالحة

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

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

يمكنك إنشاء عنوان URL للطلب الذي لم يتم توقيعه بدون التوقيع.

احرص أيضًا على تضمين معرّف العميل في المعلَمة client. مثلاً:

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

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

لأغراض تحديد المشاكل وحلّها، يمكنك إنشاء توقيع رقمي تلقائيًا باستخدام الأداة المتاحة توقيع عنوان URL الآن.

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

في كلتا الحالتين، من المفترض أن يظهر لك عنوان 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 بعنوان 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

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

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