Dijital İmza Kılavuzu

API anahtarıyla isteğinizi dijital olarak imzalama

Kullanımınıza bağlı olarak, isteklerin kimliğini doğrulamak için API anahtarına ek olarak dijital bir imza gerekebilir. Aşağıdaki makalelere göz atın:

Dijital imzaların işleyiş şekli

Dijital imzalar, Google Cloud Console'da bulunan bir URL imzalama gizli anahtarı kullanılarak oluşturulur. Bu gizli anahtar aslında sizinle Google arasında paylaşılan özel bir anahtardır ve projenize özgüdür.

İmzalama işlemi, URL'yi ve paylaşılan gizli anahtarınızı birleştirmek için bir şifreleme algoritması kullanır. Oluşturulan benzersiz imza, sunucularımızın API anahtarınızı kullanarak istekte bulunan siteler için bunu yapmaya yetkili olduğunu doğrulamasını sağlar.

İmzalanmamış istekleri sınırlayın

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 uygulamanız veya siteniz için API anahtarını oluştururken kullandığınız projeyi seçin.
  3. API'ler açılır menüsünden Maps Static API veya Street View Static 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. Ö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.

İstekleriniz imzalanıyor

İsteklerinizin imzalanması aşağıdaki adımlardan oluşur:

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

Proje URL'nizi imzalamak için:

  1. Cloud Console'da Google Haritalar Platformu Kimlik Bilgileri sayfasına gidin.
  2. Proje açılır menüsünü seçin ve Maps Static API veya Street View Static API için API anahtarını oluştururken kullandığınız projeyi seçin.
  3. Gizli Oluşturma Aracı kartına ilerleyin. Mevcut gizli anahtar alanı, mevcut URL imzalama gizli anahtarınızı içerir.
  4. Sayfada, mevcut imzalama sırrınızı kullanarak Haritalar Statik API'si veya Street View Static API isteğini otomatik olarak imzalamanıza olanak tanıyan Şimdi bir URL imzala widget'ı da bulunmaktadır. İlgili sayfaya erişmek için Şimdi URL imzala kartına ilerleyin.

Yeni bir URL imzalama gizli anahtarı almak için Gizli Anahtar Yeniden Oluştur'u seçin. Önceki gizli anahtarın süresi, yeni gizli anahtar oluşturulduktan 24 saat sonra sona erer. Eski sırrı içeren istekler 24 saat geçtikten sonra kullanılamaz.

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
AyarlakarakterURL kullanımı
Alfanümerik CANNOT TRANSLATE Metin dizeleri, şema kullanımı (http), bağlantı noktası (8080) vb.
Ayrılmamış - _ ~ Metin dizeleri
Rezervasyon yapıldı ! * ' ( ) ; : @ & = + $ , / ? % # [ ] Kontrol karakterleri ve/veya Metin Dizeleri

Aynı durum, bir metin dizesi içinde iletilen Ayrılmış gruptaki tüm karakterler için geçerlidir. Daha fazla bilgi için Özel karakterler bölümüne bakın.

İmzasız istek URL'nizi imza olmadan oluşturun. Talimatlar için aşağıdaki geliştirici dokümanlarına bakın:

API anahtarını da key parametresine eklediğinizden emin olun. Örneğin:

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

İmzalanmış istek oluştur

Web sayfanızda basit bir Maps Static API veya Street View Static API resmi barındırma gibi sorun giderme işlemleri için tek seferlik kullanım alanlarında ya da sorun giderme işlemleri için mevcut Şimdi URL imzalayın widget'ını kullanarak otomatik olarak dijital imza oluşturabilirsiniz.

Dinamik olarak oluşturulan istekler için birkaç ek ara adım gerektiren sunucu tarafı imzalamaya ihtiyacınız vardır

Her iki durumda da, sonuna bir signature parametresi eklenen bir istek URL'si oluşturmanız gerekir. Ö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

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

  1. 1. Adım: URL imzalama gizli anahtarınızı alın bölümünde açıklandığı şekilde Şimdi URL imzalayın widget'ını bulun.
  2. URL alanına, 2. Adım: İmzalanmamış isteğinizi oluşturun bölümündeki imzasız istek URL'nizi yapıştırın.
  3. Görüntülenen İmzalı URL'niz alanında dijital imzalı URL'niz yer alır. Kopyasını oluşturduğunuzdan emin olun.
Sunucu tarafında dijital imza oluşturma

Şimdi bir URL imzalayın widget'ına kıyasla, sunucu tarafında dijital imza oluştururken birkaç ek işlem yapmanız gerekir:

  1. Protokol şemasını ve URL'nin ana makine bölümlerini kaldırıp yalnızca yolu ve sorguyu bırakın:

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

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

    Çoğu şifreleme kitaplığı, anahtarın ham bayt biçiminde olmasını gerektirdiğinden, imzalamadan önce muhtemelen URL imzalama gizli anahtarınızı orijinal ham biçiminde çözmeniz gerekecektir.

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

  4. Çoğu şifreleme kitaplığı, ham bayt biçiminde imza oluşturduğundan, URL'lerin URL içinde iletilebilecek bir öğe haline getirilmesi için, değiştirilmiş Base64'ü kullanarak elde edilen ikili imzayı dönüştürmeniz gerekir.

  5. Base64 kodlamalı imzayı, imzalanmamış orijinal istek URL'sinin signature parametresine ekleyin. Ö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 yollarını gösteren örnekler için aşağıdaki URL imzalama için örnek kod bölümüne bakın.

URL imzalama için örnek kod

Aşağıdaki bölümlerde, sunucu tarafı kodu kullanılarak URL imzalamanın nasıl kullanılacağı gösterilmektedir. URL imzalama gizli anahtarınızı kullanıcılara göstermekten kaçınmak için URL'ler her zaman sunucu tarafında imzalanmalıdır.

Python

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

#!/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 JDK 1.8'den beri mevcut olan java.util.Base64 sınıfı kullanılmaktadır. Eski sürümlerin Apache Commons veya benzerlerini kullanması gerekebilir. (Kodu indirin.)

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 bir URL'yi imzalamak için yerel Düğüm modülleri kullanılmaktadır. (Kodu indirin.)

'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 bir URL isteğini imzalamak için varsayılan System.Security.Cryptography kitaplığı kullanılmaktadır. URL güvenli bir sürümü uygulamak için varsayılan Base64 kodlamasını dönüştürmemiz gerektiğini unutmayın. (Kodu indirin.)

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 imzalama projesinde mevcuttur.

Sorun giderme

İstek geçersiz bir imza içeriyorsa API, HTTP 403 (Forbidden) hatası döndürür. Bu hata, büyük olasılıkla kullanılan imzalama gizli anahtarı aktarılan API anahtarına bağlı değilse veya ASCII olmayan giriş imzalanmadan önce URL olarak kodlanmamışsa ortaya çıkar.

Sorunu gidermek için istek URL'sini kopyalayın, signature sorgu parametresini çıkarın ve aşağıdaki talimatları uygulayarak geçerli bir imza oluşturun:

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

  1. 1. Adım: URL imzalama gizli anahtarınızı alın bölümünde açıklandığı şekilde Şimdi URL imzalayın widget'ını bulun.
  2. URL alanına, 2. Adım: İmzalanmamış isteğinizi oluşturun bölümündeki imzasız istek URL'nizi yapıştırın.
  3. Görüntülenen İmzalı URL'niz alanında dijital imzalı URL'niz yer alır. Kopyasını oluşturduğunuzdan emin olun.