-
Notifications
You must be signed in to change notification settings - Fork 10k
[Bots] Web Bot Auth docs #23099
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
[Bots] Web Bot Auth docs #23099
Changes from 7 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
c4232ad
Changes for WBA
Oxyjun ba0e6f2
Structure change
Oxyjun 699adac
Adding FAQ
Oxyjun 46dc052
Apply suggestions from code review
Oxyjun d49ba64
Fixing FAQs, adding more info on response headers
Oxyjun d22d2df
Review part 1 - inline suggestions
Oxyjun e3ae398
Applying review suggestions part 2
Oxyjun 02b4271
Update src/content/docs/bots/concepts/bot/verified-bots/overview.mdx
Oxyjun 14c8908
Squashed commit of the following:
Oxyjun d2ca445
Merge commit '0264d07c42c5107203aaabc038fd6efc1fb1134a' into jun/bots…
Oxyjun 2922787
Adding link to future blog
Oxyjun 3850658
Final round of fixes
Oxyjun e5c66c6
Adding WBA release note
Oxyjun dbaad35
Merge commit '3c081196eea0881a527e459e4b8eed4fabad4979' into jun/bots…
Oxyjun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
src/content/docs/bots/concepts/bot/verified-bots/ip-validation.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| pcx_content_type: concept | ||
| title: IP validation | ||
| sidebar: | ||
| order: 7 | ||
| label: IP validation | ||
|
|
||
| --- | ||
|
|
||
| import { GlossaryTooltip, Steps } from "~/components" | ||
|
|
||
| The IP validation method aims to identify all of the IP addresses that a bot may use to send requests. | ||
|
|
||
| Cloudflare can achieve this in two ways: | ||
|
|
||
| - **Using IP list provided by the bot owner**: The bot owner can host a public list of IP ranges (for example, [Googlebot's list](https://developers.google.com/static/search/apis/ipranges/googlebot.json)). Cloudflare fetches and uses this list directly for validation. | ||
| - **Using Domain-based reverse DNS**: The bot owner can provide a domain (or set of domains) that their bot requests originate from. Cloudflare collects the IP addresses observed in the requests with the bot's user agent, and performs reverse DNS lookups. If the reverse DNS of an IP resolves to one of the provided domains, Cloudflare considers it valid and stores it. | ||
|
|
||
| ## Public IP List | ||
|
|
||
| To verify a bot using a public IP list, you need to provide: | ||
|
|
||
| - A fixed and limited set of IP addresses, which can be verified via publicly accessible plain-text, `JSON`, or `CSV`. | ||
| - IP addresses used solely by the bot owner. | ||
| - A user-agent match pattern. | ||
|
|
||
| ## Reverse DNS | ||
|
|
||
| To verify a bot using reverse DNS, you need to provide: | ||
|
|
||
| - A list of domain suffixes to validate DNS records. | ||
| - IP addresses should have PTR records set correctly. | ||
| - A user-agent match pattern. | ||
|
|
||
| ## Generic user-agents | ||
|
|
||
| User-agent patterns that match generic user-agents will be rejected by the Verified Bots API. When you add a user-agent pattern that is considered very common to the Verified Bot form, you may encounter an error message that will prompt you to correct the user-agent before you can submit again. | ||
|
|
||
| Generic user-agents include: | ||
|
|
||
| - `Dart` | ||
| - `Go-http-client` | ||
| - `GuzzleHttp` | ||
| - `Google Chrome` | ||
| - `Mozilla Firefox` | ||
| - `Safari` | ||
| - `Nessus` | ||
| - `Websocket++` | ||
| - `cloudflare-go` | ||
| - `fasthttp` | ||
| - `got` | ||
| - `nginx-ssl early hints` | ||
| - `node` | ||
| - `node-fetch` | ||
| - `okhttp` | ||
| - `python-requests` | ||
| - `uTorrent` |
37 changes: 37 additions & 0 deletions
37
src/content/docs/bots/concepts/bot/verified-bots/overview.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| pcx_content_type: concept | ||
| title: Overview | ||
| sidebar: | ||
| order: 3 | ||
| label: Overview | ||
|
|
||
| --- | ||
|
|
||
| import { GlossaryTooltip } from "~/components" | ||
|
|
||
| A **verified bot** is a bot which has been added to Cloudflare's list of <GlossaryTooltip term="verified bot">verified bots</GlossaryTooltip>. | ||
|
|
||
| You can request for your bot to be added to Cloudflare's list of verified bots by filling out an [online application](https://dash.cloudflare.com/?to=/:account/configurations/verified-bots) in the Cloudflare dashboard. | ||
|
|
||
| ## Verified bot requirement | ||
|
|
||
| For a bot to be verified, it must meet the following requirements: | ||
|
|
||
| 1. The bot must follow [verified bots policy](/bots/concepts/bot/verified-bots/policy/). | ||
| 2. The bot must be verified using one of the following verification methods: | ||
| - [Web Bot Auth](/bots/concepts/bot/verified-bots/web-bot-auth/) | ||
| - [IP validation](/bots/concepts/bot/verified-bots/ip-validation/) | ||
|
|
||
| Once Cloudflare verifies a bot, it will appear on the [Cloudflare Radar's list of verified bots](https://radar.cloudflare.com/verified-bots). | ||
|
|
||
| :::note | ||
| Bot operators who prefer not to create a free Cloudflare account can do so using our [old form](https://docs.google.com/forms/d/e/1FAIpQLSdqYNuULEypMnp4i5pROSc-uP6x65Xub9svD27mb8JChA_-XA/viewform?usp=sf_link), but the waiting time is up to several weeks for verified bot requests to be evaluated. | ||
| ::: | ||
|
|
||
| ## Transient false negatives | ||
|
|
||
| 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. | ||
|
|
||
| It takes 24 hours for an inactive IP to be removed as a verified bot. | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.