راهنمای امضای دیجیتال

درخواستتان را به‌صورت دیجیتالی با کلید میانای برنامه‌سازی کاربردی امضا کنید

بسته به استفاده شما، ممکن است برای اصالت‌سنجی درخواست‌ها، علاوه‌بر کلید میانای برنامه‌سازی کاربردی، به امضای دیجیتال هم نیاز باشد. برای اطلاعات بیشتر، مقاله‌های زیر را ببینید:

نحوه عملکرد امضاهای دیجیتال

امضاهای دیجیتال از رمز امضای نشانی وب استفاده می‌کنند که در کنسول Google Cloud دردسترس است. این رمز کلیدی خصوصی است که فقط بین شما و Google هم‌رسانی می‌شود و برای پروژه شما منحصربه‌فرد است.

فرایند امضا از الگوریتم رمزگذاری برای ترکیب نشانی وب و رمز مشترک شما استفاده می‌کند. امضای یکتای حاصل به سرورهای Google امکان می‌دهد درستی‌سنجی کنند که هر سایتی که بااستفاده از کلید میانای برنامه‌سازی کاربردی شما درخواست تولید می‌کند، مجاز به انجام این کار است.

محدود کردن درخواست‌های امضانشده

برای اطمینان از اینکه کلید میانای برنامه‌سازی کاربردی شما فقط درخواست‌های امضاشده را می‌پذیرد، کارهای زیر را انجام دهید:

  1. به صفحه سهمیه‌های Google Maps Platform در کنسول Cloud بروید.
  2. از فهرست کرکره‌ای پروژه، پروژه‌ای را که هنگام ایجاد کلید میانای برنامه‌سازی کاربردی برای برنامه یا سایتتان استفاده کردید انتخاب کنید.
  3. از فهرست کرکره‌ای میاناهای برنامه‌سازی کاربردی، Maps Static API یا Street View Static API را انتخاب کنید.
  4. بخش درخواست‌های امضانشده را ازهم باز کنید.
  5. در جدول نام سهمیه، روی ویرایش در کنار سهمیه‌ای که می‌خواهید ویرایش کنید کلیک کنید، مثلاً درخواست‌های امضانشده در روز.
  6. در قاب ویرایش حد سهمیه، حد سهمیه را به‌روز کنید.
  7. روی ذخیره کلیک کنید.

درحال امضای درخواست‌های شما

امضای درخواست‌هایتان شامل مراحل زیر است:

مرحله ۱: دریافت رمز امضای نشانی وب

برای دریافت رمز امضای نشانی وب پروژه:

  1. به صفحه اطلاعات اعتباری Google Maps Platform در کنسول Cloud بروید.
  2. منوِ کرکره‌ای پروژه را انتخاب کنید و همان پروژه‌ای را انتخاب کنید که هنگام ایجاد کلید میانای API برای استفاده کردید .
  3. به‌پایین پیمایش کنید تا به کارت تولیدکننده کلید مخفی برسید. فیلد رمز فعلی حاوی رمز امضای نشانی وب فعلی شما است.
  4. این صفحه همچنین دارای ابزاره اکنون نشانی وب را امضا کنید است که به شما امکان می‌دهد به‌طور خودکار درخواست را بااستفاده از رمز امضای فعلی خود امضا کنید. به پایین پیمایش کنید تا به کارت اکنون نشانی وب را امضا کنید دسترسی پیدا کنید.

برای دریافت رمز امضای نشانی وب جدید، بازتولید رمز را انتخاب کنید. رمز قبلی ۲۴ ساعت پس‌از تولید رمز جدید منقضی خواهد شد. پس‌از گذشت ۲۴ ساعت، درخواست‌های حاوی رمز قدیمی دیگر کار نمی‌کنند.

مرحله ۲: ساختن درخواست امضانشده

نویسه‌هایی که در جدول زیر فهرست نشده‌اند باید کدبندی نشانی وب داشته باشند:

خلاصه نویسه‌های معتبر نشانی وب
به‌صفنویسه‌هااستفاده از نشانی وب
الفباعددی 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)، و غیره.
رزرو نشده است - _ . ~ رشته‌های نوشتاری
رزروشده ! * ' ( ) ; : @ & = + $ , / ? % # [ ] نویسه‌های کنترلی و/یا رشته‌های نوشتاری

همین امر برای هر نویسه‌ای در مجموعه رزروشده نیز صدق می‌کند، اگر در داخل رشته نوشتاری ارسال شوند. برای اطلاعات بیشتر، نویسه‌های خاص را ببینید.

نشانی وب درخواست امضانشده‌تان را بدون امضا بسازید. برای دستورالعمل‌ها، به مستندات توسعه‌دهنده زیر مراجعه کنید:

حتماً کلید میانای برنامه‌سازی کاربردی را نیز در پارامتر 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 در صفحه وب، یا برای عیب‌یابی، می‌توانید بااستفاده از ابزارک دردسترس اکنون نشانی وب را امضا کنید، به‌طور خودکار امضای دیجیتال تولید کنید.

