डिजिटल हस्ताक्षर की गाइड

एपीआई पासकोड की मदद से, अपने अनुरोध पर डिजिटल हस्ताक्षर करना

आपके इस्तेमाल के हिसाब से, अनुरोधों की पुष्टि करने के लिए, एपीआई पासकोड के साथ-साथ डिजिटल हस्ताक्षर की ज़रूरत पड़ सकती है. ये लेख पढ़ें:

डिजिटल हस्ताक्षर कैसे काम करते हैं

डिजिटल हस्ताक्षर, यूआरएल साइनिंग पासकोड का इस्तेमाल करके जनरेट किए जाते हैं. यह पासकोड, Google Cloud Console पर उपलब्ध होता है. यह पासकोड, असल में एक निजी पासकोड होता है. इसे सिर्फ़ आपके और Google के बीच शेयर किया जाता है. साथ ही, यह आपके प्रोजेक्ट के लिए यूनीक होता है.

हस्ताक्षर करने की प्रोसेस में, एन्क्रिप्शन एल्गोरिदम का इस्तेमाल करके, यूआरएल और आपके शेयर किए गए पासवर्ड को जोड़ा जाता है. इस यूनीक हस्ताक्षर की मदद से, हमारे सर्वर यह पुष्टि कर पाते हैं कि आपकी एपीआई पासकोड का इस्तेमाल करके अनुरोध जनरेट करने वाली किसी भी साइट के पास ऐसा करने की अनुमति है या नहीं.

बिना हस्ताक्षर वाले अनुरोधों को सीमित करना

यह पक्का करने के लिए कि आपकी एपीआई पासकोड सिर्फ़ साइन किए गए अनुरोध स्वीकार करता है:

  1. Cloud Console में, Google Maps Platform के कोटा पेज पर जाएं.
  2. प्रोजेक्ट के ड्रॉप-डाउन पर क्लिक करें और वही प्रोजेक्ट चुनें जिसका इस्तेमाल आपने अपने ऐप्लिकेशन या साइट के लिए एपीआई पासकोड बनाते समय किया था.
  3. एपीआई ड्रॉप-डाउन से, Maps Static API या Street View Static API चुनें.
  4. बिना हस्ताक्षर वाले अनुरोध सेक्शन को बड़ा करें.
  5. कोटा का नाम टेबल में, उस कोटा के बगल में मौजूद 'बदलाव करें' बटन पर क्लिक करें जिसमें आपको बदलाव करना है. उदाहरण के लिए, हर दिन मिलने वाले ऐसे अनुरोध जिन पर हस्ताक्षर नहीं किए गए हैं.
  6. तय सीमा में बदलाव करें पैनल में, कोटा की सीमा अपडेट करें.
  7. सेव करें को चुनें.

अपने अनुरोधों पर हस्ताक्षर करना

अपने अनुरोधों पर हस्ताक्षर करने के लिए, यह तरीका अपनाएं:

पहला चरण: यूआरएल साइन करने के लिए पासकोड पाना

अपने प्रोजेक्ट के यूआरएल का साइनिंग सीक्रेट पाने के लिए:

  1. Cloud Console में, Google Maps Platform के क्रेडेंशियल पेज पर जाएं.
  2. प्रोजेक्ट ड्रॉप-डाउन चुनें और वही प्रोजेक्ट चुनें जिसका इस्तेमाल आपने Maps Static API या Street View Static API के लिए, एपीआई पासकोड बनाने के समय किया था.
  3. नीचे की ओर स्क्रोल करके, सीक्रेट जनरेटर कार्ड पर जाएं. मौजूदा पासवर्ड फ़ील्ड में, यूआरएल को हस्ताक्षर करने के लिए इस्तेमाल किया जाने वाला मौजूदा पासवर्ड होता है.
  4. इस पेज पर अभी यूआरएल पर हस्ताक्षर करें विजेट भी मौजूद है. इसकी मदद से, Maps Static API या Street View Static API के अनुरोध पर अपने मौजूदा पासवर्ड का इस्तेमाल करके, अपने-आप हस्ताक्षर किया जा सकता है. इसे ऐक्सेस करने के लिए, नीचे की ओर स्क्रोल करके अभी यूआरएल पर हस्ताक्षर करें कार्ड पर जाएं.

यूआरएल साइनिंग सीक्रेट का नया पासवर्ड पाने के लिए, सीक्रेट फिर से जनरेट करें को चुनें. नया सीक्रेट जनरेट करने के 24 घंटे बाद, पुराना सीक्रेट इस्तेमाल नहीं किया जा सकेगा. 24 घंटे बाद, पुराने सीक्रेट वाले अनुरोध काम नहीं करते.

दूसरा चरण: बिना हस्ताक्षर वाला अनुरोध बनाना

नीचे दी गई टेबल में नहीं दिए गए वर्णों को कोड में बदलना ज़रूरी है:

