Skip to content

Commit d7f938f

Browse files
[Page Shield] Update alerts (#22679)
--------- Co-authored-by: Rebecca Tamachiro <[email protected]>
1 parent 7433952 commit d7f938f

File tree

17 files changed

+157
-117
lines changed

17 files changed

+157
-117
lines changed

public/__redirects

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,6 +1003,8 @@
10031003
/page-shield/use-dashboard/monitor-connections/ /page-shield/detection/monitor-connections-scripts/ 301
10041004
/page-shield/use-dashboard/monitor-scripts/ /page-shield/detection/monitor-connections-scripts/ 301
10051005
/support/firewall/tools/troubleshooting-page-shield/ /page-shield/troubleshooting/ 301
1006+
/page-shield/reference/alerts/ /page-shield/alerts/alert-types/ 301
1007+
/page-shield/detection/configure-alerts/ /page-shield/alerts/configure/ 301
10061008

10071009
# queues
10081010
/queues/configuration/ /queues/reference/configuration/ 301

src/content/docs/page-shield/reference/alerts.mdx renamed to src/content/docs/page-shield/alerts/alert-types.mdx

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,60 @@
11
---
2-
title: Page Shield alerts
2+
title: Alert types
33
pcx_content_type: reference
44
sidebar:
55
order: 3
6-
label: Alerts
6+
label: Alert types
77
---
88

99
import { AvailableNotifications } from "~/components";
1010

11-
You can configure alerts for resources detected in your domain. Refer to [Configure Page Shield alerts](/page-shield/detection/configure-alerts/) for instructions.
11+
You can configure alerts for resources detected in your domain. Refer to [Page Shield alerts](/page-shield/alerts/) for more information.
1212

1313
## New resource alerts
1414

15+
:::note
16+
Requires a Business plan or higher.
17+
:::
18+
1519
<AvailableNotifications
1620
product="Page Shield"
1721
notificationFilter="Page Shield New Resources Alert"
18-
/> <AvailableNotifications
22+
/>
23+
<AvailableNotifications
1924
product="Page Shield"
2025
notificationFilter="Page Shield New Domain Alert"
21-
/> <AvailableNotifications
26+
/>
27+
<AvailableNotifications
2228
product="Page Shield"
2329
notificationFilter="Page Shield New Resource Exceeds Max URL Length Alert"
2430
/>
2531

2632
## Code change alert
2733

34+
:::note
35+
Requires an Enterprise plan with a paid add-on.
36+
:::
37+
2838
<AvailableNotifications
2939
product="Page Shield"
3040
notificationFilter="Page Shield New Code Change Detection Alert"
3141
/>
3242

3343
## Malicious resource alerts
3444

45+
:::note
46+
Requires an Enterprise plan with a paid add-on.
47+
:::
48+
3549
<AvailableNotifications
3650
product="Page Shield"
3751
notificationFilter="Page Shield New Malicious Domain Alert"
38-
/> <AvailableNotifications
52+
/>
53+
<AvailableNotifications
3954
product="Page Shield"
4055
notificationFilter="Page Shield New Malicious URL Alert"
41-
/> <AvailableNotifications
56+
/>
57+
<AvailableNotifications
4258
product="Page Shield"
4359
notificationFilter="Page Shield New Malicious Script Alert"
4460
/>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Configure a Page Shield alert
3+
pcx_content_type: how-to
4+
sidebar:
5+
order: 2
6+
label: Configure an alert
7+
description: Configure scoped or unscoped Page Shield alerts to get notified about relevant client-side changes on your zones.
8+
---
9+
10+
import { Render } from "~/components";
11+
12+
<Render file="alerts-configure" />
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Page Shield alerts
3+
pcx_content_type: concept
4+
sidebar:
5+
order: 5
6+
group:
7+
label: Alerting
8+
description: Page Shield alerts notify you when new scripts are detected
9+
on your domain or when Page Shield detects resources that are likely
10+
malicious.
11+
---
12+
13+
import { Render } from "~/components";
14+
15+
:::note
16+
New resource alerts require a Business plan or higher. Code change and malicious resource alerts require an Enterprise plan with a paid add-on. For details, refer to [Alert types](/page-shield/alerts/alert-types/).
17+
:::
18+
19+
<Render file="alerts-intro" />
20+
21+
You can configure unscoped or scoped alerts:
22+
23+
- **Unscoped alert**: An alert configured for all zones in your Cloudflare account. Unscoped alerts are trigged either daily, hourly, or immediately, depending on the [alert type](/page-shield/alerts/alert-types/).
24+
25+
- **Scoped alert**: An alert scoped to one or more zones. You must configure [policies](/page-shield/policies/) for the zones you select to receive any notifications. Scoped alerts are triggered immediately. Policy violations will not trigger an alert. For more information, refer to [Scoped alerts](#scoped-alerts).
26+
27+
:::note
28+
Cloudflare only takes into account [policies in allow mode](/page-shield/policies/#policy-actions) for scoped alerts.
29+
:::
30+
31+
For alerts sent at regular intervals, you might experience a delay between adding a new script and receiving an alert.
32+
33+
For instructions on configuring alerts, refer to [Configure a Page Shield alert](/page-shield/alerts/configure/).
34+
35+
## Scoped alerts
36+
37+
:::note
38+
Applies to Enterprise customers with a paid add-on.
39+
:::
40+
41+
If you have configured [allow policies](/page-shield/policies/#policy-actions) in a zone — policies which allow specific scripts and connections and block everything else — you can filter alert notifications according to those policies. These alerts are called scoped alerts.
42+
43+
When you create a scoped alert using the **Policies of these zones** alert filter, you will only receive the most relevant notifications based on the values of the allow policies you configured.
44+
45+
For each scoped alert, Page Shield does the following:
46+
47+
1. Check which allow policies in a zone are enabled.
48+
2. For every enabled policy, compare the URL of the new or changed resource against the allowed sources in the policy.
49+
3. If the resource is allowed by the policy, check if the new or modified resource should trigger the current Page Shield alert.
50+
4. If the alert should trigger, send an alert notification to the configured destinations.
51+
52+
When you create a scoped alert you will not receive notifications for resources blocked by an allow policy. These are [policy violations](/page-shield/policies/violations/) that you can review in the dashboard, through GraphQL, or via Logpush.
53+
54+
:::note
55+
56+
You will not receive notifications for a scoped alert in the following cases:
57+
58+
- No configured policies in the zone
59+
- Policy configured in log mode
60+
- Policy is not enabled
61+
62+
:::
63+
64+
For unscoped alerts, you will receive alerts for resources detected in all your zones, and you may receive alerts about resources that are blocked by one of your configured allow policies.

src/content/docs/page-shield/detection/configure-alerts.mdx

Lines changed: 0 additions & 51 deletions
This file was deleted.

src/content/docs/page-shield/detection/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Detection and alerting
2+
title: Detection
33
pcx_content_type: navigation
44
sidebar:
55
order: 4
66
group:
77
hideIndex: true
88
head: []
9-
description: Learn more about Page Shield's detection and alerting features.
9+
description: Learn more about Page Shield's detection features.
1010
---
1111

1212
import { DirectoryListing } from "~/components";

src/content/docs/page-shield/detection/review-changed-scripts.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@ sidebar:
55
order: 4
66
head: []
77
description: Learn how to review scripts on your domain after receiving a code change alert.
8-
98
---
109

1110
:::note
12-
1311
Available as a paid add-on for customers on an Enterprise plan.
1412
:::
1513

1614
Page Shield analyzes the JavaScript dependencies in the pages of your domain over time.
1715

18-
You can configure a notification for [code change alerts](/page-shield/reference/alerts/#code-change-alert) to receive a daily notification about changed scripts in your domain.
16+
You can configure a notification for [code change alerts](/page-shield/alerts/alert-types/#code-change-alert) to receive a daily notification about changed scripts in your domain.
1917

2018
When you receive such a notification:
2119

src/content/docs/page-shield/detection/review-malicious-scripts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To review the scripts considered malicious:
3838

3939
4. Based on the displayed information, and with the help of the [last seen/first seen fields in the script details](/page-shield/detection/monitor-connections-scripts/#view-details), review and update the pages where the malicious script was detected.
4040

41-
You can configure alerts for detected malicious scripts. Refer to [Page Shield alerts](/page-shield/reference/alerts/) for more information on the available alert types.
41+
You can configure alerts for detected malicious scripts. Refer to [Page Shield alerts](/page-shield/alerts/) for more information.
4242

4343
## Review malicious connections
4444

src/content/docs/page-shield/get-started.mdx

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ Depending on your plan, you may be able to also review the connections made by s
3131

3232
## Configure alerts
3333

34-
:::note
35-
Only available to customers on a Business or Enterprise plan.
36-
:::
37-
38-
<Render file="alerts-intro" />
34+
<Render
35+
file="alerts-intro"
36+
params={{
37+
availabilityDetails:
38+
"The available alert types depend on your Cloudflare plan.",
39+
}}
40+
/>
3941

4042
<Render file="alerts-configure" />
4143

src/content/docs/page-shield/how-it-works/malicious-script-detection.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ In addition to the integrity score, Page Shield will also provide individual sco
3434
- **Crypto mining**
3535
- **Malware**
3636

37-
You can configure [Malicious Script Alerts](/page-shield/reference/alerts/). You will receive an alert notification as soon as Cloudflare detects JavaScript code classified as malicious in your domain.
37+
You can [configure Malicious Script Alerts](/page-shield/alerts/configure/). You will receive an alert notification as soon as Cloudflare detects JavaScript code classified as malicious in your domain.
3838

3939
## Malicious URL checks
4040

4141
Page Shield will search for the URLs of your JavaScript dependencies in threat intelligence feeds to determine if any of those scripts should be categorized as malicious.
4242

4343
The Page Shield dashboards display the scripts that were considered malicious at the top of the scripts list.
4444

45-
You can [configure Malicious URL Alerts](/page-shield/reference/alerts/) to receive an alert notification as soon as Cloudflare detects a script from a malicious URL in your domain.
45+
You can [configure Malicious URL Alerts](/page-shield/alerts/configure/) to receive an alert notification as soon as Cloudflare detects a script from a malicious URL in your domain.
4646

4747
Depending on your current configuration, Page Shield can also search for malicious URLs in the URLs of outgoing connections made by scripts in your domain. To enable this check, you must [allow Page Shield to use the full URLs of outgoing connections](/page-shield/reference/settings/#connection-target-details) instead of only the hostname in Page Shield settings.
4848

@@ -54,7 +54,7 @@ A domain previously reported as malicious can later be reported as non-malicious
5454

5555
Page Shield will also check the target domains of connections made by scripts in your domain's pages, following the same approach described for scripts.
5656

57-
You can configure [Malicious Domain Alerts](/page-shield/reference/alerts/) to receive an alert notification as soon as Cloudflare detects a malicious script loaded from a known malicious domain in your domain.
57+
You can [configure Malicious Domain Alerts](/page-shield/alerts/configure/) to receive an alert notification as soon as Cloudflare detects a malicious script loaded from a known malicious domain in your domain.
5858

5959
---
6060

0 commit comments

Comments
 (0)