Dijital İmza 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. Aşağıdaki makalelere göz atın:

Dijital imzaların işleyiş şekli

Dijital imzalar, Google Cloud Console'da bulunan bir URL imzalama gizlisi kullanılarak oluşturulur. Bu gizli anahtar, yalnızca sizinle Google arasında paylaşılan ve projenize özgü 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. Elde edilen benzersiz imza, sunucularımızın API anahtarınızı kullanarak istek oluşturan tüm sitelerin bunu yapmaya yetkili olduğunu doğrulamasına olanak tanır.

İmzasız istekleri sınırlama

API anahtarınızın yalnızca imzalı istekleri kabul etmesini sağlamak 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 listesinden Maps Static API veya Street View Static API'yi seçin.
  4. İmzasız istekler bölümünü genişletin.
  5. Kota Adı tablosunda, düzenlemek istediğiniz kotanın yanındaki düzenleme düğmesini tıklayın. Örneğin, Günlük imzalanmamış 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

İsteklerinizi imzalamak için aşağıdaki adımları uygulamanız gerekir:

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

Proje URL'nizin imzalama gizlisini almak için:

  1. Cloud Console'daki 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şturduğunuzda kullandığınız projeyi seçin.
  3. Gizli Şifre Oluşturucu kartına gidin. Mevcut gizli anahtar alanı, mevcut URL imzalama gizli anahtarınızı içerir.
  4. Sayfada, mevcut imzalama gizli anahtarınızı kullanarak Maps Static API veya Street View Static API isteğini otomatik olarak imzalamanıza olanak tanıyan Şimdi URL imzala widget'ı da bulunur. Erişmek için aşağı kaydırıp Hemen bir URL imzalayın kartına gidin.

Yeni bir URL imzalama gizlisi almak için Gizliyi Yeniden Oluştur'u seçin. Yeni bir gizli anahtar oluşturduktan 24 saat sonra önceki gizli anahtarın süresi dolar. 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 listelenmeyen karakterler URL olarak kodlanmalıdır:

Geçerli URL Karakterlerinin Özeti
HazırkarakterlerURL 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

Metin dizesinde iletildikleri takdirde Ayrılmış kümesindeki tüm karakterler için de aynı durum 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 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 Haritalar Static API veya Street View Static API resmi barındırma gibi tek seferlik kullanım alanları veya sorun giderme amacıyla, mevcut Şimdi bir URL 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 gerekir.

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

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

Google Cloud Console'daki Şimdi URL imzala 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ığı gibi Hemen 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ünen İmzalanmış URL'niz alanında dijital olarak imzalanmış URL'niz yer alır. Kopya oluşturmayı unutmayın.
Sunucu tarafında dijital imza oluşturma

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

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

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

  2. Gösterilen URL imzalama gizlisi, URL'ler için değiştirilmiş bir Base64 ile kodlanmıştır.

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

  3. Yukarıdaki ayıklama işlemi uygulanmış isteği HMAC-SHA1 kullanarak imzalayın.

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

  5. Base64 kodlamalı imzayı, signature parametresindeki imzasız orijinal 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ı kod kullanarak URL imzalamanın 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ı kod kullanarak URL imzalamanın yolları gösterilmektedir. URL imzalama gizliliğinizin 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ılmaktadır. 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, 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 kodlamayı 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 dillerde örnekler

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

Sorun giderme

İstek geçersiz bir imza içeriyorsa API bir HTTP 403 (Forbidden) hatası döndürür. Bu hata büyük olasılıkla, kullanılan imzalama gizlisi 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 kaldırın ve aşağıdaki talimatları uygulayarak geçerli bir imza yeniden oluşturun:

Google Cloud Console'daki Şimdi URL imzala 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ığı gibi Hemen 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ünen İmzalanmış URL'niz alanında dijital olarak imzalanmış URL'niz yer alır. Kopya oluşturmayı unutmayın.