การลงนามคําขอรหัสไคลเอ็นต์

สำคัญ: แพ็กเกจพรีเมียมของ Google Maps Platform ไม่มีให้ใช้งานสำหรับ ลงชื่อสมัครใช้หรือลูกค้าใหม่

ลายเซ็นดิจิทัล

วิธีการทำงานของลายเซ็นดิจิทัล

ลายเซ็นดิจิทัลสร้างขึ้นโดยใช้ข้อมูลลับในการลงชื่อ URL หรือคีย์การเข้ารหัส ซึ่งมีอยู่ที่ คอนโซล Google Cloud ข้อมูลลับนี้เป็นคีย์ส่วนตัว ซึ่งมีการแชร์เท่านั้น ระหว่างคุณกับ Google และเป็นเอกลักษณ์เฉพาะ รหัสไคลเอ็นต์

ขั้นตอนการลงนามใช้อัลกอริทึมการเข้ารหัสเพื่อรวม URL กับ ข้อมูลลับที่ใช้ร่วมกัน ลายเซ็นที่ไม่ซ้ำกันที่ได้จะทำให้เซิร์ฟเวอร์ของเราสามารถยืนยัน ว่าเว็บไซต์ใดก็ตามสร้างคำขอโดยใช้ รหัสไคลเอ็นต์ ได้รับอนุญาตให้ทำเช่นนั้น

การเซ็นชื่อคำขอ

การเซ็นชื่อคำขอมีขั้นตอนดังนี้

• ขั้นตอนที่ 1 รับข้อมูลลับในการรับรอง URL
• ขั้นตอนที่ 2 สร้างคำขอที่ไม่ได้ลงชื่อ
• ขั้นตอนที่ 3 สร้างคำขอที่ลงนามแล้ว

ขั้นตอนที่ 1: รับข้อมูลลับในการลงทะเบียน URL

หากต้องการรับข้อมูลลับในการรับรอง URL ของโปรเจ็กต์ ให้ทำดังนี้

1. ไปที่หน้า หน้ารหัสไคลเอ็นต์ ใน Cloud Console
2. ช่อง Key จะมีข้อมูลลับในการรับรอง URL ของรหัสไคลเอ็นต์ปัจจุบัน

หากคุณต้องการสร้างข้อมูลลับในการลงทะเบียน URL รหัสไคลเอ็นต์ใหม่ ติดต่อทีมสนับสนุน

ขั้นตอนที่ 2: สร้างคำขอที่ไม่ได้ลงชื่อ

อักขระที่ไม่แสดงในตารางด้านล่างต้องเข้ารหัส URL

เช่นเดียวกันกับทุกอักขระในชุดสงวนไว้ หากมีการส่งผ่านภายในข้อความ สตริง สำหรับข้อมูลเพิ่มเติม โปรดดู สัญลักษณ์พิเศษ

สร้าง 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

1. ตัดรูปแบบโปรโตคอลและส่วนโฮสต์ของ URL ออก เหลือเฉพาะเส้นทางและข้อความค้นหา:

/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID

2. ข้อมูลลับในการลงทะเบียน URL ที่แสดงมีการเข้ารหัสในรูปแบบที่แก้ไข Base64 สําหรับ URL

   เนื่องจากไลบรารีการเข้ารหัสส่วนใหญ่กำหนดให้คีย์อยู่ในรูปแบบไบต์ดิบ คุณจึงมีแนวโน้ม ต้องถอดรหัสข้อมูลลับในการลงทะเบียน URL ของคุณเป็นรูปแบบข้อมูลดิบต้นฉบับก่อนที่จะลงนาม

3. ลงนามในคำขอที่ถูกตัดข้างต้นโดยใช้ HMAC-SHA1

4. เนื่องจากไลบรารีการเข้ารหัสส่วนใหญ่จะสร้างลายเซ็นในรูปแบบไบต์ดิบ คุณจึงต้อง แปลงลายเซ็นไบนารีที่ได้ โดยใช้คำสั่งที่แก้ไข Base64 สำหรับ URL ที่จะแปลง ลงในสิ่งที่สามารถส่งผ่านภายใน URL ได้

5. เพิ่มลายเซ็นที่เข้ารหัส 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 Signing ด้านล่าง

โค้ดตัวอย่างสำหรับ URL Signing

ส่วนต่อไปนี้จะแสดงวิธีติดตั้ง URL Signing โดยใช้ โค้ดฝั่งเซิร์ฟเวอร์ URL ต้องมีการรับรองในฝั่งเซิร์ฟเวอร์เสมอเพื่อหลีกเลี่ยง เปิดเผยข้อมูลลับในการลงทะเบียน 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))

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;
  }
}

'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;
}

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 ก่อนลงนาม

หากต้องการแก้ปัญหานี้ ให้คัดลอก URL คำขอ นำการค้นหา signature ออก และสร้างลายเซ็นที่ถูกต้องใหม่โดยทำตามวิธีการด้านล่าง

เพื่อสร้างลายเซ็นดิจิทัลด้วย รหัสลูกค้าของคุณ โดยใช้วิดเจ็ต Sign a URL now ด้านล่าง

1. ดึงข้อมูลลับในการลงทะเบียน URL รหัสไคลเอ็นต์ของคุณ ตามที่อธิบายไว้ในขั้นตอนที่ 1: รับข้อมูลลับในการลงทะเบียน URL
2. ในช่อง URL ให้วาง URL คำขอที่ไม่ได้ลงชื่อจาก ขั้นตอนที่ 2: สร้างคำขอที่ไม่ได้ลงชื่อ
3. ในช่อง URL Signing Secret ให้วางข้อมูลลับในการลงทะเบียน URL จากขั้นตอนที่ 2
   ระบบจะสร้างลายเซ็นดิจิทัลตาม URL คำขอที่ไม่ได้ลงชื่อและข้อมูลลับที่ลงนาม และต่อท้าย URL เดิมของคุณ
4. ช่อง URL ที่ลงชื่อที่ปรากฏจะมี URL ที่ลงชื่อแบบดิจิทัลของคุณ