Authentification et autorisation

Cette page concerne uniquement les clients qui possèdent une ancienne licence Maps APIs for Work ou Maps API for Business. Cette page ne s'applique pas aux clients qui disposent du nouveau Google Maps APIs Premium Plan, sorti en janvier 2016.

ID client et signatures

Pour les clients Google Maps APIs for Work, les API d'image (Static Maps API et Street View Image API) acceptent un ID client et une signature unique pour l'authentification.

ID client et signature

Lors de l'utilisation des API d'image avec une licence Google Maps APIs for Work, deux paramètres d'authentification sont obligatoires en plus des paramètres standard :

  • Votre ID client. Pour accéder aux fonctionnalités spéciales de Google Maps APIs for Work, vous devez fournir un ID client dès que vous accédez à une bibliothèque ou un service de l'API. Lors de l'inscription à Google Maps APIs for Work, le Google Cloud Support Portal vous enverra cet ID client. Tous les ID client commencent par le préfixe gme-. Indiquez votre ID client comme valeur du paramètre client.

  • Une signature unique, générée à l'aide de votre clé cryptographique privée. Renseignez cette signature comme valeur du paramètre signature. Vous trouverez plus d'informations sur la génération d'une signature ci-dessous, dans la section sur les signatures numériques.

Static Maps API :

    <img src="https://maps.googleapis.com/maps/api/staticmap
      ?center=-15.800513,-47.91378
      &zoom=11
      &size=300x300
      &client=YOUR_CLIENT_ID
      &signature=SIGNATURE">

Street View Image API :

    <img src="https://maps.googleapis.com/maps/api/streetview
      ?location=40.720032,-73.988354
      &size=400x400
      &fov=90&heading=235&pitch=10
      &client=YOUR_CLIENT_ID
      &signature=SIGNATURE">

Vous ne devez pas inclure de paramètre key dans votre requête.

Signatures numériques, pour les clients Google Maps APIs for Work

Les requêtes vers les API d'image effectuées par les clients Google Maps APIs for Work nécessitent une signature numérique, générée à l'aide de la clé cryptographique privée qui vous a été communiquée dans votre mail de bienvenue.

Le processus de signature associe une URL et la clé au moyen d'un algorithme de chiffrement. La signature unique qui en résulte permet à nos serveurs de vérifier que tous les sites qui génèrent des requêtes à l'aide de votre ID client sont autorisés à le faire. La signature est également unique au niveau d'une URL, afin de garantir que les requêtes qui utilisent votre ID client ne puissent être modifiées qu'en demandant la création d'une autre signature.

Votre clé cryptographique privée

Votre clé cryptographique privée de signature d'URL sera générée avec votre ID client et correspond à une « clé à secret partagé » entre vous et Google. Cette clé de signature n'appartient qu'à vous et est spécifique à votre ID client. Votre clé de signature doit donc être conservée en lieu sûr. Cette clé ne doit pas être transmise dans une requête, stockée sur un site Web, ni publiée sur un forum public. Quiconque obtient cette clé de signature peut envoyer des requêtes en utilisant votre identité.

Remarque : Cette clé cryptographique privée de signature est différente des clés d'API émises par la Google API Console.

En cas de perte de votre clé cryptographique privée, connectez-vous au Google Cloud Support Portal et cliquez sur Maps: Manage Client ID pour la récupérer.

Générer une signature numérique

Toute tentative d'accès aux API d'image avec une signature non valide générera une erreur HTTP 403 (Forbidden). Lors de la conversion de vos applications pour utiliser la signature d'URL, pensez à tester vos signatures pour vérifier qu'elles envoient une requête valide. Vous devez au préalable tester si l'URL d'origine est valide et si les signatures générées sont correctes.

Procédez comme suit pour créer une signature numérique pour votre requête :

  1. Construisez l'URL de la requête sans la signature, en veillant à inclure le paramètre client. Notez que tout caractère non standard devra être codé en URL :

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

    Street View Image API : https://maps.googleapis.com/maps/api/streetview?location=41.403609,2.174448&size=456x456&client=clientID

    Remarque : Tous les services Google nécessitent le codage de caractères UTF-8 (qui inclut implicitement ASCII). Si vos applications utilisent d'autres jeux de caractères, veillez à ce qu'elles créent les URL au format UTF-8 et les codent en URL de manière appropriée.

  2. Supprimez la partie domaine de la requête pour ne conserver que le chemin et la demande :

    Static Maps API : /maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=clientID

    Street View Image API : /maps/api/streetview?location=41.403609,2.174448&size=456x456&client=clientID

  3. Récupérez votre clé privée, encodée en Base64 modifié pour les URL, et signez l'URL ci-dessus à l'aide de l'algorithme HMAC-SHA1. Vous devrez peut-être décoder cette clé dans son format binaire d'origine. Notez que dans la plupart des bibliothèques cryptographiques, la signature sera générée au format binaire.

    Remarque : Le format Base64 modifié pour les URL remplace les caractères + et / du format Base64 standard par les caractères - et _, respectivement. Ces signatures Base64 n'ont donc plus besoin d'être codées en URL.

  4. Codez la signature binaire générée à l'aide du format Base64 modifié pour les URL afin de la convertir de sorte à être incluse dans une URL.

  5. Associez cette signature à l'URL au sein d'un paramètre signature :

    Static Maps API :https://maps.googleapis.com/maps/api/staticmap?center=40.714%2c%20-73.998&zoom=12&size=400x400&client=clientID&signature=base64signature

    Street View Image API:https://maps.googleapis.com/maps/api/streetview?location=41.403609,2.174448&size=456x456&client=clientID&signature=base64signature

Pour des exemples de mise en œuvre de la signature d'URL à l'aide du code côté serveur, voir Exemple de code de signature d'URL.

Exemple de code de signature d'URL

Les sections suivantes expliquent comment mettre en œuvre la signature d'URL à l'aide du code côté serveur. Les URL doivent toujours être signées côté serveur afin de masquer votre clé cryptographique aux utilisateurs.

Python

L'exemple ci-dessous utilise les bibliothèques Python standard pour signer une URL. (Télécharger le 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

L'exemple ci-dessous utilise la classe java.util.Base64 disponible depuis la version JDK 1.8 (les versions plus anciennes pourront avoir besoin d'Apache Commons ou similaire). (Télécharger le 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#

L'exemple ci-dessous utilise la bibliothèque System.Security.Cryptography par défaut pour signer une requête d'URL. Notez que nous devons convertir le codage Base64 par défaut pour pouvoir mettre en œuvre une version d'URL sécurisée. (Télécharger le 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));
    }
  }
}

Résolution des problèmes d'authentification

Si votre requête est mal définie ou intègre une signature non valide, l'API d'image renvoie une erreur HTTP 403 (Forbidden).

Pour résoudre les problèmes liés aux URL, utilisez l'outil URL Signing Debugger. Il vous permet de valider rapidement les URL et les signatures générées par votre application.

Par ailleurs, les clients Google Maps APIs for Work peuvent résoudre les problèmes liés aux URL en se connectant au Google Cloud Support Portal et en sélectionnant Resources > Google Maps APIs for Work online tools > URL Signing Debugger for Web Service and Image APIs.