Edge Security Acceleration:Validation de la conformité des schémas d'API

Analyser les détails des requêtes

Pour identifier la cause racine des requêtes non conformes, examinez les journaux échantillonnés dans Events ou Security Analytics.

1. Identifiez d'abord une API présentant un nombre anormal de requêtes non conformes.

2. Choisissez la fonctionnalité de journalisation appropriée selon l'action configurée :

   • Action définie sur None : Ces requêtes ne déclenchant aucune action de sécurité, analysez-les dans Security Analytics.

   • Action définie sur Monitor ou Block : Ces requêtes déclenchant une action de sécurité, vous trouverez plus facilement les journaux associés dans Events.

3. Cette section prend Events comme exemple. Dans le volet de navigation de gauche, choisissez Security > Events.

   Pour utiliser Security Analytics, choisissez Security > Security Analytics dans le volet de navigation de gauche.

4. Sur la page Events, faites défiler jusqu'à la section Sampling Logs. Filtrez les journaux correspondant aux règles API Security. Cliquez sur l'icône de développement en regard d'une entrée de journal pour afficher ses détails et analyser la requête. Vous pouvez également utiliser Real-time Log pour une analyse plus détaillée des journaux d'accès.

Modifier l'action

Configurez une action par défaut pour toutes les API ou définissez une action spécifique pour des API individuelles.

• Modifier l'action par défaut globale : Dans l'onglet Schema Validation, cliquez sur Change dans la colonne Default Action et sélectionnez une action :

  • Block : Bloque la requête non conforme et enregistre l'événement.

  • Monitor : Autorise le passage de la requête non conforme et enregistre l'événement.

  • None : Aucune action n'est effectuée.

  

• Configurer une action pour une API spécifique : Dans la liste des API de l'onglet Schema Validation, cliquez sur Change Action pour l'API souhaitée et sélectionnez une action :

  • Default : Utilise l'action par défaut globale.

  • Block : Bloque la requête non conforme et enregistre l'événement.

  • Monitor : Autorise le passage de la requête non conforme et enregistre l'événement.

  • None : Aucune action n'est effectuée.

    

Version

La validation de schéma ESA prend uniquement en charge la spécification OpenAPI (OAS) v3.0.x.

Champs

Champs obligatoires

• openapi : La version de l'API, par exemple 3.0.0.

• info : Métadonnées concernant l'API, telles que "version": "1.0.0".

• paths : Doit contenir au moins un chemin d'API, par exemple /api.

• servers : Informations sur l'hôte. Les sous-champs suivants sont pris en charge :

  • url : Seules les URL absolues sont prises en charge, par exemple https://api.example.com.

  • variables : ESA ne prend pas en charge les variables de serveur. Les espaces réservés aux variables sont ignorés lors de l'analyse.

Champs facultatifs

• schema : Définition de la structure des données. Les types suivants sont pris en charge :

  • int32

  • uint32

  • int64

  • uint64

  • float

  • double

  • boolean

  • email

• reference : Utilise $ref pour référencer un objet prédéfini. Les références externes ou relatives ne sont pas prises en charge.

• requestBody : Définit le corps de la requête. Seules les données avec un content-type de application/json sont prises en charge.

{
    "openapi": "3.0.0",
    "info": {
        "title": "example",
        "description": "example",
        "version": "1.0"
    },
    "servers": [
    {
      "url": "https://example1.aliyun.com",
      "description": "example1 url"
    },
    {
      "url": "https://example2.aliyun.com",
      "description": "example2 url"
    }
    ],
    "components": {
        "schemas": {
            "ParamsObject": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "value": {
                        "type": "string"
                    }
                },
                "required": [
                    "id",
                    "value"
                ]
            }
        }
    },
    "paths": {
        "/example/{param1}": {
            "get": {
                "operationId": "getexampleById",
                "parameters": [
                    {
                        "name": "param1",
                        "in": "path",
                        "required": true,
                        "description": "id",
                        "schema": {
                            "type": "integer",
                            "format": "int32"
                        }
                    }
                ]
            }
        },
        "/api1": {
            "post": {
                "operationId": "post_api1",
                "summary": "post api1 request",
                "parameters": [],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ParamsObject"
                            }
                        }
                    }
                }
            },
            "get" :{
                "operationId": "get_api1",
                "summary": "get api1 request",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "integer",
                            "format": "int32"
                        }
                    },
                    {
                        "name": "name",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        }
    }
}