Skip to content

Commit 2c935b2

Browse files
[WAF] Update dashboard instructions (#20759)
--------- Co-authored-by: marciocloudflare <[email protected]>
1 parent eeb4aad commit 2c935b2

File tree

17 files changed

+409
-10
lines changed

17 files changed

+409
-10
lines changed

public/robots.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ Disallow: /plans/
55
Disallow: /constellation
66
Disallow: /cdn-cgi/
77
Disallow: /google-tag-first-party-mode/
8+
Disallow: /security/
89

910
Sitemap: https://developers.cloudflare.com/sitemap-index.xml

src/components/overrides/Head.astro

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import type { CollectionEntry } from "astro:content";
1010
// grab the current top-level folder. Remove . characters for 1.1.1.1 URL
1111
const currentSection = Astro.url.pathname.split("/")[1].replaceAll(".", "");
1212
const head = Astro.locals.starlightRoute.entry.data.head;
13+
const noIndexProductsList = ["style-guide", "security"];
1314
1415
if (currentSection) {
1516
const product = await getEntry("products", currentSection);
@@ -77,7 +78,7 @@ if (currentSection) {
7778
}
7879
}
7980
80-
if (currentSection === "style-guide") {
81+
if (noIndexProductsList.includes(currentSection)) {
8182
head.push({
8283
tag: "meta",
8384
attrs: {

src/content/docs/api-shield/security/jwt-validation/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ To automatically keep your JWKS up to date when your identity provider refreshes
3535

3636
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
3737
2. Go to **Security** > **API Shield** > **API Rules**.
38-
3. Add a name for your rule.
38+
3. <a id="rule-form"/>
39+
Add a name for your rule.
3940
4. Select a hostname to protect requests with saved endpoints using the rule.
4041
5. Deselect any endpoints that you want JWT Validation to ignore (for example, an endpoint used to generate a JWT).
4142
6. Select the Token Validation Configuration that corresponds to the incoming requests.

src/content/docs/api-shield/security/sequence-mitigation/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ For example, if there was an authorization bug that allowed users to iterate thr
4545
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
4646
2. Go to **Security** > **API Shield** > **API Rules**.
4747
3. Select **Create sequence rule**.
48-
4. Name your rule.
48+
4. <a id="rule-form"/>
49+
Name your rule.
4950
5. Select a starting endpoint. This is the endpoint that you expect users to hit first in their request flow when using your API.
5051
1. Choose a hostname to display the list of endpoints for that hostname.
5152
2. Choose an endpoint.

src/content/docs/page-shield/policies/create-dashboard.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ description: Learn how to create a Page Shield policy in the Cloudflare dashboar
1313

1414
3. Select **Create policy**.
1515

16-
4. Enter a descriptive name for the rule in **Description**.
16+
4. <a id="rule-form" />
17+
Enter a descriptive name for the rule in **Description**.
1718

1819
5. Under **If incoming requests match**, define the policy scope. You can use the Expression Builder (specifying one or more values for **Field**, **Operator**, and **Value**) or manually enter an expression using the Expression Editor. For more information, refer to [Edit expressions in the dashboard](/ruleset-engine/rules-language/expressions/edit-expressions/).
1920

@@ -23,7 +24,6 @@ description: Learn how to create a Page Shield policy in the Cloudflare dashboar
2324
- To refresh the displayed sources based on Page Shield's detected resources, select **Refresh suggestions**.
2425

2526
:::note
26-
2727
Page Shield provides suggestions for **Default**, **Scripts**, and **Connections** directives. For the **Default** directive, suggestions are based on monitored scripts and connections resources.
2828
:::
2929

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Security Analytics
3+
pcx_content_type: concept
4+
sidebar:
5+
order: 3
6+
description: Security Analytics shows information about all incoming HTTP requests or mitigated requests (rule matches).
7+
---
8+
9+
import { GlossaryTooltip } from "~/components";
10+
11+
Security Analytics shows information about all incoming HTTP requests or only about requests mitigated by Cloudflare.
12+
13+
Use Security Analytics as your starting point to understand and analyze traffic patterns, and to create security rules based on the filters you applied.
14+
15+
## Traffic
16+
17+
The **Traffic** tab displays information about all incoming HTTP requests for your domain, including requests not handled by Cloudflare security products.
18+
19+
In this tab you can perform several tasks:
20+
21+
- View the traffic distribution for your domain.
22+
- Understand which traffic is being mitigated by Cloudflare security products, and where non-mitigated traffic is being served from (Cloudflare global network or [origin server](https://www.cloudflare.com/learning/cdn/glossary/origin-server/)).
23+
- Analyze suspicious traffic and create tailored custom [security rules](/security/rules/) based on applied filters.
24+
- [Find an appropriate rate limit](/waf/rate-limiting-rules/find-rate-limit/) for incoming traffic.
25+
26+
For information on how to use the **Traffic** tab, refer to [Security Analytics](/waf/analytics/security-analytics/#adjusting-displayed-data).
27+
28+
If you need to modify existing security-related rules you already configured, consider also using the [Events](#events) tab. This tab displays information about requests affected by Cloudflare security products.
29+
30+
### Suspicious activity
31+
32+
The suspicious activity gives you information about suspicious requests that were identified by the Cloudflare detections you have enabled. The supported detections include:
33+
34+
- [Account takeover](/bots/concepts/detection-ids/#account-takeover-detections)
35+
- [Leaked credential check](/waf/detections/leaked-credentials/) (only for user and password leaked)
36+
- [Malicious uploads](/waf/detections/malicious-uploads/)
37+
- Firewall for AI
38+
- [WAF attack score](/waf/detections/attack-score/)
39+
40+
Each suspicious activity is classified with a severity score that can vary from critical to low. You can use the filter option to investigate further.
41+
42+
:::note
43+
The **Traffic** tab includes functionality available in the [Security Analytics](/waf/analytics/security-analytics/) page in the previous dashboard navigation structure. However, some page elements will appear in a different order, or they may be unavailable in the **Traffic** tab, such as Insights or the score-based analyses sidebar.
44+
:::
45+
46+
## Events
47+
48+
Use the **Events** tab to review <GlossaryTooltip term="mitigated request">mitigated requests</GlossaryTooltip> and to tailor your security configurations.
49+
50+
The **Events** tab displays information about requests actioned or flagged by Cloudflare security products. Each incoming HTTP request might generate one or more security events. The tab only shows these events, not the HTTP requests themselves. To obtain information on all incoming HTTP requests, use the [Traffic](#traffic) tab.
51+
52+
Users on a Free plan can view summarized events by date in sampled logs. Customers on paid plans have access to additional graphs and dashboards that summarize the most relevant information about the current behavior of Cloudflare's security features on your zone.
53+
54+
For more information on the **Events** tab, refer to [Security Events](/waf/analytics/security-events/).
55+
56+
:::note
57+
The **Events** tab corresponds to the [Security Events](/waf/analytics/security-events/) page in the previous dashboard navigation structure.
58+
:::
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Security dashboard (beta)
3+
pcx_content_type: overview
4+
sidebar:
5+
order: 1
6+
description: The Security dashboard (beta) helps you understand the current security posture of your web applications and allows you configure different security rules for those applications.
7+
head:
8+
- tag: title
9+
content: Overview
10+
---
11+
12+
import { Card, CardGrid, Feature, LinkTitleCard, RelatedProduct } from "~/components";
13+
14+
The Security dashboard (beta) is your starting point to better understand the security posture of your web applications, and to configure rules to protect them.
15+
16+
<Card title="New dashboard experience" icon="rocket">
17+
18+
The new **Security** navigation in the Cloudflare dashboard is currently available in beta for users that opt in to the new user interface. To opt in:
19+
20+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com), and select your account and domain.
21+
2. Open any page under **Security**.
22+
3. In the top right-hand corner of the page, select **Try new security dashboard**.
23+
24+
You can swap back to the previous dashboard at any time by selecting **Return to old security dashboard** in the same page location.
25+
26+
</Card>
27+
28+
## Features
29+
30+
<Feature header="Security overview" href="/security/overview/" cta="Explore Security overview">
31+
Get a high-level overview of your domain's security posture.
32+
</Feature>
33+
34+
<Feature
35+
header="Security Analytics"
36+
href="/security/analytics/"
37+
cta="Explore Security Analytics"
38+
>
39+
Shows information about all incoming HTTP requests or mitigated requests (rule
40+
matches). Tailor your security configurations based on sampled logs.
41+
</Feature>
42+
43+
<Feature header="Web asset discovery" href="/security/resources/">
44+
Discover your web assets (including API endpoints) and instruct Cloudflare how
45+
to best protect them.
46+
</Feature>
47+
48+
<Feature header="Security rules" href="/security/rules/">
49+
Perform security actions on incoming requests that match specified filters.
50+
</Feature>
51+
52+
---
53+
54+
## More resources
55+
56+
<CardGrid>
57+
58+
<LinkTitleCard
59+
title="Plans"
60+
href="https://www.cloudflare.com/plans/#overview"
61+
icon="document"
62+
>
63+
Compare available Cloudflare plans
64+
</LinkTitleCard>
65+
66+
</CardGrid>
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Security overview
3+
pcx_content_type: concept
4+
sidebar:
5+
order: 2
6+
---
7+
8+
Security overview provides a high-level security overview of you zone. Security overview allows you to review the security posture of your domain. The security overview page is available on both the new security dashboard as well as the existing security dashboard.
9+
10+
The Security overview page will display the following information:
11+
12+
- **Traffic last 7 days**: Review traffic from the last seven days that has been mitigated, served by Cloudflare, and served by origin.
13+
- **Security posture**:
14+
- **Configurations**: Review your currently enabled configurations, and whether additional configurations are required for them.
15+
- **Suggestions**: Review security suggestions to improve your security posture.
16+
- **Rules with the most activity**: Review the number of times a security rule has been activated by matching requests.
17+
- **Last updated rules**: Review rules you recently changed.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: Security rules
3+
pcx_content_type: concept
4+
sidebar:
5+
order: 5
6+
description: Security rules perform security actions on incoming requests that match specified filters.
7+
---
8+
9+
Security rules perform security-related actions on incoming requests that match specified filters. Rules are evaluated and executed in order, from first to last.
10+
11+
## Security rules
12+
13+
The **Security rules** tab includes a list of different types of rules configured in your zone to protect your applications and resources.
14+
15+
To create a security rule:
16+
17+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and zone.
18+
2. Go to **Security** > **Security rules**.
19+
3. (Optional) Select **Templates**, and then select a template from the list. You can customize the default configuration of the template before deploying the new rule. Refer to the resources listed in the next step.
20+
4. Select **Create rule** > select the type of rule you want to create. Refer to the following resources about each rule type:
21+
- [Custom rules](/waf/custom-rules/create-dashboard/#rule-form)
22+
- [Rate limiting rules](/waf/rate-limiting-rules/create-zone-dashboard/#rule-form)
23+
- [API sequence rules](/api-shield/security/sequence-mitigation/#rule-form)
24+
- [API JWT validation rules](/api-shield/security/jwt-validation/#rule-form) (requires a [token configuration](/security/settings/#all-settings))
25+
- [Managed rules exceptions](/waf/managed-rules/waf-exceptions/define-dashboard/#2-define-basic-exception-parameters)
26+
- [Content security rules](/page-shield/policies/create-dashboard/#rule-form) (previously known as Page Shield policies)
27+
28+
:::note[Notes]
29+
30+
The **Security rules** tab includes functionality available in different products in the previous dashboard navigation structure, such as the [WAF](/waf/), [API Shield](/api-shield/), and [Page Shield](/page-shield/).
31+
32+
The tab may show additional rule types if you have configured at least one of the following:
33+
34+
- [IP access rules](/waf/tools/ip-access-rules/)
35+
- [User agent blocking rules](/waf/tools/user-agent-blocking/)
36+
- [Zone lockdown rules](/waf/tools/zone-lockdown/)
37+
38+
:::
39+
40+
## DDoS protection
41+
42+
The **DDoS Protection** tab shows the multiple DDoS mitigation services provided by Cloudflare. You can create rules to override these mitigation tools. DDoS attack protection overrides are only available to Enterprise customers with the Advanced DDoS Protection subscription.
43+
44+
To learn more about DDoS protection overrides, refer to the following resources:
45+
46+
- [HTTP DDoS attack protection overrides](/ddos-protection/managed-rulesets/http/override-expressions/)
47+
- [Network-layer DDoS attack protection overrides](/ddos-protection/managed-rulesets/network/override-expressions/)
48+
49+
:::note
50+
You define overrides for the Network-layer DDoS attack protection managed ruleset at the account level in Account Home > **L3/4 DDoS** > **Network-layer DDoS Protection**.
51+
:::

0 commit comments

Comments
 (0)