← Dokumentace WAF / managed-rules / payload-logging

Konfigurace logování payloadu přes API

Použijte Rulesets API ke konfiguraci logování payloadů pro spravovanou sadu pravidel přes API.

1. Použijte Získání vstupní sady pravidel zóny operaci k získání následujících ID:

   • ID vstupní sada pravidel (entry point ruleset) http_request_firewall_managed fáze.
   • ID execute pravidlo nasazující spravovanou sadu pravidel WAF, pro kterou chcete nakonfigurovat logování payloadu.

2. Použijte Aktualizace pravidla v rulesetu zóny operaci k aktualizaci pravidla, které jste identifikovali v předchozím kroku.

   Zahrňte matched_data objekt v části pravidla action_parameters objekt ke konfiguraci protokolování payloadů. matched_data objekt má následující strukturu:

   "action_parameters": {
     // ...
     "matched_data": {
       "public_key": "<PUBLIC_KEY_VALUE>"
     }
   }

   Nahraďte <PUBLIC_KEY_VALUE> veřejným klíčem, který chcete použít pro protokolování payloadů. Veřejný klíč můžete vygenerovat v příkazové řádce nebo v dashboardu Cloudflare.

Tento příklad konfiguruje protokolování payloadů pro Cloudflare Managed Ruleset, která je již nasazena pro zónu s ID $ZONE_ID.

1. Vyvolejte Získání vstupní sady pravidel zóny operaci k získání pravidel aktuálně nakonfigurovaných ve vstupním rulesetu http_request_firewall_managed fáze.

   Získání vstupní sady pravidel zóny

   curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/phases/http_request_firewall_managed/entrypoint" \
   	--request GET \
   	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

   {
   	"result": {
   		"id": "060013b1eeb14c93b0dcd896537e0d2c", // entry point ruleset ID
   		"name": "default",
   		"description": "",
   		"source": "firewall_managed",
   		"kind": "zone",
   		"version": "3",
   		"rules": [
   			// (...)
   			{
   				"id": "1bdb49371c1f46958fc8b985efcb79e7", // `execute` rule ID
   				"version": "1",
   				"action": "execute",
   				"expression": "true",
   				"last_updated": "2024-01-20T14:21:28.643979Z",
   				"ref": "1bdb49371c1f46958fc8b985efcb79e7",
   				"enabled": true,
   				"action_parameters": {
   					"id": "efb7b8c949ac4650a09736fc376e9aee", // "Cloudflare Managed Ruleset" ID
   					"version": "latest"
   				}
   			}
   			// (...)
   		],
   		"last_updated": "2024-01-20T14:29:00.190643Z",
   		"phase": "http_request_firewall_managed"
   	},
   	"success": true,
   	"errors": [],
   	"messages": []
   }

2. Uložte si následující ID pro další krok:

   • ID vstupní sady pravidel (entry point ruleset): 060013b1eeb14c93b0dcd896537e0d2c
   • ID execute pravidlo nasazující Cloudflare Managed Ruleset: 1bdb49371c1f46958fc8b985efcb79e7

   Chcete-li najít správné pravidlo v rules vyhledejte execute pravidlo obsahující ID sady Cloudflare Managed Ruleset (...376e9aee) v action_parameters > id.

3. Vyvolejte Aktualizace pravidla v rulesetu zóny operaci k aktualizaci konfigurace pravidla, které jste identifikovali. Pravidlo nyní bude obsahovat konfiguraci protokolování payloadů (matched_data objekt).

   Aktualizace pravidla v rulesetu zóny

   curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/060013b1eeb14c93b0dcd896537e0d2c/rules/1bdb49371c1f46958fc8b985efcb79e7" \
   	--request PATCH \
   	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
   	--json '{
   		"action": "execute",
   		"action_parameters": {
   				"id": "efb7b8c949ac4650a09736fc376e9aee",
   				"matched_data": {
   						"public_key": "Ycig/Zr/pZmklmFUN99nr+taURlYItL91g+NcHGYpB8="
   				}
   		},
   		"expression": "true"
   	}'

   Odpověď bude obsahovat kompletní sadu pravidel po aktualizaci pravidla.

Další informace o nasazování spravovaných sad pravidel přes API viz Nasazení spravované sady pravidel v dokumentaci Ruleset Engine.

Zakázání logování payloadu pro spravovanou sadu pravidel:

1. Použijte Aktualizace pravidla v rulesetu zóny operaci k aktualizaci pravidla nasazujícího spravovanou sadu pravidel (pravidla s "action": "execute").

2. Upravte definici pravidla tak, aby neobsahovala matched_data objekt v action_parameters.

Například následující PATCH požadavek aktualizuje pravidlo s ID $RULE_ID nasazující Cloudflare Managed Ruleset tak, aby bylo logování payloadu zakázáno:

curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/rulesets/$RULESET_ID/rules/$RULE_ID" \
	--request PATCH \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"action": "execute",
		"action_parameters": {
				"id": "efb7b8c949ac4650a09736fc376e9aee"
		},
		"expression": "true"
	}'

Podrobnosti o získání ID vstupní sady pravidel a ID pravidla k aktualizaci najdete v Konfigurace a zapnutí logování payloadu.