Skip to content

Commit df3ea68

Browse files
patriciasantaanathomasgauvin
authored andcommitted
[Various] Clean up unused partials (#23845)
* api shield partials * bots partials * challenges partials * formatting
1 parent 0f63290 commit df3ea68

File tree

66 files changed

+523
-819
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+523
-819
lines changed

src/content/docs/api-shield/index.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,14 @@ Identify and address your API vulnerabilities.
2121

2222
## Why care about API security?
2323

24-
<Render file="why-care" product="api-shield" />
24+
APIs have become the [backbone of popular web services](https://blog.postman.com/intro-to-apis-history-of-apis/), helping the Internet become more accessible and useful.
25+
26+
As APIs have become more prevalent, however, so have their problems:
27+
28+
- Many companies have [thousands of APIs](/api-shield/security/api-discovery/), including ones they do not even know about.
29+
- To support a large base of users, many APIs are protected by a negative security model that makes them vulnerable to credential-stuffing attacks and automated scanning tools.
30+
- With so many endpoints and users, it’s difficult to recognize brute-force attacks against [specific endpoints](/api-shield/security/volumetric-abuse-detection/).
31+
- Sophisticated attacks are even harder to recognize, often because even development teams are unaware of common and uncommon [usage patterns](/api-shield/security/sequence-analytics/).
2532

2633
Refer to the [Get started](/api-shield/get-started/) guide to set up API Shield.
2734

src/content/docs/api-shield/management-and-monitoring/api-routing.mdx

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

88
---
99

10-
import { Render, Steps } from "~/components"
10+
import { Markdown, Render, Steps, Tabs, TabItem } from "~/components"
1111

1212
API Shield Routing enables customers to create a unified external-facing API that routes requests to different back-end services that may have different paths and hosts than the existing zone and DNS configuration.
1313

@@ -18,15 +18,62 @@ The term **Source Endpoint** refers to the endpoint managed by API Shield in End
1818

1919
## Process
2020

21-
<Render file="source-endpoints" />
21+
22+
You must add Source Endpoints to Endpoint Management through established methods, including [uploading a schema](/api-shield/security/schema-validation/#add-validation-by-uploading-a-schema), via [API Discovery](/api-shield/security/api-discovery/), or by [adding manually](/api-shield/management-and-monitoring/#add-endpoints-manually), before creating a route.
23+
24+
To create a route, you will need the operation ID of the Source Endpoint. To find the operation ID in the dashboard:
25+
26+
<Tabs syncKey="dashNewNav">
27+
<TabItem label="Old dashboard">
28+
<Steps>
29+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
30+
2. Select **Security** > **API Shield**.
31+
3. Filter the endpoints to find your **Source Endpoint**.
32+
4. Expand the row for your Source Endpoint and note the **operation ID** field.
33+
5. Select the copy icon to copy the operation ID to your clipboard.
34+
</Steps>
35+
</TabItem>
36+
<TabItem label="New dashboard" icon="rocket">
37+
<Steps>
38+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
39+
2. Select **Security** > **Web assets**.
40+
3. Filter the endpoints to find your **Source Endpoint**.
41+
4. Expand the row for your Source Endpoint and note the **operation ID** field.
42+
5. Select the copy icon to copy the operation ID to your clipboard.
43+
</Steps>
44+
</TabItem>
45+
</Tabs>
2246

2347
Once your Source Endpoints are added to Endpoint Management, use the following steps to create and verify routes on any given operation ID:
2448

2549
### Create a route
2650

27-
<Render file="routing" />
51+
<Tabs syncKey="dashNewNav">
52+
<TabItem label="Old dashboard">
53+
<Steps>
54+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
55+
2. Go to **Security** > **API Shield**.
56+
3. In **Endpoint Management**, select an existing endpoint and expand its details.
57+
4. Under **Routing**, select **Create route**.
58+
5. Enter the target URL or IP address to route your endpoint to.
59+
6. Select **Deploy route**.
60+
</Steps>
61+
</TabItem>
62+
<TabItem label="New dashboard" icon="rocket">
63+
<Steps>
64+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
65+
2. Go to **Security** > **Web assets**.
66+
3. In **Endpoints**, select an existing endpoint and expand its details.
67+
4. Under **Routing**, select **Create route**.
68+
5. Enter the target URL or IP address to route your endpoint to.
69+
6. Select **Deploy route**.
70+
</Steps>
71+
</TabItem>
72+
</Tabs>
2873

29-
<Render file="routing-path-variables" />
74+
:::note
75+
You can reorder path variables if they are present. For example, you can route `/api/{var1}/users/{var2}` to `/{var2}/users/{var1}`. Segments of the path that are not variables may be added or omitted entirely.
76+
:::
3077

3178
You can also edit or delete a route by selecting **Edit route** on an existing route.
3279

@@ -47,4 +94,8 @@ API Shield Routing is currently in an open beta and is only available for Enterp
4794

4895
## Limitations
4996

50-
<Render file="routing-limitations" />
97+
The Target Endpoint cannot be routed to a Worker if the route is to the same zone.
98+
99+
You cannot change the method of a request. For example, a `GET` Source Endpoint will always send a `GET` request to the Target Endpoint.
100+
101+
You must use all of the variables in the Target Endpoint that appear in the Source Endpoint. For example, routing `/api/{var1}/users/{var2}` to `/api/users/{var2}` is not allowed and will result in an error since `{var1}` is present in the Source Endpoint but not in the Target Endpoint.

src/content/docs/api-shield/management-and-monitoring/endpoint-labels.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ Use managed labels to identify endpoints by use case. Cloudflare may automatical
4848
`cf-rss-feed`: Add this label to endpoints that expect traffic from RSS clients.
4949

5050
:::note
51-
<Render file="rss-labels" product="bots" />
51+
[Bot Fight Mode](/bots/get-started/bot-fight-mode/) will not block requests to endpoints labeled as `cf-rss-feed`.
52+
53+
[Super Bot Fight Mode rules](/bots/get-started/super-bot-fight-mode/#ruleset-engine) will not match or challenge requests labeled as `cf-rss-feed`.
5254
:::
5355

5456
### Risk labels

src/content/docs/api-shield/security/api-discovery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jp-api.example.com/api/v1/users/{var1}
4343

4444
We will consolidate to `{hostVar1}.example.com/api/v1/users/{var1}`.
4545

46-
<Render file="blog-post" />
46+
For more technical details, see our [blog post](https://blog.cloudflare.com/ml-api-discovery-and-schema-learning/).
4747

4848
### Inbox view
4949

src/content/docs/bots/additional-configurations/ai-labyrinth.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ To enable [AI Labyrinth](/bots/additional-configurations/ai-labyrinth):
1616
<Tabs syncKey="dashNewNav">
1717
<TabItem label="Old dashboard">
1818
<Steps>
19-
<Render
20-
file="ai-labyrinth-enable"
21-
params={{ one: "Bot Fight Mode" }}
22-
/>
19+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
20+
2. Go to **Security** > **Bots**.
21+
3. Select **Configure Bot Fight Mode**.
22+
4. Enable **AI Labyrinth**.
2323
</Steps>
2424
</TabItem>
2525
<TabItem label="New dashboard" icon="rocket">

src/content/docs/bots/additional-configurations/detection-ids.mdx

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

88
import { Render, Tabs, TabItem, Steps } from "~/components"
99

10-
<Render file="detection-ids" />
10+
Detection IDs are static rules used to detect predictable bot behavior with no overlap with human traffic. Detection IDs refer to the precise [detection](/bots/concepts/bot-detection-engines/) used to identify a bot, which could be from heuristics, verified bot detections, or anomaly detections. For example, a detection ID can identify if you sent your headers in a different order than what was expected of your browser.
1111

1212
If you are having an issue with one of our heuristics, detection IDs allow you to decide which heuristics to enforce on your zones using customer configurable heuristics. You can choose unique actions for different bots, detected through Cloudflare’s heuristics engine. You can block, allow, or serve alternate content to specific bots to meet the unique needs of your site’s traffic.
1313

@@ -101,7 +101,13 @@ and not any(cf.bot_management.detection_ids[*] in {3355446 12577893})
101101

102102
## Account takeover detections
103103

104-
<Render file="account-takeover-detections" />
104+
Using the detection IDs below, you can detect and mitigate account takeover attacks. You can monitor the number of login requests for a given software and network combination, as well as the percentage of login errors. When it reaches a suspicious level, you can prevent these attacks by using [custom rules](/waf/custom-rules/), [rate limiting rules](/waf/rate-limiting-rules/), and [Workers](/workers/).
105+
106+
| Detection ID | Description |
107+
| ------------ | ---------------------------------------- |
108+
| `201326592` | Observes all login failures to the zone. |
109+
| `201326593` | Observes all login traffic to the zone. |
110+
| `201326598` | Sets a dynamic threshold based on the normal traffic that is unique to the zone.<br /><br /> When the ID matches a login failure, Bot Management sets the [bot score](/bots/concepts/bot-score/) to 2 and [anomaly detection](/bots/concepts/bot-detection-engines/#anomaly-detection-enterprise) as its score source. |
105111

106112
### Challenges for account takeover detections
107113

src/content/docs/bots/additional-configurations/ja3-ja4-fingerprint/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ sidebar:
88

99
import { Render } from "~/components"
1010

11-
<Render file="ja3-fingerprint" />
11+
[**JA3**](https://github.com/salesforce/ja3) and [**JA4**](https://github.com/FoxIO-LLC/ja4) **fingerprints** help you profile specific SSL/TLS clients across different destination IPs, Ports, and X509 certificates.
1212

13-
<Render file="ja4-fingerprint" />
13+
JA4 fingerprint adds new functionality by sorting ClientHello extensions and reducing the total number of unique fingerprints for modern browsers.
1414

1515
:::note
1616

src/content/docs/bots/additional-configurations/managed-robots-txt.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ To implement a `robots.txt` file on your domain:
5050
<Tabs syncKey="dashNewNav">
5151
<TabItem label="Old dashboard">
5252
<Steps>
53-
<Render
54-
file="enable-managed-robots-txt"
55-
params={{ one: "Bot Fight Mode" }}
56-
/>
53+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
54+
2. Go to **Security** > **Bots**.
55+
3. Select **Configure Bot Fight Mode**.
56+
4. Turn **Manage bot traffic with robots.txt** on.
5757
</Steps>
5858
</TabItem>
5959
<TabItem label="New dashboard" icon="rocket">

src/content/docs/bots/additional-configurations/static-resources.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ The **Static Resource Protection** setting will only activate if at least one of
4646

4747
## Bot Management for Enterprise
4848

49-
<Render file="static-resources-bm" /> <br/>
49+
Static resources are protected by default when you create [custom rules](/waf/custom-rules/) using `cf.bot_management.score`.
5050

5151
To exclude static resources, you would need to include `not (cf.bot_management.static_resource)` as part of your custom rule.
5252

5353
## Which files are protected?
5454

55-
<Render file="static-resources-list" />
55+
Static resources are files with the following extensions:
56+
57+
`ico|jpg|png|jpeg|gif|css|js|tif|tiff|bmp|pict|webp|svg|svgz|class|jar|txt|csv|doc|docx|xls|xlsx|pdf|ps|pls|ppt|pptx|ttf|otf|woff|woff2|eot|eps|ejs|swf|torrent|midi|mid|m3u8|m4a|mp3|ogg|ts`

src/content/docs/bots/concepts/bot-score.mdx

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ sidebar:
77

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

10-
<Render file="bot-score-definition" />
10+
A bot score is a score from *1* to *99* that indicates how likely that request came from a bot.
11+
12+
For example, a score of 1 means Cloudflare is quite certain the request was automated, while a score of 99 means Cloudflare is quite certain the request came from a human.
1113

1214
Bot scores are available to be used in rule expressions and with Workers to customize application behavior. For more details, refer to [Bot Management variables](/bots/reference/bot-management-variables/).
1315

@@ -20,7 +22,13 @@ Granular bot scores are only available to Enterprise customers who have purchase
2022

2123
Customers with a Pro plan or higher can automatically see bot traffic divided into groups by going to **Security** > **Bots**.
2224

23-
<Render file="bot-groupings" />
25+
| Category | Range |
26+
| -------------------- | -------------------------------------------------------------------------------------- |
27+
| **Not computed** | Bot scores of 0. |
28+
| **Automated** | Bot scores of 1. |
29+
| **Likely automated** | Bot scores of 2 through 29. |
30+
| **Likely human** | Bot scores of 30 through 99. |
31+
| **Verified bot** | Non-malicious automated traffic (used to power search engines and other applications). |
2432

2533
:::note
2634

@@ -34,15 +42,35 @@ Bot scores are not computed for requests to paths that are handled by Cloudflare
3442
The following detection engines only apply to Enterprise Bot Management. For specific details about the engines included in your plan, refer to [Plans](/bots/plans/).
3543
:::
3644

37-
<Render file="bm-bot-detection-engines" />
45+
### Heuristics
46+
47+
<Render file="bots-heuristics" product="bots" />
48+
49+
The Heuristics engine immediately gives automated requests a score of 1.
50+
51+
### Machine learning
52+
53+
<Render file="bots-ml" product="bots" />
54+
55+
The ML engine produces scores 2 through 99.
56+
57+
### Anomaly detection
58+
59+
<Render file="bots-ad" product="bots" />
60+
61+
### JavaScript detections
62+
63+
<Render file="bots-jsd" product="bots" />
64+
65+
JSD is enabled by default but completely optional. To adjust your settings, open the Bot Management Configuration page from **Security** > **Bots**.
3866

3967
### Cloudflare service
4068

41-
<Render file="bots-cs" />
69+
**Cloudflare Service** is a special <GlossaryTooltip term="bot score">bot score</GlossaryTooltip> source for Enterprise Zero Trust to avoid false positives.
4270

4371
### Not computed
4472

45-
<Render file="bots-nc" />
73+
A bot score of 0 means Bot Management did not run on the request. Cloudflare does not run Bot Management on internal service requests that Bot Management has no interest in blocking.
4674

4775
### Notes on detection
4876

0 commit comments

Comments
 (0)