यूआरएल में इस्तेमाल किए जा सकने वाले वर्ण
सेट करेंवर्णयूआरएल का इस्तेमाल
अक्षर और अंक 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
'अभी साइन करें' विजेट का इस्तेमाल करना

Google Cloud Console में अभी यूआरएल पर हस्ताक्षर करें विजेट का इस्तेमाल करके, एपीआई पासकोड की मदद से डिजिटल हस्ताक्षर जनरेट करने के लिए:

  1. अभी यूआरएल पर हस्ताक्षर करें विजेट ढूंढें, जैसा कि पहला चरण: यूआरएल पर हस्ताक्षर करने के लिए पासकोड पाना में बताया गया है.
  2. यूआरएल फ़ील्ड में, बिना हस्ताक्षर वाला अनुरोध यूआरएल चिपकाएं. यह यूआरएल, दूसरा चरण: बिना हस्ताक्षर वाला अनुरोध बनाना से लें.
  3. आपका हस्ताक्षर वाला यूआरएल फ़ील्ड में, डिजिटल हस्ताक्षर वाला यूआरएल दिखेगा. इसकी कॉपी ज़रूर बनाएं.
सर्वर-साइड पर डिजिटल हस्ताक्षर जनरेट करना

अभी यूआरएल पर हस्ताक्षर करें विजेट की तुलना में, आपको सर्वर साइड पर डिजिटल हस्ताक्षर जनरेट करते समय कुछ और कार्रवाइयां करनी होंगी:

  1. यूआरएल के प्रोटोकॉल स्कीम और होस्ट वाले हिस्सों को हटाएं और सिर्फ़ पाथ और क्वेरी को छोड़ दें:

  2. /maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
    
  3. यूआरएल के लिए, दिखाया गया यूआरएल साइनिंग सीक्रेट, बदले गए Base64 में एन्कोड किया गया है.

    ज़्यादातर क्रिप्टोग्राफ़िक लाइब्रेरी के लिए, पासकोड को रॉ बाइट फ़ॉर्मैट में होना ज़रूरी है. इसलिए, आपको हस्ताक्षर करने से पहले, यूआरएल के हस्ताक्षर वाले पासकोड को उसके मूल रॉ फ़ॉर्मैट में डिकोड करना पड़ सकता है.

  4. HMAC-SHA1 का इस्तेमाल करके, ऊपर दिए गए अनुरोध पर हस्ताक्षर करें.
  5. ज़्यादातर क्रिप्टोग्राफ़िक लाइब्रेरी, रॉ बाइट फ़ॉर्मैट में हस्ताक्षर जनरेट करती हैं. इसलिए, आपको यूआरएल के लिए, बदले गए Base64 का इस्तेमाल करके, बाइनरी हस्ताक्षर को बदलना होगा, ताकि इसे यूआरएल में पास किया जा सके.

  6. signature पैरामीटर में, हस्ताक्षर न किए गए ओरिजनल अनुरोध यूआरएल में, Base64 में एन्कोड किए गए हस्ताक्षर को जोड़ें. उदाहरण के लिए:

    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

नीचे दिए गए उदाहरण में, JDK 1.8 से उपलब्ध 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 कोड को बदलना होगा. (कोड को डाउनलोड करें.)

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) गड़बड़ी दिखाता है. आम तौर पर, यह गड़बड़ी तब होती है, जब साइन करने के लिए इस्तेमाल किया गया पासकोड, पास की गई एपीआई पासकोड से लिंक न हो या साइन करने से पहले, नॉन-एससीआई इनपुट को यूआरएल-एन्कोड न किया गया हो.

समस्या को हल करने के लिए, अनुरोध का यूआरएल कॉपी करें और signature क्वेरी पैरामीटर को हटाएं. इसके बाद, नीचे दिए गए निर्देशों का पालन करके मान्य हस्ताक्षर फिर से जनरेट करें:

Google Cloud Console में, अभी यूआरएल पर हस्ताक्षर करें विजेट का इस्तेमाल करके, एपीआई पासकोड की मदद से डिजिटल हस्ताक्षर जनरेट करने के लिए:

  1. अभी यूआरएल पर हस्ताक्षर करें विजेट ढूंढें, जैसा कि पहला चरण: यूआरएल पर हस्ताक्षर करने के लिए पासकोड पाना में बताया गया है.
  2. यूआरएल फ़ील्ड में, बिना हस्ताक्षर वाला अनुरोध यूआरएल चिपकाएं. यह यूआरएल, दूसरा चरण: बिना हस्ताक्षर वाला अनुरोध बनाएं से पाया जा सकता है.
  3. आपका हस्ताक्षर वाला यूआरएल फ़ील्ड में, डिजिटल हस्ताक्षर वाला यूआरएल दिखेगा. इसकी कॉपी ज़रूर बनाएं.