Conceptos clave

Antes de configurar definiciones en Security Rules, comprende sus conceptos fundamentales en detalle.

Configuraciones disponibles en Security Rules

Las Security Rules te permiten configurar el acceso HTTP y la autenticación para cada función Basic I/O y Advanced I/O en tu proyecto, definiendo valores para cada uno de esos parámetros en el archivo JSON.

Los siguientes valores se pueden establecer para cada definición de parámetro de una función:

Methods

El parámetro methods te permite definir los métodos HTTP que se pueden usar para acceder a una función. Catalyst proporciona soporte para los métodos GET, POST, DELETE, PUT y PATCH de manera predeterminada.

Cuando eliminas un método del archivo JSON para una función particular, el usuario final no podrá activar la función con ese método HTTP. Por ejemplo, si eliminas el método POST, el usuario no podrá pasar ningún valor de entrada en la llamada a la función usando ese método, y si eliminas el método GET para una función, el usuario no podrá llamar a la URL de la función Basic I/O o Advanced I/O.

Por lo tanto, puedes personalizar los métodos HTTP que se pueden permitir para llamar a una función y eliminar métodos innecesarios para una mejor seguridad.

Authentication

El parámetro authentication te permite habilitar o deshabilitar la autenticación para acceder a una función. Define si un usuario necesita autenticar su identidad para llamar a una función particular. El parámetro authentication se establece en optional para todas tus funciones de manera predeterminada cuando las creas.

Cuando este parámetro se establece en optional para una función, cualquier usuario podrá acceder a la URL de la función sin someterse a una verificación de autenticación. La URL de la función será, por lo tanto, accesible globalmente para todos y todas las llamadas a la función se permitirán sin restricciones de Catalyst.

Para restringir el acceso a la función solo a usuarios autenticados y aumentar la seguridad, puedes establecer el parámetro en required. Esto informa a Catalyst que realice una verificación de autenticación del usuario cuando llame a la función.

Security Rules admite dos tipos de métodos de autenticación:

• Autenticación de usuarios de Catalyst:
  

  Este método de autenticación habilita el acceso para todos los usuarios de tu aplicación de Catalyst agregados en Catalyst Authentication, de manera predeterminada. Puedes manejar este método de autenticación incorporando un formulario de inicio de sesión de usuario en tu aplicación de Catalyst y habilitando una sesión de inicio de sesión. Los usuarios de la aplicación entonces podrán llamar a la función automáticamente sin necesidad de pasar por ninguna verificación adicional de usuario.

• Autenticación basada en OAuth:
  

  Este método de autenticación habilita el acceso para los usuarios con un token de acceso OAuth. Puedes pasar el token de acceso como un encabezado en la solicitud de llamada a la función como se muestra en este ejemplo:

curl -X POST \
https://shipmenttracking-61317105.zohocatalyst.com/CustomerPortal/create \
-H "Authorization: Zoho-oauthtoken 1000.910*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*16.2f*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*57"

Para implementar la autenticación OAuth en tu aplicación de Catalyst, consulta nuestra documentación de ayuda de autenticación OAuth para pasos detallados.

Configuración de Security Rules para funciones Basic I/O y Advanced I/O

Las definiciones de Security Rules para una función Basic I/O se configuran con los siguientes valores predeterminados cuando se crea la función:

"functions": {
        "LogDelivery": {
            "methods": [
                "GET",
                "POST",
                "DELETE",
                "PUT",
                "PATCH"
            ],
            "authentication": "optional"
        }
    }

Las definiciones de Security Rules para una función Advanced I/O se configuran con los siguientes valores predeterminados cuando se crea la función:

"advancedio": {
        "CustomerPortal": [
            {
                ".*": {
                    "methods": [
                        "GET",
                        "POST",
                        "DELETE",
                        "PUT",
                        "PATCH"
                    ],
                    "authentication": "optional"
                }
            }
        ]
    }

De manera predeterminada, Catalyst usa el patrón comodín .* para definir las configuraciones de una función Advanced I/O, indicando que estas definiciones se aplican a todas las rutas creadas en la función Advanced I/O.

Puedes configurar diferentes definiciones para cada ruta definida en una función Advanced I/O de manera individual. Por ejemplo, si has definido dos rutas llamadas /vendor y /customer en la función, puedes habilitar o deshabilitar métodos específicos y la autenticación para cada ruta de forma independiente como:

"advancedio": {
        "CustomerPortal": [
            {
                "/vendor": {
                    "methods": [
                        "GET",
                        "POST",
                        "PUT"
                    ],
                    "authentication": "required"
                },
                "/customer": {
                    "methods": [
                        "GET",
                        "POST",
                        "DELETE",
                        "PUT",
                        "PATCH"
                    ],
                    "authentication": "optional"
                }
            }
        ]
    }

Ventajas de API Gateway sobre Security Rules

Mientras que la característica de Security Rules define las configuraciones para funcionalidades básicas de enrutamiento y autenticación para tus funciones, API Gateway te permite crear APIs individuales, proporciona más flexibilidad en la personalización del enrutamiento y la autenticación, y ofrece funcionalidades adicionales.

Algunas ventajas de API Gateway sobre Security Rules incluyen:

• Además de los métodos HTTP soportados por Security Rules, puedes agregar todos los métodos HTTP bajo un único método llamado ANY y crear una sola API para él en API Gateway.
• Puedes configurar una URL de solicitud personalizada y una URL de destino y crear APIs individuales para cada método de solicitud para cada URL.
• Además de la autenticación de usuarios de Catalyst y la autenticación OAuth, API Gateway también admite autenticación usando API Keys.
• Puedes configurar el throttling para cada API individual.
• También puedes crear APIs para clientes web y configurar sus definiciones.