Comprender las plantillas de ruta

Dentro de API Gateway, es posible enrutar las solicitudes entrantes según plantillas de ruta de acceso. La creación de plantillas de rutas tiene tres componentes principales:

• Coincidencia exacta
• Coincidencia de comodines únicos
• Coincidencia de comodines dobles

En las siguientes secciones, se describe cada uno de estos componentes y cómo funcionan dentro del contexto de API Gateway.

Coincidencia exacta

Una ruta de acceso con plantilla sin segmentos de comodín individuales o dobles (* o **) se convierte en una coincidencia de ruta de acceso exacta. Por ejemplo, la especificación de OpenAPI para la configuración de la API de tu puerta de enlace puede contener una sección como la siguiente:

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

En este ejemplo, la puerta de enlace solo aceptará solicitudes a /shelves y no a otras rutas.

Nota: Las barras diagonales codificadas en URL (%2F) no se tratarán como barras diagonales reales, lo que significa que %2Fshelves no coincidirán con la operación de OpenAPI anterior.

Coincidencia de comodines únicos

Si una ruta de acceso con plantilla contiene una variable, un segmento de comodín único (p. ej., {var} o {var=*}), o ambos, la puerta de enlace permitirá las solicitudes entrantes que cumplan con lo siguiente:

• Las solicitudes no contienen una barra diagonal adicional (/), lo que significa que la variable coincidirá con un solo segmento de ruta.
• Las solicitudes contienen al menos un carácter.
• Las solicitudes pueden contener una barra final adicional si está presente al final de la ruta de acceso.

Nota: Para la expansión de variables, todos los caracteres, excepto [-_.~/0-9a-zA-Z], están codificados en porcentajes.

Por ejemplo, la especificación de OpenAPI para la configuración de la API de tu puerta de enlace puede contener una sección como la siguiente:

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

En este ejemplo, la puerta de enlace aceptará solicitudes que coincidan con la siguiente regex:

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

Coincidencia de comodines dobles

Si una ruta de acceso con plantilla contiene una variable denotada por un segmento de comodín doble (p. ej. {var=**}), la puerta de enlace permitirá las solicitudes entrantes que cumplan con lo siguiente:

• Las solicitudes pueden contener todos los caracteres, incluidas las barras diagonales (/).
• Las solicitudes pueden contener 0 o más caracteres.
• Las solicitudes pueden contener una barra final adicional si está presente al final de la ruta de acceso.

Nota: Las variables de comodines dobles solo se pueden usar en el último segmento de la ruta de acceso proporcionada. Esto significa que no se permite /shelves/{shelf=**}/books/{book=**}, ya que {shelf=**} no se declaró en el último segmento de la ruta de acceso. Para la expansión de variables, todos los caracteres, excepto [-_.~/0-9a-zA-Z], se codifican con un porcentaje.

Por ejemplo, la especificación de OpenAPI para la configuración de API de tu puerta de enlace puede contener una sección como la siguiente:

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

En este ejemplo, la puerta de enlace aceptará solicitudes que coincidan con la siguiente regex:

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

Barras diagonales codificadas en URL

API Gateway sigue la RFC 3986, que no trata a las barras diagonales codificadas para URL (%2F) como barras reales cuando se hacen coincidir las rutas de URL para el enrutamiento o las decisiones de seguridad. Si se esperan barras con codificación URL, tu backend debe controlar estas solicitudes según corresponda.

Advertencia: Si tu backend espera que las barras diagonales codificadas en URL (%2F) se traten como barras reales cuando se coinciden con las plantillas de ruta de acceso de API Gateway, las solicitudes que contienen barras diagonales de URL codificadas pueden coincidir con operaciones inesperadas y generan un acceso con privilegios excesivos a los recursos de backend.

Por ejemplo, considera la siguiente especificación de OpenAPI:

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: []

En este ejemplo, la operación /shelves/{shelf}/books/{book} requiere una clave de API, pero la operación /shelves/{shelf} no tiene restricciones.

En el caso de que un usuario envíe una solicitud a /shelves/shelf_1%2Fbooks%2Fbook_2, haz lo siguiente:

• La puerta de enlace procesará la solicitud como una operación GetShelf para el ID de la biblioteca shelf_1%2Fbooks%2Fbook_2. En este caso, no se aplica una verificación de clave de API.
• Si se normaliza %2F antes de cualquier control de solicitudes por parte del backend, la solicitud se puede procesar como la operación GetBook para el ID del libro book_2. En otras palabras, el backend procesa /shelves/shelf_1%2Fbooks%2Fbook_2 como /shelves/shelf_1/books/book_2.

En este ejemplo, el backend espera que la operación GetBook realice una verificación de clave de API en la puerta de enlace. Sin embargo, debido a que la puerta de enlace leyó la solicitud como una operación GetShelf, no se realizó ninguna verificación de clave de API.

Normalización de varias barras diagonales adyacentes

API Gateway sigue la RFC 3986, que indica que las rutas con varias barras diagonales adyacentes se tratarán como una ruta de acceso diferente de las que tienen barras diagonales únicas. Por ejemplo, una solicitud que contiene /shelves/// no será normalizada por la puerta de enlace a la ruta de la solicitud /shelves/ antes de hacer coincidir una plantilla de ruta del URI ni cuando se reenvía al el backend especificado.

Advertencia: Si tu backend normaliza las rutas de URL combinando varias barras diagonales en una sola, las solicitudes que contienen varias barras diagonales adyacentes pueden coincidir con operaciones de puerta de enlace inesperadas y generar un acceso con privilegios excesivos a tus recursos de backend.