برای درخواست‌های تولیدشده به‌صورت پویا، به امضای سمت سرور نیاز دارید که به چند مرحله واسطه اضافی نیاز دارد

در هر دو حالت، باید به نشانی وب درخواستی برسید که پارامتر signature به انتهای آن اضافه شده باشد. برای مثال:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
استفاده از ابزارک «اکنون نشانی وب را امضا کنید»

برای تولید امضای دیجیتال با کلید API بااستفاده از ابزاره اکنون نشانی وب را امضا کنید در کنسول Google Cloud:

  1. ابزارک اکنون نشانی وب را امضا کنید را پیدا کنید، همان‌طور که در مرحله ۱: دریافت رمز امضای نشانی وب توضیح داده شده است.
  2. در فیلد نشانی وب، نشانی وب درخواست امضانشده‌تان را از مرحله ۲: ساختن درخواست امضانشده جای‌گذاری کنید.
  3. فیلد نشانی وب امضاشده شما که ظاهر می‌شود حاوی نشانی وب امضاشده دیجیتالی شما خواهد بود. حتماً رونوشت تهیه کنید.
تولید امضاهای دیجیتال در سمت سرور

درمقایسه با ابزاره اکنون نشانی وب را امضا کنید، باید چند اقدام دیگر هنگام تولید امضاهای دیجیتال در سمت سرور انجام دهید:

  1. طرح پروتکل و بخش‌های میزبان نشانی وب را حذف کنید، و فقط مسیر و پُرسمان را باقی بگذارید:

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

  2. رمز امضای نشانی وب نمایش‌داده‌شده در Base64 اصلاح‌شده برای نشانی‌های وب کدبندی شده است.

    ازآنجایی‌که اکثر کتابخانه‌های رمزنگاری نیاز دارند که کلید در قالب بایت خام باشد، احتمالاً باید رمز امضای نشانی وب خود را قبل‌از امضا کردن به قالب خام اصلی آن رمزگشایی کنید.

  3. درخواست حذف‌شده بالا را بااستفاده از HMAC-SHA1 امضا کنید.

  4. ازآنجاکه اکثر کتابخانه‌های رمزنگاری امضا را در قالب بایت خام تولید می‌کنند، باید امضای دودویی حاصل را بااستفاده از Base64 اصلاح‌شده برای نشانی‌های وب تبدیل کنید تا به چیزی تبدیل شود که بتوان آن را در نشانی وب ارسال کرد.

  5. امضای کدبندی‌شده با Base64 را به نشانی وب درخواست امضانشده اصلی در پارامتر signature اضافه کنید. برای مثال:

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

برای نمونه‌هایی که روش‌های پیاده‌سازی امضای نشانی وب را بااستفاده از کد سمت سرور نشان می‌دهند، کد نمونه برای امضای نشانی وب را در زیر ببینید.

کد نمونه برای امضای نشانی وب

بخش‌های زیر روش‌های پیاده‌سازی امضای نشانی وب را بااستفاده از کد سمت سرور نشان می‌دهند. نشانی‌های وب باید همیشه در سمت سرور امضا شوند تا رمز امضای نشانی وب شما برای کاربران فاش نشود.

Python

مثال زیر از کتابخانه‌های استاندارد Python برای امضای نشانی وب استفاده می‌کند. (کد را بارگیری کنید.)

#!/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.util.Base64 استفاده می‌کند که از نسخه ۱.۸ کیت توسعه جاوا دردسترس است - نسخه‌های قدیمی‌تر ممکن است نیاز به استفاده از 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 بومی برای امضای نشانی وب استفاده می‌کند. (کد را بارگیری کنید.)

'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 برای امضای درخواست نشانی وب استفاده می‌کند. توجه داشته باشید که باید کدبندی Base64 پیش‌فرض را تبدیل کنیم تا نسخه URL-safe را پیاده‌سازی کنیم. (کد را بارگیری کنید.)

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) را برمی‌گرداند. این خطا به احتمال زیاد زمانی رخ می‌دهد که رمز امضای استفاده‌شده به کلید میانای برنامه‌سازی کاربردی ارسال‌شده پیوند داده نشده باشد، یا اگر ورودی غیرASCII قبل‌از امضا کردن، کدگذاری URL نشده باشد.

برای عیب‌یابی مشکل، نشانی وب درخواست را کپی کنید، پارامتر پُرسمان signature را حذف کنید، و طبق دستورالعمل‌های زیر امضای معتبری را بازتولید کنید:

برای تولید امضای دیجیتال با کلید API بااستفاده از ابزاره اکنون نشانی وب را امضا کنید در کنسول Google Cloud:

  1. ابزارک اکنون نشانی وب را امضا کنید را پیدا کنید، همان‌طور که در مرحله ۱: دریافت رمز امضای نشانی وب توضیح داده شده است.
  2. در فیلد نشانی وب، نشانی وب درخواست امضانشده‌تان را از مرحله ۲: ساختن درخواست امضانشده جای‌گذاری کنید.
  3. فیلد نشانی وب امضاشده شما که ظاهر می‌شود حاوی نشانی وب امضاشده دیجیتالی شما خواهد بود. حتماً رونوشت تهیه کنید.