Dijital İmza Kılavuzu

İsteğinizi bir API anahtarıyla dijital olarak imzalayın

Kullanımınıza bağlı olarak, aşağıdakileri yapmak için API anahtarının yanı sıra bir dijital imza da gerekebilir. kimlik doğrulama istekleri. Aşağıdakilere göz atın makaleler:

Dijital imzaların işleyiş şekli

Dijital imzalar, URL imzalama gizli anahtarı kullanılarak oluşturulur. Google Cloud Console. Bu gizli anahtar esas olarak yalnızca Google ile sizin aranızda paylaşılan, ve projenize özgüdür.

İmzalama sürecinde, URL ve paylaşılan bir sır. Ortaya çıkan benzersiz imza, sunucularımızın API anahtarınızı kullanarak istek oluşturan tüm sitelerin bunu yapma yetkisine sahip olduğunu doğrulayın.

İmzasız istekleri sınırlama

API anahtarınızın yalnızca imzalı istekleri kabul ettiğinden emin olmak için:

  1. Cloud Console'da Google Haritalar Platformu Kotalar sayfasına gidin.
  2. Proje açılır menüsünü tıklayın ve oluştururken kullandığınız projeyi seçin uygulamanız veya sitenizin API anahtarını kullanın.
  3. API'ler açılır menüsünden Haritalar Statik API veya Street View Statik API'yi seçin.
  4. İmzalanmamış istekler bölümünü genişletin.
  5. Kota Adı tablosunda, düzenlemek istediğiniz kotanın yanındaki düzenle düğmesini tıklayın düzenleyin. Örneğin, Günlük imzasız istek sayısı.
  6. Kota Sınırını Düzenle bölmesinde Kota sınırı'nı güncelleyin.
  7. Kaydet'i seçin.

İsteklerinizi imzalama

İsteklerinizin imzalanması aşağıdaki adımları içerir:

1. Adım: URL imzalama gizli anahtarınızı alın

Proje URL'si imzalama gizli anahtarınızı almak için:

  1. Şuraya gidin: Google Haritalar Platformu Kimlik Bilgileri sayfası Cloud Console'da bulabilirsiniz.
  2. Proje açılır menüsünü ve API anahtarını oluştururken kullandığınız projeyi seçin Haritalar Statik API veya Street View Static API için.
  3. Secret Generator kartına ilerleyin. Mevcut gizli anahtar alanı geçerli URL imzalama gizli anahtarı.
  4. Sayfada ayrıca otomatik olarak oturum açmanıza olanak tanıyan Şimdi bir URL imzalayın widget'ı Geçerli imzalama gizli anahtarınızı kullanarak Maps Static API veya Street View Static API isteği. Erişmek için Şimdi bir URL imzalayın kartına gidin.

Yeni bir URL imzalama gizli anahtarı almak için Regenerate Secret (Gizli Anahtarı Yeniden Oluştur) seçeneğini belirleyin. Önceki gizli anahtarın süresi, yeni gizli anahtar oluşturmanızdan 24 saat sonra sona erer. 24 saat geçtikten sonra, eski gizli anahtarı içeren istekler artık çalışmaz.

2. Adım: İmzalanmamış isteğinizi oluşturun

Aşağıdaki tabloda listelenmeyen karakterler URL olarak kodlanmış olmalıdır:

Geçerli URL Karakterlerinin Özeti
AyarlakarakterlerURL kullanımı
Alfanümerik a b c d e f g h i j k l m n o p q r s t u v g x y z 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 0 1 2 3 4 5 6 7 8 9 Metin dizeleri, şema kullanımı (http), bağlantı noktası (8080) vb.
Ayrılmamış - _ . ~ Metin dizeleri
Rezervasyon yapıldı ! * ( ) ; : @ & = + TL , / ? % # [ ] Kontrol karakterleri ve/veya Metin Dizeleri

Aynı durum, bir metin içinde geçirilen Ayrılmış kümesindeki tüm karakterler için de geçerlidir. dize. Daha fazla bilgi için bkz. Özel karakterler.

İmzalanmamış istek URL'nizi imza olmadan oluşturun. Talimatlar için aşağıdaki geliştirici belgelerine bakın:

Belgeye API anahtarını da eklemeyi unutmayın. key parametresinden yararlanın. Örneğin:

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

İmzalanmış isteği oluştur

