Authentifizierung und Autorisierung

Diese Seite richtet sich ausschließlich an Kunden mit einer früheren Maps APIs for Work- oder Maps API for Business-Lizenz. Diese Seite hat keine Gültigkeit für Kunden mit dem neuen Google Maps APIs Premium Plan, der ab Januar 2016 erhältlich ist.

Client-IDs und Signaturen

Wenn Sie die Google Maps APIs-Webdienste mit einer Google Maps APIs for Work-Lizenz verwenden, werden zwei Authentifizierungsparameter benötigt: die Client-ID und eine eindeutige digitale Signatur (anstelle des API-Schlüssels).

Beim Wechsel von den kostenlosen API-Webdiensten zu einer Google Maps APIs for Work-Implementierung müssen Sie den Parameter key aus Ihren Anforderungen entfernen. Anforderungen, die mit einer Client-ID und einem Schlüssel erfolgen, werden von den Google Maps APIs-Webdiensten zurückgewiesen.

Ihre Client-ID und Signatur

Nachdem Sie eine Google Maps APIs for Work-Lizenz erworben haben, erhalten Sie eine Begrüßungs-E-Mail von Google. Diese E-Mail enthält Ihre Client-ID und Ihren privaten kryptografischen Schlüssel.

  • Ihre Client-ID benötigen Sie für die Sonderfunktionen von Google Maps APIs for Work – beim Zugriff auf API-Bibliotheken oder -Dienste müssen Sie eine Client-ID angeben. Alle Client-IDs beginnen mit dem Präfix gme-. Übergeben Sie Ihre Client-ID als Wert des Parameters client.

  • Mit Ihrem privaten kryptografischen Schlüssel wird eine eindeutige digitale Signatur generiert. Übergeben Sie diese Signatur als Wert des Parameters signature. Weitere Informationen zum Generieren einer Signatur finden Sie weiter unten im Abschnitt über digitale Signaturen.

Hier ist ein Beispiel für die Google Maps Directions API:

    https://maps.googleapis.com/maps/api/directions/json
      ?origin=Toronto
      &destination=Montreal
      &client=gme-YOUR_CLIENT_ID
      &signature=YOUR_URL_SIGNATURE

Wenn Sie Ihre Client-ID oder Ihren privaten kryptografischen Schlüssel verloren haben, können Sie diese erneut anfordern, indem Sie sich im Google Cloud Support Portal anmelden und in den Links im linken Bereich der Seite auf Maps: Manage Client ID klicken.

Optionaler Parameter für Berichte

Zusätzlich zu den Authentifizierungsparametern ist der folgende Parameter für Google Maps APIs for Work-Anforderungen optional:

  • channel wird zur Bereitstellung zusätzlicher Berichtsdetails verwendet, indem verschiedene Kanäle in Ihren Berichten getrennt voneinander gruppiert werden. Informationen hierzu finden Sie im Abschnitt Kanalberichte des Dokuments Kontingente und Berichte zu den Google Maps APIs for Work-Webdiensten.

Digitale Signaturen

Anforderungen an die Webdienst-APIs durch Google Maps APIs for Work-Kunden erfordern eine digitale Signatur (signature), die mit dem privaten kryptografischen Schlüssel generiert wird, den Sie in Ihrer Begrüßungs-E-Mail erhalten haben.

Der Signaturvorgang kombiniert unter Verwendung eines Verschlüsselungsalgorithmus eine URL mit dem Schlüssel. Anhand der daraus resultierenden eindeutigen Signatur können unsere Server prüfen, ob eine Website, die mittels Ihrer Client-ID Anforderungen generiert, dazu auch autorisiert ist. Die Signatur ist außerdem eindeutig für die URL. Dadurch wird sichergestellt, dass Anforderungen, die Ihre Client-ID verwenden, nicht modifiziert werden können, ohne dass eine neue Signatur generiert werden muss.

Ihr privater kryptografischer Schlüssel

Ihr privater kryptografischer URL-Signaturschlüssel wird zusammen mit Ihrer Client-ID ausgegeben. Er handelt sich um einen „gemeinsamen geheimen Schlüssel“, den Sie mit Google teilen. Dieser Signaturschlüssel gehört nur Ihnen und ist Ihrer Client-ID eindeutig zugeordnet. Gewährleisten Sie daher die Sicherheit Ihres Signaturschlüssels. Dieser Schlüssel darf nicht in Anforderungen weitergegeben, auf Websites gespeichert oder in öffentlichen Foren gepostet werden. Jeder, der in den Besitz dieses Signaturschlüssels gelangt, kann unter Verwendung Ihrer Identität Anforderungen manipulieren.

Hinweis: Dieser private kryptografische Signaturschlüssel ist nicht identisch mit den durch die Google API Console ausgegebenen API-Schlüsseln.

Sollten Sie Ihren privaten kryptografischen Schlüssel verloren haben, melden Sie sich im Google Cloud Support Portal an und klicken Sie auf Maps: Manage Client ID, um ihn wieder abzurufen.

Digitale Signatur generieren

