Section numbers are those of RFC 9116, read as text for this site; the two fields marked IANA are in the registry (version of 7 March 2026) and not in the RFC text. The checks are the ones the explorer makes.
Lines
- A field is a name,
:, a space and a value, on one line; the name is not case-sensitive (section 2, ABNF in section 4:fs SP). - A line that starts with
#is a comment (2.1). Blank lines are allowed (2). - Every line ends with CR LF or LF (2.2); a line may have white space before its end (
eol = *WSP [CR] LF, section 4). - The file is plain text, UTF-8 (4). A field may appear more than once unless its definition says otherwise, and several values must not be chained in one field (2).
- Fields that are not registered are allowed, and a researcher MUST ignore the ones it does not support (2.4).
- A researcher may choose not to parse a file larger than 32 KB, a field longer than 2,048 characters, or a file of more than 1,000 lines (5.4: “they may choose”). The explorer reports each as an Issue and still reads the file.
Fields
| Field | Repeats | Value and rules | Source |
|---|---|---|---|
Contact | yes | Required, at least one. A URI: mailto: and tel: for email addresses and phone numbers, or an https:// page. List in order of preference, the first being preferred. Encryption is recommended when it is an email address. | 2.5.3 |
Expires | no | Required, exactly once. A date and time in the Internet profile of ISO 8601 (RFC 3339), after which the file is stale. Recommended to be less than a year ahead. The RFC’s own example writes a lower-case z. | 2.5.5, 5.3 |
Encryption | yes | A URI of a key (a web address, a dns: OPENPGPKEY record, or openpgp4fpr: with a fingerprint). A key MUST NOT appear in the field. | 2.5.4 |
Acknowledgments | yes | A link to a page that recognises researchers for their reports. | 2.5.1 |
Preferred-Languages | no | Language tags (RFC 5646) separated by commas, at least one; equal priority, order means nothing. Absent means English may be assumed. | 2.5.8 |
Canonical | yes | The canonical URIs where this file is. If the file has the field and the address it was fetched from is not listed, its contents SHOULD NOT be trusted. A listed address is not trusted for all the others without another mechanism, such as the signature. | 2.5.2 |
Policy | yes | A link to the vulnerability disclosure policy. | 2.5.7 |
Hiring | yes | A link to the vendor’s security-related job positions. | 2.5.6 |
CSAF | yes | A link to the provider-metadata.json of the Common Security Advisory Framework (OASIS Open). | IANA, registered 2023-02-15 |
Bug-Bounty | no | The registry says that Bug-Bounty: True indicates that reporters may be financially rewarded and Bug-Bounty: False that no reward can be offered. | IANA, registered 2026-03-07 |
For Acknowledgments, Canonical, Contact, Encryption, Hiring and
Policy, a web URI MUST begin with https:// (each field’s section says so). The registry does not
repeat that for CSAF, and the explorer does not check it there. The value of the URI fields must follow the URI syntax of RFC 3986;
the explorer tests for a scheme and a rest, not for the whole grammar.
Signing
Signing with an OpenPGP cleartext signature is RECOMMENDED (2.3), together with Canonical so that the signature
authenticates the location. The grammar (section 4) has a header line, one or more Hash: lines, a blank line, the
cleartext (dash-escaped as RFC 4880 section 7.1 describes: a line that starts with - MUST start with
- ; a line starting with From SHOULD), then -----BEGIN PGP SIGNATURE-----, optional
Key: value armor headers, a blank line, base64 data, and -----END PGP SIGNATURE-----.
The explorer checks that these parts are present and shows the signature without verifying it: which key to trust is the researcher’s
responsibility (2.3).
Location and retrieval
- Web services MUST place the file under
/.well-known/; a top-level copy or a redirect is allowed for older readers; the/.well-known/copy MUST be used if both exist (3). - Fetched over HTTPS, with the content type
text/plainand charsetutf-8(3). Retrieval may involve redirects, which a researcher should examine (3, 5.2). - The file applies to the host that served it, not to subdomains or parent domains; it may also apply to the organisation’s products and services (3.1).
- The registered well-known URI suffix is
security.txt, status permanent (6.1).