Skip to content

Commit 90978cb

Browse files
committed
Clarify payload content
1 parent b2ef0fb commit 90978cb

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

src/content/docs/waf/managed-rules/payload-logging/decrypt-in-logs.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Refer to the Worker project's [README](https://github.com/cloudflare/matched-dat
2323

2424
## Structure of `encrypted_matched_data` property in Logpush
2525

26+
Payload information includes the specific string that triggered the rule, along with the text that appears immediately before and after the match.
27+
2628
Once you decrypt its value, the `encrypted_matched_data` property of the `Metadata` field in Logpush has a structure similar to the following:
2729

2830
```jsonc
@@ -41,7 +43,7 @@ Once you decrypt its value, the `encrypted_matched_data` property of the `Metada
4143
}
4244
```
4345

44-
The `before` and `after` properties will contain at most 25 bytes of content appearing before and after the matched text.
46+
The `before` and `after` properties are optional (there may be no content before/after the matched text) and will contain at most 25 bytes of content appearing before and after the match.
4547

4648
Below are a few examples of payload matches:
4749

src/content/docs/waf/managed-rules/payload-logging/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ sidebar:
77

88
import { GlossaryTooltip } from "~/components";
99

10-
The WAF allows you to log the request information that triggered a specific rule of a managed ruleset. This information is known as the payload. Payload logging is especially useful when diagnosing the behavior of WAF rules. Since the values that triggered a rule may contain sensitive data, they are encrypted with a customer-provided public key so that only you can examine them later.
10+
The WAF allows you to log the request information that triggered a specific rule of a managed ruleset. This information is known as the payload. Payload information includes the specific string that triggered the rule, along with the text that appears immediately before and after the match.
1111

12-
:::note
12+
Payload logging is especially useful when diagnosing the behavior of WAF rules. Since the values that triggered a rule may contain sensitive data, they are encrypted with a customer-provided public key so that only you can examine them later.
1313

14+
:::note
1415
This feature is only available for customers on an Enterprise plan.
15-
1616
:::
1717

1818
## Turn on payload logging

src/content/docs/waf/managed-rules/payload-logging/view.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ View the content of the matched rule payload in the dashboard by entering your p
2121
The private key is not sent to a Cloudflare server. The decryption occurs entirely in the browser.
2222
:::
2323

24-
If the private key you entered decrypts the encrypted payload successfully, the dashboard will show the fields that matched and the matched payload in clear text, including some text before and after the match.
24+
If the private key you entered decrypts the encrypted payload successfully, the dashboard will show the name of the fields that matched and the matched string in clear text, along with some text appearing before and after the match.
2525

2626
![Viewing the decrypted payload match data after entering your private key in the dashboard](~/assets/images/waf/transform-rules/payload-decrypted.png)

0 commit comments

Comments
 (0)