Dijital imza kılavuzu

İsteğinizi API anahtarıyla dijital olarak imzalama

Kullanımınıza bağlı olarak, isteklerin kimliğini doğrulamak için API anahtarının yanı sıra dijital imza da gerekebilir. Daha fazla bilgi için aşağıdaki makalelere bakın:

Dijital imzaların işleyiş şekli

Dijital imzalarda, Google Cloud Console'da bulunan URL imzalama gizli anahtarı kullanılır. Bu gizli anahtar, yalnızca sizinle Google arasında paylaşılan ve projenize özel olan bir özel anahtardı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, Google sunucularının, API anahtarınızı kullanarak oluşturma isteği oluşturan tüm sitelerin bunu yapmaya yetkili olduğunu doğrulamasını sağlar.

İmzasız istekleri sınırlama

API anahtarınızın yalnızca imzalı istekleri kabul etmesini sağlamak için aşağıdakileri yapın:

  1. Cloud Console'da Google Haritalar Platformu Kotalar sayfasına gidin.
  2. Proje açılır listesinden, uygulamanız veya siteniz için API anahtarını oluştururken kullandığınız projeyi seçin.
  3. API'ler açılır listesinden 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 (ör. Günlük imzasız istek sayısı) yanındaki Düzenle'yi tıklayın.
  6. Kota Sınırını Düzenle bölmesinde Kota sınırı'nı güncelleyin.
  7. Kaydet'i tıklayın.

İsteklerinizi imzalama

İsteklerinizi imzalama işlemi aşağıdaki adımlardan oluşur:

1. adım: URL imzalama gizli anahtarınızı alma

Projenizin URL imzalama gizli anahtarını almak için:

  1. Cloud Console'da Google Haritalar Platformu Kimlik Bilgileri sayfasına gidin.
  2. Proje açılır menüsünü tıklayın ve API anahtarını oluştururken kullandığınız projeyi seçin .
  3. Secret Generator kartına gidin. Mevcut gizli anahtar alanında mevcut URL imzalama gizli anahtarınız bulunur.
  4. Sayfada ayrıca, mevcut imzalama gizli anahtarınızı kullanarak isteği otomatik olarak imzalamanıza olanak tanıyan URL'yi şimdi imzala widget'ı da bulunur. URL imzalama kartına giderek bu karta erişin.

Yeni bir URL imzalama gizli anahtarı almak için Gizli Anahtarı Yeniden Oluştur'u seçin. Önceki gizli anahtar, yeni bir gizli anahtar oluşturduktan 24 saat sonra geçerliliğini yitirir. 24 saat geçtikten sonra, eski gizli anahtarı içeren istekler artık çalışmaz.

2. adım: İmzasız isteğinizi oluşturun

Aşağıdaki tabloda yer almayan karakterler URL kodlamalı olmalıdır:

Geçerli URL karakterlerinin özeti
AyarlandıkarakterlerURL 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 w 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ı ! * ' ( ) ; : @ & = + $ , / ? % # [ ] Kontrol karakterleri ve/veya metin dizeleri

Aynı durum, bir metin dizesi içinde iletilen Ayrılmış kümesindeki tüm karakterler için de geçerlidir. Daha fazla bilgi için Özel karakterler başlıklı makaleyi inceleyin.

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

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

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

İmzalı isteği oluşturma

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

Dinamik olarak oluşturulan istekler için sunucu tarafı imzalama gerekir. Bu işlem için birkaç ek ara adım uygulanmalıdır.

Her iki durumda da, sonuna signature parametresi eklenmiş bir istek URL'si elde etmeniz gerekir. Örneğin:

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

Google Cloud Console'da URL'yi şimdi imzala widget'ını kullanarak API anahtarıyla dijital imza oluşturmak için:

  1. 1. adım: URL imzalama gizli anahtarınızı alma bölümünde açıklandığı şekilde Şimdi bir URL imzalayın widget'ını bulun.
  2. URL alanına, 2. adım: İmzasız 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 olarak imzalanmış URL'niz yer alır. Kopyasını oluşturmayı unutmayın.
Sunucu tarafında dijital imzalar oluşturma

URL'yi şimdi imzala widget'ıyla karşılaştırıldığında, sunucu tarafında dijital imza oluştururken birkaç ek işlem yapmanız gerekir:

  1. URL'nin protokol şeması ve ana makine kısımlarını çıkararak yalnızca yol ve sorguyu bırakın:

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

  2. Gösterilen URL imzalama gizli anahtarı, URL'ler için değiştirilmiş bir Base64 biçiminde kodlanır.

    Çoğu kriptografik kitaplık, anahtarın ham bayt biçiminde olmasını gerektirdiğinden, imzalama işleminden önce URL imzalama gizli anahtarınızın kodunu orijinal ham biçimine dönüştürmeniz gerekir.

  3. HMAC-SHA1 kullanarak yukarıdaki ayıklanmış isteği imzalayın.

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

  5. Base64 kodlamalı imzayı, signature parametresindeki orijinal imzasız istek URL'sine 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ı kodunu kullanarak URL imzalama yöntemlerini 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ı kodunu kullanarak URL imzalama işleminin nasıl uygulanacağı gösterilmektedir. URL imzalama gizli anahtarınızın kullanıcılara gösterilmesini önlemek 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 kullanılabilen java.util.Base64 sınıfı kullanılmıştır. Daha eski sürümlerde Apache Commons veya benzeri bir sınıfın kullanılması 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 Node 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 için güvenli bir sürüm uygulamak üzere 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));
    }
  }
}

Diğer dillerdeki örnekler

Daha fazla dili kapsayan örnekleri url-signing projesinde bulabilirsiniz.

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ı, iletilen API anahtarına bağlı değilse veya ASCII olmayan giriş, imzalamadan önce URL olarak kodlanmamışsa ortaya çıkar.

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

Google Cloud Console'da URL'yi şimdi imzala widget'ını kullanarak API anahtarıyla dijital imza oluşturmak için:

  1. 1. adım: URL imzalama gizli anahtarınızı alma bölümünde açıklandığı şekilde URL'yi şimdi imzalayın widget'ını bulun.
  2. URL alanına, 2. adım: İmzasız 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 olarak imzalanmış URL'niz yer alır. Kopyasını oluşturmayı unutmayın.