Hướng dẫn chữ ký số

Ký yêu cầu bằng kỹ thuật số bằng khóa API

Tuỳ thuộc vào cách sử dụng của bạn, có thể cần có chữ ký số (ngoài khoá API) để xác thực yêu cầu. Hãy xem các bài viết sau:

Cách thức hoạt động của chữ ký số

Chữ ký số được tạo bằng bí mật ký URL. URL này có trên Google Cloud Console. Về cơ bản, khóa bí mật này là một khóa riêng tư, chỉ được chia sẻ giữa bạn và Google và là duy nhất của dự án.

Quá trình ký sẽ sử dụng một thuật toán mã hóa để kết hợp URL và khóa bí mật dùng chung của bạn. Chữ ký duy nhất thu được sẽ cho phép máy chủ của chúng tôi xác minh rằng mọi trang web tạo yêu cầu bằng khoá API của bạn đều được phép thực hiện việc này.

Hạn chế các yêu cầu không được ký

Để đảm bảo rằng khoá API chỉ chấp nhận các yêu cầu đã ký:

  1. Truy cập vào trang Hạn mức của Google Maps Platform trong Cloud Console.
  2. Nhấp vào trình đơn thả xuống của dự án rồi chọn chính dự án mà bạn đã sử dụng khi tạo khóa API cho ứng dụng hoặc trang web của mình.
  3. Chọn API tĩnh của Maps hoặc API tĩnh của Chế độ xem phố từ menu thả xuống API.
  4. Mở rộng mục Yêu cầu chưa ký.
  5. Trong bảng Quota Name (Tên hạn mức), hãy nhấp vào nút chỉnh sửa bên cạnh hạn mức mà bạn muốn chỉnh sửa. Ví dụ: Số yêu cầu không ký mỗi ngày.
  6. Cập nhật phần Giới hạn định mức trong ngăn Chỉnh sửa giới hạn định mức.
  7. Chọn Lưu.

Ký yêu cầu của bạn

Việc ký yêu cầu của bạn bao gồm các bước sau:

Bước 1: Nhận bí mật ký URL của bạn

Cách nhận thông tin mật về URL ký dự án:

  1. Truy cập vào trang Thông tin đăng nhập của Nền tảng Google Maps trong Cloud Console.
  2. Chọn trình đơn thả xuống của dự án rồi chọn chính dự án mà bạn đã sử dụng khi tạo khoá API cho Maps Static API hoặc Chế độ xem phố API tĩnh.
  3. Cuộn xuống thẻ Trình tạo bí mật. Trường Thông tin hiện tại chứa thông tin mật về URL hiện tại của bạn.
  4. Trang này cũng có tiện ích Ký URL ngay bây giờ cho phép bạn tự động ký API Maps tĩnh hoặc API tĩnh của Chế độ xem phố bằng mật khẩu ký hiện tại của bạn. Cuộn xuống thẻ Ký URL ngay để truy cập.

Để nhận khóa bí mật mới, hãy chọn Tạo lại khóa bí mật. Khóa bí mật trước đó sẽ hết hạn sau 24 giờ kể từ khi bạn tạo khóa bí mật mới. Sau 24 giờ, yêu cầu chứa khóa bí mật cũ không còn hoạt động nữa.

Bước 2: Xây dựng yêu cầu chưa ký

Các ký tự không được liệt kê trong bảng dưới đây phải được mã hóa URL:

Tóm tắt các ký tự URL hợp lệ
Đặtký tựSử dụng URL
Chữ và số 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 Chuỗi văn bản, sử dụng lược đồ (http), cổng (8080), v.v.
Không dành riêng - _ . ~ Chuỗi văn bản
Đã đặt chỗ ! * ' ( ) ; : @ & = + $ , / ? % # [ ] Ký tự điều khiển và/hoặc Chuỗi văn bản

Điều này cũng áp dụng cho mọi ký tự trong tập hợp Dành riêng nếu chúng được truyền bên trong một chuỗi văn bản. Để biết thêm thông tin, hãy xem phần Ký tự đặc biệt.

Tạo URL yêu cầu chưa ký của bạn mà không có chữ ký. Để được hướng dẫn, hãy xem tài liệu dành cho nhà phát triển sau đây:

Hãy nhớ đưa khoá API vào tham số key. Ví dụ:

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

Tạo yêu cầu đã ký

Đối với các trường hợp sử dụng một lần, chẳng hạn như lưu trữ một hình ảnh đơn giản trên API Maps tĩnh hoặc API tĩnh của Chế độ xem phố trên trang web của bạn hoặc mục đích khắc phục sự cố, bạn có thể tự động tạo chữ ký số bằng cách sử dụng tiện ích Ký URL ngay bây giờ.

