Client-ID: Anfragesignatur

Wichtig: Du kannst dich nicht mehr für die Google Maps Platform-Premiumoption registrieren. Auch für Neukunden ist sie nicht mehr verfügbar.

Digitale Signaturen

Funktionsweise digitaler Signaturen

Digitale Signaturen werden mit einem URL-Signatur-Secret (auch kryptografischer Schlüssel genannt) generiert, das in der Google Cloud Console verfügbar ist. Dieses Secret ist im Wesentlichen ein privater Schlüssel, der nur zwischen Google und dir ausgetauscht wird und für deine Client-ID eindeutig ist.

Beim Signaturvorgang wird ein Verschlüsselungsalgorithmus verwendet, um die URL und dein gemeinsames Secret zu kombinieren. Anhand der sich ergebenden eindeutigen Signatur kann von unseren Servern geprüft werden, ob Anfragen zur Websitegenerierung, bei denen deine Client-ID verwendet wird, entsprechend autorisiert sind.

Anfragen signieren

So signierst du deine Anfragen:

Schritt 1: URL-Signatur-Secret abrufen

So rufst du das URL-Signatur-Secret für dein Projekt ab:

  1. Öffne in der Cloud Console die Client-ID-Seite.
  2. Im Feld Schlüssel findest du dein aktuelles URL-Signatur-Secret der Client-ID.

Wenn es neu generiert werden muss, wende dich an den Support.

Schritt 2: Nicht signierte Anfrage erstellen

Erstelle die Anfrage-URL ohne Signatur.

Vergiss dabei nicht, auch die Client-ID in den Parameter client aufzunehmen. Beispiel:

https://maps.googleapis.com/maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=YOUR_CLIENT_ID

Signierte Anfrage generieren

Zur Fehlerbehebung kannst du mithilfe des verfügbaren Widgets Jetzt URL signieren automatisch eine digitale Signatur generieren lassen.

Für dynamisch generierte Anfragen ist die serverseitige Signierung erforderlich, bei der einige zusätzliche Zwischenschritte nötig sind.

In beiden Fällen sollte dir am Schluss eine Anfrage-URL zur Verfügung stehen, an deren Ende der Parameter signature angehängt ist. Beispiel:

https://maps.googleapis.com/maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=YOUR_CLIENT_ID
&signature=BASE64_SIGNATURE
Widget „Jetzt URL signieren“ verwenden

So generierst du mit dem Widget Jetzt URL signieren eine digitale Signatur mit deiner Client-ID:

  1. Frage dein URL-Signatur-Secret der Client-ID ab, wie unter Schritt 1: URL-Signatur-Secret abrufen beschrieben.
  2. Füge im Feld URL die URL der unsignierten Anfrage aus Schritt 2: Nicht signierte Anfrage erstellen ein.
  3. Füge dann im Feld URL-Signatur-Secret den entsprechenden Wert aus Schritt 2 ein.
    Es wird eine digitale Signatur basierend auf der Anfrage-URL ohne Signatur sowie dem Signatur-Secret generiert und an die ursprüngliche URL angehängt.
  4. Im daraufhin eingeblendeten Feld Meine signierte URL ist deine digital signierte URL zu sehen. Davon solltest du eine Kopie erstellen.
Digitale Signaturen serverseitig generieren

Beim serverseitigen Generieren digitaler Signaturen sind im Vergleich zum Widget Jetzt URL signieren einige zusätzliche Schritte erforderlich:

  1. Entferne das Protokollschema und die Hostteile der URL, sodass nur Pfad und Anfrage übrig bleiben:

  2. /maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=YOUR_CLIENT_ID
    
  3. Das angezeigte URL-Signatur-Secret wird mit einem modifizierten Base64-Verfahren für URLs codiert.

    Bei den meisten Kryptografiebibliotheken muss der Schlüssel im Rohbyte-Format vorliegen. Daher musst du das URL-Signatur-Secret in der Regel vor dem Signieren in sein ursprüngliches Rohformat decodieren.

  4. Signiere die Anfrage, aus der die entsprechenden Zeichen entfernt wurden, mithilfe von HMAC-SHA1.
  5. Bei den meisten Kryptografiebibliotheken werden Signaturen im Rohbyte-Format generiert. Daher musst du die sich ergebende, binäre Signatur mit dem modifizierten Base64-Verfahren für URLs in ein Format konvertieren, das innerhalb der URL übergeben werden kann.

  6. Hänge die Base64-codierte Signatur an die ursprüngliche, nicht signierte Anfrage-URL im Parameter signature an. Beispiel:

    https://maps.googleapis.com/maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=YOUR_CLIENT_ID
    &signature=BASE64_SIGNATURE

Beispiele für Möglichkeiten zur Implementierung der URL-Signatur mit serverseitigem Code findest du im nachfolgenden Abschnitt, Beispielcode für URL-Signaturen.

Beispielcode für URL-Signaturen

In den folgenden Abschnitten findest du Möglichkeiten zur Implementierung der URL-Signatur mit serverseitigem Code. URLs müssen immer serverseitig signiert werden, damit das URL-Signatur-Secret nicht für Nutzer sichtbar ist.

Python

Im Beispiel unten werden Python-Standardbibliotheken verwendet, um eine URL zu signieren. Hier kannst du den Code herunterladen.

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

Im Beispiel unten wird die Klasse java.util.Base64 verwendet, die seit JDK 1.8 verfügbar ist. Für ältere Versionen muss möglicherweise Apache Commons o. Ä. verwendet werden. Hier kannst du den Code herunterladen.

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

Im Beispiel unten werden native Node.js-Module verwendet, um eine URL zu signieren. Hier kannst du den Code herunterladen.

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

Im Beispiel unten wird die Standardbibliothek System.Security.Cryptography verwendet, um eine URL-Anfrage zu signieren. Wir müssen die Base64-Standardcodierung konvertieren, um eine URL-sichere Version zu implementieren. Hier kannst du den Code herunterladen.

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

Beispiele in weiteren Sprachen

Beispiele für weitere Sprachen findest du hier.

Authentifizierungsprobleme beheben

Wenn die Anfrage nicht richtig formatiert ist oder eine ungültige Signatur enthält, gibt die Places API den Fehler HTTP 403 (Forbidden) zurück.

So lässt sich der Fehler beheben: Kopiere die Anfrage-URL, entferne den Abfrageparameter signature und generiere eine gültige Signatur. Folge dazu der Anleitung unter Widget „Jetzt URL signieren“ verwenden weiter oben.