| Internet-Draft | REP | June 2022 |
| Koster, et al. | Expires 5 December 2022 | [Page] |
This document specifies and extends the "Robots Exclusion Protocol" method originally defined by Martijn Koster in 1996 for service owners to control how content served by their services may be accessed, if at all, by automatic clients known as crawlers.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 5 December 2022.¶
Copyright (c) 2022 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document applies to services that provide resources that clients can access through URIs as defined in [RFC3986]. For example, in the context of HTTP, a browser is a client that displays the content of a web page.¶
Crawlers are automated clients. Search engines for instance have crawlers to recursively traverse links for indexing as defined in [RFC8288].¶
It may be inconvenient for service owners if crawlers visit the entirety of their URI space. This document specifies the rules originally defined by the "Robots Exclusion Protocol" [ROBOTSTXT] that crawlers are expected to obey when accessing URIs.¶
These rules are not a form of access authorization.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The protocol language consists of rule(s) and group(s) that the service makes available in a file named 'robots.txt' as described in Section 2.3:¶
Below is an Augmented Backus-Naur Form (ABNF) description, as described in [RFC5234].¶
robotstxt = *(group / emptyline)
group = startgroupline ; We start with a user-agent
*(startgroupline / emptyline) ; ... and possibly more
; user-agents
*(rule / emptyline) ; followed by rules relevant
; for UAs
startgroupline = *WS "user-agent" *WS ":" *WS product-token EOL
rule = *WS ("allow" / "disallow") *WS ":"
*WS (path-pattern / empty-pattern) EOL
; parser implementors: define additional lines you need (for
; example, sitemaps).
product-token = identifier / "*"
path-pattern = "/" *UTF8-char-noctl ; valid URI path pattern
empty-pattern = *WS
identifier = 1*(%x2D / %x41-5A / %x5F / %x61-7A)
comment = "#" *(UTF8-char-noctl / WS / "#")
emptyline = EOL
EOL = *WS [comment] NL ; end-of-line may have
; optional trailing comment
NL = %x0D / %x0A / %x0D.0A
WS = %x20 / %x09
; UTF8 derived from RFC3629, but excluding control characters
UTF8-char-noctl = UTF8-1-noctl / UTF8-2 / UTF8-3 / UTF8-4
UTF8-1-noctl = %x21 / %x22 / %x24-7F ; excluding control, space, '#'
UTF8-2 = %xC2-DF UTF8-tail
UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2UTF8-tail /
%xED %x80-9F UTF8-tail / %xEE-EF 2UTF8-tail
UTF8-4 = %xF0 %x90-BF 2UTF8-tail / %xF1-F3 3UTF8-tail /
%xF4 %x80-8F 2UTF8-tail
UTF8-tail = %x80-BF
¶
Crawlers set their own name, which is called a product token, to find relevant groups. The product token MUST contain only upper and lowercase letters ("a-z" and "A-Z"), underscores ("_"), and hyphens ("-"). The product token SHOULD be a substring of the identification string that the crawler sends to the service (for example, in the case of HTTP, the product token SHOULD be a substring in the user-agent header). The identification string SHOULD describe the purpose of the crawler. Here's an example of a user-agent HTTP request header with a link pointing to a page describing the purpose of the ExampleBot crawler, which appears as a substring in the user-agent HTTP header and as a product token in the robots.txt user-agent line:¶
| user-agent HTTP header | robots.txt user-agent line |
|---|---|
| user-agent: Mozilla/5.0 (compatible; ExampleBot/0.1; https://www.example.com/bot.html) | user-agent: ExampleBot |
Crawlers MUST find the group that matches the product token exactly, and then obey the rules of the group. If there is more than one group matching the user-agent, the matching groups' rules MUST be combined into one group and parsed according to Section 2.2.2.¶
| Two groups that match the same product token exactly | Merged group |
|---|---|
| user-agent: ExampleBot disallow: /foo disallow: /bar user-agent: ExampleBot disallow: /baz |
user-agent: ExampleBot disallow: /foo disallow: /bar disallow: /baz |
The matching of the product token MUST be case-insensitive. If no matching group exists, crawlers MUST obey the group with a user-agent line with the "*" value, if present.¶
| Two groups that don't explicitly match ExampleBot | Applicable group for ExampleBot |
|---|---|
| user-agent: * disallow: /foo disallow: /bar user-agent: BazBot disallow: /baz |
user-agent: * disallow: /foo disallow: /bar |
If no group matches the product token and there is no group with a user-agent line with the "*" value, or no groups are present at all, no rules apply.¶
These lines indicate whether accessing a URI that matches the corresponding path is allowed or disallowed.¶
To evaluate if access to a URI is allowed, a robot MUST match the paths in allow and disallow rules against the URI. The matching SHOULD be case sensitive. The most specific match found MUST be used. The most specific match is the match that has the most octets. Duplicate rules in a group MAY be deduplicated. If an allow and disallow rule is equivalent, the allow SHOULD be used. If no match is found amongst the rules in a group for a matching user-agent, or there are no rules in the group, the URI is allowed. The /robots.txt URI is implicitly allowed.¶
Octets in the URI and robots.txt paths outside the range of the US-ASCII coded character set, and those in the reserved range defined by [RFC3986], MUST be percent-encoded as defined by [RFC3986] prior to comparison.¶
If a percent-encoded US-ASCII octet is encountered in the URI, it MUST be unencoded prior to comparison, unless it is a reserved character in the URI as defined by [RFC3986] or the character is outside the unreserved character range. The match evaluates positively if and only if the end of the path from the rule is reached before a difference in octets is encountered.¶
For example:¶
| Path | Encoded Path | Path to Match |
|---|---|---|
| /foo/bar?baz=quz | /foo/bar?baz=quz | /foo/bar?baz=quz |
| /foo/bar?baz=http ://foo.bar |
/foo/bar?baz=http%3A %2F%2Ffoo.bar |
/foo/bar?baz=http%3A %2F%2Ffoo.bar |
| /foo/bar/U+E38384 | /foo/bar/%E3%83%84 | /foo/bar/%E3%83%84 |
| /foo/bar/%E3%83%84 | /foo/bar/%E3%83%84 | /foo/bar/%E3%83%84 |
| /foo/bar/%62%61%7A | /foo/bar/%62%61%7A | /foo/bar/baz |
The crawler SHOULD ignore "disallow" and "allow" rules that are not in any group (for example, any rule that precedes the first user-agent line).¶
Implementers MAY bridge encoding mismatches if they detect that the robots.txt file is not UTF8 encoded.¶
Crawlers SHOULD allow the following special characters:¶
| Character | Description | Example |
|---|---|---|
| "#" | Designates an end of line comment. | "allow: / # comment in line" "# comment on its own line" |
| "$" | Designates the end of the match pattern. | "allow: /this/path/exactly$" |
| "*" | Designates 0 or more instances of any character. | "allow: /this/*/exactly" |
If crawlers match special characters verbatim in the URI, crawlers SHOULD use "%" encoding. For example:¶
| Percent-encoded Pattern | URI |
|---|---|
| /path/file-with-a-%2A.html | https://www.example.com/path/file-with-a-*.html |
| /path/foo-%24 | https://www.example.com/path/foo-$ |
Clients MAY interpret other records that are not part of the robots.txt protocol. For example, 'sitemap' [SITEMAPS]. Clients MAY be lenient when interpreting other records. For example, clients may accept common typos of the record.¶
Parsing of other records MUST NOT interfere with the parsing of explicitly defined records in Section 2.¶
The rules MUST be accessible in a file named "/robots.txt" (all lower case) in the top level path of the service. The file MUST be UTF-8 encoded (as defined in [RFC3629]) and Internet Media Type "text/plain" (as defined in [RFC2046]).¶
As per [RFC3986], the URI of the robots.txt is:¶
"scheme:[//authority]/robots.txt"¶
For example, in the context of HTTP or FTP, the URI is:¶
http://www.example.com/robots.txt
https://www.example.com/robots.txt
ftp://ftp.example.com/robots.txt
¶
If the crawler successfully downloads the robots.txt, the crawler MUST follow the parseable rules.¶
The server may respond to a robots.txt fetch request with a redirect, such as HTTP 301 and HTTP 302. The crawlers SHOULD follow at least five consecutive redirects, even across authorities (for example, hosts in case of HTTP), as defined in [RFC1945].¶
If a robots.txt file is reached within five consecutive redirects, the robots.txt file MUST be fetched, parsed, and its rules followed in the context of the initial authority.¶
If there are more than five consecutive redirects, crawlers MAY assume that the robots.txt is unavailable.¶
If the robots.txt is unreachable due to server or network errors, this means the robots.txt is undefined and the crawler MUST assume complete disallow. For example, in the context of HTTP, an unreachable robots.txt has a response code in the 500-599 range. For other undefined status codes, the crawler MUST assume the robots.txt is unreachable.¶
If the robots.txt is undefined for a reasonably long period of time (for example, 30 days), clients MAY assume the robots.txt is unavailable or continue to use a cached copy.¶
Crawlers SHOULD try to parse each line of the robots.txt file. Crawlers MUST use the parseable rules.¶
The Robots Exclusion Protocol is not a substitute for more valid content security measures. Listing URIs in the robots.txt file exposes the URI publicly and thus makes the URIs discoverable.¶
This document has no actions for IANA.¶
The following example shows:¶
User-agent: *
Disallow: /*.gif$
Disallow: /example/
Allow: /publications/
User-Agent : foobot
Disallow: /
Allow : /example/page.html
Allow : /example/allowed.gif
User-Agent : barbot
User-Agent : bazbot
Disallow : /example/page.html
User-Agent: quxbot
EOF
¶
The following example shows that in the case of two rules, the longest one is used for matching. In the following case, /example/page/disallowed.gif MUST be used for the URI example.com/example/page/disallow.gif.¶
User-Agent : foobot
Allow : /example/page/
Disallow : /example/page/disallowed.gif
¶