Comprendre la modélisation de chemin d'accès

Dans API Gateway, il est possible d'acheminer les requêtes entrantes en fonction de la modélisation de chemin d'accès. La modélisation de chemin d'accès comporte trois composants principaux :

• Correspondance exacte
• Correspondance générique unique
• Correspondance générique double

Les sections suivantes décrivent chacun de ces composants et leur fonctionnement dans le contexte d'API Gateway.

Mot clé exact

Un chemin modélisé sans segment unique ou double (* ou **) est converti en correspondance de chemin exacte. Par exemple, la spécification OpenAPI de votre configuration d'API de passerelle peut contenir une section semblable à celle-ci :

...
paths:
  /shelves:
    get:
      summary: List shelves
...

Dans cet exemple, la passerelle n'accepte que les requêtes adressées à /shelves et aucun autre chemin.

Remarque : Les barres obliques encodées en URL (%2F) ne seront pas traitées comme des barres obliques réelles, ce qui signifie que %2Fshelves ne correspondra pas à l'opération OpenAPI ci-dessus.

Mise en correspondance d'un caractère générique unique

Si un chemin modélisé contient une variable, un segment générique unique (par exemple, {var} ou {var=*}), ou les deux, la passerelle autorise les requêtes entrantes qui respectent les conditions suivantes :

• Les requêtes ne contiennent pas de barre oblique supplémentaire (/), ce qui signifie que la variable ne correspondra qu'à un seul segment de chemin.
• Les requêtes contiennent au moins un caractère.
• Les requêtes peuvent contenir une barre oblique supplémentaire si elles sont présentes à la fin du chemin.

Remarque : Pour l'expansion des variables, tous les caractères, à l'exception de [-_.~/0-9a-zA-Z], sont encodés en pourcentage.

Par exemple, la spécification OpenAPI de votre configuration d'API de passerelle peut contenir une section semblable à celle-ci :

...
paths:
  /shelves/{shelf}/books/{book}: # Equivalent to /shelves/{shelf=*}/books/{book=*}
    get:
      summary: Retrieve a book
...

Dans cet exemple, la passerelle accepte les requêtes correspondant à l'expression régulière suivante :

^/shelves/[^/]+/books/[^/]+/?$

Mise en correspondance des caractères génériques doubles

Si un chemin modélisé contient une variable désignée par un double segment générique (par exemple {var=**}), la passerelle autorise les requêtes entrantes qui respectent les conditions suivantes :

• Les requêtes peuvent contenir tous les caractères, y compris les barres obliques (/).
• Les requêtes peuvent contenir zéro, un ou plusieurs caractères.
• Les requêtes peuvent contenir une barre oblique supplémentaire si elles sont présentes à la fin du chemin.

Remarque : Les variables à double caractère générique ne peuvent être utilisées que dans le dernier segment du chemin fourni. Cela signifie que /shelves/{shelf=**}/books/{book=**} n'est pas autorisé, car {shelf=**} n'est pas déclaré dans le dernier segment du chemin. Pour l'expansion variable, tous les caractères, à l'exception de [-_.~/0-9a-zA-Z], sont encodés en pourcentage.

Par exemple, la spécification OpenAPI de votre configuration d'API de passerelle peut contenir une section semblable à celle-ci :

...
paths:
  /shelves/{shelf=*}/books/{book=**}:
    get:
      summary: Retrieve a book
...

Dans cet exemple, la passerelle accepte les requêtes correspondant à l'expression régulière suivante :

^/shelves/[^/]+/books/.*/?$

Barres obliques encodées en URL

API Gateway respecte le protocole RFC 3986, qui ne traite pas les barres obliques encodées (%2F) comme des barres obliques réelles lors de la mise en correspondance des chemins d'URL pour les décisions de routage ou de sécurité. Si vous utilisez des barres obliques encodées en URL, votre backend doit traiter ces requêtes en conséquence.

Avertissement : Si votre backend s'attend à ce que les barres obliques encodées en URL (%2F) soient traitées comme des barres obliques réelles lors de la mise en correspondance des modèles de chemin d'accès API Gateway, les requêtes contenant des barres obliques encodées en URL peuvent correspondre à des opérations inattendues et entraîner un accès avec droits trop élevés aux ressources de backend.

Par exemple, considérons les spécifications OpenAPI suivantes :

securityDefinitions:
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"
paths:
  /shelves/{shelf}:
      get:
        parameters:
        - in: path
          name: shelf
          type: string
          required: true
          description: Shelf ID.
        summary: List shelves
        operationId: GetShelf
          responses:
            '200':
              description: A successful response
              schema:
                type: string
    /shelves/{shelf}/books/{book}:
      get:
        parameters:
        - in: path
          name: shelf
          type: string
          required: true
          description: Shelf ID.
        - in: path
          name: book
          type: string
          required: true
          description: Book ID
        summary: Retrieve a book
        operationId: GetBook
          responses:
            '200':
              description: A successful response
              schema:
                type: string
         security:
         - api_key: []

Dans cet exemple, l'opération /shelves/{shelf}/books/{book} nécessite une clé API, mais l'opération /shelves/{shelf} n'est pas restreinte.

Dans le cas où un utilisateur envoie une requête à /shelves/shelf_1%2Fbooks%2Fbook_2 :

• La passerelle traitera la requête en tant qu'opération GetShelf pour l'ID d'étagère shelf_1%2Fbooks%2Fbook_2. Dans ce cas, la vérification des clés API n'est pas appliquée.
• Si la requête %2F est normalisée avant tout traitement des requêtes par le backend, celle-ci peut être traitée comme l'opération GetBook pour l'ID de livre book_2. En d'autres termes, le backend traite /shelves/shelf_1%2Fbooks%2Fbook_2 comme étant /shelves/shelf_1/books/book_2.

Dans cet exemple, le backend s'attend à ce que l'opération GetBook effectue une vérification de clé API au niveau de la passerelle. Cependant, comme la passerelle a lu la requête en tant qu'opération GetShelf, aucune vérification de clé API n'a été effectuée.

Normalisation de plusieurs barres obliques adjacentes

API Gateway est conforme à la norme RFC 3986, qui stipule que les chemins d'accès comportant plusieurs barres obliques adjacentes seront traités comme des chemins différents de ceux comportant des barres obliques singulières. Par exemple, une requête contenant /shelves/// ne sera pas normalisée par la passerelle vers le chemin d'accès de la requête /shelves/ avant la mise en correspondance d'un modèle de chemin d'URI ni lors du transfert vers le backend spécifié.

Avertissement : Si votre backend normalise les chemins d'URL en fusionnant plusieurs barres obliques en une seule, les requêtes contenant plusieurs barres obliques adjacentes peuvent correspondre à des opérations de passerelle inattendues et entraîner un accès avec droits trop élevés à vos ressources backend.