Versuche, mit einer ungültigen Signatur auf die Google Maps APIs-Webdienste zuzugreifen, führen zum Fehler HTTP 403 (Forbidden). Wenn Sie Ihre Anwendungen auf die Verwendung der URL-Signatur umstellen, führen Sie unbedingt einen Test Ihrer Signaturen durch, um sicherzustellen, dass sie gültige Anforderungen auslösen. Zuerst sollten Sie testen, ob die ursprüngliche URL gültig ist und ob Sie die richtigen Signaturen generieren.

Befolgen Sie die folgenden Schritte, um eine digitale Signatur für Ihre Anforderung zu erstellen:

  1. Erstellen Sie die Anforderungs-URL ohne Signatur und achten Sie dabei darauf, Ihren Parameter client einzubinden. Beachten Sie, dass alle nicht standardmäßigen Zeichen URL-codiert sein müssen: Konstruieren Sie zum Beispiel für die Directions API die URL wie folgt:

    https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID

    Hinweis: Alle Google-Dienste erfordern eine UTF-8-Zeichencodierung (die implizit ASCII mit einschließt). Falls Ihre Anwendungen mit anderen Zeichencodierungen betrieben werden, stellen Sie sicher, dass von diesen Anwendungen URLs mit UTF-8-Codierung erstellt werden und eine ordnungsgemäße URL-Codierung durchgeführt wird.

  2. Entfernen Sie den Domänenteil der Anforderung, sodass nur Pfad und Abfrage übrig bleiben: Beispiel für die Directions API:

    /maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID

  3. Rufen Sie Ihren privaten Schlüssel ab, der mit einem modifizierten Base64-Verfahren für URLs codiert ist, und signieren Sie die obige URL mithilfe des HMAC-SHA1-Algorithmus. Möglicherweise müssen Sie diesen Schlüssel in sein ursprüngliches Binärformat decodieren. Beachten Sie, dass die daraus resultierende Signatur in den meisten kryptografischen Bibliotheken im Binärformat vorliegt.

    Hinweis: Über das modifiziertes Base64-Verfahren für URLs werden die Zeichen + und / des Standard-Base64-Verfahrens durch - bzw. _ ersetzt, sodass bei diesen Base64-Signaturen keine URL-Codierung mehr durchgeführt werden muss.

  4. Codieren Sie die sich ergebende binäre Signatur mit dem modifizierten Base64-Verfahren für URLs, um diese Signatur in ein Format zu konvertieren, das innerhalb einer URL weitergeleitet werden kann.

  5. Fügen Sie diese Signatur der URL innerhalb eines Parameters signature hinzu: Beispiel für die Directions API:

    https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&client=clientID&signature=base64signature

Beispiele für Möglichkeiten zur Implementierung der URL-Signatur von serverseitigem Code finden Sie im Codebeispiel für URL-Signaturen.

Codebeispiel für URL-Signaturen



In den folgenden Abschnitten werden Ihnen Methoden aufgezeigt, wie Sie URL-Signaturen mit serverseitigem Code implementieren. URLs müssen immer serverseitig signiert werden, damit Ihr Kryptografieschlüssel nicht anderen Benutzern angezeigt wird.

Python

Das Beispiel unten verwendet Standard-Python-Bibliotheken zur Signatur von URLs. (Download Code.)

#!/usr/bin/python
# -*- coding: utf-8 -*-
""" Signs a URL using a URL signing secret """

import hashlib
import hmac
import base64
import 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, 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

if __name__ == "__main__":
  input_url = raw_input("URL to Sign: ")
  secret = raw_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. Ältere Versionen müssen ggf. Apache Commons o. Ä. verwenden. (Download Code.)

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

C#

Das Beispiel unten verwendet die standardmäßige Bibliothek System.Security.Cryptography zur Signatur einer URL-Anforderung. Beachten Sie, dass die Standard-Base64-Codierung konvertiert werden muss, um eine URL-sichere Version implementieren zu können. (Download Code.)

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

Sie können die folgende URL und den privaten Schlüssel testen, um zu prüfen, ob die richtige Signatur generiert wird. Beachten Sie, dass dieser private Schlüssel ausschließlich Testzwecken dient und von keinem Google-Dienst validiert wird.

  • URL: https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID
  • Privater Schlüssel: vNIXE0xscrmjlyV-12Nj_BvUPaw=
  • Zu signierender URL-Teil: /maps/api/geocode/json?address=New+York&client=clientID
  • Signatur: chaRF2hTJKOScPr-RQCEhZbSzIE=
  • Vollständige signierte URL: https://maps.googleapis.com/maps/api/geocode/json?address=New+York&client=clientID&signature=chaRF2hTJKOScPr-RQCEhZbSzIE=

Beispiele in weiteren Sprachen

Beispiele für weitere Sprachen finden Sie im Projekt url-signing.

Behandlung von Authentifizierungsproblemen

Wenn Ihre Anforderung falsch formatiert ist oder eine ungültige Signatur enthält, gibt die Webdienst-API den Fehler HTTP 403 (Forbidden) zurück.

Für die Problembehandlung von einzelnen URLs können Sie den URL-Signaturdebugger verwenden. Damit können Sie eine von Ihrer Anwendung generierte URL und Signatur schnell überprüfen.

Alternativ hierzu können Google Maps APIs for Work-Kunden sich zur Fehlerbehebung einzelner URLs im Google Cloud Support Portal anmelden und Resources > Google Maps online tools > URL Signing Debugger for Web Service and Image APIs auswählen.