Quan trọng: Gói Google Maps Platform Premium không còn được hỗ trợ để đăng ký hoặc trở thành khách hàng mới.
Chữ ký số
Cách hoạt động của chữ ký số
Chữ ký số được tạo bằng Khoá ký URL (hay khoá mã hoá) có trên Google Cloud Console. Về cơ bản, bí mật này là một khoá riêng tư, chỉ được chia sẻ giữa bạn và Google và là duy nhất cho ID ứng dụng khách của bạn.
Quá trình ký này sử dụng một thuật toán mã hoá để kết hợp URL và khoá bí mật dùng chung của bạn. Chữ ký duy nhất thu được giú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 mã ứng dụng khách của bạn đều được phép làm như vậy.
Ký yêu cầu
Quá trình 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
- Bước 2: Tạo yêu cầu chưa ký
- Bước 3: Tạo yêu cầu đã ký
Bước 1: Lấy bí mật ký URL của bạn
Cách lấy bí mật ký URL của dự án:
- Truy cập trang Mã ứng dụng khách trong Cloud Console.
- Trường Khoá chứa bí mật ký URL mã ứng dụng khách hiện tại của bạn.
Nếu bạn cần tạo lại mật khẩu ký URL của mã ứng dụng khách, hãy liên hệ với nhóm hỗ trợ.
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 | ký tự | Việc sử dụng URL |
|---|---|---|
| Chữ và số | a b c d e f g g h i j k l m n o p q r s t t u v w x y z A B C D 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 9 6 7 | Chuỗi văn bản, cách sử dụng lượ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 mọi ký tự trong tập hợp Dành riêng nếu các ký tự đó được truyền vào 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ý mà không cần chữ ký.
Hãy nhớ đưa cả mã ứng dụng khách vào tham số client. Ví dụ:
https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
Tạo yêu cầu đã ký
Để khắc phục sự cố, bạn có thể tạo chữ ký số tự động bằng tiện ích Ký URL ngay có sẵn.
Đối với các yêu cầu được tạo một cách linh động, bạn cần sử dụng tính năng ký phía máy chủ. Việc này sẽ yêu cầu thêm một vài bước trung gian
Dù bằng cách nào, bạn cũng nên kết thúc với 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&size=400x400&client=YOUR_CLIENT_ID &signature=BASE64_SIGNATURE
-
Xoá 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:
-
Mã bí mật ký URL hiển thị được mã hoá trong một Base64 đã sửa đổi cho các URL.
Vì 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 có thể bạn sẽ cần giải mã bí mật ký URL của mình về định dạng thô ban đầu trước khi ký.
- Ký yêu cầu đã loại bỏ ở trên bằng HMAC-SHA1.
-
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 sẽ cần chuyển đổi chữ ký nhị phân thu được bằng cách sử dụng Base64 đã sửa đổi cho các URL để chuyển đổi chữ ký đó thành nội dung có thể truyền được trong URL.
-
Thêm 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&size=400x400&client=YOUR_CLIENT_ID &signature=BASE64_SIGNATURE
/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&client=YOUR_CLIENT_ID
Để tham khảo các ví dụ minh hoạ 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 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 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ý URL. (Tải mã xuống.)
#!/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 mã xuống.)
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 mã xuống.)
'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ý một yêu cầu URL.
Xin lưu ý rằng chúng ta cần chuyển đổi phương thức mã hoá Base64 mặc định để triển khai một phiên bản an toàn với URL.
(Tải mã xuống.)
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
Bạn có thể xem ví dụ cho nhiều ngôn ngữ khác trong dự án url-signing.
Khắc phục sự cố
Nếu yêu cầu có 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 khoá bí mật ký đã sử dụng không được liên kết với ID ứng dụng khách đã chuyển hoặc nếu dữ liệu đầu vào không phải ASCII không được mã hoá URL trước khi ký.
Để khắc phục sự cố này, hãy sao chép URL yêu cầu, xoá tham số truy vấn signature và tạo lại chữ ký hợp lệ theo hướng dẫn bên dưới:
Để tạo chữ ký số bằng mã ứng dụng khách, hãy sử dụng tiện ích Ký URL ngay dưới đây:
- Tìm nạp mật khẩu ký URL của mã ứng dụng khách, như mô tả trong Bước 1: Lấy bí mật ký URL của bạn.
- Trong trường URL, hãy dán URL yêu cầu chưa ký trong Bước 2: Tạo yêu cầu chưa ký.
- Trong trường Bí mật ký URL, hãy dán bí mật ký URL của bạn từ Bước 2.
Chữ ký số được tạo dựa trên URL yêu cầu chưa ký và mật khẩu ký của bạn, rồi nối thêm vào URL ban đầu của bạn. - 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.