Sử dụng chữ ký số

Ký yêu cầu bằng khoá API theo hình thức kỹ thuật số

Tuỳ thuộc vào cách sử dụng, bạn có thể phải cung cấp chữ ký số (ngoài khoá API) để xác thực các yêu cầu. Xem các mục sau bài viết:

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

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

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

Hạn chế các yêu cầu chưa ký

Để đảm bảo rằng khoá API của bạn 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 dự án rồi chọn chính dự án mà bạn đã sử dụng khi tạo khoá API cho ứng dụng hoặc trang web của bạn.
  3. Chọn Maps Static API (API Tĩnh của Maps) từ trình đơn API thả xuống.
  4. Mở rộng mục Chưa ký yêu cầu.
  5. Trong bảng 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 bạn muốn chỉnh sửa. Ví dụ: Số yêu cầu chưa ký mỗi ngày.
  6. Cập nhật Giới hạn hạn mức trong ngăn Chỉnh sửa hạn mức.
  7. Chọn Lưu.

Trước khi bắt đầu

Trước khi bắt đầu, hãy tìm hiểu URL của trang web chứa bản đồ tĩnh của bạn. Đây là URL dùng để ký chữ ký số.

Ký yêu cầu

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

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

Cách lấy bí mật ký URL cho dự án của bạn:

  1. Chuyển đến 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 dự án rồi chọn chính dự án mà bạn đã sử dụng khi tạo khoá API cho API Tĩnh của Maps.
  3. Di chuyển xuống thẻ Secret Generator (Trình tạo bí mật). Trường Khoá bí mật hiện tại chứa bí mật ký URL hiện tại.
  4. Trang này cũng có tiện ích Ký URL ngay giúp bạn tự động ký yêu cầu API Tĩnh của Maps bằng khoá bí mật ký hiện tại của bạn. Di chuyển xuống thẻ Ký URL ngay để truy cập vào thẻ đó.

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

Bước 2: Tạo yêu cầu chưa được ký

Các ký tự không được liệt kê trong bảng dưới đây phải được mã hoá 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 h o a o q u ả n g t ậ p A B C D E F G H I J K L M P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 Chuỗi văn bản, cách sử dụng giao thức (http), cổng (8080), v.v.
Không dành riêng — _ . ~ Chuỗi văn bản
Đã đặt trước ! * ( ) ; : @ & = + $ , / ? % # [ ] 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 bất kỳ ký tự nào trong tập hợp Dành riêng, nếu các ký tự đó được truyền bên trong một văn bản . Để biết thêm thông tin, hãy xem Ký tự đặc biệt.

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

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

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

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

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

Đối với các yêu cầu được tạo một cách linh động, bạn cần có phía máy chủ ký. Quá trình này yêu cầu thêm một số bước trung gian

Dù bằng cách nào, bạn cũng nên kết thúc bằng một URL yêu cầu có tham số signature được thêm vào cuối. Ví dụ:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&zoom=12&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
Sử dụng tiện ích Ký URL ngay

Để tạo chữ ký số bằng khoá API bằng cách sử dụ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: Lấy mã bí mật dùng để ký URL.
  2. Trong trường URL, hãy dán URL yêu cầu chưa được ký của bạn từ Bước 2: Tạo 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ố của bạn. 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 thực hiện thêm khi tạo chữ ký số phía máy chủ:

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

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

  2. Khoá ký URL hiển thị được mã hoá theo Base64 cho URL.

    Hầu hết các thư viện mật mã học đề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 của bạn thành định dạng thô ban đầu trước khi ký.

  3. Ký yêu cầu bị xoá ở trên bằng HMAC-SHA1.

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

  5. Nối chữ ký được mã hoá 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&zoom=12&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE

Để xem các mẫu trình bày cách triển khai tính năng ký URL bằng mã phía máy chủ, hãy xem 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 ký URL bằng mã phía máy chủ. URL phải luôn được ký phía máy chủ để tránh tiết lộ bí mật ký URL của bạn cho người dùng.

Python

Ví dụ bên dưới sử dụng các thư viện Python tiêu chuẩn để ký một 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 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ụ bên dưới 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 giá trị mặc định System.Security.Cryptography để ký yêu cầu URL. Xin lưu ý rằng chúng ta cần chuyển đổi mã hoá Base64 mặc định để triển khai Phiên bản an toàn với 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

Ví dụ về các ngôn ngữ khác có sẵn trong url-signing dự án.

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ề một HTTP 403 (Forbidden) lỗi. Rất có thể lỗi này sẽ xảy ra nếu việc ký đã sử dụng secret không được liên kết với khoá API đã chuyển, hoặc nếu dữ liệu nhập 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, loại bỏ truy vấn signature và tạo lại một chữ ký hợp lệ theo hướng dẫn bên dưới:

Để tạo chữ ký số bằng khoá API bằng cách sử dụ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: Lấy mã bí mật dùng để ký URL.
  2. Trong trường URL, hãy dán URL yêu cầu chưa được ký của bạn từ Bước 2: Tạo 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ố của bạn. Hãy nhớ tạo một bản sao.