Đối với các yêu cầu được tạo theo phương thức động, bạn cần ký phía máy chủ, yêu cầu thêm một số bước trung gian

Dù bằng cách nào đi nữa, bạn vẫn sẽ nhận được một URL yêu cầu có tham số signature ở cuối. Ví dụ:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
Sử dụng tiện ích con Đăng nhập URL ngay

Để tạo chữ ký số với khóa API bằng tiện ích Ký URL ngay trong Google Cloud Console:

  1. Tìm tiện ích Ký URL ngay, như mô tả trong Bước 1: Nhận thông tin mật về URL của bạn.
  2. Trong trường URL, hãy dán URL yêu cầu chưa ký của bạn từ Bước 2: Xây dựng yêu cầu chưa ký.
  3. Trường URL đã ký của bạn xuất hiện sẽ chứa URL đã ký kỹ thuật số. Hãy nhớ tạo một bản sao.
Tạo chữ ký số phía máy chủ

So với tiện ích Ký URL ngay, bạn sẽ cần làm thêm một số việc khi tạo chữ ký số ở phía máy chủ:

  1. Tách bỏ lược đồ giao thức và lưu trữ các phần của URL, chỉ để lại đường dẫn và truy vấn:

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

  2. Bí mật ký URL hiển thị được mã hóa trong Base64 đã sửa đổi cho URL.

    Hầu hết các thư viện mật mã đều yêu cầu khoá phải ở định dạng byte thô, nên bạn có thể cần giải mã bí mật ký URL thành định dạng thô ban đầu trước khi ký.

  3. Ký yêu cầu rút gọn ở trên bằng HMAC-SHA1.

  4. Vì hầu hết các thư viện mật mã đều tạo chữ ký ở định dạng byte thô, nên bạn cần chuyển đổi chữ ký nhị phân thu được bằng Base64 đã sửa đổi cho các URL để chuyển đổi chữ ký đó thành tên có thể chuyển trong URL.

  5. Thêm chữ ký được mã hóa Base64 vào URL yêu cầu chưa ký ban đầu trong tham số signature. Ví dụ:

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

Để xem ví dụ về cách triển khai tính năng ký URL bằng mã phía máy chủ, hãy xem phần Mã mẫu để ký URL ở bên dưới.

Mã mẫu để ký URL

Các phần sau đây cho biết cách triển khai việc ký URL bằng mã phía máy chủ. URL phải luôn được ký phía máy chủ để tránh hiển thị bí mật ký URL của bạn cho người dùng.

Python

Ví dụ dưới đây sử dụng thư viện Python chuẩn để ký URL. (Tải xuống mã.)

#!/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

Ví dụ bên dưới sử dụng lớp java.util.Base64 có sẵn kể từ JDK 1.8 – các phiên bản cũ hơn có thể cần sử dụng Apache Commons hoặc các phiên bản tương tự. (Tải xuống mã.)

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

Ví dụ dưới đây sử dụng các mô-đun Nút gốc để ký URL. (Tải xuống mã.)

'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#

Ví dụ bên dưới sử dụng thư viện System.Security.Cryptography mặc định để ký yêu cầu URL. Xin lưu ý rằng chúng ta cần chuyển đổi chế độ mã hoá Base64 mặc định để triển khai phiên bản an toàn cho URL. (Tải xuống mã.)

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

Ví dụ bằng các ngôn ngữ khác

Các ví dụ về các ngôn ngữ khác có sẵn trong dự án ký tên url.

Khắc phục sự cố

Nếu yêu cầu bao gồm chữ ký không hợp lệ, API sẽ trả về lỗi HTTP 403 (Forbidden). Lỗi này rất có thể xảy ra nếu khóa bí mật sử dụng không được liên kết với khóa API đã chuyển hoặc nếu đầu vào không phải ASCII không được mã hóa URL trước khi ký.

Để khắc phục vấn đề, hãy sao chép URL yêu cầu, tách tham số truy vấn signature rồi tạo lại chữ ký hợp lệ theo hướng dẫn bên dưới:

Để tạo chữ ký số với khóa API bằng tiện ích Ký URL ngay trong Google Cloud Console:

  1. Tìm tiện ích Ký URL ngay, như mô tả trong Bước 1: Nhận thông tin mật về URL của bạn.
  2. Trong trường URL, hãy dán URL yêu cầu chưa ký của bạn từ Bước 2: Xây dựng yêu cầu chưa ký.
  3. Trường URL đã ký của bạn xuất hiện sẽ chứa URL đã ký kỹ thuật số. Hãy nhớ tạo một bản sao.