Adición de soporte de mTLS a despliegues de API

Para agregar una política de solicitud mTLS a una especificación de despliegue de API mediante la consola:

1. Cree o actualice un despliegue de API con la consola, seleccione la opción Desde cero e introduzca los detalles en la página Información básica.

   Para obtener más información, consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API y Actualización de un gateway de API.

2. En la sección Políticas de solicitud de API de la página Información básica, en Mutual-TLS, seleccione la opción Activar mTLs y, opcionalmente, especifique:

   • Nombre alternativo de asunto (SAN) / Nombre común: valores que deben aparecer en uno o más de los siguientes campos del certificado presentado por el cliente de API para que el gateway de API acepte solicitudes del cliente:
     • Dirección de correo electrónico
     • URL
     • Nombre del Dominio

     Por ejemplo, example.com. Puede especificar hasta 10 valores por defecto (puede cambiar este límite interno). La validación no distingue entre mayúsculas y minúsculas.

     Puede incluir un comodín asterisco (*) al inicio y/o al final de cada valor para representar cero, uno o más caracteres. No puede incluir un comodín asterisco en el medio del valor. Por ejemplo:

     • *.example.com coincide con server.example.com
     • server.example.* coincide con server.example.com
     • *.example.* coincide con server.example.com
     • server.*.com no coincide con server.example.com porque el comodín no puede estar en el medio del valor

     Si especifica valores al configurar mTLS para un despliegue de API, el gateway de API rechazará las solicitudes de clientes de API que presenten certificados que no los contengan. Si no especifica valores al configurar mTLS, el gateway de API aceptará todas las solicitudes de los clientes de API que proporcionen el certificado es válido.

3. Seleccione Revisar para revisar los detalles introducidos para el despliegue de API.
4. Seleccione Crear o Guardar cambios para crear o actualizar el despliegue de API.
5. (Opcional) Confirme que la API se ha desplegado correctamente llamándola. Para ello, consulte Llamada a una API desplegada en un gateway de API.

Pasos para agregar una política de solicitud mTLS a una especificación de despliegue de API en un archivo JSON:

1. Con el editor de JSON de su elección, edite la especificación de despliegue de API existente a la que desea agregar soporte de mTLS o cree una nueva especificación de despliegue de API (consulte Creación de una especificación de despliegue de API).

   Por ejemplo, la siguiente especificación básica de despliegue de API define una función sencilla de Hello World sin servidor en OCI Functions como un único backend:

   {
     "routes": [
       {
         "path": "/hello",
         "methods": ["GET"],
         "backend": {
           "type": "ORACLE_FUNCTIONS_BACKEND",
           "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
         }
       }
     ]
   }

2. Para especificar una política de solicitud de mTLS que se aplica globalmente a todas las rutas de un despliegue de API:

   1. Inserte una sección requestPolicies antes de la sección routes si no existe ninguna. Por ejemplo:

      {
        "requestPolicies": {},
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

   2. Añada la siguiente política mutualTLS a la nueva sección requestPolicies para aplicarla de forma global a todas las rutas de un despliegue de API:

      {
        "requestPolicies": {
          "mutualTls":{
            "isVerifiedCertificateRequired": true|false,
            "allowedSans": [<list-of-values>]
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

      donde:

      • "isVerifiedCertificateRequired": true|false, es true o false, lo que indica si mTLS está activado para el despliegue de API. Si no se especifica, el valor por defecto es false.
      • "allowedSans": [<list-of-values>] es una lista opcional de valores separados por comas que debe aparecer en uno o más de los siguientes campos del certificado presentado por el cliente de API para que el gateway de API acepte solicitudes del cliente:
        • Dirección de correo electrónico
        • URL
        • Nombre del Dominio

        Por ejemplo, example.com. Puede especificar hasta 10 valores por defecto (puede cambiar este límite interno). La validación no distingue entre mayúsculas y minúsculas.

        Puede incluir un comodín asterisco (*) al inicio y/o al final de cada valor para representar cero, uno o más caracteres. No puede incluir un comodín asterisco en el medio del valor. Por ejemplo:

        • *.example.com coincide con server.example.com
        • server.example.* coincide con server.example.com
        • *.example.* coincide con server.example.com
        • server.*.com no coincide con server.example.com porque el comodín no puede estar en el medio del valor

        Si especifica valores al configurar mTLS para un despliegue de API, el gateway de API rechazará las solicitudes de clientes de API que presenten certificados que no los contengan. Si no especifica valores al configurar mTLS, el gateway de API aceptará todas las solicitudes de los clientes de API que proporcionen el certificado es válido.

      Por ejemplo:

      {
        "requestPolicies": {
          "mutualTls":{
            "isVerifiedCertificateRequired": true,
            "allowedSans": [
              "example.com",
              "example.co.uk"
            ]
          }
        },
        "routes": [
          {
            "path": "/hello",
            "methods": ["GET"],
            "backend": {
              "type": "ORACLE_FUNCTIONS_BACKEND",
              "functionId": "ocid1.fnfunc.oc1.phx.aaaaaaaaab______xmq"
            }
          }
        ]
      }

3. Guarde el archivo JSON que contiene la especificación de despliegue de API.

4. Utilice la especificación de despliegue de API al crear o actualizar un despliegue de API de las siguientes formas:

   • Especificando el archivo JSON en la consola al seleccionar la opción Cargar API.
   • Especificando el archivo JSON en una solicitud para la API REST de gateway de API.

   Para obtener más información, consulte Despliegue de una API en un gateway de API mediante la creación de un despliegue de API y Actualización de un gateway de API.

5. (Opcional) Confirme que la API se ha desplegado correctamente llamándola. Para ello, consulte Llamada a una API desplegada en un gateway de API.