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

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

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

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

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

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

साइन नहीं किए गए अनुरोधों की संख्या सीमित करें

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

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

आपके अनुरोधों पर हस्ताक्षर किया जा रहा है

अनुरोधों पर हस्ताक्षर करने के ये चरण होते हैं:

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

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

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

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

दूसरा चरण: साइन न किया गया अनुरोध तैयार करना

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

मान्य यूआरएल वर्णों के बारे में खास जानकारी
सेट करेंवर्णयूआरएल का इस्तेमाल
अक्षर और अंक अ ख दू ना प रा ग ग ता है ए बी सी डी ई एफ़ जी एच आई जे के एल एम न ओ पी क्यू री एस टी यू डब्ल्यू डब्ल्यू एक्स वाई ज़ेड 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

हस्ताक्षर किया गया अनुरोध जनरेट करें

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

डाइनैमिक रूप से जनरेट होने वाले अनुरोधों के लिए, आपको सर्वर-साइड की ज़रूरत होगी साइन अप करने के लिए, आपको कुछ और इंटरमीडिएट चरण पूरे करने होंगे

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

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
'यूआरएल पर अभी हस्ताक्षर करें' विजेट का इस्तेमाल करना

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

  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 पैरामीटर. उदाहरण के लिए:

    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

नीचे दिए गए उदाहरण में, उपलब्ध 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

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

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

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

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

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