Skip to content

Commit 23d4c1d

Browse files
patriciasantaananevikashah
authored andcommitted
[Bots] Signed agents (#24757)
* signed agents * spacing * redirect * space * fix link * broken links
1 parent 2731fb5 commit 23d4c1d

File tree

20 files changed

+228
-112
lines changed

20 files changed

+228
-112
lines changed

public/__redirects

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,10 @@
265265
/bots/get-started/pro/ /bots/get-started/super-bot-fight-mode/ 301
266266
/bots/additional-configurations/javascript-detections/ /cloudflare-challenges/challenge-types/javascript-detections/ 301
267267
/bots/troubleshooting/frequently-asked-questions/ /bots/frequently-asked-questions/ 301
268+
/bots/concepts/bot/verified-bots/categories/ /bots/concepts/bot/verified-bots/#categories 301
269+
/bots/concepts/bot/verified-bots/ip-validation/ /bots/reference/bot-verification/ip-validation/ 301
270+
/bots/concepts/bot/verified-bots/web-bot-auth/ /bots/reference/bot-verification/web-bot-auth/ 301
271+
/bots/concepts/bot/verified-bots/overview/ /bots/concepts/bot/verified-bots/ 301
268272

269273
#browser-rendering
270274
/browser-rendering/get-started/browser-rendering-with-DO/ /browser-rendering/workers-bindings/browser-rendering-with-do/ 301

src/content/docs/ai-crawl-control/features/manage-ai-crawlers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The **Crawlers** tab displays a table of AI crawlers that are requesting access
2222
| Column | Details |
2323
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2424
| Crawler | The name of the AI crawler and the operator that owns it. |
25-
| Category | The category of the AI crawler. Refer to [Verified bot categories](/bots/concepts/bot/verified-bots/categories/). |
25+
| Category | The category of the AI crawler. Refer to [Verified bot categories](/bots/concepts/bot/verified-bots/#categories). |
2626
| Requests | Total allowed and blocked requests with trend chart. Blocked requests may come from any configured rule, not just the actions shown here. |
2727
| Robots.txt violations | The number of times the AI crawler has violated your <GlossaryTooltip term="robots.txt">`robots.txt`</GlossaryTooltip> file. |
2828
| Action | The action you wish to take for the AI crawler. Refer to [Take action for each AI crawler](/ai-crawl-control/features/manage-ai-crawlers/#take-action-for-each-ai-crawler). |

src/content/docs/ai-crawl-control/features/pay-per-crawl/use-pay-per-crawl-as-ai-owner/crawl-pages.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To access this content, the AI crawler must provide headers for paid access.
3333

3434
### 2.1. Include WBA headers
3535

36-
Include Web Bot Auth headers by following the steps [Sign your requests](/bots/concepts/bot/verified-bots/web-bot-auth/#4-after-verification-sign-your-requests)
36+
Include Web Bot Auth headers by following the steps [Sign your requests](/bots/reference/bot-verification/web-bot-auth/#4-after-verification-sign-your-requests)
3737

3838
### 2.2. Include payment headers
3939

src/content/docs/ai-crawl-control/features/pay-per-crawl/use-pay-per-crawl-as-ai-owner/verify-ai-crawler.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To access this content, you must verify your AI crawler.
3737

3838
Ensure your AI crawler identifies itself with the required headers for Web Bot Auth.
3939

40-
Follow the steps found in [Web Both Auth](/bots/concepts/bot/verified-bots/web-bot-auth/).
40+
Follow the steps found in [Web Both Auth](/bots/reference/bot-verification/web-bot-auth/).
4141

4242
## 2. Follow verified bot policy
4343

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { Render, Steps } from "~/components"
1414
The **Block AI bots** feature is only available in the new [application security dashboard](/security/).
1515
:::
1616

17-
You can choose to block AI bots by activating **Block AI bots**. Activating this setting will block [verified bots](/bots/concepts/bot/verified-bots/overview/) that are classified as AI crawlers, as well as a number of unverified bots that behave similarly.
17+
You can choose to block AI bots by activating **Block AI bots**. Activating this setting will block [verified bots](/bots/concepts/bot/verified-bots/) that are classified as AI crawlers, as well as a number of unverified bots that behave similarly.
1818

1919
To block [AI bots](/bots/concepts/bot/#ai-bots):
2020

src/content/docs/bots/concepts/bot/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For more background, refer to [What is a bot?](https://www.cloudflare.com/learni
2323

2424
<Render file="verified-bots" product="bots" />
2525

26-
For more information, refer to [Verified bots](/bots/concepts/bot/verified-bots/overview/).
26+
For more information, refer to [Verified bots](/bots/concepts/bot/verified-bots/).
2727

2828
:::note
2929

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
pcx_content_type: overview
3+
title: Signed agents
4+
sidebar:
5+
order: 3
6+
learning_center:
7+
title: What is a bot?
8+
link: https://www.cloudflare.com/learning/bots/what-is-a-bot/
9+
10+
---
11+
12+
A signed agent is controlled by an end user and a verified signature-agent from their Web Bot Auth implementation.
13+
14+
You can request for your agent to be added to Cloudflare's bots and agents directory by filling out an [online application](https://dash.cloudflare.com/?to=/:account/configurations/verified-bots) in the Cloudflare dashboard.
15+
16+
:::note
17+
A bot cannot be registered as both a verified bot and a signed agent. Review Cloudflare's [verified bots](/bots/concepts/bot/verified-bots/) to determine how to identify your bot.
18+
:::
19+
20+
## Signed agent requirement
21+
22+
For an agent to be recognized, it must meet the following requirements:
23+
24+
1. The agent must follow the [signed agents policy](/bots/concepts/bot/signed-agents/policy/).
25+
2. The bot must be using [Web Bot Auth](/bots/reference/bot-verification/web-bot-auth/).
26+
27+
Once Cloudflare approves a signed agent, it should appear on [Cloudflare Radar's bots and agents directory](https://radar.cloudflare.com/verified-bots).
28+
29+
---
30+
31+
## Transient false negatives
32+
33+
Once Cloudflare lists an agent as a signed agent, this entry is cached and may get delisted if no traffic is seen in the Cloudflare network coming from the agent for a defined period of time.
34+
35+
An agent can remain unlisted until Cloudflare sees traffic being sourced from the agent. When the agent is revalidated, it is listed as a signed agent again.
36+
37+
---
38+
39+
## Verification method
40+
41+
The bot must be verified using [Web Bot Auth](/bots/reference/bot-verification/web-bot-auth/).
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
pcx_content_type: reference
3+
title: Signed agents policy
4+
sidebar:
5+
order: 3
6+
label: Policy
7+
8+
---
9+
10+
In order to be listed by Cloudflare as a signed agent, your agent must conform to the below requirements. To provide the best possible protection to our customers, this policy may change in the future as we adapt to new bot behaviors.
11+
12+
## Agent policy
13+
14+
### Minimum traffic
15+
16+
An agent must have a minimum amount of traffic for Cloudflare to be able to find it in the sampled data. The minimum traffic should have more than 1,000 requests per day across multiple domains.
17+
18+
### Minimum zones
19+
20+
Service must be made for a widespread use of zones.
21+
22+
#### Example
23+
24+
A bot crawling one site is not valid.
25+
26+
### Agent identification
27+
28+
The user-agent field is optional as it is not required for Web Bot Authentication.
29+
30+
However, if you choose to provide a user-agent, it and the message signature must meet the following requirements:
31+
32+
- Have at least five characters.
33+
- Must not contain special characters.
34+
- Must not include the same user-agent of another verified service.
35+
36+
#### Example
37+
38+
`cloudflare-browser-rendering` is a valid message signature.
39+
40+
### Service purpose
41+
42+
The purpose of the service should be benign or helpful to both the owner of a zone and the users of the service. The service cannot perform any of the following:
43+
44+
- Bot tooling
45+
- Scalpers
46+
- Credential-stuffing
47+
- Directory-traversal scanning
48+
- Excessive data scraping
49+
- DDoS botnets
50+
51+
#### Example
52+
53+
Price scraping direct e-commerce competitors is not a valid use case.
54+
55+
### Public documentation
56+
57+
The agent must have a publicly documented purpose and expected behavior.
58+
59+
---
60+
61+
## Breach of policy
62+
63+
If any of the requirements to validate are breached, a service will be removed from the signed agent list.
64+
65+
The following are examples of breaches of policy:
66+
67+
- The service has vulnerabilities that have not been patched.
68+
- The disclosed purpose of the service does not reflect on the traffic.

src/content/docs/bots/concepts/bot/verified-bots/categories.mdx

Lines changed: 0 additions & 41 deletions
This file was deleted.
Lines changed: 71 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,84 @@
11
---
2-
pcx_content_type: navigation
2+
pcx_content_type: overview
33
title: Verified bots
44
sidebar:
5-
group:
6-
hideIndex: true
75
order: 2
86
learning_center:
97
title: What is a bot?
108
link: https://www.cloudflare.com/learning/bots/what-is-a-bot/
119

1210
---
1311

14-
import { Render, DirectoryListing } from "~/components";
12+
import { GlossaryTooltip } from "~/components";
1513

16-
<Render file="verified-bots" product="bots" />
14+
A verified bot is a bot which has been added to Cloudflare's list of <GlossaryTooltip term="verified bot">verified bots</GlossaryTooltip>.
1715

18-
Refer to the pages below for additional resources on verified bots.
16+
You can request for your bot to be added to Cloudflare's bots and agents directory by filling out an [online application](https://dash.cloudflare.com/?to=/:account/configurations/verified-bots) in the Cloudflare dashboard.
1917

20-
<DirectoryListing />
18+
:::note
19+
A bot cannot be registered as both a verified bot and a signed agent. Review Cloudflare's [signed agents](/bots/concepts/bot/signed-agents/) to determine how to identify your bot.
20+
:::
21+
22+
## Verified bot requirement
23+
24+
For a bot to be verified, it must meet the following requirements:
25+
26+
1. The bot must follow [verified bots policy](/bots/concepts/bot/verified-bots/policy/).
27+
2. The bot must be verified using one of the following verification methods:
28+
- [Web Bot Auth](/bots/reference/bot-verification/web-bot-auth/)
29+
- [IP validation](/bots/reference/bot-verification/ip-validation/)
30+
31+
Once Cloudflare approves a verified bot, it should appear on [Cloudflare Radar's bots and agents directory](https://radar.cloudflare.com/verified-bots).
32+
33+
---
34+
35+
## Transient false negatives
36+
37+
Once Cloudflare lists a bot as a verified bot, this entry is cached and may get delisted if no traffic is seen in the Cloudflare network coming from the bot for a defined period of time.
38+
39+
It takes 24 hours for an inactive IP to be removed as a verified bot.
40+
41+
A bot can remain unlisted until Cloudflare sees traffic being sourced from the bot. When the bot is revalidated, it is listed as a verified bot again.
42+
43+
---
44+
45+
## Verification methods
46+
47+
The bot must be verified using one of the following validation methods:
48+
49+
- [Web Bot Auth](/bots/reference/bot-verification/web-bot-auth/)
50+
- [IP validation](/bots/reference/bot-verification/ip-validation/)
51+
52+
---
53+
54+
## Categories
55+
56+
You can segment your verified bot traffic by its type and purpose by adding the Verified Bot Categories field `cf.verified_bot_category` as a filter criteria in [WAF Custom rules](/waf/custom-rules/), [Advanced Rate Limiting](/waf/rate-limiting-rules/), and Late Transform rules.
57+
58+
:::note
59+
The Verified Bot Categories field is not compatible with legacy Firewall rules.
60+
:::
61+
62+
| Name | String value | Example |
63+
| -------------------------- | ---------------------------- | ----------------------------------------------------------------------- |
64+
| Academic research | `Academic Research` | Library of Congress, TurnItInBot, Bibliothèque nationale de France |
65+
| Accessibility | `Accessibility` | Accessible Web Bot |
66+
| Advertising or marketing | `Advertising & Marketing` | Google Adsbot |
67+
| Aggregators | `Aggregator` | Pinterest, Indeed Jobsbot |
68+
| AI Assistant | `AI Assistant` | Perplexity-User, DuckAssistBot |
69+
| AI Crawler | `AI Crawler` | Google Bard, ChatGPT bot |
70+
| AI Search | `AI Search` | OAI-SearchBot |
71+
| Archiver | `Archiver` | Internet Archive, CommonCrawl |
72+
| Feed fetcher | `Feed Fetcher` | RSS or Podcast feed updaters |
73+
| Monitoring or analytics | `Monitoring & Analytics` | Uptime Monitors |
74+
| Page preview | `Page Preview` | Facebook, Slack, Twitter, or Discord Link Preview tools |
75+
| Search engine crawler | `Search Engine Crawler` | Googlebot, Bingbot, Yandexbot, Baidubot |
76+
| Search engine optimization | `Search Engine Optimization` | Google Lighthouse, GT Metrix, Pingdom, AddThis |
77+
| Security | `Security` | Vulnerability Scanners, SSL Domain Control Validation (DCV) Check Tools |
78+
| Social media marketing | `Social Media Marketing` | Brandwatch |
79+
| Webhooks | `Webhooks` | Payment processors, WordPress Integration tools |
80+
| Other | `Other` | |
81+
82+
### Availability
83+
84+
Verified Bot Categories is available on all plans.

0 commit comments

Comments
 (0)