security.txt provides a way for websites to define security policies.
The security.txt file sets clear guidelines for security researchers on how to report security issues.
security.txt is the equivalent of robots.txt, but for security issues.
“ When security vulnerabilities are discovered by researchers, proper reporting channels are often lacking. As a result, vulnerabilities may be left unreported. This document defines a format ("security.txt") to help organizations describe their vulnerability disclosure practices to make it easier for researchers to report vulnerabilities.”
The definitive reference on security.txt and how it is used can be found in RFC 9116.
Extensions to security.txt can be found in an IANA registry
Project website: https://securitytxt.org/ (https://github.com/securitytxt/securitytxt.org)
https://github.com/securitytxt/
What is the main purpose of security.txt?
The main purpose of security.txt is to help make things easier for companies and security researchers when trying to secure platforms. Thanks to security.txt, security researchers can easily get in touch with companies about security issues.
Is security.txt an RFC?
Yes, it was published by the IETF as RFC 9116. There is also a related IANA registry.
Information about previous drafts can be found in the "archived" folder and at the IETF's Datatracker website.
Where should I put the security.txt file?
For websites, the security.txt file should be placed under the /.well-known/ path
(/.well-known/security.txt) [RFC8615].
It can also be placed in the root directory (/security.txt) of a website, especially
if the /.well-known/ directory cannot be used for technical reasons, or simply as a fallback.
Please consult section 3 of RFC 9116 for details.
Are there any settings I should apply to the file?
The security.txt file should have an Internet Media Type of text/plain and must be served over HTTPS.
Will adding an email address expose me to spam bots?
The email value is an optional field. If you are worried about spam, you can set a URI as the value and link to your security policy.
To maintain an orderly, productive, and fun environment, the security.txt project have a few guidelines that we ask people to adhere to when they are participating in contributing to the project. These guidelines apply equally to everyone within the security.txt project. Likewise, they apply to all spaces managed by the security.txt project, both online and offline. This includes GitHub repositories, chat rooms, in-person events, and any other communication channels.
- Be welcoming, friendly, patient, and kind.
- Be respectful.
- Be cautious with how you word things. Our goal is to remain professional.
- When we disagree, try to understand why.
- Direct contributions to the specification will only be accepted from individuals [1]. The security.txt project will not accept contributions to the specification in the name of an organisation. This is to ensure that the specifications and tools remain as neutral as possible.
- Registering an account on any service in the name of the security.txt project must be clearly communicated via the team first.
Contributions from the public are welcome.
The issue tracker is the preferred channel for bug reports and features requests.
The bug tracker utilizes several labels to help organize and identify issues.
Use the GitHub issue search — check if the issue has already been reported.