Tek seferlik kullanım alanları (ör. basit bir Cihazınızdaki Maps Static API veya Street View Static API görseli veya sorun giderme amacıyla kullanılan dijital imza Mevcut öğeleri kullanarak Hemen bir URL imzalayın widget'ını.

Dinamik olarak oluşturulan istekler için sunucu tarafında birkaç ek ara adım gerektirir

Her iki durumda da signature parametresine sahip bir istek URL'niz olur. sonuna eklenir. Örneğin:

https://maps.googleapis.com/maps/api/staticmap?center=Z%C3%BCrich&size=400x400&key=YOUR_API_KEY
&signature=BASE64_SIGNATURE
Şimdi URL imzalayın widget'ını kullanma

Dijital imza oluşturmak için bir API anahtarı Şimdi bir URL imzalayın widget'ını kullanarak Google Cloud Console'da:

  1. Şimdi bir URL imzalayın widget'ını bulun. 1. Adım: URL imzalama gizli anahtarınızı alın bölümünde açıklandığı gibi.
  2. URL alanına, şu adresteki imzalanmamış istek URL'nizi yapıştırın: 2. Adım: İmzalanmamış isteğinizi oluşturun.
  3. Görünen İmzalanmış URL'niz alanında dijital olarak imzalanmış URL'niz yer alır. Kopya oluşturduğunuzdan emin olun.
Sunucu tarafında dijital imza oluşturma

Şimdi bir URL imzalayın widget'ı ile karşılaştırıldığında, birkaç ek sunucu tarafında dijital imza oluştururken gerçekleştirilecek işlemler:

  1. URL'nin protokol şemasını ve ana makine bölümlerini çıkarır, yalnızca yol ve sorguyu bırakarak

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

  2. Görüntülenen URL imzalama gizli anahtarı, değiştirilmiş bir URL'ler için Base64

    Çoğu şifreleme kitaplığı, anahtarın ham bayt biçiminde olmasını gerektirdiğinden büyük olasılıkla URL imzalama gizli kodunuzun kodunu, imzalamadan önce orijinal ham biçiminde çözmeniz gerekir.

  3. Yukarıdaki sadeleştirilmiş isteği HMAC-SHA1 kullanarak imzalayın.

  4. Çoğu şifreleme kitaplığı ham bayt biçiminde bir imza oluşturduğundan, elde edilen ikili imzayı, değiştirilmiş biçimi kullanarak Dönüştürülecek URL'ler için Base64 içinde iletilebilecek bir şeye dönüştürmenizi sağlar.

  5. Base64 kodlu imzayı orijinal imzasız istek URL'sine signature parametresinden yararlanın. Örneğin:

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

Sunucu tarafı kodu kullanarak URL imzalama uygulama yöntemlerini gösteren örnekler için Aşağıdaki URL imzalama için örnek kod.

URL imzalama için örnek kod

Aşağıdaki bölümlerde, sunucu tarafı kodudur. Kullanılmaması için URL'ler her zaman sunucu tarafında URL imzalama sırrınızı kullanıcılara gösterir.

Python

Aşağıdaki örnekte URL'yi imzalamak için standart Python kitaplıkları kullanılmaktadır. (İndir girin.)

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

Aşağıdaki örnekte, mevcut java.util.Base64 sınıfı kullanılmaktadır. JDK 1.8'den itibaren - eski sürümlerde Apache Commons veya benzeri bir yazılım kullanılması gerekebilir. (İndir girin.)

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

Aşağıdaki örnekte URL imzalamak için yerel Düğüm modülleri kullanılmaktadır. (İndir girin.)

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

Aşağıdaki örnekte varsayılan olarak, System.Security.Cryptography kitaplığını kullanabilirsiniz. Şunun için varsayılan Base64 kodlamasını dönüştürmemiz gerektiğini unutmayın: URL için güvenli sürüm. (İndir girin.)

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

Ek dillerdeki örnekler

Daha fazla dili kapsayan örnekler url-signing belirler.

Sorun giderme

İstek geçersiz bir imza içeriyorsa API, HTTP 403 (Forbidden) hata. Bu hata büyük olasılıkla, kullanılan imzalama sır, iletilen API anahtarına bağlanmadıysa veya ASCII olmayan giriş imzalanmadan önce URL olarak kodlanmazsa.

Sorunu gidermek için istek URL'sini kopyalayın ve signature sorgusunu kaldırın parametresini kullanın ve aşağıdaki talimatları uygulayarak geçerli bir imzayı yeniden oluşturun:

Dijital imza oluşturmak için bir API anahtarı Şimdi bir URL imzalayın widget'ını kullanarak Google Cloud Console'da:

  1. Şimdi bir URL imzalayın widget'ını bulun. 1. Adım: URL imzalama gizli anahtarınızı alın bölümünde açıklandığı gibi.
  2. URL alanına, şu adresteki imzalanmamış istek URL'nizi yapıştırın: 2. Adım: İmzalanmamış isteğinizi oluşturun.
  3. Görünen İmzalanmış URL'niz alanında dijital olarak imzalanmış URL'niz yer alır. Kopya oluşturduğunuzdan emin olun.