Edge Security Acceleration:API schema compliance validation

非準拠リクエストの分析

スキーマ検証を設定すると、ESA は API リクエストを継続的に監視します。スキーマ検証 タブで、API リストのツールバーにあるフィルターアイコン をクリックし、スキーマを選択してリストをフィルターします。ESA は一致する API を表示し、[非準拠リクエスト] 列には過去 24 時間の非準拠リクエストの数が表示されます。

非準拠リクエストは、次の問題によって引き起こされる可能性があります。

• クライアント側のエラー：正当なクライアントが、不正な形式のリクエストを送信することがあります。例えば、パラメーター形式の誤り (JSON が必要なのにフォームデータを送信するなど)、必須パラメーターの欠落、型の不一致 (ブール値フィールドに文字列を送信するなど) があります。このような場合、フロントエンド設計を見直し、エラー検出、送信プロンプトなどの保護手段を追加してください。

• 悪意のある攻撃：攻撃者は、インジェクションやブルートフォース攻撃などの脆弱性を探索するために、不正な形式のリクエストを送信することがよくあります。非準拠リクエストの急増は、攻撃が進行中であることを示している可能性があります。攻撃が疑われる場合は、アクションをブロックに変更し、より厳格な WAF ルールを設定してください。

スキーマのない API の分析

スキーマファイルを正常にアップロードすると、スキーマに準拠する API は自動的にバインドされます。スキーマ検証 タブの スキーマなし API 数 列で、フィルター ボタンをクリックすると、スキーマのない API のリストが表示されます。

スキーマのない API の場合、ESA は非準拠リクエストをカウントできないため、潜在的なセキュリティギャップが生じます。API にスキーマがない理由は次のとおりです。

• スキーマからの漏れ：アップロードしたスキーマファイルに API が含まれていませんでした。リストで API のパス、ホスト、HTTP メソッドを確認し、スキーマファイルを更新して再度アップロードしてください。

• 非標準の API 設計：検出された API が標準的な設計プラクティスに従っていないため、スキーマと一致しません。API のリファクタリングが必要になる場合があります。一般的な問題は次のとおりです。

  • 非標準のパス：API パスが正しくありません。例えば、正しい paths エントリが /users であるべきところを、/user と定義されている場合などです。

  • 誤用された HTTP メソッド：メソッドがセマンティック規則に従っていません。例えば、DELETE の代わりに /users/delete/123 のような破壊的なアクションに GET メソッドを使用している場合などです。

  • ステータスコードの乱用：API レスポンスのステータスコードが正しくありません。例えば、すべてのレスポンスが 200 OK を返し、実際のステータスは { "responses": "500" } のようにレスポンスボディで返される場合などです。

  • 紛らわしい I/O 構造：入出力データが正しくありません。例えば、入力にあるべき email フィールドが出力に誤って配置されている場合などです。

タイプとサイズ

スキーマ検証ファイルは、.yml、.yaml、または .json 形式である必要があります。最大ファイルサイズは 58 KB です。スキーマファイルが大きすぎる場合は、.json 形式を使用し、アップロードする前にローカルでファイルを圧縮できます。

スキーマの内容

例

以下は、.json スキーマファイルの例です。

{
    "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"
                        }
                    }
                ]
            }
        }
    }
}